-
-
Notifications
You must be signed in to change notification settings - Fork 38
analytics: combine copy feature tracking events into one
#708
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
ambergristle
wants to merge
5
commits into
vikejs:main
Choose a base branch
from
ambergristle:simplify-tracking
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
1450201
chore: combine tracking
ambergristle 8f8a440
chore: desctructure flag when creating command
ambergristle c33d108
chore: flatten `multiple` categories
ambergristle 52ffeb0
chore: format
ambergristle 81f8e25
chore: remove comment
ambergristle File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,53 +1,64 @@ | ||
| type Events = CopyEvent; | ||
| declare global { | ||
| // eslint-disable-next-line no-var | ||
| var zaraz: Zaraz | undefined; | ||
| } | ||
|
|
||
| interface CopyEvent { | ||
| name: "copy"; | ||
| data: { | ||
| flags: string[]; | ||
| package_manager: string; | ||
| }; | ||
| /** | ||
| * This signature is compatible with both Umami and GA | ||
| */ | ||
| export function track<T extends TrackingEvent>(name: T["name"], data: T["data"]) { | ||
| globalThis.zaraz?.track(name, data); | ||
| } | ||
|
|
||
| interface Zaraz { | ||
| track: <T extends Events>(event: T["name"], data: unknown) => Promise<void>; | ||
| track: <T extends TrackingEvent>(event: T["name"], data: unknown) => Promise<void>; | ||
| } | ||
|
|
||
| declare global { | ||
| // eslint-disable-next-line no-var | ||
| var zaraz: Zaraz | undefined; | ||
| } | ||
| type TrackingEvent = CopyEvent; | ||
|
|
||
| function generateUUID() { | ||
| return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, (c) => { | ||
| const r = (Math.random() * 16) | 0, | ||
| v = c === "x" ? r : (r & 0x3) | 0x8; | ||
| return v.toString(16); | ||
| }); | ||
| export interface CopyEvent { | ||
| name: "copy_scaffold"; | ||
| data: { | ||
| package_manager: string; | ||
| // could be interesting, but maybe tracking | ||
| // button clicks as part of a funnel is better | ||
| // is_preset: boolean; | ||
| [key: string]: string; | ||
| }; | ||
| } | ||
|
|
||
| export function track<T extends Events>(event: T["name"], data: T["data"]) { | ||
| const interactionid = generateUUID(); | ||
| console.log({ | ||
| interactionid, | ||
| event, | ||
| data, | ||
| }); | ||
| switch (event) { | ||
| case "copy": { | ||
| if (data.flags.length === 0) { | ||
| globalThis.zaraz?.track(event, { | ||
| flag: undefined, | ||
| package_manager: data.package_manager, | ||
| interactionid, | ||
| }); | ||
| } | ||
| for (const flag of data.flags) { | ||
| globalThis.zaraz?.track(event, { | ||
| flag, | ||
| package_manager: data.package_manager, | ||
| interactionid, | ||
| }); | ||
| type FeatureFlag = { | ||
| flag: string; | ||
| category: string; | ||
| }; | ||
|
|
||
| export function formatFeatureFlags(selectedFlags: FeatureFlag[]): Record<string, string> { | ||
| const categoriesMultiple = new Set<string>(); | ||
|
|
||
| const flags = selectedFlags.reduce( | ||
| (data, { flag, category }) => { | ||
| if (data[category]) { | ||
| if (Array.isArray(data[category])) { | ||
| data[category].push(flag); | ||
| } else { | ||
| // Track all keys converted to arrays | ||
| categoriesMultiple.add(category); | ||
| data[category] = [data[category], flag]; | ||
| } | ||
| } else { | ||
| data[category] = flag; | ||
| } | ||
| return data; | ||
| }, | ||
| {} as Record<string, string | string[]>, | ||
| ); | ||
|
|
||
| // Recombine all arrays into strings | ||
| categoriesMultiple.forEach((category) => { | ||
| if (Array.isArray(flags[category])) { | ||
| flags[category] = flags[category].sort().join(":"); | ||
| } | ||
| } | ||
| }); | ||
|
|
||
| return flags as Record<string, string>; | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.