@ember-data/model 4.5.0-alpha.5 → 4.5.0

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

@@ -1,15 +1,15 @@
 import { assert } from '@ember/debug';
 import { dependentKeyCompat } from '@ember/object/compat';
+import { DEBUG } from '@glimmer/env';
 import { cached, tracked } from '@glimmer/tracking';
 
-import type { RecordData } from '@ember-data/record-data/-private';
-import { errorsArrayToHash } from '@ember-data/store/-private';
-import type CoreStore from '@ember-data/store/-private/system/core-store';
-import type { NotificationType } from '@ember-data/store/-private/system/record-notification-manager';
-import type RequestCache from '@ember-data/store/-private/system/request-cache';
-import type { StableRecordIdentifier } from '@ember-data/store/-private/ts-interfaces/identifier';
-
-import notifyChanges from './notify-changes';
+import type Store from '@ember-data/store';
+import { storeFor } from '@ember-data/store';
+import { errorsArrayToHash, 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 { StableRecordIdentifier } from '@ember-data/types/q/identifier';
+import type { RecordData } from '@ember-data/types/q/record-data';
 
 type Model = InstanceType<typeof import('./model')>;
 
@@ -139,7 +139,7 @@ root
   @internal
 */
 export default class RecordState {
-  declare store: CoreStore;
+  declare store: Store;
   declare identifier: StableRecordIdentifier;
   declare record: Model;
   declare rs: RequestCache;
@@ -152,24 +152,23 @@ export default class RecordState {
   declare _lastError: any;
 
   constructor(record: Model) {
-    const { store } = record;
-
-    let id = record._internalModel.identifier;
+    const store = storeFor(record)!;
+    const identity = recordIdentifierFor(record);
 
+    this.identifier = identity;
     this.record = record;
-    this.recordData = record._internalModel._recordData;
+    this.recordData = store._instanceCache.getRecordData(identity);
 
     this.pendingCount = 0;
     this.fulfilledCount = 0;
     this.rejectedCount = 0;
-
     this._errorRequests = [];
     this._lastError = null;
 
     let requests = store.getRequestStateService();
     let notifications = store._notificationManager;
 
-    requests.subscribeForRecord(id, (req) => {
+    const handleRequest = (req) => {
       if (req.type === 'mutation') {
         switch (req.state) {
           case 'pending':
@@ -218,10 +217,20 @@ export default class RecordState {
             break;
         }
       }
-    });
+    };
+
+    requests.subscribeForRecord(identity, handleRequest);
+
+    // we instantiate lazily
+    // so we grab anything we don't have yet
+    if (!DEBUG) {
+      const lastRequest = requests.getLastRequestForRecord(identity);
+      if (lastRequest) {
+        handleRequest(lastRequest);
+      }
+    }
 
-    notifications.subscribe(id, (identifier: StableRecordIdentifier, type: NotificationType, key?: string) => {
-      notifyChanges(identifier, type, key, record, store);
+    notifications.subscribe(identity, (identifier: StableRecordIdentifier, type: NotificationType, key?: string) => {
       switch (type) {
         case 'state':
           this.notify('isNew');
@@ -253,15 +262,15 @@ export default class RecordState {
   }
 
   updateInvalidErrors() {
-    let jsonApiErrors = this.recordData.getErrors!();
+    let jsonApiErrors = this.recordData.getErrors!(this.identifier);
 
     const { errors } = this.record;
-    errors._clear();
+    errors.clear();
     let newErrors = errorsArrayToHash(jsonApiErrors);
     let errorKeys = Object.keys(newErrors);
 
     for (let i = 0; i < errorKeys.length; i++) {
-      errors._add(errorKeys[i], newErrors[errorKeys[i]]);
+      errors.add(errorKeys[i], newErrors[errorKeys[i]]);
     }
   }
 
@@ -280,6 +289,7 @@ 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) {

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

@@ -0,0 +1,585 @@
+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 type { BelongsToRelationship } from '@ember-data/record-data/-private';
+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/record-notification-manager';
+import type { DebugWeakCache } from '@ember-data/store/-private/weak-cache';
+import type {
+  LinkObject,
+  Links,
+  SingleResourceDocument,
+  SingleResourceRelationship,
+} from '@ember-data/types/q/ember-data-json-api';
+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 type { LegacySupport } from '../legacy-relationships-support';
+import { LEGACY_SUPPORT } from '../model';
+
+/**
+  @module @ember-data/model
+*/
+
+interface ResourceIdentifier {
+  links?: {
+    related?: string | LinkObject;
+  };
+  meta?: JSONObject;
+}
+
+function isResourceIdentiferWithRelatedLinks(
+  value: SingleResourceRelationship | ResourceIdentifier | null
+): value is ResourceIdentifier & { links: { related: string | LinkObject | null } } {
+  return Boolean(value && value.links && value.links.related);
+}
+
+/**
+ A `BelongsToReference` is a low-level API that allows users and
+ addon authors to perform meta-operations on a belongs-to
+ relationship.
+
+ @class BelongsToReference
+ @public
+ */
+export default class BelongsToReference {
+  declare key: string;
+  declare belongsToRelationship: BelongsToRelationship;
+  declare type: string;
+  #identifier: StableRecordIdentifier;
+  declare store: Store;
+
+  // unsubscribe tokens given to us by the notification manager
+  #token!: Object;
+  #relatedToken: Object | null = null;
+
+  @tracked _ref = 0;
+
+  constructor(
+    store: Store,
+    parentIdentifier: StableRecordIdentifier,
+    belongsToRelationship: BelongsToRelationship,
+    key: string
+  ) {
+    this.key = key;
+    this.belongsToRelationship = belongsToRelationship;
+    this.type = belongsToRelationship.definition.type;
+    this.store = store;
+    this.#identifier = parentIdentifier;
+
+    this.#token = store._notificationManager.subscribe(
+      parentIdentifier,
+      (_: StableRecordIdentifier, bucket: NotificationType, notifiedKey?: string) => {
+        if ((bucket === 'relationships' || bucket === 'property') && notifiedKey === key) {
+          this._ref++;
+        }
+      }
+    );
+
+    // TODO inverse
+  }
+
+  destroy() {
+    // TODO @feature we need the notification manager often enough
+    // we should potentially just expose it fully public
+    this.store._notificationManager.unsubscribe(this.#token);
+    if (this.#relatedToken) {
+      this.store._notificationManager.unsubscribe(this.#relatedToken);
+    }
+  }
+
+  @cached
+  @dependentKeyCompat
+  get _relatedIdentifier(): StableRecordIdentifier | null {
+    this._ref; // consume the tracked prop
+    if (this.#relatedToken) {
+      this.store._notificationManager.unsubscribe(this.#relatedToken);
+    }
+
+    let resource = this._resource();
+    if (resource && resource.data) {
+      const identifier = this.store.identifierCache.getOrCreateRecordIdentifier(resource.data);
+      this.#relatedToken = this.store._notificationManager.subscribe(
+        identifier,
+        (_: StableRecordIdentifier, bucket: NotificationType, notifiedKey?: string) => {
+          if (bucket === 'identity' || ((bucket === 'attributes' || bucket === 'property') && notifiedKey === 'id')) {
+            this._ref++;
+          }
+        }
+      );
+
+      return identifier;
+    }
+
+    return null;
+  }
+
+  /**
+   The `id` of the record that this reference refers to. Together, the
+   `type()` and `id()` methods form a composite key for the identity
+   map. This can be used to access the id of an async relationship
+   without triggering a fetch that would normally happen if you
+   attempted to use `record.get('relationship.id')`.
+
+   Example
+
+   ```javascript
+   // models/blog.js
+   import Model, { belongsTo } from '@ember-data/model';
+
+   export default class BlogModel extends Model {
+    @belongsTo({ async: true }) user;
+   }
+
+   let blog = store.push({
+      data: {
+        type: 'blog',
+        id: 1,
+        relationships: {
+          user: {
+            data: { type: 'user', id: 1 }
+          }
+        }
+      }
+    });
+   let userRef = blog.belongsTo('user');
+
+   // get the identifier of the reference
+   if (userRef.remoteType() === "id") {
+      let id = userRef.id();
+    }
+   ```
+
+   @method id
+    @public
+   @return {String} The id of the record in this belongsTo relationship.
+   */
+  id(): string | null {
+    return this._relatedIdentifier?.id || null;
+  }
+
+  /**
+   The link Ember Data will use to fetch or reload this belongs-to
+   relationship. By default it uses only the "related" resource linkage.
+
+   Example
+
+   ```javascript
+   // models/blog.js
+   import Model, { belongsTo } from '@ember-data/model';
+   export default Model.extend({
+      user: belongsTo({ async: true })
+    });
+
+   let blog = store.push({
+      data: {
+        type: 'blog',
+        id: 1,
+        relationships: {
+          user: {
+            links: {
+              related: '/articles/1/author'
+            }
+          }
+        }
+      }
+    });
+   let userRef = blog.belongsTo('user');
+
+   // get the identifier of the reference
+   if (userRef.remoteType() === "link") {
+      let link = userRef.link();
+    }
+   ```
+
+   @method link
+   @public
+   @return {String} The link Ember Data will use to fetch or reload this belongs-to relationship.
+   */
+  link(): string | null {
+    let resource = this._resource();
+
+    if (isResourceIdentiferWithRelatedLinks(resource)) {
+      if (resource.links) {
+        let related = resource.links.related;
+        return !related || typeof related === 'string' ? related : related.href;
+      }
+    }
+    return null;
+  }
+
+  /**
+   * any links that have been received for this relationship
+   *
+   * @method links
+   * @public
+   * @returns
+   */
+  links(): Links | null {
+    let resource = this._resource();
+
+    return resource && resource.links ? resource.links : null;
+  }
+
+  /**
+   The meta data for the belongs-to relationship.
+
+   Example
+
+   ```javascript
+   // models/blog.js
+   import Model, { belongsTo } from '@ember-data/model';
+   export default Model.extend({
+      user: belongsTo({ async: true })
+    });
+
+   let blog = store.push({
+      data: {
+        type: 'blog',
+        id: 1,
+        relationships: {
+          user: {
+            links: {
+              related: {
+                href: '/articles/1/author'
+              },
+            },
+            meta: {
+              lastUpdated: 1458014400000
+            }
+          }
+        }
+      }
+    });
+
+   let userRef = blog.belongsTo('user');
+
+   userRef.meta() // { lastUpdated: 1458014400000 }
+   ```
+
+   @method meta
+    @public
+   @return {Object} The meta information for the belongs-to relationship.
+   */
+  meta() {
+    let meta: Dict<JSONValue> | null = null;
+    let resource = this._resource();
+    if (resource && resource.meta && typeof resource.meta === 'object') {
+      meta = resource.meta;
+    }
+    return meta;
+  }
+
+  _resource() {
+    return this.store._instanceCache.recordDataFor(this.#identifier, false).getBelongsTo(this.key);
+  }
+
+  /**
+   This returns a string that represents how the reference will be
+   looked up when it is loaded. If the relationship has a link it will
+   use the "link" otherwise it defaults to "id".
+
+   Example
+
+   ```app/models/post.js
+   import Model, { hasMany } from '@ember-data/model';
+
+   export default class PostModel extends Model {
+     @hasMany({ async: true }) comments;
+   }
+   ```
+
+   ```javascript
+   let post = store.push({
+     data: {
+       type: 'post',
+       id: 1,
+       relationships: {
+         comments: {
+           data: [{ type: 'comment', id: 1 }]
+         }
+       }
+     }
+   });
+
+   let commentsRef = post.hasMany('comments');
+
+   // get the identifier of the reference
+   if (commentsRef.remoteType() === "ids") {
+     let ids = commentsRef.ids();
+   } else if (commentsRef.remoteType() === "link") {
+     let link = commentsRef.link();
+   }
+   ```
+
+   @method remoteType
+   @public
+   @return {String} The name of the remote type. This should either be `link` or `id`
+   */
+  remoteType(): 'link' | 'id' {
+    let value = this._resource();
+    if (isResourceIdentiferWithRelatedLinks(value)) {
+      return 'link';
+    }
+    return 'id';
+  }
+
+  /**
+   `push` can be used to update the data in the relationship and Ember
+   Data will treat the new data as the canonical value of this
+   relationship on the backend.
+
+   Example
+
+   ```app/models/blog.js
+   import Model, { belongsTo } from '@ember-data/model';
+
+   export default class BlogModel extends Model {
+      @belongsTo({ async: true }) user;
+    }
+
+   let blog = store.push({
+      data: {
+        type: 'blog',
+        id: 1,
+        relationships: {
+          user: {
+            data: { type: 'user', id: 1 }
+          }
+        }
+      }
+    });
+   let userRef = blog.belongsTo('user');
+
+   // provide data for reference
+   userRef.push({
+      data: {
+        type: 'user',
+        id: 1,
+        attributes: {
+          username: "@user"
+        }
+      }
+    }).then(function(user) {
+      userRef.value() === user;
+    });
+   ```
+
+   @method push
+    @public
+   @param {Object|Promise} objectOrPromise a promise that resolves to a JSONAPI document object describing the new value of this relationship.
+   @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 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
+    );
+
+    const { graph, identifier } = this.belongsToRelationship;
+    this.store._backburner.join(() => {
+      graph.push({
+        op: 'replaceRelatedRecord',
+        record: identifier,
+        field: this.key,
+        value: recordIdentifierFor(record),
+      });
+    });
+
+    return record;
+  }
+
+  /**
+   `value()` synchronously returns the current value of the belongs-to
+   relationship. Unlike `record.get('relationshipName')`, calling
+   `value()` on a reference does not trigger a fetch if the async
+   relationship is not yet loaded. If the relationship is not loaded
+   it will always return `null`.
+
+   Example
+
+   ```javascript
+   // models/blog.js
+   import Model, { belongsTo } from '@ember-data/model';
+
+   export default class BlogModel extends Model {
+     @belongsTo({ async: true }) user;
+   }
+
+   let blog = store.push({
+      data: {
+        type: 'blog',
+        id: 1,
+        relationships: {
+          user: {
+            data: { type: 'user', id: 1 }
+          }
+        }
+      }
+    });
+   let userRef = blog.belongsTo('user');
+
+   userRef.value(); // null
+
+   // provide data for reference
+   userRef.push({
+      data: {
+        type: 'user',
+        id: 1,
+        attributes: {
+          username: "@user"
+        }
+      }
+    }).then(function(user) {
+      userRef.value(); // user
+    });
+   ```
+
+   @method value
+    @public
+   @return {Model} the record in this relationship
+   */
+  value(): RecordInstance | null {
+    let resource = this._resource();
+    return resource && resource.data ? this.store.peekRecord(resource.data) : null;
+  }
+
+  /**
+   Loads a record in a belongs-to relationship if it is not already
+   loaded. If the relationship is already loaded this method does not
+   trigger a new load.
+
+   Example
+
+   ```javascript
+   // models/blog.js
+   import Model, { belongsTo } from '@ember-data/model';
+
+   export default class BlogModel extends Model {
+     @belongsTo({ async: true }) user;
+   }
+
+   let blog = store.push({
+      data: {
+        type: 'blog',
+        id: 1,
+        relationships: {
+          user: {
+            data: { type: 'user', id: 1 }
+          }
+        }
+      }
+    });
+   let userRef = blog.belongsTo('user');
+
+   userRef.value(); // null
+
+   userRef.load().then(function(user) {
+      userRef.value() === user
+    });
+   ```
+
+   You may also pass in an options object whose properties will be
+   fed forward. This enables you to pass `adapterOptions` into the
+   request given to the adapter via the reference.
+
+   Example
+
+   ```javascript
+   userRef.load({ adapterOptions: { isPrivate: true } }).then(function(user) {
+     userRef.value() === user;
+   });
+   ```
+   ```app/adapters/user.js
+   import Adapter from '@ember-data/adapter';
+
+   export default class UserAdapter extends Adapter {
+     findRecord(store, type, id, snapshot) {
+       // In the adapter you will have access to adapterOptions.
+       let adapterOptions = snapshot.adapterOptions;
+     }
+   });
+   ```
+
+   @method load
+    @public
+   @param {Object} options the options to pass in.
+   @return {Promise} a promise that resolves with the record in this belongs-to relationship.
+   */
+  load(options?: Dict<unknown>) {
+    const support: LegacySupport = (
+      LEGACY_SUPPORT as DebugWeakCache<StableRecordIdentifier, LegacySupport>
+    ).getWithError(this.#identifier);
+    return support.getBelongsTo(this.key, options);
+  }
+
+  /**
+   Triggers a reload of the value in this relationship. If the
+   remoteType is `"link"` Ember Data will use the relationship link to
+   reload the relationship. Otherwise it will reload the record by its
+   id.
+
+   Example
+
+   ```javascript
+   // models/blog.js
+   import Model, { belongsTo } from '@ember-data/model';
+
+   export default class BlogModel extends Model {
+     @belongsTo({ async: true }) user;
+   }
+
+   let blog = store.push({
+      data: {
+        type: 'blog',
+        id: 1,
+        relationships: {
+          user: {
+            data: { type: 'user', id: 1 }
+          }
+        }
+      }
+    });
+   let userRef = blog.belongsTo('user');
+
+   userRef.reload().then(function(user) {
+      userRef.value() === user
+    });
+   ```
+
+   You may also pass in an options object whose properties will be
+   fed forward. This enables you to pass `adapterOptions` into the
+   request given to the adapter via the reference. A full example
+   can be found in the `load` method.
+
+   Example
+
+   ```javascript
+   userRef.reload({ adapterOptions: { isPrivate: true } })
+   ```
+
+   @method reload
+    @public
+   @param {Object} options the options to pass in.
+   @return {Promise} a promise that resolves with the record in this belongs-to relationship after the reload has completed.
+   */
+  reload(options?: Dict<unknown>) {
+    const support: LegacySupport = (
+      LEGACY_SUPPORT as DebugWeakCache<StableRecordIdentifier, LegacySupport>
+    ).getWithError(this.#identifier);
+    return support.reloadBelongsTo(this.key, options).then(() => this.value());
+  }
+}