feat: support custom global analytics key by oscb · Pull Request #928 · segmentio/analytics-next

oscb · 2023-08-15T18:56:10Z

I've included a changeset (psst. run yarn changeset. Read about changesets here).

changeset-bot · 2023-08-15T19:20:38Z

🦋 Changeset detected

Latest commit: 31dd1d9

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
@segment/analytics-next	Minor
@segment/analytics-core	Minor
@segment/analytics-node	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

silesky · 2023-08-16T22:35:45Z

Hey @oscb! Thanks for taking this.

I thought the goal was to allow users to use window.foo.track() rather than window.analytics.track()? So the config option would be like 'analyticsGlobalKey', and we save that key in memory -- using it whenever we want to get the global analytics, like how getCDNUrl() works. The fact that this would also be the same reference as the buffer is just an implementation detail.

Maybe I'm missing some context?

oscb · 2023-08-17T19:44:26Z

I thought the goal was to allow users to use window.foo.track() rather than window.analytics.track()? So the config option would be like 'analyticsGlobalKey', and we save that key in memory -- using it whenever we want to get the global analytics, like how getCDNUrl() works. The fact that this would also be the same reference as the buffer is just an implementation detail.

Yes, it's sort of the idea. I think the name of the config option can be changed to analyticsGlobalKey

Per my discussion with Chris we're not yet changing the script part of it as it is going to be a challenge given that the script itself uses window.analytics but devs can modify the script and use their custom key and send it through the config (needs docs).

silesky · 2023-08-24T03:29:18Z

+'@internal/consent-tools-integration-tests': minor
+---
+
+Adds `bufferKey` option for setting custom global window buffers


Suggested change

Adds `bufferKey` option for setting custom global window buffers

Adds `globalAnalyticsKey` option for setting custom global window buffers

silesky · 2023-08-24T03:29:34Z

    })
  })

+  describe('bufferKey', () => {


Suggested change

describe('bufferKey', () => {

describe('globalAnalyticsKey', () => {

silesky · 2023-08-24T17:10:30Z

@@ -0,0 +1,26 @@
+import { createTaskGroup } from '../task-group'


silesky · 2023-08-25T17:09:14Z

   */
  highEntropyValuesClientHints?: HighEntropyHint[]
+  /**
+   * Key for the global window property storing the buffered calls


Suggested change

* Key for the global window property storing the buffered calls

* When using the snippet, this is the key that points to the global analytics instance (e.g. window.analytics).

silesky · 2023-08-25T17:10:36Z

  analytics: Analytics,
  buffer: PreInitMethodCallBuffer
 ): Promise<void> {
+  const calls = getGlobalAnalytics()


Can we get rid of this now? i.e restore the old function signature of "popSnippetWindowBuffer"?

Yea I guess we don't ned this anymore since we store it globally

silesky · 2023-08-25T17:14:48Z

+  ;(window as any).analytics = (await AnalyticsBrowser.standalone(
    writeKey,
    options
  )) as AnalyticsSnippet


Could we add a setGlobalAnalyticsMethod?
Then we can do:

setGlobalAnalytics(await AnalyticsBrowser.standalone( writeKey, options )))

silesky · 2023-08-25T17:19:59Z

  noConflict(): Analytics {
    console.warn(deprecationWarning)
-    window.analytics = _analytics ?? this
+    ;(window as any).analytics = _analytics ?? this


We probably want to add a setGlobalAnalytics method and do something like:

setGlobalAnalytics(_analytics ?? this)

…ticsKey

silesky

Small late breaking feedback just noticed!

silesky · 2023-09-08T16:59:41Z

@@ -0,0 +1,31 @@
+import { AnalyticsSnippet } from './standalone-interface'


Since file has import side effects -- I think we should name it 'global-analytics-helpers.ts ' or something like that, so nobody puts anything else in it. It could also go in /lib

Good point. It stopped being only an utils file

silesky · 2023-09-08T17:01:48Z

+
+/**
+ * Gets the global analytics instance/buffer
+ * @param key name of the window property where the buffer is stored (default: analytics)


Can we change the comment to say "global analytics/buffer"

silesky · 2023-09-09T21:06:57Z

@@ -0,0 +1,6 @@
+---
+'@segment/analytics-next': minor
+'@internal/consent-tools-integration-tests': minor


Oops... this bump looks like a mistake

silesky

Some other stuff ;-)

silesky · 2023-09-09T21:17:14Z

@@ -44,7 +44,7 @@ const WebWorker: React.FC = () => {
          }}
          value="Track!"


It's actually fine to do:

declare global { interface Window { analytics: AnalyticsSnippet } }

... since this is not a published repo

I'll leave it as it is for now. But yeah, doesn't matter.

feat: support custom global buffer key

f03b2f2

chore: fix tests

db9da4f

feat: store globalAnalytics key

c7a59f5

oscb requested a review from silesky August 23, 2023 21:00

oscb added 3 commits August 23, 2023 14:37

fix: fix linter and ajs-tester issues

64888dc

chore: rename bufferKey to globalAnalyticsKey

55f4382

chore: fix ajs-tester lint

b48c83a

silesky reviewed Aug 24, 2023

View reviewed changes

silesky changed the title ~~feat: support custom global buffer key~~ feat: support custom global analytics key Aug 25, 2023

silesky reviewed Aug 25, 2023

View reviewed changes

silesky requested changes Aug 25, 2023

View reviewed changes

Comment thread packages/browser/src/browser/utils.ts

oscb added 3 commits August 28, 2023 10:54

fix: add setGlobalAnalytics convenience method, rename to globalAnaly…

48b61f6

…ticsKey

chore: merge master

18763c2

chore: new comments, using setGlobalAnalytics in noConflict

dae77ba

oscb requested a review from silesky September 8, 2023 16:40

silesky approved these changes Sep 8, 2023

View reviewed changes

silesky requested changes Sep 8, 2023

View reviewed changes

silesky reviewed Sep 8, 2023

View reviewed changes

oscb added 2 commits September 8, 2023 15:20

chore: rename and move utils to libs/global-analytics-helper

5a75461

merge: master

3c91f8d

oscb requested a review from silesky September 8, 2023 22:27

silesky approved these changes Sep 8, 2023

View reviewed changes

silesky reviewed Sep 9, 2023

View reviewed changes

silesky requested changes Sep 9, 2023

View reviewed changes

silesky reviewed Sep 9, 2023

View reviewed changes

chore: update the changeset

31dd1d9

oscb requested a review from silesky September 12, 2023 18:19

silesky approved these changes Sep 12, 2023

View reviewed changes

oscb merged commit 7f4232c into master Sep 12, 2023

oscb deleted the oscb/window branch September 12, 2023 18:56

This was referenced Sep 12, 2023

Version Packages #948

Merged

Version Packages chrisradek/analytics-next#1

Open

nunofgs mentioned this pull request Jan 30, 2025

Add analytics global key customerio/cdp-analytics-js#37

Merged

	Adds `bufferKey` option for setting custom global window buffers
	Adds `globalAnalyticsKey` option for setting custom global window buffers

	describe('bufferKey', () => {
	describe('globalAnalyticsKey', () => {

		@@ -0,0 +1,26 @@
		import { createTaskGroup } from '../task-group'

	* Key for the global window property storing the buffered calls
	* When using the snippet, this is the key that points to the global analytics instance (e.g. window.analytics).

		@@ -0,0 +1,31 @@
		import { AnalyticsSnippet } from './standalone-interface'

		@@ -44,7 +44,7 @@ const WebWorker: React.FC = () => {
		}}
		value="Track!"

Conversation

oscb commented Aug 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented Aug 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

silesky commented Aug 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

oscb commented Aug 17, 2023

Uh oh!

silesky Aug 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

silesky Aug 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

silesky Aug 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

silesky Aug 25, 2023

Choose a reason for hiding this comment

Uh oh!

silesky Aug 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

oscb Aug 28, 2023

Choose a reason for hiding this comment

Uh oh!

silesky Aug 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

silesky Aug 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

silesky left a comment

Choose a reason for hiding this comment

Uh oh!

silesky Sep 8, 2023

Choose a reason for hiding this comment

Uh oh!

oscb Sep 8, 2023

Choose a reason for hiding this comment

Uh oh!

silesky Sep 8, 2023

Choose a reason for hiding this comment

Uh oh!

silesky Sep 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

silesky left a comment

Choose a reason for hiding this comment

Uh oh!

silesky Sep 9, 2023

Choose a reason for hiding this comment

Uh oh!

oscb Sep 12, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

oscb commented Aug 15, 2023 •

edited

Loading

changeset-bot bot commented Aug 15, 2023 •

edited

Loading

silesky commented Aug 16, 2023 •

edited

Loading

silesky Aug 24, 2023 •

edited

Loading

silesky Aug 24, 2023 •

edited

Loading

silesky Aug 24, 2023 •

edited

Loading

silesky Aug 25, 2023 •

edited

Loading

silesky Aug 25, 2023 •

edited

Loading

silesky Aug 25, 2023 •

edited

Loading

silesky Sep 9, 2023 •

edited

Loading