feat: Make PollyRequest.respond accept a response object (#168)

BREAKING CHANGE: Any adapters calling `pollyRequest.respond` should pass it a response object instead of the previous 3 arguments (statusCode, headers, body).

packages/@pollyjs/adapter/src/index.js

@@ -17,7 +17,7 @@ export default class Adapter {
 
   /* eslint-disable-next-line getter-return */
   static get name() {
-    assert('Must override the static `name` getter.', false);
+    assert('Must override the static `name` getter.');
   }
 
   get defaultOptions() {
@@ -217,27 +217,34 @@ export default class Adapter {
     );
   }
 
-  /* Required Hooks */
   onConnect() {
-    this.assert('Must implement the `onConnect` hook.', false);
+    this.assert('Must implement the `onConnect` hook.');
   }
 
   onDisconnect() {
-    this.assert('Must implement the `onDisconnect` hook.', false);
+    this.assert('Must implement the `onDisconnect` hook.');
   }
 
   /**
    * @param {PollyRequest} pollyRequest
-   * @returns {response}
+   * @returns {{ statusCode: number, headers: Object, body: string }}
    */
   async passthroughRequest(/* pollyRequest */) {
-    this.assert('Must implement `passthroughRequest`.', false);
+    this.assert('Must implement the `passthroughRequest` hook.');
   }
 
-  /* Other Hooks */
+  /**
+   * Make sure the response from a Polly request is delivered to the
+   * user through the adapter interface.
+   *
+   * Calling `pollyjs.flush()` will await this method.
+   *
+   * @param {PollyRequest} pollyRequest
+   */
+  async respondToRequest(/* pollyRequest */) {}
+
   /**
    * @param {PollyRequest} pollyRequest
-   * @returns {*}
    */
   async onRecord(pollyRequest) {
     await this.onPassthrough(pollyRequest);
@@ -248,31 +255,26 @@ export default class Adapter {
    * @param {PollyRequest} pollyRequest
    * @param {Object} normalizedResponse The normalized response generated from the recording entry
    * @param {Object} recordingEntry The entire recording entry
-   * @returns {*}
    */
-  async onReplay(pollyRequest, { statusCode, headers, body }) {
-    await pollyRequest.respond(statusCode, headers, body);
+  async onReplay(pollyRequest, normalizedResponse) {
+    await pollyRequest.respond(normalizedResponse);
   }
 
   /**
    * @param {PollyRequest} pollyRequest
-   * @param {PollyResponse} response
-   * @returns {*}
+   * @param {PollyResponse} pollyResponse
    */
-  async onIntercept(pollyRequest, { statusCode, headers, body }) {
-    await pollyRequest.respond(statusCode, headers, body);
+  async onIntercept(pollyRequest, pollyResponse) {
+    await pollyRequest.respond(pollyResponse);
   }
 
   /**
    * @param {PollyRequest} pollyRequest
-   * @returns {*}
    */
   async onPassthrough(pollyRequest) {
-    const { statusCode, headers, body } = await this.passthroughRequest(
-      pollyRequest
-    );
+    const response = await this.passthroughRequest(pollyRequest);
 
-    await pollyRequest.respond(statusCode, headers, body);
+    await pollyRequest.respond(response);
   }
 
   /**
@@ -294,7 +296,6 @@ export default class Adapter {
 
   /**
    * @param {PollyRequest} pollyRequest
-   * @param {*} result The returned result value from the request handler
    */
   async onRequestFinished(pollyRequest) {
     await this.respondToRequest(pollyRequest);
@@ -309,12 +310,4 @@ export default class Adapter {
   onRequestFailed(pollyRequest, error) {
     pollyRequest.promise.reject(error);
   }
-
-  /**
-   * Make sure the response from a Polly request is delivered to the
-   * user through the adapter interface.
-   *
-   * Calling `pollyjs.flush()` will await this method.
-   */
-  async respondToRequest(/* pollyRequest */) {}
 }

packages/@pollyjs/core/src/-private/request.js

@@ -43,7 +43,7 @@ export default class PollyRequest extends HTTPBase {
     this.setHeaders(request.headers);
     this.recordingName = polly.recordingName;
     this.recordingId = polly.recordingId;
-    this.requestArguments = freeze(request.requestArguments || []);
+    this.requestArguments = freeze(request.requestArguments);
     this.promise = defer();
     this[POLLY] = polly;
     this[EVENT_EMITTER] = new EventEmitter({ eventNames: SUPPORTED_EVENTS });
@@ -163,7 +163,9 @@ export default class PollyRequest extends HTTPBase {
     this.timestamp = timestamp();
   }
 
-  async respond(status, headers, body) {
+  async respond(response) {
+    const { statusCode, headers, body } = response || {};
+
     assert(
       'Cannot respond to a request that already has a response.',
       !this.didRespond
@@ -172,8 +174,11 @@ export default class PollyRequest extends HTTPBase {
     // Timestamp the response
     this.response.timestamp = timestamp();
 
-    // Set the status code and headers
-    this.response.status(status).setHeaders(headers);
+    // Set the status code
+    this.response.status(statusCode);
+
+    // Se the headers
+    this.response.setHeaders(headers);
 
     // Set the body without modifying any headers (instead of using .send())
     this.response.body = body;

packages/@pollyjs/persister/src/index.js

@@ -19,7 +19,7 @@ export default class Persister {
 
   /* eslint-disable-next-line getter-return */
   static get name() {
-    assert('Must override the static `name` getter.', false);
+    assert('Must override the static `name` getter.');
   }
 
   get defaultOptions() {
@@ -202,14 +202,14 @@ export default class Persister {
   }
 
   findRecording() {
-    this.assert('Must implement the `findRecording` hook.', false);
+    this.assert('Must implement the `findRecording` hook.');
   }
 
   saveRecording() {
-    this.assert('Must implement the `saveRecording` hook.', false);
+    this.assert('Must implement the `saveRecording` hook.');
   }
 
   deleteRecording() {
-    this.assert('Must implement the `deleteRecording` hook.', false);
+    this.assert('Must implement the `deleteRecording` hook.');
   }
 }

packages/@pollyjs/utils/src/utils/assert.js

@@ -1,5 +1,5 @@
 export default function(msg, condition) {
-  if (typeof condition === 'undefined' || condition === false) {
+  if (!condition) {
     throw new Error(`[Polly] ${msg}`);
   }
 }