react-relay 11.0.2 → 13.0.0-rc.2

package/lib/relay-hooks/usePreloadedQuery.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
@@ -11,7 +11,8 @@
 // flowlint ambiguous-object-type:error
 'use strict';
 
-var invariant = require('invariant');
+var _require = require('./loadQuery'),
+    useTrackLoadQueryInRender = _require.useTrackLoadQueryInRender;
 
 var useLazyLoadQueryNode = require('./useLazyLoadQueryNode');
 
@@ -19,10 +20,7 @@ var useMemoOperationDescriptor = require('./useMemoOperationDescriptor');
 
 var useRelayEnvironment = require('./useRelayEnvironment');
 
-var warning = require("fbjs/lib/warning");
-
-var _require = require('./loadQuery'),
-    useTrackLoadQueryInRender = _require.useTrackLoadQueryInRender;
+var invariant = require('invariant');
 
 var _require2 = require('react'),
     useDebugValue = _require2.useDebugValue;
@@ -32,6 +30,8 @@ var _require3 = require('relay-runtime'),
     fetchQueryDeduped = _require3$__internal.fetchQueryDeduped,
     fetchQuery = _require3$__internal.fetchQuery;
 
+var warning = require("fbjs/lib/warning");
+
 function usePreloadedQuery(gqlQuery, preloadedQuery, options) {
   // We need to use this hook in order to be able to track if
   // loadQuery was called during render

package/lib/relay-hooks/useQueryLoader.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
@@ -15,24 +15,36 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 
 var _createForOfIteratorHelper2 = _interopRequireDefault(require("@babel/runtime/helpers/createForOfIteratorHelper"));
 
-var useIsMountedRef = require('./useIsMountedRef');
-
-var useRelayEnvironment = require('./useRelayEnvironment');
-
 var _require = require('./loadQuery'),
     loadQuery = _require.loadQuery,
     useTrackLoadQueryInRender = _require.useTrackLoadQueryInRender;
 
+var useIsMountedRef = require('./useIsMountedRef');
+
+var useRelayEnvironment = require('./useRelayEnvironment');
+
 var _require2 = require('react'),
     useCallback = _require2.useCallback,
     useEffect = _require2.useEffect,
     useRef = _require2.useRef,
     useState = _require2.useState;
 
+var _require3 = require('relay-runtime'),
+    getRequest = _require3.getRequest;
+
 var initialNullQueryReferenceState = {
   kind: 'NullQueryReference'
 };
 
+function requestIsLiveQuery(preloadableRequest) {
+  if (preloadableRequest.kind === 'PreloadableConcreteRequest') {
+    return preloadableRequest.params.metadata.live !== undefined;
+  }
+
+  var request = getRequest(preloadableRequest);
+  return request.params.metadata.live !== undefined;
+}
+
 function useQueryLoader(preloadableRequest, initialQueryReference) {
   /**
    * We want to always call `queryReference.dispose()` for every call to
@@ -175,7 +187,11 @@ function useQueryLoader(preloadableRequest, initialQueryReference) {
           undisposedQueryReferences["delete"](undisposedQueryReference);
 
           if (undisposedQueryReference.kind !== 'NullQueryReference') {
-            undisposedQueryReference.dispose && undisposedQueryReference.dispose();
+            if (requestIsLiveQuery(preloadableRequest)) {
+              undisposedQueryReference.dispose && undisposedQueryReference.dispose();
+            } else {
+              undisposedQueryReference.releaseQuery && undisposedQueryReference.releaseQuery();
+            }
           }
         }
       } catch (err) {
@@ -184,7 +200,7 @@ function useQueryLoader(preloadableRequest, initialQueryReference) {
         _iterator.f();
       }
     }
-  }, [queryReference, isMountedRef, queryLoaderCallback]);
+  }, [queryReference, isMountedRef, queryLoaderCallback, preloadableRequest]);
   useEffect(function () {
     return function disposeAllRemainingQueryReferences() {
       // undisposedQueryReferences.current is never reassigned
@@ -194,10 +210,14 @@ function useQueryLoader(preloadableRequest, initialQueryReference) {
 
       try {
         for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
-          var unhandledStateChange = _step2.value;
+          var undisposedQueryReference = _step2.value;
 
-          if (unhandledStateChange.kind !== 'NullQueryReference') {
-            unhandledStateChange.dispose && unhandledStateChange.dispose();
+          if (undisposedQueryReference.kind !== 'NullQueryReference') {
+            if (requestIsLiveQuery(preloadableRequest)) {
+              undisposedQueryReference.dispose && undisposedQueryReference.dispose();
+            } else {
+              undisposedQueryReference.releaseQuery && undisposedQueryReference.releaseQuery();
+            }
           }
         }
       } catch (err) {
@@ -206,7 +226,7 @@ function useQueryLoader(preloadableRequest, initialQueryReference) {
         _iterator2.f();
       }
     };
-  }, []);
+  }, [preloadableRequest]);
   return [queryReference.kind === 'NullQueryReference' ? null : queryReference, queryLoaderCallback, disposeQuery];
 }
 

package/lib/relay-hooks/useRefetchableFragment.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.

package/lib/relay-hooks/useRefetchableFragmentNode.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
@@ -15,13 +15,13 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 
 var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
 
-var ProfilerContext = require('./ProfilerContext');
-
-var getRefetchMetadata = require('./getRefetchMetadata');
+var _require = require('./FragmentResource'),
+    getFragmentResourceForEnvironment = _require.getFragmentResourceForEnvironment;
 
-var getValueAtPath = require('./getValueAtPath');
+var ProfilerContext = require('./ProfilerContext');
 
-var invariant = require('invariant');
+var _require2 = require('./QueryResource'),
+    getQueryResourceForEnvironment = _require2.getQueryResourceForEnvironment;
 
 var useFragmentNode = require('./useFragmentNode');
 
@@ -31,13 +31,7 @@ var useQueryLoader = require('./useQueryLoader');
 
 var useRelayEnvironment = require('./useRelayEnvironment');
 
-var warning = require("fbjs/lib/warning");
-
-var _require = require('./FragmentResource'),
-    getFragmentResourceForEnvironment = _require.getFragmentResourceForEnvironment;
-
-var _require2 = require('./QueryResource'),
-    getQueryResourceForEnvironment = _require2.getQueryResourceForEnvironment;
+var invariant = require('invariant');
 
 var _require3 = require('react'),
     useCallback = _require3.useCallback,
@@ -48,7 +42,11 @@ var _require4 = require('relay-runtime'),
     fetchQuery = _require4.__internal.fetchQuery,
     createOperationDescriptor = _require4.createOperationDescriptor,
     getFragmentIdentifier = _require4.getFragmentIdentifier,
-    getSelector = _require4.getSelector;
+    getRefetchMetadata = _require4.getRefetchMetadata,
+    getSelector = _require4.getSelector,
+    getValueAtPath = _require4.getValueAtPath;
+
+var warning = require("fbjs/lib/warning");
 
 function reducer(state, action) {
   switch (action.type) {
@@ -262,7 +260,6 @@ function useRefetchFunction(componentDisplayName, dispatch, disposeQuery, fragme
     // all variables required by the fragment when calling `refetch()`.
     // We fill in any variables not passed by the call to `refetch()` with the
     // variables from the original parent fragment owner.
-    // $FlowFixMe[cannot-spread-interface]
 
 
     var refetchVariables = (0, _objectSpread2["default"])((0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, parentVariables), fragmentVariables), providedRefetchVariables); // If the query needs an identifier value ('id' or similar) and one
@@ -312,7 +309,7 @@ function useRefetchFunction(componentDisplayName, dispatch, disposeQuery, fragme
   //   - fragmentNode and parentFragmentRef are also captured by including
   //     fragmentIdentifier
   // eslint-disable-next-line react-hooks/exhaustive-deps
-  [fragmentIdentifier, dispatch, disposeQuery, identifierValue]);
+  [fragmentIdentifier, dispatch, disposeQuery, identifierValue, loadQuery]);
 }
 
 var debugFunctions;
@@ -321,8 +318,7 @@ if (process.env.NODE_ENV !== "production") {
   debugFunctions = {
     getInitialIDAndType: function getInitialIDAndType(memoRefetchVariables, fragmentRefPathInResponse, environment) {
       var _require5 = require('relay-runtime'),
-          Record = _require5.Record; // $FlowFixMe[prop-missing]
-
+          Record = _require5.Record;
 
       var id = memoRefetchVariables === null || memoRefetchVariables === void 0 ? void 0 : memoRefetchVariables.id;
 

package/lib/relay-hooks/useRelayEnvironment.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
@@ -11,13 +11,13 @@
 // flowlint ambiguous-object-type:error
 'use strict';
 
-var ReactRelayContext = require('react-relay/ReactRelayContext');
-
 var invariant = require('invariant');
 
 var _require = require('react'),
     useContext = _require.useContext;
 
+var ReactRelayContext = require('react-relay/ReactRelayContext');
+
 function useRelayEnvironment() {
   var context = useContext(ReactRelayContext);
   !(context != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'useRelayEnvironment: Expected to have found a Relay environment provided by ' + 'a `RelayEnvironmentProvider` component. ' + 'This usually means that useRelayEnvironment was used in a ' + 'component that is not a descendant of a `RelayEnvironmentProvider`. ' + 'Please make sure a `RelayEnvironmentProvider` has been rendered somewhere ' + 'as a parent or ancestor of your component.') : invariant(false) : void 0;

package/lib/relay-hooks/useStaticFragmentNodeWarning.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
@@ -11,11 +11,11 @@
 // flowlint ambiguous-object-type:error
 'use strict';
 
-var warning = require("fbjs/lib/warning");
-
 var _require = require('react'),
     useRef = _require.useRef;
 
+var warning = require("fbjs/lib/warning");
+
 function useStaticFragmentNodeWarning(fragmentNode, warningContext) {
   if (process.env.NODE_ENV !== "production") {
     // This is calling `useRef` conditionally, but based on the environment

package/lib/relay-hooks/useSubscribeToInvalidationState.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
@@ -16,7 +16,6 @@ var useRelayEnvironment = require('./useRelayEnvironment');
 var _require = require('react'),
     useEffect = _require.useEffect,
     useRef = _require.useRef;
-
 /**
  * This hook subscribes a callback to the invalidation state of the given data
  * ids.
@@ -26,6 +25,8 @@ var _require = require('react'),
  * re-established and the previous one will be disposed.
  * The subscription will automatically be disposed on unmount
  */
+
+
 function useSubscribeToInvalidationState(dataIDs, callback) {
   var environment = useRelayEnvironment();
   var disposableRef = useRef(null);

package/lib/relay-hooks/useSubscription.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
@@ -10,12 +10,13 @@
 // flowlint ambiguous-object-type:error
 'use strict';
 
-var React = require('react');
-
 var useRelayEnvironment = require('./useRelayEnvironment');
 
-var _require = require('relay-runtime'),
-    requestSubscription = _require.requestSubscription;
+var _require = require('react'),
+    useEffect = _require.useEffect;
+
+var _require2 = require('relay-runtime'),
+    requestSubscription = _require2.requestSubscription;
 
 function useSubscription(config, requestSubscriptionFn) {
   // N.B. this will re-subscribe every render if config or requestSubscriptionFn
@@ -23,9 +24,11 @@ function useSubscription(config, requestSubscriptionFn) {
   // Please do not pass an object defined in-line.
   var actualRequestSubscription = requestSubscriptionFn !== null && requestSubscriptionFn !== void 0 ? requestSubscriptionFn : requestSubscription;
   var environment = useRelayEnvironment();
-  React.useEffect(function () {
-    var _requestSubscription = requestSubscription(environment, config),
-        dispose = _requestSubscription.dispose;
+  useEffect(function () {
+    // $FlowFixMe[method-unbinding] added when improving typing for this parameters
+    var _actualRequestSubscri = actualRequestSubscription(environment, config),
+        dispose = _actualRequestSubscri.dispose; // $FlowFixMe[incompatible-call]
+
 
     return dispose;
   }, [environment, config, actualRequestSubscription]);

package/multi-actor/ActorChange.js.flow

@@ -0,0 +1,58 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict-local
+ * @emails oncall+relay
+ * @format
+ */
+
+'use strict';
+
+import type {ActorIdentifier} from 'relay-runtime/multi-actor-environment';
+
+const RelayEnvironmentProvider = require('../relay-hooks/RelayEnvironmentProvider');
+const useRelayActorEnvironment = require('./useRelayActorEnvironment');
+const React = require('react');
+
+export opaque type ActorChangePoint<TFragmentRef> = $ReadOnly<{
+  __fragmentRef: TFragmentRef,
+  __viewer: ActorIdentifier,
+}>;
+
+type ActorChangeProps<TFragmentRef> = {
+  actorChangePoint: ActorChangePoint<TFragmentRef>,
+  children: (
+    fragmentRef: TFragmentRef,
+    actorIdentifier: ActorIdentifier,
+  ) => React.MixedElement,
+};
+
+function ActorChange<TFragmentRef>(
+  props: ActorChangeProps<TFragmentRef>,
+): React.Element<typeof RelayEnvironmentProvider> {
+  const actorEnvironment = useRelayActorEnvironment(
+    props.actorChangePoint.__viewer,
+  );
+  const getEnvironmentForActor = React.useCallback(
+    (actorIdentifier: ActorIdentifier) => {
+      return actorEnvironment.multiActorEnvironment.forActor(actorIdentifier);
+    },
+    [actorEnvironment],
+  );
+
+  return (
+    <RelayEnvironmentProvider
+      environment={actorEnvironment}
+      getEnvironmentForActor={getEnvironmentForActor}>
+      {props.children(
+        props.actorChangePoint.__fragmentRef,
+        props.actorChangePoint.__viewer,
+      )}
+    </RelayEnvironmentProvider>
+  );
+}
+
+module.exports = ActorChange;

package/multi-actor/index.js.flow

@@ -0,0 +1,14 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict-local
+ * @emails oncall+relay
+ * @format
+ */
+
+'use strict';
+
+export type {ActorChangePoint} from './ActorChange';

package/multi-actor/useRelayActorEnvironment.js.flow

@@ -0,0 +1,49 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails oncall+relay
+ * @flow strict-local
+ * @format
+ */
+
+// flowlint ambiguous-object-type:error
+
+'use strict';
+
+import type {
+  ActorIdentifier,
+  IActorEnvironment,
+} from 'relay-runtime/multi-actor-environment';
+
+const invariant = require('invariant');
+const {useContext} = require('react');
+const ReactRelayContext = require('react-relay/ReactRelayContext');
+
+function useRelayActorEnvironment(
+  actorIdentifier: ActorIdentifier,
+): IActorEnvironment {
+  const context = useContext(ReactRelayContext);
+  invariant(
+    context != null,
+    'useRelayActorEnvironment: Expected to have found a Relay environment provided by ' +
+      'a `RelayEnvironmentProvider` component. ' +
+      'This usually means that useRelayActorEnvironment was used in a ' +
+      'component that is not a descendant of a `RelayEnvironmentProvider`. ' +
+      'Please make sure a `RelayEnvironmentProvider` has been rendered somewhere ' +
+      'as a parent or ancestor of your component.',
+  );
+  const getEnvironmentForActor = context.getEnvironmentForActor;
+  invariant(
+    getEnvironmentForActor != null,
+    'useRelayActorEnvironment: Expected to have a function `getEnvironmentForActor`.' +
+      'This usually means that `RelayEnvironmentProvider`. was not properly set up for use in the ' +
+      'multi actor application. Please make sure the provider has defined a `getEnvironmentForActor`.',
+  );
+
+  return getEnvironmentForActor(actorIdentifier);
+}
+
+module.exports = useRelayActorEnvironment;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-relay",
   "description": "A framework for building GraphQL-driven React applications.",
-  "version": "11.0.2",
+  "version": "13.0.0-rc.2",
   "keywords": [
     "graphql",
     "relay",
@@ -13,10 +13,10 @@
   "repository": "facebook/relay",
   "dependencies": {
     "@babel/runtime": "^7.0.0",
-    "fbjs": "^3.0.0",
+    "fbjs": "^3.0.2",
     "invariant": "^2.2.4",
     "nullthrows": "^1.1.1",
-    "relay-runtime": "11.0.2"
+    "relay-runtime": "13.0.0-rc.2"
   },
   "peerDependencies": {
     "react": "^16.9.0 || ^17"