Unify DynamicContext callback parameters across link click, button click and form tracking plugins in v5 release
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- typescript
Research direction
Start with the linked PR #1389 review and issue #1368, then compare the DynamicContext callback signatures described for the Button, Link, and Form plugins. Define the v5 object-parameter interface and its event data requirements across those plugins; done means the three plugin APIs are consistently specified for the breaking change.
Written by the indexing model from the issue text.
Description
Suggested in https://github.com/snowplow/snowplow-javascript-tracker/pull/1389#pullrequestreview-2453061584:
It's unfortunate we couldn't fit this into v4 as a breaking change, the resulting API inconsistency with the other plugins will be a bit awkward to resolve now.
| Plugin | Context Arg 1 | Context Arg 2 | Context Arg 3 |
|---|---|---|---|
| Button | Event Payload | - (Element in this PR) | - |
| Link | Element | - | - |
| Form (Change/Focus) | Element | Element Type | Element Value |
| Form (Submit) | Element | ElementData[] |
- |
It might be worth planning for v5 to unify plugins onto a single object param for dynamic contexts so we can be a bit looser with the interface. For Link and Button at least, getting the actual MouseEvent/PointerEvent for information on the type of click, modifier keys, coordinates, pressure used, etc could be useful in some use cases (as suggested in #1368) so would be nice to add in at some point.
Originally posted by @jethron in https://github.com/snowplow/snowplow-javascript-tracker/pull/1389#pullrequestreview-2453061584
- Dominant language
- TypeScript
- Stars
- 590
- Forks
- 232
- Avg merge
- 2h 22m
- Merged PRs (30d)
- 3
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from snowplow/snowplow-javascript-tracker
-
type:defect
Difficulty 3/5 1-2 days Newbie friendliness 58/100
snowplow/snowplow-javascript-tracker#1498 · 1 comment ·
-
type:enhancement
Difficulty 3/5 1-2 days Newbie friendliness 45/100
snowplow/snowplow-javascript-tracker#1443 · 4 comments ·
-
type:defect
Difficulty 4/5 3-5 days Newbie friendliness 35/100
snowplow/snowplow-javascript-tracker#1442 · 6 comments ·
-
type:enhancement
snowplow/snowplow-javascript-tracker#1438 · 3 comments · 2 assignees ·
-
type:enhancement
Difficulty 4/5 3-5 days Newbie friendliness 35/100
All issues in snowplow/snowplow-javascript-tracker
Similar issues
-
clawsweeper:fix-shape-clear clawsweeper:queueable-fix clawsweeper:source-repro impact:ux-friction issue-rating: 🦞 diamond lobster no-stale P3
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 76/100
-
code-quality refactoring
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
github/gh-aw-firewall#8816 ·
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
langchain-ai/deepagents#6450 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
vercel/react-tweet#225 ·