@travetto/context 5.0.0-rc.8 → 5.0.0

package/README.md

@@ -15,7 +15,7 @@ yarn add @travetto/context
 
 This module provides a wrapper around node's [async_hooks](https://nodejs.org/api/async_hooks.html) to maintain context across async calls. This is generally used for retaining contextual user information at various levels of async flow. 
 
-The most common way of utilizing the context, is via the [WithAsyncContext](https://github.com/travetto/travetto/tree/main/module/context/src/decorator.ts#L6) decorator.  The decorator requires the class it's being used in, to have a [AsyncContext](https://github.com/travetto/travetto/tree/main/module/context/src/service.ts#L13) member, as it is the source of the contextual information. 
+The most common way of utilizing the context, is via the [WithAsyncContext](https://github.com/travetto/travetto/tree/main/module/context/src/decorator.ts#L7) decorator.  The decorator requires the class it's being used in, to have a [AsyncContext](https://github.com/travetto/travetto/tree/main/module/context/src/service.ts#L13) member, as it is the source of the contextual information. 
 
 The decorator will load the context on invocation, and will keep the context active during the entire asynchronous call chain.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/context",
-  "version": "5.0.0-rc.8",
+  "version": "5.0.0",
   "description": "Async-aware state management, maintaining context across asynchronous calls.",
   "keywords": [
     "async-hooks",
@@ -26,10 +26,10 @@
     "directory": "module/context"
   },
   "dependencies": {
-    "@travetto/di": "^5.0.0-rc.8"
+    "@travetto/di": "^5.0.0"
   },
   "peerDependencies": {
-    "@travetto/test": "^5.0.0-rc.8"
+    "@travetto/test": "^5.0.0"
   },
   "peerDependenciesMeta": {
     "@travetto/test": {

package/src/decorator.ts

@@ -1,17 +1,17 @@
+import { AsyncMethodDescriptor } from '@travetto/runtime';
 import { AsyncContext } from './service';
 
 /**
  * Allows running a function while providing an async context
  */
-export function WithAsyncContext<T extends { context: AsyncContext }>(data?: Record<string, unknown>) {
-  return function <U extends unknown[], V = unknown>(
+export function WithAsyncContext(data?: Record<string, unknown>) {
+  return function <T extends { context: AsyncContext }>(
     target: T,
     prop: string,
-    descriptor: TypedPropertyDescriptor<(...args: U) => Promise<V>>
+    descriptor: AsyncMethodDescriptor<T>
   ): typeof descriptor {
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    const og = descriptor.value! as (this: T, ...args: unknown[]) => Promise<V>;
-    descriptor.value = function (this: T, ...args: unknown[]): Promise<V> {
+    const og = descriptor.value!;
+    descriptor.value = function (...args: unknown[]): ReturnType<typeof og> {
       return this.context.run(og.bind(this, ...args), structuredClone(data ?? {}));
     };
 

package/src/service.ts

@@ -1,10 +1,10 @@
 import { AsyncLocalStorage } from 'node:async_hooks';
 
 import { Injectable } from '@travetto/di';
-import { AppError } from '@travetto/runtime';
+import { AppError, castTo } from '@travetto/runtime';
 
 
-type Ctx = Record<string | symbol, unknown>;
+type Ctx<T = unknown> = Record<string | symbol, T>;
 
 /**
  * Async context using `asyncHooks`
@@ -12,7 +12,7 @@ type Ctx = Record<string | symbol, unknown>;
 @Injectable()
 export class AsyncContext {
 
-  alStorage = new AsyncLocalStorage<{ value: Ctx }>();
+  alStorage = new AsyncLocalStorage<{ value?: Ctx }>();
   active = 0;
 
   constructor() {
@@ -20,19 +20,17 @@ export class AsyncContext {
     this.iterate = this.iterate.bind(this);
   }
 
-  #store(setAs?: Ctx | null): Ctx {
+  #store<T = unknown>(setAs?: Ctx<T> | null): Ctx<T> {
     const val = this.alStorage.getStore();
     if (!val) {
       throw new AppError('Context is not initialized', 'general');
     }
     if (setAs) {
       val.value = setAs;
-    } else {
-      if (!val.value) {
-        val.value = {};
-      }
+    } else if (!val.value) {
+      val.value = {};
     }
-    return val.value;
+    return castTo(val.value);
   }
 
   /**
@@ -41,10 +39,9 @@ export class AsyncContext {
   get<T = unknown>(key: string | symbol): T;
   get(): Ctx;
   get<T>(key?: string | symbol): Ctx | T {
-    const root = this.#store();
+    const root = this.#store<T>();
     if (key) {
-      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-      return root[key as string] as T;
+      return root[key];
     } else {
       return root;
     }
@@ -75,8 +72,7 @@ export class AsyncContext {
     try {
       return await fn();
     } finally {
-      // @ts-expect-error
-      delete this.alStorage.getStore().value;
+      delete this.alStorage.getStore()?.value;
       if ((this.active -= 1) === 0) {
         this.alStorage.disable();
       }
@@ -95,8 +91,7 @@ export class AsyncContext {
     try {
       return yield* fn();
     } finally {
-      // @ts-expect-error
-      delete this.alStorage.getStore().value;
+      delete this.alStorage.getStore()?.value;
       if ((this.active -= 1) === 0) {
         this.alStorage.disable();
       }

package/support/test/context.ts

@@ -26,7 +26,7 @@ export function WithSuiteContext(data: Record<string, unknown> = {}) {
           await RootRegistry.init();
           const ctx = await DependencyRegistry.getInstance(AsyncContext);
           for (const t of SuiteRegistry.get(target).tests) {
-            const fn = wrapped(ctx, this[t.methodName] as Function);
+            const fn = wrapped(ctx, this[t.methodName]);
             Object.defineProperty(fn, 'name', { value: t.methodName });
             this[t.methodName] = fn;
           }