@prezly/theme-kit-nextjs 10.9.2 → 10.10.0

package/build/adapters/prezly/telemetry.test.mjs

@@ -0,0 +1,165 @@
+function asyncGeneratorStep(n, t, e, r, o, a, c) { try { var i = n[a](c), u = i.value; } catch (n) { return void e(n); } i.done ? t(u) : Promise.resolve(u).then(r, o); }
+function _asyncToGenerator(n) { return function () { var t = this, e = arguments; return new Promise(function (r, o) { var a = n.apply(t, e); function _next(n) { asyncGeneratorStep(a, r, o, _next, _throw, "next", n); } function _throw(n) { asyncGeneratorStep(a, r, o, _next, _throw, "throw", n); } _next(void 0); }); }; }
+import { createObservedFetch, upstreamRoute } from "./telemetry.mjs";
+import { createBoundedFetch, FetchScheduler } from "./requests.mjs";
+import { PrezlyAdapter } from "./server.mjs";
+var nativeFetch = globalThis.fetch;
+var tick = () => new Promise(resolve => setImmediate(resolve));
+afterEach(() => {
+  globalThis.fetch = nativeFetch;
+  jest.useRealTimers();
+});
+it.each([['/v2/newsrooms/private-id', 'newsroom'], ['/v2/newsrooms/private-id/languages/en_GB', 'languages'], ['/v2/newsrooms/private-id/categories', 'categories'], ['/v2/stories/by-slug/private-slug?token=secret', 'story_by_slug'], ['/v2/stories/search', 'stories'], ['/v2/stories/private-uuid', 'story'], ['/custom/private-path', 'other']])('classifies %s without retaining URL values', (path, expected) => {
+  expect(upstreamRoute("https://private-origin.test".concat(path))).toBe(expected);
+});
+it('observes raw response headers without consuming the body or adding a signal', /*#__PURE__*/_asyncToGenerator(function* () {
+  var events = [];
+  var response = new Response('private-body');
+  var read = jest.spyOn(response, 'arrayBuffer');
+  var fetchMock = jest.fn(/*#__PURE__*/_asyncToGenerator(function* () {
+    return response;
+  }));
+  var options = {
+    headers: {
+      Authorization: 'private-token'
+    }
+  };
+  var observed = createObservedFetch(fetchMock, {
+    observe: e => {
+      events.push(e);
+    },
+    source: 'custom'
+  }, 'raw');
+  expect(yield observed('https://private-origin.test/v2/stories/private-uuid', options)).toBe(response);
+  expect(read).not.toHaveBeenCalled();
+  expect(fetchMock).toHaveBeenCalledWith('https://private-origin.test/v2/stories/private-uuid', options);
+  expect(events).toEqual([expect.objectContaining({
+    type: 'upstream',
+    client: 'raw',
+    route: 'story',
+    source: 'custom',
+    status: '2xx'
+  })]);
+  expect(JSON.stringify(events)).not.toMatch(/private-/);
+}));
+it('keeps telemetry outside the source/cache identity when adapters share work', /*#__PURE__*/_asyncToGenerator(function* () {
+  var events = [];
+  var config = {
+    newsroom: 'private-room',
+    accessToken: 'private-token'
+  };
+  var cache = {
+    memory: true,
+    latestVersion: 1,
+    namespace: 'metrics-adapter-sharing'
+  };
+  globalThis.fetch = jest.fn(/*#__PURE__*/_asyncToGenerator(function* () {
+    return Response.json({
+      newsroom: {
+        name: 'room'
+      }
+    });
+  }));
+  var observed = PrezlyAdapter.connect(config, {
+    cache,
+    telemetry: e => {
+      events.push(e);
+    }
+  }).usePrezlyClient();
+  var plain = PrezlyAdapter.connect(config, {
+    cache
+  }).usePrezlyClient();
+  yield Promise.all([observed.contentDelivery.newsroom(), plain.contentDelivery.newsroom()]);
+  expect(globalThis.fetch).toHaveBeenCalledTimes(1);
+  yield tick();
+  yield observed.contentDelivery.newsroom();
+  expect(globalThis.fetch).toHaveBeenCalledTimes(1);
+  expect(events.filter(e => e.type === 'upstream')).toHaveLength(1);
+  expect(events.some(e => e.type === 'cache_hit')).toBe(true);
+}));
+it('reports queued, full, accepted and completed wait without changing admission limits', /*#__PURE__*/_asyncToGenerator(function* () {
+  var events = [];
+  var telemetry = {
+    observe: e => {
+      events.push(e);
+    }
+  };
+  var scheduler = new FetchScheduler({
+    concurrency: 1,
+    queueLimit: 1
+  });
+  var release;
+  var active = scheduler.run(() => new Promise(r => {
+    release = r;
+  }), undefined, telemetry, 'story');
+  var queued = scheduler.run(/*#__PURE__*/_asyncToGenerator(function* () {
+    return 42;
+  }), undefined, telemetry, 'story');
+  yield expect(scheduler.run(/*#__PURE__*/_asyncToGenerator(function* () {
+    return 0;
+  }), undefined, telemetry, 'story')).rejects.toThrow('queue is full');
+  yield tick();
+  release();
+  yield active;
+  expect(yield queued).toBe(42);
+  yield tick();
+  expect(events.filter(e => e.type === 'fetch_queue').map(e => e.outcome)).toEqual(['accepted', 'queued', 'full', 'accepted']);
+}));
+it('reports queue timeout and body deadline independently of successful HTTP headers', /*#__PURE__*/_asyncToGenerator(function* () {
+  jest.useFakeTimers();
+  var events = [];
+  var telemetry = {
+    observe: e => {
+      events.push(e);
+    }
+  };
+  var scheduler = new FetchScheduler({
+    concurrency: 1,
+    queueLimit: 1,
+    queueTimeout: 10,
+    requestTimeout: 30
+  });
+  var finish;
+  var fetchMock = jest.fn(/*#__PURE__*/_asyncToGenerator(function* () {
+    return new Response(new ReadableStream({
+      start(controller) {
+        finish = () => controller.close();
+      }
+    }));
+  }));
+  var fetch = createBoundedFetch(createObservedFetch(fetchMock, telemetry, 'content'), scheduler, telemetry);
+  var first = fetch('https://example.test/v2/stories/search');
+  var failed = expect(first).rejects.toThrow('timed out');
+  var next = fetch('https://example.test/v2/stories/search');
+  var queued = expect(next).rejects.toThrow('queue wait timed out');
+  yield jest.advanceTimersByTimeAsync(31);
+  yield failed;
+  yield queued;
+  expect(events.filter(e => e.type === 'upstream')).toEqual([expect.objectContaining({
+    status: '2xx'
+  })]);
+  expect(events.filter(e => e.type === 'fetch_timeout')).toHaveLength(1);
+  expect(events).toContainEqual(expect.objectContaining({
+    type: 'fetch_queue',
+    outcome: 'wait_timeout'
+  }));
+  finish();
+  yield jest.advanceTimersByTimeAsync(0);
+  expect(jest.getTimerCount()).toBe(0);
+}));
+it('a throwing or rejecting observer cannot change successful fetch outcomes', /*#__PURE__*/_asyncToGenerator(function* () {
+  var response = new Response('ok');
+  for (var observe of [() => {
+    throw Error('metrics');
+  }, /*#__PURE__*/_asyncToGenerator(function* () {
+    throw Error('metrics');
+  })]) {
+    var fetch = createObservedFetch(/*#__PURE__*/_asyncToGenerator(function* () {
+      return response;
+    }), {
+      observe
+    }, 'raw');
+    expect(yield fetch('https://example.test')).toBe(response);
+  }
+  yield tick();
+}));

package/package.json

@@ -1,118 +1,115 @@
 {
-  "name": "@prezly/theme-kit-nextjs",
-  "version": "10.9.2",
-  "description": "Data layer and utility library for developing Prezly themes with NextJS",
-  "type": "module",
-  "main": "build/index.mjs",
-  "types": "build/index.d.ts",
-  "files": [
-    "build",
-    "README.md"
-  ],
-  "exports": {
-    ".": {
-      "types": "./build/index.d.ts",
-      "require": "./build/index.cjs",
-      "default": "./build/index.mjs"
+    "name": "@prezly/theme-kit-nextjs",
+    "version": "10.10.0",
+    "description": "Data layer and utility library for developing Prezly themes with NextJS",
+    "type": "module",
+    "main": "build/index.mjs",
+    "types": "build/index.d.ts",
+    "files": [
+        "build",
+        "README.md"
+    ],
+    "exports": {
+        ".": {
+            "types": "./build/index.d.ts",
+            "require": "./build/index.cjs",
+            "default": "./build/index.mjs"
+        },
+        "./server": {
+            "types": "./build/server.d.ts",
+            "require": "./build/server.cjs",
+            "default": "./build/server.mjs"
+        },
+        "./middleware": {
+            "types": "./build/middleware/index.d.ts",
+            "require": "./build/middleware/index.cjs",
+            "default": "./build/middleware/index.mjs"
+        },
+        "./next-config": {
+            "types": "./build/next-config/index.d.ts",
+            "require": "./build/next-config/index.cjs",
+            "default": "./build/next-config/index.mjs"
+        },
+        "./sentry": {
+            "types": "./build/sentry/index.d.ts",
+            "require": "./build/sentry/index.cjs",
+            "default": "./build/sentry/index.mjs"
+        },
+        "./playwright": {
+            "types": "./build/playwright/index.d.ts",
+            "require": "./build/playwright/index.cjs",
+            "default": "./build/playwright/index.mjs"
+        }
     },
-    "./server": {
-      "types": "./build/server.d.ts",
-      "require": "./build/server.cjs",
-      "default": "./build/server.mjs"
+    "engines": {
+        "node": ">= 18.18.0",
+        "npm": ">= 8.x"
     },
-    "./middleware": {
-      "types": "./build/middleware/index.d.ts",
-      "require": "./build/middleware/index.cjs",
-      "default": "./build/middleware/index.mjs"
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/prezly/theme-kit-js.git",
+        "directory": "packages/nextjs"
     },
-    "./next-config": {
-      "types": "./build/next-config/index.d.ts",
-      "require": "./build/next-config/index.cjs",
-      "default": "./build/next-config/index.mjs"
+    "keywords": [
+        "prezly",
+        "nextjs"
+    ],
+    "author": "Prezly Team",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/prezly/theme-kit-js/issues"
     },
-    "./sentry": {
-      "types": "./build/sentry/index.d.ts",
-      "require": "./build/sentry/index.cjs",
-      "default": "./build/sentry/index.mjs"
+    "homepage": "https://github.com/prezly/theme-kit-js/tree/main/packages/nextjs#readme",
+    "scripts": {
+        "prepack": "pnpm test:build",
+        "prebuild": "rimraf --glob build/* *.tsbuildinfo",
+        "build": "pnpm build:types && pnpm build:esm && pnpm build:cjs",
+        "build:types": "tsc --project .",
+        "build:esm": "babel --config-file=../../babel.esm.json src/ --extensions=.ts,.tsx --out-dir=build/ --out-file-extension=.mjs",
+        "build:cjs": "babel --config-file=../../babel.cjs.json src/ --extensions=.ts,.tsx --out-dir=build/ --out-file-extension=.cjs",
+        "dev": "tsc --watch --preserveWatchOutput --project .",
+        "typecheck": "tsc --noEmit --emitDeclarationOnly false --incremental --project .",
+        "lint": "biome lint src",
+        "lint:fix": "biome lint --write src",
+        "format": "biome format src",
+        "format:fix": "biome format --write src",
+        "test": "pnpm test:unit && pnpm test:build",
+        "test:unit": "jest",
+        "test:redis": "node tests/test-redis-resilience.cjs",
+        "test:build": "pnpm test:build:cjs && pnpm test:build:esm && pnpm test:build:types",
+        "test:build:types": "tsc --esModuleInterop --noEmit --target es2020 --moduleResolution node tests/test-build-types.ts",
+        "test:build:esm": "node tests/test-build.mjs",
+        "test:build:cjs": "node tests/test-build.cjs"
     },
-    "./playwright": {
-      "types": "./build/playwright/index.d.ts",
-      "require": "./build/playwright/index.cjs",
-      "default": "./build/playwright/index.mjs"
-    }
-  },
-  "engines": {
-    "node": ">= 16.x",
-    "npm": ">= 8.x"
-  },
-  "devEngines": {
-    "node": ">= 16.x",
-    "npm": ">= 8.x"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/prezly/theme-kit-js.git",
-    "directory": "packages/nextjs"
-  },
-  "keywords": [
-    "prezly",
-    "nextjs"
-  ],
-  "author": "Prezly Team",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/prezly/theme-kit-js/issues"
-  },
-  "homepage": "https://github.com/prezly/theme-kit-js/tree/main/packages/nextjs#readme",
-  "peerDependencies": {
-    "@playwright/test": "1.x",
-    "@prezly/sdk": "21.12.0 || ^23.x",
-    "next": "^14.x || ^15.x",
-    "react": "^18.x || ^19.x",
-    "react-dom": "^18.x || ^19.x"
-  },
-  "peerDependenciesMeta": {
-    "@playwright/test": {
-      "optional": true
-    }
-  },
-  "dependencies": {
-    "@noble/hashes": "1.8.0",
-    "@prezly/theme-kit-core": "^10.9.2",
-    "@prezly/theme-kit-intl": "^10.9.1",
-    "@prezly/theme-kit-react": "^10.9.1",
-    "@technically/is-not-undefined": "^1.0.0",
-    "@technically/omit-undefined": "^1.0.4",
-    "json-stable-stringify": "^1.2.1",
-    "redis": "^4.7.0",
-    "url-pattern": "^1.0.3"
-  },
-  "devDependencies": {
-    "@sentry/nextjs": "7.120.4"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "sideEffects": false,
-  "gitHead": "0d33a99980bcf409578f25a666ce4b3f93877caf",
-  "scripts": {
-    "prebuild": "rimraf --glob build/* *.tsbuildinfo",
-    "build": "pnpm build:types && pnpm build:esm && pnpm build:cjs",
-    "build:types": "tsc --project .",
-    "build:esm": "babel --config-file=../../babel.esm.json src/ --extensions=.ts,.tsx --out-dir=build/ --out-file-extension=.mjs",
-    "build:cjs": "babel --config-file=../../babel.cjs.json src/ --extensions=.ts,.tsx --out-dir=build/ --out-file-extension=.cjs",
-    "dev": "tsc --watch --preserveWatchOutput --project .",
-    "typecheck": "tsc --noEmit --emitDeclarationOnly false --incremental --project .",
-    "lint": "biome lint src",
-    "lint:fix": "biome lint --write src",
-    "format": "biome format src",
-    "format:fix": "biome format --write src",
-    "test": "pnpm test:unit && pnpm test:build",
-    "test:unit": "jest",
-    "test:redis": "node tests/test-redis-resilience.cjs",
-    "test:build": "pnpm test:build:cjs && pnpm test:build:esm && pnpm test:build:types",
-    "test:build:types": "tsc --esModuleInterop --noEmit build/index.d.ts",
-    "test:build:esm": "node tests/test-build.mjs",
-    "test:build:cjs": "node tests/test-build.cjs"
-  }
-}
+    "peerDependencies": {
+        "@playwright/test": "1.x",
+        "@prezly/sdk": "21.12.0 || ^23.x",
+        "next": "^14.x || ^15.x",
+        "react": "^18.x || ^19.x",
+        "react-dom": "^18.x || ^19.x"
+    },
+    "peerDependenciesMeta": {
+        "@playwright/test": {
+            "optional": true
+        }
+    },
+    "dependencies": {
+        "@noble/hashes": "1.8.0",
+        "@prezly/theme-kit-core": "workspace:^",
+        "@prezly/theme-kit-intl": "workspace:^",
+        "@prezly/theme-kit-react": "workspace:^",
+        "@technically/is-not-undefined": "^1.0.0",
+        "@technically/omit-undefined": "^1.0.4",
+        "json-stable-stringify": "^1.2.1",
+        "redis": "^4.7.0",
+        "url-pattern": "^1.0.3"
+    },
+    "devDependencies": {
+        "@sentry/nextjs": "7.120.4"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "sideEffects": false,
+    "gitHead": "51b1ce99cf8ce2c886001077bcaf95cb143f86ce"
+}