fix(web): injectSpeedInsights requires a parameter value (#38)

.eslintrc.cjs

@@ -6,6 +6,7 @@ module.exports = {
     require.resolve('@vercel/style-guide/eslint/jest'),
   ],
   env: {
+    node: true,
     jest: true,
   },
   parserOptions: {

package.json

@@ -6,17 +6,18 @@
   },
   "license": "Apache-2.0",
   "scripts": {
-    "prepare": "husky install"
+    "prepare": "husky install",
+    "test": "pnpm -F @vercel/speed-insights test"
   },
   "prettier": "@vercel/style-guide/prettier",
   "dependencies": {
     "lint-staged": "^14.0.1"
   },
   "devDependencies": {
-    "@vercel/style-guide": "^5.0.1",
+    "@vercel/style-guide": "^5",
     "husky": "^8.0.3",
     "prettier": "3.0.3",
-    "typescript": "^5.2.2"
+    "typescript": "^5"
   },
   "packageManager": "pnpm@8.6.5"
 }

packages/web/jest.setup.ts

@@ -1,6 +1,8 @@
 import '@testing-library/jest-dom';
 
 beforeEach(() => {
-  // reset dom before each test
-  document.getElementsByTagName('html')[0].innerHTML = '';
+  if ('document' in global) {
+    /* eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- there is an HTML element */
+    document.querySelector('html')!.innerHTML = '';
+  }
 });

packages/web/package.json

@@ -95,12 +95,12 @@
     "@swc/jest": "^0.2.29",
     "@testing-library/jest-dom": "^6.1.2",
     "@testing-library/react": "^14.0.0",
-    "@types/jest": "^29.5.4",
-    "@types/node": "^20.5.9",
-    "@types/react": "^18.2.21",
+    "@types/jest": "^29.5.11",
+    "@types/node": "^20.11.0",
+    "@types/react": "^18.2.47",
     "copyfiles": "^2.4.1",
-    "jest": "^29.6.4",
-    "jest-environment-jsdom": "^29.6.4",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
     "next": "^13.4.19",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",

packages/web/scripts/postinstall.mjs

@@ -1,4 +1,3 @@
-/* eslint-disable no-undef -- Allow the use `process` */
 /* eslint-disable no-console -- Allow the use of `console` */
 import fs from 'node:fs';
 import path from 'node:path';

packages/web/src/generic.server.test.ts

@@ -0,0 +1,8 @@
+/** @jest-environment node */
+import { injectSpeedInsights } from './generic';
+
+describe('injectSpeedInsights()', () => {
+  it('does nothing in a server environment', () => {
+    expect(injectSpeedInsights({})).toBe(null);
+  });
+});

packages/web/src/generic.test.ts

@@ -0,0 +1,33 @@
+import { injectSpeedInsights } from './generic';
+
+describe('injectSpeedInsights()', () => {
+  it('allows no parameters', () => {
+    expect(injectSpeedInsights()).toEqual({
+      setRoute: expect.any(Function) as () => void,
+    });
+    expectInjectedScript();
+  });
+
+  it('can set framework', () => {
+    const framework = 'sveltekit';
+    expect(injectSpeedInsights({ framework })).toEqual({
+      setRoute: expect.any(Function) as () => void,
+    });
+    expectInjectedScript({ framework });
+  });
+});
+
+function expectInjectedScript({
+  src = 'https://va.vercel-scripts.com/v1/speed-insights/script.debug.js',
+  framework = '',
+} = {}): void {
+  const candidateScript = document.querySelector('script');
+  expect(candidateScript).toBeDefined();
+  /* eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- the previous assertion fails otherwise */
+  const script = candidateScript!;
+  expect(script.defer).toBe(true);
+  expect(script.src).toBe(src);
+  expect(script.dataset.sdkn).toBe(
+    `@vercel/speed-insights${framework ? `/${framework}` : ''}`,
+  );
+}

packages/web/src/generic.ts

@@ -20,7 +20,7 @@ const PROXY_SCRIPT_URL = `/_vercel/speed-insights/script.js`;
 function injectSpeedInsights(
   props: SpeedInsightsProps & {
     framework?: string;
-  },
+  } = {},
 ): {
   setRoute: (route: string | null) => void;
 } | null {

packages/web/src/utils.test.ts

@@ -1,7 +1,7 @@
 import { computeRoute } from './utils';
 
 describe('utils', () => {
-  describe('computeRoute', () => {
+  describe('computeRoute()', () => {
     it('returns unchanged pathname if no pathParams provided', () => {
       expect(computeRoute('/vercel/next-site/analytics', null)).toBe(
         '/vercel/next-site/analytics',