Introduce baseURL in Raw Request Action axios config

Author: A3a3e1

CHANGELOG.md

@@ -1,4 +1,8 @@
-## 2.8.2 (February 02, 2023)
+## 2.8.3 (February 27, 2024)
+* The component interface has not changed. This is a technical enhancement! Introduced baseURL parameter in the `Raw Request` Action's configuration of the axios library. Refer to the [Readme](README.md#raw-request) for the details. 
+It will not affect any of the existing integration. Instead, it gives more flexibility allowing to call other REST endpoints than the standard `/services/data` [(#82)](https://github.com/elasticio/salesforce-component-v2/issues/82)
+
+## 2.8.2 (February 02, 2024)
 * Fixed bug when component didn't use `replayId` after error in `Subscribe to PubSub` trigger
 
 ## 2.8.1 (December 28, 2023)

README.md

@@ -358,8 +358,13 @@ Empty object will be returned, if query doesn't find any data.
 
 ### Raw Request
 
+This function executes a custom REST API call request. By default, the service called is `/services/data`, which encompasses most of the services provided by Salesforce. 
+Alternatively, you can call any other services, such as `/services/apexrest`, by specifying the full URL instead of a relative one.
+
 #### Input Metadata
 * HTTP Verb - Allowed values GET, POST, PUT, PATCH, DELETE, HEAD, Required. HTTP verb to use in the request.
+  * To call services based on the `/services/data` endpoint, you can utilize a relative path, for instance, `query/?q=SELECT+Id,Name+FROM+Account`. This automatically constructs the URL as follows: `https://{your_instance}.salesforce.com/services/data/{SALESFORCE_API_VERSION}/query/?q=SELECT+Id,Name+FROM+Account`
+  * For calling other services like `/services/apexrest`, provide **the full URL**, such as `https://{your_instance}.salesforce.com/services/apexrest/myApexClass`
 * Path - String, Required. Use a relative path to make a request (for a list of all types of objects - `sobjects`, e.g., to list the type of objects Account - `sobjects/account`). Since Salesforce sends the endpoint that must be called dynamically, there is no need to enter the base URL like this - `https://{INSTANCE_NAME}.salesforce.com/services/data/v{SALESFORCE_API_VERSION}/sobjects/{SALESFORCE_OBJECT}`. Instead, you should use a relative path - `sobjects/{SALESFORCE_OBJECT}`.
 * Request Body - Object, Optional. Body to attach to the HTTP Request
 

component.json

@@ -2,8 +2,8 @@
   "title": "Salesforce v2",
   "description": "Customer relationship management (CRM) software & cloud computing from the leader in CRM solutions for businesses large & small.",
   "docsUrl": "https://github.com/elasticio/salesforce-component-v2",
-  "url": "http://www.salesforce.com/",
-  "version": "2.8.2",
+  "url": "https://www.salesforce.com/",
+  "version": "2.8.3",
   "authClientTypes": [
     "oauth2"
   ],
@@ -703,4 +703,4 @@
       }
     }
   }
-}
+}

lib/actions/rawRequest.js

@@ -43,11 +43,11 @@ async function processAction(msg, cfg) {
       logger.info('Trying to call method %s', method);
       const basePath = `/services/data/v${SALESFORCE_VERSION}/`;
       const resourcePath = (path.trim().charAt(0) === '/') ? path.trim().slice(1) : path.trim();
-      const rawRequestPath = `${instanceUrl}${basePath}${resourcePath}`;
       const lowerCasedMethod = method.toLowerCase();
       const rawRequestConfig = {
+        baseURL: `${instanceUrl}${basePath}`,
         method: lowerCasedMethod,
-        url: rawRequestPath,
+        url: resourcePath,
         headers: {
           Authorization: `Bearer ${accessToken && accessToken.replace(/"|'/g, '')}`,
           'Content-Type': 'application/json',

spec/actions/rawRequest.spec.js

@@ -9,7 +9,7 @@ const {
 const processAction = require('../../lib/actions/rawRequest');
 
 describe('Raw request test', () => {
-  describe('Should succeed with method GET resource sobjects', () => {
+  describe('Should succeed with method GET, relative URL, resource sobjects', () => {
     it('Retrieves the list of queryable sobjects', async () => {
       const testCfg = { ...defaultCfg };
       const msg = { body: { method: 'GET', path: 'sobjects' } };
@@ -29,6 +29,29 @@ describe('Raw request test', () => {
     });
   });
 
+  describe('Should succeed with method GET, absolute URL, resource apexrest', () => {
+    it('Retrieves the list of queryable sobjects', async () => {
+      const testCfg = { ...defaultCfg };
+      const msg = {
+        body: {
+          method: 'POST',
+          path: `${testsCommon.instanceUrl}/services/apexrest/echoRequest`,
+          body: {
+            text: 'fool',
+          },
+        },
+      };
+
+      fetchToken();
+      const scope = nock(testsCommon.instanceUrl)
+        .post('/services/apexrest/echoRequest')
+        .reply(200, 'No, you are fool');
+      const result = await processAction.process.call(getContext(), msg, testCfg);
+      expect(result.body).to.have.eql('No, you are fool');
+      scope.done();
+    });
+  });
+
   describe('Should succeed with method POST request create record', () => {
     it('Retrieves the list of limits', async () => {
       const testCfg = { ...defaultCfg };