@serwist/google-analytics 9.0.0-preview.0 → 9.0.0-preview.1

package/dist/initialize.js

@@ -3,63 +3,35 @@ import { privateCacheNames, logger, getFriendlyURL } from '@serwist/core/interna
 import { Router, Route } from '@serwist/routing';
 import { NetworkOnly, NetworkFirst } from '@serwist/strategies';
 
-/*
-  Copyright 2018 Google LLC
-
-  Use of this source code is governed by an MIT-style
-  license that can be found in the LICENSE file or at
-  https://opensource.org/licenses/MIT.
-*/ const QUEUE_NAME = "serwist-google-analytics";
-const MAX_RETENTION_TIME = 60 * 48; // Two days in minutes
+const QUEUE_NAME = "serwist-google-analytics";
+const MAX_RETENTION_TIME = 60 * 48;
 const GOOGLE_ANALYTICS_HOST = "www.google-analytics.com";
 const GTM_HOST = "www.googletagmanager.com";
 const ANALYTICS_JS_PATH = "/analytics.js";
 const GTAG_JS_PATH = "/gtag/js";
 const GTM_JS_PATH = "/gtm.js";
-// This RegExp matches all known Measurement Protocol single-hit collect
-// endpoints. Most of the time the default path (/collect) is used, but
-// occasionally an experimental endpoint is used when testing new features,
-// (e.g. /r/collect or /j/collect)
 const COLLECT_PATHS_REGEX = /^\/(\w+\/)?collect/;
 
-/**
- * Creates the requestWillDequeue callback to be used with the background
- * sync plugin. The callback takes the failed request and adds the
- * `qt` param based on the current time, as well as applies any other
- * user-defined hit modifications.
- *
- * @param config
- * @returns The requestWillDequeue callback function.
- * @private
- */ const createOnSyncCallback = (config)=>{
+const createOnSyncCallback = (config)=>{
     return async ({ queue })=>{
         let entry = undefined;
         while(entry = await queue.shiftRequest()){
             const { request, timestamp } = entry;
             const url = new URL(request.url);
             try {
-                // Measurement protocol requests can set their payload parameters in
-                // either the URL query string (for GET requests) or the POST body.
                 const params = request.method === "POST" ? new URLSearchParams(await request.clone().text()) : url.searchParams;
-                // Calculate the qt param, accounting for the fact that an existing
-                // qt param may be present and should be updated rather than replaced.
                 const originalHitTime = timestamp - (Number(params.get("qt")) || 0);
                 const queueTime = Date.now() - originalHitTime;
-                // Set the qt param prior to applying hitFilter or parameterOverrides.
                 params.set("qt", String(queueTime));
-                // Apply `parameterOverrides`, if set.
                 if (config.parameterOverrides) {
                     for (const param of Object.keys(config.parameterOverrides)){
                         const value = config.parameterOverrides[param];
                         params.set(param, value);
                     }
                 }
-                // Apply `hitFilter`, if set.
                 if (typeof config.hitFilter === "function") {
                     config.hitFilter.call(null, params);
                 }
-                // Retry the fetch. Ignore URL search params from the URL as they're
-                // now in the post body.
                 await fetch(new Request(url.origin + url.pathname, {
                     body: params.toString(),
                     method: "POST",
@@ -85,13 +57,7 @@ const COLLECT_PATHS_REGEX = /^\/(\w+\/)?collect/;
         }
     };
 };
-/**
- * Creates GET and POST routes to catch failed Measurement Protocol hits.
- *
- * @param bgSyncPlugin
- * @returns The created routes.
- * @private
- */ const createCollectRoutes = (bgSyncPlugin)=>{
+const createCollectRoutes = (bgSyncPlugin)=>{
     const match = ({ url })=>url.hostname === GOOGLE_ANALYTICS_HOST && COLLECT_PATHS_REGEX.test(url.pathname);
     const handler = new NetworkOnly({
         plugins: [
@@ -103,48 +69,28 @@ const COLLECT_PATHS_REGEX = /^\/(\w+\/)?collect/;
         new Route(match, handler, "POST")
     ];
 };
-/**
- * Creates a route with a network first strategy for the analytics.js script.
- *
- * @param cacheName
- * @returns The created route.
- * @private
- */ const createAnalyticsJsRoute = (cacheName)=>{
+const createAnalyticsJsRoute = (cacheName)=>{
     const match = ({ url })=>url.hostname === GOOGLE_ANALYTICS_HOST && url.pathname === ANALYTICS_JS_PATH;
     const handler = new NetworkFirst({
         cacheName
     });
     return new Route(match, handler, "GET");
 };
-/**
- * Creates a route with a network first strategy for the gtag.js script.
- *
- * @param cacheName
- * @returns The created route.
- * @private
- */ const createGtagJsRoute = (cacheName)=>{
+const createGtagJsRoute = (cacheName)=>{
     const match = ({ url })=>url.hostname === GTM_HOST && url.pathname === GTAG_JS_PATH;
     const handler = new NetworkFirst({
         cacheName
     });
     return new Route(match, handler, "GET");
 };
-/**
- * Creates a route with a network first strategy for the gtm.js script.
- *
- * @param cacheName
- * @returns The created route.
- * @private
- */ const createGtmJsRoute = (cacheName)=>{
+const createGtmJsRoute = (cacheName)=>{
     const match = ({ url })=>url.hostname === GTM_HOST && url.pathname === GTM_JS_PATH;
     const handler = new NetworkFirst({
         cacheName
     });
     return new Route(match, handler, "GET");
 };
-/**
- * @param options
- */ const initialize = (options = {})=>{
+const initialize = (options = {})=>{
     const cacheName = privateCacheNames.getGoogleAnalyticsName(options.cacheName);
     const bgSyncPlugin = new BackgroundSyncPlugin(QUEUE_NAME, {
         maxRetentionTime: MAX_RETENTION_TIME,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/google-analytics",
-  "version": "9.0.0-preview.0",
+  "version": "9.0.0-preview.1",
   "type": "module",
   "description": "Queues failed requests and uses the Background Sync API to replay them when the network is available",
   "files": [
@@ -42,15 +42,15 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@serwist/background-sync": "9.0.0-preview.0",
-    "@serwist/core": "9.0.0-preview.0",
-    "@serwist/routing": "9.0.0-preview.0",
-    "@serwist/strategies": "9.0.0-preview.0"
+    "@serwist/background-sync": "9.0.0-preview.1",
+    "@serwist/core": "9.0.0-preview.1",
+    "@serwist/routing": "9.0.0-preview.1",
+    "@serwist/strategies": "9.0.0-preview.1"
   },
   "devDependencies": {
     "rollup": "4.9.6",
     "typescript": "5.4.0-dev.20240203",
-    "@serwist/constants": "9.0.0-preview.0"
+    "@serwist/constants": "9.0.0-preview.1"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0"