@nage-api/cache 1.0.0-beta.2

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,127 @@
+# @nage-api/cache
+
+A typed cache that fails soft (PLAN.md §8, §25 P1).
+
+Three drivers behind one service: `memory` for a single instance, `redis` for a
+shared one, `two-tier` for both. Application code injects `CacheService` and
+never learns which it got.
+
+## Wiring it up
+
+```ts
+import { Module } from '@nestjs/common';
+import { NageCacheModule, type RedisClientPort } from '@nage-api/cache';
+import type { LoggerPort } from '@nage-api/contracts';
+
+// Whichever client the application already has: ioredis, node-redis, or a fake
+// in tests. This package names the six commands it needs and depends on none of
+// them. Only `redis` and `two-tier` require one.
+declare const redis: RedisClientPort;
+declare const logger: LoggerPort;
+
+@Module({
+  imports: [
+    NageCacheModule.forRoot({
+      cache: { driver: 'two-tier', namespace: 'shop', ttl: '5m' },
+      redis,
+      // A broken shared tier is reported, not thrown. Without a handler the
+      // failure is silent and the only symptom is a slower application.
+      onRemoteError: (operation, error) => {
+        logger.warn('cache: remote tier failed', { operation, error });
+      },
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+## Using it
+
+`CacheService` is exported by the module, so injecting the class is enough.
+
+```ts
+import { Injectable } from '@nestjs/common';
+import { CacheService } from '@nage-api/cache';
+
+interface Product {
+  readonly id: string;
+  readonly name: string;
+}
+
+declare const repository: { findById(id: string): Promise<Product | undefined> };
+
+@Injectable()
+export class ProductService {
+  constructor(private readonly cache: CacheService) {}
+
+  async find(id: string): Promise<Product | undefined> {
+    return this.cache.wrap(`product:${id}`, () => repository.findById(id), {
+      ttl: '5m',
+      tags: [`product:${id}`],
+    });
+  }
+
+  async onProductChanged(id: string): Promise<void> {
+    // Drops the row's own entry and every list that included it.
+    await this.cache.invalidateTag(`product:${id}`);
+  }
+
+  async onBulkImport(): Promise<void> {
+    await this.cache.namespace('product').invalidateNamespace();
+  }
+}
+```
+
+## What it adds over a `Map`
+
+**Single-flight.** Concurrent `wrap` calls for one key run the loader once. A
+popular key expiring under load otherwise starts one identical query per
+in-flight request — the stampede that turns a cache miss into an outage. The
+in-flight entry is cleared in a `finally`, so a failed load doesn't poison the
+key for everyone who asks next.
+
+**Bounded memory.** The in-process store evicts least-recently-used entries and
+sweeps expired ones on a timer. An unbounded map keyed by anything a request can
+influence is a memory leak with a slow fuse. The timer is `unref`'d, so a cache
+never keeps a process alive.
+
+**Namespaces and tags.** Every key is prefixed, so a namespace can be dropped
+without knowing which keys it wrote, and an entry can carry labels so a write to
+one row invalidates every list that included it.
+
+**Absence is not cached by default.** Caching `undefined` is how a race writes a
+tombstone over a value that arrived a millisecond later. `cacheEmpty: true`
+turns it on where "not found" is the common answer.
+
+## Two tiers
+
+L1 is in-process, L2 is shared, and L1 holds a **shorter** TTL than L2 —
+capped by `l1TtlMs`, five seconds by default. That cap is the safety argument:
+an in-process copy is the one nothing can invalidate remotely, so staleness is
+bounded by a number you chose rather than by when a process happens to restart.
+A local delete clears L1 immediately, so the instance that made a change never
+reads its own stale value.
+
+A cache is an optimisation, so a broken L2 degrades rather than throws: remote
+failures are reported through `onRemoteError` and the request is served from L1
+or from the source. A value Redis returns that will not parse is a miss, not an
+exception.
+
+## Redis without a Redis dependency
+
+`RedisCacheStore` is written against `RedisClientPort` — six commands — rather
+than against ioredis or node-redis. The heavyweight client stays out of the
+install for the deployments that never use it, and the store is testable
+without a daemon, which is what the suite does.
+
+Two details worth keeping: prefix invalidation uses `SCAN`, never `KEYS` (which
+is O(n) over the keyspace and blocks the server every other service depends
+on), and `clear()` is scoped to the store's own prefix rather than flushing the
+database out from under its neighbours.
+
+## Not yet implemented
+
+- A `@Cacheable()` method decorator. The explicit `wrap` call is currently the
+  only entry point, which keeps the cache key visible at the call site.
+- Stale-while-revalidate: `CacheOutcome` reserves a `stale` case for it.
+- Redis Cluster tag indexes; the tag set assumes a single keyspace.

package/dist/cache.module.d.ts

@@ -0,0 +1,34 @@
+/**
+ * `NageCacheModule.forRoot(config)` (PLAN.md §11.1 item 6).
+ *
+ * Disabled is the default, and a disabled feature contributes **no provider** —
+ * not a no-op one. The acceptance criterion for Phase 8 is that enabling and
+ * disabling a feature cleanly adds and removes providers, so a module that
+ * always registered a null cache would pass by cheating.
+ *
+ * The driver is chosen here, once, from configuration: `memory` for a single
+ * instance, `redis` for a shared one, `two-tier` for both. Application code
+ * injects `CacheService` and never learns which it got.
+ */
+import { type DynamicModule, type OnApplicationShutdown } from '@nestjs/common';
+import type { CacheConfig } from '@nage-api/contracts';
+import { type RedisClientPort } from './redis.store.js';
+import type { CacheStore, Clock } from './ports.js';
+export interface NageCacheModuleOptions {
+    readonly cache?: CacheConfig;
+    /** Required when the driver is `redis` or `two-tier`. */
+    readonly redis?: RedisClientPort;
+    /** Supply a store directly, bypassing driver selection. */
+    readonly store?: CacheStore;
+    readonly clock?: Clock;
+    /** Reported when the shared tier fails; a broken L2 degrades, never throws. */
+    readonly onRemoteError?: (operation: string, error: unknown) => void;
+}
+export declare class NageCacheModule implements OnApplicationShutdown {
+    static forRoot(options?: NageCacheModuleOptions): DynamicModule;
+    /** Stop the sweep timers so a test suite and a `SIGTERM` both exit cleanly. */
+    onApplicationShutdown(): void;
+    private static buildStore;
+    private static memoryStore;
+}
+//# sourceMappingURL=cache.module.d.ts.map

package/dist/cache.module.js

@@ -0,0 +1,100 @@
+"use strict";
+/**
+ * `NageCacheModule.forRoot(config)` (PLAN.md §11.1 item 6).
+ *
+ * Disabled is the default, and a disabled feature contributes **no provider** —
+ * not a no-op one. The acceptance criterion for Phase 8 is that enabling and
+ * disabling a feature cleanly adds and removes providers, so a module that
+ * always registered a null cache would pass by cheating.
+ *
+ * The driver is chosen here, once, from configuration: `memory` for a single
+ * instance, `redis` for a shared one, `two-tier` for both. Application code
+ * injects `CacheService` and never learns which it got.
+ */
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var NageCacheModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NageCacheModule = void 0;
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nage-api/core");
+const cache_service_js_1 = require("./cache.service.js");
+const memory_store_js_1 = require("./memory.store.js");
+const redis_store_js_1 = require("./redis.store.js");
+const two_tier_store_js_1 = require("./two-tier.store.js");
+const tokens_js_1 = require("./tokens.js");
+/**
+ * Sweep timers created by `forRoot`, so shutdown can stop them.
+ *
+ * Module-scope rather than a static field: a decorated class may not carry a
+ * static private identifier, and a public static would be part of the API.
+ */
+const sweepers = [];
+let NageCacheModule = NageCacheModule_1 = class NageCacheModule {
+    static forRoot(options = {}) {
+        const config = options.cache ?? {};
+        // Off means off: no store, no service, nothing to inject.
+        if (config.enabled === false) {
+            return { module: NageCacheModule_1, providers: [], exports: [] };
+        }
+        const store = options.store ?? NageCacheModule_1.buildStore(config, options);
+        const service = new cache_service_js_1.CacheService({
+            store,
+            ...(config.namespace === undefined ? {} : { namespace: config.namespace }),
+            defaultTtlMs: config.ttl === undefined ? 0 : (0, core_1.parseDurationMs)(config.ttl),
+            ...(options.clock === undefined ? {} : { clock: options.clock }),
+        });
+        const providers = [
+            { provide: tokens_js_1.NAGE_CACHE_STORE, useValue: store },
+            { provide: tokens_js_1.NAGE_CACHE, useValue: service },
+            { provide: cache_service_js_1.CacheService, useValue: service },
+        ];
+        return {
+            module: NageCacheModule_1,
+            providers,
+            exports: [tokens_js_1.NAGE_CACHE, tokens_js_1.NAGE_CACHE_STORE, cache_service_js_1.CacheService],
+        };
+    }
+    /** Stop the sweep timers so a test suite and a `SIGTERM` both exit cleanly. */
+    onApplicationShutdown() {
+        for (const store of sweepers.splice(0))
+            store.stop();
+    }
+    static buildStore(config, options) {
+        const driver = config.driver ?? 'memory';
+        if (driver === 'memory')
+            return NageCacheModule_1.memoryStore(options);
+        if (options.redis === undefined) {
+            throw new core_1.ConfigurationError({
+                detail: `cache.driver "${driver}" needs a Redis client; pass one to NageCacheModule.forRoot({ redis })`,
+                meta: { setting: 'cache.driver', driver },
+            });
+        }
+        const remote = new redis_store_js_1.RedisCacheStore({
+            client: options.redis,
+            ...(config.namespace === undefined ? {} : { keyPrefix: `${config.namespace}:` }),
+        });
+        if (driver === 'redis')
+            return remote;
+        return new two_tier_store_js_1.TwoTierCacheStore({
+            l1: NageCacheModule_1.memoryStore(options),
+            l2: remote,
+            ...(options.clock === undefined ? {} : { clock: options.clock }),
+            ...(options.onRemoteError === undefined ? {} : { onRemoteError: options.onRemoteError }),
+        });
+    }
+    static memoryStore(options) {
+        const store = new memory_store_js_1.MemoryCacheStore(options.clock === undefined ? {} : { clock: options.clock });
+        sweepers.push(store);
+        return store;
+    }
+};
+exports.NageCacheModule = NageCacheModule;
+exports.NageCacheModule = NageCacheModule = NageCacheModule_1 = __decorate([
+    (0, common_1.Module)({})
+], NageCacheModule);
+//# sourceMappingURL=cache.module.js.map

package/dist/cache.service.d.ts

@@ -0,0 +1,73 @@
+/**
+ * The typed cache application code uses (PLAN.md §8).
+ *
+ * Three things it adds over a bare store:
+ *
+ * **Namespacing.** Every key is prefixed, so `cache.namespace('product')` can
+ * be dropped wholesale without knowing which keys it wrote. The legacy
+ * framework shared one flat keyspace, which meant invalidation was either
+ * surgical-and-wrong or a full flush.
+ *
+ * **Single-flight.** Concurrent `wrap` calls for the same key run the loader
+ * once. Without it, a popular key expiring under load starts one identical
+ * database query per in-flight request — the cache stampede that turns a cache
+ * miss into an outage.
+ *
+ * **Typing.** `wrap<T>` returns `T`, not `any`. A cache that hands back
+ * `unknown` pushes a cast to every call site, and those casts are where a
+ * schema change stops being a type error.
+ */
+import type { CacheStats, CacheStore, Clock } from './ports.js';
+export interface CacheServiceOptions {
+    readonly store: CacheStore;
+    /** Prefix applied to every key, e.g. the application name. */
+    readonly namespace?: string;
+    /** Default entry lifetime; `0` means "until invalidated". */
+    readonly defaultTtlMs?: number;
+    readonly clock?: Clock;
+}
+export interface CacheSetOptions {
+    /** Milliseconds, or a duration string like `5m`. */
+    readonly ttl?: number | string;
+    readonly tags?: readonly string[];
+}
+export interface CacheWrapOptions extends CacheSetOptions {
+    /**
+     * Skip the read and refresh the entry. For a "force refresh" button, not for
+     * routine use.
+     */
+    readonly refresh?: boolean;
+    /**
+     * Cache a loader's `undefined` result too.
+     *
+     * Off by default, because caching absence is how a race writes a tombstone
+     * over a value that arrived a millisecond later. Turn it on for lookups where
+     * "not found" is the common answer and the cost of a stale miss is low.
+     */
+    readonly cacheEmpty?: boolean;
+}
+export declare class CacheService {
+    #private;
+    constructor(options: CacheServiceOptions);
+    /** A view scoped to a sub-namespace, sharing the same store and counters. */
+    namespace(name: string): CacheService;
+    get<TValue>(key: string): Promise<TValue | undefined>;
+    set(key: string, value: unknown, options?: CacheSetOptions): Promise<void>;
+    delete(key: string): Promise<void>;
+    /** Drop everything this namespace wrote. */
+    invalidateNamespace(name?: string): Promise<number>;
+    /** Drop every entry labelled with a tag, wherever it was written. */
+    invalidateTag(tag: string): Promise<number>;
+    /**
+     * Read through the cache, loading on a miss.
+     *
+     * Concurrent calls for the same key share one loader invocation, so a key
+     * expiring under load costs one query rather than one per request.
+     */
+    wrap<TValue>(key: string, load: () => Promise<TValue>, options?: CacheWrapOptions): Promise<TValue>;
+    get stats(): CacheStats;
+    resetStats(): void;
+}
+/** Accepts milliseconds or a duration string, so config and code agree. */
+export declare function toMilliseconds(ttl: number | string | undefined): number | undefined;
+//# sourceMappingURL=cache.service.d.ts.map