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

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

@@ -2,18 +2,23 @@ import ArrayMixin, { NativeArray } from '@ember/array';
 import type ArrayProxy from '@ember/array/proxy';
 import { assert, deprecate } from '@ember/debug';
 import { dependentKeyCompat } from '@ember/object/compat';
+import { DEBUG } from '@glimmer/env';
 import { tracked } from '@glimmer/tracking';
 import Ember from 'ember';
 
 import { resolve } from 'rsvp';
 
-import type { ManyArray } from 'ember-data/-private';
-
-import { DEPRECATE_PROMISE_MANY_ARRAY_BEHAVIORS } from '@ember-data/private-build-infra/deprecations';
+import {
+  DEPRECATE_A_USAGE,
+  DEPRECATE_COMPUTED_CHAINS,
+  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';
 
+import type ManyArray from './many-array';
+
 export interface HasManyProxyCreateArgs {
   promise: Promise<ManyArray>;
   content?: ManyArray;
@@ -53,13 +58,27 @@ export default class PromiseManyArray {
     this.isDestroyed = false;
     this.isDestroying = false;
 
-    const meta = Ember.meta(this);
-    meta.hasMixin = (mixin: Object) => {
-      if (mixin === NativeArray || mixin === ArrayMixin) {
-        return true;
-      }
-      return false;
-    };
+    if (DEPRECATE_A_USAGE) {
+      const meta = Ember.meta(this);
+      meta.hasMixin = (mixin: Object) => {
+        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' },
+          for: 'ember-data',
+        });
+        // @ts-expect-error ArrayMixin is more than a type
+        if (mixin === NativeArray || mixin === ArrayMixin) {
+          return true;
+        }
+        return false;
+      };
+    } else if (DEBUG) {
+      const meta = Ember.meta(this);
+      meta.hasMixin = (mixin: Object) => {
+        assert(`Do not use A() on an EmberData PromiseManyArray`);
+      };
+    }
   }
 
   //---- Methods/Properties on ArrayProxy that we will keep as our API
@@ -75,7 +94,9 @@ export default class PromiseManyArray {
   get length(): number {
     // shouldn't be needed, but ends up being needed
     // for computed chains even in 4.x
-    this['[]'];
+    if (DEPRECATE_COMPUTED_CHAINS) {
+      this['[]'];
+    }
     return this.content ? this.content.length : 0;
   }
 
@@ -85,7 +106,9 @@ export default class PromiseManyArray {
   // to recompute. We entangle the '[]' tag from
   @dependentKeyCompat
   get '[]'() {
-    return this.content ? this.content['[]'] : this.content;
+    if (DEPRECATE_COMPUTED_CHAINS) {
+      return this.content?.length && this.content;
+    }
   }
 
   /**
@@ -99,7 +122,6 @@ export default class PromiseManyArray {
    * @private
    */
   forEach(cb) {
-    this['[]']; // needed for < 3.23 support e.g. 3.20 lts
     if (this.content && this.length) {
       this.content.forEach(cb);
     }

package/addon/-private/promise-proxy-base.js

@@ -0,0 +1,4 @@
+import PromiseProxyMixin from '@ember/object/promise-proxy-mixin';
+import ObjectProxy from '@ember/object/proxy';
+
+export const PromiseObject = ObjectProxy.extend(PromiseProxyMixin);

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

@@ -1,9 +1,11 @@
+import { deprecate } from '@ember/debug';
 import { dependentKeyCompat } from '@ember/object/compat';
 import { cached, tracked } from '@glimmer/tracking';
 
 import type { Object as JSONObject, Value as JSONValue } from 'json-typescript';
 import { resolve } from 'rsvp';
 
+import { DEPRECATE_PROMISE_PROXIES } from '@ember-data/private-build-infra/deprecations';
 import type { Graph } from '@ember-data/record-data/-private/graph';
 import type BelongsToRelationship from '@ember-data/record-data/-private/relationships/state/belongs-to';
 import type Store from '@ember-data/store';
@@ -385,8 +387,25 @@ export default class BelongsToReference {
    @return {Promise<record>} A promise that resolves with the new value in this belongs-to relationship.
    */
   async push(data: SingleResourceDocument | Promise<SingleResourceDocument>): Promise<RecordInstance> {
-    // TODO @deprecate pushing unresolved payloads
-    const jsonApiDoc = await resolve(data);
+    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',
+          }
+        );
+      }
+    }
     let record = this.store.push(jsonApiDoc);
 
     // eslint-disable-next-line @typescript-eslint/no-unsafe-call

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

@@ -1,3 +1,4 @@
+import { deprecate } from '@ember/debug';
 import { dependentKeyCompat } from '@ember/object/compat';
 import { DEBUG } from '@glimmer/env';
 import { cached, tracked } from '@glimmer/tracking';
@@ -7,6 +8,7 @@ import { resolve } from 'rsvp';
 
 import { ManyArray } from 'ember-data/-private';
 
+import { DEPRECATE_PROMISE_PROXIES } from '@ember-data/private-build-infra/deprecations';
 import type { Graph } from '@ember-data/record-data/-private/graph';
 import type ManyRelationship from '@ember-data/record-data/-private/relationships/state/has-many';
 import type Store from '@ember-data/store';
@@ -397,7 +399,25 @@ export default class HasManyReference {
   async push(
     objectOrPromise: ExistingResourceObject[] | CollectionResourceDocument | { data: SingleResourceDocument[] }
   ): Promise<ManyArray> {
-    const payload = await resolve(objectOrPromise);
+    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',
+          }
+        );
+      }
+    }
     let array: Array<ExistingResourceObject | SingleResourceDocument>;
 
     if (!Array.isArray(payload) && typeof payload === 'object' && Array.isArray(payload.data)) {

package/index.js

@@ -20,6 +20,8 @@ module.exports = Object.assign({}, addonBaseConfig, {
       '@ember/string',
       '@embroider/macros/es-compat',
 
+      '@ember/object/proxy',
+      '@ember/object/promise-proxy-mixin',
       '@ember/application',
       '@ember/array',
       '@ember/array/mutable',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ember-data/model",
-  "version": "4.8.0-alpha.5",
+  "version": "4.8.0-alpha.6",
   "description": "A presentation layer for apps built with @ember-data/store",
   "keywords": [
     "ember-addon"
@@ -22,9 +22,9 @@
     "test:node": "mocha"
   },
   "dependencies": {
-    "@ember-data/canary-features": "4.8.0-alpha.5",
-    "@ember-data/private-build-infra": "4.8.0-alpha.5",
-    "@ember-data/store": "4.8.0-alpha.5",
+    "@ember-data/canary-features": "4.8.0-alpha.6",
+    "@ember-data/private-build-infra": "4.8.0-alpha.6",
+    "@ember-data/store": "4.8.0-alpha.6",
     "@ember/edition-utils": "^1.2.0",
     "@ember/string": "^3.0.0",
     "@embroider/macros": "^1.8.3",
@@ -38,7 +38,7 @@
     "inflection": "~1.13.2"
   },
   "devDependencies": {
-    "@ember-data/unpublished-test-infra": "4.8.0-alpha.5",
+    "@ember-data/unpublished-test-infra": "4.8.0-alpha.6",
     "@ember/optional-features": "^2.0.0",
     "@ember/test-helpers": "~2.7.0",
     "broccoli-asset-rev": "^3.0.0",