@serenity-js/rest 3.10.2 → 3.10.4

package/CHANGELOG.md

@@ -3,6 +3,26 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.10.4](https://github.com/serenity-js/serenity-js/compare/v3.10.3...v3.10.4) (2023-09-22)
+
+**Note:** Version bump only for package @serenity-js/rest
+
+
+
+
+
+## [3.10.3](https://github.com/serenity-js/serenity-js/compare/v3.10.2...v3.10.3) (2023-09-15)
+
+
+### Bug Fixes
+
+* **rest:** correctly resolve relative paths in REST requests ([1bdf3eb](https://github.com/serenity-js/serenity-js/commit/1bdf3eb05701007c8d640e4529f701862f223480))
+* **rest:** improved error messages and error handling for failed requests ([e6eb0c3](https://github.com/serenity-js/serenity-js/commit/e6eb0c36db0979be4c8e861cfe402094b7157024)), closes [#1876](https://github.com/serenity-js/serenity-js/issues/1876)
+
+
+
+
+
 ## [3.10.2](https://github.com/serenity-js/serenity-js/compare/v3.10.1...v3.10.2) (2023-09-10)
 
 

package/lib/screenplay/abilities/CallAnApi.d.ts

@@ -135,6 +135,5 @@ export declare class CallAnApi extends Ability {
      * @param mappingFunction
      */
     mapLastResponse<T>(mappingFunction: (response: AxiosResponse) => T): T;
-    private captureResponseOf;
 }
 //# sourceMappingURL=CallAnApi.d.ts.map

package/lib/screenplay/abilities/CallAnApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CallAnApi.d.ts","sourceRoot":"","sources":["../../../src/screenplay/abilities/CallAnApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAwD,MAAM,mBAAmB,CAAC;AAClG,OAAO,KAAK,EAAE,aAAa,EAAc,aAAa,EAAgB,kBAAkB,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAGvH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AACH,qBAAa,SAAU,SAAQ,OAAO;IA8CtB,OAAO,CAAC,QAAQ,CAAC,aAAa;IA5C1C,eAAe;IACf,OAAO,CAAC,YAAY,CAAgB;IAEpC;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS;IAQrC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE,aAAa,GAAG,SAAS;IAIrD;;;;;;OAMG;gBAC0B,aAAa,EAAE,aAAa;IAIzD;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAE,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC,GAAG,CAAC,KAAK,GAAG,GAAG,IAAI;IAI7D;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,CAAC;IAI3D;;;;;;;;;OASG;IACH,UAAU,CAAC,MAAM,EAAE,kBAAkB,GAAG,MAAM;IAI9C;;;;;;;;OAQG;IACH,eAAe,CAAC,CAAC,EAAE,eAAe,EAAE,CAAC,QAAQ,EAAE,aAAa,KAAK,CAAC,GAAG,CAAC;IAQtE,OAAO,CAAC,iBAAiB;CA0B5B"}
+{"version":3,"file":"CallAnApi.d.ts","sourceRoot":"","sources":["../../../src/screenplay/abilities/CallAnApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAwD,MAAM,mBAAmB,CAAC;AAClG,OAAO,KAAK,EAAE,aAAa,EAAc,aAAa,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAGzG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AACH,qBAAa,SAAU,SAAQ,OAAO;IA8CtB,OAAO,CAAC,QAAQ,CAAC,aAAa;IA5C1C,eAAe;IACf,OAAO,CAAC,YAAY,CAAgB;IAEpC;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS;IAQrC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE,aAAa,GAAG,SAAS;IAIrD;;;;;;OAMG;gBAC0B,aAAa,EAAE,aAAa;IAIzD;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAE,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC,GAAG,CAAC,KAAK,GAAG,GAAG,IAAI;IAI7D;;;;;;;;;;;OAWG;IACG,OAAO,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,CAAC;IAgCjE;;;;;;;;;OASG;IACH,UAAU,CAAC,MAAM,EAAE,kBAAkB,GAAG,MAAM;IAQ9C;;;;;;;;OAQG;IACH,eAAe,CAAC,CAAC,EAAE,eAAe,EAAE,CAAC,QAAQ,EAAE,aAAa,KAAK,CAAC,GAAG,CAAC;CAOzE"}

package/lib/screenplay/abilities/CallAnApi.js

@@ -129,8 +129,32 @@ class CallAnApi extends core_1.Ability {
      *  Axios request configuration, which can be used to override the defaults
      *  provided when the {@apilink Ability|ability} to {@apilink CallAnApi} was instantiated.
      */
-    request(config) {
-        return this.captureResponseOf(this.axiosInstance.request(config));
+    async request(config) {
+        let url;
+        try {
+            url = this.resolveUrl(config);
+            this.lastResponse = await this.axiosInstance.request({
+                ...config,
+                url,
+            });
+            return this.lastResponse;
+        }
+        catch (error) {
+            const description = `${config.method.toUpperCase()} ${url || config.url}`;
+            switch (true) {
+                case /timeout.*exceeded/.test(error.message):
+                    throw new core_1.TestCompromisedError(`The request has timed out: ${description}`, error);
+                case /Network Error/.test(error.message):
+                    throw new core_1.TestCompromisedError(`A network error has occurred: ${description}`, error);
+                case error instanceof TypeError:
+                    throw new core_1.ConfigurationError(`Looks like there was an issue with Axios configuration`, error);
+                case !error.response:
+                    throw new core_1.TestCompromisedError(`The API call has failed: ${description}`, error);
+                default:
+                    this.lastResponse = error.response;
+                    return error.response;
+            }
+        }
     }
     /**
      * Resolves the final URL, based on the {@apilink AxiosRequestConfig} provided
@@ -143,7 +167,10 @@ class CallAnApi extends core_1.Ability {
      * @param config
      */
     resolveUrl(config) {
-        return this.axiosInstance.getUri(config);
+        const baseURL = this.axiosInstance.defaults.baseURL || config.baseURL;
+        return baseURL
+            ? new URL(config.url, baseURL).toString()
+            : config.url;
     }
     /**
      * Maps the last cached response to another type.
@@ -160,27 +187,6 @@ class CallAnApi extends core_1.Ability {
         }
         return mappingFunction(this.lastResponse);
     }
-    captureResponseOf(promisedResponse) {
-        return promisedResponse
-            .then(lastResponse => {
-            this.lastResponse = lastResponse;
-            return lastResponse;
-        }, error => {
-            switch (true) {
-                case /timeout.*exceeded/.test(error.message):
-                    throw new core_1.TestCompromisedError(`The request has timed out`, error);
-                case /Network Error/.test(error.message):
-                    throw new core_1.TestCompromisedError(`A network error has occurred`, error);
-                case error instanceof TypeError:
-                    throw new core_1.ConfigurationError(`Looks like there was an issue with Axios configuration`, error);
-                case !error.response:
-                    throw new core_1.TestCompromisedError(`The API call has failed`, error); // todo: include request url
-                default:
-                    this.lastResponse = error.response;
-                    return error.response;
-            }
-        });
-    }
 }
 exports.CallAnApi = CallAnApi;
 //# sourceMappingURL=CallAnApi.js.map

package/lib/screenplay/abilities/CallAnApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"CallAnApi.js","sourceRoot":"","sources":["../../../src/screenplay/abilities/CallAnApi.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAkG;AAElG,kDAA0B;AAE1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AACH,MAAa,SAAU,SAAQ,cAAO;IAKlC;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,CAAC,OAAe;QACrB,OAAO,IAAI,SAAS,CAAC,eAAK,CAAC,MAAM,CAAC;YAC9B,OAAO;YACP,OAAO,EAAE,IAAI;YACb,OAAO,EAAE,EAAE,MAAM,EAAE,kCAAkC,EAAE;SAC1D,CAAC,CAAC,CAAC;IACR,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,KAAK,CAAC,aAA4B;QACrC,OAAO,IAAI,SAAS,CAAC,aAAa,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;OAMG;IACH,YAA6B,aAA4B;QACrD,KAAK,EAAE,CAAC;QADiB,kBAAa,GAAb,aAAa,CAAe;IAEzD,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAyC;QAClD,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,MAA0B;QAC9B,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;OASG;IACH,UAAU,CAAC,MAA0B;QACjC,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;OAQG;IACH,eAAe,CAAI,eAA+C;QAC9D,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YACpB,MAAM,IAAI,iBAAU,CAAC,sEAAsE,CAAC,CAAC;SAChG;QAED,OAAO,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC;IAEO,iBAAiB,CAAC,gBAA8B;QACpD,OAAO,gBAAgB;aAClB,IAAI,CACD,YAAY,CAAC,EAAE;YACX,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;YAEjC,OAAO,YAAY,CAAC;QACxB,CAAC,EACD,KAAK,CAAC,EAAE;YACJ,QAAQ,IAAI,EAAE;gBACV,KAAK,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;oBACxC,MAAM,IAAI,2BAAoB,CAAC,2BAA2B,EAAE,KAAK,CAAC,CAAC;gBACvE,KAAK,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;oBACpC,MAAM,IAAI,2BAAoB,CAAC,8BAA8B,EAAE,KAAK,CAAC,CAAC;gBAC1E,KAAK,KAAK,YAAY,SAAS;oBAC3B,MAAM,IAAI,yBAAkB,CAAC,wDAAwD,EAAE,KAAK,CAAC,CAAC;gBAClG,KAAK,CAAG,KAAoB,CAAC,QAAQ;oBACjC,MAAM,IAAI,2BAAoB,CAAC,yBAAyB,EAAE,KAAK,CAAC,CAAC,CAAG,4BAA4B;gBACpG;oBACI,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,QAAQ,CAAC;oBAEnC,OAAO,KAAK,CAAC,QAAQ,CAAC;aAC7B;QACL,CAAC,CACJ,CAAC;IACV,CAAC;CACJ;AAzID,8BAyIC"}
+{"version":3,"file":"CallAnApi.js","sourceRoot":"","sources":["../../../src/screenplay/abilities/CallAnApi.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAkG;AAElG,kDAA0B;AAE1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AACH,MAAa,SAAU,SAAQ,cAAO;IAKlC;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,CAAC,OAAe;QACrB,OAAO,IAAI,SAAS,CAAC,eAAK,CAAC,MAAM,CAAC;YAC9B,OAAO;YACP,OAAO,EAAE,IAAI;YACb,OAAO,EAAE,EAAE,MAAM,EAAE,kCAAkC,EAAE;SAC1D,CAAC,CAAC,CAAC;IACR,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,KAAK,CAAC,aAA4B;QACrC,OAAO,IAAI,SAAS,CAAC,aAAa,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;OAMG;IACH,YAA6B,aAA4B;QACrD,KAAK,EAAE,CAAC;QADiB,kBAAa,GAAb,aAAa,CAAe;IAEzD,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAyC;QAClD,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,OAAO,CAAC,MAA0B;QACpC,IAAI,GAAW,CAAC;QAEhB,IAAI;YACA,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC9B,IAAI,CAAC,YAAY,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC;gBACjD,GAAG,MAAM;gBACT,GAAG;aACN,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,YAAY,CAAC;SAC5B;QACD,OAAM,KAAK,EAAE;YACT,MAAM,WAAW,GAAG,GAAI,MAAM,CAAC,MAAM,CAAC,WAAW,EAAG,IAAK,GAAG,IAAI,MAAM,CAAC,GAAI,EAAE,CAAC;YAE9E,QAAQ,IAAI,EAAE;gBACV,KAAK,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;oBACxC,MAAM,IAAI,2BAAoB,CAAC,8BAA+B,WAAY,EAAE,EAAE,KAAK,CAAC,CAAC;gBACzF,KAAK,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;oBACpC,MAAM,IAAI,2BAAoB,CAAC,iCAAkC,WAAY,EAAE,EAAE,KAAK,CAAC,CAAC;gBAC5F,KAAK,KAAK,YAAY,SAAS;oBAC3B,MAAM,IAAI,yBAAkB,CAAC,wDAAwD,EAAE,KAAK,CAAC,CAAC;gBAClG,KAAK,CAAG,KAAoB,CAAC,QAAQ;oBACjC,MAAM,IAAI,2BAAoB,CAAC,4BAA6B,WAAY,EAAE,EAAE,KAAK,CAAC,CAAC;gBACvF;oBACI,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,QAAQ,CAAC;oBAEnC,OAAO,KAAK,CAAC,QAAQ,CAAC;aAC7B;SACJ;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,UAAU,CAAC,MAA0B;QACjC,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC;QAEtE,OAAO,OAAO;YACV,CAAC,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,QAAQ,EAAE;YACzC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;IACrB,CAAC;IAED;;;;;;;;OAQG;IACH,eAAe,CAAI,eAA+C;QAC9D,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YACpB,MAAM,IAAI,iBAAU,CAAC,sEAAsE,CAAC,CAAC;SAChG;QAED,OAAO,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC;CACJ;AA9ID,8BA8IC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serenity-js/rest",
-  "version": "3.10.2",
+  "version": "3.10.4",
   "description": "Test REST APIs with Serenity/JS",
   "author": {
     "name": "Jan Molak",
@@ -45,20 +45,20 @@
     "node": "^16.13 || ^18.12 || ^20"
   },
   "dependencies": {
-    "@serenity-js/core": "3.10.2",
+    "@serenity-js/core": "3.10.4",
     "axios": "^1.5.0"
   },
   "devDependencies": {
     "@integration/testing-tools": "3.0.0",
-    "@serenity-js/assertions": "3.10.2",
+    "@serenity-js/assertions": "3.10.4",
     "@types/chai": "^4.3.6",
     "@types/mocha": "^10.0.1",
-    "axios-mock-adapter": "1.21.5",
+    "axios-mock-adapter": "1.22.0",
     "c8": "8.0.1",
     "mocha": "^10.2.0",
     "mocha-multi": "^1.1.7",
     "ts-node": "^10.9.1",
     "typescript": "5.1.6"
   },
-  "gitHead": "6834827fffe5dd8dd3d2f39d2fea2c4039ab1d3d"
+  "gitHead": "28f12bd6029a9a6c1d8e492486138bf0c83916cd"
 }

package/src/screenplay/abilities/CallAnApi.ts

@@ -1,5 +1,5 @@
 import { Ability, ConfigurationError, LogicError, TestCompromisedError } from '@serenity-js/core';
-import type { AxiosDefaults, AxiosError, AxiosInstance, AxiosPromise, AxiosRequestConfig, AxiosResponse } from 'axios';
+import type { AxiosDefaults, AxiosError, AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
 import axios from 'axios';
 
 /**
@@ -132,8 +132,36 @@ export class CallAnApi extends Ability {
      *  Axios request configuration, which can be used to override the defaults
      *  provided when the {@apilink Ability|ability} to {@apilink CallAnApi} was instantiated.
      */
-    request(config: AxiosRequestConfig): Promise<AxiosResponse> {
-        return this.captureResponseOf(this.axiosInstance.request(config));
+    async request(config: AxiosRequestConfig): Promise<AxiosResponse> {
+        let url: string;
+
+        try {
+            url = this.resolveUrl(config);
+            this.lastResponse = await this.axiosInstance.request({
+                ...config,
+                url,
+            });
+
+            return this.lastResponse;
+        }
+        catch(error) {
+            const description = `${ config.method.toUpperCase() } ${ url || config.url }`;
+
+            switch (true) {
+                case /timeout.*exceeded/.test(error.message):
+                    throw new TestCompromisedError(`The request has timed out: ${ description }`, error);
+                case /Network Error/.test(error.message):
+                    throw new TestCompromisedError(`A network error has occurred: ${ description }`, error);
+                case error instanceof TypeError:
+                    throw new ConfigurationError(`Looks like there was an issue with Axios configuration`, error);
+                case ! (error as AxiosError).response:
+                    throw new TestCompromisedError(`The API call has failed: ${ description }`, error);
+                default:
+                    this.lastResponse = error.response;
+
+                    return error.response;
+            }
+        }
     }
 
     /**
@@ -147,7 +175,11 @@ export class CallAnApi extends Ability {
      * @param config
      */
     resolveUrl(config: AxiosRequestConfig): string {
-        return this.axiosInstance.getUri(config);
+        const baseURL = this.axiosInstance.defaults.baseURL || config.baseURL;
+
+        return baseURL
+            ? new URL(config.url, baseURL).toString()
+            : config.url;
     }
 
     /**
@@ -166,31 +198,4 @@ export class CallAnApi extends Ability {
 
         return mappingFunction(this.lastResponse);
     }
-
-    private captureResponseOf(promisedResponse: AxiosPromise): AxiosPromise {
-        return promisedResponse
-            .then(
-                lastResponse => {
-                    this.lastResponse = lastResponse;
-
-                    return lastResponse;
-                },
-                error => {
-                    switch (true) {
-                        case /timeout.*exceeded/.test(error.message):
-                            throw new TestCompromisedError(`The request has timed out`, error);
-                        case /Network Error/.test(error.message):
-                            throw new TestCompromisedError(`A network error has occurred`, error);
-                        case error instanceof TypeError:
-                            throw new ConfigurationError(`Looks like there was an issue with Axios configuration`, error);
-                        case ! (error as AxiosError).response:
-                            throw new TestCompromisedError(`The API call has failed`, error);   // todo: include request url
-                        default:
-                            this.lastResponse = error.response;
-
-                            return error.response;
-                    }
-                },
-            );
-    }
 }