Merge branch 'develop' into delete-ssr

* develop: feat: add google analytics gtag.js plugin (#1702) chore: bump conventional-changelog-cli from 2.2.2 to 3.0.0 (#2085)
2026-10-17 04:31:18 +08:00 · 2023-06-29 19:55:12 -07:00
parent 8d5d20480a 29f3c82faa
commit 103dde845f
6 changed files with 538 additions and 445 deletions
@@ -0,0 +1,97 @@
+// Modules, constants, and variables
+// npm run test:e2e gtag.test.js
+// -----------------------------------------------------------------------------
+const docsifyInit = require('../helpers/docsify-init');
+const { test, expect } = require('./fixtures/docsify-init-fixture');
+
+const gtagList = [
+  'AW-YYYYYY', // Google Ads
+  'DC-ZZZZZZ', // Floodlight
+  'G-XXXXXX', // Google Analytics 4 (GA4)
+  'UA-XXXXXX', // Google Universal Analytics (GA3)
+];
+
+// Suite
+// -----------------------------------------------------------------------------
+test.describe('Gtag Plugin Tests', () => {
+  // page request listened, print collect url
+  function pageRequestListened(page) {
+    page.on('request', request => {
+      if (request.url().indexOf('www.google-analytics.com') !== -1) {
+        // console.log(request.url());
+      }
+    });
+
+    page.on('response', response => {
+      const request = response.request();
+      // googleads.g.doubleclick.net
+      // www.google-analytics.com
+      // www.googletagmanager.com
+      const reg =
+        /googleads\.g\.doubleclick\.net|www\.google-analytics\.com|www\.googletagmanager\.com/g;
+      if (request.url().match(reg)) {
+        // console.log(request.url(), response.status());
+      }
+    });
+  }
+
+  // Tests
+  // ---------------------------------------------------------------------------
+  test('single gtag', async ({ page }) => {
+    pageRequestListened(page);
+
+    const docsifyInitConfig = {
+      config: {
+        gtag: gtagList[0],
+      },
+      scriptURLs: ['/lib/plugins/gtag.min.js'],
+      styleURLs: ['/lib/themes/vue.css'],
+    };
+
+    await docsifyInit({
+      ...docsifyInitConfig,
+    });
+
+    const $docsify = await page.evaluate(() => window.$docsify);
+
+    // Verify config options
+    expect(typeof $docsify).toEqual('object');
+
+    // console.log($docsify.gtag, $docsify.gtag === '');
+
+    // Tests
+    expect($docsify.gtag).not.toEqual('');
+  });
+
+  test('multi gtag', async ({ page }) => {
+    pageRequestListened(page);
+
+    const docsifyInitConfig = {
+      config: {
+        gtag: gtagList,
+      },
+      scriptURLs: ['/lib/plugins/gtag.min.js'],
+      styleURLs: ['/lib/themes/vue.css'],
+    };
+
+    await docsifyInit({
+      ...docsifyInitConfig,
+    });
+
+    const $docsify = await page.evaluate(() => window.$docsify);
+
+    // Verify config options
+    expect(typeof $docsify).toEqual('object');
+
+    // console.log($docsify.gtag, $docsify.gtag === '');
+
+    // Tests
+    expect($docsify.gtag).not.toEqual('');
+  });
+
+  test('data-ga attribute', async ({ page }) => {
+    pageRequestListened(page);
+
+    // TODO
+  });
+});