gatsby-plugin-google-gtag 5.0.0 → 5.1.0

package/CHANGELOG.md

@@ -3,6 +3,15 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [5.0.0](https://github.com/gatsbyjs/gatsby/commits/gatsby-plugin-google-gtag@5.0.0/packages/gatsby-plugin-google-gtag) (2022-11-08)
+
+[🧾 Release notes](https://www.gatsbyjs.com/docs/reference/release-notes/v5.0)
+
+#### Chores
+
+- Update peerDeps [#36965](https://github.com/gatsbyjs/gatsby/issues/36965) ([b624442](https://github.com/gatsbyjs/gatsby/commit/b6244424fe8b724cbc23b80b2b4f5424cc2055a4))
+- apply patches for v5 [#36796](https://github.com/gatsbyjs/gatsby/issues/36796) ([25f79b6](https://github.com/gatsbyjs/gatsby/commit/25f79b6c3719fdf09584ade620a05c66ba2a697c))
+
 ## [4.24.0](https://github.com/gatsbyjs/gatsby/commits/gatsby-plugin-google-gtag@4.24.0/packages/gatsby-plugin-google-gtag) (2022-09-27)
 
 [🧾 Release notes](https://www.gatsbyjs.com/docs/reference/release-notes/v4.24)

package/README.md

@@ -50,6 +50,8 @@ module.exports = {
           exclude: ["/preview/**", "/do-not-track/me/too/"],
           // Defaults to https://www.googletagmanager.com
           origin: "YOUR_SELF_HOSTED_ORIGIN",
+          // Delays processing pageview events on route update (in milliseconds)
+          delayOnRouteUpdate: 0,
         },
       },
     },
@@ -137,3 +139,7 @@ If you enable this optional option, Google Global Site Tag will not be loaded at
 ## The "pluginConfig.exclude" option
 
 If you need to exclude any path from the tracking system, you can add it (one or more) to this optional array as glob expressions.
+
+## The "pluginConfig.delayOnRouteUpdate" option
+
+If you need to delay processing pageview events on route update (e.g. to wait for page transitions with [`gatsby-plugin-transition-link`](https://www.gatsbyjs.com/plugins/gatsby-plugin-transition-link/)), then this option adds a delay before generating the pageview event.

package/gatsby-browser.js

@@ -1,12 +1,17 @@
 "use strict";
 
-exports.onRouteUpdate = function (_ref) {
+exports.onRouteUpdate = function (_ref, pluginOptions) {
   var location = _ref.location;
 
+  if (pluginOptions === void 0) {
+    pluginOptions = {};
+  }
+
   if (process.env.NODE_ENV !== "production" || typeof gtag !== "function") {
     return null;
   }
 
+  var pluginConfig = pluginOptions.pluginConfig || {};
   var pathIsExcluded = location && typeof window.excludeGtagPaths !== "undefined" && window.excludeGtagPaths.some(function (rx) {
     return rx.test(location.pathname);
   });
@@ -19,13 +24,18 @@ exports.onRouteUpdate = function (_ref) {
     });
   };
 
+  var _pluginConfig$delayOn = pluginConfig.delayOnRouteUpdate,
+      delayOnRouteUpdate = _pluginConfig$delayOn === void 0 ? 0 : _pluginConfig$delayOn;
+
   if ("requestAnimationFrame" in window) {
     requestAnimationFrame(function () {
-      requestAnimationFrame(sendPageView);
+      requestAnimationFrame(function () {
+        return setTimeout(sendPageView, delayOnRouteUpdate);
+      });
     });
   } else {
-    // simulate 2 rAF calls
-    setTimeout(sendPageView, 32);
+    // Delay by 32ms to simulate 2 requestOnAnimationFrame calls
+    setTimeout(sendPageView, 32 + delayOnRouteUpdate);
   }
 
   return null;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "gatsby-plugin-google-gtag",
   "description": "Gatsby plugin to add google gtag onto a site",
-  "version": "5.0.0",
+  "version": "5.1.0",
   "author": "Tyler Buchea <tyler@buchea.com>",
   "bugs": {
     "url": "https://github.com/gatsbyjs/gatsby/issues"
@@ -13,7 +13,7 @@
   "devDependencies": {
     "@babel/cli": "^7.15.4",
     "@babel/core": "^7.15.5",
-    "babel-preset-gatsby-package": "^3.0.0",
+    "babel-preset-gatsby-package": "^3.1.0",
     "cross-env": "^7.0.3"
   },
   "homepage": "https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-plugin-google-gtag#readme",
@@ -43,5 +43,5 @@
   "engines": {
     "node": ">=18.0.0"
   },
-  "gitHead": "0c6cd6126c9ccb7fbd62ad3aa3a75efaa7bc7427"
+  "gitHead": "2cfb64b6a7d2fac447f4535c30a82fbcbc6251bf"
 }