chore: [M3-6497] - Remove Google Analytics and clean up custom events #9266

mjac0bs · 2023-06-15T16:55:46Z

Description 📝

Final Google Analytics -> Adobe Analytics migration PR with the clean up to remove GA from Cloud Manager. We're finally deprecating GA in our 6/26 release!

TODO:

Merge corresponding internal PR for removing REACT_APP_GA_ID and REACT_APP_GTM_ID

Major Changes 🔄

List highlighting major changes

Renames files from src/utilities/ga and src/utilities/ga.test.ts to src/utilities/analytics.ts and src/utilities/analytics.test.ts.
Renames some functions and comments around the app that mention "GA" to "Analytics" to avoid any future confusion.
Removes react-ga as a package.
Removes references to GA_ID and GTM_ID environment variables.
Removes unused custom events.
Restores firing of the sendCreateBucketEvent when an OBJ storage bucket is created -- we used to track this, but it seems to have gotten dropped when refactoring components.
Fixes a bug with the Disk Resize Flow custom event that was causing an event to incorrectly fire every time the error toast displayed, rather than every time the docs link was clicked on the error toast! (This was why we had an inflated count for this event.)

How to test 🧪

How to setup test environment?
- Have the REACT_APP_GA_ID set in your local .env. (Reach out if you need this.)
- Have the REACT_APP_ADOBE_ANALYTICS_URL set in your local .env. (Reach out if you need this.)
- yarn up
How to verify changes?
- Refer to src/utilities/analytics.ts for custom events to test.
- Test actions that fire custom events and verify in the browser console that (1) no Google Analytics data is logged and (2) Adobe Analytics data is logged. See chore: [M3-6496] - Add Adobe Analytics custom event tracking #9004 for details instructions on setting up + expected output for Adobe logging.
How to run Unit or E2E tests?
yarn cy:run
Review the corresponding internal PR (ask me for this) to get rid of our build env vars.

cypress · 2023-06-15T17:59:55Z

Passing run #4360 ↗︎

0	167	3	0	0

Details:

Merge branch 'develop' into new-M3-6497-ga-and-custom-events-clean-up
Project: Cloud Manager E2E	Commit: `87bf1dfd38`
Status: Passed	Duration: 12:11 💡
Started: Jun 18, 2023 7:32 PM	Ended: Jun 18, 2023 7:44 PM

_{This comment has been generated by cypress-bot as a result of this
project's GitHub integration settings.}

mjac0bs · 2023-06-15T18:03:41Z

packages/api-v4/src/request.ts

-
-  /*
-   * If in the future, we want to hook into every single
-   * async action for the purpose of sending the request data
-   * to Google Tag Manager, we can uncomment out the following
-   * .then() and .catch() on return Axios(config)
-   */
-
-  // .then(response => {
-  //   /*
-  //    * This is sending an event to the Google Tag Manager
-  //    * data layer. This is important because it lets us track
-  //    * async actions as custom events
-  //    */
-  //   if ((window as any).dataLayer) {
-  //     (window as any).dataLayer = (window as any).dataLayer || [];
-  //     (window as any).dataLayer.push({
-  //       'event': 'asyncActionSuccess',
-  //       'url': response.config.url,
-  //       'method': response.config.method,
-  //     });
-  //   };
-  //   return response;
-  // })
-  // .catch(e => {
-  //   /*
-  //    * This is sending an event to the Google Tag Manager
-  //    * data layer. This is important because it lets us track
-  //    * async actions as custom events
-  //    */
-  //   if ((window as any).dataLayer) {
-  //     (window as any).dataLayer = (window as any).dataLayer || [];
-  //     (window as any).dataLayer.push({
-  //       'event': 'asyncActionFailure',
-  //       'url': e.response.config.url,
-  //       'method': e.response.config.method,
-  //     });
-  //   };
-  //   return Promise.reject(e);
-  // });


With the removal of GA and GTM, we can remove this comment block - it's just taking up space.

mjac0bs · 2023-06-15T18:03:54Z

packages/manager/src/features/Linodes/LinodesCreate/ApiAwarenessModal/index.tsx

-const fireGAEvent = (label: string) => {
-  sendEvent({
-    action: 'Click:link',
-    category: 'Linode Create API CLI Awareness Modal',
-    label,
-  });
-};


Essentially used the sendApiAwarenessClick event in place of this function in order to keep events in src/utilities/analytics.tsx where we can.

mjac0bs · 2023-06-15T18:04:16Z

packages/manager/src/features/ToastNotifications/ToastNotifications.tsx

-                  action: `Click:link`,
-                  label: 'Disk resize failed toast',
-                })
+                () =>


This was the cause of a bug. 🙃 sendEvent was firing here every time the toast displayed, rather than just when the link on the toast was clicked.

mjac0bs · 2023-06-15T18:04:22Z

packages/manager/src/utilities/analytics.ts

+  sendEvent({
+    category: 'Linode Action Menu',
+    action: 'Open Action Menu',
+  });


This function was being called again with recent refactoring of the action menu, so I uncommented it here.

mjac0bs · 2023-06-15T18:04:26Z

packages/manager/src/utilities/analytics.ts

-// getAll.ts
-export const sendFetchAllEvent = (
-  eventLabel: string,
-  eventValue: number
-): void => {
-  sendEvent({
-    category: 'Search',
-    action: 'Data fetch all entities',
-    label: eventLabel,
-    value: eventValue,
-  });
-};
-
-// TagImportDrawer.tsx
-export const sendImportDisplayGroupSubmitEvent = (
-  eventLabel: string,
-  eventValue: number
-): void => {
-  sendEvent({
-    category: 'dashboard',
-    action: 'import display groups',
-    label: eventLabel,
-    value: eventValue,
-  });
-};
-
-// LinodeThemeWrapper.tsx
-export const sendSpacingToggleEvent = (eventLabel: string): void => {
-  // AC 8/24/2020: disabling this event to reduce hits on GA as this seems to not be used
-  // sendEvent({
-  //   category: 'Theme Choice',
-  //   action: 'Spacing Toggle',
-  //   label: eventLabel
-  // });
-};
-
-// LinodeThemeWrapper.tsx
-export const sendThemeToggleEvent = (): void => {
-  // AC 9/24/2020: disabling this event to reduce hits on GA as this seems to not be used
-  // sendEvent({
-  //   category: 'Theme Choice',
-  //   action: 'Theme Toggle',
-  //   label: eventLabel
-  // });
-};
-


None of these events are currently in use, so I removed them.

…m events

mjac0bs · 2023-06-15T18:15:10Z

packages/api-v4/.changeset/pr-9266-removed-1686852804191.md

This could also be a tech story or just not included at all in the changelog.

I'm okay with any of these options.

bnussman-akamai · 2023-06-15T18:59:25Z

packages/api-v4/.changeset/pr-9266-removed-1686852804191.md

I'm okay with any of these options.

hkhalil-akamai

LGTM! Great work on this migration @mjac0bs

abailly-akamai

🎉

abailly-akamai · 2023-06-15T20:33:56Z

packages/manager/src/features/Linodes/LinodesCreate/ApiAwarenessModal/index.tsx

@@ -147,7 +136,9 @@ const ApiAwarenessModal = (props: Props) => {
              <ExternalLink
                text="personal access token"
                link="/profile/tokens"
-                onClick={() => fireGAEvent('personal access token')}
+                onClick={() =>
+                  sendApiAwarenessClickEvent('link', 'personal access token')


Out of curiosity, Is the first argument typed or can it be anything?

Any string, to allow for an action like "Click:" where the input type could be a link, named tab, icon...

It’s unrelated to this PR but am wondering if we should eventually type this so we can chose from a limited set of events. The idea is that we can get dupes, events with different cases etc. And maybe in the future when we harvest it will be important to be able to filter events by types, or at least some events maybe be easier to group or just find. Just a thought!

Yeah, it's a good idea. Our current events are kind all over the place (especially in regard to actions), and I'm not sure how we'd best get those down to a limited set, but at the very least we could type-enforce for more consistency with new events. I'll document as a follow up task.

mjac0bs added 7 commits June 15, 2023 07:49

Remove GA_ID, GTM_ID env vars and references

d5308b8

Rename ga.ts and ga.test.ts, update imports

99bea09

Remove react-ga

8d55b61

Clean up analytics events file

9f3bc6d

More clean up to remove references to GA

bd8851e

More clean up

73a7da0

Fix bug overfiring disk error toast event; clean up

ec42dd9

mjac0bs self-assigned this Jun 15, 2023

bnussman-akamai added Missing Changeset Ready for Review labels Jun 15, 2023

mjac0bs mentioned this pull request Jun 15, 2023

chore: [M3-6497] - Remove GA and clean up custom events #9044

Closed

1 task

mjac0bs added the Analytics Relating to Analytics migration project or Adobe Analytics label Jun 15, 2023

mjac0bs commented Jun 15, 2023

View reviewed changes

mjac0bs added 2 commits June 15, 2023 11:12

Added changeset: Deprecate Google Analytics and clean up unused custo…

9dc59d0

…m events

Added changeset: References to deprecated Google Tag Manager

0f39300

bnussman-akamai removed the Missing Changeset label Jun 15, 2023

mjac0bs commented Jun 15, 2023

View reviewed changes

bnussman-akamai approved these changes Jun 15, 2023

View reviewed changes

bnussman-akamai added Add'tl Approval Needed Waiting on another approval! and removed Ready for Review labels Jun 15, 2023

hkhalil-akamai approved these changes Jun 15, 2023

View reviewed changes

bnussman-akamai added the Approved Multiple approvals and ready to merge! label Jun 15, 2023

bnussman-akamai removed the Add'tl Approval Needed Waiting on another approval! label Jun 15, 2023

Merge branch 'develop' into new-M3-6497-ga-and-custom-events-clean-up

bce00b1

abailly-akamai approved these changes Jun 15, 2023

View reviewed changes

mjac0bs and others added 2 commits June 16, 2023 12:41

Remove any pipes

b3d600b

Merge branch 'develop' into new-M3-6497-ga-and-custom-events-clean-up

87bf1df

mjac0bs merged commit f962d33 into linode:develop Jun 16, 2023

This was referenced Jun 22, 2023

Release v1.96.0 - release → staging #9300

Merged

Release v1.96.0 - staging → master #9316

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: [M3-6497] - Remove Google Analytics and clean up custom events #9266

chore: [M3-6497] - Remove Google Analytics and clean up custom events #9266

mjac0bs commented Jun 15, 2023 •

edited

Loading

cypress bot commented Jun 15, 2023 •

edited

Loading

mjac0bs Jun 15, 2023

mjac0bs Jun 15, 2023

mjac0bs Jun 15, 2023

mjac0bs Jun 15, 2023

mjac0bs Jun 15, 2023

mjac0bs Jun 15, 2023

bnussman-akamai Jun 15, 2023

bnussman-akamai Jun 15, 2023

hkhalil-akamai left a comment

abailly-akamai left a comment

abailly-akamai Jun 15, 2023

mjac0bs Jun 16, 2023

abailly-akamai Jun 16, 2023

mjac0bs Jun 16, 2023

chore: [M3-6497] - Remove Google Analytics and clean up custom events #9266

chore: [M3-6497] - Remove Google Analytics and clean up custom events #9266

Conversation

mjac0bs commented Jun 15, 2023 • edited Loading

Description 📝

Major Changes 🔄

How to test 🧪

cypress bot commented Jun 15, 2023 • edited Loading

Passing run #4360 ↗︎

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hkhalil-akamai left a comment

Choose a reason for hiding this comment

abailly-akamai left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mjac0bs commented Jun 15, 2023 •

edited

Loading

cypress bot commented Jun 15, 2023 •

edited

Loading