test: Add test for missing host/Electron behavior

Author: benvinegar

packages/tracker/src/lib/__tests__/track.spec.ts

@@ -0,0 +1,127 @@
+import { describe, test, expect, vi, beforeEach, afterEach } from "vitest";
+import { trackPageview } from "../track";
+import * as requestModule from "../request";
+import { Client } from "../client";
+
+describe("trackPageview", () => {
+    // Mock the makeRequest function
+    const makeRequestMock = vi.fn();
+
+    beforeEach(() => {
+        // Mock the makeRequest function
+        vi.spyOn(requestModule, "makeRequest").mockImplementation(
+            makeRequestMock,
+        );
+
+        // Reset mocks between tests
+        makeRequestMock.mockReset();
+
+        // Mock window.location
+        Object.defineProperty(window, "location", {
+            writable: true,
+            value: {
+                pathname: "/test-path",
+                search: "?test=true",
+                host: "example.com",
+            },
+        });
+
+        // Mock navigator.userAgent
+        Object.defineProperty(navigator, "userAgent", {
+            writable: true,
+            value: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)",
+        });
+
+        // Mock document.referrer
+        Object.defineProperty(document, "referrer", {
+            writable: true,
+            value: "",
+        });
+
+        // Mock document.querySelector for canonical URL
+        vi.spyOn(document, "querySelector").mockReturnValue(null);
+    });
+
+    afterEach(() => {
+        vi.restoreAllMocks();
+    });
+
+    test("should make a request when host is not empty", () => {
+        const client = new Client({
+            siteId: "test-site",
+            reporterUrl: "https://example.com/collect",
+            autoTrackPageviews: false,
+        });
+
+        trackPageview(client);
+
+        expect(makeRequestMock).toHaveBeenCalledTimes(1);
+        expect(makeRequestMock).toHaveBeenCalledWith(
+            "https://example.com/collect",
+            expect.objectContaining({
+                p: "/test-path",
+                h: "http://localhost",
+                r: "",
+                sid: "test-site",
+            }),
+        );
+    });
+
+    test("should exit early when host is empty and not in Electron", () => {
+        // Mock empty host (file:/// URI)
+        Object.defineProperty(window, "location", {
+            writable: true,
+            value: {
+                pathname: "/test-path",
+                search: "?test=true",
+                host: "",
+            },
+        });
+
+        // Mock non-Electron user agent
+        Object.defineProperty(navigator, "userAgent", {
+            writable: true,
+            value: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)",
+        });
+
+        const client = new Client({
+            siteId: "test-site",
+            reporterUrl: "https://example.com/collect",
+            autoTrackPageviews: false,
+        });
+
+        trackPageview(client);
+
+        // Verify that makeRequest was not called
+        expect(makeRequestMock).not.toHaveBeenCalled();
+    });
+
+    test("should make a request when host is empty but in Electron", () => {
+        // Mock empty host (file:/// URI)
+        Object.defineProperty(window, "location", {
+            writable: true,
+            value: {
+                pathname: "/test-path",
+                search: "?test=true",
+                host: "",
+            },
+        });
+
+        // Mock Electron user agent
+        Object.defineProperty(navigator, "userAgent", {
+            writable: true,
+            value: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) Electron/15.0.0",
+        });
+
+        const client = new Client({
+            siteId: "test-site",
+            reporterUrl: "https://example.com/collect",
+            autoTrackPageviews: false,
+        });
+
+        trackPageview(client);
+
+        // Verify that makeRequest was called
+        expect(makeRequestMock).toHaveBeenCalledTimes(1);
+    });
+});

packages/tracker/src/lib/track.ts

@@ -52,6 +52,8 @@ export function trackPageview(client: Client, opts: TrackPageviewOpts = {}) {
     const canonical = getCanonicalUrl();
     const location = canonical ?? window.location;
 
+    // if host is empty, we're probably loading a file:/// URI
+    // -- exit early if this is not an Electron app
     if (location.host === "" && navigator.userAgent.indexOf("Electron") < 0) {
         return;
     }