Skip to content

Snowplow onboarding flow

Elwyn Benson requested to merge 404794-snowplow-key-in-frontend into master

What does this MR do and why?

Rename all instances of jitsuKey in the frontend to trackingKey.

Make GraphQL + the view helper return either the jitsu_key or the new product_analytics_instrumentation_key depending on whether or not the feature flag is enabled, and which values are set.

  • If product analytics is not available (FF off, no licensed feature check) key is null
  • Else if product analytics is available
    • If product_analytics_snowplow_support is disabled, return jitsu_key
    • Else if the feature flag is enabled
      • return product_analytics_instrumentation_key if it exists, else return jitsu_key

Also modified the onboarding state resolver so that it will return the correct onboarding state when connecting to Snowplow.

Screenshots or screen recordings

n/a, nothing visually different

How to set up and validate locally

Note: This feature has a lot of setup steps. If you need help please ask me or I can step through these during a call with you.

  1. Follow these instructions to setup Product Analytics in GDK.
  2. Create a new project.
  3. In the new project, view the Analytics > Dashboards
  4. Click on the Product Analytics Set up button.
  5. Validate that you can go through the Project Analytics onboarding process and connect project to jitsu

Now enable the snowplow feature flag product_analytics_snowplow_support

  1. verify that your project continues to work with jitsu

1.Setup your devkit to work with snowplow instructions

  1. Create a new project.
  2. In the new project, view the Analytics > Dashboards
  3. Click on the Product Analytics Set up button.
  4. Validate that you can go through the Project Analytics onboarding process and connect project to snowplow

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Related to #404794 (closed)

Edited by Robert Hunt

Merge request reports