@prezly/theme-kit-nextjs 10.9.3 → 10.10.1

package/README.md

@@ -413,8 +413,30 @@ new retained key namespaces for every token or invalidation version. This create
 a one-time cold cache on upgrade. Roll out gradually and warm representative
 newsrooms before an expected traffic spike. Existing unscoped entries remain
 subject to their configured expiration; do not flush a Redis instance that also
-contains routing data. TTL, negative-cache classification and query
-canonicalization are separate policies and are unchanged here.
+contains routing data. TTL and query canonicalization are separate policies and
+are unchanged here.
+
+### Not-found results
+
+`contentDelivery.story()` and `contentDelivery.gallery()` resolve `null` when the
+API answers 403, 404 or 410. A `null` result is a cache hit like any other value:
+only an absent entry falls back to the API, so `false` and `0` are also valid
+cached values. Not-found entries are kept for `negativeTtl` seconds (default 60,
+`ContentDelivery.DEFAULT_NEGATIVE_TTL`). The deadline is written into the cached
+envelope and checked on every read, so a cache layer that ignores the `ttl`
+hint, or a `null` entry written by an older Theme Kit, is a miss rather than a
+stale hit. Memory and Redis also expire these entries on their own, and Redis
+does not renew that lifetime on read. A cache version change still invalidates
+them at once, so publishing a story makes it visible immediately; a story that
+becomes available without a version change appears within the TTL. Errors such
+as 401, 429, 5xx and transport failures throw and are never stored. `undefined`
+results are not stored either.
+
+Set `cache.negativeTtl` in `PrezlyAdapter.connect` to change the retention. It
+must be a positive integer number of seconds. Not-found caching needs the
+source/authorization scope described above; a client created with a custom
+`fetch` and no `requestScope` keeps treating `null` as a miss and does not
+store it.
 
 ### Verification and release
 

package/build/adapters/prezly/cache/configure.cjs

@@ -19,7 +19,8 @@ function configure(config) {
   if (storage) {
     return {
       storage: config.namespace ? storage.namespace(config.namespace) : storage,
-      latestVersion: _themeKitCore.Resolvable.resolve(config.latestVersion)
+      latestVersion: _themeKitCore.Resolvable.resolve(config.latestVersion),
+      negativeTtl: config.negativeTtl
     };
   }
   return undefined;

package/build/adapters/prezly/cache/configure.d.ts

@@ -10,9 +10,12 @@ export interface Configuration {
     namespace?: string;
     /** Extra immutable identity for custom fetch implementations. Enables request sharing. */
     requestScope?: string;
+    /** Retention in seconds for not-found results. See `ContentDelivery.DEFAULT_NEGATIVE_TTL`. */
+    negativeTtl?: number;
     telemetry?: ContentDelivery.Telemetry;
 }
 export declare function configure(config: Configuration): {
     storage: ContentDelivery.Cache;
     latestVersion: number;
+    negativeTtl: number | undefined;
 } | undefined;

package/build/adapters/prezly/cache/configure.mjs

@@ -13,7 +13,8 @@ export function configure(config) {
   if (storage) {
     return {
       storage: config.namespace ? storage.namespace(config.namespace) : storage,
-      latestVersion: Resolvable.resolve(config.latestVersion)
+      latestVersion: Resolvable.resolve(config.latestVersion),
+      negativeTtl: config.negativeTtl
     };
   }
   return undefined;

package/build/adapters/prezly/cache/redis.cjs

@@ -89,14 +89,16 @@ function createRedisCache(_ref) {
           if (!cached) return undefined;
           var entry = JSON.parse(cached);
           if (entry.version < latestVersion) return undefined;
-          if (ttl) {
+          // Sliding expiry applies to regular content only. An entry with its
+          // own short retention must not be renewed to the default lifetime.
+          if (ttl && entry.ttl === undefined) {
             void command(() => connection.expire("".concat(namespacePrefix).concat(key), ttl), telemetry, 'expire').catch(() => undefined);
           }
           if (onSource) _themeKitCore.ContentDelivery.notify(onSource, 'redis');
           return entry.value;
         })();
       },
-      set(key, value, version) {
+      set(key, value, version, options) {
         return _asyncToGenerator(function* () {
           if (!connection.isReady) {
             _themeKitCore.ContentDelivery.emit(telemetry, {
@@ -105,13 +107,21 @@ function createRedisCache(_ref) {
             });
             return;
           }
-          var entry = {
+          // SET EX takes whole seconds; round a fractional hint up, never down.
+          var entry = (options === null || options === void 0 ? void 0 : options.ttl) === undefined ? {
             value,
             version
+          } : {
+            value,
+            version,
+            ttl: Math.max(1, Math.ceil(options.ttl))
           };
-          yield command(() => connection.set("".concat(namespacePrefix).concat(key), JSON.stringify(entry), {
-            EX: ttl
-          }), telemetry, 'set');
+          yield command(() => {
+            var _entry$ttl;
+            return connection.set("".concat(namespacePrefix).concat(key), JSON.stringify(entry), {
+              EX: (_entry$ttl = entry.ttl) !== null && _entry$ttl !== void 0 ? _entry$ttl : ttl
+            });
+          }, telemetry, 'set');
         })();
       },
       namespace(namespace) {

package/build/adapters/prezly/cache/redis.mjs

@@ -82,14 +82,16 @@ export function createRedisCache(_ref) {
           if (!cached) return undefined;
           var entry = JSON.parse(cached);
           if (entry.version < latestVersion) return undefined;
-          if (ttl) {
+          // Sliding expiry applies to regular content only. An entry with its
+          // own short retention must not be renewed to the default lifetime.
+          if (ttl && entry.ttl === undefined) {
             void command(() => connection.expire("".concat(namespacePrefix).concat(key), ttl), telemetry, 'expire').catch(() => undefined);
           }
           if (onSource) ContentDelivery.notify(onSource, 'redis');
           return entry.value;
         })();
       },
-      set(key, value, version) {
+      set(key, value, version, options) {
         return _asyncToGenerator(function* () {
           if (!connection.isReady) {
             ContentDelivery.emit(telemetry, {
@@ -98,13 +100,21 @@ export function createRedisCache(_ref) {
             });
             return;
           }
-          var entry = {
+          // SET EX takes whole seconds; round a fractional hint up, never down.
+          var entry = (options === null || options === void 0 ? void 0 : options.ttl) === undefined ? {
             value,
             version
+          } : {
+            value,
+            version,
+            ttl: Math.max(1, Math.ceil(options.ttl))
           };
-          yield command(() => connection.set("".concat(namespacePrefix).concat(key), JSON.stringify(entry), {
-            EX: ttl
-          }), telemetry, 'set');
+          yield command(() => {
+            var _entry$ttl;
+            return connection.set("".concat(namespacePrefix).concat(key), JSON.stringify(entry), {
+              EX: (_entry$ttl = entry.ttl) !== null && _entry$ttl !== void 0 ? _entry$ttl : ttl
+            });
+          }, telemetry, 'set');
         })();
       },
       namespace(namespace) {

package/build/adapters/prezly/cache/redis.test.cjs

@@ -83,12 +83,73 @@ it('preserves namespace, version and sliding expiry and observes expiry rejectio
     EX: 300
   });
 }));
+it('stores a short-lived entry with its own expiry and never renews it', /*#__PURE__*/_asyncToGenerator(function* () {
+  var _connection3 = connection(),
+    client = _connection3.client,
+    cache = _connection3.cache;
+  yield cache.set('missing', null, 4, {
+    ttl: 60
+  });
+  expect(client.set).toHaveBeenLastCalledWith('test:missing', JSON.stringify({
+    value: null,
+    version: 4,
+    ttl: 60
+  }), {
+    EX: 60
+  });
+  client.get.mockResolvedValueOnce(JSON.stringify({
+    value: null,
+    version: 4,
+    ttl: 60
+  }));
+  var onSource = jest.fn();
+  expect(yield cache.get('missing', 4, onSource)).toBeNull();
+  expect(onSource).toHaveBeenCalledWith('redis');
+  expect(client.expire).not.toHaveBeenCalled();
+  client.get.mockResolvedValueOnce(JSON.stringify({
+    value: null,
+    version: 4,
+    ttl: 60
+  }));
+  expect(yield cache.get('missing', 5)).toBeUndefined();
+}));
+it('rounds a fractional ttl hint up to whole seconds for SET EX', /*#__PURE__*/_asyncToGenerator(function* () {
+  var _connection4 = connection(),
+    client = _connection4.client,
+    cache = _connection4.cache;
+  yield cache.set('short', null, 1, {
+    ttl: 0.5
+  });
+  expect(client.set).toHaveBeenLastCalledWith('test:short', JSON.stringify({
+    value: null,
+    version: 1,
+    ttl: 1
+  }), {
+    EX: 1
+  });
+}));
+it.each([false, 0, ''])('returns a stored %p as a hit', /*#__PURE__*/function () {
+  var _ref8 = _asyncToGenerator(function* (value) {
+    var _connection5 = connection(),
+      client = _connection5.client,
+      cache = _connection5.cache;
+    client.get.mockResolvedValueOnce(JSON.stringify({
+      value,
+      version: 2
+    }));
+    expect(yield cache.get('key', 2)).toBe(value);
+    expect(client.expire).toHaveBeenCalledTimes(1);
+  });
+  return function (_x) {
+    return _ref8.apply(this, arguments);
+  };
+}());
 it.each(['get', 'set'])('times out stalled %s commands without unsafe cancellation and recovers', /*#__PURE__*/function () {
-  var _ref6 = _asyncToGenerator(function* (method) {
+  var _ref9 = _asyncToGenerator(function* (method) {
     jest.useFakeTimers();
-    var _connection3 = connection(),
-      client = _connection3.client,
-      cache = _connection3.cache;
+    var _connection6 = connection(),
+      client = _connection6.client,
+      cache = _connection6.cache;
     var rejectOperation;
     client[method].mockImplementationOnce(() => new Promise((_, reject) => {
       rejectOperation = reject;
@@ -102,14 +163,14 @@ it.each(['get', 'set'])('times out stalled %s commands without unsafe cancellati
     yield jest.advanceTimersByTimeAsync(0);
     expect(jest.getTimerCount()).toBe(0);
   });
-  return function (_x) {
-    return _ref6.apply(this, arguments);
+  return function (_x2) {
+    return _ref9.apply(this, arguments);
   };
 }());
 it('does not fragment Redis connections by observer and distinguishes unavailable from commands', /*#__PURE__*/_asyncToGenerator(function* () {
-  var _connection4 = connection(false),
-    client = _connection4.client,
-    options = _connection4.options;
+  var _connection7 = connection(false),
+    client = _connection7.client,
+    options = _connection7.options;
   var events = [];
   var observe = event => {
     events.push(event);

package/build/adapters/prezly/cache/redis.test.mjs

@@ -81,12 +81,73 @@ it('preserves namespace, version and sliding expiry and observes expiry rejectio
     EX: 300
   });
 }));
+it('stores a short-lived entry with its own expiry and never renews it', /*#__PURE__*/_asyncToGenerator(function* () {
+  var _connection3 = connection(),
+    client = _connection3.client,
+    cache = _connection3.cache;
+  yield cache.set('missing', null, 4, {
+    ttl: 60
+  });
+  expect(client.set).toHaveBeenLastCalledWith('test:missing', JSON.stringify({
+    value: null,
+    version: 4,
+    ttl: 60
+  }), {
+    EX: 60
+  });
+  client.get.mockResolvedValueOnce(JSON.stringify({
+    value: null,
+    version: 4,
+    ttl: 60
+  }));
+  var onSource = jest.fn();
+  expect(yield cache.get('missing', 4, onSource)).toBeNull();
+  expect(onSource).toHaveBeenCalledWith('redis');
+  expect(client.expire).not.toHaveBeenCalled();
+  client.get.mockResolvedValueOnce(JSON.stringify({
+    value: null,
+    version: 4,
+    ttl: 60
+  }));
+  expect(yield cache.get('missing', 5)).toBeUndefined();
+}));
+it('rounds a fractional ttl hint up to whole seconds for SET EX', /*#__PURE__*/_asyncToGenerator(function* () {
+  var _connection4 = connection(),
+    client = _connection4.client,
+    cache = _connection4.cache;
+  yield cache.set('short', null, 1, {
+    ttl: 0.5
+  });
+  expect(client.set).toHaveBeenLastCalledWith('test:short', JSON.stringify({
+    value: null,
+    version: 1,
+    ttl: 1
+  }), {
+    EX: 1
+  });
+}));
+it.each([false, 0, ''])('returns a stored %p as a hit', /*#__PURE__*/function () {
+  var _ref8 = _asyncToGenerator(function* (value) {
+    var _connection5 = connection(),
+      client = _connection5.client,
+      cache = _connection5.cache;
+    client.get.mockResolvedValueOnce(JSON.stringify({
+      value,
+      version: 2
+    }));
+    expect(yield cache.get('key', 2)).toBe(value);
+    expect(client.expire).toHaveBeenCalledTimes(1);
+  });
+  return function (_x) {
+    return _ref8.apply(this, arguments);
+  };
+}());
 it.each(['get', 'set'])('times out stalled %s commands without unsafe cancellation and recovers', /*#__PURE__*/function () {
-  var _ref6 = _asyncToGenerator(function* (method) {
+  var _ref9 = _asyncToGenerator(function* (method) {
     jest.useFakeTimers();
-    var _connection3 = connection(),
-      client = _connection3.client,
-      cache = _connection3.cache;
+    var _connection6 = connection(),
+      client = _connection6.client,
+      cache = _connection6.cache;
     var rejectOperation;
     client[method].mockImplementationOnce(() => new Promise((_, reject) => {
       rejectOperation = reject;
@@ -100,14 +161,14 @@ it.each(['get', 'set'])('times out stalled %s commands without unsafe cancellati
     yield jest.advanceTimersByTimeAsync(0);
     expect(jest.getTimerCount()).toBe(0);
   });
-  return function (_x) {
-    return _ref6.apply(this, arguments);
+  return function (_x2) {
+    return _ref9.apply(this, arguments);
   };
 }());
 it('does not fragment Redis connections by observer and distinguishes unavailable from commands', /*#__PURE__*/_asyncToGenerator(function* () {
-  var _connection4 = connection(false),
-    client = _connection4.client,
-    options = _connection4.options;
+  var _connection7 = connection(false),
+    client = _connection7.client,
+    options = _connection7.options;
   var events = [];
   var observe = event => {
     events.push(event);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prezly/theme-kit-nextjs",
-  "version": "10.9.3",
+  "version": "10.10.1",
   "description": "Data layer and utility library for developing Prezly themes with NextJS",
   "type": "module",
   "main": "build/index.mjs",
@@ -45,10 +45,6 @@
     "node": ">= 18.18.0",
     "npm": ">= 8.x"
   },
-  "devEngines": {
-    "node": ">= 18.18.0",
-    "npm": ">= 8.x"
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/prezly/theme-kit-js.git",
@@ -78,14 +74,14 @@
   },
   "dependencies": {
     "@noble/hashes": "1.8.0",
-    "@prezly/theme-kit-core": "^10.9.3",
-    "@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"
+    "url-pattern": "^1.0.3",
+    "@prezly/theme-kit-core": "^10.10.1",
+    "@prezly/theme-kit-react": "^10.9.1",
+    "@prezly/theme-kit-intl": "^10.9.1"
   },
   "devDependencies": {
     "@sentry/nextjs": "7.120.4"
@@ -94,7 +90,7 @@
     "access": "public"
   },
   "sideEffects": false,
-  "gitHead": "31134742a0ff3f3e669283f94843c3222eac8ebd",
+  "gitHead": "51b1ce99cf8ce2c886001077bcaf95cb143f86ce",
   "scripts": {
     "prebuild": "rimraf --glob build/* *.tsbuildinfo",
     "build": "pnpm build:types && pnpm build:esm && pnpm build:cjs",