@evolu/common 8.4.0 → 8.6.0

package/src/Resource.ts

@@ -114,6 +114,8 @@ export interface Lease<T extends Resource> extends Disposable {
  * ```ts
  * import {
  *   all,
+ *   assertEqual,
+ *   assertFalse,
  *   createRun,
  *   createSharedResource,
  *   ok,
@@ -139,7 +141,7 @@ export interface Lease<T extends Resource> extends Disposable {
  * );
  *
  * // Creating the owner is lazy; no connection is open yet.
- * expect(createdCount).toBe(0);
+ * assertEqual(createdCount, 0);
  *
  * // `use` owns and releases a lease around each operation.
  * const send = (message: string): Task<void> =>
@@ -159,8 +161,8 @@ export interface Lease<T extends Resource> extends Disposable {
  *
  * // Reacquiring during the idle delay reuses the same generation.
  * using reusedLease = await run.ok(sharedConnection.acquire);
- * expect(reusedLease.created).toBe(false);
- * expect(createdCount).toBe(1);
+ * assertFalse(reusedLease.created);
+ * assertEqual(createdCount, 1);
  * ```
  *
  * ## FAQ
@@ -392,7 +394,7 @@ export const createSharedResource =
         // only.
         if (sharedResourceRun.getState().type !== "Running") return true;
 
-        if (idleDisposeAfter) {
+        if (idleDisposeAfter !== undefined) {
           idleDisposeFiber = sharedResourceRun.abortable<void, never>(
             async (run) => {
               await run.ok(sleep(idleDisposeAfter));
@@ -414,7 +416,9 @@ export const createSharedResource =
         resource: current as unknown as BorrowedResource<T>,
         created,
         release,
-        [Symbol.dispose]: release,
+        [Symbol.dispose]: () => {
+          release();
+        },
       };
 
       leakDetector.track(
@@ -518,6 +522,8 @@ export const createSharedResource =
  * ```ts
  * import {
  *   all,
+ *   assertEqual,
+ *   assertSame,
  *   createRun,
  *   createSharedResourceByKey,
  *   ok,
@@ -579,8 +585,9 @@ export const createSharedResource =
  *   }),
  * );
  *
- * expect(missingLease).toBeUndefined();
- * expect(messagesByOwnerId).toEqual(
+ * assertSame(missingLease, undefined);
+ * assertEqual(
+ *   messagesByOwnerId,
  *   new Map([
  *     ["owner-1", ["first", "second"]],
  *     ["owner-2", ["hello"]],
@@ -832,6 +839,7 @@ export function createSharedResourceByKey<
         using leaseDisposer = new DisposableStack();
         const leasesByKey: Array<readonly [Lease<T>, K]> = [];
 
+        // oxlint-disable-next-line unicorn/no-useless-spread -- Snapshot keys because each acquisition awaits and can mutate the registry.
         for (const [key] of [...sharedResourcesByKey]) {
           const lease = await run.ok(sharedResourceByKey.acquireCurrent(key));
           if (lease) leasesByKey.push([leaseDisposer.use(lease), key]);
@@ -892,6 +900,7 @@ export function createSharedResourceByKey<
  *
  * ```ts
  * import {
+ *   assertEqual,
  *   createRun,
  *   createSharedResourceByKeyWithClaims,
  *   ok,
@@ -930,32 +939,41 @@ export function createSharedResourceByKey<
  *
  * {
  *   // Account A retains both transports.
- *   using accountATransports = await run.ok(
+ *   using _accountATransports = await run.ok(
  *     transports.claim(accountA, [relay, localNetwork]),
  *   );
  *
  *   {
  *     // Account B reuses the relay already retained by account A.
- *     using accountBRelay = await run.ok(
+ *     using _accountBRelay = await run.ok(
  *       transports.claim(accountB, [relay]),
  *     );
- *     expect(transports.getClaimsForResource(relay)).toEqual(
+ *     assertEqual(
+ *       transports.getClaimsForResource(relay),
  *       new Set([accountA, accountB]),
  *     );
- *     expect(transports.getResourceKeysForClaim(accountA)).toEqual(
+ *     assertEqual(
+ *       transports.getResourceKeysForClaim(accountA),
  *       new Set([relay, localNetwork]),
  *     );
  *   }
  *
  *   // Releasing account B leaves account A's relay retain intact.
- *   expect(transports.getClaimsForResource(relay)).toEqual(
+ *   assertEqual(
+ *     transports.getClaimsForResource(relay),
  *     new Set([accountA]),
  *   );
  * }
  *
  * // Releasing the final claim removes the relation for both transports.
- * expect(transports.getClaimsForResource(relay)).toEqual(new Set());
- * expect(transports.getClaimsForResource(localNetwork)).toEqual(new Set());
+ * assertEqual(
+ *   transports.getClaimsForResource(relay),
+ *   new Set<AccountId>(),
+ * );
+ * assertEqual(
+ *   transports.getClaimsForResource(localNetwork),
+ *   new Set<AccountId>(),
+ * );
  * ```
  */
 export interface SharedResourceByKeyWithClaims<
@@ -1346,7 +1364,9 @@ export const createSharedResourceByKeyWithClaims =
           const release = (): boolean => releaseClaimLease(heldClaimLease);
           const claimLease: ClaimLease = {
             release,
-            [Symbol.dispose]: release,
+            [Symbol.dispose]: () => {
+              release();
+            },
           };
 
           leakDetector.track(
@@ -1367,6 +1387,7 @@ export const createSharedResourceByKeyWithClaims =
               resourceKey,
             ] of firstClaimTransitions) {
               onFirstClaimAdded?.(claim, resource, resourceKey);
+              // oxlint-disable-next-line eslint/no-loop-func -- Captures this iteration's block-scoped transition values for rollback.
               compensations.defer(() => {
                 if (!succeeded) {
                   notifyLastClaimRemoved(claim, resource, resourceKey);