Update snowplow config (#153)

* Update snowplow config to work with docusaurus routing. * Add correct prop-type * Don't set tracker on dev env. --------- Signed-off-by: Mirjam Aulbach <[email protected]>
Aiven-Open · Nov 1, 2023 · 8bad411 · 8bad411
1 parent d78784e
commit 8bad411
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 4 deletions.
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -26,6 +26,7 @@ const config = {
   onBrokenMarkdownLinks: "warn",
 
   clientModules: [require.resolve("./snowplow.js")],
+
   // Even if you don't use internalization, you can use this field to set useful
   // metadata like html lang. For example, if your site is Chinese, you may want
   // to replace "en" with "zh-Hans".

diff --git a/snowplow.js b/snowplow.js
@@ -1,14 +1,15 @@
 import ExecutionEnvironment from "@docusaurus/ExecutionEnvironment";
 import { newTracker, trackPageView } from "@snowplow/browser-tracker";
 
+const isProduction = process.env.NODE_ENV === "production";
 const trackerConfig = {
   appId: "klaw-docs",
   platform: "web",
   forceSecureTracker: true,
   discoverRootDomain: true,
   cookieSameSite: "Lax",
   anonymousTracking: { withServerAnonymisation: true },
-  postPath: "/aiven/dc",
+  postPath: "/aiven/dc2",
   crossDomainLinker: function (linkElement) {
     return linkElement.id === "crossDomainLink";
   },
@@ -23,9 +24,24 @@ function setupBrowserTracker() {
   newTracker("at", "dc.aiven.io", trackerConfig);
 }
 
-if (ExecutionEnvironment.canUseDOM) {
+if (isProduction && ExecutionEnvironment.canUseDOM) {
+  // only set tracker on prod
   setupBrowserTracker();
-  trackPageView();
 }
 
+const module = {
+  onRouteDidUpdate({ location, previousLocation }) {
+    // only set tracker on prod
+    if (isProduction) {
+      // only call trackPageView when page route changed
+      if (location.pathname !== previousLocation?.pathname) {
+        // see https://github.com/facebook/docusaurus/pull/7424 regarding setTimeout
+        setTimeout(() => {
+          trackPageView();
+        });
+      }
+    }
+  },
+};
+
 export default module;
diff --git a/src/components/HomepageFeatures/index.js b/src/components/HomepageFeatures/index.js
@@ -140,7 +140,7 @@ function Feature({ Svg, title, description }) {
 Feature.propTypes = {
   Svg: PropTypes.any,
   title: PropTypes.string,
-  description: PropTypes.string,
+  description: PropTypes.node,
 };
 
 export default function HomepageFeatures() {