Remove Google Analytics (#8201)

fm3 · daniel-wer · web-flow · commit 42f1c52bf8a1 · 2024-11-19T12:14:42.000Z
* Remove Google Analytics

* changelog, migration guide

* Update CHANGELOG.unreleased.md

Co-authored-by: Daniel &lt;daniel.werner@scalableminds.com&gt;

---------

Co-authored-by: Daniel &lt;daniel.werner@scalableminds.com&gt;
diff --git a/CHANGELOG.unreleased.md b/CHANGELOG.unreleased.md
@@ -24,5 +24,6 @@ For upgrade instructions, please check the [migration guide](MIGRATIONS.released
 - Fix a bug where trying to delete a non-existing node (via the API, for example) would delete the whole active tree. [#8176](https://github.com/scalableminds/webknossos/pull/8176)
 
 ### Removed
+- Removed Google Analytics integration. [#8201](https://github.com/scalableminds/webknossos/pull/8201)
 
 ### Breaking Changes
diff --git a/MIGRATIONS.unreleased.md b/MIGRATIONS.unreleased.md
@@ -8,4 +8,6 @@ User-facing changes are documented in the [changelog](CHANGELOG.released.md).
 ## Unreleased
 [Commits](https://github.com/scalableminds/webknossos/compare/24.11.1...HEAD)
 
+- The config option `googleAnalytics.trackingId` is no longer used and can be removed. [#8201](https://github.com/scalableminds/webknossos/pull/8201)
+
 ### Postgres Evolutions:
diff --git a/app/utils/WkConf.scala b/app/utils/WkConf.scala
@@ -200,10 +200,6 @@ class WkConf @Inject()(configuration: Configuration) extends ConfigReader with L
     val environment: String = get[String]("airbrake.environment")
   }
 
-  object GoogleAnalytics {
-    val trackingId: String = get[String]("googleAnalytics.trackingId")
-  }
-
   object SlackNotifications {
     val uri: String = get[String]("slackNotifications.uri")
     val verboseLoggingEnabled: Boolean = get[Boolean]("slackNotifications.verboseLoggingEnabled")
@@ -259,7 +255,6 @@ class WkConf @Inject()(configuration: Configuration) extends ConfigReader with L
       Silhouette,
       Jobs,
       Airbrake,
-      GoogleAnalytics,
       BackendAnalytics,
       Slick,
       Voxelytics,
diff --git a/app/views/main.scala.html b/app/views/main.scala.html
@@ -6,9 +6,6 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=no" />
     <meta name="commit-hash" content="@(webknossos.BuildInfo.commitHash)" />
     <meta name="selected-theme" content="@(selectedTheme)" />
-    @if(conf.GoogleAnalytics.trackingId.nonEmpty) {
-    <meta name="google-analytics-tracking-id" content="@(conf.GoogleAnalytics.trackingId)" />
-    }
     <title>@(conf.WebKnossos.tabTitle)</title>
     @openGraphTitle.map { ogt =>
     <meta property="og:title" content="@ogt" />
@@ -52,25 +49,5 @@
   </head>
   <body>
     <main id="main-container"></main>
-
-    @if(conf.GoogleAnalytics.trackingId.nonEmpty) {
-    <script
-      async
-      src="https://www.googletagmanager.com/gtag/js?id=@(conf.GoogleAnalytics.trackingId)"
-    ></script>
-    <script>
-      const metaElement = document.querySelector("meta[name='google-analytics-tracking-id']");
-      const googleAnalyticsTrackingId = metaElement ? metaElement.getAttribute("content") : null;
-      window.dataLayer = window.dataLayer || [];
-      function gtag() {
-        dataLayer.push(arguments);
-      }
-      gtag("js", new Date());
-      gtag("config", googleAnalyticsTrackingId, {
-        anonymize_ip: true,
-        cookie_expires: 0,
-      });
-    </script>
-    }
   </body>
 </html>
diff --git a/conf/application.conf b/conf/application.conf
@@ -293,9 +293,6 @@ airbrake {
   projectID = "insert-valid-projectID-here"
 }
 
-# Front-end analytics
-googleAnalytics.trackingId = ""
-
 # Slack notification
 slackNotifications {
   uri = ""
diff --git a/frontend/javascripts/admin/dataset/dataset_upload_view.tsx b/frontend/javascripts/admin/dataset/dataset_upload_view.tsx
@@ -54,7 +54,6 @@ import {
 import Toast from "libs/toast";
 import * as Utils from "libs/utils";
 import messages from "messages";
-import { trackAction } from "oxalis/model/helpers/analytics";
 import Zip from "libs/zipjs_wrapper";
 import {
   AllowedTeamsFormItem,
@@ -350,7 +349,6 @@ class DatasetUploadView extends React.Component<PropsWithFormAndRouter, State> {
       });
       finishDatasetUpload(datastoreUrl, uploadInfo).then(
         async () => {
-          trackAction("Upload dataset");
           Toast.success(messages["dataset.upload_success"]);
           let maybeError;
 
diff --git a/frontend/javascripts/dashboard/advanced_dataset/dataset_table.tsx b/frontend/javascripts/dashboard/advanced_dataset/dataset_table.tsx
@@ -14,7 +14,6 @@ import type {
 } from "types/api_flow_types";
 import type { DatasetFilteringMode } from "dashboard/dataset_view";
 import { stringToColor } from "libs/format_utils";
-import { trackAction } from "oxalis/model/helpers/analytics";
 import CategorizationLabel from "oxalis/view/components/categorization_label";
 import DatasetActionView, {
   getDatasetActionContextMenu,
@@ -791,7 +790,6 @@ export function DatasetTags({
       };
     }
 
-    trackAction("Edit dataset tag");
     updateDataset(dataset, updater);
   };
 
diff --git a/frontend/javascripts/dashboard/dataset/dataset_settings_view.tsx b/frontend/javascripts/dashboard/dataset/dataset_settings_view.tsx
@@ -32,7 +32,6 @@ import {
   updateDatasetPartial,
 } from "admin/admin_rest_api";
 import { handleGenericError } from "libs/error_handling";
-import { trackAction } from "oxalis/model/helpers/analytics";
 import Toast from "libs/toast";
 import messages from "messages";
 import features from "features";
@@ -390,7 +389,6 @@ class DatasetSettingsView extends React.PureComponent<PropsWithFormAndRouter, St
       }
     }
 
-    trackAction(`Dataset ${verb}`);
     this.props.onComplete();
   };
 
diff --git a/frontend/javascripts/dashboard/explorative_annotations_view.tsx b/frontend/javascripts/dashboard/explorative_annotations_view.tsx
@@ -60,7 +60,6 @@ import Store from "oxalis/store";
 import Toast from "libs/toast";
 import * as Utils from "libs/utils";
 import messages from "messages";
-import { trackAction } from "oxalis/model/helpers/analytics";
 import TextWithDescription from "components/text_with_description";
 import { getVolumeDescriptors } from "oxalis/model/accessors/volumetracing_accessor";
 import { RenderToPortal } from "oxalis/view/layouting/portal_utils";
@@ -289,7 +288,6 @@ class ExplorativeAnnotationsView extends React.PureComponent<Props, State> {
       const newTracing = await editLockedState(tracing.id, tracing.typ, locked);
       Toast.success(messages["annotation.was_edited"]);
       this.updateTracingInLocalState(tracing, (_t) => newTracing);
-      trackAction("Lock/Unlock explorative annotation");
     } catch (error) {
       handleGenericError(error as Error, "Could not update the annotation lock state.");
     }
@@ -475,7 +473,6 @@ class ExplorativeAnnotationsView extends React.PureComponent<Props, State> {
           editAnnotation(newAnnotation.id, newAnnotation.typ, {
             tags: newAnnotation.tags,
           });
-          trackAction("Edit annotation tag");
         }
 
         return newAnnotation;
diff --git a/frontend/javascripts/main.tsx b/frontend/javascripts/main.tsx
@@ -6,7 +6,6 @@ import UnthrottledStore, { startSagas } from "oxalis/store";
 import { message } from "antd";
 
 import { getActiveUser, checkAnyOrganizationExists, getOrganization } from "admin/admin_rest_api";
-import { googleAnalyticsLogClicks } from "oxalis/model/helpers/analytics";
 import { load as loadFeatureToggles } from "features";
 import { setActiveUserAction } from "oxalis/model/actions/user_actions";
 import { setHasOrganizationsAction, setThemeAction } from "oxalis/model/actions/ui_actions";
@@ -97,7 +96,6 @@ document.addEventListener("DOMContentLoaded", async () => {
     throwAssertions: false,
   });
   message.config({ top: 30 });
-  document.addEventListener("click", googleAnalyticsLogClicks);
   checkBrowserFeatures();
   await Promise.all([loadFeatureToggles(), loadActiveUser(), loadHasOrganizations()]);
   await Promise.all([loadOrganization()]);
diff --git a/frontend/javascripts/navbar.tsx b/frontend/javascripts/navbar.tsx
@@ -45,7 +45,6 @@ import {
   sendAnalyticsEvent,
 } from "admin/admin_rest_api";
 import { logoutUserAction, setActiveUserAction } from "oxalis/model/actions/user_actions";
-import { trackVersion } from "oxalis/model/helpers/analytics";
 import { useFetch, useInterval } from "libs/react_helpers";
 import LoginForm from "admin/auth/login_form";
 import Request from "libs/request";
@@ -739,13 +738,9 @@ function AnonymousAvatar() {
   );
 }
 
-async function getAndTrackVersion(dontTrack: boolean = false) {
+async function getVersion() {
   const buildInfo = await getBuildInfo();
-  const { version } = buildInfo.webknossos;
-  if (dontTrack) {
-    trackVersion(version);
-  }
-  return version;
+  return buildInfo.webknossos.version;
 }
 
 function AnnotationLockedByUserTag({
@@ -831,15 +826,15 @@ function Navbar({
     location.href = "/";
   };
 
-  const version = useFetch(getAndTrackVersion, null, []);
+  const version = useFetch(getVersion, null, []);
   const [isHelpMenuOpen, setIsHelpMenuOpen] = useState(false);
   const [polledVersion, setPolledVersion] = useState<string | null>(null);
   const [isHelpModalOpen, setIsHelpModalOpen] = useState(false);
 
   useInterval(
     async () => {
       if (isHelpMenuOpen) {
-        setPolledVersion(await getAndTrackVersion(true));
+        setPolledVersion(await getVersion());
       }
     },
     2000,
diff --git a/frontend/javascripts/oxalis/model/helpers/analytics.ts b/frontend/javascripts/oxalis/model/helpers/analytics.ts
diff --git a/frontend/javascripts/oxalis/model/sagas/settings_saga.ts b/frontend/javascripts/oxalis/model/sagas/settings_saga.ts
@@ -5,7 +5,6 @@ import {
 import { type Saga, take, select } from "oxalis/model/sagas/effect-generators";
 import { all, takeEvery, debounce, call, retry } from "typed-redux-saga";
 import type { UpdateUserSettingAction } from "oxalis/model/actions/settings_actions";
-import { trackAction } from "oxalis/model/helpers/analytics";
 import { updateUserConfiguration, updateDatasetConfiguration } from "admin/admin_rest_api";
 import ErrorHandling from "libs/error_handling";
 import Toast from "libs/toast";
@@ -97,12 +96,6 @@ function* prepareDatasetSettingsForSaving(
   return maskedDatasetConfiguration;
 }
 
-function* trackUserSettingsAsync(action: UpdateUserSettingAction): Saga<void> {
-  if (action.propertyName === "newNodeNewTree") {
-    yield* call(trackAction, `${action.value ? "Enabled" : "Disabled"} soma clicking`);
-  }
-}
-
 function* showUserSettingToast(action: UpdateUserSettingAction): Saga<void> {
   const { propertyName } = action;
 
@@ -129,7 +122,6 @@ export default function* watchPushSettingsAsync(): Saga<void> {
       pushDatasetSettingsAsync(originalDatasetSettings),
     ),
     debounce(2500, "UPDATE_LAYER_SETTING", () => pushDatasetSettingsAsync(originalDatasetSettings)),
-    takeEvery("UPDATE_USER_SETTING", trackUserSettingsAsync),
     takeEvery("UPDATE_USER_SETTING", showUserSettingToast),
   ]);
 }
diff --git a/frontend/javascripts/oxalis/view/action_bar_view.tsx b/frontend/javascripts/oxalis/view/action_bar_view.tsx
@@ -9,7 +9,6 @@ import {
   getLayoutConfig,
   addNewLayout,
 } from "oxalis/view/layouting/layout_persistence";
-import { trackAction } from "oxalis/model/helpers/analytics";
 import AddNewLayoutModal from "oxalis/view/action-bar/add_new_layout_modal";
 import { withAuthentication } from "admin/auth/authentication_modal";
 import { type ViewMode, type ControlMode, MappingStatusEnum } from "oxalis/constants";
@@ -196,7 +195,6 @@ class ActionBarView extends React.PureComponent<Props, State> {
       fallbackLayerName,
       maybeMappingName,
     );
-    trackAction("Create hybrid tracing (from view mode)");
     location.href = `${location.origin}/annotations/${annotation.typ}/${annotation.id}${location.hash}`;
   };
 
diff --git a/frontend/javascripts/oxalis/view/nml_upload_zone_container.tsx b/frontend/javascripts/oxalis/view/nml_upload_zone_container.tsx
@@ -8,7 +8,6 @@ import type { Dispatch } from "redux";
 import type { OxalisState } from "oxalis/store";
 import { setDropzoneModalVisibilityAction } from "oxalis/model/actions/ui_actions";
 import FormattedDate from "components/formatted_date";
-import { trackAction } from "oxalis/model/helpers/analytics";
 
 type State = {
   files: Array<File>;
@@ -115,7 +114,6 @@ class NmlUploadZoneContainer extends React.PureComponent<Props, State> {
       files,
       dropzoneActive: false,
     });
-    trackAction("NML drag and drop");
     this.props.hideDropzoneModal();
   };
 
diff --git a/frontend/javascripts/router.tsx b/frontend/javascripts/router.tsx
@@ -46,7 +46,6 @@ import window from "libs/window";
 import _ from "lodash";
 import Navbar from "navbar";
 import { ControlModeEnum } from "oxalis/constants";
-import { trackAction } from "oxalis/model/helpers/analytics";
 import type { OxalisState } from "oxalis/store";
 import HelpButton from "oxalis/view/help_modal";
 import TracingLayoutView from "oxalis/view/layouting/tracing_layout_view";
@@ -85,26 +84,6 @@ type StateProps = {
 };
 type Props = StateProps;
 const browserHistory = createBrowserHistory();
-browserHistory.listen((location) => {
-  // @ts-ignore
-  if (typeof window.ga !== "undefined" && window.ga !== null && window.ga.getByName != null) {
-    // t0 is the default tracker name
-    // @ts-ignore
-    const tracker = window.ga.getByName("t0");
-    if (tracker == null) return;
-    const lastPage = tracker.get("page");
-    const newPage = location.pathname;
-
-    // The listener is called repeatedly for a single page change, don't send repeated pageviews
-    if (lastPage !== newPage) {
-      // Update the tracker state first, so that subsequent pageviews AND events use the correct page
-      // @ts-ignore
-      window.gtag("set", "page_path", newPage);
-      // @ts-ignore
-      window.gtag("event", "page_view");
-    }
-  }
-});
 
 function PageNotFoundView() {
   return (
@@ -673,7 +652,6 @@ class ReactRouter extends React.Component<Props> {
                         null,
                         resolutionRestrictions,
                       );
-                      trackAction(`Create ${type} tracing`);
                       return `/annotations/${annotation.id}`;
                     }}
                   />

Original file line number	Diff line number	Diff line change
`@@ -293,9 +293,6 @@ airbrake {`
`293`	`293`	`projectID = "insert-valid-projectID-here"`
`294`	`294`	`}`
`295`	`295`
`296`		`-# Front-end analytics`
`297`		`-googleAnalytics.trackingId = ""`
`298`		`-`
`299`	`296`	`# Slack notification`
`300`	`297`	`slackNotifications {`
`301`	`298`	`uri = ""`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,6 @@ import {`
`32`	`32`	`updateDatasetPartial,`
`33`	`33`	`} from "admin/admin_rest_api";`
`34`	`34`	`import { handleGenericError } from "libs/error_handling";`
`35`		`-import { trackAction } from "oxalis/model/helpers/analytics";`
`36`	`35`	`import Toast from "libs/toast";`
`37`	`36`	`import messages from "messages";`
`38`	`37`	`import features from "features";`
`@@ -390,7 +389,6 @@ class DatasetSettingsView extends React.PureComponent<PropsWithFormAndRouter, St`
`390`	`389`	`}`
`391`	`390`	`}`
`392`	`391`
`393`		- trackAction(`Dataset ${verb}`);
`394`	`392`	`this.props.onComplete();`
`395`	`393`	`};`
`396`	`394`