feat(core): Add flushRequestsOnStop configuration option (#335)

Netflix · May 18, 2020 · ab4a2e1 · ab4a2e1
1 parent 48ea1d7
commit ab4a2e1
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 0 deletions.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -71,6 +71,22 @@ polly.configure({
 });
 ```
 
+## flushRequestsOnStop
+
+_Type_: `Boolean`
+_Default_: `false`
+
+Await any unresolved requests handled by the polly instance
+(via [flush](api#flush)) when [stop](api#stop) is called.
+
+**Example**
+
+```js
+polly.configure({
+  flushRequestsOnStop: true
+});
+```
+
 ## expiresIn
 
 _Type_: `String`

diff --git a/packages/@pollyjs/core/src/defaults/config.js b/packages/@pollyjs/core/src/defaults/config.js
@@ -15,6 +15,7 @@ export default {
   },
 
   logging: false,
+  flushRequestsOnStop: false,
 
   recordIfMissing: true,
   recordFailedRequests: false,

diff --git a/packages/@pollyjs/core/src/polly.js b/packages/@pollyjs/core/src/polly.js
@@ -232,6 +232,10 @@ export default class Polly {
    */
   async stop() {
     if (this.mode !== MODES.STOPPED) {
+      if (this.config.flushRequestsOnStop) {
+        await this.flush();
+      }
+
       this.disconnect();
       this.logger.disconnect();
       await (this.persister && this.persister.persist());

diff --git a/packages/@pollyjs/core/tests/unit/polly-test.js b/packages/@pollyjs/core/tests/unit/polly-test.js
@@ -169,6 +169,28 @@ describe('Unit | Polly', function() {
     expect(recognizedOptions.context).to.equal(fakeContext);
   });
 
+  it('calls flush when flushRequestsOnStop is enabled', async function() {
+    let polly = new Polly('squawk', { flushRequestsOnStop: false });
+    let flushCalled = false;
+
+    polly.flush = async () => {
+      flushCalled = true;
+    };
+
+    await polly.stop();
+    expect(flushCalled).to.be.false;
+
+    polly = new Polly('squawk', { flushRequestsOnStop: true });
+    flushCalled = false;
+
+    polly.flush = async () => {
+      flushCalled = true;
+    };
+
+    await polly.stop();
+    expect(flushCalled).to.be.true;
+  });
+
   describe('configure', function() {
     setupPolly();
 
@@ -481,6 +503,13 @@ describe('Unit | Polly', function() {
       expect(this.polly.disconnect());
       expect(disconnects.length).to.equal(2);
     });
+
+    it('.flush()', async function() {
+      const promise = this.polly.flush();
+
+      expect(promise).to.be.a('promise');
+      await promise;
+    });
   });
 
   describe('Class Methods & Events', function() {