@unito/integration-cli 0.60.2 → 0.60.3

package/dist/boilerplate/.nvmrc

@@ -1 +1 @@
-lts/iron
+20.9

package/dist/boilerplate/Dockerfile

@@ -4,7 +4,7 @@
 # Build
 #
 
-FROM --platform=$BUILDPLATFORM public.ecr.aws/docker/library/node:20-alpine as build
+FROM --platform=$BUILDPLATFORM public.ecr.aws/docker/library/node:20.9-alpine as build
 
 WORKDIR /build
 
@@ -19,7 +19,7 @@ RUN npm run compile
 # Runtime
 #
 
-FROM --platform=$TARGETPLATFORM public.ecr.aws/docker/library/node:20-alpine as runtime
+FROM --platform=$TARGETPLATFORM public.ecr.aws/docker/library/node:20.9-alpine as runtime
 
 WORKDIR /app
 

package/dist/boilerplate/package.json

@@ -20,13 +20,13 @@
     "email": "hello@unito.io"
   },
   "engines": {
-    "node": ">=20.0.0"
+    "node": "20.9"
   },
   "dependencies": {
     "@unito/integration-sdk": "^0.x"
   },
   "devDependencies": {
-    "@types/node": "20.x",
+    "@types/node": "20.9.x",
     "typescript-eslint": "7.x",
     "eslint": "8.x",
     "npm-audit-resolver": "^3.0.0-RC.0",

package/dist/src/services/oauth2.js

@@ -41,9 +41,6 @@ class OAuth2Service {
      */
     constructor(authorizationInfo, environment = globalConfiguration_1.Environment.Production, credentialPayload) {
         const { clientId, clientSecret, authorizationUrl, scopes, tokenUrl, grantType, requestContentType, refreshRequestParameters, tokenRequestParameters, } = authorizationInfo;
-        this.startServer = this.startServer.bind(this);
-        this.stopServer = this.stopServer.bind(this);
-        this.handleCallback = this.handleCallback.bind(this);
         this.clientId = clientId;
         this.clientSecret = clientSecret;
         this.providerAuthorizationUrl = authorizationUrl;
@@ -99,7 +96,8 @@ class OAuth2Service {
         // Error response: https://www.rfc-editor.org/rfc/rfc6749#section-4.1.2.1
         const error = req.query.error;
         if (error) {
-            res.setHeader('Content-Type', 'text/html').send(exports.HTML_ERROR_MSG);
+            res.setHeader('Content-Type', 'text/html');
+            res.send(exports.HTML_ERROR_MSG);
             return;
         }
         // We keep all the non-standard query parameters of the authorization response
@@ -130,16 +128,17 @@ class OAuth2Service {
             ])),
         };
         try {
-            const fetchResult = await fetch((0, template_1.expandTemplate)(this.tokenUrl, templateVariables, { urlEncodeVariables: true }), {
+            const tokenResponse = await fetch((0, template_1.expandTemplate)(this.tokenUrl, templateVariables, { urlEncodeVariables: true }), {
                 headers: tokenRequestHeaders,
                 body: this.encodeBody(tokenRequestPayload, this.requestContentType),
                 method: 'POST',
             });
-            if (fetchResult.status !== 200) {
+            if (tokenResponse.status !== 200) {
                 res.setHeader('Content-Type', 'text/html');
                 res.send(exports.HTML_ERROR_MSG);
+                return;
             }
-            const response = await fetchResult.json();
+            const response = await tokenResponse.json();
             this.oauth2Response = {
                 accessToken: response.access_token,
                 refreshToken: response.refresh_token,
@@ -148,8 +147,10 @@ class OAuth2Service {
             res.send(exports.HTML_SUCCESS_MSG);
         }
         catch (error) {
-            res.setHeader('Content-Type', 'text/html');
-            res.send(exports.HTML_ERROR_MSG);
+            if (!res.headersSent) {
+                res.setHeader('Content-Type', 'text/html');
+                res.send(exports.HTML_ERROR_MSG);
+            }
         }
     }
     /**
@@ -194,25 +195,23 @@ class OAuth2Service {
         if (this.clientSecret) {
             bodyData.client_secret = this.clientSecret;
         }
-        const fetchOptions = {
-            headers: {
-                'Content-Type': this.requestContentType,
-                ...(this.refreshRequestParameters?.header ?? {}),
-            },
-            body: this.encodeBody(bodyData, this.requestContentType),
-            method: 'POST',
-        };
         try {
-            const fetchResult = await fetch(this.tokenUrl, fetchOptions);
-            if (fetchResult.status !== 200) {
-                throw new errors_1.FailedToRetrieveAccessTokenError(await fetchResult.text());
+            const tokenResponse = await fetch(this.tokenUrl, {
+                headers: {
+                    'Content-Type': this.requestContentType,
+                    ...(this.refreshRequestParameters?.header ?? {}),
+                },
+                body: this.encodeBody(bodyData, this.requestContentType),
+                method: 'POST',
+            });
+            if (tokenResponse.status !== 200) {
+                throw new errors_1.FailedToRetrieveAccessTokenError(await tokenResponse.text());
             }
-            const response = await fetchResult.json();
-            const credentialsInfo = {
+            const response = await tokenResponse.json();
+            return {
                 accessToken: response.access_token,
                 refreshToken: response.refresh_token,
             };
-            return credentialsInfo;
         }
         catch (error) {
             throw new errors_1.FailedToRetrieveAccessTokenError(JSON.stringify(error));

package/dist/test/services/oauth2.test.js

@@ -13,7 +13,7 @@ describe('OAuth2Helper', () => {
     let openSpy;
     let fetchStub;
     describe('constructor', () => {
-        it('should throw an error if the request content type is not supported', async () => {
+        it('throws an error if the request content type is not supported', async () => {
             try {
                 new oauth2_1.default({ scopes: [], requestContentType: 'random' });
             }
@@ -51,18 +51,18 @@ describe('OAuth2Helper', () => {
             sinon_1.default.restore();
         });
         describe('authorize', () => {
-            it('should open the authorization URL', async () => {
+            it('opens the authorization URL', async () => {
                 await oauth2Helper.authorize();
                 sinon_1.default.assert.calledOnce(openSpy);
                 sinon_1.default.assert.calledWith(openSpy, 'https://provider.com/oauth/authorize?client_id=your-client-id&scope=scope1+scope2&state=eyJjbGlDYWxsYmFja1VybCI6Ii9vYXV0aDIvY2FsbGJhY2sifQ%3D%3D&response_type=code&redirect_uri=https%3A%2F%2Fintegrations-platform.unito.io%2Fcredentials%2Fnew%2Foauth2%2Fcallback-cli');
             });
-            it('should maintain the pre-existing query parameters in authorization URL', async () => {
+            it('maintains the pre-existing query parameters in authorization URL', async () => {
                 oauth2Helper['providerAuthorizationUrl'] = 'https://provider.com/oauth/authorize?query1=value1&query2=value2';
                 await oauth2Helper.authorize();
                 sinon_1.default.assert.calledOnce(openSpy);
                 sinon_1.default.assert.calledWith(openSpy, 'https://provider.com/oauth/authorize?query1=value1&query2=value2&client_id=your-client-id&scope=scope1+scope2&state=eyJjbGlDYWxsYmFja1VybCI6Ii9vYXV0aDIvY2FsbGJhY2sifQ%3D%3D&response_type=code&redirect_uri=https%3A%2F%2Fintegrations-platform.unito.io%2Fcredentials%2Fnew%2Foauth2%2Fcallback-cli');
             });
-            it('should support dynamic params', async () => {
+            it('supports dynamic params', async () => {
                 oauth2Helper['providerAuthorizationUrl'] = 'https://pro-{+foo}-der.com/oauth/authorize?query1={+bar}';
                 await oauth2Helper.authorize();
                 sinon_1.default.assert.calledOnce(openSpy);
@@ -70,7 +70,7 @@ describe('OAuth2Helper', () => {
             });
         });
         describe('handleCallback', () => {
-            it('should retrieve the access token and return it in the response', async () => {
+            it('retrieves the access token and return it in the response', async () => {
                 const code = 'test-code';
                 const req = { query: { code } };
                 const res = { send: sinon_1.default.stub(), setHeader: sinon_1.default.stub() };
@@ -87,7 +87,7 @@ describe('OAuth2Helper', () => {
                 sinon_1.default.assert.calledOnce(res.send);
                 sinon_1.default.assert.calledWith(res.send, oauth2Namespace.HTML_SUCCESS_MSG);
             });
-            it('should handle dynamic variables with values from provider response and credential payload', async () => {
+            it('handles dynamic variables with values from provider response and credential payload', async () => {
                 oauth2Helper['tokenUrl'] = 'https://{+foo}.com/oauth/token?specialParam={+authorizationResponse.responseValue}';
                 const code = 'test-code';
                 const req = { query: { code, responseValue: 'DynamicValue' } };
@@ -105,7 +105,7 @@ describe('OAuth2Helper', () => {
                 sinon_1.default.assert.calledOnce(res.send);
                 sinon_1.default.assert.calledWith(res.send, oauth2Namespace.HTML_SUCCESS_MSG);
             });
-            it('should handle errors and return 500 status', async () => {
+            it('handles errors - fetch exception', async () => {
                 const code = 'test-code';
                 const req = { query: { code } };
                 const res = { send: sinon_1.default.stub(), setHeader: sinon_1.default.stub() };
@@ -114,9 +114,18 @@ describe('OAuth2Helper', () => {
                 sinon_1.default.assert.calledOnce(res.send);
                 sinon_1.default.assert.calledWith(res.send, oauth2Namespace.HTML_ERROR_MSG);
             });
+            it('handles errors - response', async () => {
+                const code = 'test-code';
+                const req = { query: { code } };
+                const res = { send: sinon_1.default.stub(), setHeader: sinon_1.default.stub() };
+                fetchStub.resolves({ status: 500 });
+                await oauth2Helper['handleCallback'](req, res);
+                sinon_1.default.assert.calledOnce(res.send);
+                sinon_1.default.assert.calledWith(res.send, oauth2Namespace.HTML_ERROR_MSG);
+            });
         });
         describe('updateToken', () => {
-            it('should retrieve the access token when a refresh token is available', async () => {
+            it('retrieves the access token when a refresh token is available', async () => {
                 const refreshToken = 'test-refresh-token';
                 const accessToken = 'test-access-token';
                 const fetchResponse = { access_token: accessToken, refresh_token: refreshToken };
@@ -125,14 +134,14 @@ describe('OAuth2Helper', () => {
                 strict_1.default.deepEqual(result, { accessToken, refreshToken });
                 sinon_1.default.assert.calledOnce(fetchStub);
             });
-            it('should throw an error when failing to refresh the access token', async () => {
+            it('throws an error when failing to refresh the access token', async () => {
                 const refreshToken = 'test-refresh-token';
                 fetchStub.rejects(new Error('Failed to retrieve access token'));
                 const response = oauth2Helper.updateToken(refreshToken);
                 await strict_1.default.rejects(response, errors_1.FailedToRetrieveAccessTokenError);
                 sinon_1.default.assert.calledOnce(fetchStub);
             });
-            it("should throw an error if we don't support the request content type", async () => {
+            it("throws an error if we don't support the request content type", async () => {
                 const refreshToken = 'test-refresh-token';
                 oauth2Helper['requestContentType'] = 'random';
                 const response = oauth2Helper.updateToken(refreshToken);
@@ -140,14 +149,14 @@ describe('OAuth2Helper', () => {
             });
         });
         describe('encodeBody', () => {
-            it('should encode body data as URL-encoded when content type is URL_ENCODED', () => {
+            it('encodes body data as URL-encoded when content type is URL_ENCODED', () => {
                 const bodyData = { key1: 'value1', key2: 'value2' };
                 const contentType = configurationTypes_1.RequestContentType.URL_ENCODED;
                 const expectedEncodedBody = 'key1=value1&key2=value2';
                 const encodedBody = oauth2Helper['encodeBody'](bodyData, contentType);
                 strict_1.default.equal(encodedBody, expectedEncodedBody);
             });
-            it('should encode body data as JSON when content type is JSON', () => {
+            it('encodes body data as JSON when content type is JSON', () => {
                 const bodyData = { key1: 'value1', key2: 'value2' };
                 const contentType = configurationTypes_1.RequestContentType.JSON;
                 const expectedEncodedBody = JSON.stringify(bodyData);

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.60.2",
+  "version": "0.60.3",
   "commands": {
     "activity": {
       "id": "activity",
@@ -9,6 +9,7 @@
       "pluginAlias": "@unito/integration-cli",
       "pluginType": "core",
       "aliases": [],
+      "hiddenAliases": [],
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -52,6 +53,7 @@
       "pluginAlias": "@unito/integration-cli",
       "pluginType": "core",
       "aliases": [],
+      "hiddenAliases": [],
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -146,6 +148,7 @@
       "pluginAlias": "@unito/integration-cli",
       "pluginType": "core",
       "aliases": [],
+      "hiddenAliases": [],
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -179,6 +182,7 @@
       "pluginAlias": "@unito/integration-cli",
       "pluginType": "core",
       "aliases": [],
+      "hiddenAliases": [],
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> --name pokemon"
@@ -202,6 +206,7 @@
       "pluginAlias": "@unito/integration-cli",
       "pluginType": "core",
       "aliases": [],
+      "hiddenAliases": [],
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -229,6 +234,7 @@
       "pluginAlias": "@unito/integration-cli",
       "pluginType": "core",
       "aliases": [],
+      "hiddenAliases": [],
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -257,6 +263,7 @@
       "pluginAlias": "@unito/integration-cli",
       "pluginType": "core",
       "aliases": [],
+      "hiddenAliases": [],
       "examples": [
         "<%= config.bin %> <%= command.id %>",
         "<%= config.bin %> <%= command.id %> --reauth --test-account=compliance"
@@ -310,6 +317,7 @@
       "pluginAlias": "@unito/integration-cli",
       "pluginType": "core",
       "aliases": [],
+      "hiddenAliases": [],
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -382,6 +390,7 @@
       "pluginAlias": "@unito/integration-cli",
       "pluginType": "core",
       "aliases": [],
+      "hiddenAliases": [],
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
@@ -513,6 +522,7 @@
       "pluginAlias": "@unito/integration-cli",
       "pluginType": "core",
       "aliases": [],
+      "hiddenAliases": [],
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unito/integration-cli",
-  "version": "0.60.2",
+  "version": "0.60.3",
   "description": "Integration CLI",
   "bin": {
     "integration-cli": "./bin/run"