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

package/addon/-private/model.js

@@ -4,7 +4,7 @@
 
 import { assert, deprecate, warn } from '@ember/debug';
 import EmberError from '@ember/error';
-import EmberObject, { get } from '@ember/object';
+import EmberObject from '@ember/object';
 import { dependentKeyCompat } from '@ember/object/compat';
 import { run } from '@ember/runloop';
 import { inject as service } from '@ember/service';
@@ -19,10 +19,11 @@ import { HAS_DEBUG_PACKAGE } from '@ember-data/private-build-infra';
 import {
   DEPRECATE_EARLY_STATIC,
   DEPRECATE_MODEL_REOPEN,
+  DEPRECATE_RELATIONSHIPS_WITHOUT_INVERSE,
   DEPRECATE_SAVE_PROMISE_ACCESS,
 } from '@ember-data/private-build-infra/deprecations';
 import { recordIdentifierFor, storeFor } from '@ember-data/store';
-import { coerceId, deprecatedPromiseObject, InternalModel, WeakCache } from '@ember-data/store/-private';
+import { coerceId, deprecatedPromiseObject, recordDataFor } from '@ember-data/store/-private';
 
 import Errors from './errors';
 import { LegacySupport } from './legacy-relationships-support';
@@ -31,18 +32,21 @@ import RecordState, { peekTag, tagged } from './record-state';
 import { relationshipFromMeta } from './relationship-meta';
 
 const { changeProperties } = Ember;
-export const LEGACY_SUPPORT = new WeakCache(DEBUG ? 'legacy-relationships' : '');
-LEGACY_SUPPORT._generator = (record) => {
+export const LEGACY_SUPPORT = new Map();
+
+export function lookupLegacySupport(record) {
   const identifier = recordIdentifierFor(record);
   let support = LEGACY_SUPPORT.get(identifier);
 
   if (!support) {
     support = new LegacySupport(record);
     LEGACY_SUPPORT.set(identifier, support);
+    LEGACY_SUPPORT.set(record, support);
   }
 
   return support;
-};
+}
+
 function findPossibleInverses(type, inverseType, name, relationshipsSoFar) {
   let possibleRelationships = relationshipsSoFar || [];
 
@@ -119,37 +123,48 @@ function computeOnce(target, key, desc) {
 */
 class Model extends EmberObject {
   @service store;
+  ___private_notifications;
 
   init(options = {}) {
-    if (DEBUG && !options._secretInit && !options._internalModel && !options._createProps) {
+    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.'
       );
     }
     const createProps = options._createProps;
     const _secretInit = options._secretInit;
-    delete options._createProps;
-    delete options._secretInit;
+    options._createProps = null;
+    options._secretInit = null;
     super.init(options);
 
-    _secretInit(this);
+    let identity = _secretInit.identifier;
+    _secretInit.cb(this, _secretInit.recordData, identity, _secretInit.store);
     this.___recordState = DEBUG ? new RecordState(this) : null;
 
     this.setProperties(createProps);
 
-    // TODO  pass something in such that we don't need internalModel
-    // to get this info
     let store = storeFor(this);
     let notifications = store._notificationManager;
-    let identity = recordIdentifierFor(this);
 
-    notifications.subscribe(identity, (identifier, type, key) => {
+    this.___private_notifications = notifications.subscribe(identity, (identifier, type, key) => {
       notifyChanges(identifier, type, key, this, store);
     });
   }
 
-  willDestroy() {
+  destroy() {
     LEGACY_SUPPORT.get(this)?.destroy();
+    this.___recordState?.destroy();
+    const store = storeFor(this);
+    const identifier = recordIdentifierFor(this);
+    store._notificationManager.unsubscribe(this.___private_notifications);
+    // Legacy behavior is to notify the relationships on destroy
+    // such that they "clear". It's uncertain this behavior would
+    // be good for a new model paradigm, likely cheaper and safer
+    // to simply not notify, for this reason the store does not itself
+    // notify individual changes once the delete has been signaled,
+    // this decision is left to model instances.
+    notifyChanges(identifier, 'relationships', undefined, this, store);
+    super.destroy();
   }
 
   /**
@@ -197,10 +212,10 @@ class Model extends EmberObject {
 
     ```javascript
     let record = store.createRecord('model');
-    record.get('isLoaded'); // true
+    record.isLoaded; // true
 
     store.findRecord('model', 1).then(function(model) {
-      model.get('isLoaded'); // true
+      model.isLoaded; // true
     });
     ```
 
@@ -224,12 +239,12 @@ class Model extends EmberObject {
 
     ```javascript
     let record = store.createRecord('model');
-    record.get('hasDirtyAttributes'); // true
+    record.hasDirtyAttributes; // true
 
     store.findRecord('model', 1).then(function(model) {
-      model.get('hasDirtyAttributes'); // false
+      model.hasDirtyAttributes; // false
       model.set('foo', 'some value');
-      model.get('hasDirtyAttributes'); // true
+      model.hasDirtyAttributes; // true
     });
     ```
 
@@ -254,11 +269,11 @@ class Model extends EmberObject {
 
     ```javascript
     let record = store.createRecord('model');
-    record.get('isSaving'); // false
+    record.isSaving; // false
     let promise = record.save();
-    record.get('isSaving'); // true
+    record.isSaving; // true
     promise.then(function() {
-      record.get('isSaving'); // false
+      record.isSaving; // false
     });
     ```
 
@@ -284,24 +299,24 @@ class Model extends EmberObject {
 
     ```javascript
     let record = store.createRecord('model');
-    record.get('isDeleted');    // false
+    record.isDeleted;    // false
     record.deleteRecord();
 
     // Locally deleted
-    record.get('isDeleted');           // true
-    record.get('hasDirtyAttributes');  // true
-    record.get('isSaving');            // false
+    record.isDeleted;           // true
+    record.hasDirtyAttributes;  // true
+    record.isSaving;            // false
 
     // Persisting the deletion
     let promise = record.save();
-    record.get('isDeleted');    // true
-    record.get('isSaving');     // true
+    record.isDeleted;    // true
+    record.isSaving;     // true
 
     // Deletion Persisted
     promise.then(function() {
-      record.get('isDeleted');          // true
-      record.get('isSaving');           // false
-      record.get('hasDirtyAttributes'); // false
+      record.isDeleted;          // true
+      record.isSaving;           // false
+      record.hasDirtyAttributes; // false
     });
     ```
 
@@ -325,10 +340,10 @@ class Model extends EmberObject {
 
     ```javascript
     let record = store.createRecord('model');
-    record.get('isNew'); // true
+    record.isNew; // true
 
     record.save().then(function(model) {
-      model.get('isNew'); // false
+      model.isNew; // false
     });
     ```
 
@@ -371,7 +386,7 @@ class Model extends EmberObject {
 
     ```javascript
     let record = store.createRecord('model');
-    record.get('dirtyType'); // 'created'
+    record.dirtyType; // 'created'
     ```
 
     @property dirtyType
@@ -392,10 +407,10 @@ class Model extends EmberObject {
     Example
 
     ```javascript
-    record.get('isError'); // false
+    record.isError; // false
     record.set('foo', 'valid value');
     record.save().then(null, function() {
-      record.get('isError'); // true
+      record.isError; // true
     });
     ```
 
@@ -441,10 +456,10 @@ class Model extends EmberObject {
 
     ```javascript
     let record = store.createRecord('model');
-    record.get('id'); // null
+    record.id; // null
 
     store.findRecord('model', 1).then(function(model) {
-      model.get('id'); // '1'
+      model.id; // '1'
     });
     ```
 
@@ -454,24 +469,37 @@ class Model extends EmberObject {
   */
   @tagged
   get id() {
-    // the _internalModel guard exists, because some dev-only deprecation code
+    // this guard exists, because some dev-only deprecation code
     // (addListener via validatePropertyInjections) invokes toString before the
     // object is real.
     if (DEBUG) {
-      if (!this._internalModel) {
+      try {
+        return recordIdentifierFor(this).id;
+      } catch {
         return void 0;
       }
     }
-    return this._internalModel.id;
+    return recordIdentifierFor(this).id;
   }
   set id(id) {
     const normalizedId = coerceId(id);
+    const identifier = recordIdentifierFor(this);
+    let didChange = normalizedId !== identifier.id;
+    assert(
+      `Cannot set ${identifier.type} record's id to ${id}, because id is already ${identifier.id}`,
+      !didChange || identifier.id === null
+    );
 
-    if (normalizedId !== null) {
-      this._internalModel.setId(normalizedId);
+    if (normalizedId !== null && didChange) {
+      this.store._instanceCache.setRecordId(identifier, normalizedId);
+      this.store._notificationManager.notify(identifier, 'identity');
     }
   }
 
+  toString() {
+    return `<model::${this.constructor.modelName}:${this.id}>`;
+  }
+
   /**
     @property currentState
     @private
@@ -494,12 +522,6 @@ class Model extends EmberObject {
     throw new Error('cannot set currentState');
   }
 
-  /**
-   @property _internalModel
-   @private
-   @type {Object}
-   */
-
   /**
     The store service instance which created this record instance
 
@@ -517,10 +539,10 @@ class Model extends EmberObject {
     - `attribute` The name of the property associated with this error message
 
     ```javascript
-    record.get('errors.length'); // 0
+    record.errors.length; // 0
     record.set('foo', 'invalid value');
     record.save().catch(function() {
-      record.get('errors').get('foo');
+      record.errors.foo;
       // [{message: 'foo should be a number.', attribute: 'foo'}]
     });
     ```
@@ -794,7 +816,7 @@ class Model extends EmberObject {
       and value is an [oldProp, newProp] array.
   */
   changedAttributes() {
-    return this._internalModel.changedAttributes();
+    return recordDataFor(this).changedAttrs(recordIdentifierFor(this));
   }
 
   /**
@@ -804,11 +826,11 @@ class Model extends EmberObject {
     Example
 
     ```javascript
-    record.get('name'); // 'Untitled Document'
+    record.name; // 'Untitled Document'
     record.set('name', 'Doc 1');
-    record.get('name'); // 'Doc 1'
+    record.name; // 'Doc 1'
     record.rollbackAttributes();
-    record.get('name'); // 'Untitled Document'
+    record.name; // 'Untitled Document'
     ```
 
     @since 1.13.0
@@ -817,8 +839,15 @@ class Model extends EmberObject {
   */
   rollbackAttributes() {
     const { currentState } = this;
-    this._internalModel.rollbackAttributes();
-    currentState.cleanErrorRequests();
+    const { isNew } = currentState;
+    storeFor(this)._join(() => {
+      recordDataFor(this).rollbackAttrs(recordIdentifierFor(this));
+      this.errors.clear();
+      currentState.cleanErrorRequests();
+      if (isNew) {
+        this.unloadRecord();
+      }
+    });
   }
 
   /**
@@ -830,13 +859,6 @@ class Model extends EmberObject {
     return storeFor(this)._instanceCache.createSnapshot(recordIdentifierFor(this));
   }
 
-  toStringExtension() {
-    // the _internalModel guard exists, because some dev-only deprecation code
-    // (addListener via validatePropertyInjections) invokes toString before the
-    // object is real.
-    return this._internalModel && this._internalModel.id;
-  }
-
   /**
     Save the record and persist any changes to the record to an
     external source via the adapter.
@@ -963,7 +985,7 @@ class Model extends EmberObject {
     import Model, { belongsTo } from '@ember-data/model';
 
     export default class BlogModel extends Model {
-      @belongsTo({ async: true }) user;
+      @belongsTo('user', { async: true, inverse: null }) user;
     }
     ```
 
@@ -1019,7 +1041,7 @@ class Model extends EmberObject {
     @return {BelongsToReference} reference for this relationship
   */
   belongsTo(name) {
-    return LEGACY_SUPPORT.lookup(this).referenceFor('belongsTo', name);
+    return lookupLegacySupport(this).referenceFor('belongsTo', name);
   }
 
   /**
@@ -1031,7 +1053,7 @@ class Model extends EmberObject {
     import Model, { hasMany } from '@ember-data/model';
 
     export default class BlogModel extends Model {
-      @hasMany({ async: true }) comments;
+      @hasMany('comment', { async: true, inverse: null }) comments;
     }
 
     let blog = store.push({
@@ -1082,7 +1104,7 @@ class Model extends EmberObject {
     @return {HasManyReference} reference for this relationship
   */
   hasMany(name) {
-    return LEGACY_SUPPORT.lookup(this).referenceFor('hasMany', name);
+    return lookupLegacySupport(this).referenceFor('hasMany', name);
   }
 
   /**
@@ -1184,7 +1206,7 @@ class Model extends EmberObject {
 
    ```javascript
    import RESTSerializer from '@ember-data/serializer/rest';
-   import { underscore } from '@ember/string';
+   import { underscore } from '<app-name>/utils/string-utils';
 
    export default const PostSerializer = RESTSerializer.extend({
      payloadKeyFromModelName(modelName) {
@@ -1491,10 +1513,10 @@ class Model extends EmberObject {
    import Post from 'app/models/post';
 
    let relationships = Blog.relationships;
-   relationships.get('user');
+   relationships.user;
    //=> [ { name: 'users', kind: 'hasMany' },
    //     { name: 'owner', kind: 'belongsTo' } ]
-   relationships.get('post');
+   relationships.post;
    //=> [ { name: 'posts', kind: 'hasMany' } ]
    ```
 
@@ -1707,9 +1729,9 @@ class Model extends EmberObject {
    import Blog from 'app/models/blog';
 
    let relationshipsByName = Blog.relationshipsByName;
-   relationshipsByName.get('users');
+   relationshipsByName.users;
    //=> { key: 'users', kind: 'hasMany', type: 'user', options: Object, isRelationship: true }
-   relationshipsByName.get('owner');
+   relationshipsByName.owner;
    //=> { key: 'owner', kind: 'belongsTo', type: 'user', options: Object, isRelationship: true }
    ```
 
@@ -1778,7 +1800,7 @@ class Model extends EmberObject {
         meta.key = name;
         meta.name = name;
         meta.parentModelName = modelName;
-        relationships[name] = relationshipFromMeta(meta);
+        relationships[name] = DEPRECATE_RELATIONSHIPS_WITHOUT_INVERSE ? relationshipFromMeta(meta) : meta;
       }
     });
     return relationships;
@@ -1810,7 +1832,7 @@ class Model extends EmberObject {
 
    let fields = Blog.fields;
    fields.forEach(function(kind, field) {
-      console.log(field, kind);
+      // do thing
     });
 
    // prints:
@@ -1848,6 +1870,7 @@ class Model extends EmberObject {
     let map = new Map();
 
     this.eachComputedProperty((name, meta) => {
+      // TODO end reliance on these booleans and stop leaking them in the spec
       if (meta.isRelationship) {
         map.set(name, meta.kind);
       } else if (meta.isAttribute) {
@@ -1992,7 +2015,7 @@ class Model extends EmberObject {
    let attributes = Person.attributes
 
    attributes.forEach(function(meta, name) {
-      console.log(name, meta);
+      // do thing
     });
 
    // prints:
@@ -2069,7 +2092,7 @@ class Model extends EmberObject {
    let transformedAttributes = Person.transformedAttributes
 
    transformedAttributes.forEach(function(field, type) {
-      console.log(field, type);
+      // do thing
     });
 
    // prints:
@@ -2142,7 +2165,7 @@ class Model extends EmberObject {
     }
 
    PersonModel.eachAttribute(function(name, meta) {
-      console.log(name, meta);
+      // do thing
     });
 
    // prints:
@@ -2211,7 +2234,7 @@ class Model extends EmberObject {
     });
 
    Person.eachTransformedAttribute(function(name, type) {
-      console.log(name, type);
+      // do thing
     });
 
    // prints:
@@ -2273,13 +2296,12 @@ class Model extends EmberObject {
         this.modelName
       );
     }
-    return `model:${get(this, 'modelName')}`;
+    return `model:${this.modelName}`;
   }
 }
 
 // this is required to prevent `init` from passing
 // the values initialized during create to `setUnknownProperty`
-Model.prototype._internalModel = null;
 Model.prototype._createProps = null;
 Model.prototype._secretInit = null;
 
@@ -2359,27 +2381,11 @@ if (DEBUG) {
     } while (current !== null);
     return null;
   };
-  let isBasicDesc = function isBasicDesc(desc) {
-    return (
-      !desc ||
-      (!desc.get && !desc.set && desc.enumerable === true && desc.writable === true && desc.configurable === true)
-    );
-  };
-  let isDefaultEmptyDescriptor = function isDefaultEmptyDescriptor(obj, keyName) {
-    let instanceDesc = lookupDescriptor(obj, keyName);
-    return isBasicDesc(instanceDesc) && lookupDescriptor(obj.constructor, keyName) === null;
-  };
 
   Model.reopen({
     init() {
       this._super(...arguments);
 
-      if (!isDefaultEmptyDescriptor(this, '_internalModel') || !(this._internalModel instanceof InternalModel)) {
-        throw new Error(
-          `'_internalModel' is a reserved property name on instances of classes extending Model. Please choose a different property name for ${this.constructor.toString()}`
-        );
-      }
-
       let ourDescriptor = lookupDescriptor(Model.prototype, 'currentState');
       let theirDescriptor = lookupDescriptor(this, 'currentState');
       let realState = this.___recordState;
@@ -2411,7 +2417,7 @@ if (DEBUG) {
         until: '5.0',
         since: { available: '4.8', enabled: '4.8' },
       });
-      return originalReopen.call(this, arguments);
+      return originalReopen.call(this, ...arguments);
     };
 
     Model.reopenClass = function deprecatedReopenClass() {
@@ -2425,7 +2431,7 @@ if (DEBUG) {
           since: { available: '4.8', enabled: '4.8' },
         }
       );
-      return originalReopenClass.call(this, arguments);
+      return originalReopenClass.call(this, ...arguments);
     };
   }
 }

package/addon/-private/notify-changes.ts

@@ -1,7 +1,7 @@
 import { cacheFor } from '@ember/object/internals';
 
 import type Store from '@ember-data/store';
-import type { NotificationType } from '@ember-data/store/-private/record-notification-manager';
+import type { NotificationType } from '@ember-data/store/-private/managers/record-notification-manager';
 import type { StableRecordIdentifier } from '@ember-data/types/q/identifier';
 
 import type Model from './model';
@@ -66,7 +66,7 @@ function notifyRelationship(identifier: StableRecordIdentifier, key: string, rec
 function notifyAttribute(store: Store, identifier: StableRecordIdentifier, key: string, record: Model) {
   let currentValue = cacheFor(record, key);
 
-  if (currentValue !== store._instanceCache.getRecordData(identifier).getAttr(key)) {
+  if (currentValue !== store._instanceCache.getRecordData(identifier).getAttr(identifier, key)) {
     record.notifyPropertyChange(key);
   }
 }