@rsdk/actx 4.2.0-next.1

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [4.2.0-next.1](https://github.com/R-Vision/rsdk/compare/v4.2.0-next.0...v4.2.0-next.1) (2024-02-02)
+
+### Features
+
+* rework work with async context ([#201](https://github.com/R-Vision/rsdk/issues/201)) ([26de1a8](https://github.com/R-Vision/rsdk/commit/26de1a814692bcd082c2f1aaedad1215ec0df1a0))

package/dist/async-context.d.ts

@@ -0,0 +1,7 @@
+export declare class AsyncContext {
+    static set(key: string, v: unknown, rewritable?: boolean): void;
+    static get<V>(key: string): V;
+    static has(key: string): boolean;
+    private static getStoreOrThrow;
+    private static assertRewritable;
+}

package/dist/async-context.interceptor.d.ts

@@ -0,0 +1,10 @@
+import type { CallHandler, ExecutionContext, NestInterceptor } from '@nestjs/common';
+import { Observable } from 'rxjs';
+/**
+ * Interceptor for initialize `AsyncLocalStorage`.
+ * Official recipe https://docs.nestjs.com/recipes/async-local-storage doesn't work with microservices.
+ * One of correctly working realization - https://github.com/Papooch/nestjs-cls/blob/26afd86edd9ef17af49f613d1b7af95b36d5ca97/packages/core/src/lib/cls-initializers/cls.interceptor.ts#L28.
+ */
+export declare class AsyncContextInterceptor implements NestInterceptor {
+    intercept(_context: ExecutionContext, next: CallHandler): Observable<any>;
+}

package/dist/async-context.interceptor.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AsyncContextInterceptor = void 0;
+const rxjs_1 = require("rxjs");
+const async_context_storage_1 = require("./async-context.storage");
+/**
+ * Interceptor for initialize `AsyncLocalStorage`.
+ * Official recipe https://docs.nestjs.com/recipes/async-local-storage doesn't work with microservices.
+ * One of correctly working realization - https://github.com/Papooch/nestjs-cls/blob/26afd86edd9ef17af49f613d1b7af95b36d5ca97/packages/core/src/lib/cls-initializers/cls.interceptor.ts#L28.
+ */
+class AsyncContextInterceptor {
+    intercept(_context, next) {
+        return new rxjs_1.Observable((observer) => {
+            async_context_storage_1.AsyncContextStorage.run(new Map(), () => {
+                next.handle().subscribe({
+                    complete: () => observer.complete(),
+                    error: (error) => observer.error(error),
+                    next: (res) => observer.next(res),
+                });
+            });
+        });
+    }
+}
+exports.AsyncContextInterceptor = AsyncContextInterceptor;
+//# sourceMappingURL=async-context.interceptor.js.map

package/dist/async-context.interceptor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"async-context.interceptor.js","sourceRoot":"","sources":["../src/async-context.interceptor.ts"],"names":[],"mappings":";;;AAKA,+BAAkC;AAElC,mEAA8D;AAE9D;;;;GAIG;AACH,MAAa,uBAAuB;IAClC,SAAS,CAAC,QAA0B,EAAE,IAAiB;QACrD,OAAO,IAAI,iBAAU,CAAC,CAAC,QAAQ,EAAE,EAAE;YACjC,2CAAmB,CAAC,GAAG,CAAC,IAAI,GAAG,EAAY,EAAE,GAAG,EAAE;gBAChD,IAAI,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC;oBACtB,QAAQ,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE;oBACnC,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC;oBACvC,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC;iBAClC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAZD,0DAYC"}

package/dist/async-context.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AsyncContext = void 0;
+const async_context_storage_1 = require("./async-context.storage");
+class AsyncContext {
+    static set(key, v, rewritable = false) {
+        const store = AsyncContext.getStoreOrThrow();
+        AsyncContext.assertRewritable(key, rewritable);
+        store.set(key, v);
+    }
+    static get(key) {
+        const store = async_context_storage_1.AsyncContextStorage.getStore();
+        return store?.get(key);
+    }
+    static has(key) {
+        const store = async_context_storage_1.AsyncContextStorage.getStore();
+        return store?.has(key) ?? false;
+    }
+    static getStoreOrThrow() {
+        const store = async_context_storage_1.AsyncContextStorage.getStore();
+        if (!store) {
+            throw new Error('AsyncContext is not provided');
+        }
+        return store;
+    }
+    static assertRewritable(key, rewritable) {
+        if (rewritable) {
+            return;
+        }
+        if (AsyncContext.has(key)) {
+            throw new Error('Unexpected rewrite');
+        }
+    }
+}
+exports.AsyncContext = AsyncContext;
+//# sourceMappingURL=async-context.js.map

package/dist/async-context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"async-context.js","sourceRoot":"","sources":["../src/async-context.ts"],"names":[],"mappings":";;;AAAA,mEAA8D;AAE9D,MAAa,YAAY;IACvB,MAAM,CAAC,GAAG,CAAC,GAAW,EAAE,CAAU,EAAE,UAAU,GAAG,KAAK;QACpD,MAAM,KAAK,GAAG,YAAY,CAAC,eAAe,EAAE,CAAC;QAE7C,YAAY,CAAC,gBAAgB,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;QAC/C,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IACpB,CAAC;IAED,MAAM,CAAC,GAAG,CAAI,GAAW;QACvB,MAAM,KAAK,GAAG,2CAAmB,CAAC,QAAQ,EAAE,CAAC;QAE7C,OAAO,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAED,MAAM,CAAC,GAAG,CAAC,GAAW;QACpB,MAAM,KAAK,GAAG,2CAAmB,CAAC,QAAQ,EAAE,CAAC;QAE7C,OAAO,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC;IAClC,CAAC;IAEO,MAAM,CAAC,eAAe;QAC5B,MAAM,KAAK,GAAG,2CAAmB,CAAC,QAAQ,EAAE,CAAC;QAC7C,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAClD,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,GAAW,EAAE,UAAmB;QAC9D,IAAI,UAAU,EAAE,CAAC;YACf,OAAO;QACT,CAAC;QACD,IAAI,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;CACF;AApCD,oCAoCC"}

package/dist/async-context.module.d.ts

@@ -0,0 +1,2 @@
+export declare class AsyncContextModule {
+}

package/dist/async-context.module.js

@@ -0,0 +1,26 @@
+"use strict";
+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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AsyncContextModule = void 0;
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nestjs/core");
+const async_context_interceptor_1 = require("./async-context.interceptor");
+let AsyncContextModule = class AsyncContextModule {
+};
+exports.AsyncContextModule = AsyncContextModule;
+exports.AsyncContextModule = AsyncContextModule = __decorate([
+    (0, common_1.Module)({
+        providers: [
+            {
+                provide: core_1.APP_INTERCEPTOR,
+                useValue: new async_context_interceptor_1.AsyncContextInterceptor(),
+            },
+        ],
+    })
+], AsyncContextModule);
+//# sourceMappingURL=async-context.module.js.map

package/dist/async-context.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"async-context.module.js","sourceRoot":"","sources":["../src/async-context.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAwC;AACxC,uCAA+C;AAE/C,2EAAsE;AAU/D,IAAM,kBAAkB,GAAxB,MAAM,kBAAkB;CAAG,CAAA;AAArB,gDAAkB;6BAAlB,kBAAkB;IAR9B,IAAA,eAAM,EAAC;QACN,SAAS,EAAE;YACT;gBACE,OAAO,EAAE,sBAAe;gBACxB,QAAQ,EAAE,IAAI,mDAAuB,EAAE;aACxC;SACF;KACF,CAAC;GACW,kBAAkB,CAAG"}

package/dist/async-context.provider.d.ts

@@ -0,0 +1,16 @@
+export interface AsyncContextProvider<V> {
+    get(): V | undefined;
+    getOrThrow(): V;
+    set(v: V): void;
+    get isSettled(): boolean;
+}
+export declare const createAsyncContextProvider: <V = never>(config: {
+    /**
+     * Only for debugging
+     */
+    name: string;
+    /**
+     * Can to rewrite after settled
+     */
+    rewritable?: boolean;
+}) => AsyncContextProvider<V>;

package/dist/async-context.provider.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createAsyncContextProvider = void 0;
+const async_context_1 = require("./async-context");
+const createAsyncContextProvider = (config) => {
+    const token = config.name;
+    let isSettled = false;
+    return {
+        get isSettled() {
+            return isSettled;
+        },
+        get() {
+            return async_context_1.AsyncContext.get(token);
+        },
+        getOrThrow() {
+            if (!async_context_1.AsyncContext.has(token)) {
+                throw new Error('Value not provided: ' + token);
+            }
+            return async_context_1.AsyncContext.get(token);
+        },
+        set(v) {
+            isSettled = true;
+            async_context_1.AsyncContext.set(token, v, config.rewritable);
+        },
+    };
+};
+exports.createAsyncContextProvider = createAsyncContextProvider;
+//# sourceMappingURL=async-context.provider.js.map

package/dist/async-context.provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"async-context.provider.js","sourceRoot":"","sources":["../src/async-context.provider.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAYxC,MAAM,0BAA0B,GAAG,CAAY,MASrD,EAA2B,EAAE;IAC5B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC;IAE1B,IAAI,SAAS,GAAG,KAAK,CAAC;IAEtB,OAAO;QACL,IAAI,SAAS;YACX,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,GAAG;YACD,OAAO,4BAAY,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACjC,CAAC;QAED,UAAU;YACR,IAAI,CAAC,4BAAY,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC7B,MAAM,IAAI,KAAK,CAAC,sBAAsB,GAAG,KAAK,CAAC,CAAC;YAClD,CAAC;YACD,OAAO,4BAAY,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACjC,CAAC;QAED,GAAG,CAAC,CAAI;YACN,SAAS,GAAG,IAAI,CAAC;YACjB,4BAAY,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;QAChD,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AAlCW,QAAA,0BAA0B,8BAkCrC"}

package/dist/async-context.storage.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="node" />
+import { AsyncLocalStorage } from 'node:async_hooks';
+export declare const AsyncContextStorage: AsyncLocalStorage<Map<any, any>>;

package/dist/async-context.storage.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AsyncContextStorage = void 0;
+const node_async_hooks_1 = require("node:async_hooks");
+exports.AsyncContextStorage = new node_async_hooks_1.AsyncLocalStorage();
+//# sourceMappingURL=async-context.storage.js.map

package/dist/async-context.storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"async-context.storage.js","sourceRoot":"","sources":["../src/async-context.storage.ts"],"names":[],"mappings":";;;AAAA,uDAAqD;AAExC,QAAA,mBAAmB,GAAG,IAAI,oCAAiB,EAAiB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { AsyncContextModule } from './async-context.module';
+export { createAsyncContextProvider, AsyncContextProvider, } from './async-context.provider';

package/dist/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createAsyncContextProvider = exports.AsyncContextModule = void 0;
+var async_context_module_1 = require("./async-context.module");
+Object.defineProperty(exports, "AsyncContextModule", { enumerable: true, get: function () { return async_context_module_1.AsyncContextModule; } });
+var async_context_provider_1 = require("./async-context.provider");
+Object.defineProperty(exports, "createAsyncContextProvider", { enumerable: true, get: function () { return async_context_provider_1.createAsyncContextProvider; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,+DAA4D;AAAnD,0HAAA,kBAAkB,OAAA;AAE3B,mEAGkC;AAFhC,oIAAA,0BAA0B,OAAA"}

package/jest.config.e2e.js

@@ -0,0 +1 @@
+module.exports = require('@rsdk/jest/jest.config.e2e');

package/jest.config.js

@@ -0,0 +1 @@
+module.exports = require('@rsdk/jest/jest.config');

package/jest.config.unit.js

@@ -0,0 +1 @@
+module.exports = require('@rsdk/jest/jest.config.unit');

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@rsdk/actx",
+  "version": "4.2.0-next.1",
+  "description": "Library for AsyncLocalStorage",
+  "license": "Apache License 2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "url": "https://github.com/R-Vision/rsdk"
+  },
+  "main": "dist/index.js",
+  "dependencies": {
+    "rxjs": "^7.8.1"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^10.0.0",
+    "@nestjs/core": "^10.0.0"
+  },
+  "gitHead": "e42244b7badde74fec2badc60a85d53878fe75ae"
+}

package/src/async-context.interceptor.ts

@@ -0,0 +1,27 @@
+import type {
+  CallHandler,
+  ExecutionContext,
+  NestInterceptor,
+} from '@nestjs/common';
+import { Observable } from 'rxjs';
+
+import { AsyncContextStorage } from './async-context.storage';
+
+/**
+ * Interceptor for initialize `AsyncLocalStorage`.
+ * Official recipe https://docs.nestjs.com/recipes/async-local-storage doesn't work with microservices.
+ * One of correctly working realization - https://github.com/Papooch/nestjs-cls/blob/26afd86edd9ef17af49f613d1b7af95b36d5ca97/packages/core/src/lib/cls-initializers/cls.interceptor.ts#L28.
+ */
+export class AsyncContextInterceptor implements NestInterceptor {
+  intercept(_context: ExecutionContext, next: CallHandler): Observable<any> {
+    return new Observable((observer) => {
+      AsyncContextStorage.run(new Map<any, any>(), () => {
+        next.handle().subscribe({
+          complete: () => observer.complete(),
+          error: (error) => observer.error(error),
+          next: (res) => observer.next(res),
+        });
+      });
+    });
+  }
+}

package/src/async-context.module.ts

@@ -0,0 +1,14 @@
+import { Module } from '@nestjs/common';
+import { APP_INTERCEPTOR } from '@nestjs/core';
+
+import { AsyncContextInterceptor } from './async-context.interceptor';
+
+@Module({
+  providers: [
+    {
+      provide: APP_INTERCEPTOR,
+      useValue: new AsyncContextInterceptor(),
+    },
+  ],
+})
+export class AsyncContextModule {}

package/src/async-context.provider.ts

@@ -0,0 +1,47 @@
+import { AsyncContext } from './async-context';
+
+export interface AsyncContextProvider<V> {
+  get(): V | undefined;
+
+  getOrThrow(): V;
+
+  set(v: V): void;
+
+  get isSettled(): boolean;
+}
+
+export const createAsyncContextProvider = <V = never>(config: {
+  /**
+   * Only for debugging
+   */
+  name: string;
+  /**
+   * Can to rewrite after settled
+   */
+  rewritable?: boolean;
+}): AsyncContextProvider<V> => {
+  const token = config.name;
+
+  let isSettled = false;
+
+  return {
+    get isSettled(): boolean {
+      return isSettled;
+    },
+    get(): V | undefined {
+      return AsyncContext.get(token);
+    },
+
+    getOrThrow(): V {
+      if (!AsyncContext.has(token)) {
+        throw new Error('Value not provided: ' + token);
+      }
+      return AsyncContext.get(token);
+    },
+
+    set(v: V): void {
+      isSettled = true;
+      AsyncContext.set(token, v, config.rewritable);
+    },
+  };
+};

package/src/async-context.storage.ts

@@ -0,0 +1,3 @@
+import { AsyncLocalStorage } from 'node:async_hooks';
+
+export const AsyncContextStorage = new AsyncLocalStorage<Map<any, any>>();

package/src/async-context.ts

@@ -0,0 +1,39 @@
+import { AsyncContextStorage } from './async-context.storage';
+
+export class AsyncContext {
+  static set(key: string, v: unknown, rewritable = false): void {
+    const store = AsyncContext.getStoreOrThrow();
+
+    AsyncContext.assertRewritable(key, rewritable);
+    store.set(key, v);
+  }
+
+  static get<V>(key: string): V {
+    const store = AsyncContextStorage.getStore();
+
+    return store?.get(key);
+  }
+
+  static has(key: string): boolean {
+    const store = AsyncContextStorage.getStore();
+
+    return store?.has(key) ?? false;
+  }
+
+  private static getStoreOrThrow(): Map<any, any> {
+    const store = AsyncContextStorage.getStore();
+    if (!store) {
+      throw new Error('AsyncContext is not provided');
+    }
+    return store;
+  }
+
+  private static assertRewritable(key: string, rewritable: boolean): void {
+    if (rewritable) {
+      return;
+    }
+    if (AsyncContext.has(key)) {
+      throw new Error('Unexpected rewrite');
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1,6 @@
+export { AsyncContextModule } from './async-context.module';
+
+export {
+  createAsyncContextProvider,
+  AsyncContextProvider,
+} from './async-context.provider';

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"
+  }
+}