Fix: @attr defaultValue() results should persist after init (#9355) (#…

…9441)

* Fix: @attr defaultValue() results should persist after initialization (#9355)

* Backport of #9355

* defaultValue function results should persist after initialization

* clear default values on patch changes

* defaultValue caching test

---------

Co-authored-by: christophersansone <chris@voltage.io>

* Fix lint errors

---------

Co-authored-by: Christopher Sansone <chris@legendary.io>
Co-authored-by: christophersansone <chris@voltage.io>
Co-authored-by: Daniel Lubovich <dlubovich@cradlepoint.com>

packages/json-api/src/-private/cache.ts

@@ -59,6 +59,7 @@ interface CachedResource {
   id: string | null;
   remoteAttrs: Record<string, unknown> | null;
   localAttrs: Record<string, unknown> | null;
+  defaultAttrs: Record<string, unknown> | null;
   inflightAttrs: Record<string, unknown> | null;
   changes: Record<string, unknown[]> | null;
   errors: JsonApiError[] | null;
@@ -72,6 +73,7 @@ function makeCache(): CachedResource {
     id: null,
     remoteAttrs: null,
     localAttrs: null,
+    defaultAttrs: null,
     inflightAttrs: null,
     changes: null,
     errors: null,
@@ -871,6 +873,7 @@ export default class JSONAPICache implements Cache {
     // we report as `isEmpty` during teardown.
     cached.localAttrs = null;
     cached.remoteAttrs = null;
+    cached.defaultAttrs = null;
     cached.inflightAttrs = null;
 
     let relatedIdentifiers = _allRelatedIdentifiers(storeWrapper, identifier);
@@ -939,9 +942,16 @@ export default class JSONAPICache implements Cache {
       return cached.inflightAttrs[attr];
     } else if (cached.remoteAttrs && attr in cached.remoteAttrs) {
       return cached.remoteAttrs[attr];
+    } else if (cached.defaultAttrs && attr in cached.defaultAttrs) {
+      return cached.defaultAttrs[attr];
     } else {
       const attrSchema = this.__storeWrapper.getSchemaDefinitionService().attributesDefinitionFor(identifier)[attr];
-      return getDefaultValue(attrSchema?.options);
+      const defaultValue = getDefaultValue(attrSchema?.options);
+      if (typeof attrSchema?.options?.defaultValue === 'function') {
+        cached.defaultAttrs = cached.defaultAttrs || (Object.create(null) as Record<string, unknown>);
+        cached.defaultAttrs[attr] = defaultValue;
+      }
+      return defaultValue;
     }
   }
 
@@ -974,6 +984,10 @@ export default class JSONAPICache implements Cache {
       delete cached.changes![attr];
     }
 
+    if (cached.defaultAttrs && attr in cached.defaultAttrs) {
+      delete cached.defaultAttrs[attr];
+    }
+
     this.__storeWrapper.notifyChange(identifier, 'attributes', attr);
   }
 
@@ -1056,6 +1070,7 @@ export default class JSONAPICache implements Cache {
     }
 
     cached.inflightAttrs = null;
+    cached.defaultAttrs = null;
 
     if (cached.errors) {
       cached.errors = null;
@@ -1408,7 +1423,7 @@ function setupRelationships(
 }
 
 function patchLocalAttributes(cached: CachedResource): boolean {
-  const { localAttrs, remoteAttrs, inflightAttrs, changes } = cached;
+  const { localAttrs, remoteAttrs, inflightAttrs, defaultAttrs, changes } = cached;
   if (!localAttrs) {
     cached.changes = null;
     return false;
@@ -1430,6 +1445,10 @@ function patchLocalAttributes(cached: CachedResource): boolean {
       delete localAttrs[attr];
       delete changes![attr];
     }
+
+    if (defaultAttrs && attr in defaultAttrs) {
+      delete defaultAttrs[attr];
+    }
   }
   return hasAppliedPatch;
 }

tests/json-api/tests/integration/cache/resource-data-documents-test.ts

@@ -460,4 +460,77 @@ module('Integration | @ember-data/json-api Cache.put(<ResourceDataDocument>)', f
       'We can fetch more included data from the cache'
     );
   });
+
+  test('generated default values are retained', function (assert) {
+    const store = new TestStore();
+    let i = 0;
+
+    store.registerSchema(
+      new TestSchema<'user'>({
+        user: {
+          attributes: {
+            name: {
+              kind: 'attribute',
+              name: 'name',
+              type: 'string',
+              options: {
+                defaultValue: () => {
+                  i++;
+                  return `Name ${i}`;
+                },
+              },
+            },
+          },
+          relationships: {},
+        },
+      })
+    );
+
+    store._run(() => {
+      store.cache.put({
+        content: {
+          data: {
+            type: 'user',
+            id: '1',
+            attributes: {},
+          },
+        },
+      }) as SingleResourceDataDocument;
+    });
+    const identifier = store.identifierCache.getOrCreateRecordIdentifier({ type: 'user', id: '1' });
+
+    const name1 = store.cache.getAttr(identifier, 'name');
+    assert.strictEqual(name1, 'Name 1', 'The default value was generated');
+    const name2 = store.cache.getAttr(identifier, 'name');
+    assert.strictEqual(name2, 'Name 1', 'The default value was cached');
+
+    store.cache.setAttr(identifier, 'name', 'Chris');
+    const name3 = store.cache.getAttr(identifier, 'name');
+    assert.strictEqual(name3, 'Chris', 'The value was updated');
+
+    store.cache.setAttr(identifier, 'name', null);
+    const name4 = store.cache.getAttr(identifier, 'name');
+    assert.strictEqual(name4, null, 'Null was set and maintained');
+
+    store.cache.rollbackAttrs(identifier);
+    const name5 = store.cache.getAttr(identifier, 'name');
+    assert.strictEqual(name5, 'Name 2', 'The default value was regenerated');
+
+    store._run(() => {
+      store.cache.put({
+        content: {
+          data: {
+            type: 'user',
+            id: '1',
+            attributes: {
+              name: 'Tomster',
+            },
+          },
+        },
+      }) as SingleResourceDataDocument;
+    });
+
+    const name6 = store.cache.getAttr(identifier, 'name');
+    assert.strictEqual(name6, 'Tomster', 'The value was updated on put');
+  });
 });