relay-runtime 2.0.0-rc.2 → 5.0.0

package/lib/RelayReader.js

@@ -4,11 +4,34 @@
  * 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 RelayModernRecord = require("./RelayModernRecord");
+
+var invariant = require("fbjs/lib/invariant");
+
+var _require = require("./RelayConcreteNode"),
+    CONDITION = _require.CONDITION,
+    CLIENT_EXTENSION = _require.CLIENT_EXTENSION,
+    FRAGMENT_SPREAD = _require.FRAGMENT_SPREAD,
+    INLINE_FRAGMENT = _require.INLINE_FRAGMENT,
+    LINKED_FIELD = _require.LINKED_FIELD,
+    MODULE_IMPORT = _require.MODULE_IMPORT,
+    SCALAR_FIELD = _require.SCALAR_FIELD;
+
+var _require2 = require("./RelayStoreUtils"),
+    FRAGMENTS_KEY = _require2.FRAGMENTS_KEY,
+    FRAGMENT_OWNER_KEY = _require2.FRAGMENT_OWNER_KEY,
+    FRAGMENT_PROP_NAME_KEY = _require2.FRAGMENT_PROP_NAME_KEY,
+    ID_KEY = _require2.ID_KEY,
+    MODULE_COMPONENT_KEY = _require2.MODULE_COMPONENT_KEY,
+    getArgumentValues = _require2.getArgumentValues,
+    getStorageKey = _require2.getStorageKey,
+    getModuleComponentKey = _require2.getModuleComponentKey;
+
 function read(recordSource, selector, owner) {
   var _owner;
 
@@ -45,7 +68,8 @@ function () {
       node: node,
       seenRecords: this._seenRecords,
       variables: this._variables,
-      isMissingData: this._isMissingData
+      isMissingData: this._isMissingData,
+      owner: this._owner
     };
   };
 
@@ -70,52 +94,78 @@ function () {
   };
 
   _proto._getVariableValue = function _getVariableValue(name) {
-    !this._variables.hasOwnProperty(name) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayReader(): Undefined variable `%s`.', name) : require("fbjs/lib/invariant")(false) : void 0;
+    !this._variables.hasOwnProperty(name) ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayReader(): Undefined variable `%s`.', name) : invariant(false) : void 0;
     return this._variables[name];
   };
 
   _proto._traverseSelections = function _traverseSelections(selections, record, data) {
-    var _this = this;
+    for (var i = 0; i < selections.length; i++) {
+      var selection = selections[i];
 
-    selections.forEach(function (selection) {
-      if (selection.kind === require("./RelayConcreteNode").SCALAR_FIELD) {
-        _this._readScalar(selection, record, data);
-      } else if (selection.kind === require("./RelayConcreteNode").LINKED_FIELD) {
-        if (selection.plural) {
-          _this._readPluralLink(selection, record, data);
-        } else {
-          _this._readLink(selection, record, data);
-        }
-      } else if (selection.kind === require("./RelayConcreteNode").CONDITION) {
-        var conditionValue = _this._getVariableValue(selection.condition);
+      switch (selection.kind) {
+        case SCALAR_FIELD:
+          this._readScalar(selection, record, data);
 
-        if (conditionValue === selection.passingValue) {
-          _this._traverseSelections(selection.selections, record, data);
-        }
-      } else if (selection.kind === require("./RelayConcreteNode").INLINE_FRAGMENT) {
-        var typeName = require("./RelayModernRecord").getType(record);
+          break;
 
-        if (typeName != null && typeName === selection.type) {
-          _this._traverseSelections(selection.selections, record, data);
-        }
-      } else if (selection.kind === require("./RelayConcreteNode").FRAGMENT_SPREAD) {
-        _this._createFragmentPointer(selection, record, data, _this._variables);
-      } else if (selection.kind === require("./RelayConcreteNode").MATCH_FIELD) {
-        _this._readMatchField(selection, record, data);
-      } else {
-        !false ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayReader(): Unexpected ast kind `%s`.', selection.kind) : require("fbjs/lib/invariant")(false) : void 0;
+        case LINKED_FIELD:
+          if (selection.plural) {
+            this._readPluralLink(selection, record, data);
+          } else {
+            this._readLink(selection, record, data);
+          }
+
+          break;
+
+        case CONDITION:
+          var conditionValue = this._getVariableValue(selection.condition);
+
+          if (conditionValue === selection.passingValue) {
+            this._traverseSelections(selection.selections, record, data);
+          }
+
+          break;
+
+        case INLINE_FRAGMENT:
+          var typeName = RelayModernRecord.getType(record);
+
+          if (typeName != null && typeName === selection.type) {
+            this._traverseSelections(selection.selections, record, data);
+          }
+
+          break;
+
+        case FRAGMENT_SPREAD:
+          this._createFragmentPointer(selection, record, data);
+
+          break;
+
+        case MODULE_IMPORT:
+          this._readModuleImport(selection, record, data);
+
+          break;
+
+        case CLIENT_EXTENSION:
+          var isMissingData = this._isMissingData;
+
+          this._traverseSelections(selection.selections, record, data);
+
+          this._isMissingData = isMissingData;
+          break;
+
+        default:
+          selection;
+          !false ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayReader(): Unexpected ast kind `%s`.', selection.kind) : invariant(false) : void 0;
       }
-    });
+    }
   };
 
   _proto._readScalar = function _readScalar(field, record, data) {
     var _field$alias;
 
     var applicationName = (_field$alias = field.alias) !== null && _field$alias !== void 0 ? _field$alias : field.name;
-
-    var storageKey = require("./RelayStoreUtils").getStorageKey(field, this._variables);
-
-    var value = require("./RelayModernRecord").getValue(record, storageKey);
+    var storageKey = getStorageKey(field, this._variables);
+    var value = RelayModernRecord.getValue(record, storageKey);
 
     if (value === undefined) {
       this._isMissingData = true;
@@ -128,10 +178,8 @@ function () {
     var _field$alias2;
 
     var applicationName = (_field$alias2 = field.alias) !== null && _field$alias2 !== void 0 ? _field$alias2 : field.name;
-
-    var storageKey = require("./RelayStoreUtils").getStorageKey(field, this._variables);
-
-    var linkedID = require("./RelayModernRecord").getLinkedRecordID(record, storageKey);
+    var storageKey = getStorageKey(field, this._variables);
+    var linkedID = RelayModernRecord.getLinkedRecordID(record, storageKey);
 
     if (linkedID == null) {
       data[applicationName] = linkedID;
@@ -144,20 +192,22 @@ function () {
     }
 
     var prevData = data[applicationName];
-    !(prevData == null || typeof prevData === 'object') ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayReader(): Expected data for field `%s` on record `%s` ' + 'to be an object, got `%s`.', applicationName, require("./RelayModernRecord").getDataID(record), prevData) : require("fbjs/lib/invariant")(false) : void 0;
+    !(prevData == null || typeof prevData === 'object') ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayReader(): Expected data for field `%s` on record `%s` ' + 'to be an object, got `%s`.', applicationName, RelayModernRecord.getDataID(record), prevData) : invariant(false) : void 0;
+    /* $FlowFixMe(>=0.98.0 site=www,mobile,react_native_fb,oss) This comment
+     * suppresses an error found when Flow v0.98 was deployed. To see the error
+     * delete this comment and run Flow. */
+
     data[applicationName] = this._traverse(field, linkedID, prevData);
   };
 
   _proto._readPluralLink = function _readPluralLink(field, record, data) {
-    var _this2 = this;
+    var _this = this;
 
     var _field$alias3;
 
     var applicationName = (_field$alias3 = field.alias) !== null && _field$alias3 !== void 0 ? _field$alias3 : field.name;
-
-    var storageKey = require("./RelayStoreUtils").getStorageKey(field, this._variables);
-
-    var linkedIDs = require("./RelayModernRecord").getLinkedRecordIDs(record, storageKey);
+    var storageKey = getStorageKey(field, this._variables);
+    var linkedIDs = RelayModernRecord.getLinkedRecordIDs(record, storageKey);
 
     if (linkedIDs == null) {
       data[applicationName] = linkedIDs;
@@ -170,92 +220,49 @@ function () {
     }
 
     var prevData = data[applicationName];
-    !(prevData == null || Array.isArray(prevData)) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayReader(): Expected data for field `%s` on record `%s` ' + 'to be an array, got `%s`.', applicationName, require("./RelayModernRecord").getDataID(record), prevData) : require("fbjs/lib/invariant")(false) : void 0;
+    !(prevData == null || Array.isArray(prevData)) ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayReader(): Expected data for field `%s` on record `%s` ' + 'to be an array, got `%s`.', applicationName, RelayModernRecord.getDataID(record), prevData) : invariant(false) : void 0;
     var linkedArray = prevData || [];
     linkedIDs.forEach(function (linkedID, nextIndex) {
       if (linkedID == null) {
         if (linkedID === undefined) {
-          _this2._isMissingData = true;
+          _this._isMissingData = true;
         }
+        /* $FlowFixMe(>=0.98.0 site=www,mobile,react_native_fb,oss) This comment
+         * suppresses an error found when Flow v0.98 was deployed. To see the
+         * error delete this comment and run Flow. */
+
 
         linkedArray[nextIndex] = linkedID;
         return;
       }
 
       var prevItem = linkedArray[nextIndex];
-      !(prevItem == null || typeof prevItem === 'object') ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayReader(): Expected data for field `%s` on record `%s` ' + 'to be an object, got `%s`.', applicationName, require("./RelayModernRecord").getDataID(record), prevItem) : require("fbjs/lib/invariant")(false) : void 0;
-      linkedArray[nextIndex] = _this2._traverse(field, linkedID, prevItem);
+      !(prevItem == null || typeof prevItem === 'object') ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayReader(): Expected data for field `%s` on record `%s` ' + 'to be an object, got `%s`.', applicationName, RelayModernRecord.getDataID(record), prevItem) : invariant(false) : void 0;
+      /* $FlowFixMe(>=0.98.0 site=www,mobile,react_native_fb,oss) This comment
+       * suppresses an error found when Flow v0.98 was deployed. To see the
+       * error delete this comment and run Flow. */
+
+      linkedArray[nextIndex] = _this._traverse(field, linkedID, prevItem);
     });
     data[applicationName] = linkedArray;
-  };
+  }
   /**
-   * Reads a ReaderMatchField, which was generated from using the @match
-   * directive
+   * Reads a ReaderModuleImport, which was generated from using the @module
+   * directive.
    */
+  ;
 
-
-  _proto._readMatchField = function _readMatchField(field, record, data) {
-    var _field$alias4;
-
-    var applicationName = (_field$alias4 = field.alias) !== null && _field$alias4 !== void 0 ? _field$alias4 : field.name;
-
-    var storageKey = require("./RelayStoreUtils").getStorageKey(field, this._variables);
-
-    var linkedID = require("./RelayModernRecord").getLinkedRecordID(record, storageKey);
-
-    if (linkedID == null) {
-      data[applicationName] = linkedID;
-
-      if (linkedID === undefined) {
-        this._isMissingData = true;
-      }
-
-      return;
-    }
-
-    var prevData = data[applicationName];
-    !(prevData == null || typeof prevData === 'object') ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayReader(): Expected data for field `%s` on record `%s` ' + 'to be an object, got `%s`.', applicationName, require("./RelayModernRecord").getDataID(record), prevData) : require("fbjs/lib/invariant")(false) : void 0; // Instead of recursing into the traversal again, let's manually traverse
-    // one level to get the record associated with the match field
-
-    var linkedRecord = this._recordSource.get(linkedID);
-
-    this._seenRecords[linkedID] = linkedRecord;
-
-    if (linkedRecord == null) {
-      if (linkedRecord === undefined) {
-        this._isMissingData = true;
-      }
-
-      data[applicationName] = linkedRecord;
-      return;
-    } // Determine the concrete type for the match field record. The type of a
-    // match field must be a union type (i.e. abstract type), so here we
-    // read the concrete type on the record, which should be the type resolved
-    // by the server in the response.
-
-
-    var concreteType = require("./RelayModernRecord").getType(linkedRecord);
-
-    !(typeof concreteType === 'string') ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayReader(): Expected to be able to resolve concrete type for ' + 'field `%s` on record `%s`', applicationName, require("./RelayModernRecord").getDataID(linkedRecord)) : require("fbjs/lib/invariant")(false) : void 0; // If we can't find a match provided in the directive for the concrete
-    // type, return null as the result
-
-    var match = field.matchesByType[concreteType];
-
-    if (match == null) {
-      data[applicationName] = null;
-      return;
-    } // Determine the component module from the store: if the field is missing
+  _proto._readModuleImport = function _readModuleImport(moduleImport, record, data) {
+    // Determine the component module from the store: if the field is missing
     // it means we don't know what component to render the match with.
+    var componentKey = getModuleComponentKey(moduleImport.documentName);
+    var component = RelayModernRecord.getValue(record, componentKey);
 
-
-    var matchComponent = require("./RelayModernRecord").getValue(linkedRecord, require("./RelayStoreUtils").MATCH_COMPONENT_KEY);
-
-    if (matchComponent == null) {
-      if (matchComponent === undefined) {
+    if (component == null) {
+      if (component === undefined) {
         this._isMissingData = true;
       }
 
-      data[applicationName] = null;
       return;
     } // Otherwise, read the fragment and module associated to the concrete
     // type, and put that data with the result:
@@ -264,33 +271,35 @@ function () {
     // - For the matched module, create a reference to the module
 
 
-    var matchResult = {};
-
     this._createFragmentPointer({
       kind: 'FragmentSpread',
-      name: match.fragmentName,
+      name: moduleImport.fragmentName,
       args: null
-    }, linkedRecord, matchResult, this._variables);
+    }, record, data);
 
-    matchResult[require("./RelayStoreUtils").FRAGMENT_PROP_NAME_KEY] = match.fragmentPropName;
-    matchResult[require("./RelayStoreUtils").MODULE_KEY] = matchComponent; // Attach the match result to the data being read
-
-    data[applicationName] = matchResult;
+    data[FRAGMENT_PROP_NAME_KEY] = moduleImport.fragmentPropName;
+    data[MODULE_COMPONENT_KEY] = component;
   };
 
-  _proto._createFragmentPointer = function _createFragmentPointer(fragmentSpread, record, data, variables) {
-    var _data$ID_KEY;
-
-    var fragmentPointers = data[require("./RelayStoreUtils").FRAGMENTS_KEY];
+  _proto._createFragmentPointer = function _createFragmentPointer(fragmentSpread, record, data) {
+    var fragmentPointers = data[FRAGMENTS_KEY];
 
     if (fragmentPointers == null) {
-      fragmentPointers = data[require("./RelayStoreUtils").FRAGMENTS_KEY] = {};
+      fragmentPointers = data[FRAGMENTS_KEY] = {};
     }
 
-    !(typeof fragmentPointers === 'object' && fragmentPointers) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayReader: Expected fragment spread data to be an object, got `%s`.', fragmentPointers) : require("fbjs/lib/invariant")(false) : void 0;
-    data[require("./RelayStoreUtils").ID_KEY] = (_data$ID_KEY = data[require("./RelayStoreUtils").ID_KEY]) !== null && _data$ID_KEY !== void 0 ? _data$ID_KEY : require("./RelayModernRecord").getDataID(record);
-    fragmentPointers[fragmentSpread.name] = fragmentSpread.args ? require("./RelayStoreUtils").getArgumentValues(fragmentSpread.args, variables) : {};
-    data[require("./RelayStoreUtils").FRAGMENT_OWNER_KEY] = this._owner;
+    !(typeof fragmentPointers === 'object' && fragmentPointers) ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayReader: Expected fragment spread data to be an object, got `%s`.', fragmentPointers) : invariant(false) : void 0;
+
+    if (data[ID_KEY] == null) {
+      data[ID_KEY] = RelayModernRecord.getDataID(record);
+    }
+    /* $FlowFixMe(>=0.98.0 site=www,mobile,react_native_fb,oss) This comment
+     * suppresses an error found when Flow v0.98 was deployed. To see the error
+     * delete this comment and run Flow. */
+
+
+    fragmentPointers[fragmentSpread.name] = fragmentSpread.args ? getArgumentValues(fragmentSpread.args, this._variables) : {};
+    data[FRAGMENT_OWNER_KEY] = this._owner;
   };
 
   return RelayReader;

package/lib/RelayRecordProxy.js

@@ -4,11 +4,19 @@
  * 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 invariant = require("fbjs/lib/invariant");
+
+var _require = require("./ClientID"),
+    generateClientID = _require.generateClientID;
+
+var _require2 = require("./RelayStoreUtils"),
+    getStableStorageKey = _require2.getStableStorageKey;
+
 /**
  * @internal
  *
@@ -37,20 +45,18 @@ function () {
   _proto.getType = function getType() {
     var type = this._mutator.getType(this._dataID);
 
-    !(type != null) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayRecordProxy: Cannot get the type of deleted record `%s`.', this._dataID) : require("fbjs/lib/invariant")(false) : void 0;
+    !(type != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayRecordProxy: Cannot get the type of deleted record `%s`.', this._dataID) : invariant(false) : void 0;
     return type;
   };
 
   _proto.getValue = function getValue(name, args) {
-    var storageKey = require("./RelayStoreUtils").getStableStorageKey(name, args);
-
+    var storageKey = getStableStorageKey(name, args);
     return this._mutator.getValue(this._dataID, storageKey);
   };
 
   _proto.setValue = function setValue(value, name, args) {
-    !isValidLeafValue(value) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayRecordProxy#setValue(): Expected a scalar or array of scalars, ' + 'got `%s`.', JSON.stringify(value)) : require("fbjs/lib/invariant")(false) : void 0;
-
-    var storageKey = require("./RelayStoreUtils").getStableStorageKey(name, args);
+    !isValidLeafValue(value) ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayRecordProxy#setValue(): Expected a scalar or array of scalars, ' + 'got `%s`.', JSON.stringify(value)) : invariant(false) : void 0;
+    var storageKey = getStableStorageKey(name, args);
 
     this._mutator.setValue(this._dataID, storageKey, value);
 
@@ -58,7 +64,7 @@ function () {
   };
 
   _proto.getLinkedRecord = function getLinkedRecord(name, args) {
-    var storageKey = require("./RelayStoreUtils").getStableStorageKey(name, args);
+    var storageKey = getStableStorageKey(name, args);
 
     var linkedID = this._mutator.getLinkedRecordID(this._dataID, storageKey);
 
@@ -66,10 +72,8 @@ function () {
   };
 
   _proto.setLinkedRecord = function setLinkedRecord(record, name, args) {
-    !(record instanceof RelayRecordProxy) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayRecordProxy#setLinkedRecord(): Expected a record, got `%s`.', record) : require("fbjs/lib/invariant")(false) : void 0;
-
-    var storageKey = require("./RelayStoreUtils").getStableStorageKey(name, args);
-
+    !(record instanceof RelayRecordProxy) ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayRecordProxy#setLinkedRecord(): Expected a record, got `%s`.', record) : invariant(false) : void 0;
+    var storageKey = getStableStorageKey(name, args);
     var linkedID = record.getDataID();
 
     this._mutator.setLinkedRecordID(this._dataID, storageKey, linkedID);
@@ -81,11 +85,13 @@ function () {
     var linkedRecord = this.getLinkedRecord(name, args);
 
     if (!linkedRecord) {
-      var storageKey = require("./RelayStoreUtils").getStableStorageKey(name, args);
+      var _this$_source$get;
 
-      var clientID = require("./generateRelayClientID")(this.getDataID(), storageKey);
+      var storageKey = getStableStorageKey(name, args);
+      var clientID = generateClientID(this.getDataID(), storageKey); // NOTE: it's possible that a client record for this field exists
+      // but the field itself was unset.
 
-      linkedRecord = this._source.create(clientID, typeName);
+      linkedRecord = (_this$_source$get = this._source.get(clientID)) !== null && _this$_source$get !== void 0 ? _this$_source$get : this._source.create(clientID, typeName);
       this.setLinkedRecord(linkedRecord, name, args);
     }
 
@@ -95,7 +101,7 @@ function () {
   _proto.getLinkedRecords = function getLinkedRecords(name, args) {
     var _this = this;
 
-    var storageKey = require("./RelayStoreUtils").getStableStorageKey(name, args);
+    var storageKey = getStableStorageKey(name, args);
 
     var linkedIDs = this._mutator.getLinkedRecordIDs(this._dataID, storageKey);
 
@@ -109,10 +115,8 @@ function () {
   };
 
   _proto.setLinkedRecords = function setLinkedRecords(records, name, args) {
-    !Array.isArray(records) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayRecordProxy#setLinkedRecords(): Expected records to be an array, got `%s`.', records) : require("fbjs/lib/invariant")(false) : void 0;
-
-    var storageKey = require("./RelayStoreUtils").getStableStorageKey(name, args);
-
+    !Array.isArray(records) ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayRecordProxy#setLinkedRecords(): Expected records to be an array, got `%s`.', records) : invariant(false) : void 0;
+    var storageKey = getStableStorageKey(name, args);
     var linkedIDs = records.map(function (record) {
       return record && record.getDataID();
     });