relay-runtime 0.0.0-main-a4e82e93 → 0.0.0-main-5c3febad

package/experimental.js

@@ -1,5 +1,5 @@
 /**
- * Relay v0.0.0-main-a4e82e93
+ * Relay v0.0.0-main-5c3febad
  *
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

package/index.js

@@ -1,5 +1,5 @@
 /**
- * Relay v0.0.0-main-a4e82e93
+ * Relay v0.0.0-main-5c3febad
  *
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

package/lib/store/live-resolvers/LiveResolverCache.js

@@ -144,12 +144,18 @@ var LiveResolverCache = /*#__PURE__*/function () {
     var liveStateRecord = recordSource.get(liveStateID);
     !(liveStateRecord != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'Expected to find record for live resolver.') : invariant(false) : void 0;
     var liveState = RelayModernRecord.getValue(liveStateRecord, RELAY_RESOLVER_LIVE_STATE_VALUE);
-    return new Promise(function (resolve) {
+    var promise = new Promise(function (resolve) {
       var unsubscribe = liveState.subscribe(function () {
         unsubscribe();
         resolve();
       });
     });
+    if (liveState.getSuspenseDisplayName != null) {
+      try {
+        promise.displayName = liveState.getSuspenseDisplayName();
+      } catch (_unused) {}
+    }
+    return promise;
   };
   _proto._setLiveStateValue = function _setLiveStateValue(linkedRecord, linkedID, liveState, field, variables) {
     var handler = this._makeLiveStateHandler(linkedID);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "relay-runtime",
   "description": "A core runtime for building GraphQL-driven applications.",
-  "version": "0.0.0-main-a4e82e93",
+  "version": "0.0.0-main-5c3febad",
   "keywords": [
     "graphql",
     "relay"

package/store/RelayStoreTypes.d.ts

@@ -1297,6 +1297,18 @@ export interface LiveState<T> {
      * should stop calling the callback for state updates.
      */
     subscribe(callback: () => void): () => void;
+
+    /**
+     * Optional. Called when Relay creates a suspense promise for this live
+     * state, and used to name that promise. Called at promise-creation time,
+     * so it can describe whatever is loading at that moment.
+     *
+     * Runs while a read is suspending, so it must be pure and cheap. The name
+     * may be reported to profiling tools, so prefer a fixed label or a small
+     * enum over anything request-specific. Return null when there is nothing
+     * specific to say.
+     */
+    readonly getSuspenseDisplayName?: () => string | null | undefined;
 }
 
 export function suspenseSentinel(): never;

package/store/RelayStoreTypes.js.flow

@@ -1666,6 +1666,17 @@ export type LiveState<out T> = {
    * call the callback when the value of the live state changes.
    */
   subscribe(cb: () => void): () => void,
+  /**
+   * Optional. Called when Relay creates a suspense promise for this live
+   * state, and used to name that promise. Called at promise-creation time, so
+   * it can describe whatever is loading at that moment.
+   *
+   * Runs while a read is suspending, so it must be pure and cheap. The name
+   * may be reported to profiling tools, so prefer a fixed label or a small
+   * enum over anything request-specific. Return null when there is nothing
+   * specific to say.
+   */
+  readonly getSuspenseDisplayName?: () => ?string,
 };
 
 /**

package/store/live-resolvers/LiveResolverCache.js.flow

@@ -332,12 +332,24 @@ class LiveResolverCache implements ResolverCache {
       RELAY_RESOLVER_LIVE_STATE_VALUE,
     );
 
-    return new Promise(resolve => {
+    const promise = new Promise<void>(resolve => {
       const unsubscribe: () => void = liveState.subscribe(() => {
         unsubscribe();
         resolve();
       });
     });
+
+    if (liveState.getSuspenseDisplayName != null) {
+      try {
+        // $FlowExpectedError[prop-missing] Expando to annotate Promises.
+        promise.displayName = liveState.getSuspenseDisplayName();
+      } catch {
+        // The name only annotates the promise, so a bug in the producer's
+        // implementation must not fail the read that is suspending.
+      }
+    }
+
+    return promise;
   }
 
   // Register a new Live State object in the store, subscribing to future