@ember-data/model 4.8.0-alpha.6 → 4.8.0

package/addon/-private/many-array.ts

@@ -367,27 +367,29 @@ function extractIdentifiersFromRecords(records: RecordInstance[]): StableRecordI
 }
 
 function extractIdentifierFromRecord(recordOrPromiseRecord: PromiseProxyRecord | RecordInstance) {
-  if (DEPRECATE_PROMISE_PROXIES && isPromiseRecord(recordOrPromiseRecord)) {
-    let content = recordOrPromiseRecord.content;
-    assert(
-      'You passed in a promise that did not originate from an EmberData relationship. You can only pass promises that come from a belongsTo relationship.',
-      content !== undefined && content !== null
-    );
-    deprecate(
-      `You passed in a PromiseProxy to a Relationship API that now expects a resolved value. await the value before setting it.`,
-      false,
-      {
-        id: 'ember-data:deprecate-promise-proxies',
-        until: '5.0',
-        since: {
-          enabled: '4.8',
-          available: '4.8',
-        },
-        for: 'ember-data',
-      }
-    );
-    assertRecordPassedToHasMany(content);
-    return recordIdentifierFor(content);
+  if (DEPRECATE_PROMISE_PROXIES) {
+    if (isPromiseRecord(recordOrPromiseRecord)) {
+      let content = recordOrPromiseRecord.content;
+      assert(
+        'You passed in a promise that did not originate from an EmberData relationship. You can only pass promises that come from a belongsTo relationship.',
+        content !== undefined && content !== null
+      );
+      deprecate(
+        `You passed in a PromiseProxy to a Relationship API that now expects a resolved value. await the value before setting it.`,
+        false,
+        {
+          id: 'ember-data:deprecate-promise-proxies',
+          until: '5.0',
+          since: {
+            enabled: '4.7',
+            available: '4.7',
+          },
+          for: 'ember-data',
+        }
+      );
+      assertRecordPassedToHasMany(content);
+      return recordIdentifierFor(content);
+    }
   }
 
   assertRecordPassedToHasMany(recordOrPromiseRecord);

package/addon/-private/model.js

@@ -3,11 +3,9 @@
  */
 
 import { assert, deprecate, warn } from '@ember/debug';
-import EmberError from '@ember/error';
 import EmberObject from '@ember/object';
 import { dependentKeyCompat } from '@ember/object/compat';
 import { run } from '@ember/runloop';
-import { isNone } from '@ember/utils';
 import { DEBUG } from '@glimmer/env';
 import { tracked } from '@glimmer/tracking';
 import Ember from 'ember';
@@ -18,6 +16,7 @@ import { HAS_DEBUG_PACKAGE } from '@ember-data/private-build-infra';
 import {
   DEPRECATE_EARLY_STATIC,
   DEPRECATE_MODEL_REOPEN,
+  DEPRECATE_NON_EXPLICIT_POLYMORPHISM,
   DEPRECATE_RELATIONSHIPS_WITHOUT_INVERSE,
   DEPRECATE_SAVE_PROMISE_ACCESS,
 } from '@ember-data/private-build-infra/deprecations';
@@ -58,7 +57,7 @@ function findPossibleInverses(type, inverseType, name, relationshipsSoFar) {
   let relationshipsForType = relationshipMap.get(type.modelName);
   let relationships = Array.isArray(relationshipsForType)
     ? relationshipsForType.filter((relationship) => {
-        let optionsForRelationship = inverseType.metaForProperty(relationship.name).options;
+        let optionsForRelationship = relationship.options;
 
         if (!optionsForRelationship.inverse && optionsForRelationship.inverse !== null) {
           return true;
@@ -125,10 +124,12 @@ class Model extends EmberObject {
   ___private_notifications;
 
   init(options = {}) {
-    if (DEBUG && !options._secretInit && !options._createProps) {
-      throw new EmberError(
-        'You should not call `create` on a model. Instead, call `store.createRecord` with the attributes you would like to set.'
-      );
+    if (DEBUG) {
+      if (!options._secretInit && !options._createProps) {
+        throw new Error(
+          'You should not call `create` on a model. Instead, call `store.createRecord` with the attributes you would like to set.'
+        );
+      }
     }
     const createProps = options._createProps;
     const _secretInit = options._secretInit;
@@ -521,8 +522,10 @@ class Model extends EmberObject {
     // when using legacy/classic ember classes. Basically: lazy in prod and eager in dev.
     // so we do this to try to steer folks to the nicer "dont user currentState"
     // error.
-    if (!DEBUG && !this.___recordState) {
-      this.___recordState = new RecordState(this);
+    if (!DEBUG) {
+      if (!this.___recordState) {
+        this.___recordState = new RecordState(this);
+      }
     }
     return this.___recordState;
   }
@@ -1279,7 +1282,7 @@ class Model extends EmberObject {
           id: 'ember-data:deprecate-early-static',
           for: 'ember-data',
           until: '5.0',
-          since: { available: '4.8', enabled: '4.8' },
+          since: { available: '4.7', enabled: '4.7' },
         }
       );
     } else {
@@ -1302,7 +1305,7 @@ class Model extends EmberObject {
           id: 'ember-data:deprecate-early-static',
           for: 'ember-data',
           until: '5.0',
-          since: { available: '4.8', enabled: '4.8' },
+          since: { available: '4.7', enabled: '4.7' },
         }
       );
     } else {
@@ -1356,7 +1359,7 @@ class Model extends EmberObject {
           id: 'ember-data:deprecate-early-static',
           for: 'ember-data',
           until: '5.0',
-          since: { available: '4.8', enabled: '4.8' },
+          since: { available: '4.7', enabled: '4.7' },
         }
       );
     } else {
@@ -1385,7 +1388,7 @@ class Model extends EmberObject {
           id: 'ember-data:deprecate-early-static',
           for: 'ember-data',
           until: '5.0',
-          since: { available: '4.8', enabled: '4.8' },
+          since: { available: '4.7', enabled: '4.7' },
         }
       );
     } else {
@@ -1394,42 +1397,46 @@ class Model extends EmberObject {
         this.modelName
       );
     }
-    let inverseType = this.typeForRelationship(name, store);
-    if (!inverseType) {
-      return null;
-    }
 
-    let propertyMeta = this.metaForProperty(name);
+    const relationship = this.relationshipsByName.get(name);
+    const { options } = relationship;
+    const isPolymorphic = options.polymorphic;
+
     //If inverse is manually specified to be null, like  `comments: hasMany('message', { inverse: null })`
-    let options = propertyMeta.options;
-    if (options.inverse === null) {
+    const isExplicitInverseNull = options.inverse === null;
+    const isAbstractType =
+      !isExplicitInverseNull && isPolymorphic && !store.getSchemaDefinitionService().doesTypeExist(relationship.type);
+
+    if (isExplicitInverseNull || isAbstractType) {
+      assert(
+        `No schema for the abstract type '${relationship.type}' for the polymorphic relationship '${name}' on '${this.modelName}' was provided by the SchemaDefinitionService.`,
+        !isPolymorphic || isExplicitInverseNull
+      );
       return null;
     }
 
-    let inverseName, inverseKind, inverse, inverseOptions;
+    let fieldOnInverse, inverseKind, inverseRelationship, inverseOptions;
+    let inverseSchema = this.typeForRelationship(name, store);
 
+    // if the type does not exist and we are not polymorphic
     //If inverse is specified manually, return the inverse
-    if (options.inverse) {
-      inverseName = options.inverse;
-      inverse = inverseType.relationshipsByName.get(inverseName);
+    if (options.inverse !== undefined) {
+      fieldOnInverse = options.inverse;
+      inverseRelationship = inverseSchema && inverseSchema.relationshipsByName.get(fieldOnInverse);
 
       assert(
-        "We found no inverse relationships by the name of '" +
-          inverseName +
-          "' on the '" +
-          inverseType.modelName +
-          "' model. This is most likely due to a missing attribute on your model definition.",
-        !isNone(inverse)
+        `We found no field named '${fieldOnInverse}' on the schema for '${inverseSchema.modelName}' to be the inverse of the '${name}' relationship on '${this.modelName}'. This is most likely due to a missing field on your model definition.`,
+        inverseRelationship
       );
 
       // TODO probably just return the whole inverse here
-      inverseKind = inverse.kind;
-      inverseOptions = inverse.options;
+      inverseKind = inverseRelationship.kind;
+      inverseOptions = inverseRelationship.options;
     } else {
       //No inverse was specified manually, we need to use a heuristic to guess one
-      if (propertyMeta.type === propertyMeta.parentModelName) {
+      if (relationship.type === relationship.parentModelName) {
         warn(
-          `Detected a reflexive relationship by the name of '${name}' without an inverse option. Look at https://guides.emberjs.com/current/models/relationships/#toc_reflexive-relations for how to explicitly specify inverses.`,
+          `Detected a reflexive relationship named '${name}' on the schema for '${relationship.type}' without an inverse option. Look at https://guides.emberjs.com/current/models/relationships/#toc_reflexive-relations for how to explicitly specify inverses.`,
           false,
           {
             id: 'ds.model.reflexive-relationship-without-inverse',
@@ -1437,30 +1444,33 @@ class Model extends EmberObject {
         );
       }
 
-      let possibleRelationships = findPossibleInverses(this, inverseType, name);
+      let possibleRelationships = findPossibleInverses(this, inverseSchema, name);
 
       if (possibleRelationships.length === 0) {
         return null;
       }
 
-      let filteredRelationships = possibleRelationships.filter((possibleRelationship) => {
-        let optionsForRelationship = inverseType.metaForProperty(possibleRelationship.name).options;
-        return name === optionsForRelationship.inverse;
-      });
+      if (DEBUG) {
+        let filteredRelationships = possibleRelationships.filter((possibleRelationship) => {
+          let optionsForRelationship = possibleRelationship.options;
+          return name === optionsForRelationship.inverse;
+        });
 
-      assert(
-        "You defined the '" +
-          name +
-          "' relationship on " +
-          this +
-          ', but you defined the inverse relationships of type ' +
-          inverseType.toString() +
-          ' multiple times. Look at https://guides.emberjs.com/current/models/relationships/#toc_explicit-inverses for how to explicitly specify inverses',
-        filteredRelationships.length < 2
-      );
+        assert(
+          "You defined the '" +
+            name +
+            "' relationship on " +
+            this +
+            ', but you defined the inverse relationships of type ' +
+            inverseSchema.toString() +
+            ' multiple times. Look at https://guides.emberjs.com/current/models/relationships/#toc_explicit-inverses for how to explicitly specify inverses',
+          filteredRelationships.length < 2
+        );
+      }
 
-      if (filteredRelationships.length === 1) {
-        possibleRelationships = filteredRelationships;
+      let explicitRelationship = possibleRelationships.find((relationship) => relationship.options.inverse === name);
+      if (explicitRelationship) {
+        possibleRelationships = [explicitRelationship];
       }
 
       assert(
@@ -1471,24 +1481,82 @@ class Model extends EmberObject {
           ', but multiple possible inverse relationships of type ' +
           this +
           ' were found on ' +
-          inverseType +
+          inverseSchema +
           '. Look at https://guides.emberjs.com/current/models/relationships/#toc_explicit-inverses for how to explicitly specify inverses',
         possibleRelationships.length === 1
       );
 
-      inverseName = possibleRelationships[0].name;
+      fieldOnInverse = possibleRelationships[0].name;
       inverseKind = possibleRelationships[0].kind;
       inverseOptions = possibleRelationships[0].options;
     }
 
+    // ensure inverse is properly configured
+    if (DEBUG) {
+      if (isPolymorphic) {
+        if (DEPRECATE_NON_EXPLICIT_POLYMORPHISM) {
+          if (!inverseOptions.as) {
+            deprecate(
+              `Relationships that satisfy polymorphic relationships MUST define which abstract-type they are satisfying using 'as'. The field '${fieldOnInverse}' on type '${inverseSchema.modelName}' is misconfigured.`,
+              false,
+              {
+                id: 'ember-data:non-explicit-relationships',
+                since: { enabled: '4.7', available: '4.7' },
+                until: '5.0',
+                for: 'ember-data',
+              }
+            );
+          }
+        } else {
+          assert(
+            `Relationships that satisfy polymorphic relationships MUST define which abstract-type they are satisfying using 'as'. The field '${fieldOnInverse}' on type '${inverseSchema.modelName}' is misconfigured.`,
+            inverseOptions.as
+          );
+          assert(
+            `options.as should match the expected type of the polymorphic relationship. Expected field '${fieldOnInverse}' on type '${inverseSchema.modelName}' to specify '${relationship.type}' but found '${inverseOptions.as}'`,
+            !!inverseOptions.as && relationship.type === inverseOptions.as
+          );
+        }
+      }
+    }
+
+    // ensure we are properly configured
+    if (DEBUG) {
+      if (inverseOptions.polymorphic) {
+        if (DEPRECATE_NON_EXPLICIT_POLYMORPHISM) {
+          if (!options.as) {
+            deprecate(
+              `Relationships that satisfy polymorphic relationships MUST define which abstract-type they are satisfying using 'as'. The field '${name}' on type '${this.modelName}' is misconfigured.`,
+              false,
+              {
+                id: 'ember-data:non-explicit-relationships',
+                since: { enabled: '4.7', available: '4.7' },
+                until: '5.0',
+                for: 'ember-data',
+              }
+            );
+          }
+        } else {
+          assert(
+            `Relationships that satisfy polymorphic relationships MUST define which abstract-type they are satisfying using 'as'. The field '${name}' on type '${this.modelName}' is misconfigured.`,
+            options.as
+          );
+          assert(
+            `options.as should match the expected type of the polymorphic relationship. Expected field '${name}' on type '${this.modelName}' to specify '${inverseRelationship.type}' but found '${options.as}'`,
+            !!options.as && inverseRelationship.type === options.as
+          );
+        }
+      }
+    }
+
     assert(
-      `The ${inverseType.modelName}:${inverseName} relationship declares 'inverse: null', but it was resolved as the inverse for ${this.modelName}:${name}.`,
-      !inverseOptions || inverseOptions.inverse !== null
+      `The ${inverseSchema.modelName}:${fieldOnInverse} relationship declares 'inverse: null', but it was resolved as the inverse for ${this.modelName}:${name}.`,
+      inverseOptions.inverse !== null
     );
 
     return {
-      type: inverseType,
-      name: inverseName,
+      type: inverseSchema,
+      name: fieldOnInverse,
       kind: inverseKind,
       options: inverseOptions,
     };
@@ -1546,7 +1614,7 @@ class Model extends EmberObject {
           id: 'ember-data:deprecate-early-static',
           for: 'ember-data',
           until: '5.0',
-          since: { available: '4.8', enabled: '4.8' },
+          since: { available: '4.7', enabled: '4.7' },
         }
       );
     } else {
@@ -1617,7 +1685,7 @@ class Model extends EmberObject {
           id: 'ember-data:deprecate-early-static',
           for: 'ember-data',
           until: '5.0',
-          since: { available: '4.8', enabled: '4.8' },
+          since: { available: '4.7', enabled: '4.7' },
         }
       );
     } else {
@@ -1684,7 +1752,7 @@ class Model extends EmberObject {
           id: 'ember-data:deprecate-early-static',
           for: 'ember-data',
           until: '5.0',
-          since: { available: '4.8', enabled: '4.8' },
+          since: { available: '4.7', enabled: '4.7' },
         }
       );
     } else {
@@ -1760,7 +1828,7 @@ class Model extends EmberObject {
           id: 'ember-data:deprecate-early-static',
           for: 'ember-data',
           until: '5.0',
-          since: { available: '4.8', enabled: '4.8' },
+          since: { available: '4.7', enabled: '4.7' },
         }
       );
     } else {
@@ -1793,7 +1861,7 @@ class Model extends EmberObject {
           id: 'ember-data:deprecate-early-static',
           for: 'ember-data',
           until: '5.0',
-          since: { available: '4.8', enabled: '4.8' },
+          since: { available: '4.7', enabled: '4.7' },
         }
       );
     } else {
@@ -1867,7 +1935,7 @@ class Model extends EmberObject {
           id: 'ember-data:deprecate-early-static',
           for: 'ember-data',
           until: '5.0',
-          since: { available: '4.8', enabled: '4.8' },
+          since: { available: '4.7', enabled: '4.7' },
         }
       );
     } else {
@@ -1910,7 +1978,7 @@ class Model extends EmberObject {
           id: 'ember-data:deprecate-early-static',
           for: 'ember-data',
           until: '5.0',
-          since: { available: '4.8', enabled: '4.8' },
+          since: { available: '4.7', enabled: '4.7' },
         }
       );
     } else {
@@ -1945,7 +2013,7 @@ class Model extends EmberObject {
           id: 'ember-data:deprecate-early-static',
           for: 'ember-data',
           until: '5.0',
-          since: { available: '4.8', enabled: '4.8' },
+          since: { available: '4.7', enabled: '4.7' },
         }
       );
     } else {
@@ -1971,7 +2039,7 @@ class Model extends EmberObject {
           id: 'ember-data:deprecate-early-static',
           for: 'ember-data',
           until: '5.0',
-          since: { available: '4.8', enabled: '4.8' },
+          since: { available: '4.7', enabled: '4.7' },
         }
       );
     } else {
@@ -2049,7 +2117,7 @@ class Model extends EmberObject {
           id: 'ember-data:deprecate-early-static',
           for: 'ember-data',
           until: '5.0',
-          since: { available: '4.8', enabled: '4.8' },
+          since: { available: '4.7', enabled: '4.7' },
         }
       );
     } else {
@@ -2125,7 +2193,7 @@ class Model extends EmberObject {
           id: 'ember-data:deprecate-early-static',
           for: 'ember-data',
           until: '5.0',
-          since: { available: '4.8', enabled: '4.8' },
+          since: { available: '4.7', enabled: '4.7' },
         }
       );
     } else {
@@ -2198,7 +2266,7 @@ class Model extends EmberObject {
           id: 'ember-data:deprecate-early-static',
           for: 'ember-data',
           until: '5.0',
-          since: { available: '4.8', enabled: '4.8' },
+          since: { available: '4.7', enabled: '4.7' },
         }
       );
     } else {
@@ -2266,7 +2334,7 @@ class Model extends EmberObject {
           id: 'ember-data:deprecate-early-static',
           for: 'ember-data',
           until: '5.0',
-          since: { available: '4.8', enabled: '4.8' },
+          since: { available: '4.7', enabled: '4.7' },
         }
       );
     } else {
@@ -2296,7 +2364,7 @@ class Model extends EmberObject {
           id: 'ember-data:deprecate-early-static',
           for: 'ember-data',
           until: '5.0',
-          since: { available: '4.8', enabled: '4.8' },
+          since: { available: '4.7', enabled: '4.7' },
         }
       );
     } else {
@@ -2408,7 +2476,7 @@ if (DEBUG) {
       let idDesc = lookupDescriptor(this, 'id');
 
       if (idDesc.get !== ID_DESCRIPTOR.get) {
-        throw new EmberError(
+        throw new Error(
           `You may not set 'id' as an attribute on your model. Please remove any lines that look like: \`id: attr('<type>')\` from ${this.constructor.toString()}`
         );
       }
@@ -2424,7 +2492,7 @@ if (DEBUG) {
         id: 'ember-data:deprecate-model-reopen',
         for: 'ember-data',
         until: '5.0',
-        since: { available: '4.8', enabled: '4.8' },
+        since: { available: '4.7', enabled: '4.7' },
       });
       return originalReopen.call(this, ...arguments);
     };
@@ -2437,7 +2505,7 @@ if (DEBUG) {
           id: 'ember-data:deprecate-model-reopenclass',
           for: 'ember-data',
           until: '5.0',
-          since: { available: '4.8', enabled: '4.8' },
+          since: { available: '4.7', enabled: '4.7' },
         }
       );
       return originalReopenClass.call(this, ...arguments);

package/addon/-private/promise-many-array.ts

@@ -64,7 +64,7 @@ export default class PromiseManyArray {
         deprecate(`Do not use A() on an EmberData PromiseManyArray`, false, {
           id: 'ember-data:no-a-with-array-like',
           until: '5.0',
-          since: { enabled: '4.8', available: '4.8' },
+          since: { enabled: '4.7', available: '4.7' },
           for: 'ember-data',
         });
         // @ts-expect-error ArrayMixin is more than a type
@@ -261,7 +261,7 @@ if (DEPRECATE_PROMISE_MANY_ARRAY_BEHAVIORS) {
       {
         id: 'ember-data:deprecate-promise-many-array-behaviors',
         until: '5.0',
-        since: { enabled: '4.8', available: '4.8' },
+        since: { enabled: '4.7', available: '4.7' },
         for: 'ember-data',
       }
     );
@@ -277,7 +277,7 @@ if (DEPRECATE_PROMISE_MANY_ARRAY_BEHAVIORS) {
         {
           id: 'ember-data:deprecate-promise-many-array-behaviors',
           until: '5.0',
-          since: { enabled: '4.8', available: '4.8' },
+          since: { enabled: '4.7', available: '4.7' },
           for: 'ember-data',
         }
       );
@@ -293,7 +293,7 @@ if (DEPRECATE_PROMISE_MANY_ARRAY_BEHAVIORS) {
         {
           id: 'ember-data:deprecate-promise-many-array-behaviors',
           until: '5.0',
-          since: { enabled: '4.8', available: '4.8' },
+          since: { enabled: '4.7', available: '4.7' },
           for: 'ember-data',
         }
       );
@@ -347,7 +347,7 @@ if (DEPRECATE_PROMISE_MANY_ARRAY_BEHAVIORS) {
         {
           id: 'ember-data:deprecate-promise-many-array-behaviors',
           until: '5.0',
-          since: { enabled: '4.8', available: '4.8' },
+          since: { enabled: '4.7', available: '4.7' },
           for: 'ember-data',
         }
       );
@@ -414,7 +414,7 @@ if (DEPRECATE_PROMISE_MANY_ARRAY_BEHAVIORS) {
         {
           id: 'ember-data:deprecate-promise-many-array-behaviors',
           until: '5.0',
-          since: { enabled: '4.8', available: '4.8' },
+          since: { enabled: '4.7', available: '4.7' },
           for: 'ember-data',
         }
       );

package/addon/-private/record-state.ts

@@ -8,6 +8,7 @@ import { storeFor } from '@ember-data/store';
 import { recordIdentifierFor } from '@ember-data/store/-private';
 import type { NotificationType } from '@ember-data/store/-private/managers/record-notification-manager';
 import type RequestCache from '@ember-data/store/-private/network/request-cache';
+import { addToTransaction, subscribe } from '@ember-data/tracking/-private';
 import type { StableRecordIdentifier } from '@ember-data/types/q/identifier';
 import type { RecordData } from '@ember-data/types/q/record-data';
 
@@ -35,21 +36,19 @@ class Tag {
   declare rev: number;
   declare isDirty: boolean;
   declare value: any;
+  declare t: boolean;
 
   constructor() {
     this.rev = 1;
     this.isDirty = true;
     this.value = undefined;
+    this.t = false;
   }
-  @tracked _tracking = 0;
-
-  subscribe() {
-    this._tracking;
-  }
+  @tracked ref = null;
 
   notify() {
     this.isDirty = true;
-    this._tracking = this.rev;
+    addToTransaction(this);
     this.rev++;
   }
   consume(v) {
@@ -86,7 +85,7 @@ export function tagged(_target, key, desc) {
   const setter = desc.set;
   desc.get = function () {
     let tag = getTag(this, key);
-    tag.subscribe();
+    subscribe(tag);
 
     if (tag.isDirty) {
       tag.consume(getter.call(this));