relay-runtime 1.3.0 → 1.5.0

package/lib/RelayError.js

@@ -1,10 +1,8 @@
 /**
  * Copyright (c) 2013-present, Facebook, Inc.
- * All rights reserved.
  *
- * This source code is licensed under the BSD-style license found in the
- * LICENSE file in the root directory of this source tree. An additional grant
- * of patent rights can be found in the PATENTS file in the same directory.
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
  *
  * @providesModule RelayError
  * 
@@ -43,9 +41,7 @@ var RelayError = {
  * @private
  */
 function createError(type, name, format, args) {
-  /*eslint-disable fb-www/sprintf-like-args */
   var error = new Error(require('fbjs/lib/sprintf').apply(undefined, [format].concat((0, _toConsumableArray3['default'])(args))));
-  /*eslint-enable fb-www/sprintf-like-args */
   error.name = name;
   error.type = type;
   error.framesToPop = 2;

package/lib/RelayInMemoryRecordSource.js

@@ -1,10 +1,8 @@
 /**
  * Copyright (c) 2013-present, Facebook, Inc.
- * All rights reserved.
  *
- * This source code is licensed under the BSD-style license found in the
- * LICENSE file in the root directory of this source tree. An additional grant
- * of patent rights can be found in the PATENTS file in the same directory.
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
  *
  * @providesModule RelayInMemoryRecordSource
  * 

package/lib/RelayInternalTypes.js

@@ -1,12 +1,9 @@
 /**
  * Copyright (c) 2013-present, Facebook, Inc.
- * All rights reserved.
  *
- * This source code is licensed under the BSD-style license found in the
- * LICENSE file in the root directory of this source tree. An additional grant
- * of patent rights can be found in the PATENTS file in the same directory.
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
  *
- * @providesModule RelayInternalTypes
  * 
  * @format
  */

package/lib/RelayInternals.js

@@ -1,12 +1,9 @@
 /**
  * Copyright (c) 2013-present, Facebook, Inc.
- * All rights reserved.
  *
- * This source code is licensed under the BSD-style license found in the
- * LICENSE file in the root directory of this source tree. An additional grant
- * of patent rights can be found in the PATENTS file in the same directory.
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
  *
- * @providesModule RelayInternals
  * 
  * @format
  */

package/lib/RelayMarkSweepStore.js

@@ -1,10 +1,8 @@
 /**
  * Copyright (c) 2013-present, Facebook, Inc.
- * All rights reserved.
  *
- * This source code is licensed under the BSD-style license found in the
- * LICENSE file in the root directory of this source tree. An additional grant
- * of patent rights can be found in the PATENTS file in the same directory.
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
  *
  * @providesModule RelayMarkSweepStore
  * 
@@ -48,6 +46,7 @@ var RelayMarkSweepStore = function () {
         }
       }
     }
+    this._gcEnabled = true;
     this._hasScheduledGC = false;
     this._index = 0;
     this._recordSource = source;
@@ -108,6 +107,13 @@ var RelayMarkSweepStore = function () {
     return { dispose: dispose };
   };
 
+  // Internal API
+
+
+  RelayMarkSweepStore.prototype.__getUpdatedRecordIDs = function __getUpdatedRecordIDs() {
+    return this._updatedRecordIDs;
+  };
+
   RelayMarkSweepStore.prototype._updateSubscription = function _updateSubscription(subscription) {
     var callback = subscription.callback,
         snapshot = subscription.snapshot;
@@ -137,7 +143,7 @@ var RelayMarkSweepStore = function () {
   RelayMarkSweepStore.prototype._scheduleGC = function _scheduleGC() {
     var _this4 = this;
 
-    if (this._hasScheduledGC) {
+    if (!this._gcEnabled || this._hasScheduledGC) {
       return;
     }
     this._hasScheduledGC = true;
@@ -170,6 +176,17 @@ var RelayMarkSweepStore = function () {
     }
   };
 
+  // Internal hooks to enable/disable garbage collection for experimentation
+
+
+  RelayMarkSweepStore.prototype.__enableGC = function __enableGC() {
+    this._gcEnabled = true;
+  };
+
+  RelayMarkSweepStore.prototype.__disableGC = function __disableGC() {
+    this._gcEnabled = false;
+  };
+
   return RelayMarkSweepStore;
 }();
 

package/lib/RelayMetricsRecorder.js

@@ -1,12 +1,9 @@
 /**
  * Copyright (c) 2013-present, Facebook, Inc.
- * All rights reserved.
  *
- * This source code is licensed under the BSD-style license found in the
- * LICENSE file in the root directory of this source tree. An additional grant
- * of patent rights can be found in the PATENTS file in the same directory.
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
  *
- * @providesModule RelayMetricsRecorder
  * 
  * @format
  */
@@ -19,6 +16,9 @@ var _classCallCheck3 = _interopRequireDefault(require('babel-runtime/helpers/cla
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { 'default': obj }; }
 
+var _require = require('relay-runtime'),
+    RelayProfiler = _require.RelayProfiler;
+
 var measurementDefaults = {
   aggregateTime: 0,
   callCount: 0
@@ -73,8 +73,8 @@ var RelayMetricsRecorder = function () {
     this._profileStack = [0];
     this._startTimesStack = [0];
 
-    require('./RelayProfiler').attachAggregateHandler('*', this._measure);
-    require('./RelayProfiler').attachProfileHandler('*', this._instrumentProfile);
+    RelayProfiler.attachAggregateHandler('*', this._measure);
+    RelayProfiler.attachProfileHandler('*', this._instrumentProfile);
   };
 
   RelayMetricsRecorder.prototype.stop = function stop() {
@@ -84,8 +84,8 @@ var RelayMetricsRecorder = function () {
     this._recordingTotalTime += require('fbjs/lib/performanceNow')() - this._recordingStartTime;
     this._isEnabled = false;
 
-    require('./RelayProfiler').detachAggregateHandler('*', this._measure);
-    require('./RelayProfiler').detachProfileHandler('*', this._instrumentProfile);
+    RelayProfiler.detachAggregateHandler('*', this._measure);
+    RelayProfiler.detachProfileHandler('*', this._instrumentProfile);
   };
 
   RelayMetricsRecorder.prototype.getMetrics = function getMetrics() {

package/lib/RelayMockRenderer.js

@@ -1,12 +1,9 @@
 /**
  * Copyright (c) 2013-present, Facebook, Inc.
- * All rights reserved.
  *
- * This source code is licensed under the BSD-style license found in the
- * LICENSE file in the root directory of this source tree. An additional grant
- * of patent rights can be found in the PATENTS file in the same directory.
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
  *
- * @providesModule RelayMockRenderer
  * 
  * @format
  */
@@ -29,9 +26,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { 'd
  * Note: For unit tests, you may need to mock `ReactDOM` as follows:
  *
  * ```
- * jest
- *   .disableAutomock()
- *   .mock('ReactDOM', () => ({}));
+ * jest.mock('ReactDOM', () => ({}));
  * ```
  *
  * Currently ReactDOM and ReactTestRenderer cannot both be loaded in the same

package/lib/RelayModernEnvironment.js

@@ -1,10 +1,8 @@
 /**
  * Copyright (c) 2013-present, Facebook, Inc.
- * All rights reserved.
  *
- * This source code is licensed under the BSD-style license found in the
- * LICENSE file in the root directory of this source tree. An additional grant
- * of patent rights can be found in the PATENTS file in the same directory.
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
  *
  * @providesModule RelayModernEnvironment
  * 
@@ -17,11 +15,15 @@ var _classCallCheck3 = _interopRequireDefault(require('babel-runtime/helpers/cla
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { 'default': obj }; }
 
+var _require = require('./RelayModernOperationSelector'),
+    createOperationSelector = _require.createOperationSelector;
+
 var RelayModernEnvironment = function () {
   function RelayModernEnvironment(config) {
     var _this = this;
 
     (0, _classCallCheck3['default'])(this, RelayModernEnvironment);
+    this._deferrableSelections = new Set();
 
     this.configName = config.configName;
     var handlerProvider = config.handlerProvider ? config.handlerProvider : require('./RelayDefaultHandlerProvider');
@@ -34,27 +36,12 @@ var RelayModernEnvironment = function () {
       return _this._network = newNet;
     };
 
-    if (process.env.NODE_ENV !== 'production') {
-      var g = typeof global !== 'undefined' ? global : window;
-
-      // Attach the debugger symbol to the global symbol so it can be accessed by
-      // devtools extension.
-      if (!g.__RELAY_DEBUGGER__) {
-        var _require = require('./RelayDebugger'),
-            RelayDebugger = _require.RelayDebugger;
-
-        g.__RELAY_DEBUGGER__ = new RelayDebugger();
-      }
-
-      // Setup the runtime part for Native
-      if (typeof g.registerDevtoolsPlugin === 'function') {
-        g.registerDevtoolsPlugin(require('relay-debugger-react-native-runtime'));
-      }
-
-      var envId = g.__RELAY_DEBUGGER__.registerEnvironment(this);
-      this._debugger = g.__RELAY_DEBUGGER__.getEnvironmentDebugger(envId);
-    } else {
-      this._debugger = null;
+    // Register this Relay Environment with Relay DevTools if it exists.
+    // Note: this must always be the last step in the constructor.
+    var _global = typeof global !== 'undefined' ? global : typeof window !== 'undefined' ? window : undefined;
+    var devToolsHook = _global && _global.__RELAY_DEVTOOLS_HOOK__;
+    if (devToolsHook) {
+      devToolsHook.registerEnvironment(this);
     }
   }
 
@@ -62,8 +49,8 @@ var RelayModernEnvironment = function () {
     return this._store;
   };
 
-  RelayModernEnvironment.prototype.getDebugger = function getDebugger() {
-    return this._debugger;
+  RelayModernEnvironment.prototype.getNetwork = function getNetwork() {
+    return this._network;
   };
 
   RelayModernEnvironment.prototype.applyUpdate = function applyUpdate(optimisticUpdate) {
@@ -129,47 +116,103 @@ var RelayModernEnvironment = function () {
     return this._store.retain(selector);
   };
 
+  RelayModernEnvironment.prototype.isSelectorLoading = function isSelectorLoading(selector) {
+    var key = require('./deferrableFragmentKey')(selector.dataID, selector.node.name, selector.variables);
+    return this._deferrableSelections.has(key);
+  };
   /**
-   * Returns an Observable of RelayResponsePayload resulting from the provided
-   * Query or Subscription operation, each of which are normalized and committed
-   * to the publish queue.
+   * Returns an Observable of ExecutePayload resulting from executing the
+   * provided Query or Subscription operation, each result of which is then
+   * normalized and committed to the publish queue.
    *
    * Note: Observables are lazy, so calling this method will do nothing until
-   * the result is subscribed to: environment.observe({...}).subscribe({...}).
+   * the result is subscribed to: environment.execute({...}).subscribe({...}).
    */
 
 
-  RelayModernEnvironment.prototype.observe = function observe(_ref2) {
+  RelayModernEnvironment.prototype.execute = function execute(_ref2) {
     var _this3 = this;
 
     var operation = _ref2.operation,
         cacheConfig = _ref2.cacheConfig,
         updater = _ref2.updater;
-    var node = operation.node,
-        variables = operation.variables;
 
-    return this._network.observe(node, variables, cacheConfig || {}).map(function (payload) {
-      return require('./normalizePayload')(node, variables, payload);
-    })['do']({
-      next: function next(payload) {
-        _this3._publishQueue.commitPayload(operation, payload, updater);
+    var optimisticResponse = void 0;
+    return this._network.execute(operation.node, operation.variables, cacheConfig || {})['do']({
+      next: function next(executePayload) {
+        var responsePayload = require('./normalizePayload')(executePayload);
+        var source = responsePayload.source,
+            fieldPayloads = responsePayload.fieldPayloads,
+            deferrableSelections = responsePayload.deferrableSelections;
+        var _iteratorNormalCompletion = true;
+        var _didIteratorError = false;
+        var _iteratorError = undefined;
+
+        try {
+          for (var _iterator = (deferrableSelections || new Set())[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
+            var selectionKey = _step.value;
+
+            _this3._deferrableSelections.add(selectionKey);
+          }
+        } catch (err) {
+          _didIteratorError = true;
+          _iteratorError = err;
+        } finally {
+          try {
+            if (!_iteratorNormalCompletion && _iterator['return']) {
+              _iterator['return']();
+            }
+          } finally {
+            if (_didIteratorError) {
+              throw _iteratorError;
+            }
+          }
+        }
+
+        if (executePayload.isOptimistic) {
+          require('fbjs/lib/invariant')(optimisticResponse == null, 'environment.execute: only support one optimistic respnose per ' + 'execute.');
+          optimisticResponse = {
+            source: source,
+            fieldPayloads: fieldPayloads
+          };
+          _this3._publishQueue.applyUpdate(optimisticResponse);
+          _this3._publishQueue.run();
+        } else {
+          if (optimisticResponse) {
+            _this3._publishQueue.revertUpdate(optimisticResponse);
+            optimisticResponse = undefined;
+          }
+          var writeSelector = createOperationSelector(operation.node, executePayload.variables, executePayload.operation);
+          if (executePayload.operation.kind === 'DeferrableOperation') {
+            var fragmentKey = require('./deferrableFragmentKey')(executePayload.variables[executePayload.operation.rootFieldVariable], executePayload.operation.fragmentName, executePayload.variables);
+            _this3._deferrableSelections['delete'](fragmentKey);
+          }
+          _this3._publishQueue.commitPayload(writeSelector, responsePayload, updater);
+          _this3._publishQueue.run();
+        }
+      }
+    })['finally'](function () {
+      if (optimisticResponse) {
+        _this3._publishQueue.revertUpdate(optimisticResponse);
+        optimisticResponse = undefined;
         _this3._publishQueue.run();
       }
     });
   };
 
   /**
-   * Returns an Observable of RelayResponsePayload resulting from the provided
-   * Mutation operation, which are normalized and committed to the publish queue
-   * along with an optional optimistic response or updater.
+   * Returns an Observable of ExecutePayload resulting from executing the
+   * provided Mutation operation, the result of which is then normalized and
+   * committed to the publish queue along with an optional optimistic response
+   * or updater.
    *
    * Note: Observables are lazy, so calling this method will do nothing until
    * the result is subscribed to:
-   * environment.observeMutation({...}).subscribe({...}).
+   * environment.executeMutation({...}).subscribe({...}).
    */
 
 
-  RelayModernEnvironment.prototype.observeMutation = function observeMutation(_ref3) {
+  RelayModernEnvironment.prototype.executeMutation = function executeMutation(_ref3) {
     var _this4 = this;
 
     var operation = _ref3.operation,
@@ -177,10 +220,6 @@ var RelayModernEnvironment = function () {
         optimisticUpdater = _ref3.optimisticUpdater,
         updater = _ref3.updater,
         uploadables = _ref3.uploadables;
-    var node = operation.node,
-        variables = operation.variables;
-
-    var mutationUid = nextMutationUid();
 
     var optimisticUpdate = void 0;
     if (optimisticResponse || optimisticUpdater) {
@@ -191,39 +230,20 @@ var RelayModernEnvironment = function () {
       };
     }
 
-    return this._network.observe(node, variables, { force: true }, uploadables).map(function (payload) {
-      return require('./normalizePayload')(node, variables, payload);
-    })['do']({
+    return this._network.execute(operation.node, operation.variables, { force: true }, uploadables)['do']({
       start: function start() {
         if (optimisticUpdate) {
-          _this4._recordDebuggerEvent({
-            eventName: 'optimistic_update',
-            mutationUid: mutationUid,
-            operation: operation,
-            fn: function fn() {
-              if (optimisticUpdate) {
-                _this4._publishQueue.applyUpdate(optimisticUpdate);
-              }
-              _this4._publishQueue.run();
-            }
-          });
+          _this4._publishQueue.applyUpdate(optimisticUpdate);
+          _this4._publishQueue.run();
         }
       },
       next: function next(payload) {
-        _this4._recordDebuggerEvent({
-          eventName: 'request_commit',
-          mutationUid: mutationUid,
-          operation: operation,
-          payload: payload,
-          fn: function fn() {
-            if (optimisticUpdate) {
-              _this4._publishQueue.revertUpdate(optimisticUpdate);
-              optimisticUpdate = undefined;
-            }
-            _this4._publishQueue.commitPayload(operation, payload, updater);
-            _this4._publishQueue.run();
-          }
-        });
+        if (optimisticUpdate) {
+          _this4._publishQueue.revertUpdate(optimisticUpdate);
+          optimisticUpdate = undefined;
+        }
+        _this4._publishQueue.commitPayload(operation, require('./normalizePayload')(payload), updater);
+        _this4._publishQueue.run();
       },
       error: function (_error) {
         function error(_x) {
@@ -236,39 +256,24 @@ var RelayModernEnvironment = function () {
 
         return error;
       }(function (error) {
-        _this4._recordDebuggerEvent({
-          eventName: 'request_error',
-          mutationUid: mutationUid,
-          operation: operation,
-          payload: error,
-          fn: function fn() {
-            if (optimisticUpdate) {
-              _this4._publishQueue.revertUpdate(optimisticUpdate);
-            }
-            _this4._publishQueue.run();
-          }
-        });
+        if (optimisticUpdate) {
+          _this4._publishQueue.revertUpdate(optimisticUpdate);
+          optimisticUpdate = undefined;
+          _this4._publishQueue.run();
+        }
       }),
       unsubscribe: function unsubscribe() {
         if (optimisticUpdate) {
-          _this4._recordDebuggerEvent({
-            eventName: 'optimistic_revert',
-            mutationUid: mutationUid,
-            operation: operation,
-            fn: function fn() {
-              if (optimisticUpdate) {
-                _this4._publishQueue.revertUpdate(optimisticUpdate);
-              }
-              _this4._publishQueue.run();
-            }
-          });
+          _this4._publishQueue.revertUpdate(optimisticUpdate);
+          optimisticUpdate = undefined;
+          _this4._publishQueue.run();
         }
       }
     });
   };
 
   /**
-   * @deprecated Use Environment.observe().subscribe()
+   * @deprecated Use Environment.execute().subscribe()
    */
 
 
@@ -279,7 +284,8 @@ var RelayModernEnvironment = function () {
         onNext = _ref4.onNext,
         operation = _ref4.operation;
 
-    return this.observe({ operation: operation, cacheConfig: cacheConfig }).subscribeLegacy({
+    require('fbjs/lib/warning')(false, 'environment.sendQuery() is deprecated. Update to the latest ' + 'version of react-relay, and use environment.execute().');
+    return this.execute({ operation: operation, cacheConfig: cacheConfig }).subscribeLegacy({
       onNext: onNext,
       onError: onError,
       onCompleted: onCompleted
@@ -287,7 +293,7 @@ var RelayModernEnvironment = function () {
   };
 
   /**
-   * @deprecated Use Environment.observe().subscribe()
+   * @deprecated Use Environment.execute().subscribe()
    */
 
 
@@ -298,7 +304,8 @@ var RelayModernEnvironment = function () {
         onNext = _ref5.onNext,
         operation = _ref5.operation;
 
-    return this.observe({ operation: operation, cacheConfig: cacheConfig }).subscribeLegacy({
+    require('fbjs/lib/warning')(false, 'environment.streamQuery() is deprecated. Update to the latest ' + 'version of react-relay, and use environment.execute().');
+    return this.execute({ operation: operation, cacheConfig: cacheConfig }).subscribeLegacy({
       onNext: onNext,
       onError: onError,
       onCompleted: onCompleted
@@ -306,7 +313,7 @@ var RelayModernEnvironment = function () {
   };
 
   /**
-   * @deprecated Use Environment.observeMutation().subscribe()
+   * @deprecated Use Environment.executeMutation().subscribe()
    */
 
 
@@ -319,7 +326,8 @@ var RelayModernEnvironment = function () {
         updater = _ref6.updater,
         uploadables = _ref6.uploadables;
 
-    return this.observeMutation({
+    require('fbjs/lib/warning')(false, 'environment.sendMutation() is deprecated. Update to the latest ' + 'version of react-relay, and use environment.executeMutation().');
+    return this.executeMutation({
       operation: operation,
       optimisticResponse: optimisticResponse,
       optimisticUpdater: optimisticUpdater,
@@ -327,10 +335,10 @@ var RelayModernEnvironment = function () {
       uploadables: uploadables
     }).subscribeLegacy({
       // NOTE: sendMutation has a non-standard use of onCompleted() by passing
-      // it a value. When switching to use observeMutation(), the next()
+      // it a value. When switching to use executeMutation(), the next()
       // Observer should be used to preserve behavior.
       onNext: function onNext(payload) {
-        payload.errors && onCompleted && onCompleted(payload.errors);
+        onCompleted && onCompleted(payload.response.errors);
       },
       onError: onError,
       onCompleted: onCompleted
@@ -338,7 +346,7 @@ var RelayModernEnvironment = function () {
   };
 
   /**
-   * @deprecated Use Environment.observe().subscribe()
+   * @deprecated Use Environment.execute().subscribe()
    */
 
 
@@ -349,33 +357,14 @@ var RelayModernEnvironment = function () {
         operation = _ref7.operation,
         updater = _ref7.updater;
 
-    return this.observe({
+    require('fbjs/lib/warning')(false, 'environment.sendSubscription() is deprecated. Update to the latest ' + 'version of react-relay, and use environment.execute().');
+    return this.execute({
       operation: operation,
       updater: updater,
       cacheConfig: { force: true }
     }).subscribeLegacy({ onNext: onNext, onError: onError, onCompleted: onCompleted });
   };
 
-  RelayModernEnvironment.prototype._recordDebuggerEvent = function _recordDebuggerEvent(_ref8) {
-    var eventName = _ref8.eventName,
-        mutationUid = _ref8.mutationUid,
-        operation = _ref8.operation,
-        payload = _ref8.payload,
-        fn = _ref8.fn;
-
-    if (this._debugger) {
-      this._debugger.recordMutationEvent({
-        eventName: eventName,
-        payload: payload,
-        fn: fn,
-        mutation: operation,
-        seriesId: mutationUid
-      });
-    } else {
-      fn();
-    }
-  };
-
   RelayModernEnvironment.prototype.checkSelectorAndUpdateStore = function checkSelectorAndUpdateStore(selector, handlers) {
     var target = new (require('./RelayInMemoryRecordSource'))();
     var result = require('./RelayDataLoader').check(this._store.getSource(), target, selector, handlers);
@@ -389,15 +378,11 @@ var RelayModernEnvironment = function () {
   return RelayModernEnvironment;
 }();
 
-var mutationUidCounter = 0;
-var mutationUidPrefix = Math.random().toString();
-function nextMutationUid() {
-  return mutationUidPrefix + mutationUidCounter++;
-}
-
 // Add a sigil for detection by `isRelayModernEnvironment()` to avoid a
 // realm-specific instanceof check, and to aid in module tree-shaking to
 // avoid requiring all of RelayRuntime just to detect its environment.
+
+
 RelayModernEnvironment.prototype['@@RelayModernEnvironment'] = true;
 
 module.exports = RelayModernEnvironment;