@ember-data/model 4.8.0-beta.0 → 4.8.0

package/addon/-private/model.js

@@ -3,7 +3,6 @@
  */
 
 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';
@@ -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 {
@@ -1489,56 +1492,60 @@ class Model extends EmberObject {
     }
 
     // ensure inverse is properly configured
-    if (DEBUG && isPolymorphic) {
-      if (DEPRECATE_NON_EXPLICIT_POLYMORPHISM) {
-        if (!inverseOptions.as) {
-          deprecate(
+    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.`,
-            false,
-            {
-              id: 'ember-data:non-explicit-relationships',
-              since: { enabled: '4.8', available: '4.8' },
-              until: '5.0',
-              for: 'ember-data',
-            }
+            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
           );
         }
-      } 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 && inverseOptions.polymorphic) {
-      if (DEPRECATE_NON_EXPLICIT_POLYMORPHISM) {
-        if (!options.as) {
-          deprecate(
+    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.`,
-            false,
-            {
-              id: 'ember-data:non-explicit-relationships',
-              since: { enabled: '4.8', available: '4.8' },
-              until: '5.0',
-              for: 'ember-data',
-            }
+            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
           );
         }
-      } 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
-        );
       }
     }
 
@@ -1607,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 {
@@ -1678,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 {
@@ -1745,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 {
@@ -1821,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 {
@@ -1854,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 {
@@ -1928,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 {
@@ -1971,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 {
@@ -2006,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 {
@@ -2032,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 {
@@ -2110,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 {
@@ -2186,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 {
@@ -2259,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 {
@@ -2327,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 {
@@ -2357,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 {
@@ -2469,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()}`
         );
       }
@@ -2485,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);
     };
@@ -2498,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));

package/addon/-private/references/belongs-to.ts

@@ -1,5 +1,6 @@
 import { deprecate } from '@ember/debug';
 import { dependentKeyCompat } from '@ember/object/compat';
+import { DEBUG } from '@glimmer/env';
 import { cached, tracked } from '@glimmer/tracking';
 
 import type { Object as JSONObject, Value as JSONValue } from 'json-typescript';
@@ -9,7 +10,6 @@ import { DEPRECATE_PROMISE_PROXIES } from '@ember-data/private-build-infra/depre
 import type { Graph } from '@ember-data/record-data/-private/graph/graph';
 import type BelongsToRelationship from '@ember-data/record-data/-private/relationships/state/belongs-to';
 import type Store from '@ember-data/store';
-import { assertPolymorphicType } from '@ember-data/store/-debug';
 import { recordIdentifierFor } from '@ember-data/store/-private';
 import type { NotificationType } from '@ember-data/store/-private/managers/record-notification-manager';
 import type {
@@ -22,6 +22,7 @@ import type { StableRecordIdentifier } from '@ember-data/types/q/identifier';
 import type { RecordInstance } from '@ember-data/types/q/record-instance';
 import type { Dict } from '@ember-data/types/q/utils';
 
+import { assertPolymorphicType } from '../debug/assert-polymorphic-type';
 import type { LegacySupport } from '../legacy-relationships-support';
 import { LEGACY_SUPPORT } from '../model';
 
@@ -101,9 +102,16 @@ export default class BelongsToReference {
     }
   }
 
+  /**
+   * The identifier of the record that this reference refers to.
+   * `null` if no related record is known.
+   *
+   * @property {StableRecordIdentifier | null} identifier
+   * @public
+   */
   @cached
   @dependentKeyCompat
-  get _relatedIdentifier(): StableRecordIdentifier | null {
+  get identifier(): StableRecordIdentifier | null {
     this._ref; // consume the tracked prop
     if (this.___relatedToken) {
       this.store._notificationManager.unsubscribe(this.___relatedToken);
@@ -165,11 +173,11 @@ export default class BelongsToReference {
    ```
 
    @method id
-    @public
+   @public
    @return {String} The id of the record in this belongsTo relationship.
    */
   id(): string | null {
-    return this._relatedIdentifier?.id || null;
+    return this.identifier?.id || null;
   }
 
   /**
@@ -388,33 +396,37 @@ export default class BelongsToReference {
    */
   async push(data: SingleResourceDocument | Promise<SingleResourceDocument>): Promise<RecordInstance> {
     let jsonApiDoc: SingleResourceDocument = data as SingleResourceDocument;
-    if (DEPRECATE_PROMISE_PROXIES && (data as { then: unknown }).then) {
-      jsonApiDoc = await resolve(data);
-      if (jsonApiDoc !== data) {
-        deprecate(
-          `You passed in a Promise to a Reference 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',
-          }
-        );
+    if (DEPRECATE_PROMISE_PROXIES) {
+      if ((data as { then: unknown }).then) {
+        jsonApiDoc = await resolve(data);
+        if (jsonApiDoc !== data) {
+          deprecate(
+            `You passed in a Promise to a Reference 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',
+            }
+          );
+        }
       }
     }
     let record = this.store.push(jsonApiDoc);
 
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-call
-    assertPolymorphicType(
-      this.belongsToRelationship.identifier,
-      this.belongsToRelationship.definition,
-      recordIdentifierFor(record),
-      this.store
-    );
+    if (DEBUG) {
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+      assertPolymorphicType(
+        this.belongsToRelationship.identifier,
+        this.belongsToRelationship.definition,
+        recordIdentifierFor(record),
+        this.store
+      );
+    }
 
     const { identifier } = this.belongsToRelationship;
     this.store._join(() => {

package/addon/-private/references/has-many.ts

@@ -13,7 +13,6 @@ import type { Graph } from '@ember-data/record-data/-private/graph/graph';
 import type ManyRelationship from '@ember-data/record-data/-private/relationships/state/has-many';
 import type Store from '@ember-data/store';
 import { recordIdentifierFor } from '@ember-data/store';
-import { assertPolymorphicType } from '@ember-data/store/-debug';
 import type { NotificationType } from '@ember-data/store/-private/managers/record-notification-manager';
 import type {
   CollectionResourceDocument,
@@ -28,6 +27,7 @@ import type { RecordInstance } from '@ember-data/types/q/record-instance';
 import type { FindOptions } from '@ember-data/types/q/store';
 import type { Dict } from '@ember-data/types/q/utils';
 
+import { assertPolymorphicType } from '../debug/assert-polymorphic-type';
 import type { LegacySupport } from '../legacy-relationships-support';
 import { LEGACY_SUPPORT } from '../model';
 
@@ -102,9 +102,15 @@ export default class HasManyReference {
     this.___relatedTokenMap.clear();
   }
 
+  /**
+   * An array of identifiers for the records that this reference refers to.
+   *
+   * @property {StableRecordIdentifier[]} identifiers
+   * @public
+   */
   @cached
   @dependentKeyCompat
-  get _relatedIdentifiers(): StableRecordIdentifier[] {
+  get identifiers(): StableRecordIdentifier[] {
     this._ref; // consume the tracked prop
 
     let resource = this._resource();
@@ -236,7 +242,7 @@ export default class HasManyReference {
    @return {Array} The ids in this has-many relationship
    */
   ids(): Array<string | null> {
-    return this._relatedIdentifiers.map((identifier) => identifier.id);
+    return this.identifiers.map((identifier) => identifier.id);
   }
 
   /**
@@ -400,22 +406,24 @@ export default class HasManyReference {
     objectOrPromise: ExistingResourceObject[] | CollectionResourceDocument | { data: SingleResourceDocument[] }
   ): Promise<ManyArray> {
     let payload = objectOrPromise;
-    if (DEPRECATE_PROMISE_PROXIES && (objectOrPromise as unknown as { then: unknown }).then) {
-      payload = await resolve(objectOrPromise);
-      if (payload !== objectOrPromise) {
-        deprecate(
-          `You passed in a Promise to a Reference 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',
-          }
-        );
+    if (DEPRECATE_PROMISE_PROXIES) {
+      if ((objectOrPromise as unknown as { then: unknown }).then) {
+        payload = await resolve(objectOrPromise);
+        if (payload !== objectOrPromise) {
+          deprecate(
+            `You passed in a Promise to a Reference 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',
+            }
+          );
+        }
       }
     }
     let array: Array<ExistingResourceObject | SingleResourceDocument>;
@@ -519,7 +527,16 @@ export default class HasManyReference {
       this.___identifier
     )!;
 
-    return this._isLoaded() ? support.getManyArray(this.key) : null;
+    const loaded = this._isLoaded();
+
+    if (!loaded) {
+      // subscribe to changes
+      // for when we are not loaded yet
+      this._ref;
+      return null;
+    }
+
+    return support.getManyArray(this.key);
   }
 
   /**

package/addon/-private/relationship-meta.ts

@@ -77,8 +77,10 @@ class RelationshipDefinition implements RelationshipSchema {
       inverse = modelClass.inverseFor(this.key, store);
     }
     // TODO make this error again for the non-polymorphic case
-    if (DEBUG && !this.options.polymorphic) {
-      modelClass.typeForRelationship(this.key, store);
+    if (DEBUG) {
+      if (!this.options.polymorphic) {
+        modelClass.typeForRelationship(this.key, store);
+      }
     }
 
     if (inverse) {

package/addon/index.ts

@@ -36,5 +36,4 @@
   @module @ember-data/model
   @main @ember-data/model
  */
-
 export { Model as default, attr, belongsTo, hasMany } from './-private';