@dxos/context 0.8.4-main.b97322e → 0.8.4-main.bd9b33e6c8

package/package.json

@@ -1,21 +1,25 @@
 {
   "name": "@dxos/context",
-  "version": "0.8.4-main.b97322e",
+  "version": "0.8.4-main.bd9b33e6c8",
   "description": "Async utils.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dxos/dxos"
+  },
   "license": "MIT",
   "author": "DXOS.org",
-  "sideEffects": true,
+  "sideEffects": false,
   "type": "module",
   "exports": {
     ".": {
+      "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs",
       "node": {
         "require": "./dist/lib/node/index.cjs",
         "default": "./dist/lib/node-esm/index.mjs"
-      },
-      "types": "./dist/types/src/index.d.ts"
+      }
     }
   },
   "types": "dist/types/src/index.d.ts",
@@ -27,10 +31,11 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/log": "0.8.4-main.b97322e",
-    "@dxos/node-std": "0.8.4-main.b97322e",
-    "@dxos/debug": "0.8.4-main.b97322e",
-    "@dxos/util": "0.8.4-main.b97322e"
+    "@hazae41/symbol-dispose-polyfill": "^1.0.2",
+    "@dxos/debug": "0.8.4-main.bd9b33e6c8",
+    "@dxos/log": "0.8.4-main.bd9b33e6c8",
+    "@dxos/node-std": "0.8.4-main.bd9b33e6c8",
+    "@dxos/util": "0.8.4-main.bd9b33e6c8"
   },
   "publishConfig": {
     "access": "public"

package/src/context.ts

@@ -14,7 +14,7 @@ export type ContextErrorHandler = (error: Error, ctx: Context) => void;
 
 export type DisposeCallback = () => any | Promise<any>;
 
-export type CreateContextParams = {
+export type CreateContextProps = {
   name?: string;
   parent?: Context;
   attributes?: Record<string, any>;
@@ -67,9 +67,11 @@ export class Context {
   #flags: ContextFlags = 0;
   #disposePromise?: Promise<boolean> = undefined;
 
+  #signal: AbortSignal | undefined = undefined;
+
   public maxSafeDisposeCallbacks = MAX_SAFE_DISPOSE_CALLBACKS;
 
-  constructor(params: CreateContextParams = {}, callMeta?: Partial<CallMetadata>) {
+  constructor(params: CreateContextProps = {}, callMeta?: Partial<CallMetadata>) {
     this.#name = getContextName(params, callMeta);
     this.#parent = params.parent;
     this.#attributes = params.attributes ?? {};
@@ -100,6 +102,16 @@ export class Context {
     return this.#disposeCallbacks.length;
   }
 
+  get signal(): AbortSignal {
+    if (this.#signal) {
+      return this.#signal;
+    }
+    const controller = new AbortController();
+    this.#signal = controller.signal;
+    this.onDispose(() => controller.abort());
+    return this.#signal;
+  }
+
   /**
    * Schedules a callback to run when the context is disposed.
    * May be async, in this case the disposer might choose to wait for all resource to released.
@@ -222,8 +234,9 @@ export class Context {
     }
   }
 
-  derive({ onError, attributes }: CreateContextParams = {}): Context {
+  derive({ onError, attributes }: CreateContextProps = {}): Context {
     const newCtx = new Context({
+      parent: this,
       // TODO(dmaretskyi): Optimize to not require allocating a new closure for every context.
       onError: async (error) => {
         if (!onError) {
@@ -267,7 +280,7 @@ export class Context {
   }
 }
 
-const getContextName = (params: CreateContextParams, callMeta?: Partial<CallMetadata>): string | undefined => {
+const getContextName = (params: CreateContextProps, callMeta?: Partial<CallMetadata>): string | undefined => {
   if (params.name) {
     return params.name;
   }

package/src/resource.ts

@@ -6,6 +6,8 @@ import { throwUnhandledError } from '@dxos/util';
 
 import { Context } from './context';
 
+import '@hazae41/symbol-dispose-polyfill';
+
 export enum LifecycleState {
   CLOSED = 'CLOSED',
   OPEN = 'OPEN',
@@ -25,6 +27,7 @@ const CLOSE_RESOURCE_ON_UNHANDLED_ERROR = false;
  */
 export abstract class Resource implements Lifecycle {
   #lifecycleState = LifecycleState.CLOSED;
+
   #openPromise: Promise<void> | null = null;
   #closePromise: Promise<void> | null = null;
 
@@ -41,6 +44,17 @@ export abstract class Resource implements Lifecycle {
    */
   #parentCtx: Context = this.#createParentContext();
 
+  /**
+   * ```ts
+   * await using resource = new Resource();
+   * await resource.open();
+   * ```
+   * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/using
+   */
+  async [Symbol.asyncDispose](): Promise<void> {
+    await this.close();
+  }
+
   get #name() {
     return Object.getPrototypeOf(this).constructor.name;
   }
@@ -60,12 +74,12 @@ export abstract class Resource implements Lifecycle {
   /**
    * To be overridden by subclasses.
    */
-  protected async _open(ctx: Context): Promise<void> {}
+  protected async _open(_ctx: Context): Promise<void> {}
 
   /**
    * To be overridden by subclasses.
    */
-  protected async _close(ctx: Context): Promise<void> {}
+  protected async _close(_ctx: Context): Promise<void> {}
 
   /**
    * Error handler for errors that are caught by the context.
@@ -82,6 +96,20 @@ export abstract class Resource implements Lifecycle {
     throw err;
   }
 
+  /**
+   * Calls the provided function, opening and closing the resource.
+   * NOTE: Consider using `using` instead.
+   * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/using
+   */
+  async use<T>(fn: (resource: this) => Promise<T>): Promise<T> {
+    try {
+      await this.open();
+      return await fn(this);
+    } finally {
+      await this.close();
+    }
+  }
+
   /**
    * Opens the resource.
    * If the resource is already open, it does nothing.
@@ -100,7 +128,6 @@ export abstract class Resource implements Lifecycle {
 
     await this.#closePromise;
     await (this.#openPromise ??= this.#open(ctx));
-
     return this;
   }
 
@@ -114,7 +141,6 @@ export abstract class Resource implements Lifecycle {
     }
     await this.#openPromise;
     await (this.#closePromise ??= this.#close(ctx));
-
     return this;
   }
 
@@ -135,13 +161,10 @@ export abstract class Resource implements Lifecycle {
     await this.#openPromise;
   }
 
-  async [Symbol.asyncDispose](): Promise<void> {
-    await this.close();
-  }
-
   async #open(ctx?: Context): Promise<void> {
     this.#closePromise = null;
     this.#parentCtx = ctx?.derive({ name: this.#name }) ?? this.#createParentContext();
+    this.#internalCtx = this.#createContext(this.#parentCtx);
     await this._open(this.#parentCtx);
     this.#lifecycleState = LifecycleState.OPEN;
   }
@@ -154,9 +177,10 @@ export abstract class Resource implements Lifecycle {
     this.#lifecycleState = LifecycleState.CLOSED;
   }
 
-  #createContext(): Context {
+  #createContext(attributeParent?: Context): Context {
     return new Context({
       name: this.#name,
+      parent: attributeParent,
       onError: (error) =>
         queueMicrotask(async () => {
           try {