@ember-data/model 4.8.0-alpha.2 → 4.8.0-alpha.5

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

@@ -1,6 +1,6 @@
 import ArrayMixin, { NativeArray } from '@ember/array';
 import type ArrayProxy from '@ember/array/proxy';
-import { assert } from '@ember/debug';
+import { assert, deprecate } from '@ember/debug';
 import { dependentKeyCompat } from '@ember/object/compat';
 import { tracked } from '@glimmer/tracking';
 import Ember from 'ember';
@@ -9,8 +9,10 @@ import { resolve } from 'rsvp';
 
 import type { ManyArray } from 'ember-data/-private';
 
-import type { InternalModel } from '@ember-data/store/-private';
+import { DEPRECATE_PROMISE_MANY_ARRAY_BEHAVIORS } from '@ember-data/private-build-infra/deprecations';
+import { StableRecordIdentifier } from '@ember-data/types/q/identifier';
 import type { RecordInstance } from '@ember-data/types/q/record-instance';
+import { FindOptions } from '@ember-data/types/q/store';
 
 export interface HasManyProxyCreateArgs {
   promise: Promise<ManyArray>;
@@ -24,16 +26,10 @@ export interface HasManyProxyCreateArgs {
   This class is returned as the result of accessing an async hasMany relationship
   on an instance of a Model extending from `@ember-data/model`.
 
-  A PromiseManyArray is an array-like proxy that also proxies certain method calls
-  to the underlying ManyArray in addition to being "promisified".
+  A PromiseManyArray is an iterable proxy that allows templates to consume related
+  ManyArrays and update once their contents are no longer pending.
 
-  Right now we proxy:
-
-    * `reload()`
-    * `createRecord()`
-
-  This promise-proxy behavior is primarily to ensure that async relationship interact
-  nicely with templates. In your JS code you should resolve the promise first.
+  In your JS code you should resolve the promise first.
 
   ```js
   const comments = await post.comments;
@@ -42,10 +38,14 @@ export interface HasManyProxyCreateArgs {
   @class PromiseManyArray
   @public
 */
-export default interface PromiseManyArray extends Omit<ArrayProxy<InternalModel, RecordInstance>, 'destroy'> {}
+export default interface PromiseManyArray extends Omit<ArrayProxy<StableRecordIdentifier, RecordInstance>, 'destroy'> {
+  createRecord(): RecordInstance;
+  reload(options: FindOptions): PromiseManyArray;
+}
 export default class PromiseManyArray {
   declare promise: Promise<ManyArray> | null;
   declare isDestroyed: boolean;
+  // @deprecated (isDestroyed is not deprecated)
   declare isDestroying: boolean;
 
   constructor(promise: Promise<ManyArray>, content?: ManyArray) {
@@ -90,6 +90,8 @@ export default class PromiseManyArray {
 
   /**
    * Iterate the proxied content. Called by the glimmer iterator in #each
+   * We do not guarantee that forEach will always be available. This
+   * may eventually be made to use Symbol.Iterator once glimmer supports it.
    *
    * @method forEach
    * @param cb
@@ -103,6 +105,19 @@ export default class PromiseManyArray {
     }
   }
 
+  /**
+   * Reload the relationship
+   * @method reload
+   * @public
+   * @param options
+   * @returns
+   */
+  reload(options: FindOptions) {
+    assert('You are trying to reload an async manyArray before it has been created', this.content);
+    this.content.reload(options);
+    return this;
+  }
+
   //----  Properties/Methods from the PromiseProxyMixin that we will keep as our API
 
   /**
@@ -201,19 +216,6 @@ export default class PromiseManyArray {
     return this.content ? this.content.meta : undefined;
   }
 
-  /**
-   * Reload the relationship
-   * @method reload
-   * @public
-   * @param options
-   * @returns
-   */
-  reload(options) {
-    assert('You are trying to reload an async manyArray before it has been created', this.content);
-    this.content.reload(options);
-    return this;
-  }
-
   //---- Our own stuff
 
   _update(promise: Promise<ManyArray>, content?: ManyArray) {
@@ -227,22 +229,55 @@ export default class PromiseManyArray {
   static create({ promise, content }: HasManyProxyCreateArgs): PromiseManyArray {
     return new this(promise, content);
   }
+}
 
-  // Methods on ManyArray which people should resolve the relationship first before calling
-  createRecord(...args) {
+if (DEPRECATE_PROMISE_MANY_ARRAY_BEHAVIORS) {
+  PromiseManyArray.prototype.createRecord = function createRecord(...args) {
+    deprecate(
+      `The createRecord method on ember-data's PromiseManyArray is deprecated. await the promise and work with the ManyArray directly.`,
+      false,
+      {
+        id: 'ember-data:deprecate-promise-many-array-behaviors',
+        until: '5.0',
+        since: { enabled: '4.8', available: '4.8' },
+        for: 'ember-data',
+      }
+    );
     assert('You are trying to createRecord on an async manyArray before it has been created', this.content);
     return this.content.createRecord(...args);
-  }
-
-  // Properties/Methods on ArrayProxy we should deprecate
-
-  get firstObject() {
-    return this.content ? this.content.firstObject : undefined;
-  }
+  };
 
-  get lastObject() {
-    return this.content ? this.content.lastObject : undefined;
-  }
+  Object.defineProperty(PromiseManyArray.prototype, 'firstObject', {
+    get() {
+      deprecate(
+        `The firstObject property on ember-data's PromiseManyArray is deprecated. await the promise and work with the ManyArray directly.`,
+        false,
+        {
+          id: 'ember-data:deprecate-promise-many-array-behaviors',
+          until: '5.0',
+          since: { enabled: '4.8', available: '4.8' },
+          for: 'ember-data',
+        }
+      );
+      return this.content ? this.content.firstObject : undefined;
+    },
+  });
+
+  Object.defineProperty(PromiseManyArray.prototype, 'lastObject', {
+    get() {
+      deprecate(
+        `The lastObject property on ember-data's PromiseManyArray is deprecated. await the promise and work with the ManyArray directly.`,
+        false,
+        {
+          id: 'ember-data:deprecate-promise-many-array-behaviors',
+          until: '5.0',
+          since: { enabled: '4.8', available: '4.8' },
+          for: 'ember-data',
+        }
+      );
+      return this.content ? this.content.lastObject : undefined;
+    },
+  });
 }
 
 function tapPromise(proxy: PromiseManyArray, promise: Promise<ManyArray>) {
@@ -268,78 +303,101 @@ function tapPromise(proxy: PromiseManyArray, promise: Promise<ManyArray>) {
   );
 }
 
-const EmberObjectMethods = [
-  'addObserver',
-  'cacheFor',
-  'decrementProperty',
-  'get',
-  'getProperties',
-  'incrementProperty',
-  'notifyPropertyChange',
-  'removeObserver',
-  'set',
-  'setProperties',
-  'toggleProperty',
-];
-EmberObjectMethods.forEach((method) => {
-  PromiseManyArray.prototype[method] = function delegatedMethod(...args) {
-    return Ember[method](this, ...args);
-  };
-});
-
-const InheritedProxyMethods = [
-  'addArrayObserver',
-  'addObject',
-  'addObjects',
-  'any',
-  'arrayContentDidChange',
-  'arrayContentWillChange',
-  'clear',
-  'compact',
-  'every',
-  'filter',
-  'filterBy',
-  'find',
-  'findBy',
-  'getEach',
-  'includes',
-  'indexOf',
-  'insertAt',
-  'invoke',
-  'isAny',
-  'isEvery',
-  'lastIndexOf',
-  'map',
-  'mapBy',
-  'objectAt',
-  'objectsAt',
-  'popObject',
-  'pushObject',
-  'pushObjects',
-  'reduce',
-  'reject',
-  'rejectBy',
-  'removeArrayObserver',
-  'removeAt',
-  'removeObject',
-  'removeObjects',
-  'replace',
-  'reverseObjects',
-  'setEach',
-  'setObjects',
-  'shiftObject',
-  'slice',
-  'sortBy',
-  'toArray',
-  'uniq',
-  'uniqBy',
-  'unshiftObject',
-  'unshiftObjects',
-  'without',
-];
-InheritedProxyMethods.forEach((method) => {
-  PromiseManyArray.prototype[method] = function proxiedMethod(...args) {
-    assert(`Cannot call ${method} before content is assigned.`, this.content);
-    return this.content[method](...args);
-  };
-});
+if (DEPRECATE_PROMISE_MANY_ARRAY_BEHAVIORS) {
+  const EmberObjectMethods = [
+    'addObserver',
+    'cacheFor',
+    'decrementProperty',
+    'get',
+    'getProperties',
+    'incrementProperty',
+    'notifyPropertyChange',
+    'removeObserver',
+    'set',
+    'setProperties',
+    'toggleProperty',
+  ];
+  EmberObjectMethods.forEach((method) => {
+    PromiseManyArray.prototype[method] = function delegatedMethod(...args) {
+      deprecate(
+        `The ${method} method on ember-data's PromiseManyArray is deprecated. await the promise and work with the ManyArray directly.`,
+        false,
+        {
+          id: 'ember-data:deprecate-promise-many-array-behaviors',
+          until: '5.0',
+          since: { enabled: '4.8', available: '4.8' },
+          for: 'ember-data',
+        }
+      );
+      return Ember[method](this, ...args);
+    };
+  });
+
+  const InheritedProxyMethods = [
+    'addArrayObserver',
+    'addObject',
+    'addObjects',
+    'any',
+    'arrayContentDidChange',
+    'arrayContentWillChange',
+    'clear',
+    'compact',
+    'every',
+    'filter',
+    'filterBy',
+    'find',
+    'findBy',
+    'getEach',
+    'includes',
+    'indexOf',
+    'insertAt',
+    'invoke',
+    'isAny',
+    'isEvery',
+    'lastIndexOf',
+    'map',
+    'mapBy',
+    // TODO update RFC to note objectAt was deprecated (forEach was left for iteration)
+    'objectAt',
+    'objectsAt',
+    'popObject',
+    'pushObject',
+    'pushObjects',
+    'reduce',
+    'reject',
+    'rejectBy',
+    'removeArrayObserver',
+    'removeAt',
+    'removeObject',
+    'removeObjects',
+    'replace',
+    'reverseObjects',
+    'setEach',
+    'setObjects',
+    'shiftObject',
+    'slice',
+    'sortBy',
+    'toArray',
+    'uniq',
+    'uniqBy',
+    'unshiftObject',
+    'unshiftObjects',
+    'without',
+  ];
+  InheritedProxyMethods.forEach((method) => {
+    PromiseManyArray.prototype[method] = function proxiedMethod(...args) {
+      deprecate(
+        `The ${method} method on ember-data's PromiseManyArray is deprecated. await the promise and work with the ManyArray directly.`,
+        false,
+        {
+          id: 'ember-data:deprecate-promise-many-array-behaviors',
+          until: '5.0',
+          since: { enabled: '4.8', available: '4.8' },
+          for: 'ember-data',
+        }
+      );
+      assert(`Cannot call ${method} before content is assigned.`, this.content);
+      return this.content[method](...args);
+    };
+  });
+}

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

@@ -6,8 +6,8 @@ import { cached, tracked } from '@glimmer/tracking';
 import type Store from '@ember-data/store';
 import { storeFor } from '@ember-data/store';
 import { recordIdentifierFor } from '@ember-data/store/-private';
-import type { NotificationType } from '@ember-data/store/-private/record-notification-manager';
-import type RequestCache from '@ember-data/store/-private/request-cache';
+import type { NotificationType } from '@ember-data/store/-private/managers/record-notification-manager';
+import type RequestCache from '@ember-data/store/-private/network/request-cache';
 import type { StableRecordIdentifier } from '@ember-data/types/q/identifier';
 import type { RecordData } from '@ember-data/types/q/record-data';
 
@@ -104,8 +104,9 @@ export function tagged(_target, key, desc) {
 }
 
 /**
-Historically InternalModel managed a state machine
-the currentState for which was reflected onto Model.
+Historically EmberData managed a state machine
+for each record, the localState for which
+was reflected onto Model.
 
 This implements the flags and stateName for backwards compat
 with the state tree that used to be possible (listed below).
@@ -153,6 +154,7 @@ export default class RecordState {
   declare recordData: RecordData;
   declare _errorRequests: any[];
   declare _lastError: any;
+  declare handler: object;
 
   constructor(record: Model) {
     const store = storeFor(record)!;
@@ -232,27 +234,30 @@ export default class RecordState {
       }
     }
 
-    notifications.subscribe(identity, (identifier: StableRecordIdentifier, type: NotificationType, key?: string) => {
-      switch (type) {
-        case 'state':
-          this.notify('isNew');
-          this.notify('isDeleted');
-          this.notify('isDirty');
-          break;
-        case 'attributes':
-          this.notify('isEmpty');
-          this.notify('isDirty');
-          break;
-        case 'unload':
-          this.notify('isNew');
-          this.notify('isDeleted');
-          break;
-        case 'errors':
-          this.updateInvalidErrors(this.record.errors);
-          this.notify('isValid');
-          break;
+    this.handler = notifications.subscribe(
+      identity,
+      (identifier: StableRecordIdentifier, type: NotificationType, key?: string) => {
+        switch (type) {
+          case 'state':
+            this.notify('isNew');
+            this.notify('isDeleted');
+            this.notify('isDirty');
+            break;
+          case 'attributes':
+            this.notify('isEmpty');
+            this.notify('isDirty');
+            break;
+          case 'errors':
+            this.updateInvalidErrors(this.record.errors);
+            this.notify('isValid');
+            break;
+        }
       }
-    });
+    );
+  }
+
+  destroy() {
+    storeFor(this.record)!._notificationManager.unsubscribe(this.handler);
   }
 
   notify(key) {
@@ -304,7 +309,6 @@ export default class RecordState {
     return !this.isLoaded && this.pendingCount > 0 && this.fulfilledCount === 0;
   }
 
-  // TODO @runspired handle "unloadRecord" see note in InternalModel
   @tagged
   get isLoaded() {
     if (this.isNew) {
@@ -318,7 +322,7 @@ export default class RecordState {
     let rd = this.recordData;
     if (this.isDeleted) {
       assert(`Expected RecordData to implement isDeletionCommitted()`, rd.isDeletionCommitted);
-      return rd.isDeletionCommitted();
+      return rd.isDeletionCommitted(this.identifier);
     }
     if (this.isNew || this.isEmpty || !this.isValid || this.isDirty || this.isLoading) {
       return false;
@@ -332,21 +336,21 @@ export default class RecordState {
     // TODO this is not actually an RFC'd concept. Determine the
     // correct heuristic to replace this with.
     assert(`Expected RecordData to implement isEmpty()`, rd.isEmpty);
-    return !this.isNew && rd.isEmpty();
+    return !this.isNew && rd.isEmpty(this.identifier);
   }
 
   @tagged
   get isNew() {
     let rd = this.recordData;
     assert(`Expected RecordData to implement isNew()`, rd.isNew);
-    return rd.isNew();
+    return rd.isNew(this.identifier);
   }
 
   @tagged
   get isDeleted() {
     let rd = this.recordData;
     assert(`Expected RecordData to implement isDeleted()`, rd.isDeleted);
-    return rd.isDeleted();
+    return rd.isDeleted(this.identifier);
   }
 
   @tagged
@@ -357,12 +361,10 @@ export default class RecordState {
   @tagged
   get isDirty() {
     let rd = this.recordData;
-    assert(`Expected RecordData to implement hasChangedAttributes()`, rd.hasChangedAttributes);
-    assert(`Expected RecordData to implement isDeletionCommitted()`, rd.isDeletionCommitted);
-    if (rd.isDeletionCommitted() || (this.isDeleted && this.isNew)) {
+    if (rd.isDeletionCommitted(this.identifier) || (this.isDeleted && this.isNew)) {
       return false;
     }
-    return this.isNew || rd.hasChangedAttributes();
+    return this.isNew || rd.hasChangedAttrs(this.identifier);
   }
 
   @tagged