relay-runtime 11.0.2 → 13.0.0-rc.2

package/lib/index.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.
@@ -14,25 +14,48 @@ var ConnectionHandler = require('./handlers/connection/ConnectionHandler');
 
 var ConnectionInterface = require('./handlers/connection/ConnectionInterface');
 
-var GraphQLTag = require('./query/GraphQLTag');
-
 var MutationHandlers = require('./handlers/connection/MutationHandlers');
 
-var PreloadableQueryRegistry = require('./query/PreloadableQueryRegistry');
+var RelayDefaultHandlerProvider = require('./handlers/RelayDefaultHandlerProvider');
 
-var RelayConcreteNode = require('./util/RelayConcreteNode');
+var applyOptimisticMutation = require('./mutations/applyOptimisticMutation');
 
-var RelayConcreteVariables = require('./store/RelayConcreteVariables');
+var commitLocalUpdate = require('./mutations/commitLocalUpdate');
+
+var commitMutation = require('./mutations/commitMutation');
 
 var RelayDeclarativeMutationConfig = require('./mutations/RelayDeclarativeMutationConfig');
 
-var RelayDefaultHandleKey = require('./util/RelayDefaultHandleKey');
+var RelayNetwork = require('./network/RelayNetwork');
 
-var RelayDefaultHandlerProvider = require('./handlers/RelayDefaultHandlerProvider');
+var RelayObservable = require('./network/RelayObservable');
 
-var RelayError = require('./util/RelayError');
+var RelayQueryResponseCache = require('./network/RelayQueryResponseCache');
 
-var RelayFeatureFlags = require('./util/RelayFeatureFlags');
+var fetchQuery = require('./query/fetchQuery');
+
+var fetchQuery_DEPRECATED = require('./query/fetchQuery_DEPRECATED');
+
+var fetchQueryInternal = require('./query/fetchQueryInternal');
+
+var GraphQLTag = require('./query/GraphQLTag');
+
+var PreloadableQueryRegistry = require('./query/PreloadableQueryRegistry');
+
+var _require = require('./store/ClientID'),
+    generateClientID = _require.generateClientID,
+    generateUniqueClientID = _require.generateUniqueClientID,
+    isClientID = _require.isClientID;
+
+var createFragmentSpecResolver = require('./store/createFragmentSpecResolver');
+
+var createRelayContext = require('./store/createRelayContext');
+
+var isRelayModernEnvironment = require('./store/isRelayModernEnvironment');
+
+var readInlineData = require('./store/readInlineData');
+
+var RelayConcreteVariables = require('./store/RelayConcreteVariables');
 
 var RelayModernEnvironment = require('./store/RelayModernEnvironment');
 
@@ -44,70 +67,57 @@ var RelayModernSelector = require('./store/RelayModernSelector');
 
 var RelayModernStore = require('./store/RelayModernStore');
 
-var RelayNetwork = require('./network/RelayNetwork');
-
-var RelayObservable = require('./network/RelayObservable');
-
 var RelayOperationTracker = require('./store/RelayOperationTracker');
 
-var RelayProfiler = require('./util/RelayProfiler');
-
-var RelayQueryResponseCache = require('./network/RelayQueryResponseCache');
-
 var RelayRecordSource = require('./store/RelayRecordSource');
 
-var RelayReplaySubject = require('./util/RelayReplaySubject');
-
 var RelayStoreUtils = require('./store/RelayStoreUtils');
 
 var ViewerPattern = require('./store/ViewerPattern');
 
-var applyOptimisticMutation = require('./mutations/applyOptimisticMutation');
-
-var commitLocalUpdate = require('./mutations/commitLocalUpdate');
-
-var commitMutation = require('./mutations/commitMutation');
-
-var createFragmentSpecResolver = require('./store/createFragmentSpecResolver');
+var requestSubscription = require('./subscription/requestSubscription');
 
 var createPayloadFor3DField = require('./util/createPayloadFor3DField');
 
-var createRelayContext = require('./store/createRelayContext');
-
 var deepFreeze = require('./util/deepFreeze');
 
-var fetchQuery = require('./query/fetchQuery');
+var getFragmentIdentifier = require('./util/getFragmentIdentifier');
 
-var fetchQueryInternal = require('./query/fetchQueryInternal');
+var getPaginationMetadata = require('./util/getPaginationMetadata');
 
-var fetchQuery_DEPRECATED = require('./query/fetchQuery_DEPRECATED');
+var getPaginationVariables = require('./util/getPaginationVariables');
 
-var getFragmentIdentifier = require('./util/getFragmentIdentifier');
+var getPendingOperationsForFragment = require('./util/getPendingOperationsForFragment');
+
+var getRefetchMetadata = require('./util/getRefetchMetadata');
 
 var getRelayHandleKey = require('./util/getRelayHandleKey');
 
 var getRequestIdentifier = require('./util/getRequestIdentifier');
 
-var isPromise = require('./util/isPromise');
+var getValueAtPath = require('./util/getValueAtPath');
 
-var isRelayModernEnvironment = require('./store/isRelayModernEnvironment');
+var isPromise = require('./util/isPromise');
 
 var isScalarAndEqual = require('./util/isScalarAndEqual');
 
-var readInlineData = require('./store/readInlineData');
-
 var recycleNodesInto = require('./util/recycleNodesInto');
 
-var reportMissingRequiredFields = require('./util/reportMissingRequiredFields');
+var RelayConcreteNode = require('./util/RelayConcreteNode');
 
-var requestSubscription = require('./subscription/requestSubscription');
+var RelayDefaultHandleKey = require('./util/RelayDefaultHandleKey');
 
-var stableCopy = require('./util/stableCopy');
+var RelayError = require('./util/RelayError');
 
-var _require = require('./store/ClientID'),
-    generateClientID = _require.generateClientID,
-    generateUniqueClientID = _require.generateUniqueClientID,
-    isClientID = _require.isClientID;
+var RelayFeatureFlags = require('./util/RelayFeatureFlags');
+
+var RelayProfiler = require('./util/RelayProfiler');
+
+var RelayReplaySubject = require('./util/RelayReplaySubject');
+
+var reportMissingRequiredFields = require('./util/reportMissingRequiredFields');
+
+var stableCopy = require('./util/stableCopy');
 
 // As early as possible, check for the existence of the JavaScript globals which
 // Relay Runtime relies upon, and produce a clear message if they do not exist.
@@ -214,6 +224,11 @@ module.exports = {
   recycleNodesInto: recycleNodesInto,
   stableCopy: stableCopy,
   getFragmentIdentifier: getFragmentIdentifier,
+  getRefetchMetadata: getRefetchMetadata,
+  getPaginationMetadata: getPaginationMetadata,
+  getPaginationVariables: getPaginationVariables,
+  getPendingOperationsForFragment: getPendingOperationsForFragment,
+  getValueAtPath: getValueAtPath,
   __internal: {
     OperationTracker: RelayOperationTracker,
     createRelayContext: createRelayContext,

package/lib/multi-actor-environment/ActorIdentifier.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.
@@ -13,11 +13,21 @@
  * A unique identifier of the current actor.
  */
 
+var invariant = require('invariant');
+
+var INTERNAL_ACTOR_IDENTIFIER_DO_NOT_USE = 'INTERNAL_ACTOR_IDENTIFIER_DO_NOT_USE';
+
+function assertInternalActorIndentifier(actorIdentifier) {
+  !(actorIdentifier === INTERNAL_ACTOR_IDENTIFIER_DO_NOT_USE) ? process.env.NODE_ENV !== "production" ? invariant(false, 'Expected to use only internal version of the `actorIdentifier`. "%s" was provided.', actorIdentifier) : invariant(false) : void 0;
+}
+
 module.exports = {
+  assertInternalActorIndentifier: assertInternalActorIndentifier,
   getActorIdentifier: function getActorIdentifier(actorID) {
     return actorID;
   },
   getDefaultActorIdentifier: function getDefaultActorIdentifier() {
     throw new Error('Not Implemented');
-  }
+  },
+  INTERNAL_ACTOR_IDENTIFIER_DO_NOT_USE: INTERNAL_ACTOR_IDENTIFIER_DO_NOT_USE
 };

package/lib/multi-actor-environment/ActorSpecificEnvironment.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,52 +10,92 @@
  */
 'use strict';
 
+var wrapNetworkWithLogObserver = require('../network/wrapNetworkWithLogObserver');
+
+var defaultGetDataID = require('../store/defaultGetDataID');
+
 var RelayOperationTracker = require('../store/RelayOperationTracker');
 
-function todo() {
-  throw new Error('Not implementd');
-}
+var RelayPublishQueue = require('../store/RelayPublishQueue');
+
+var registerEnvironmentWithDevTools = require('../util/registerEnvironmentWithDevTools');
 
 var ActorSpecificEnvironment = /*#__PURE__*/function () {
-  // Actor specific properties
   function ActorSpecificEnvironment(config) {
+    var _this = this;
+
+    this.configName = config.configName;
     this.actorIdentifier = config.actorIdentifier;
     this.multiActorEnvironment = config.multiActorEnvironment;
     this.__log = config.logFn;
     this.requiredFieldLogger = config.requiredFieldLogger;
     this._operationTracker = new RelayOperationTracker();
     this._store = config.store;
-    this._network = config.network;
+    this._network = wrapNetworkWithLogObserver(this, config.network);
+    this._publishQueue = new RelayPublishQueue(config.store, config.handlerProvider, defaultGetDataID);
+    this._defaultRenderPolicy = config.defaultRenderPolicy; // TODO:T92305692 Remove `options` in favor of directly using `actorIdentifier` on the environment
+
+    this.options = {
+      actorID: this.actorIdentifier
+    }; // We need to add this here to pass `isRelayModernEnvironment` check
+    // $FlowFixMe[prop-missing]
+
+    this['@@RelayModernEnvironment'] = true;
+
+    if (process.env.NODE_ENV !== "production") {
+      var _require = require('../store/StoreInspector'),
+          inspect = _require.inspect;
+
+      this.DEBUG_inspect = function (dataID) {
+        return inspect(_this, dataID);
+      };
+    } // Register this Relay Environment with Relay DevTools if it exists.
+    // Note: this must always be the last step in the constructor.
+
+
+    registerEnvironmentWithDevTools(this);
   }
 
   var _proto = ActorSpecificEnvironment.prototype;
 
+  _proto.getPublishQueue = function getPublishQueue() {
+    return this._publishQueue;
+  };
+
   _proto.UNSTABLE_getDefaultRenderPolicy = function UNSTABLE_getDefaultRenderPolicy() {
-    return todo();
+    return this._defaultRenderPolicy;
   };
 
   _proto.applyMutation = function applyMutation(optimisticConfig) {
-    return this.multiActorEnvironment.applyMutation(this.actorIdentifier, optimisticConfig);
+    return this.multiActorEnvironment.applyMutation(this, optimisticConfig);
   };
 
   _proto.applyUpdate = function applyUpdate(optimisticUpdate) {
-    return this.multiActorEnvironment.applyUpdate(this.actorIdentifier, optimisticUpdate);
+    return this.multiActorEnvironment.applyUpdate(this, optimisticUpdate);
+  };
+
+  _proto.revertUpdate = function revertUpdate(optimisticUpdate) {
+    return this.multiActorEnvironment.revertUpdate(this, optimisticUpdate);
+  };
+
+  _proto.replaceUpdate = function replaceUpdate(optimisticUpdate, replacementUpdate) {
+    return this.multiActorEnvironment.replaceUpdate(this, optimisticUpdate, replacementUpdate);
   };
 
   _proto.check = function check(operation) {
-    return this.multiActorEnvironment.check(this.actorIdentifier, operation);
+    return this.multiActorEnvironment.check(this, operation);
   };
 
   _proto.subscribe = function subscribe(snapshot, callback) {
-    return this.multiActorEnvironment.subscribe(this.actorIdentifier, snapshot, callback);
+    return this.multiActorEnvironment.subscribe(this, snapshot, callback);
   };
 
   _proto.retain = function retain(operation) {
-    return this.multiActorEnvironment.retain(this.actorIdentifier, operation);
+    return this.multiActorEnvironment.retain(this, operation);
   };
 
   _proto.commitUpdate = function commitUpdate(updater) {
-    return this.multiActorEnvironment.commitUpdate(this.actorIdentifier, updater);
+    return this.multiActorEnvironment.commitUpdate(this, updater);
   }
   /**
    * Commit a payload to the environment using the given operation selector.
@@ -63,7 +103,7 @@ var ActorSpecificEnvironment = /*#__PURE__*/function () {
   ;
 
   _proto.commitPayload = function commitPayload(operationDescriptor, payload) {
-    return this.multiActorEnvironment.commitPayload(this.actorIdentifier, operationDescriptor, payload);
+    return this.multiActorEnvironment.commitPayload(this, operationDescriptor, payload);
   };
 
   _proto.getNetwork = function getNetwork() {
@@ -79,27 +119,31 @@ var ActorSpecificEnvironment = /*#__PURE__*/function () {
   };
 
   _proto.lookup = function lookup(selector) {
-    return this.multiActorEnvironment.lookup(this.actorIdentifier, selector);
+    return this.multiActorEnvironment.lookup(this, selector);
   };
 
   _proto.execute = function execute(config) {
-    return this.multiActorEnvironment.execute(this.actorIdentifier, config);
+    return this.multiActorEnvironment.execute(this, config);
+  };
+
+  _proto.executeSubscription = function executeSubscription(config) {
+    return this.multiActorEnvironment.executeSubscription(this, config);
   };
 
   _proto.executeMutation = function executeMutation(options) {
-    return this.multiActorEnvironment.executeMutation(this.actorIdentifier, options);
+    return this.multiActorEnvironment.executeMutation(this, options);
   };
 
   _proto.executeWithSource = function executeWithSource(options) {
-    return this.multiActorEnvironment.executeWithSource(this.actorIdentifier, options);
+    return this.multiActorEnvironment.executeWithSource(this, options);
   };
 
   _proto.isRequestActive = function isRequestActive(requestIdentifier) {
-    return this.multiActorEnvironment.isRequestActive(this.actorIdentifier, requestIdentifier);
+    return this.multiActorEnvironment.isRequestActive(this, requestIdentifier);
   };
 
   _proto.isServer = function isServer() {
-    return todo();
+    return this.multiActorEnvironment.isServer();
   };
 
   return ActorSpecificEnvironment;

package/lib/multi-actor-environment/ActorUtils.js

@@ -0,0 +1,27 @@
+/**
+ * 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
+ * 
+ * @format
+ */
+'use strict';
+
+var ACTOR_IDENTIFIER_FIELD_NAME = 'actor_key';
+
+var _require = require('./ActorIdentifier'),
+    getActorIdentifier = _require.getActorIdentifier;
+
+function getActorIdentifierFromPayload(payload) {
+  if (payload != null && typeof payload === 'object' && typeof payload[ACTOR_IDENTIFIER_FIELD_NAME] === 'string') {
+    return getActorIdentifier(payload[ACTOR_IDENTIFIER_FIELD_NAME]);
+  }
+}
+
+module.exports = {
+  ACTOR_IDENTIFIER_FIELD_NAME: ACTOR_IDENTIFIER_FIELD_NAME,
+  getActorIdentifierFromPayload: getActorIdentifierFromPayload
+};