@ember-data/store 4.8.0-alpha.4 → 4.8.0-beta.0

package/addon/-private/utils/uuid-polyfill.ts

@@ -1,71 +1,73 @@
 /**
   @module @ember-data/store
 */
-const isFastBoot = typeof FastBoot !== 'undefined';
-const CRYPTO: Crypto = isFastBoot ? (FastBoot.require('crypto') as Crypto) : window.crypto;
-
 interface FastbootCrypto {
   randomFillSync(v: Uint8Array): Uint8Array;
 }
 
-if (!CRYPTO.randomUUID) {
-  // we might be able to optimize this by requesting more bytes than we need at a time
-  const rng = function (): Uint8Array {
-    // WHATWG crypto RNG - http://wiki.whatwg.org/wiki/Crypto
-    let rnds8 = new Uint8Array(16);
+export default function installPolyfill() {
+  const isFastBoot = typeof FastBoot !== 'undefined';
+  const CRYPTO: Crypto = isFastBoot ? (FastBoot.require('crypto') as Crypto) : window.crypto;
 
-    if (!CRYPTO.getRandomValues && !isFastBoot) {
-      throw new Error(`Unable to generate bytes for UUID`);
-    }
+  if (!CRYPTO.randomUUID) {
+    // we might be able to optimize this by requesting more bytes than we need at a time
+    const rng = function (): Uint8Array {
+      // WHATWG crypto RNG - http://wiki.whatwg.org/wiki/Crypto
+      let rnds8 = new Uint8Array(16);
 
-    return CRYPTO.getRandomValues
-      ? CRYPTO.getRandomValues(rnds8)
-      : (CRYPTO as unknown as FastbootCrypto).randomFillSync(rnds8);
-  };
+      if (!CRYPTO.getRandomValues && !isFastBoot) {
+        throw new Error(`Unable to generate bytes for UUID`);
+      }
 
-  /*
-   * Convert array of 16 byte values to UUID string format of the form:
-   * XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
-   */
-  const byteToHex: string[] = [];
-  for (let i = 0; i < 256; ++i) {
-    byteToHex[i] = (i + 0x100).toString(16).substr(1);
-  }
+      return CRYPTO.getRandomValues
+        ? CRYPTO.getRandomValues(rnds8)
+        : (CRYPTO as unknown as FastbootCrypto).randomFillSync(rnds8);
+    };
 
-  const bytesToUuid = function (buf: Uint8Array) {
-    let bth = byteToHex;
-    // join used to fix memory issue caused by concatenation: https://bugs.chromium.org/p/v8/issues/detail?id=3175#c4
-    return [
-      bth[buf[0]],
-      bth[buf[1]],
-      bth[buf[2]],
-      bth[buf[3]],
-      '-',
-      bth[buf[4]],
-      bth[buf[5]],
-      '-',
-      bth[buf[6]],
-      bth[buf[7]],
-      '-',
-      bth[buf[8]],
-      bth[buf[9]],
-      '-',
-      bth[buf[10]],
-      bth[buf[11]],
-      bth[buf[12]],
-      bth[buf[13]],
-      bth[buf[14]],
-      bth[buf[15]],
-    ].join('');
-  };
+    /*
+     * Convert array of 16 byte values to UUID string format of the form:
+     * XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
+     */
+    const byteToHex: string[] = [];
+    for (let i = 0; i < 256; ++i) {
+      byteToHex[i] = (i + 0x100).toString(16).substr(1);
+    }
+
+    const bytesToUuid = function (buf: Uint8Array) {
+      let bth = byteToHex;
+      // join used to fix memory issue caused by concatenation: https://bugs.chromium.org/p/v8/issues/detail?id=3175#c4
+      return [
+        bth[buf[0]],
+        bth[buf[1]],
+        bth[buf[2]],
+        bth[buf[3]],
+        '-',
+        bth[buf[4]],
+        bth[buf[5]],
+        '-',
+        bth[buf[6]],
+        bth[buf[7]],
+        '-',
+        bth[buf[8]],
+        bth[buf[9]],
+        '-',
+        bth[buf[10]],
+        bth[buf[11]],
+        bth[buf[12]],
+        bth[buf[13]],
+        bth[buf[14]],
+        bth[buf[15]],
+      ].join('');
+    };
 
-  CRYPTO.randomUUID = function uuidv4(): string {
-    let rnds = rng();
+    CRYPTO.randomUUID = function uuidv4(): string {
+      let rnds = rng();
 
-    // Per 4.4, set bits for version and `clock_seq_hi_and_reserved`
-    rnds[6] = (rnds[6] & 0x0f) | 0x40;
-    rnds[8] = (rnds[8] & 0x3f) | 0x80;
+      // Per 4.4, set bits for version and `clock_seq_hi_and_reserved`
+      rnds[6] = (rnds[6] & 0x0f) | 0x40;
+      rnds[8] = (rnds[8] & 0x3f) | 0x80;
 
-    return bytesToUuid(rnds);
-  };
+      return bytesToUuid(rnds);
+    };
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ember-data/store",
-  "version": "4.8.0-alpha.4",
+  "version": "4.8.0-beta.0",
   "description": "The core of EmberData. Provides the Store service which coordinates the cache with the network and presentation layers.",
   "keywords": [
     "ember-addon"
@@ -21,8 +21,8 @@
     "start": "ember serve"
   },
   "dependencies": {
-    "@ember-data/canary-features": "4.8.0-alpha.4",
-    "@ember-data/private-build-infra": "4.8.0-alpha.4",
+    "@ember-data/canary-features": "4.8.0-beta.0",
+    "@ember-data/private-build-infra": "4.8.0-beta.0",
     "@ember/string": "^3.0.0",
     "@embroider/macros": "^1.8.3",
     "@glimmer/tracking": "^1.1.2",
@@ -33,7 +33,7 @@
     "ember-cli-typescript": "^5.1.0"
   },
   "devDependencies": {
-    "@ember-data/unpublished-test-infra": "4.8.0-alpha.4",
+    "@ember-data/unpublished-test-infra": "4.8.0-beta.0",
     "@ember/optional-features": "^2.0.0",
     "@ember/test-helpers": "~2.7.0",
     "@types/ember": "^4.0.1",
@@ -66,7 +66,7 @@
     "configPath": "tests/dummy/config"
   },
   "volta": {
-    "node": "16.16.0",
+    "node": "16.17.0",
     "yarn": "1.22.19"
   }
 }

package/addon/-private/backburner.js

@@ -1,25 +0,0 @@
-/**
-  @module @ember-data/store
-*/
-
-import { registerWaiter } from '@ember/test';
-import { DEBUG } from '@glimmer/env';
-import Ember from 'ember';
-
-// TODO: expose Ember._Backburner as `import { _Backburner } from '@ember/runloop'` in ember-rfc176-data + emberjs/ember.js
-/*
-  syncRelationships is used by the UI to grab updates from the graph
-  and update the ManyArrays.
-
-  We may be able to remove this once the new relationship layer is
-  complete.
-*/
-const backburner = new Ember._Backburner(['coalesce', 'sync', 'notify']);
-
-if (DEBUG) {
-  registerWaiter(() => {
-    return !backburner.currentInstance && !backburner.hasTimers();
-  });
-}
-
-export default backburner;

package/addon/-private/record-arrays/adapter-populated-record-array.ts

@@ -1,128 +0,0 @@
-import type NativeArray from '@ember/array/-private/native-array';
-import { assert } from '@ember/debug';
-
-import type { CollectionResourceDocument, Links, Meta, PaginationLinks } 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 { FindOptions } from '@ember-data/types/q/store';
-import type { Dict } from '@ember-data/types/q/utils';
-
-import type RecordArrayManager from '../managers/record-array-manager';
-import SnapshotRecordArray from '../network/snapshot-record-array';
-import type { PromiseArray } from '../proxies/promise-proxies';
-import { promiseArray } from '../proxies/promise-proxies';
-import type Store from '../store-service';
-import RecordArray from './record-array';
-
-export interface AdapterPopulatedRecordArrayCreateArgs {
-  modelName: string;
-  store: Store;
-  manager: RecordArrayManager;
-  content: NativeArray<StableRecordIdentifier>;
-  isLoaded: boolean;
-  query?: Dict<unknown>;
-  meta?: Meta;
-  links?: Links | PaginationLinks | null;
-}
-
-/**
-  @module @ember-data/store
-*/
-
-/**
-  Represents an ordered list of records whose order and membership is
-  determined by the adapter. For example, a query sent to the adapter
-  may trigger a search on the server, whose results would be loaded
-  into an instance of the `AdapterPopulatedRecordArray`.
-
-  This class should not be imported and instantiated by consuming applications.
-
-  ---
-
-  If you want to update the array and get the latest records from the
-  adapter, you can invoke [`update()`](AdapterPopulatedRecordArray/methods/update?anchor=update):
-
-  Example
-
-  ```javascript
-  // GET /users?isAdmin=true
-  store.query('user', { isAdmin: true }).then(function(admins) {
-
-    admins.get("length"); // 42
-
-    // somewhere later in the app code, when new admins have been created
-    // in the meantime
-    //
-    // GET /users?isAdmin=true
-    admins.update().then(function() {
-      admins.isUpdating; // false
-      admins.get("length"); // 123
-    });
-
-    admins.isUpdating; // true
-  }
-  ```
-
-  @class AdapterPopulatedRecordArray
-  @public
-  @extends RecordArray
-*/
-export default class AdapterPopulatedRecordArray extends RecordArray {
-  declare links: Links | PaginationLinks | null;
-  declare meta: Dict<unknown> | null;
-  declare query: Dict<unknown> | null;
-
-  init(props?: AdapterPopulatedRecordArrayCreateArgs) {
-    assert(`Cannot initialize AdapterPopulatedRecordArray with isUpdating`, !props || !('isUpdating' in props));
-    super.init();
-    this.query = this.query || null;
-    this.links = this.links || null;
-    this.meta = this.meta || null;
-  }
-
-  replace() {
-    throw new Error(`The result of a server query (on ${this.modelName}) is immutable.`);
-  }
-
-  _update(): PromiseArray<RecordInstance, AdapterPopulatedRecordArray> {
-    const { store, query } = this;
-
-    // TODO save options from initial request?
-    return promiseArray(store.query(this.modelName, query, { _recordArray: this }));
-  }
-
-  _setObjects(identifiers: StableRecordIdentifier[], payload: CollectionResourceDocument) {
-    // TODO: initial load should not cause change events at all, only
-    // subsequent. This requires changing the public api of adapter.query, but
-    // hopefully we can do that soon.
-    this.content.setObjects(identifiers);
-
-    this.setProperties({
-      isLoaded: true,
-      isUpdating: false,
-      // TODO this assign kills the root reference but a deep-copy would be required
-      // for both meta and links to actually not be by-ref. We whould likely change
-      // this to a dev-only deep-freeze.
-      meta: Object.assign({}, payload.meta),
-      links: Object.assign({}, payload.links),
-    });
-
-    this.manager._associateWithRecordArray(identifiers, this);
-  }
-
-  _createSnapshot(options: FindOptions) {
-    // this is private for users, but public for ember-data internals
-    // meta will only be present for an AdapterPopulatedRecordArray
-    return new SnapshotRecordArray(this, this.meta, options);
-  }
-
-  /**
-    @method _setIdentifiers
-    @param {StableRecordIdentifier[]} identifiers
-    @param {Object} payload normalized payload
-    @private
-  */
-  _setIdentifiers(identifiers: StableRecordIdentifier[], payload: CollectionResourceDocument): void {
-    this._setObjects(identifiers, payload);
-  }
-}

package/addon/-private/record-arrays/record-array.ts

@@ -1,328 +0,0 @@
-/**
-  @module @ember-data/store
-*/
-import type NativeArray from '@ember/array/-private/native-array';
-import ArrayProxy from '@ember/array/proxy';
-import { assert, deprecate } from '@ember/debug';
-import { set } from '@ember/object';
-import { tracked } from '@glimmer/tracking';
-
-import { Promise } from 'rsvp';
-
-import type { RecordArrayManager, Snapshot } from 'ember-data/-private';
-
-import { DEPRECATE_SNAPSHOT_MODEL_CLASS_ACCESS } from '@ember-data/private-build-infra/deprecations';
-import type { StableRecordIdentifier } from '@ember-data/types/q/identifier';
-import type { RecordInstance } from '@ember-data/types/q/record-instance';
-import type { FindOptions } from '@ember-data/types/q/store';
-
-import SnapshotRecordArray from '../network/snapshot-record-array';
-import type { PromiseArray } from '../proxies/promise-proxies';
-import { promiseArray } from '../proxies/promise-proxies';
-import type Store from '../store-service';
-
-function recordForIdentifier(store: Store, identifier: StableRecordIdentifier): RecordInstance {
-  return store._instanceCache.getRecord(identifier);
-}
-
-export interface RecordArrayCreateArgs {
-  modelName: string;
-  store: Store;
-  manager: RecordArrayManager;
-  content: NativeArray<StableRecordIdentifier>;
-  isLoaded: boolean;
-}
-
-/**
-  A record array is an array that contains records of a certain modelName. The record
-  array materializes records as needed when they are retrieved for the first
-  time. You should not create record arrays yourself. Instead, an instance of
-  `RecordArray` or its subclasses will be returned by your application's store
-  in response to queries.
-
-  This class should not be imported and instantiated by consuming applications.
-
-  @class RecordArray
-  @public
-  @extends Ember.ArrayProxy
-*/
-export default class RecordArray extends ArrayProxy<StableRecordIdentifier, RecordInstance> {
-  /**
-    The array of client ids backing the record array. When a
-    record is requested from the record array, the record
-    for the client id at the same index is materialized, if
-    necessary, by the store.
-
-    @property content
-    @private
-    @type Ember.Array
-  */
-  declare content: NativeArray<StableRecordIdentifier>;
-  declare _getDeprecatedEventedInfo: () => string;
-  declare modelName: string;
-  /**
-    The flag to signal a `RecordArray` is finished loading data.
-
-    Example
-
-    ```javascript
-    let people = store.peekAll('person');
-    people.isLoaded; // true
-    ```
-
-    @property isLoaded
-    @public
-    @type Boolean
-  */
-  declare isLoaded: boolean;
-  /**
-    The store that created this record array.
-
-    @property store
-    @private
-    @type Store
-    */
-  declare store: Store;
-  declare _updatingPromise: PromiseArray<RecordInstance, RecordArray> | null;
-  declare manager: RecordArrayManager;
-
-  /**
-    The flag to signal a `RecordArray` is currently loading data.
-    Example
-    ```javascript
-    let people = store.peekAll('person');
-    people.isUpdating; // false
-    people.update();
-    people.isUpdating; // true
-    ```
-    @property isUpdating
-    @public
-    @type Boolean
-  */
-  @tracked isUpdating: boolean = false;
-
-  init(props?: RecordArrayCreateArgs) {
-    assert(`Cannot initialize RecordArray with isUpdating`, !props || !('isUpdating' in props));
-    assert(`Cannot initialize RecordArray with isUpdating`, !props || !('_updatingPromise' in props));
-    super.init();
-
-    // TODO can we get rid of this?
-    this.content = this.content || null;
-    this._updatingPromise = null;
-  }
-
-  replace() {
-    throw new Error(
-      `The result of a server query (for all ${this.modelName} types) is immutable. To modify contents, use toArray()`
-    );
-  }
-
-  /**
-   The modelClass represented by this record array.
-
-   @property type
-    @public
-    @deprecated
-   @type {subclass of Model}
-   */
-
-  /**
-    Retrieves an object from the content by index.
-
-    @method objectAtContent
-    @private
-    @param {Number} index
-    @return {Model} record
-  */
-  objectAtContent(index: number): RecordInstance | undefined {
-    let identifier = this.content.objectAt(index);
-    return identifier ? recordForIdentifier(this.store, identifier) : undefined;
-  }
-
-  /**
-    Used to get the latest version of all of the records in this array
-    from the adapter.
-
-    Example
-
-    ```javascript
-    let people = store.peekAll('person');
-    people.isUpdating; // false
-
-    people.update().then(function() {
-      people.isUpdating; // false
-    });
-
-    people.isUpdating; // true
-    ```
-
-    @method update
-    @public
-  */
-  update(): PromiseArray<RecordInstance, RecordArray> {
-    if (this.isUpdating) {
-      return this._updatingPromise!;
-    }
-
-    this.isUpdating = true;
-
-    let updatingPromise = this._update();
-    updatingPromise.finally(() => {
-      this._updatingPromise = null;
-      if (this.isDestroying || this.isDestroyed) {
-        return;
-      }
-      this.isUpdating = false;
-    });
-
-    this._updatingPromise = updatingPromise;
-
-    return updatingPromise;
-  }
-
-  /*
-    Update this RecordArray and return a promise which resolves once the update
-    is finished.
-   */
-  _update(): PromiseArray<RecordInstance, RecordArray> {
-    return this.store.findAll(this.modelName, { reload: true });
-  }
-
-  /**
-    Saves all of the records in the `RecordArray`.
-
-    Example
-
-    ```javascript
-    let messages = store.peekAll('message');
-    messages.forEach(function(message) {
-      message.hasBeenSeen = true;
-    });
-    messages.save();
-    ```
-
-    @method save
-    @public
-    @return {PromiseArray} promise
-  */
-  save(): PromiseArray<RecordInstance, RecordArray> {
-    let promiseLabel = `DS: RecordArray#save ${this.modelName}`;
-    let promise = Promise.all(this.invoke('save'), promiseLabel).then(
-      () => this,
-      null,
-      'DS: RecordArray#save return RecordArray'
-    );
-
-    return promiseArray<RecordInstance, RecordArray>(promise);
-  }
-
-  /**
-    @method _unregisterFromManager
-    @internal
-  */
-  _unregisterFromManager() {
-    this.manager.unregisterRecordArray(this);
-  }
-
-  willDestroy() {
-    this._unregisterFromManager();
-    this._dissociateFromOwnRecords();
-    // TODO: we should not do work during destroy:
-    //   * when objects are destroyed, they should simply be left to do
-    //   * if logic errors do to this, that logic needs to be more careful during
-    //    teardown (ember provides isDestroying/isDestroyed) for this reason
-    //   * the exception being: if an dominator has a reference to this object,
-    //     and must be informed to release e.g. e.g. removing itself from th
-    //     recordArrayMananger
-    // TODO we have to use set here vs dot notation because computed properties don't clear
-    // otherwise for destroyed records and will not update their value.
-    set(this, 'content', null as unknown as NativeArray<StableRecordIdentifier>);
-    set(this, 'length', 0);
-    super.willDestroy();
-  }
-
-  /**
-    @method _createSnapshot
-    @private
-  */
-  _createSnapshot(options: FindOptions) {
-    // this is private for users, but public for ember-data internals
-    // meta will only be present for an AdapterPopulatedRecordArray
-    return new SnapshotRecordArray(this, null, options);
-  }
-
-  /**
-    @method _dissociateFromOwnRecords
-    @internal
-  */
-  _dissociateFromOwnRecords() {
-    this.content.forEach((identifier) => {
-      let recordArrays = this.manager.getRecordArraysForIdentifier(identifier);
-
-      if (recordArrays) {
-        recordArrays.delete(this);
-      }
-    });
-  }
-
-  /**
-    Adds identifiers to the `RecordArray` without duplicates
-
-    @method _pushIdentifiers
-    @internal
-    @param {StableRecordIdentifier[]} identifiers
-  */
-  _pushIdentifiers(identifiers: StableRecordIdentifier[]): void {
-    this.content.pushObjects(identifiers);
-  }
-
-  /**
-    Removes identifiers from the `RecordArray`.
-
-    @method _removeIdentifiers
-    @internal
-    @param {StableRecordIdentifier[]} identifiers
-  */
-  _removeIdentifiers(identifiers: StableRecordIdentifier[]): void {
-    // if we are unloading all there's no point in an expensive diff
-    // and traversal.
-    if (identifiers.length === this.content.length) {
-      this.content.clear();
-    } else {
-      // TODO This is horribly innefficient, we should refactor RecordArray
-      // to be a native class of our own.
-      this.content.removeObjects(identifiers);
-    }
-  }
-
-  /**
-    @method _takeSnapshot
-    @internal
-  */
-  _takeSnapshot(): Snapshot[] {
-    return this.content.map((identifier) => this.store._instanceCache.createSnapshot(identifier));
-  }
-}
-
-if (DEPRECATE_SNAPSHOT_MODEL_CLASS_ACCESS) {
-  Object.defineProperty(RecordArray.prototype, 'type', {
-    get() {
-      deprecate(
-        `Using RecordArray.type to access the ModelClass for a record is deprecated. Use store.modelFor(<modelName>) instead.`,
-        false,
-        {
-          id: 'ember-data:deprecate-snapshot-model-class-access',
-          until: '5.0',
-          for: 'ember-data',
-          since: { available: '4.5.0', enabled: '4.5.0' },
-        }
-      );
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-      if (!this.modelName) {
-        return null;
-      }
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-return, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
-      return this.store.modelFor(this.modelName);
-    },
-  });
-}