[BUGFIX TEST] reloading tests for adapter encapsulation side quest - …

…shouldBackgroundReloadRecord (#6718)
emberjs · Nov 11, 2019 · c9a8908 · c9a8908
1 parent 3fed1c0
commit c9a8908
Show file tree

Hide file tree

Showing 2 changed files with 224 additions and 2 deletions.
diff --git a/packages/store/addon/-private/system/core-store.ts b/packages/store/addon/-private/system/core-store.ts
@@ -1018,7 +1018,11 @@ abstract class CoreStore extends Service {
     }
 
     // Trigger the background refetch if backgroundReload option is passed
-    if (options.backgroundReload || adapter.shouldBackgroundReloadRecord(this, snapshot)) {
+    if (
+      options.backgroundReload ||
+      !adapter.shouldBackgroundReloadRecord ||
+      adapter.shouldBackgroundReloadRecord(this, snapshot)
+    ) {
       this._scheduleFetch(internalModel, options);
     }
 

diff --git a/packages/unpublished-adapter-encapsulation-test-app/tests/integration/reload-test.js b/packages/unpublished-adapter-encapsulation-test-app/tests/integration/reload-test.js
@@ -429,5 +429,223 @@ module('integration/reload - Reloading Tests', function(hooks) {
     });
   });
 
-  module('adapter.shouldBackgroundReloadRecord', function() {});
+  module('adapter.shouldBackgroundReloadRecord', function() {
+    test('adapter.shouldBackgroundReloadRecord is not called when store.findRecord is called for an unloaded record (but we do make request)', async function(assert) {
+      let payload = {
+        data: {
+          id: '1',
+          type: 'person',
+          attributes: {
+            firstName: 'Gaurav',
+            lastName: 'Munjal',
+          },
+        },
+      };
+
+      setupReloadTest.call(this, {
+        resolveFindRecordWith: payload,
+      });
+
+      let record = this.store.push(payload);
+
+      this.store.unloadRecord(record);
+
+      await this.store.findRecord('person', '1');
+
+      assert.equal(this.adapter.shouldBackgroundReloadRecordCalled, 0, 'shouldBackgroundReloadRecord is not called');
+      assert.equal(this.adapter.requestsMade, 1, 'an ajax request is made');
+    });
+
+    test('adapter.shouldBackgroundReloadRecord is not called when store.findRecord is called for a never loaded record (but we do make request)', async function(assert) {
+      let payload = {
+        data: {
+          id: '1',
+          type: 'person',
+          attributes: {
+            firstName: 'Gaurav',
+            lastName: 'Munjal',
+          },
+        },
+      };
+
+      setupReloadTest.call(this, {
+        resolveFindRecordWith: payload,
+      });
+
+      await this.store.findRecord('person', '1');
+
+      assert.equal(this.adapter.shouldBackgroundReloadRecordCalled, 0, 'shouldBackgroundReloadRecord is not called');
+      assert.equal(this.adapter.requestsMade, 1, 'an ajax request is made');
+    });
+
+    test('adapter.shouldBackgroundReloadRecord is not called called when store.findRecord is called with reload: true flag (but we do make request)', async function(assert) {
+      let payload = {
+        data: {
+          id: '1',
+          type: 'person',
+          attributes: {
+            firstName: 'Gaurav',
+            lastName: 'Munjal',
+          },
+        },
+      };
+
+      setupReloadTest.call(this, {
+        resolveFindRecordWith: payload,
+      });
+
+      this.store.push(payload);
+
+      await this.store.findRecord('person', '1', { reload: true });
+
+      assert.equal(this.adapter.shouldBackgroundReloadRecordCalled, 0, 'shouldBackgroundReloadRecord is not called');
+      assert.equal(this.adapter.requestsMade, 1, 'an ajax request is made');
+    });
+
+    test('adapter.shouldBackgroundReloadRecord is not called called when store.findRecord is called and shouldReloadRecord returns true (but we do make request)', async function(assert) {
+      let payload = {
+        data: {
+          id: '1',
+          type: 'person',
+          attributes: {
+            firstName: 'Gaurav',
+            lastName: 'Munjal',
+          },
+        },
+      };
+
+      setupReloadTest.call(this, {
+        shouldReloadRecord: true,
+        resolveFindRecordWith: payload,
+      });
+
+      this.store.push(payload);
+
+      await this.store.findRecord('person', '1');
+
+      assert.equal(this.adapter.shouldBackgroundReloadRecordCalled, 0, 'shouldBackgroundReloadRecord is not called');
+      assert.equal(this.adapter.requestsMade, 1, 'an ajax request is made');
+    });
+
+    test('adapter.shouldBackgroundReloadRecord is not called when store.findRecord is called with backroundReload as an option (backgroundReload is true)', async function(assert) {
+      let payload = {
+        data: {
+          id: '1',
+          type: 'person',
+          attributes: {
+            firstName: 'Gaurav',
+            lastName: 'Munjal',
+          },
+        },
+      };
+
+      setupReloadTest.call(this, {
+        resolveFindRecordWith: payload,
+      });
+
+      this.store.push(payload);
+
+      await this.store.findRecord('person', '1', { backgroundReload: true });
+
+      assert.equal(this.adapter.shouldBackgroundReloadRecordCalled, 0, 'shouldBackgroundReloadRecord is not called');
+      assert.equal(this.adapter.requestsMade, 1, 'an ajax request is made');
+    });
+
+    test('adapter.shouldBackgroundReloadRecord is not called when store.findRecord is called with backroundReload as an option (backgroundReload is false)', async function(assert) {
+      let payload = {
+        data: {
+          id: '1',
+          type: 'person',
+          attributes: {
+            firstName: 'Gaurav',
+            lastName: 'Munjal',
+          },
+        },
+      };
+
+      setupReloadTest.call(this, {
+        resolveFindRecordWith: payload,
+      });
+
+      this.store.push(payload);
+
+      await this.store.findRecord('person', '1', { backgroundReload: false });
+
+      assert.equal(this.adapter.shouldBackgroundReloadRecordCalled, 0, 'shouldBackgroundReloadRecord is not called');
+      assert.equal(this.adapter.requestsMade, 0, 'no ajax request is made');
+    });
+
+    test('store.findRecord does not error if adapter.shouldBackgroundReloadRecord is undefined and backgroundReload is not present.', async function(assert) {
+      let payload = {
+        data: {
+          id: '1',
+          type: 'person',
+          attributes: {
+            firstName: 'Gaurav',
+            lastName: 'Munjal',
+          },
+        },
+      };
+
+      setupReloadTest.call(this, {
+        resolveFindRecordWith: payload,
+      });
+
+      this.store.push(payload);
+
+      await this.store.findRecord('person', '1');
+
+      assert.equal(this.adapter.requestsMade, 1, 'an ajax request is made');
+    });
+
+    test('adapter.shouldBackgroundReloadRecord is called when store.findRecord is called and there is no backgroundReload flag (adapter.shouldBackgroundReloadRecord() returns true)', async function(assert) {
+      let payload = {
+        data: {
+          id: '1',
+          type: 'person',
+          attributes: {
+            firstName: 'Gaurav',
+            lastName: 'Munjal',
+          },
+        },
+      };
+
+      setupReloadTest.call(this, {
+        shouldBackgroundReloadRecord: true,
+        resolveFindRecordWith: payload,
+      });
+
+      this.store.push(payload);
+
+      await this.store.findRecord('person', '1');
+
+      assert.equal(this.adapter.shouldBackgroundReloadRecordCalled, 1, 'shouldBackgroundReloadRecord is called');
+      assert.equal(this.adapter.requestsMade, 1, 'an ajax request is made');
+    });
+
+    test('adapter.shouldBackgroundReloadRecord is called when store.findRecord is called and there is no backgroundReload flag (adapter.shouldBackgroundReloadRecord() returns false)', async function(assert) {
+      let payload = {
+        data: {
+          id: '1',
+          type: 'person',
+          attributes: {
+            firstName: 'Gaurav',
+            lastName: 'Munjal',
+          },
+        },
+      };
+
+      setupReloadTest.call(this, {
+        shouldBackgroundReloadRecord: false,
+        resolveFindRecordWith: payload,
+      });
+
+      this.store.push(payload);
+
+      await this.store.findRecord('person', '1');
+
+      assert.equal(this.adapter.shouldBackgroundReloadRecordCalled, 1, 'shouldBackgroundReloadRecord is called');
+      assert.equal(this.adapter.requestsMade, 0, 'no ajax request is made');
+    });
+  });
 });