@devvit/public-api 0.10.22-next-2024-06-06-cf36c56e2.0 → 0.10.22-next-2024-06-06-0f86ae113.0

package/devvit/internals/blocks/handler/BlocksHandler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BlocksHandler.d.ts","sourceRoot":"","sources":["../../../../../src/devvit/internals/blocks/handler/BlocksHandler.ts"],"names":[],"mappings":"AACA,OAAO,EAAe,KAAK,QAAQ,EAAE,KAAK,SAAS,EAAE,KAAK,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAO7F,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEzD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,KAAK,EAAe,IAAI,EAAE,UAAU,EAAE,WAAW,EAAS,MAAM,YAAY,CAAC;AAIpF;;;;;;GAMG;AACH,eAAO,IAAI,oBAAoB,EAAE,aAAa,GAAG,IAAW,CAAC;AAE7D,wBAAgB,gBAAgB,IAAI,aAAa,CAKhD;AAED,wBAAgB,WAAW,IAAI,OAAO,CAErC;AAMD;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,IAAI,EACzC,OAAO,EAAE,WAAW,EACpB,WAAW,EAAE,CAAC,CAAC,EAAE,UAAU,KAAK,CAAC,GAChC,CAAC,CA8BH;AAED,eAAO,IAAI,oBAAoB,EAAE,aAAa,GAAG,IAAW,CAAC;AAE7D;;;;GAIG;AACH,qBAAa,aAAa;;IAIxB,oBAAoB,EAAE,aAAa,GAAG,IAAI,CAAQ;gBAEtC,IAAI,EAAE,GAAG,CAAC,iBAAiB;IAMjC,MAAM,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC;CAgV1E"}
+{"version":3,"file":"BlocksHandler.d.ts","sourceRoot":"","sources":["../../../../../src/devvit/internals/blocks/handler/BlocksHandler.ts"],"names":[],"mappings":"AACA,OAAO,EAAe,KAAK,QAAQ,EAAE,KAAK,SAAS,EAAE,KAAK,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAO7F,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEzD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,KAAK,EAAe,IAAI,EAAE,UAAU,EAAE,WAAW,EAAS,MAAM,YAAY,CAAC;AAIpF;;;;;;GAMG;AACH,eAAO,IAAI,oBAAoB,EAAE,aAAa,GAAG,IAAW,CAAC;AAE7D,wBAAgB,gBAAgB,IAAI,aAAa,CAKhD;AAED,wBAAgB,WAAW,IAAI,OAAO,CAErC;AAMD;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,IAAI,EACzC,OAAO,EAAE,WAAW,EACpB,WAAW,EAAE,CAAC,CAAC,EAAE,UAAU,KAAK,CAAC,GAChC,CAAC,CA8BH;AAED,eAAO,IAAI,oBAAoB,EAAE,aAAa,GAAG,IAAW,CAAC;AAE7D;;;;GAIG;AACH,qBAAa,aAAa;;IAIxB,oBAAoB,EAAE,aAAa,GAAG,IAAI,CAAQ;gBAEtC,IAAI,EAAE,GAAG,CAAC,iBAAiB;IAMjC,MAAM,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC;CAsV1E"}

package/devvit/internals/blocks/handler/BlocksHandler.js

@@ -114,7 +114,9 @@ export class BlocksHandler {
         let changed;
         let progress;
         let remaining = [...eventsToProcess];
+        console.debug('starting processing events');
         while (eventsToProcess.length > 0) {
+            console.debug('processing events loop iteration', eventsToProcess.length);
             /**
              * A concurrently executable batch is a set of events that can be executed in parallel.  This either one main queue event,
              * or any number of other queue events.
@@ -168,7 +170,7 @@ export class BlocksHandler {
             for (const event of context._requeueEvents) {
                 if (!isMainQueue && !event.async) {
                     console.debug('NOT reprocessing event in BlocksHandler, sync mismatch A', event);
-                    // We're async, this is a main queue event.  We need to send it back to the platform to let
+                    // We're async, this is a main qrueue event.  We need to send it back to the platform to let
                     // the platform synchronize it.
                     remainingRequeueEvents.push(event);
                     continue;
@@ -232,6 +234,7 @@ export class BlocksHandler {
 }
 _BlocksHandler_root = new WeakMap(), _BlocksHandler_contextBuilder = new WeakMap(), _BlocksHandler_blocksTransformer = new WeakMap(), _BlocksHandler_instances = new WeakSet(), _BlocksHandler_loadHooks = function _BlocksHandler_loadHooks(context, ..._events) {
     // TBD: partial rendering
+    context._hooks = {};
     __classPrivateFieldGet(this, _BlocksHandler_instances, "m", _BlocksHandler_renderRoot).call(this, __classPrivateFieldGet(this, _BlocksHandler_root, "f"), context.request.props ?? {}, context);
 }, _BlocksHandler_handleAsyncQueues = 
 /**
@@ -262,8 +265,11 @@ async function _BlocksHandler_handleAsyncQueues(context, ...batch) {
 }, _BlocksHandler_handleMainQueue = async function _BlocksHandler_handleMainQueue(context, ...batch) {
     // We need to handle events in order, so that the state is updated in the correct order.
     for (const event of batch) {
+        console.log('handling main queue event', event);
+        console.log('before', context._state);
         __classPrivateFieldGet(this, _BlocksHandler_instances, "m", _BlocksHandler_loadHooks).call(this, context, event);
         await __classPrivateFieldGet(this, _BlocksHandler_instances, "m", _BlocksHandler_attemptHook).call(this, context, event);
+        console.log('after', context._state);
     }
     // TODO: Decide whether this is excessive.  It doesn't hurt anything besides performance.
     __classPrivateFieldGet(this, _BlocksHandler_instances, "m", _BlocksHandler_loadHooks).call(this, context);

package/devvit/internals/blocks/handler/useAsync.d.ts

@@ -1,10 +1,20 @@
 import type { JSONValue } from '@devvit/shared-types/json.js';
 import type { AsyncUseStateInitializer, UseAsyncResult } from '../../../../types/hooks.js';
+export type AsyncOptions = {
+    /**
+     * The data loader will re-run if the value of `depends` changes.
+     */
+    depends?: JSONValue;
+    /**
+     * If `enabled` is false, the data loader will not run.
+     */
+    enabled?: boolean;
+};
 /**
  * This is the preferred way to handle async state in Devvit.
  *
  * @param initializer -- any async function that returns a JSONValue
  * @returns UseAsyncResult<S>
  */
-export declare function useAsync<S extends JSONValue>(initializer: AsyncUseStateInitializer<S>): UseAsyncResult<S>;
+export declare function useAsync<S extends JSONValue>(initializer: AsyncUseStateInitializer<S>, options?: AsyncOptions): UseAsyncResult<S>;
 //# sourceMappingURL=useAsync.d.ts.map

package/devvit/internals/blocks/handler/useAsync.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useAsync.d.ts","sourceRoot":"","sources":["../../../../../src/devvit/internals/blocks/handler/useAsync.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,KAAK,EAAE,wBAAwB,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAmF3F;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,SAAS,EAC1C,WAAW,EAAE,wBAAwB,CAAC,CAAC,CAAC,GACvC,cAAc,CAAC,CAAC,CAAC,CAMnB"}
+{"version":3,"file":"useAsync.d.ts","sourceRoot":"","sources":["../../../../../src/devvit/internals/blocks/handler/useAsync.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,KAAK,EAAE,wBAAwB,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAQ3F,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,OAAO,CAAC,EAAE,SAAS,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAsGF;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,SAAS,EAC1C,WAAW,EAAE,wBAAwB,CAAC,CAAC,CAAC,EACxC,OAAO,GAAE,YAAiB,GACzB,cAAc,CAAC,CAAC,CAAC,CAMnB"}

package/devvit/internals/blocks/handler/useAsync.js

@@ -9,33 +9,49 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _AsyncHook_hookId, _AsyncHook_initializer, _AsyncHook_invalidate, _AsyncHook_ctx;
+var _AsyncHook_hookId, _AsyncHook_initializer, _AsyncHook_invalidate, _AsyncHook_ctx, _AsyncHook_options, _AsyncHook_localDepends, _AsyncHook_enabled;
 import { registerHook } from './BlocksHandler.js';
+import isEqual from 'lodash.isequal';
+import { CIRCUIT_BREAKER_MSG } from '@devvit/shared-types/CircuitBreaker.js';
 class AsyncHook {
-    constructor(initializer, params) {
+    constructor(initializer, options, params) {
         _AsyncHook_hookId.set(this, void 0);
         _AsyncHook_initializer.set(this, void 0);
         _AsyncHook_invalidate.set(this, void 0);
         _AsyncHook_ctx.set(this, void 0);
-        console.debug('useAsync v1');
-        this.state = { data: null, loading: false, error: null };
+        _AsyncHook_options.set(this, void 0);
+        _AsyncHook_localDepends.set(this, void 0);
+        _AsyncHook_enabled.set(this, void 0);
+        console.debug('useAsync v1', options);
+        __classPrivateFieldSet(this, _AsyncHook_options, options, "f");
+        this.state = { data: null, loading: false, error: null, depends: null };
         __classPrivateFieldSet(this, _AsyncHook_hookId, params.hookId, "f");
         __classPrivateFieldSet(this, _AsyncHook_initializer, initializer, "f");
         __classPrivateFieldSet(this, _AsyncHook_invalidate, params.invalidate, "f");
         __classPrivateFieldSet(this, _AsyncHook_ctx, params.context, "f");
+        __classPrivateFieldSet(this, _AsyncHook_localDepends, options.depends ?? null, "f");
+        __classPrivateFieldSet(this, _AsyncHook_enabled, options.enabled ?? true, "f");
     }
     /**
      * After we look at our state, we need to decide if we need to dispatch a request to load the data.
      */
     onStateLoaded() {
+        if (!__classPrivateFieldGet(this, _AsyncHook_enabled, "f")) {
+            return;
+        }
         console.debug('async onLoad ', __classPrivateFieldGet(this, _AsyncHook_hookId, "f"), this.state);
-        if (this.state.data === null && this.state.error === null && this.state.loading === false) {
+        console.debug('async onLoad have ', __classPrivateFieldGet(this, _AsyncHook_localDepends, "f"), 'and', this.state.depends);
+        if (!isEqual(__classPrivateFieldGet(this, _AsyncHook_localDepends, "f"), this.state.depends) ||
+            (this.state.data === null && this.state.error === null && this.state.loading === false)) {
             this.state.loading = true;
+            this.state.depends = __classPrivateFieldGet(this, _AsyncHook_localDepends, "f");
             __classPrivateFieldGet(this, _AsyncHook_invalidate, "f").call(this);
             const requeueEvent = {
                 hook: __classPrivateFieldGet(this, _AsyncHook_hookId, "f"),
                 async: true,
-                asyncRequest: { requestId: __classPrivateFieldGet(this, _AsyncHook_hookId, "f") },
+                asyncRequest: {
+                    requestId: __classPrivateFieldGet(this, _AsyncHook_hookId, "f") + '-' + JSON.stringify(this.state.depends),
+                },
             };
             console.debug('onLoad requeue');
             __classPrivateFieldGet(this, _AsyncHook_ctx, "f").addToRequeueEvents(requeueEvent);
@@ -57,6 +73,9 @@ class AsyncHook {
             }
             catch (e) {
                 if (e instanceof Error) {
+                    if (e.message === CIRCUIT_BREAKER_MSG) {
+                        throw e;
+                    }
                     asyncResponse.error = { message: e.message, details: e.stack ?? '' };
                 }
                 else {
@@ -71,29 +90,35 @@ class AsyncHook {
             context.addToRequeueEvents(requeueEvent);
         }
         else if (event.asyncResponse) {
-            const result = {
-                data: event.asyncResponse.data?.value,
-                loading: false,
-                error: event.asyncResponse.error ?? null,
-            };
-            this.state = result;
-            __classPrivateFieldGet(this, _AsyncHook_invalidate, "f").call(this);
+            const anticipatedRequestId = __classPrivateFieldGet(this, _AsyncHook_hookId, "f") + '-' + JSON.stringify(this.state.depends);
+            if (event.asyncResponse.requestId === anticipatedRequestId) {
+                const result = {
+                    data: event.asyncResponse.data?.value,
+                    loading: false,
+                    error: event.asyncResponse.error ?? null,
+                };
+                this.state = { ...this.state, ...result };
+                __classPrivateFieldGet(this, _AsyncHook_invalidate, "f").call(this);
+            }
+            else {
+                console.debug('onResp skip, stale event');
+            }
         }
         else {
             throw new Error('Unknown event type');
         }
     }
 }
-_AsyncHook_hookId = new WeakMap(), _AsyncHook_initializer = new WeakMap(), _AsyncHook_invalidate = new WeakMap(), _AsyncHook_ctx = new WeakMap();
+_AsyncHook_hookId = new WeakMap(), _AsyncHook_initializer = new WeakMap(), _AsyncHook_invalidate = new WeakMap(), _AsyncHook_ctx = new WeakMap(), _AsyncHook_options = new WeakMap(), _AsyncHook_localDepends = new WeakMap(), _AsyncHook_enabled = new WeakMap();
 /**
  * This is the preferred way to handle async state in Devvit.
  *
  * @param initializer -- any async function that returns a JSONValue
  * @returns UseAsyncResult<S>
  */
-export function useAsync(initializer) {
+export function useAsync(initializer, options = {}) {
     const hook = registerHook({ namespace: 'useAsync' }, (params) => {
-        return new AsyncHook(initializer, params);
+        return new AsyncHook(initializer, options, params);
     });
     return hook.state;
 }

package/meta.json

@@ -12491,14 +12491,29 @@
       ],
       "format": "esm"
     },
+    "../shared-types/dist/CircuitBreaker.js": {
+      "bytes": 943,
+      "imports": [],
+      "format": "esm"
+    },
     "src/devvit/internals/blocks/handler/useAsync.ts": {
-      "bytes": 3350,
+      "bytes": 4653,
       "imports": [
         {
           "path": "src/devvit/internals/blocks/handler/BlocksHandler.ts",
           "kind": "import-statement",
           "original": "./BlocksHandler.js"
         },
+        {
+          "path": "../../node_modules/lodash.isequal/index.js",
+          "kind": "import-statement",
+          "original": "lodash.isequal"
+        },
+        {
+          "path": "../shared-types/dist/CircuitBreaker.js",
+          "kind": "import-statement",
+          "original": "@devvit/shared-types/CircuitBreaker.js"
+        },
         {
           "path": "<runtime>",
           "kind": "import-statement",
@@ -12508,7 +12523,7 @@
       "format": "esm"
     },
     "src/devvit/internals/blocks/handler/BlocksHandler.ts": {
-      "bytes": 15852,
+      "bytes": 16152,
       "imports": [
         {
           "path": "@devvit/protos",
@@ -14411,7 +14426,7 @@
           "bytesInOutput": 3085
         },
         "src/devvit/internals/blocks/handler/BlocksHandler.ts": {
-          "bytesInOutput": 13219
+          "bytesInOutput": 13522
         },
         "src/devvit/internals/blocks/handler/useForm.ts": {
           "bytesInOutput": 915
@@ -14438,7 +14453,10 @@
           "bytesInOutput": 1558
         },
         "src/devvit/internals/blocks/handler/useAsync.ts": {
-          "bytesInOutput": 2744
+          "bytesInOutput": 4060
+        },
+        "../shared-types/dist/CircuitBreaker.js": {
+          "bytesInOutput": 50
         },
         "src/devvit/internals/ui-request-handler.ts": {
           "bytesInOutput": 618
@@ -14522,7 +14540,7 @@
           "bytesInOutput": 370
         }
       },
-      "bytes": 14954664
+      "bytes": 14961084
     }
   }
 }

package/meta.min.json

@@ -3721,14 +3721,29 @@
       ],
       "format": "esm"
     },
+    "../shared-types/dist/CircuitBreaker.js": {
+      "bytes": 943,
+      "imports": [],
+      "format": "esm"
+    },
     "src/devvit/internals/blocks/handler/useAsync.ts": {
-      "bytes": 3350,
+      "bytes": 4653,
       "imports": [
         {
           "path": "src/devvit/internals/blocks/handler/BlocksHandler.ts",
           "kind": "import-statement",
           "original": "./BlocksHandler.js"
         },
+        {
+          "path": "../../node_modules/lodash.isequal/index.js",
+          "kind": "import-statement",
+          "original": "lodash.isequal"
+        },
+        {
+          "path": "../shared-types/dist/CircuitBreaker.js",
+          "kind": "import-statement",
+          "original": "@devvit/shared-types/CircuitBreaker.js"
+        },
         {
           "path": "<runtime>",
           "kind": "import-statement",
@@ -3738,7 +3753,7 @@
       "format": "esm"
     },
     "src/devvit/internals/blocks/handler/BlocksHandler.ts": {
-      "bytes": 15852,
+      "bytes": 16152,
       "imports": [
         {
           "path": "@devvit/protos",
@@ -4643,7 +4658,7 @@
       "imports": [],
       "exports": [],
       "inputs": {},
-      "bytes": 1129986
+      "bytes": 1133674
     },
     "dist/public-api.min.js": {
       "imports": [
@@ -5320,7 +5335,7 @@
           "bytesInOutput": 260
         },
         "src/devvit/internals/blocks/handler/BlocksHandler.ts": {
-          "bytesInOutput": 5523
+          "bytesInOutput": 5741
         },
         "src/devvit/internals/blocks/handler/UIClient.ts": {
           "bytesInOutput": 974
@@ -5347,7 +5362,10 @@
           "bytesInOutput": 627
         },
         "src/devvit/internals/blocks/handler/useAsync.ts": {
-          "bytesInOutput": 1265
+          "bytesInOutput": 1874
+        },
+        "../shared-types/dist/CircuitBreaker.js": {
+          "bytesInOutput": 28
         },
         "src/apis/reddit/helpers/makeGettersEnumerable.ts": {
           "bytesInOutput": 166
@@ -5425,7 +5443,7 @@
           "bytesInOutput": 178
         }
       },
-      "bytes": 239753
+      "bytes": 240608
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devvit/public-api",
-  "version": "0.10.22-next-2024-06-06-cf36c56e2.0",
+  "version": "0.10.22-next-2024-06-06-0f86ae113.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
@@ -30,8 +30,8 @@
   },
   "types": "./index.d.ts",
   "dependencies": {
-    "@devvit/protos": "0.10.22-next-2024-06-06-cf36c56e2.0",
-    "@devvit/shared-types": "0.10.22-next-2024-06-06-cf36c56e2.0",
+    "@devvit/protos": "0.10.22-next-2024-06-06-0f86ae113.0",
+    "@devvit/shared-types": "0.10.22-next-2024-06-06-0f86ae113.0",
     "base64-js": "1.5.1",
     "clone-deep": "4.0.1",
     "core-js": "3.27.2",
@@ -41,7 +41,7 @@
     "@ampproject/filesize": "4.3.0",
     "@devvit/eslint-config": "0.10.21",
     "@devvit/repo-tools": "0.10.21",
-    "@devvit/tsconfig": "0.10.22-next-2024-06-06-cf36c56e2.0",
+    "@devvit/tsconfig": "0.10.22-next-2024-06-06-0f86ae113.0",
     "@microsoft/api-extractor": "7.41.0",
     "@reddit/faceplate-ui": "11.3.3",
     "@types/clone-deep": "4.0.1",
@@ -64,5 +64,5 @@
     }
   },
   "source": "./src/index.ts",
-  "gitHead": "1ebbed96dc0b4e6c74e670fa46ad4d11db531c03"
+  "gitHead": "2d281619c3a9a358cb8851ff2f58ee52fb0bbf6b"
 }

package/public-api.d.ts

@@ -1457,6 +1457,17 @@ declare const AsyncError_2: {
     fromPartial(object: DeepPartial_49<AsyncError_2>): AsyncError_2;
 };
 
+declare type AsyncOptions = {
+    /**
+     * The data loader will re-run if the value of `depends` changes.
+     */
+    depends?: JSONValue;
+    /**
+     * If `enabled` is false, the data loader will not run.
+     */
+    enabled?: boolean;
+};
+
 declare interface AsyncRequest {
     requestId: string;
     data?: {
@@ -65410,7 +65421,7 @@ declare type UrlString = string;
  * @param initializer -- any async function that returns a JSONValue
  * @returns UseAsyncResult<S>
  */
-export declare function useAsync<S extends JSONValue>(initializer: AsyncUseStateInitializer<S>): UseAsyncResult<S>;
+export declare function useAsync<S extends JSONValue>(initializer: AsyncUseStateInitializer<S>, options?: AsyncOptions): UseAsyncResult<S>;
 
 export declare type UseAsyncResult<S> = {
     data: S | null;