@rsdk/nats.kv 5.4.0-next.2

package/src/watch-kv.service.ts

@@ -0,0 +1,124 @@
+import { Inject } from '@nestjs/common';
+import { DiscoveryService } from '@nestjs/core';
+import { InjectLogger } from '@rsdk/core';
+import { ILogger } from '@rsdk/logging';
+import type { KV, KvEntry, KvWatchOptions } from 'nats';
+import { KvWatchInclude } from 'nats';
+
+import { NatsKvService } from './nats-kv.service';
+import type { KvWatcher, WatchConfig } from './watch-kv.decorator';
+import { WatchKv } from './watch-kv.decorator';
+
+export class WatchKvService {
+  constructor(
+    @InjectLogger(WatchKvService)
+    private readonly logger: ILogger,
+    private readonly discovery: DiscoveryService,
+    private readonly nats: NatsKvService,
+    @Inject('CONNECTION_NAME')
+    private readonly connectionName?: string,
+  ) {}
+
+  /**
+   * Runs the watches for the key-value service.
+   * Waits for buckets to exist and starts the watch operation for each bucket.
+   */
+  public async runWatches(): Promise<void> {
+    const watchers = await this.discoverWatchers();
+
+    await Promise.all(
+      watchers.map(async ({ instance, metadata }) => {
+        await this.nats.waitForBucketExists(metadata.bucket, 5000);
+        await this.runWatch(metadata, instance);
+        this.logger.info('NatsKV watcher started', { metadata });
+      }),
+    );
+  }
+
+  /**
+   * Stops all watches.
+   *
+   * @note This method is not implemented yet.
+   */
+  public async stopWatches(): Promise<void> {
+    // TODO: Implement
+  }
+
+  public async watch(
+    kv: KV,
+    opts: KvWatchOptions,
+    callback: (event: KvEntry) => Promise<void>,
+  ): Promise<void> {
+    for await (const entry of await kv.watch(opts)) {
+      callback(entry).catch((error) => {
+        this.logger.error('Error processing KV entry', { entry, err: error });
+      });
+    }
+  }
+
+  /**
+   * Runs the watch operation for the given metadata and watcher.
+   *
+   * @param config - The watch configuration.
+   * @param watcher - The KvWatcher instance.
+   * @returns A Promise that resolves when the watch operation is complete.
+   */
+  private async runWatch(
+    config: WatchConfig,
+    watcher: KvWatcher,
+  ): Promise<void> {
+    const kv = await this.nats.create({
+      bucketName: config.bucket,
+      bindOnly: true,
+    });
+
+    this.watch(
+      kv.getRawStorage(),
+      { include: KvWatchInclude.LastValue },
+      async (event) => {
+        switch (event.operation) {
+          case 'PUT':
+            await watcher.onPut(event);
+            break;
+          case 'DEL':
+            await watcher.onDelete(event);
+            break;
+          case 'PURGE':
+            await watcher.onDelete(event);
+            break;
+        }
+      },
+    );
+  }
+
+  /**
+   * Discovers and returns an array of KvWatcher instances along with their corresponding metadata.
+   *
+   * @returns An array of objects containing the KvWatcher instance and its metadata.
+   */
+  private discoverWatchers(): { instance: KvWatcher; metadata: WatchConfig }[] {
+    return this.discovery.getProviders().reduce(
+      (acc, watcher) => {
+        /**
+         * NOTE: This is a fix for TypeError in call .getMetadataByDecorator() above
+         * because some tokens are not instances of classes and have no constructor.
+         * */
+        const clsRef = watcher.instance?.constructor ?? watcher.metatype;
+        if (!clsRef) {
+          return acc;
+        }
+
+        const metadata = this.discovery.getMetadataByDecorator(
+          WatchKv,
+          watcher,
+        );
+
+        if (metadata && metadata.connectionName === this.connectionName) {
+          acc.push({ instance: watcher.instance, metadata });
+        }
+        return acc;
+      },
+      [] as { instance: KvWatcher; metadata: WatchConfig }[],
+    );
+  }
+}

package/tsconfig.build.json

@@ -0,0 +1,12 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": [
+    "node_modules",
+    "dist",
+    "test",
+    "**/*.spec.ts",
+    "**/*.test.ts",
+    "**/*.test.e2e.ts",
+    "**/*.test.manual-e2e.ts",
+  ]
+}

package/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "@rsdk/tsconfig/base.json",
+  "compilerOptions": {
+    "declaration": true,
+    "outDir": "dist"
+  }
+}