@dxos/async 0.8.4-main.72ec0f3 → 0.8.4-main.765dc60934

package/LICENSE

@@ -1,8 +1,105 @@
-MIT License 
-Copyright (c) 2022 DXOS
+# Functional Source License, Version 1.1, ALv2 Future License
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+## Abbreviation
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+FSL-1.1-Apache-2.0
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+## Notice
+
+Copyright 2026 DXOS
+
+## Terms and Conditions
+
+### Licensor ("We")
+
+The party offering the Software under these Terms and Conditions.
+
+### The Software
+
+The "Software" is each version of the software that we make available under
+these Terms and Conditions, as indicated by our inclusion of these Terms and
+Conditions with the Software.
+
+### License Grant
+
+Subject to your compliance with this License Grant and the Patents,
+Redistribution and Trademark clauses below, we hereby grant you the right to
+use, copy, modify, create derivative works, publicly perform, publicly display
+and redistribute the Software for any Permitted Purpose identified below.
+
+### Permitted Purpose
+
+A Permitted Purpose is any purpose other than a Competing Use. A Competing Use
+means making the Software available to others in a commercial product or
+service that:
+
+1. substitutes for the Software;
+
+2. substitutes for any other product or service we offer using the Software
+   that exists as of the date we make the Software available; or
+
+3. offers the same or substantially similar functionality as the Software.
+
+Permitted Purposes specifically include using the Software:
+
+1. for your internal use and access;
+
+2. for non-commercial education;
+
+3. for non-commercial research; and
+
+4. in connection with professional services that you provide to a licensee
+   using the Software in accordance with these Terms and Conditions.
+
+### Patents
+
+To the extent your use for a Permitted Purpose would necessarily infringe our
+patents, the license grant above includes a license under our patents. If you
+make a claim against any party that the Software infringes or contributes to
+the infringement of any patent, then your patent license to the Software ends
+immediately.
+
+### Redistribution
+
+The Terms and Conditions apply to all copies, modifications and derivatives of
+the Software.
+
+If you redistribute any copies, modifications or derivatives of the Software,
+you must include a copy of or a link to these Terms and Conditions and not
+remove any copyright notices provided in or with the Software.
+
+### Disclaimer
+
+THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR
+PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
+
+IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE
+SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES,
+EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
+
+### Trademarks
+
+Except for displaying the License Details and identifying us as the origin of
+the Software, you have no right under these Terms and Conditions to use our
+trademarks, trade names, service marks or product names.
+
+## Grant of Future License
+
+We hereby irrevocably grant you an additional license to use the Software under
+the Apache License, Version 2.0 that is effective on the second anniversary of
+the date we make the Software available. On or after that date, you may use the
+Software under the Apache License, Version 2.0, in which case the following
+will apply:
+
+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/dist/lib/browser/index.mjs

@@ -22,7 +22,7 @@ var chain = (chain2) => async (elements) => {
 import { ComplexMap } from "@dxos/util";
 var combine = (...cleanupFns) => {
   return () => {
-    cleanupFns.flat().forEach((cleanupFn) => cleanupFn());
+    cleanupFns.flat().filter((f) => typeof f === "function").forEach((cleanupFn) => cleanupFn());
   };
 };
 var timeout = (cb, ms = 0) => {
@@ -39,8 +39,8 @@ var addEventListener = (target, type, listener, options) => {
 };
 var SubscriptionList = class {
   _cleanups = [];
-  add(cb) {
-    this._cleanups.push(cb);
+  add(...cb) {
+    this._cleanups.push(...cb);
     return this;
   }
   clear() {
@@ -166,6 +166,9 @@ var sleepWithContext = (ctx, ms) => {
 };
 var asyncReturn = () => sleep(0);
 var asyncTimeout = async (promise, timeout2, err) => {
+  if (typeof promise === "function") {
+    throw new Error("First argument must be a promise.");
+  }
   let timeoutId;
   const throwable = err === void 0 || typeof err === "string" ? new TimeoutError(timeout2, err) : err;
   const timeoutPromise = new Promise((resolve, reject) => {
@@ -174,9 +177,8 @@ var asyncTimeout = async (promise, timeout2, err) => {
     }, timeout2);
     unrefTimeout(timeoutId);
   });
-  const conditionTimeout = typeof promise === "function" ? promiseFromCallback(promise) : promise;
   return await Promise.race([
-    conditionTimeout,
+    promise,
     timeoutPromise
   ]).finally(() => {
     clearTimeout(timeoutId);
@@ -213,7 +215,6 @@ var waitForEvent = (eventEmitter, eventName, test, timeout2, error) => {
 
 // src/events.ts
 import { Context } from "@dxos/context";
-var __dxlog_file = "/__w/dxos/dxos/packages/common/async/src/events.ts";
 var DO_NOT_ERROR_ON_ASYNC_CALLBACK = true;
 var Event = class _Event {
   /**
@@ -268,10 +269,7 @@ var Event = class _Event {
       _ctx,
       _callback
     ] : [
-      new Context(void 0, {
-        F: __dxlog_file,
-        L: 132
-      }),
+      new Context(),
       _ctx
     ];
     const weak = !!options?.weak;
@@ -301,10 +299,7 @@ var Event = class _Event {
       _ctx,
       _callback
     ] : [
-      new Context(void 0, {
-        F: __dxlog_file,
-        L: 169
-      }),
+      new Context(),
       _ctx
     ];
     const listener = new EventListener(this, callback, ctx, true, false);
@@ -607,7 +602,7 @@ var MutexGuard = class {
     this.release();
   }
 };
-var classMutexSymbol = Symbol("class-mutex");
+var classMutexSymbol = /* @__PURE__ */ Symbol("class-mutex");
 var FORCE_DISABLE_WARNING = false;
 var enableWarning = !FORCE_DISABLE_WARNING && globalThis.mochaExecutor;
 var synchronized = (target, propertyName, descriptor) => {
@@ -638,7 +633,6 @@ import PushStream from "zen-push";
 
 // src/trigger.ts
 import { invariant } from "@dxos/invariant";
-var __dxlog_file2 = "/__w/dxos/dxos/packages/common/async/src/trigger.ts";
 var trigger = (timeout2) => {
   let callback;
   const promise = new Promise((resolve, reject) => {
@@ -730,15 +724,7 @@ var Trigger = class {
   }
 };
 var latch = ({ count = 1, timeout: timeout2 } = {}) => {
-  invariant(count >= 0, void 0, {
-    F: __dxlog_file2,
-    L: 139,
-    S: void 0,
-    A: [
-      "count >= 0",
-      ""
-    ]
-  });
+  invariant(count >= 0);
   let t;
   let doResolve;
   let doReject;
@@ -935,16 +921,15 @@ import { warnAfterTimeout as warnAfterTimeout2 } from "@dxos/debug";
 import { log as log2 } from "@dxos/log";
 
 // src/task-scheduling.ts
-import { ContextDisposedError as ContextDisposedError2 } from "@dxos/context";
+import { Context as Context2, ContextDisposedError as ContextDisposedError2 } from "@dxos/context";
 import { StackTrace as StackTrace2 } from "@dxos/debug";
 
 // src/track-leaks.ts
 import { StackTrace } from "@dxos/debug";
 import { log } from "@dxos/log";
-var __dxlog_file3 = "/__w/dxos/dxos/packages/common/async/src/track-leaks.ts";
 var enabled = typeof process !== "undefined" && !!process.env.DX_TRACK_LEAKS;
 var openResources = /* @__PURE__ */ new Set();
-var handleSymbol = Symbol("checkLeaksHandle");
+var handleSymbol = /* @__PURE__ */ Symbol("checkLeaksHandle");
 var trackResource = (resourceProvider) => {
   if (!enabled) {
     return () => {
@@ -991,31 +976,11 @@ var dumpLeaks = () => {
   if (!enabled) {
     return;
   }
-  log.info(`Leaked resources ${openResources.size}:`, void 0, {
-    F: __dxlog_file3,
-    L: 82,
-    S: void 0,
-    C: (f, a) => f(...a)
-  });
+  log.info(`Leaked resources ${openResources.size}:`);
   for (const resource of openResources) {
-    log.info(`- ${resource.name} at`, void 0, {
-      F: __dxlog_file3,
-      L: 84,
-      S: void 0,
-      C: (f, a) => f(...a)
-    });
-    log.info(resource.openStack.getStack(1), void 0, {
-      F: __dxlog_file3,
-      L: 85,
-      S: void 0,
-      C: (f, a) => f(...a)
-    });
-    log.info("\n", void 0, {
-      F: __dxlog_file3,
-      L: 86,
-      S: void 0,
-      C: (f, a) => f(...a)
-    });
+    log.info(`- ${resource.name} at`);
+    log.info(resource.openStack.getStack(1));
+    log.info("\n");
   }
 };
 if (enabled) {
@@ -1072,6 +1037,79 @@ var DeferredTask = class {
     await this._currentTask;
   }
 };
+var AsyncTask = class {
+  #callback;
+  #ctx = void 0;
+  #scheduled = false;
+  #currentTask = null;
+  #nextTask = new Trigger();
+  constructor(callback) {
+    this.#callback = callback;
+  }
+  get scheduled() {
+    return this.#scheduled;
+  }
+  /**
+  * Context of the resource that owns the task.
+  * When the context is disposed, the task is cancelled and cannot be scheduled again.
+  */
+  open() {
+    this.#ctx = new Context2();
+  }
+  /**
+  * Closes the task and waits for it to finish if it is running.
+  */
+  async close() {
+    await this.#ctx?.dispose();
+    await this.join();
+    this.#ctx = void 0;
+  }
+  [Symbol.asyncDispose]() {
+    return this.close();
+  }
+  /**
+  * Schedule the task to run asynchronously.
+  */
+  // TODO(dmaretskyi): Add scheduleAt. Where the earlier time will override the later one.
+  schedule() {
+    if (!this.#ctx || this.#ctx.disposed) {
+      throw new Error("AsyncTask not open");
+    }
+    if (this.#scheduled) {
+      return;
+    }
+    scheduleTask(this.#ctx, async () => {
+      await this.#currentTask;
+      if (!this.#ctx || this.#ctx.disposed) {
+        return;
+      }
+      this.#scheduled = false;
+      const completionTrigger = this.#nextTask;
+      this.#nextTask = new Trigger();
+      this.#currentTask = runInContextAsync(this.#ctx, () => this.#callback()).then(() => {
+        completionTrigger.wake();
+      });
+    });
+    this.#scheduled = true;
+  }
+  /**
+  * Schedule the task to run and wait for it to finish.
+  */
+  async runBlocking() {
+    if (this.#ctx?.disposed) {
+      throw new ContextDisposedError2();
+    }
+    this.schedule();
+    await this.#nextTask.wait();
+  }
+  /**
+  * Waits for the current task to finish if it is running.
+  * Does not schedule a new task.
+  */
+  async join() {
+    await this.#currentTask;
+  }
+};
 var runInContext = (ctx, fn) => {
   try {
     fn();
@@ -1157,7 +1195,6 @@ function _ts_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 __dxlog_file4 = "/__w/dxos/dxos/packages/common/async/src/persistent-lifecycle.ts";
 var INIT_RESTART_DELAY = 100;
 var DEFAULT_MAX_RESTART_DELAY = 5e3;
 var PersistentLifecycle = class extends Resource {
@@ -1183,25 +1220,21 @@ var PersistentLifecycle = class extends Resource {
       try {
         await this._restart();
       } catch (err) {
+        if (this._ctx?.disposed) {
+          return;
+        }
         log2.warn("Restart failed", {
           err
-        }, {
-          F: __dxlog_file4,
-          L: 72,
-          S: this,
-          C: (f, a) => f(...a)
         });
         this._restartTask?.schedule();
       }
     });
     this._currentState = await this._start().catch((err) => {
+      if (this._ctx?.disposed) {
+        return void 0;
+      }
       log2.warn("Start failed", {
         err
-      }, {
-        F: __dxlog_file4,
-        L: 78,
-        S: this,
-        C: (f, a) => f(...a)
       });
       this._restartTask?.schedule();
       return void 0;
@@ -1215,11 +1248,6 @@ var PersistentLifecycle = class extends Resource {
   async _restart() {
     log2(`restarting in ${this._restartAfter}ms`, {
       state: this._lifecycleState
-    }, {
-      F: __dxlog_file4,
-      L: 91,
-      S: this,
-      C: (f, a) => f(...a)
     });
     await this._stopCurrentState();
     if (this._lifecycleState !== LifecycleState.OPEN) {
@@ -1238,12 +1266,7 @@ var PersistentLifecycle = class extends Resource {
       try {
         await this._stop(this._currentState);
       } catch (err) {
-        log2.catch(err, void 0, {
-          F: __dxlog_file4,
-          L: 113,
-          S: this,
-          C: (f, a) => f(...a)
-        });
+        log2.catch(err);
       }
       this._currentState = void 0;
     }
@@ -1267,7 +1290,6 @@ _ts_decorate([
 
 // src/push-iterable.ts
 import { invariant as invariant2 } from "@dxos/invariant";
-var __dxlog_file5 = "/__w/dxos/dxos/packages/common/async/src/push-iterable.ts";
 var makePushIterable = () => {
   const buf = [];
   const trigger2 = new Trigger({
@@ -1281,15 +1303,7 @@ var makePushIterable = () => {
             await trigger2.wait();
           }
           const item = buf.shift();
-          invariant2(item, void 0, {
-            F: __dxlog_file5,
-            L: 42,
-            S: this,
-            A: [
-              "item",
-              ""
-            ]
-          });
+          invariant2(item);
           switch (item.kind) {
             case "next":
               return {
@@ -1594,6 +1608,7 @@ var UpdateScheduler = class {
   }
 };
 export {
+  AsyncTask,
   CancellableObservableProvider,
   DeferredTask,
   Event,