@ember-data/store 3.28.10 → 3.28.11

package/addon/-private/system/core-store.ts

@@ -2500,6 +2500,7 @@ abstract class CoreStore extends Service {
     const factory = internalModelFactoryFor(this);
 
     if (modelName === undefined) {
+      this._notificationManager.destroy();
       factory.clear();
     } else {
       let normalizedModelName = normalizeModelName(modelName);

package/addon/-private/system/record-notification-manager.ts

@@ -1,13 +1,16 @@
-import { identifierCacheFor } from '../identifiers/cache';
+import { assert } from '@ember/debug';
+import { DEBUG } from '@glimmer/env';
+
+import isStableIdentifier from '../identifiers/is-stable-identifier';
 
 type CoreStore = import('./core-store').default;
-type RecordIdentifier = import('../ts-interfaces/identifier').RecordIdentifier;
 type StableRecordIdentifier = import('../ts-interfaces/identifier').StableRecordIdentifier;
 
-type UnsubscribeToken = Object;
+type UnsubscribeToken = object;
+let tokenId = 0;
 
-const Cache = new WeakMap<StableRecordIdentifier, Map<UnsubscribeToken, NotificationCallback>>();
-const Tokens = new WeakMap<UnsubscribeToken, StableRecordIdentifier>();
+const Cache = new Map<StableRecordIdentifier, Map<UnsubscribeToken, NotificationCallback>>();
+const Tokens = new Map<UnsubscribeToken, StableRecordIdentifier>();
 
 export type NotificationType =
   | 'attributes'
@@ -20,50 +23,73 @@ export type NotificationType =
   | 'property'; // 'property' is an internal EmberData only transition period concept.
 
 export interface NotificationCallback {
-  (identifier: RecordIdentifier, notificationType: 'attributes' | 'relationships' | 'property', key?: string): void;
-  (identifier: RecordIdentifier, notificationType: 'errors' | 'meta' | 'identity' | 'unload' | 'state'): void;
+  (identifier: StableRecordIdentifier, notificationType: 'attributes' | 'relationships', key?: string): void;
+  (identifier: StableRecordIdentifier, notificationType: 'errors' | 'meta' | 'identity' | 'state'): void;
   (identifier: StableRecordIdentifier, notificationType: NotificationType, key?: string): void;
 }
 
+// TODO this isn't importable anyway, remove and use a map on the manager?
 export function unsubscribe(token: UnsubscribeToken) {
   let identifier = Tokens.get(token);
-  if (!identifier) {
-    throw new Error('Passed unknown unsubscribe token to unsubscribe');
+
+  if (identifier) {
+    Tokens.delete(token);
+    const map = Cache.get(identifier);
+    map?.delete(token);
   }
-  Tokens.delete(token);
-  const map = Cache.get(identifier);
-  map?.delete(token);
 }
 /*
   Currently only support a single callback per identifier
 */
 export default class NotificationManager {
-  constructor(private store: CoreStore) {}
+  declare store: CoreStore;
+  constructor(store: CoreStore) {
+    this.store = store;
+  }
 
-  subscribe(identifier: RecordIdentifier, callback: NotificationCallback): UnsubscribeToken {
-    let stableIdentifier = identifierCacheFor(this.store).getOrCreateRecordIdentifier(identifier);
-    let map = Cache.get(stableIdentifier);
-    if (map === undefined) {
+  subscribe(identifier: StableRecordIdentifier, callback: NotificationCallback): UnsubscribeToken {
+    assert(`Expected to receive a stable Identifier to subscribe to`, isStableIdentifier(identifier));
+    let map = Cache.get(identifier);
+
+    if (!map) {
       map = new Map();
-      Cache.set(stableIdentifier, map);
+      Cache.set(identifier, map);
     }
-    let unsubToken = {};
+
+    let unsubToken = DEBUG ? { _tokenRef: tokenId++ } : {};
     map.set(unsubToken, callback);
-    Tokens.set(unsubToken, stableIdentifier);
+    Tokens.set(unsubToken, identifier);
     return unsubToken;
   }
 
-  notify(identifier: RecordIdentifier, value: 'attributes' | 'relationships' | 'property', key?: string): boolean;
-  notify(identifier: RecordIdentifier, value: 'errors' | 'meta' | 'identity' | 'unload' | 'state'): boolean;
-  notify(identifier: RecordIdentifier, value: NotificationType, key?: string): boolean {
-    let stableIdentifier = identifierCacheFor(this.store).getOrCreateRecordIdentifier(identifier);
-    let callbackMap = Cache.get(stableIdentifier);
+  unsubscribe(token: UnsubscribeToken) {
+    unsubscribe(token);
+  }
+
+  // deactivated type signature overloads because pass-through was failing to match any. Bring back if possible.
+  // notify(identifier: StableRecordIdentifier, value: 'attributes' | 'relationships', key?: string): boolean;
+  // notify(identifier: StableRecordIdentifier, value: 'errors' | 'meta' | 'identity' | 'state'): boolean;
+  notify(identifier: StableRecordIdentifier, value: NotificationType, key?: string): boolean {
+    assert(
+      `Notify does not accept a key argument for the namespace '${value}'. Received key '${key}'.`,
+      !key || value === 'attributes' || value === 'relationships'
+    );
+    if (!isStableIdentifier(identifier)) {
+      return false;
+    }
+
+    let callbackMap = Cache.get(identifier);
     if (!callbackMap || !callbackMap.size) {
       return false;
     }
     callbackMap.forEach((cb) => {
-      cb(stableIdentifier, value, key);
+      cb(identifier, value, key);
     });
     return true;
   }
+
+  destroy() {
+    Tokens.clear();
+    Cache.clear();
+  }
 }

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

@@ -40,8 +40,8 @@ export default class BelongsToReference extends Reference {
   declare parentIdentifier: StableRecordIdentifier;
 
   // unsubscribe tokens given to us by the notification manager
-  #token!: Object;
-  #relatedToken: Object | null = null;
+  #token!: object;
+  #relatedToken: object | null = null;
 
   @tracked _ref = 0;
 
@@ -76,8 +76,10 @@ export default class BelongsToReference extends Reference {
   destroy() {
     if (CUSTOM_MODEL_CLASS) {
       unsubscribe(this.#token);
+      this.#token = null as unknown as object;
       if (this.#relatedToken) {
         unsubscribe(this.#relatedToken);
+        this.#relatedToken = null;
       }
     }
   }
@@ -88,6 +90,7 @@ export default class BelongsToReference extends Reference {
     this._ref; // consume the tracked prop
     if (this.#relatedToken) {
       unsubscribe(this.#relatedToken);
+      this.#relatedToken = null;
     }
 
     let resource = this._resource();

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

@@ -76,6 +76,7 @@ export default class HasManyReference extends Reference {
   destroy() {
     if (CUSTOM_MODEL_CLASS) {
       unsubscribe(this.#token);
+      this.#token = null as unknown as object;
       this.#relatedTokenMap.forEach((token) => {
         unsubscribe(token);
       });
@@ -90,22 +91,30 @@ export default class HasManyReference extends Reference {
 
     let resource = this._resource();
 
-    this.#relatedTokenMap.forEach((token) => {
-      unsubscribe(token);
-    });
-    this.#relatedTokenMap.clear();
+    let map = this.#relatedTokenMap;
+    this.#relatedTokenMap = new Map();
 
     if (resource && resource.data) {
       return resource.data.map((resourceIdentifier) => {
         const identifier = this.store.identifierCache.getOrCreateRecordIdentifier(resourceIdentifier);
-        const token = this.store._notificationManager.subscribe(
-          identifier,
-          (_: StableRecordIdentifier, bucket: NotificationType, notifiedKey?: string) => {
-            if (bucket === 'identity' || ((bucket === 'attributes' || bucket === 'property') && notifiedKey === 'id')) {
-              this._ref++;
+
+        let token = map.get(identifier);
+
+        if (token) {
+          map.delete(identifier);
+        } else {
+          token = this.store._notificationManager.subscribe(
+            identifier,
+            (_: StableRecordIdentifier, bucket: NotificationType, notifiedKey?: string) => {
+              if (
+                bucket === 'identity' ||
+                ((bucket === 'attributes' || bucket === 'property') && notifiedKey === 'id')
+              ) {
+                this._ref++;
+              }
             }
-          }
-        );
+          );
+        }
 
         this.#relatedTokenMap.set(identifier, token);
 
@@ -113,6 +122,11 @@ export default class HasManyReference extends Reference {
       });
     }
 
+    map.forEach((token) => {
+      this.store._notificationManager.unsubscribe(token);
+    });
+    map.clear();
+
     return [];
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ember-data/store",
-  "version": "3.28.10",
+  "version": "3.28.11",
   "description": "The default blueprint for ember-cli addons.",
   "keywords": [
     "ember-addon"
@@ -17,8 +17,8 @@
     "start": "ember serve"
   },
   "dependencies": {
-    "@ember-data/canary-features": "3.28.10",
-    "@ember-data/private-build-infra": "3.28.10",
+    "@ember-data/canary-features": "3.28.11",
+    "@ember-data/private-build-infra": "3.28.11",
     "@ember/string": "^3.0.0",
     "@glimmer/tracking": "^1.0.4",
     "ember-cached-decorator-polyfill": "^0.1.4",
@@ -27,7 +27,7 @@
     "ember-cli-typescript": "^4.1.0"
   },
   "devDependencies": {
-    "@ember-data/unpublished-test-infra": "3.28.10",
+    "@ember-data/unpublished-test-infra": "3.28.11",
     "@ember/optional-features": "^2.0.0",
     "@ember/test-helpers": "^2.2.5",
     "@types/ember": "^3.16.5",