relay-runtime 1.7.0-rc.1 → 2.0.0

package/lib/RelayDataLoader.js

@@ -1,302 +0,0 @@
-/**
- * Copyright (c) 2013-present, Facebook, Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- *
- *  strict-local
- * @format
- */
-
-'use strict';
-
-var _classCallCheck3 = _interopRequireDefault(require('babel-runtime/helpers/classCallCheck'));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { 'default': obj }; }
-
-/**
- * Synchronously check whether the records required to fulfill the
- * given `selector` are present in `source`.
- *
- * If a field is missing, it uses the provided handlers to attempt to substitute
- * data. The `target` will store all records that are modified because of a
- * successful substitution.
- *
- * If all records are present, returns `true`, otherwise `false`.
- */
-function check(source, target, selector, handlers) {
-  var dataID = selector.dataID,
-      node = selector.node,
-      variables = selector.variables;
-
-  var loader = new RelayDataLoader(source, target, variables, handlers);
-  return loader.check(node, dataID);
-}
-
-/**
- * @private
- */
-
-var RelayDataLoader = function () {
-  function RelayDataLoader(source, target, variables, handlers) {
-    (0, _classCallCheck3['default'])(this, RelayDataLoader);
-
-    this._source = source;
-    this._variables = variables;
-    this._recordWasMissing = false;
-    this._handlers = handlers;
-    this._mutator = new (require('./RelayRecordSourceMutator'))(source, target);
-  }
-
-  RelayDataLoader.prototype.check = function check(node, dataID) {
-    this._traverse(node, dataID);
-    return !this._recordWasMissing;
-  };
-
-  RelayDataLoader.prototype._getVariableValue = function _getVariableValue(name) {
-    !this._variables.hasOwnProperty(name) ? process.env.NODE_ENV !== 'production' ? require('fbjs/lib/invariant')(false, 'RelayAsyncLoader(): Undefined variable `%s`.', name) : require('fbjs/lib/invariant')(false) : void 0;
-    return this._variables[name];
-  };
-
-  RelayDataLoader.prototype._handleMissing = function _handleMissing() {
-    this._recordWasMissing = true;
-  };
-
-  RelayDataLoader.prototype._getDataForHandlers = function _getDataForHandlers(field, dataID) {
-    return {
-      args: field.args ? require('./RelayStoreUtils').getArgumentValues(field.args, this._variables) : {},
-      // Getting a snapshot of the record state is potentially expensive since
-      // we will need to merge the sink and source records. Since we do not create
-      // any new records in this process, it is probably reasonable to provide
-      // handlers with a copy of the source record.
-      // The only thing that the provided record will not contain is fields
-      // added by previous handlers.
-      record: this._source.get(dataID)
-    };
-  };
-
-  RelayDataLoader.prototype._handleMissingScalarField = function _handleMissingScalarField(field, dataID) {
-    var _getDataForHandlers2 = this._getDataForHandlers(field, dataID),
-        args = _getDataForHandlers2.args,
-        record = _getDataForHandlers2.record;
-
-    var _iteratorNormalCompletion = true;
-    var _didIteratorError = false;
-    var _iteratorError = undefined;
-
-    try {
-      for (var _iterator = this._handlers[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true) {
-        var handler = _step.value;
-
-        if (handler.kind === 'scalar') {
-          var newValue = handler.handle(field, record, args);
-          if (newValue !== undefined) {
-            return newValue;
-          }
-        }
-      }
-    } catch (err) {
-      _didIteratorError = true;
-      _iteratorError = err;
-    } finally {
-      try {
-        if (!_iteratorNormalCompletion && _iterator['return']) {
-          _iterator['return']();
-        }
-      } finally {
-        if (_didIteratorError) {
-          throw _iteratorError;
-        }
-      }
-    }
-
-    this._handleMissing();
-  };
-
-  RelayDataLoader.prototype._handleMissingLinkField = function _handleMissingLinkField(field, dataID) {
-    var _getDataForHandlers3 = this._getDataForHandlers(field, dataID),
-        args = _getDataForHandlers3.args,
-        record = _getDataForHandlers3.record;
-
-    var _iteratorNormalCompletion2 = true;
-    var _didIteratorError2 = false;
-    var _iteratorError2 = undefined;
-
-    try {
-      for (var _iterator2 = this._handlers[Symbol.iterator](), _step2; !(_iteratorNormalCompletion2 = (_step2 = _iterator2.next()).done); _iteratorNormalCompletion2 = true) {
-        var handler = _step2.value;
-
-        if (handler.kind === 'linked') {
-          var newValue = handler.handle(field, record, args);
-          if (newValue != null && this._mutator.getStatus(newValue) === require('./RelayRecordState').EXISTENT) {
-            return newValue;
-          }
-        }
-      }
-    } catch (err) {
-      _didIteratorError2 = true;
-      _iteratorError2 = err;
-    } finally {
-      try {
-        if (!_iteratorNormalCompletion2 && _iterator2['return']) {
-          _iterator2['return']();
-        }
-      } finally {
-        if (_didIteratorError2) {
-          throw _iteratorError2;
-        }
-      }
-    }
-
-    this._handleMissing();
-  };
-
-  RelayDataLoader.prototype._handleMissingPluralLinkField = function _handleMissingPluralLinkField(field, dataID) {
-    var _this = this;
-
-    var _getDataForHandlers4 = this._getDataForHandlers(field, dataID),
-        args = _getDataForHandlers4.args,
-        record = _getDataForHandlers4.record;
-
-    var _iteratorNormalCompletion3 = true;
-    var _didIteratorError3 = false;
-    var _iteratorError3 = undefined;
-
-    try {
-      for (var _iterator3 = this._handlers[Symbol.iterator](), _step3; !(_iteratorNormalCompletion3 = (_step3 = _iterator3.next()).done); _iteratorNormalCompletion3 = true) {
-        var handler = _step3.value;
-
-        if (handler.kind === 'pluralLinked') {
-          var newValue = handler.handle(field, record, args);
-          if (newValue != null) {
-            return newValue.filter(function (linkedID) {
-              return linkedID != null && _this._mutator.getStatus(linkedID) === require('./RelayRecordState').EXISTENT;
-            });
-          }
-        }
-      }
-    } catch (err) {
-      _didIteratorError3 = true;
-      _iteratorError3 = err;
-    } finally {
-      try {
-        if (!_iteratorNormalCompletion3 && _iterator3['return']) {
-          _iterator3['return']();
-        }
-      } finally {
-        if (_didIteratorError3) {
-          throw _iteratorError3;
-        }
-      }
-    }
-
-    this._handleMissing();
-  };
-
-  RelayDataLoader.prototype._traverse = function _traverse(node, dataID) {
-    var status = this._mutator.getStatus(dataID);
-    if (status === require('./RelayRecordState').UNKNOWN) {
-      this._handleMissing();
-    }
-    if (status === require('./RelayRecordState').EXISTENT) {
-      this._traverseSelections(node.selections, dataID);
-    }
-  };
-
-  RelayDataLoader.prototype._traverseSelections = function _traverseSelections(selections, dataID) {
-    var _this2 = this;
-
-    selections.every(function (selection) {
-      switch (selection.kind) {
-        case require('./RelayConcreteNode').SCALAR_FIELD:
-          _this2._prepareScalar(selection, dataID);
-          break;
-        case require('./RelayConcreteNode').LINKED_FIELD:
-          if (selection.plural) {
-            _this2._preparePluralLink(selection, dataID);
-          } else {
-            _this2._prepareLink(selection, dataID);
-          }
-          break;
-        case require('./RelayConcreteNode').CONDITION:
-          var conditionValue = _this2._getVariableValue(selection.condition);
-          if (conditionValue === selection.passingValue) {
-            _this2._traverseSelections(selection.selections, dataID);
-          }
-          break;
-        case require('./RelayConcreteNode').INLINE_FRAGMENT:
-          var typeName = _this2._mutator.getType(dataID);
-          if (typeName != null && typeName === selection.type) {
-            _this2._traverseSelections(selection.selections, dataID);
-          }
-          break;
-        case require('./RelayConcreteNode').LINKED_HANDLE:
-          // Handles have no selections themselves; traverse the original field
-          // where the handle was set-up instead.
-          var handleField = require('./cloneRelayHandleSourceField')(selection, selections, _this2._variables);
-          if (handleField.plural) {
-            _this2._preparePluralLink(handleField, dataID);
-          } else {
-            _this2._prepareLink(handleField, dataID);
-          }
-          break;
-        default:
-          !(selection.kind === require('./RelayConcreteNode').SCALAR_FIELD) ? process.env.NODE_ENV !== 'production' ? require('fbjs/lib/invariant')(false, 'RelayAsyncLoader(): Unexpected ast kind `%s`.', selection.kind) : require('fbjs/lib/invariant')(false) : void 0;
-      }
-      return !_this2._done;
-    });
-  };
-
-  RelayDataLoader.prototype._prepareScalar = function _prepareScalar(field, dataID) {
-    var storageKey = require('./RelayStoreUtils').getStorageKey(field, this._variables);
-    var fieldValue = this._mutator.getValue(dataID, storageKey);
-    if (fieldValue === undefined) {
-      fieldValue = this._handleMissingScalarField(field, dataID);
-      if (fieldValue !== undefined) {
-        this._mutator.setValue(dataID, storageKey, fieldValue);
-      }
-    }
-  };
-
-  RelayDataLoader.prototype._prepareLink = function _prepareLink(field, dataID) {
-    var storageKey = require('./RelayStoreUtils').getStorageKey(field, this._variables);
-    var linkedID = this._mutator.getLinkedRecordID(dataID, storageKey);
-
-    if (linkedID === undefined) {
-      linkedID = this._handleMissingLinkField(field, dataID);
-      if (linkedID != null) {
-        this._mutator.setLinkedRecordID(dataID, storageKey, linkedID);
-      }
-    }
-    if (linkedID != null) {
-      this._traverse(field, linkedID);
-    }
-  };
-
-  RelayDataLoader.prototype._preparePluralLink = function _preparePluralLink(field, dataID) {
-    var _this3 = this;
-
-    var storageKey = require('./RelayStoreUtils').getStorageKey(field, this._variables);
-    var linkedIDs = this._mutator.getLinkedRecordIDs(dataID, storageKey);
-
-    if (linkedIDs === undefined) {
-      linkedIDs = this._handleMissingPluralLinkField(field, dataID);
-      if (linkedIDs != null) {
-        this._mutator.setLinkedRecordIDs(dataID, storageKey, linkedIDs);
-      }
-    }
-    if (linkedIDs) {
-      linkedIDs.forEach(function (linkedID) {
-        if (linkedID != null) {
-          _this3._traverse(field, linkedID);
-        }
-      });
-    }
-  };
-
-  return RelayDataLoader;
-}();
-
-module.exports = {
-  check: check
-};

package/lib/RelayMarkSweepStore.js

@@ -1,242 +0,0 @@
-/**
- * Copyright (c) 2013-present, Facebook, Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- *
- *  strict-local
- * @format
- */
-
-'use strict';
-
-var _extends3 = _interopRequireDefault(require('babel-runtime/helpers/extends'));
-
-var _classCallCheck3 = _interopRequireDefault(require('babel-runtime/helpers/classCallCheck'));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { 'default': obj }; }
-
-/**
- * @public
- *
- * An implementation of the `Store` interface defined in `RelayStoreTypes`.
- *
- * Note that a Store takes ownership of all records provided to it: other
- * objects may continue to hold a reference to such records but may not mutate
- * them. The static Relay core is architected to avoid mutating records that may have been
- * passed to a store: operations that mutate records will either create fresh
- * records or clone existing records and modify the clones. Record immutability
- * is also enforced in development mode by freezing all records passed to a store.
- */
-var RelayMarkSweepStore = function () {
-  function RelayMarkSweepStore(source) {
-    (0, _classCallCheck3['default'])(this, RelayMarkSweepStore);
-
-    // Prevent mutation of a record from outside the store.
-    if (process.env.NODE_ENV !== 'production') {
-      var storeIDs = source.getRecordIDs();
-      for (var ii = 0; ii < storeIDs.length; ii++) {
-        var record = source.get(storeIDs[ii]);
-        if (record) {
-          require('./RelayModernRecord').freeze(record);
-        }
-      }
-    }
-    this._gcEnabled = true;
-    this._hasScheduledGC = false;
-    this._index = 0;
-    this._recordSource = source;
-    this._roots = new Map();
-    this._subscriptions = new Set();
-    this._updatedRecordIDs = {};
-  }
-
-  RelayMarkSweepStore.prototype.getSource = function getSource() {
-    return this._recordSource;
-  };
-
-  RelayMarkSweepStore.prototype.check = function check(selector) {
-    return require('./RelayDataLoader').check(this._recordSource, this._recordSource, selector, []);
-  };
-
-  RelayMarkSweepStore.prototype.retain = function retain(selector) {
-    var _this = this;
-
-    var index = this._index++;
-    var dispose = function dispose() {
-      _this._roots['delete'](index);
-      _this._scheduleGC();
-    };
-    this._roots.set(index, selector);
-    return { dispose: dispose };
-  };
-
-  RelayMarkSweepStore.prototype.lookup = function lookup(selector) {
-    var snapshot = require('./RelayReader').read(this._recordSource, selector);
-    if (process.env.NODE_ENV !== 'production') {
-      require('./deepFreeze')(snapshot);
-    }
-    return snapshot;
-  };
-
-  RelayMarkSweepStore.prototype.notify = function notify() {
-    var _this2 = this;
-
-    this._subscriptions.forEach(function (subscription) {
-      _this2._updateSubscription(subscription);
-    });
-    this._updatedRecordIDs = {};
-  };
-
-  RelayMarkSweepStore.prototype.publish = function publish(source) {
-    updateTargetFromSource(this._recordSource, source, this._updatedRecordIDs);
-  };
-
-  RelayMarkSweepStore.prototype.subscribe = function subscribe(snapshot, callback) {
-    var _this3 = this;
-
-    var subscription = { callback: callback, snapshot: snapshot };
-    var dispose = function dispose() {
-      _this3._subscriptions['delete'](subscription);
-    };
-    this._subscriptions.add(subscription);
-    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;
-
-    if (!require('./hasOverlappingIDs')(snapshot, this._updatedRecordIDs)) {
-      return;
-    }
-
-    var _RelayReader$read = require('./RelayReader').read(this._recordSource, snapshot),
-        data = _RelayReader$read.data,
-        seenRecords = _RelayReader$read.seenRecords;
-
-    var nextData = require('./recycleNodesInto')(snapshot.data, data);
-    var nextSnapshot = (0, _extends3['default'])({}, snapshot, {
-      data: nextData,
-      seenRecords: seenRecords
-    });
-    if (process.env.NODE_ENV !== 'production') {
-      require('./deepFreeze')(nextSnapshot);
-    }
-    subscription.snapshot = nextSnapshot;
-    if (nextSnapshot.data !== snapshot.data) {
-      callback(nextSnapshot);
-    }
-  };
-
-  RelayMarkSweepStore.prototype._scheduleGC = function _scheduleGC() {
-    var _this4 = this;
-
-    if (!this._gcEnabled || this._hasScheduledGC) {
-      return;
-    }
-    this._hasScheduledGC = true;
-    require('fbjs/lib/resolveImmediate')(function () {
-      _this4.__gc();
-      _this4._hasScheduledGC = false;
-    });
-  };
-
-  RelayMarkSweepStore.prototype.__gc = function __gc() {
-    var _this5 = this;
-
-    var references = new Set();
-    // Mark all records that are traversable from a root
-    this._roots.forEach(function (selector) {
-      require('./RelayReferenceMarker').mark(_this5._recordSource, selector, references);
-    });
-    // Short-circuit if *nothing* is referenced
-    if (!references.size) {
-      this._recordSource.clear();
-      return;
-    }
-    // Evict any unreferenced nodes
-    var storeIDs = this._recordSource.getRecordIDs();
-    for (var ii = 0; ii < storeIDs.length; ii++) {
-      var dataID = storeIDs[ii];
-      if (!references.has(dataID)) {
-        this._recordSource.remove(dataID);
-      }
-    }
-  };
-
-  // 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;
-}();
-
-/**
- * Updates the target with information from source, also updating a mapping of
- * which records in the target were changed as a result.
- */
-
-
-function updateTargetFromSource(target, source, updatedRecordIDs) {
-  var dataIDs = source.getRecordIDs();
-  for (var ii = 0; ii < dataIDs.length; ii++) {
-    var dataID = dataIDs[ii];
-    var sourceRecord = source.get(dataID);
-    var targetRecord = target.get(dataID);
-    // Prevent mutation of a record from outside the store.
-    if (process.env.NODE_ENV !== 'production') {
-      if (sourceRecord) {
-        require('./RelayModernRecord').freeze(sourceRecord);
-      }
-    }
-    if (sourceRecord === require('./RelayStoreUtils').UNPUBLISH_RECORD_SENTINEL) {
-      // Unpublish a record
-      target.remove(dataID);
-      updatedRecordIDs[dataID] = true;
-    } else if (sourceRecord && targetRecord) {
-      var nextRecord = require('./RelayModernRecord').update(targetRecord, sourceRecord);
-      if (nextRecord !== targetRecord) {
-        // Prevent mutation of a record from outside the store.
-        if (process.env.NODE_ENV !== 'production') {
-          require('./RelayModernRecord').freeze(nextRecord);
-        }
-        updatedRecordIDs[dataID] = true;
-        target.set(dataID, nextRecord);
-      }
-    } else if (sourceRecord === null) {
-      target['delete'](dataID);
-      if (targetRecord !== null) {
-        updatedRecordIDs[dataID] = true;
-      }
-    } else if (sourceRecord) {
-      target.set(dataID, sourceRecord);
-      updatedRecordIDs[dataID] = true;
-    } // don't add explicit undefined
-  }
-}
-
-require('./RelayProfiler').instrumentMethods(RelayMarkSweepStore.prototype, {
-  lookup: 'RelayMarkSweepStore.prototype.lookup',
-  notify: 'RelayMarkSweepStore.prototype.notify',
-  publish: 'RelayMarkSweepStore.prototype.publish',
-  retain: 'RelayMarkSweepStore.prototype.retain',
-  subscribe: 'RelayMarkSweepStore.prototype.subscribe',
-  __gc: 'RelayMarkSweepStore.prototype.__gc'
-});
-
-module.exports = RelayMarkSweepStore;

package/lib/deferrableFragmentKey.js

@@ -1,20 +0,0 @@
-/**
- * Copyright (c) 2013-present, Facebook, Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- *
- *  strict
- * @format
- */
-
-'use strict';
-
-function deferrableFragmentKey(dataID, fragmentName, variables) {
-  var variablesString = Object.keys(variables).reduce(function (acc, key) {
-    return '' + acc + (acc ? ',' : '') + key + ':' + variables[key];
-  }, '');
-  return 'path:' + dataID + ',key:' + fragmentName + ',request:' + variablesString;
-}
-
-module.exports = deferrableFragmentKey;