@ember-data/legacy-compat 5.3.3 → 5.3.4

package/README.md

@@ -24,3 +24,11 @@ Install using your javascript package manager of choice. For instance with [pnpm
 ```no-highlight
 pnpm add @ember-data/legacy-compat
 ```
+
+**Tagged Releases**
+
+- ![NPM Canary Version](https://img.shields.io/npm/v/%40ember-data/legacy-compat/canary?label=%40canary&color=FFBF00)
+- ![NPM Beta Version](https://img.shields.io/npm/v/%40ember-data/legacy-compat/beta?label=%40beta&color=ff00ff)
+- ![NPM Stable Version](https://img.shields.io/npm/v/%40ember-data/legacy-compat/latest?label=%40latest&color=90EE90)
+- ![NPM LTS Version](https://img.shields.io/npm/v/%40ember-data/legacy-compat/lts?label=%40lts&color=0096FF)
+- ![NPM LTS 4.12 Version](https://img.shields.io/npm/v/%40ember-data/legacy-compat/lts-4-12?label=%40lts-4-12&color=bbbbbb)

package/addon-main.cjs

@@ -0,0 +1,5 @@
+'use strict';
+
+const { addonShim } = require('@warp-drive/build-config/addon-shim.cjs');
+
+module.exports = addonShim(__dirname);

package/{addon/-private-1aicprWG.js → dist/-private-DVN28hvw.js}

@@ -1,7 +1,8 @@
 import { SOURCE, coerceId } from '@ember-data/store/-private';
-import { assert, warn } from '@ember/debug';
-import { macroCondition, getOwnConfig, importSync } from '@embroider/macros';
+import { warn } from '@ember/debug';
+import { macroCondition, getGlobalConfig, dependencySatisfies, importSync } from '@embroider/macros';
 import { createDeferred } from '@ember-data/request';
+import { getOrSetGlobal } from '@warp-drive/core-types/-private';
 
 /**
   @module @ember-data/legacy-compat
@@ -10,7 +11,7 @@ import { createDeferred } from '@ember-data/request';
 /**
   SnapshotRecordArray is not directly instantiable.
   Instances are provided to consuming application's
-  adapters for certain requests.
+  adapters for certain `findAll` requests.
 
   @class SnapshotRecordArray
   @public
@@ -149,13 +150,17 @@ class SnapshotRecordArray {
   }
 }
 function assertIdentifierHasId(identifier) {
-  assert(`Attempted to schedule a fetch for a record without an id.`, identifier && identifier.id !== null);
+  macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+    if (!test) {
+      throw new Error(`Attempted to schedule a fetch for a record without an id.`);
+    }
+  })(identifier && identifier.id !== null) : {};
 }
 function iterateData(data, fn) {
   if (Array.isArray(data)) {
     return data.map(fn);
   } else {
-    return fn(data);
+    return fn(data, 0);
   }
 }
 function payloadIsNotBlank(adapterPayload) {
@@ -175,7 +180,7 @@ function payloadIsNotBlank(adapterPayload) {
   @internal
 */
 function validateDocumentStructure(doc) {
-  if (macroCondition(getOwnConfig().env.DEBUG)) {
+  if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
     const errors = [];
     if (!doc || typeof doc !== 'object') {
       errors.push('Top level of a JSON API document must be an object');
@@ -218,7 +223,11 @@ function validateDocumentStructure(doc) {
         }
       }
     }
-    assert(`Response must be normalized to a valid JSON API document:\n\t* ${errors.join('\n\t* ')}`, errors.length === 0);
+    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+      if (!test) {
+        throw new Error(`Response must be normalized to a valid JSON API document:\n\t* ${errors.join('\n\t* ')}`);
+      }
+    })(errors.length === 0) : {};
   }
 }
 function normalizeResponseHelper(serializer, store, modelClass, payload, id, requestType) {
@@ -335,7 +344,11 @@ class Snapshot {
    */
   get record() {
     const record = this._store.peekRecord(this.identifier);
-    assert(`Record ${this.identifier.type} ${this.identifier.id} (${this.identifier.lid}) is not yet loaded and thus cannot be accessed from the Snapshot during serialization`, record !== null);
+    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+      if (!test) {
+        throw new Error(`Record ${this.identifier.type} ${this.identifier.id} (${this.identifier.lid}) is not yet loaded and thus cannot be accessed from the Snapshot during serialization`);
+      }
+    })(record !== null) : {};
     return record;
   }
   get _attributes() {
@@ -346,10 +359,12 @@ class Snapshot {
     const {
       identifier
     } = this;
-    const attrs = Object.keys(this._store.getSchemaDefinitionService().attributesDefinitionFor(identifier));
+    const attrs = this._store.schema.fields(identifier);
     const cache = this._store.cache;
-    attrs.forEach(keyName => {
-      attributes[keyName] = cache.getAttr(identifier, keyName);
+    attrs.forEach((field, keyName) => {
+      if (field.kind === 'attribute') {
+        attributes[keyName] = cache.getAttr(identifier, keyName);
+      }
     });
     return attributes;
   }
@@ -376,7 +391,11 @@ class Snapshot {
     if (keyName in this._attributes) {
       return this._attributes[keyName];
     }
-    assert(`Model '${this.identifier.lid}' has no attribute named '${keyName}' defined.`, false);
+    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+      {
+        throw new Error(`Model '${this.identifier.lid}' has no attribute named '${keyName}' defined.`);
+      }
+    })() : {};
   }
 
   /**
@@ -459,27 +478,35 @@ class Snapshot {
     if (returnModeIsId === false && keyName in this._belongsToRelationships) {
       return this._belongsToRelationships[keyName];
     }
-    const relationshipMeta = store.getSchemaDefinitionService().relationshipsDefinitionFor({
+    const relationshipMeta = store.schema.fields({
       type: this.modelName
-    })[keyName];
-    assert(`Model '${this.identifier.lid}' has no belongsTo relationship named '${keyName}' defined.`, relationshipMeta && relationshipMeta.kind === 'belongsTo');
-
-    // TODO @runspired it seems this code branch would not work with CUSTOM_MODEL_CLASSes
-    // this check is not a regression in behavior because relationships don't currently
-    // function without access to intimate API contracts between RecordData and Model.
-    // This is a requirement we should fix as soon as the relationship layer does not require
-    // this intimate API usage.
-    if (macroCondition(!getOwnConfig().packages.HAS_JSON_API_PACKAGE)) {
-      assert(`snapshot.belongsTo only supported when using the package @ember-data/json-api`);
-    }
+    }).get(keyName);
+    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+      if (!test) {
+        throw new Error(`Model '${this.identifier.lid}' has no belongsTo relationship named '${keyName}' defined.`);
+      }
+    })(relationshipMeta && relationshipMeta.kind === 'belongsTo') : {};
+    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+      if (!test) {
+        throw new Error(`snapshot.belongsTo only supported when using the package @ember-data/graph`);
+      }
+    })(dependencySatisfies('@ember-data/graph', '*')) : {};
     const graphFor = importSync('@ember-data/graph/-private').graphFor;
     const {
       identifier
     } = this;
-    if (macroCondition(getOwnConfig().env.DEBUG)) {
+    if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
       const relationship = graphFor(this._store).get(identifier, keyName);
-      assert(`You looked up the ${keyName} belongsTo relationship for { type: ${identifier.type}, id: ${identifier.id || ''}, lid: ${identifier.lid} but no such relationship was found.`, relationship);
-      assert(`You looked up the ${keyName} belongsTo relationship for { type: ${identifier.type}, id: ${identifier.id || ''}, lid: ${identifier.lid} but that relationship is a hasMany.`, relationship.definition.kind === 'belongsTo');
+      macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+        if (!test) {
+          throw new Error(`You looked up the ${keyName} belongsTo relationship for { type: ${identifier.type}, id: ${identifier.id || ''}, lid: ${identifier.lid} but no such relationship was found.`);
+        }
+      })(relationship) : {};
+      macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+        if (!test) {
+          throw new Error(`You looked up the ${keyName} belongsTo relationship for { type: ${identifier.type}, id: ${identifier.id || ''}, lid: ${identifier.lid} but that relationship is a hasMany.`);
+        }
+      })(relationship.definition.kind === 'belongsTo') : {};
     }
     const value = graphFor(this._store).getData(identifier, keyName);
     const data = value && value.data;
@@ -539,27 +566,41 @@ class Snapshot {
       return cachedSnapshots;
     }
     const store = this._store;
-    const relationshipMeta = store.getSchemaDefinitionService().relationshipsDefinitionFor({
+    const relationshipMeta = store.schema.fields({
       type: this.modelName
-    })[keyName];
-    assert(`Model '${this.identifier.lid}' has no hasMany relationship named '${keyName}' defined.`, relationshipMeta && relationshipMeta.kind === 'hasMany');
+    }).get(keyName);
+    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+      if (!test) {
+        throw new Error(`Model '${this.identifier.lid}' has no hasMany relationship named '${keyName}' defined.`);
+      }
+    })(relationshipMeta && relationshipMeta.kind === 'hasMany') : {};
 
     // TODO @runspired it seems this code branch would not work with CUSTOM_MODEL_CLASSes
     // this check is not a regression in behavior because relationships don't currently
     // function without access to intimate API contracts between RecordData and Model.
     // This is a requirement we should fix as soon as the relationship layer does not require
     // this intimate API usage.
-    if (macroCondition(!getOwnConfig().packages.HAS_JSON_API_PACKAGE)) {
-      assert(`snapshot.hasMany only supported when using the package @ember-data/json-api`);
-    }
+    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+      if (!test) {
+        throw new Error(`snapshot.hasMany only supported when using the package @ember-data/graph`);
+      }
+    })(dependencySatisfies('@ember-data/graph', '*')) : {};
     const graphFor = importSync('@ember-data/graph/-private').graphFor;
     const {
       identifier
     } = this;
-    if (macroCondition(getOwnConfig().env.DEBUG)) {
+    if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
       const relationship = graphFor(this._store).get(identifier, keyName);
-      assert(`You looked up the ${keyName} hasMany relationship for { type: ${identifier.type}, id: ${identifier.id || ''}, lid: ${identifier.lid} but no such relationship was found.`, relationship);
-      assert(`You looked up the ${keyName} hasMany relationship for { type: ${identifier.type}, id: ${identifier.id || ''}, lid: ${identifier.lid} but that relationship is a belongsTo.`, relationship.definition.kind === 'hasMany');
+      macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+        if (!test) {
+          throw new Error(`You looked up the ${keyName} hasMany relationship for { type: ${identifier.type}, id: ${identifier.id || ''}, lid: ${identifier.lid} but no such relationship was found.`);
+        }
+      })(relationship) : {};
+      macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+        if (!test) {
+          throw new Error(`You looked up the ${keyName} hasMany relationship for { type: ${identifier.type}, id: ${identifier.id || ''}, lid: ${identifier.lid} but that relationship is a belongsTo.`);
+        }
+      })(relationship.definition.kind === 'hasMany') : {};
     }
     const value = graphFor(this._store).getData(identifier, keyName);
     if (value.data) {
@@ -602,9 +643,11 @@ class Snapshot {
     @public
   */
   eachAttribute(callback, binding) {
-    const attrDefs = this._store.getSchemaDefinitionService().attributesDefinitionFor(this.identifier);
-    Object.keys(attrDefs).forEach(key => {
-      callback.call(binding, key, attrDefs[key]);
+    const fields = this._store.schema.fields(this.identifier);
+    fields.forEach((field, key) => {
+      if (field.kind === 'attribute') {
+        callback.call(binding, key, field);
+      }
     });
   }
 
@@ -623,9 +666,11 @@ class Snapshot {
     @public
   */
   eachRelationship(callback, binding) {
-    const relationshipDefs = this._store.getSchemaDefinitionService().relationshipsDefinitionFor(this.identifier);
-    Object.keys(relationshipDefs).forEach(key => {
-      callback.call(binding, key, relationshipDefs[key]);
+    const fields = this._store.schema.fields(this.identifier);
+    fields.forEach((field, key) => {
+      if (field.kind === 'belongsTo' || field.kind === 'hasMany') {
+        callback.call(binding, key, field);
+      }
     });
   }
 
@@ -653,11 +698,15 @@ class Snapshot {
   serialize(options) {
     upgradeStore(this._store);
     const serializer = this._store.serializerFor(this.modelName);
-    assert(`Cannot serialize record, no serializer found`, serializer);
+    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+      if (!test) {
+        throw new Error(`Cannot serialize record, no serializer found`);
+      }
+    })(serializer) : {};
     return serializer.serialize(this, options);
   }
 }
-const SaveOp = Symbol('SaveOp');
+const SaveOp = getOrSetGlobal('SaveOp', Symbol('SaveOp'));
 class FetchManager {
   // fetches pending in the runloop, waiting to be coalesced
 
@@ -740,11 +789,15 @@ class FetchManager {
       }
       return identifier;
     }, error => {
-      assert(`Async Leak Detected: Expected the store to not be destroyed`, !store.isDestroyed);
+      macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+        if (!test) {
+          throw new Error(`Async Leak Detected: Expected the store to not be destroyed`);
+        }
+      })(!store.isDestroyed) : {};
       const cache = store.cache;
       if (!cache || cache.isEmpty(identifier) || isInitialLoad) {
         let isReleasable = true;
-        if (macroCondition(getOwnConfig().packages.HAS_GRAPH_PACKAGE)) {
+        if (macroCondition(dependencySatisfies('@ember-data/graph', '*'))) {
           if (!cache) {
             const graphFor = importSync('@ember-data/graph/-private').graphFor;
             const graph = graphFor(store);
@@ -779,7 +832,7 @@ class FetchManager {
       fetchesById.set(identifier, requestsForIdentifier);
     }
     requestsForIdentifier.push(pendingFetchItem);
-    if (macroCondition(getOwnConfig().env.TESTING)) {
+    if (macroCondition(getGlobalConfig().WarpDrive.env.TESTING)) {
       if (!request.disableTestWaiter) {
         const {
           waitForPromise
@@ -816,7 +869,7 @@ class FetchManager {
     let promise;
     if (isEmpty) {
       assertIdentifierHasId(identifier);
-      if (macroCondition(getOwnConfig().env.DEBUG)) {
+      if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
         promise = this.scheduleFetch(identifier, Object.assign({}, options, {
           reload: true
         }), request);
@@ -826,7 +879,11 @@ class FetchManager {
       }
     } else if (isLoading) {
       promise = this.getPendingFetch(identifier, options);
-      assert(`Expected to find a pending request for a record in the loading state, but found none`, promise);
+      macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+        if (!test) {
+          throw new Error(`Expected to find a pending request for a record in the loading state, but found none`);
+        }
+      })(promise) : {};
     } else {
       promise = Promise.resolve(identifier);
     }
@@ -894,15 +951,31 @@ function _findMany(store, adapter, modelName, snapshots) {
   const modelClass = store.modelFor(modelName); // `adapter.findMany` gets the modelClass still
   const promise = Promise.resolve().then(() => {
     const ids = snapshots.map(s => s.id);
-    assert(`Cannot fetch a record without an id`, ids.every(v => v !== null));
+    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+      if (!test) {
+        throw new Error(`Cannot fetch a record without an id`);
+      }
+    })(ids.every(v => v !== null)) : {};
     // eslint-disable-next-line @typescript-eslint/unbound-method
-    assert(`Expected this adapter to implement findMany for coalescing`, adapter.findMany);
+    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+      if (!test) {
+        throw new Error(`Expected this adapter to implement findMany for coalescing`);
+      }
+    })(adapter.findMany) : {};
     const ret = adapter.findMany(store, modelClass, ids, snapshots);
-    assert('adapter.findMany returned undefined, this was very likely a mistake', ret !== undefined);
+    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+      if (!test) {
+        throw new Error('adapter.findMany returned undefined, this was very likely a mistake');
+      }
+    })(ret !== undefined) : {};
     return ret;
   });
   return promise.then(adapterPayload => {
-    assert(`You made a 'findMany' request for '${modelName}' records with ids '[${snapshots.map(s => s.id).join(',')}]', but the adapter's response did not have any data`, !!payloadIsNotBlank(adapterPayload));
+    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+      if (!test) {
+        throw new Error(`You made a 'findMany' request for '${modelName}' records with ids '[${snapshots.map(s => s.id).join(',')}]', but the adapter's response did not have any data`);
+      }
+    })(!!payloadIsNotBlank(adapterPayload)) : {};
     const serializer = store.serializerFor(modelName);
     const payload = normalizeResponseHelper(serializer, store, modelClass, adapterPayload, null, 'findMany');
     return payload;
@@ -981,8 +1054,16 @@ function handleFoundRecords(store, fetchMap, snapshots, coalescedPayload) {
 function _fetchRecord(store, adapter, fetchItem) {
   const identifier = fetchItem.identifier;
   const modelName = identifier.type;
-  assert(`You tried to find a record but you have no adapter (for ${modelName})`, adapter);
-  assert(`You tried to find a record but your adapter (for ${modelName}) does not implement 'findRecord'`, typeof adapter.findRecord === 'function');
+  macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+    if (!test) {
+      throw new Error(`You tried to find a record but you have no adapter (for ${modelName})`);
+    }
+  })(adapter) : {};
+  macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+    if (!test) {
+      throw new Error(`You tried to find a record but your adapter (for ${modelName}) does not implement 'findRecord'`);
+    }
+  })(typeof adapter.findRecord === 'function') : {};
   const snapshot = store._fetchManager.createSnapshot(identifier, fetchItem.options);
   const klass = store.modelFor(identifier.type);
   const id = identifier.id;
@@ -990,12 +1071,28 @@ function _fetchRecord(store, adapter, fetchItem) {
     return adapter.findRecord(store, klass, identifier.id, snapshot);
   });
   promise = promise.then(adapterPayload => {
-    assert(`Async Leak Detected: Expected the store to not be destroyed`, !(store.isDestroyed || store.isDestroying));
-    assert(`You made a 'findRecord' request for a '${modelName}' with id '${id}', but the adapter's response did not have any data`, !!payloadIsNotBlank(adapterPayload));
+    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+      if (!test) {
+        throw new Error(`Async Leak Detected: Expected the store to not be destroyed`);
+      }
+    })(!(store.isDestroyed || store.isDestroying)) : {};
+    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+      if (!test) {
+        throw new Error(`You made a 'findRecord' request for a '${modelName}' with id '${id}', but the adapter's response did not have any data`);
+      }
+    })(!!payloadIsNotBlank(adapterPayload)) : {};
     const serializer = store.serializerFor(modelName);
     const payload = normalizeResponseHelper(serializer, store, klass, adapterPayload, id, 'findRecord');
-    assert(`Ember Data expected the primary data returned from a 'findRecord' response to be an object but instead it found an array.`, !Array.isArray(payload.data));
-    assert(`The 'findRecord' request for ${modelName}:${id} resolved indicating success but contained no primary data. To indicate a 404 not found you should either reject the promise returned by the adapter's findRecord method or throw a NotFoundError.`, 'data' in payload && payload.data !== null && typeof payload.data === 'object');
+    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+      if (!test) {
+        throw new Error(`Ember Data expected the primary data returned from a 'findRecord' response to be an object but instead it found an array.`);
+      }
+    })(!Array.isArray(payload.data)) : {};
+    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+      if (!test) {
+        throw new Error(`The 'findRecord' request for ${modelName}:${id} resolved indicating success but contained no primary data. To indicate a 404 not found you should either reject the promise returned by the adapter's findRecord method or throw a NotFoundError.`);
+      }
+    })('data' in payload && payload.data !== null && typeof payload.data === 'object') : {};
     warn(`You requested a record of type '${modelName}' with id '${id}' but the adapter returned a payload with primary data having an id of '${payload.data.id}'. Use 'store.findRecord()' when the requested id is the same as the one returned by the adapter. In other cases use 'store.queryRecord()' instead.`, coerceId(payload.data.id) === coerceId(id), {
       id: 'ds.store.findRecord.id-mismatch'
     });
@@ -1013,7 +1110,11 @@ function _processCoalescedGroup(store, fetchMap, group, adapter, modelName) {
   } else if (group.length === 1) {
     _fetchRecord(store, adapter, fetchMap.get(group[0]));
   } else {
-    assert("You cannot return an empty array from adapter's method groupRecordsForFindMany", false);
+    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+      {
+        throw new Error("You cannot return an empty array from adapter's method groupRecordsForFindMany");
+      }
+    })() : {};
   }
 }
 function _flushPendingFetchForType(store, pendingFetchMap, modelName) {
@@ -1069,11 +1170,23 @@ function _flushPendingSave(store, pending) {
   const operation = options[SaveOp];
   const modelName = snapshot.modelName;
   const modelClass = store.modelFor(modelName);
-  assert(`You tried to update a record but you have no adapter (for ${modelName})`, adapter);
-  assert(`You tried to update a record but your adapter (for ${modelName}) does not implement '${operation}'`, typeof adapter[operation] === 'function');
+  macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+    if (!test) {
+      throw new Error(`You tried to update a record but you have no adapter (for ${modelName})`);
+    }
+  })(adapter) : {};
+  macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+    if (!test) {
+      throw new Error(`You tried to update a record but your adapter (for ${modelName}) does not implement '${operation}'`);
+    }
+  })(typeof adapter[operation] === 'function') : {};
   let promise = Promise.resolve().then(() => adapter[operation](store, modelClass, snapshot));
   const serializer = store.serializerFor(modelName);
-  assert(`Your adapter's '${operation}' method must return a value, but it returned 'undefined'`, promise !== undefined);
+  macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+    if (!test) {
+      throw new Error(`Your adapter's '${operation}' method must return a value, but it returned 'undefined'`);
+    }
+  })(promise !== undefined) : {};
   promise = promise.then(adapterPayload => {
     if (adapterPayload) {
       return normalizeResponseHelper(serializer, store, modelClass, adapterPayload, snapshot.id, operation);