snowplow / snowplow/snowplow-javascript-tracker

Send Snowplow core events using self-describing events

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

Nobody has claimed this yet.

category:core priority:low status:needs_triage type:enhancement
Dominant language
TypeScript
Stars
590
Forks
232
Avg merge
2h 22m
Merged PRs (30d)
3

Description

In the Snowplow documentation for Canonical event model, we have different event types.

However, for the five core events we assign sort of made-up schema urls that they don't exist:

  • page_view
  • page_ping
  • transaction
  • transaction_item
  • struct
  • unstruct

My proposal is to send first four events with unstruct and defined josnSchema. For that, we can add a Boolean to each of these functions to tell it to send with unstruct self-describing events/context instead of the regular payload:

  • trackPageView (page_view event + context for browser/device)
  • enableActivityTracking (page_ping event + optional context for browser/device )
  • addTrans (transaction event + optional context for browser/device )
  • addItem (transaction_item context for transaction + optional context for browser/device )

This will help us with some basic field validations and also community users who adapt this new methodology might suffer less later when there is a change in the schema or they want to change the schema or there is a migration plan for atomic.events core table.

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 reviewing the linked SchemaEnrichment.scala file and the tracker functions named in the issue: trackPageView, enableActivityTracking, addTrans, and addItem. Clarify the self-describing event and schema requirements first; done would mean the four core events use the proposed unstruct format with defined JSON schemas and the relevant behavior is covered by the project’s tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
api, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.