Docs: Opt Out of Umami with ?stats=off (#109)

Author: talbs

tests/tiny-tell.spec.js

@@ -932,6 +932,16 @@ test.describe('site pages', () => {
     }
   });
 
+  test('?stats=off opts the browser out of Umami, and ?stats=on puts it back', async ({ page }) => {
+    const flag = () => page.evaluate(() => localStorage.getItem('umami.disabled'));
+    await open(page, { path: '/docs/?stats=off#stats' });
+    await page.waitForURL(/\/docs\/#stats$/);
+    expect(await flag(), 'off sets the key Umami checks before every send, and drops the param').toBe('1');
+    await open(page, { path: '/?stats=on' });
+    await page.waitForURL(url => url.search === '');
+    expect(await flag(), 'on clears it again').toBeNull();
+  });
+
   test('the wordmark reports the load in the state color on light, and keeps its dot in ink on dark', async ({
     page,
   }) => {

tools/site/docs.html

@@ -1926,7 +1926,9 @@ <h3 id="contributing">Contributing</h3>
         <h3 id="stats">Stats</h3>
         <p>
           The site counts visits with <a href="https://umami.is/">Umami</a>, plus which tell you pick, which install tab
-          you open, and which palette you try. There are no cookies, and nothing in the totals identifies you.
+          you open, and which palette you try. There are no cookies, and nothing in the totals identifies you. To leave
+          yourself out, open <a href="?stats=off#stats"><code>?stats=off</code></a> once in each browser.
+          <a href="?stats=on#stats"><code>?stats=on</code></a> puts you back.
         </p>
       </section>
       <section

tools/site/track.js

@@ -2,3 +2,14 @@ const PAGE = { '/': 'landing', '/docs/': 'docs' };
 
 export const track = (name, data) =>
   window.umami?.track(name, { ...data, page: PAGE[location.pathname] ?? location.pathname });
+
+const url = new URL(location);
+const stats = url.searchParams.get('stats');
+if (stats === 'off' || stats === 'on') {
+  /* Umami's own opt-out: it checks this key before every send. */
+  try {
+    stats === 'off' ? localStorage.setItem('umami.disabled', '1') : localStorage.removeItem('umami.disabled');
+  } catch {}
+  url.searchParams.delete('stats');
+  history.replaceState(null, '', url);
+}