react-relay 0.0.0-main-99abbcde → 0.0.0-main-56cda151

package/ReactRelayContext.js

@@ -1,5 +1,5 @@
 /**
- * Relay v0.0.0-main-99abbcde
+ * Relay v0.0.0-main-56cda151
  *
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

package/hooks.js

@@ -1,5 +1,5 @@
 /**
- * Relay v0.0.0-main-99abbcde
+ * Relay v0.0.0-main-56cda151
  *
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

package/index.js

@@ -1,5 +1,5 @@
 /**
- * Relay v0.0.0-main-99abbcde
+ * Relay v0.0.0-main-56cda151
  *
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

package/legacy.js

@@ -1,5 +1,5 @@
 /**
- * Relay v0.0.0-main-99abbcde
+ * Relay v0.0.0-main-56cda151
  *
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

package/lib/relay-hooks/rsc/useQueryFromServer.js

@@ -3,49 +3,57 @@
 
 var usePreloadedQuery = require('../usePreloadedQuery');
 var useRelayEnvironment = require('../useRelayEnvironment');
+var invariant = require('invariant');
 var _require = require('react'),
   use = _require.use,
+  useEffect = _require.useEffect,
+  useLayoutEffect = _require.useLayoutEffect,
   useMemo = _require.useMemo;
 var _require2 = require('relay-runtime'),
-  __internal = _require2.__internal,
-  ROOT_TYPE = _require2.ROOT_TYPE,
+  RelayModernEnvironment = _require2.Environment,
   createOperationDescriptor = _require2.createOperationDescriptor,
   getRequest = _require2.getRequest;
-var defaultGetDataID = __internal.defaultGetDataID,
-  normalizeResponse = __internal.normalizeResponse;
-var committedRefs = new WeakSet();
+var publishedQueryRefs = new WeakMap();
+function getPublishedQueryRefs(environment) {
+  var refs = publishedQueryRefs.get(environment);
+  if (refs == null) {
+    refs = new WeakMap();
+    publishedQueryRefs.set(environment, refs);
+  }
+  return refs;
+}
 var DEFAULT_STALE_MS = 30_000;
+var useIsomorphicLayoutEffect = typeof window === 'undefined' ? useEffect : useLayoutEffect;
 function useQueryFromServer(query, queryRef, options) {
-  var _options$staleThresho, _environment$_getData;
+  var _options$staleThresho, _environment$construc, _environment$construc2;
   var environment = useRelayEnvironment();
   var request = getRequest(query);
   var threshold = (_options$staleThresho = options === null || options === void 0 ? void 0 : options.staleThresholdMs) !== null && _options$staleThresho !== void 0 ? _options$staleThresho : DEFAULT_STALE_MS;
-  var getDataID = (_environment$_getData = environment._getDataID) !== null && _environment$_getData !== void 0 ? _environment$_getData : defaultGetDataID;
   var response = use(queryRef._response);
   var isFresh = response.data != null && Date.now() - queryRef.fetchedAt <= threshold;
-  var shouldCommit = isFresh && !committedRefs.has(queryRef);
+  !(environment instanceof RelayModernEnvironment) ? process.env.NODE_ENV !== "production" ? invariant(false, 'useQueryFromServer: expected a RelayModernEnvironment, got `%s`. ' + 'useQueryFromServer is currently only compatible with RelayModernStore.', (_environment$construc = (_environment$construc2 = environment.constructor) === null || _environment$construc2 === void 0 ? void 0 : _environment$construc2.name) !== null && _environment$construc !== void 0 ? _environment$construc : typeof environment) : invariant(false) : void 0;
+  var publishedRefs = getPublishedQueryRefs(environment);
+  var shouldCommit = isFresh && !publishedRefs.has(queryRef);
   if (shouldCommit) {
-    var _environment$__log;
-    committedRefs.add(queryRef);
     var operation = createOperationDescriptor(request, queryRef.variables);
     var responsePayload = {
       data: response.data,
       errors: response.errors
     };
-    var relayPayload = normalizeResponse(responsePayload, operation.root, ROOT_TYPE, {
-      getDataID: getDataID,
-      treatMissingFieldsAsNull: false,
-      deferDeduplicatedFields: false,
-      log: (_environment$__log = environment.__log) !== null && _environment$__log !== void 0 ? _environment$__log : null,
-      path: [],
-      shouldProcessClientComponents: false
-    }, false);
-    environment.getStore().publish(relayPayload.source);
+    publishedRefs.set(queryRef, environment.publishWithDeferredNotify(operation, responsePayload));
   }
+  useIsomorphicLayoutEffect(function () {
+    var refs = getPublishedQueryRefs(environment);
+    var flushNotify = refs.get(queryRef);
+    if (flushNotify != null) {
+      refs.set(queryRef, null);
+      flushNotify();
+    }
+  }, [environment, queryRef]);
   var preloadedQuery = useMemo(function () {
     var _request$params$id;
     var isFreshAtMemo = response.data != null && Date.now() - queryRef.fetchedAt <= threshold;
-    var useStore = isFreshAtMemo || committedRefs.has(queryRef);
+    var useStore = isFreshAtMemo || getPublishedQueryRefs(environment).has(queryRef);
     return {
       kind: 'PreloadedQuery_DEPRECATED',
       environment: environment,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-relay",
   "description": "A framework for building GraphQL-driven React applications.",
-  "version": "0.0.0-main-99abbcde",
+  "version": "0.0.0-main-56cda151",
   "keywords": [
     "graphql",
     "relay",
@@ -20,7 +20,7 @@
     "fbjs": "^3.0.2",
     "invariant": "^2.2.4",
     "nullthrows": "^1.1.1",
-    "relay-runtime": "0.0.0-main-99abbcde"
+    "relay-runtime": "0.0.0-main-56cda151"
   },
   "peerDependencies": {
     "react": "^16.9.0 || ^17 || ^18 || ^19"

package/relay-hooks/rsc/useQueryFromServer.js.flow

@@ -16,26 +16,50 @@ import type {
   PreloadedQueryRef,
   PreloadedQueryResponse,
 } from './serverPreloadQuery';
-import type {Query, Variables} from 'relay-runtime';
+import type {IEnvironment, Query, Variables} from 'relay-runtime';
 
 const usePreloadedQuery = require('../usePreloadedQuery');
 const useRelayEnvironment = require('../useRelayEnvironment');
+const invariant = require('invariant');
 // $FlowFixMe[missing-export] React.use is available in React 19+
-const {use, useMemo} = require('react');
+const {use, useEffect, useLayoutEffect, useMemo} = require('react');
 const {
-  __internal,
-  ROOT_TYPE,
+  Environment: RelayModernEnvironment,
   createOperationDescriptor,
   getRequest,
 } = require('relay-runtime');
 
-const {defaultGetDataID, normalizeResponse} = __internal;
-
-// $FlowFixMe[unclear-type] WeakSet used for identity-based dedup only
-const committedRefs: WeakSet<any> = new WeakSet();
+// Which refs have been published to which environment, and the notify each
+// still owes. Module state, not a component ref: the attempt that publishes
+// need not be the attempt that commits. Keyed by environment because
+// "published" is a fact about one store.
+const publishedQueryRefs: WeakMap<
+  IEnvironment,
+  // $FlowFixMe[unclear-type] keyed by ref identity only
+  WeakMap<any, (() => void) | null>,
+> = new WeakMap();
+
+function getPublishedQueryRefs(
+  environment: IEnvironment,
+  // $FlowFixMe[unclear-type] keyed by ref identity only
+): WeakMap<any, (() => void) | null> {
+  let refs = publishedQueryRefs.get(environment);
+  if (refs == null) {
+    refs = new WeakMap();
+    publishedQueryRefs.set(environment, refs);
+  }
+  return refs;
+}
 
 const DEFAULT_STALE_MS = 30_000;
 
+// This is a 'use client' hook, so it still renders during SSR, where
+// useLayoutEffect warns and does nothing. There is no notify to flush there
+// either: nothing is subscribed to a server render's store.
+const useIsomorphicLayoutEffect =
+  // $FlowFixMe[cannot-resolve-name] `window` has no libdef in the OSS build
+  typeof window === 'undefined' ? useEffect : useLayoutEffect;
+
 hook useQueryFromServer<TVariables extends Variables, TData>(
   query: Query<TVariables, TData>,
   queryRef: PreloadedQueryRef<TVariables, TData>,
@@ -44,26 +68,25 @@ hook useQueryFromServer<TVariables extends Variables, TData>(
   const environment = useRelayEnvironment();
   const request = getRequest(query);
   const threshold = options?.staleThresholdMs ?? DEFAULT_STALE_MS;
-  // TODO: Add a method to IEnvironment for server-side publish so custom
-  // IEnvironment implementations don't need to access _getDataID.
-  // $FlowFixMe[prop-missing] _getDataID is not on IEnvironment
-  // $FlowFixMe[unclear-type]
-  const getDataID: any = environment._getDataID ?? defaultGetDataID;
 
   const response: PreloadedQueryResponse<TData> = use(queryRef._response);
 
   const isFresh =
     response.data != null && Date.now() - queryRef.fetchedAt <= threshold;
 
-  const shouldCommit = isFresh && !committedRefs.has(queryRef);
+  // `publishWithDeferredNotify` is on RelayModernEnvironment rather than
+  // IEnvironment while the API is experimental.
+  invariant(
+    environment instanceof RelayModernEnvironment,
+    'useQueryFromServer: expected a RelayModernEnvironment, got `%s`. ' +
+      'useQueryFromServer is currently only compatible with RelayModernStore.',
+    environment.constructor?.name ?? typeof environment,
+  );
 
-  // Publish server data to the Relay store without notifying subscribers.
-  // This avoids the React "Cannot update a component while rendering a
-  // different component" error that occurs when store.notify() triggers
-  // setState in other mounted components that subscribe to overlapping records.
-  if (shouldCommit) {
-    committedRefs.add(queryRef);
+  const publishedRefs = getPublishedQueryRefs(environment);
+  const shouldCommit = isFresh && !publishedRefs.has(queryRef);
 
+  if (shouldCommit) {
     const operation = createOperationDescriptor(request, queryRef.variables);
 
     // $FlowFixMe[unclear-type]
@@ -71,25 +94,28 @@ hook useQueryFromServer<TVariables extends Variables, TData>(
       data: response.data,
       errors: response.errors,
     };
-    const relayPayload = normalizeResponse(
-      responsePayload,
-      operation.root,
-      ROOT_TYPE,
-      {
-        getDataID,
-        treatMissingFieldsAsNull: false,
-        deferDeduplicatedFields: false,
-        // $FlowFixMe[prop-missing]
-        log: environment.__log ?? null,
-        path: [],
-        shouldProcessClientComponents: false,
-      },
-      false,
+    publishedRefs.set(
+      queryRef,
+      environment.publishWithDeferredNotify(operation, responsePayload),
     );
-
-    environment.getStore().publish(relayPayload.source);
   }
 
+  // A layout effect rather than during render, which would be a setState in
+  // another component mid-render, and rather than a microtask, which can land
+  // between concurrent-render work units. Not airtight: a subtree that renders
+  // but never mounts never runs this, and its notify waits for the next one.
+  useIsomorphicLayoutEffect(() => {
+    const refs = getPublishedQueryRefs(environment);
+    const flushNotify = refs.get(queryRef);
+    if (flushNotify != null) {
+      // Null rather than delete: the entry is also what marks this ref
+      // published, so removing it would republish on the next render and flip
+      // the fetch policy below back to network-only.
+      refs.set(queryRef, null);
+      flushNotify();
+    }
+  }, [environment, queryRef]);
+
   // Build a PreloadedQuery shim. Fresh data was committed to the store
   // above, so source is null and fetchPolicy is "store-or-network".
   // Stale path uses "network-only" to trigger a client-side refetch.
@@ -101,7 +127,8 @@ hook useQueryFromServer<TVariables extends Variables, TData>(
     // component instance, read from the store even if the server timestamp
     // is past the staleness threshold. This prevents a network refetch
     // from overwriting store mutations made after the initial commit.
-    const useStore = isFreshAtMemo || committedRefs.has(queryRef);
+    const useStore =
+      isFreshAtMemo || getPublishedQueryRefs(environment).has(queryRef);
 
     return {
       kind: 'PreloadedQuery_DEPRECATED',

package/rsc-client_EXPERIMENTAL.js

@@ -1,5 +1,5 @@
 /**
- * Relay v0.0.0-main-99abbcde
+ * Relay v0.0.0-main-56cda151
  *
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

package/rsc_EXPERIMENTAL.js

@@ -1,5 +1,5 @@
 /**
- * Relay v0.0.0-main-99abbcde
+ * Relay v0.0.0-main-56cda151
  *
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *