feat!: Cleanup adapter and persister APIs (#429)

BREAKING CHANGE: - Adapter - `passthroughRequest` renamed to `onFetchResponse` - `respondToRequest` renamed to `onRespond` - Persister - `findRecording` renamed to `onFindRecording` - `saveRecording` renamed to `onSaveRecording` - `deleteRecording` renamed to `onDeleteRecording`
Netflix · Nov 30, 2021 · 06499fc · 06499fc
1 parent 3ab0d1d
commit 06499fc
Show file tree

Hide file tree

Showing 24 changed files with 252 additions and 277 deletions.
diff --git a/docs/adapters/custom.md b/docs/adapters/custom.md
@@ -41,12 +41,12 @@ class CustomAdapter extends Adapter {
     /* Do something when the adapter is disconnected from */
   }
 
-  async passthroughRequest(pollyRequest) {
+  async onFetchResponse(pollyRequest) {
     /* Do something when the adapter is connect to */
   }
 
   /* optional */
-  async respondToRequest(pollyRequest) {
+  async onRespond(pollyRequest) {
     const { statusCode, body, headers } = pollyRequest.response;
     /* Deliver the response to the user */
   }
@@ -57,12 +57,12 @@ The `Adapter` class provides the `handleRequest()` method which can be
 called from `onConnect`. It accepts request parameters and returns a
 PollyRequest object with a `response` property.
 
-The `passthroughRequest` method takes a PollyRequest object, makes a real HTTP
+The `onFetchResponse` method takes a PollyRequest object, makes a real HTTP
 request and returns the response as a `{ statusCode, headers, body }` object,
 where `body` is a string.
 
-The `respondToRequest()` method makes sure that the response has been delivered
-to the user. `pollyjs.flush()` will wait for all `respondToRequests()` calls to
+The `onRespond()` method makes sure that the response has been delivered
+to the user. `pollyjs.flush()` will wait for all `onResponds()` calls to
 finish. You can omit the implementation of this method if no asynchronous
 delivery is required.
 
@@ -103,7 +103,7 @@ class FetchAdapter extends Adapter {
     window.fetch = this.originalFetch;
   }
 
-  async passthroughRequest(pollyRequest) {
+  async onFetchResponse(pollyRequest) {
     const response = await this.originalFetch([
       pollyRequest.url,
       {

diff --git a/docs/persisters/custom.md b/docs/persisters/custom.md
@@ -33,11 +33,11 @@ class CustomPersister extends Persister {
     return 'custom';
   }
 
-  findRecording() {}
+  onFindRecording() {}
 
-  saveRecording() {}
+  onSaveRecording() {}
 
-  deleteRecording() {}
+  onDeleteRecording() {}
 }
 ```
 

diff --git a/packages/@pollyjs/adapter-fetch/src/index.js b/packages/@pollyjs/adapter-fetch/src/index.js
@@ -16,12 +16,6 @@ export default class FetchAdapter extends Adapter {
     return 'fetch';
   }
 
-  static get name() {
-    // NOTE: deprecated in 4.1.0 but proxying since it's possible "core" is behind
-    // and therefore still referencing `name`.  Remove in 5.0.0
-    return this.id;
-  }
-
   get defaultOptions() {
     return {
       context: global
@@ -153,7 +147,7 @@ export default class FetchAdapter extends Adapter {
     }
   }
 
-  async passthroughRequest(pollyRequest) {
+  async onFetchResponse(pollyRequest) {
     const { context } = this.options;
     const { options } = pollyRequest.requestArguments;
 
@@ -195,7 +189,7 @@ export default class FetchAdapter extends Adapter {
     };
   }
 
-  respondToRequest(pollyRequest, error) {
+  onRespond(pollyRequest, error) {
     const {
       context: { Response }
     } = this.options;

diff --git a/packages/@pollyjs/adapter-node-http/src/index.js b/packages/@pollyjs/adapter-node-http/src/index.js
@@ -29,12 +29,6 @@ export default class HttpAdapter extends Adapter {
     return 'node-http';
   }
 
-  static get name() {
-    // NOTE: deprecated in 4.1.0 but proxying since it's possible "core" is behind
-    // and therefore still referencing `name`.  Remove in 5.0.0
-    return this.id;
-  }
-
   onConnect() {
     this.assert(
       'Running concurrent node-http adapters is unsupported, stop any running Polly instances.',
@@ -187,7 +181,7 @@ export default class HttpAdapter extends Adapter {
     }
   }
 
-  async passthroughRequest(pollyRequest) {
+  async onFetchResponse(pollyRequest) {
     const { parsedArguments } = pollyRequest.requestArguments;
     const { method, headers, body } = pollyRequest;
     const { options } = parsedArguments;
@@ -230,7 +224,7 @@ export default class HttpAdapter extends Adapter {
     };
   }
 
-  async respondToRequest(pollyRequest, error) {
+  async onRespond(pollyRequest, error) {
     const { req, respond } = pollyRequest.requestArguments;
     const { statusCode, body, headers, encoding } = pollyRequest.response;
 

diff --git a/packages/@pollyjs/adapter-node-http/tests/jest/integration/fetch-test.js b/packages/@pollyjs/adapter-node-http/tests/jest/integration/fetch-test.js
@@ -21,14 +21,14 @@ describe('Integration | Jest | Fetch', function () {
     expect((await fetch('http://localhost:4000/api/db/foo')).status).toBe(404);
     await persister.persist();
 
-    const har = await persister.find(recordingId);
+    const har = await persister.findRecording(recordingId);
 
     expect(har).toBeDefined();
     expect(har.log.entries.length).toBe(1);
     expect(har.log.entries[0].request.url.includes('/api/db/foo')).toBe(true);
     expect(har.log.entries[0].response.status).toBe(404);
 
-    await persister.delete(recordingId);
-    expect(persister.find(recordingId)).resolves.toBeNull();
+    await persister.deleteRecording(recordingId);
+    expect(persister.findRecording(recordingId)).resolves.toBeNull();
   });
 });
diff --git a/packages/@pollyjs/adapter-node-http/tests/jest/integration/xhr-test.js b/packages/@pollyjs/adapter-node-http/tests/jest/integration/xhr-test.js
@@ -33,14 +33,14 @@ describe('Integration | Jest | XHR', function () {
     expect((await request('/api/db/foo')).status).toBe(404);
     await persister.persist();
 
-    const har = await persister.find(recordingId);
+    const har = await persister.findRecording(recordingId);
 
     expect(har).toBeDefined();
     expect(har.log.entries.length).toBe(1);
     expect(har.log.entries[0].request.url.includes('/api/db/foo')).toBe(true);
     expect(har.log.entries[0].response.status).toBe(404);
 
-    await persister.delete(recordingId);
-    expect(persister.find(recordingId)).resolves.toBeNull();
+    await persister.deleteRecording(recordingId);
+    expect(persister.findRecording(recordingId)).resolves.toBeNull();
   });
 });
diff --git a/packages/@pollyjs/adapter-puppeteer/src/index.js b/packages/@pollyjs/adapter-puppeteer/src/index.js
@@ -10,12 +10,6 @@ export default class PuppeteerAdapter extends Adapter {
     return 'puppeteer';
   }
 
-  static get name() {
-    // NOTE: deprecated in 4.1.0 but proxying since it's possible "core" is behind
-    // and therefore still referencing `name`.  Remove in 5.0.0
-    return this.id;
-  }
-
   get defaultOptions() {
     return {
       page: null,
@@ -160,7 +154,7 @@ export default class PuppeteerAdapter extends Adapter {
     this._requestsMapping.pollyRequests.set(request, pollyRequest);
   }
 
-  async passthroughRequest(pollyRequest) {
+  async onFetchResponse(pollyRequest) {
     const { page } = this.options;
     const { id, order, url, method, headers, body } = pollyRequest;
     const requestId = `${this.polly.recordingId}:${id}:${order}`;
@@ -199,7 +193,7 @@ export default class PuppeteerAdapter extends Adapter {
     }
   }
 
-  async respondToRequest(pollyRequest, error) {
+  async onRespond(pollyRequest, error) {
     const { request } = pollyRequest.requestArguments;
     const { response } = pollyRequest;
 

diff --git a/packages/@pollyjs/adapter-xhr/src/index.js b/packages/@pollyjs/adapter-xhr/src/index.js
@@ -18,12 +18,6 @@ export default class XHRAdapter extends Adapter {
     return 'xhr';
   }
 
-  static get name() {
-    // NOTE: deprecated in 4.1.0 but proxying since it's possible "core" is behind
-    // and therefore still referencing `name`.  Remove in 5.0.0
-    return this.id;
-  }
-
   get defaultOptions() {
     return {
       context: global
@@ -78,7 +72,7 @@ export default class XHRAdapter extends Adapter {
     }
   }
 
-  async passthroughRequest(pollyRequest) {
+  async onFetchResponse(pollyRequest) {
     const { xhr: fakeXhr } = pollyRequest.requestArguments;
     const xhr = new this.NativeXMLHttpRequest();
 
@@ -143,7 +137,7 @@ export default class XHRAdapter extends Adapter {
     };
   }
 
-  respondToRequest(pollyRequest, error) {
+  onRespond(pollyRequest, error) {
     const { xhr } = pollyRequest.requestArguments;
 
     if (pollyRequest[ABORT_HANDLER]) {