@ember-data/store 5.4.0-alpha.152 → 5.4.0-alpha.153

package/dist/-private.js

@@ -1 +1 @@
-export { A as ARRAY_SIGNAL, C as CacheHandler, j as CollectionRecordArray, I as LiveArray, M as MUTATE, R as RecordArrayManager, v as RelatedCollection, k as SOURCE, S as Store, q as StoreMap, _ as _clearCaches, u as _deprecatingNormalize, g as coerceId, f as constructResource, h as ensureStringId, l as fastPush, i as isStableIdentifier, w as log, x as logGroup, n as notifyArray, p as peekCache, r as recordIdentifierFor, m as removeRecordDataFor, t as setCacheFor, o as setRecordIdentifier, s as storeFor } from "./many-array-uP6jS6_J.js";
+export { A as ARRAY_SIGNAL, C as CacheHandler, j as CollectionRecordArray, I as LiveArray, M as MUTATE, R as RecordArrayManager, v as RelatedCollection, k as SOURCE, S as Store, q as StoreMap, _ as _clearCaches, u as _deprecatingNormalize, g as coerceId, f as constructResource, h as ensureStringId, l as fastPush, i as isStableIdentifier, w as log, x as logGroup, n as notifyArray, p as peekCache, r as recordIdentifierFor, m as removeRecordDataFor, t as setCacheFor, o as setRecordIdentifier, s as storeFor } from "./many-array-BBvney_-.js";

package/dist/index.js

@@ -1,4 +1,4 @@
-export { C as CacheHandler, S as default, r as recordIdentifierFor, c as setIdentifierForgetMethod, a as setIdentifierGenerationMethod, d as setIdentifierResetMethod, b as setIdentifierUpdateMethod, e as setKeyInfoForResource, s as storeFor } from "./many-array-uP6jS6_J.js";
+export { C as CacheHandler, S as default, r as recordIdentifierFor, c as setIdentifierForgetMethod, a as setIdentifierGenerationMethod, d as setIdentifierResetMethod, b as setIdentifierUpdateMethod, e as setKeyInfoForResource, s as storeFor } from "./many-array-BBvney_-.js";
 import '@ember/debug';
 import '@embroider/macros';
 import '@ember-data/request-utils/string';

package/dist/{many-array-uP6jS6_J.js → many-array-BBvney_-.js}

@@ -4,7 +4,7 @@ import { EnableHydration, SkipCache } from '@warp-drive/core-types/request';
 import { setLogging, getRuntimeConfig } from '@warp-drive/core-types/runtime';
 import { getOrSetGlobal, peekTransient, setTransient } from '@warp-drive/core-types/-private';
 import { _backburner } from '@ember/runloop';
-import { defineSignal, createSignal, subscribe, createArrayTags, addToTransaction, addTransactionCB } from '@ember-data/tracking/-private';
+import { defineSignal, createSignal, subscribe, createArrayTags, addToTransaction, addTransactionCB, defineSubscription, notifySignal } from '@ember-data/tracking/-private';
 import { CACHE_OWNER, DEBUG_STALE_CACHE_OWNER, DEBUG_IDENTIFIER_BUCKET, DEBUG_CLIENT_ORIGINATED } from '@warp-drive/core-types/identifier';
 import { dasherize } from '@ember-data/request-utils/string';
 import { compat } from '@ember-data/tracking';
@@ -2678,6 +2678,7 @@ class IdentifierArray {
   isDestroying = false;
   isDestroyed = false;
   _updatingPromise = null;
+  identifier;
   [IS_COLLECTION] = true;
   [SOURCE];
   [NOTIFY]() {
@@ -2716,6 +2717,7 @@ class IdentifierArray {
     this.modelName = options.type;
     this.store = options.store;
     this._manager = options.manager;
+    this.identifier = options.identifier || null;
     this[SOURCE] = options.identifiers;
     this[ARRAY_SIGNAL] = createSignal(this, 'length');
     const store = options.store;
@@ -3172,6 +3174,12 @@ class RecordArrayManager {
     this._identifiers = new Map();
     this._set = new Map();
     this._visibilitySet = new Map();
+    this._subscription = this.store.notifications.subscribe('document', (identifier, type) => {
+      if (type === 'updated' && this._keyedArrays.has(identifier.lid)) {
+        const array = this._keyedArrays.get(identifier.lid);
+        this.dirtyArray(array, 0, true);
+      }
+    });
     this._subscription = this.store.notifications.subscribe('resource', (identifier, type) => {
       if (type === 'added') {
         this._visibilitySet.set(identifier, true);
@@ -3186,11 +3194,35 @@ class RecordArrayManager {
   }
   _syncArray(array) {
     const pending = this._pending.get(array);
-    if (!pending || this.isDestroying || this.isDestroyed) {
+    const isRequestArray = isCollection(array);
+    if (!isRequestArray && !pending || this.isDestroying || this.isDestroyed) {
       return;
     }
-    sync(array, pending, this._set.get(array));
-    this._pending.delete(array);
+
+    // first flush any staged changes
+    if (pending) {
+      sync(array, pending, this._set.get(array));
+      this._pending.delete(array);
+    }
+
+    // then pull new state if required
+    if (isRequestArray) {
+      const tag = array[ARRAY_SIGNAL];
+      if (tag.reason === 'cache-sync') {
+        tag.reason = null;
+        const doc = this.store.cache.peek(array.identifier);
+        macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+          if (!test) {
+            throw new Error(`Expected to find a document for ${array.identifier.lid} but found none`);
+          }
+        })(doc) : {};
+        const data = !('data' in doc) || !Array.isArray(doc.data) ? [] : doc.data;
+        // TODO technically we should destroy here if
+        // !('data' in doc) || !Array.isArray(doc.data)
+        // is true.
+        this.populateManagedArray(array, data, null);
+      }
+    }
   }
   mutate(mutation) {
     this.store.cache.mutate(mutation);
@@ -3229,9 +3261,13 @@ class RecordArrayManager {
     }
     return array;
   }
-  createArray(config) {
+  getCollection(config) {
+    if (config.identifier && this._keyedArrays.has(config.identifier.lid)) {
+      return this._keyedArrays.get(config.identifier.lid);
+    }
     const options = {
       type: config.type,
+      identifier: config.identifier || null,
       links: config.doc?.links || null,
       meta: config.doc?.meta || null,
       query: config.query || null,
@@ -3244,16 +3280,22 @@ class RecordArrayManager {
     const array = new Collection(options);
     this._managed.add(array);
     this._set.set(array, new Set(options.identifiers || []));
+    if (config.identifier) {
+      this._keyedArrays.set(config.identifier.lid, array);
+    }
     if (config.identifiers) {
       associate(this._identifiers, array, config.identifiers);
     }
     return array;
   }
-  dirtyArray(array, delta) {
+  dirtyArray(array, delta, shouldSyncFromCache) {
     if (array === FAKE_ARR) {
       return;
     }
     const tag = array[ARRAY_SIGNAL];
+    if (shouldSyncFromCache) {
+      tag.reason = 'cache-sync';
+    }
     if (!tag.shouldReset) {
       tag.shouldReset = true;
       addTransactionCB(array[NOTIFY]);
@@ -3317,8 +3359,8 @@ class RecordArrayManager {
     fastPush(source, identifiers);
     this._set.set(array, new Set(identifiers));
     notifyArray(array);
-    array.meta = payload.meta || null;
-    array.links = payload.links || null;
+    array.meta = payload?.meta || null;
+    array.links = payload?.links || null;
     array.isLoaded = true;
     disassociate(this._identifiers, array, old);
     associate(this._identifiers, array, identifiers);
@@ -3332,7 +3374,7 @@ class RecordArrayManager {
           changes.delete(identifier);
         } else {
           changes.set(identifier, 'add');
-          this.dirtyArray(array, changes.size);
+          this.dirtyArray(array, changes.size, false);
         }
       });
     }
@@ -3346,7 +3388,7 @@ class RecordArrayManager {
           changes.delete(identifier);
         } else {
           changes.set(identifier, 'del');
-          this.dirtyArray(array, changes.size);
+          this.dirtyArray(array, changes.size, false);
         }
       });
     }
@@ -3451,6 +3493,9 @@ function sync(array, changes, arraySet) {
     */
   }
 }
+function isCollection(array) {
+  return array.identifier !== null;
+}
 
 /**
  * @module @ember-data/store
@@ -5774,9 +5819,9 @@ function urlFromLink(link) {
  * determined by the record instance itself.
  *
  * @public
- * @class Document
+ * @class ReactiveDocument
  */
-class Document {
+class ReactiveDocument {
   /**
    * The links object for this document, if any
    *
@@ -5831,10 +5876,27 @@ class Document {
    * @type {StableDocumentIdentifier|null}
    */
 
-  #store;
-  constructor(store, identifier) {
-    this.#store = store;
+  constructor(store, identifier, localCache) {
+    this._store = store;
+    this._localCache = localCache;
     this.identifier = identifier;
+
+    // TODO if we ever enable auto-cleanup of the cache, we will need to tear this down
+    // in a destroy method
+    if (identifier) {
+      store.notifications.subscribe(identifier, (_identifier, type) => {
+        switch (type) {
+          case 'updated':
+            // FIXME in the case of a collection we need to notify it's length
+            // and have it recalc
+            notifySignal(this, 'data');
+            notifySignal(this, 'links');
+            notifySignal(this, 'meta');
+            notifySignal(this, 'errors');
+            break;
+        }
+      });
+    }
   }
   async #request(link, options) {
     const href = this.links?.[link];
@@ -5845,7 +5907,7 @@ class Document {
     Object.assign(options, {
       url: urlFromLink(href)
     });
-    const response = await this.#store.request(options);
+    const response = await this._store.request(options);
     return response.content;
   }
 
@@ -5957,10 +6019,90 @@ class Document {
     return data;
   }
 }
-defineSignal(Document.prototype, 'data');
-defineSignal(Document.prototype, 'links');
-defineSignal(Document.prototype, 'errors');
-defineSignal(Document.prototype, 'meta');
+defineSubscription(ReactiveDocument.prototype, 'errors', {
+  get() {
+    const {
+      identifier
+    } = this;
+    if (!identifier) {
+      const {
+        document
+      } = this._localCache;
+      if ('errors' in document) {
+        return document.errors;
+      }
+      return;
+    }
+    const doc = this._store.cache.peek(identifier);
+    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+      if (!test) {
+        throw new Error(`No cache data was found for the document '${identifier.lid}'`);
+      }
+    })(doc) : {};
+    return 'errors' in doc ? doc.errors : undefined;
+  }
+});
+defineSubscription(ReactiveDocument.prototype, 'data', {
+  get() {
+    const {
+      identifier,
+      _localCache
+    } = this;
+    const doc = identifier ? this._store.cache.peek(identifier) : _localCache.document;
+    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+      if (!test) {
+        throw new Error(`No cache data was found for the document '${identifier?.lid ?? '<uncached document>'}'`);
+      }
+    })(doc) : {};
+    const data = 'data' in doc ? doc.data : undefined;
+    if (Array.isArray(data)) {
+      return this._store.recordArrayManager.getCollection({
+        type: identifier ? identifier.lid : _localCache.request.url,
+        identifiers: data,
+        doc: identifier ? undefined : doc,
+        identifier: identifier ?? null
+      });
+    } else if (data) {
+      return this._store.peekRecord(data);
+    } else {
+      return data;
+    }
+  }
+});
+defineSubscription(ReactiveDocument.prototype, 'links', {
+  get() {
+    const {
+      identifier
+    } = this;
+    if (!identifier) {
+      return this._localCache.document.links;
+    }
+    const data = this._store.cache.peek(identifier);
+    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+      if (!test) {
+        throw new Error(`No cache data was found for the document '${identifier.lid}'`);
+      }
+    })(data) : {};
+    return data.links;
+  }
+});
+defineSubscription(ReactiveDocument.prototype, 'meta', {
+  get() {
+    const {
+      identifier
+    } = this;
+    if (!identifier) {
+      return this._localCache.document.meta;
+    }
+    const data = this._store.cache.peek(identifier);
+    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+      if (!test) {
+        throw new Error(`No cache data was found for the document '${identifier.lid}'`);
+      }
+    })(data) : {};
+    return data.meta;
+  }
+});
 const MUTATION_OPS = new Set(['createRecord', 'updateRecord', 'deleteRecord']);
 function calcShouldFetch(store, request, hasCachedValue, identifier) {
   const {
@@ -5977,17 +6119,6 @@ function calcShouldBackgroundFetch(store, request, willFetch, identifier) {
 function isMutation(request) {
   return Boolean(request.op && MUTATION_OPS.has(request.op));
 }
-function copyDocumentProperties(target, source) {
-  if ('links' in source) {
-    target.links = source.links;
-  }
-  if ('meta' in source) {
-    target.meta = source.meta;
-  }
-  if ('errors' in source) {
-    target.errors = source.errors;
-  }
-}
 function isCacheAffecting(document) {
   if (!isMutation(document.request)) {
     return true;
@@ -6015,9 +6146,6 @@ function cloneError(error) {
   Object.assign(cloned, error);
   return cloned;
 }
-function isErrorDocument(document) {
-  return 'errors' in document;
-}
 function getPriority(identifier, deduped, priority) {
   if (identifier) {
     const existing = deduped.get(identifier);
@@ -6147,10 +6275,10 @@ const CacheHandler = {
     const shouldHydrate = context.request[EnableHydration] || false;
     context.setResponse(peeked.response);
     if ('error' in peeked) {
-      const content = shouldHydrate ? maybeUpdateErrorUiObjects(store, {
+      const content = shouldHydrate ? maybeUpdateUiObjects(store, context.request, {
         shouldHydrate,
         identifier
-      }, peeked.content, true) : peeked.content;
+      }, peeked.content) : peeked.content;
       const newError = cloneError(peeked);
       newError.content = content;
       throw newError;
@@ -6158,15 +6286,15 @@ const CacheHandler = {
     const result = shouldHydrate ? maybeUpdateUiObjects(store, context.request, {
       shouldHydrate,
       identifier
-    }, peeked.content, true) : peeked.content;
+    }, peeked.content) : peeked.content;
     return result;
   }
 };
-function maybeUpdateUiObjects(store, request, options, document, isFromCache) {
+function maybeUpdateUiObjects(store, request, options, document) {
   const {
     identifier
   } = options;
-  if (!document) {
+  if (!document || !options.shouldHydrate) {
     macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
       if (!test) {
         throw new Error(`The CacheHandler expected response content but none was found`);
@@ -6174,97 +6302,21 @@ function maybeUpdateUiObjects(store, request, options, document, isFromCache) {
     })(!options.shouldHydrate) : {};
     return document;
   }
-  if (Array.isArray(document.data)) {
-    const {
-      recordArrayManager
-    } = store;
-    if (!identifier) {
-      if (!options.shouldHydrate) {
-        return document;
-      }
-      const data = recordArrayManager.createArray({
-        type: request.url,
-        identifiers: document.data,
-        doc: document,
-        query: request
-      });
-      const doc = new Document(store, null);
-      doc.data = data;
-      doc.meta = document.meta;
-      doc.links = document.links;
-      return doc;
-    }
-    let managed = recordArrayManager._keyedArrays.get(identifier.lid);
-    if (!managed) {
-      managed = recordArrayManager.createArray({
-        type: identifier.lid,
-        identifiers: document.data,
-        doc: document
-      });
-      recordArrayManager._keyedArrays.set(identifier.lid, managed);
-      const doc = new Document(store, identifier);
-      doc.data = managed;
-      doc.meta = document.meta;
-      doc.links = document.links;
-      store._documentCache.set(identifier, doc);
-      return options.shouldHydrate ? doc : document;
-    } else {
-      const doc = store._documentCache.get(identifier);
-      if (!isFromCache) {
-        recordArrayManager.populateManagedArray(managed, document.data, document);
-        doc.data = managed;
-        doc.meta = document.meta;
-        doc.links = document.links;
-      }
-      return options.shouldHydrate ? doc : document;
-    }
-  } else {
-    if (!identifier && !options.shouldHydrate) {
-      return document;
-    }
-    const data = document.data ? store.peekRecord(document.data) : null;
-    let doc;
-    if (identifier) {
-      doc = store._documentCache.get(identifier);
-    }
-    if (!doc) {
-      doc = new Document(store, identifier);
-      doc.data = data;
-      copyDocumentProperties(doc, document);
-      if (identifier) {
-        store._documentCache.set(identifier, doc);
-      }
-    } else if (!isFromCache) {
-      doc.data = data;
-      copyDocumentProperties(doc, document);
-    }
-    return options.shouldHydrate ? doc : document;
-  }
-}
-function maybeUpdateErrorUiObjects(store, options, document, isFromCache) {
-  const {
-    identifier
-  } = options;
-
-  // TODO investigate why ResourceErrorDocument is insufficient for expressing all error types
-  if (!isErrorDocument(document) || !identifier && !options.shouldHydrate) {
-    return document;
-  }
-  let doc;
   if (identifier) {
-    doc = store._documentCache.get(identifier);
-  }
-  if (!doc) {
-    doc = new Document(store, identifier);
-    copyDocumentProperties(doc, document);
-    if (identifier) {
+    let doc = store._documentCache.get(identifier);
+    if (!doc) {
+      doc = new ReactiveDocument(store, identifier, null);
       store._documentCache.set(identifier, doc);
     }
-  } else if (!isFromCache) {
-    doc.data = undefined;
-    copyDocumentProperties(doc, document);
+    return doc;
   }
-  return options.shouldHydrate ? doc : document;
+
+  // if we don't have an identifier, we give the document
+  // its own local cache
+  return new ReactiveDocument(store, null, {
+    request,
+    document
+  });
 }
 function updateCacheForSuccess(store, request, options, document) {
   let response = null;
@@ -6282,7 +6334,7 @@ function updateCacheForSuccess(store, request, options, document) {
   } else {
     response = store.cache.put(document);
   }
-  return maybeUpdateUiObjects(store, request, options, response, false);
+  return maybeUpdateUiObjects(store, request, options, response);
 }
 function handleFetchSuccess(store, context, options, document) {
   const {
@@ -6315,7 +6367,7 @@ function updateCacheForError(store, context, options, error) {
     store.cache.commitWasRejected(record, errors);
   } else {
     response = store.cache.put(error);
-    return maybeUpdateErrorUiObjects(store, options, response, false);
+    return maybeUpdateUiObjects(store, context.request, options, response);
   }
 }
 function handleFetchError(store, context, options, error) {