snowplow / snowplow/snowplow-java-tracker

Move internal components into their own namespace

Open
#185 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

category:breaking_change
Dominant language
Java
Stars
25
Forks
35
Avg merge
52m
Merged PRs (30d)
1

Description

It is meant to be exclusive - just for the core payload key-value pairs. The reason it gets confusing is that you can insert a TrackerPayload as the data component of a SelfDescribing json because it is really just a Map under the hood. We could probably clarify this by:

  1. Renaming it to something more appropriate like NonEmptyStringMap
  2. Removing the ability to pass this object directly into the SelfDescribingJson

Perhaps there is something around package visibility we should be toggling too...

cc/ @alexanderdean

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating TrackerPayload and SelfDescribingJson and inspecting how TrackerPayload is accepted as a data component. Compare the proposed NonEmptyStringMap name and package-visibility changes with the existing public API; done means the internal payload representation is appropriately scoped and the SelfDescribingJson boundary is unambiguous.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.