Track UTM tags with the REFERRER call #27

gtupak · 2022-11-17T17:56:48Z

At the initial page visit, add the source, medium and campaign as parameters to the REFERRER event call if their respective UTM tags are present in the url (utm_source, utm_medium and utm_campaign, respectively).

@stuart-watt, I renamed campaignId to campaign fyi, to match the utm tag namings, in case you need to change anything on your end.

xitronix

Referrer and utm tags are different things, Kale named utm tags as attribute. So we should separate this functionality in my opinion or remove attribute function. Let's discuss it during stand up

kquintal

Seems good, the granularity of tests also gives me confidence.

From @xitronix comment tho, seems you two want to change this, so I'll just comment and feel free to re-request review after your discussion.

gtupak · 2022-11-18T16:27:24Z

@xitronix I agree with your comment. What would you say if we:

Replace the REFERRER event by FIRST_PAGE_VISIT, which includes url and referrer, source, medium, campaign if present
Add a config option to automatically report UTM tags which is true by default. If false, we won't add the 3 utm parameters in the call above
Throw in attribute() if the config option of (2.) is true
Throw in referrer() if the config option of auto-reporting referrer is true

xitronix · 2022-11-18T21:16:42Z

I agree, the only thing which i want to specfy is that attributes should look like :

{
   referrer: ...,
   utm: {
      source: ...,
      ....
   }
}

gtupak · 2022-11-22T01:51:59Z

We should also probably save to the sessionStorage that the FIRST_PAGE_VISIT call was already made
~~Throw an error in attribution() and referrer() functions if their respective automatic report config is set to true~~

gtupak · 2022-11-22T20:57:29Z

src/ArcxAnalyticsSdk.ts

+      url?: string
+      referrer?: string
+      utm?: {
+        source?: string
+        medium?: string
+        campaign?: string
+      }


@stuart-watt this would be the attribute structure of the FIRST_PAGE_VISIT event. Would you like to change anything?

This is perfect for me, no changes required @gtupak

It would actually be simpler on my end if the url, referrer, source, medium and campaign were all on the same level. i.e. no need for the utm key. Since I know what source, medium and campaign are UTM tags, I don't see a need to explicitly have a nested utm dictionary.

Although I can work with the structure above

I find it better structured this way. In case we want to add more information to this call in the future, we can add other nested objects inside based on their category. If we put all of them at the same level it might create confusion in the future and increase tech debt potential.

src/ArcxAnalyticsSdk.ts

test/helpers/reconfigureJsdom.ts

test/ArcxAnalyticsSdk.test.ts

test/ArcxAnalyticsProvider.test.tsx

add window object typing rm comments and log do not save the url on the window object and add medium option to attribute call make the current url private add arcx analyticx provider and CRA example project log page events track event clicks on console view update readme fix installations add missing peer dependencies ignore webpack config ts to avoid eslint errors update header and favicon support react versions >=16 improve example repo move the helper outside the analytics sdk class add window object typing rm comments and log do not save the url on the window object and add medium option to attribute call make the current url private add arcx analyticx provider and CRA example project log page events track event clicks on console view update readme fix installations add missing peer dependencies ignore webpack config ts to avoid eslint errors add react testing library add first provider test add remaining provider tests add coverage report 100% coverage on provider test attribution event rm log simplify button clicks log test (debugging) rm log add missing peer dep adjust comments move the helper outside the analytics sdk class add window object typing rm comments and log do not save the url on the window object and add medium option to attribute call make the current url private add arcx analyticx provider and CRA example project log page events track event clicks on console view update readme fix installations add missing peer dependencies ignore webpack config ts to avoid eslint errors update header and favicon support react versions >=16 improve example repo move the helper outside the analytics sdk class add window object typing rm comments and log do not save the url on the window object and add medium option to attribute call make the current url private add arcx analyticx provider and CRA example project log page events track event clicks on console view update readme fix installations add missing peer dependencies ignore webpack config ts to avoid eslint errors add react testing library add first provider test add remaining provider tests add coverage report 100% coverage on provider test attribution event rm log simplify button clicks log test (debugging) rm log auto-track utm tags as part of the REFERRER call, rename campaignId to campaign

…resent

…al register

gtupak · 2022-11-24T17:31:16Z

🎉 This PR is included in version 1.3.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

gtupak requested review from xitronix and kquintal November 17, 2022 17:56

gtupak force-pushed the test/add-provider-tests branch from 072fd88 to e544df8 Compare November 17, 2022 19:19

gtupak force-pushed the feat/auto-track-utm branch 3 times, most recently from e82953a to e8f1689 Compare November 17, 2022 19:57

gtupak linked an issue Nov 17, 2022 that may be closed by this pull request

Auto-track UTM tags #26

Closed

xitronix suggested changes Nov 18, 2022

View reviewed changes

kquintal reviewed Nov 18, 2022

View reviewed changes

Base automatically changed from test/add-provider-tests to main November 18, 2022 16:13

gtupak force-pushed the feat/auto-track-utm branch from e8f1689 to e238b08 Compare November 18, 2022 16:17

gtupak force-pushed the feat/auto-track-utm branch from e238b08 to 9b65fed Compare November 22, 2022 19:02

gtupak requested a review from xitronix November 22, 2022 19:02

gtupak commented Nov 22, 2022

View reviewed changes

xitronix suggested changes Nov 22, 2022

View reviewed changes

gtupak force-pushed the feat/auto-track-utm branch from 79a1e2c to ebccb95 Compare November 22, 2022 21:58

gtupak requested a review from xitronix November 22, 2022 22:24

gtupak commented Nov 23, 2022

View reviewed changes

test/ArcxAnalyticsProvider.test.tsx Outdated Show resolved Hide resolved

gtupak added 9 commits November 23, 2022 13:49

chore: add test-watch command

040b3db

feat(arcxanalyticssdk.ts): add FIRST_PAGE_VISIT tracking

38b80eb

test: update tests

8d14518

refactor(arcxanalyticssdk.ts): rm duplicate code

8b69022

refactor: extract type

633dbe4

refactor: if utm is true, add the keys even if the utm tags are not p…

ed4ebca

…resent

refactor: use old implementation of referrer()

0f92d29

test: use globalJsdom instead of reconfigureJsdom

9901983

xitronix and others added 2 commits November 23, 2022 13:50

refactor: make jsdom global, which is anyway

5d54c21

test(arcxanalyticsprovider.test.tsx): add missing type, rm jsdom glob…

52a21fe

…al register

gtupak force-pushed the feat/auto-track-utm branch from f9a6f60 to 52a21fe Compare November 23, 2022 18:50

test(jsdom.setup.test.ts): cleanup after tests

40ebc48

xitronix approved these changes Nov 23, 2022

View reviewed changes

gtupak merged commit 22463b8 into main Nov 23, 2022

gtupak deleted the feat/auto-track-utm branch November 23, 2022 21:30

gtupak mentioned this pull request Nov 23, 2022

Every page click generates a PAGE event #28

Closed

gtupak added the released label Nov 24, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Track UTM tags with the REFERRER call #27

Track UTM tags with the REFERRER call #27

Uh oh!

gtupak commented Nov 17, 2022

Uh oh!

xitronix left a comment

Uh oh!

kquintal left a comment

Uh oh!

gtupak commented Nov 18, 2022

Uh oh!

xitronix commented Nov 18, 2022

Uh oh!

gtupak commented Nov 22, 2022 •

edited

Loading

Uh oh!

gtupak Nov 22, 2022

Uh oh!

stuart-watt Nov 23, 2022

Uh oh!

stuart-watt Nov 23, 2022 •

edited

Loading

Uh oh!

gtupak Nov 23, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gtupak commented Nov 24, 2022

Uh oh!

Uh oh!

Track UTM tags with the REFERRER call #27

Track UTM tags with the REFERRER call #27

Uh oh!

Conversation

gtupak commented Nov 17, 2022

Uh oh!

xitronix left a comment

Choose a reason for hiding this comment

Uh oh!

kquintal left a comment

Choose a reason for hiding this comment

Uh oh!

gtupak commented Nov 18, 2022

Uh oh!

xitronix commented Nov 18, 2022

Uh oh!

gtupak commented Nov 22, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gtupak Nov 22, 2022

Choose a reason for hiding this comment

Uh oh!

stuart-watt Nov 23, 2022

Choose a reason for hiding this comment

Uh oh!

stuart-watt Nov 23, 2022 • 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!

gtupak Nov 23, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gtupak commented Nov 24, 2022

Uh oh!

Uh oh!

gtupak commented Nov 22, 2022 •

edited

Loading

stuart-watt Nov 23, 2022 •

edited

Loading