fix: salesforce v2 refactor

src/v0/destinations/salesforce/config.js

@@ -27,6 +27,7 @@ const DESTINATION = 'Salesforce';
 const SALESFORCE_OAUTH_SANDBOX = 'salesforce_oauth_sandbox';
 const OAUTH = 'oauth';
 const LEGACY = 'legacy';
+const SALESFORCE_OAUTH = 'salesforce_oauth';
 
 const mappingConfig = getMappingConfig(ConfigCategory, __dirname);
 
@@ -42,5 +43,6 @@ module.exports = {
   DESTINATION,
   OAUTH,
   LEGACY,
+  SALESFORCE_OAUTH,
   SALESFORCE_OAUTH_SANDBOX,
 };

src/v0/destinations/salesforce/networkHandler.js

@@ -1,18 +1,22 @@
 const { proxyRequest, prepareProxyRequest } = require('../../../adapters/network');
 const { processAxiosResponse } = require('../../../adapters/utils/networkUtils');
+const { isHttpStatusSuccess } = require('../../util');
 const { LEGACY } = require('./config');
 const { salesforceResponseHandler } = require('./utils');
 
 const responseHandler = (responseParams) => {
   const { destinationResponse, destType, rudderJobMetadata } = responseParams;
   const message = `Request for destination: ${destType} Processed Successfully`;
+  const { status } = destinationResponse;
 
-  salesforceResponseHandler(
-    destinationResponse,
-    'during Salesforce Response Handling',
-    rudderJobMetadata?.destInfo?.authKey,
-    LEGACY,
-  );
+  if (!isHttpStatusSuccess(status) && status >= 400) {
+    salesforceResponseHandler(
+      destinationResponse,
+      'during Salesforce Response Handling',
+      rudderJobMetadata?.destInfo?.authKey,
+      LEGACY,
+    );
+  }
 
   // else successfully return status as 200, message and original destination response
   return {

src/v0/destinations/salesforce/utils.js

@@ -3,13 +3,10 @@
   ThrottledError,
   AbortedError,
   OAuthSecretError,
+  isDefinedAndNotNull,
 } = require('@rudderstack/integrations-lib');
 const { handleHttpRequest } = require('../../../adapters/network');
-const {
-  isHttpStatusSuccess,
-  getAuthErrCategoryFromStCode,
-  isDefinedAndNotNull,
-} = require('../../util');
+const { getAuthErrCategoryFromStCode } = require('../../util');
 const Cache = require('../../util/cache');
 const {
   ACCESS_TOKEN_CACHE_TTL,
@@ -18,11 +15,69 @@
   DESTINATION,
   LEGACY,
   OAUTH,
+  SALESFORCE_OAUTH,
   SALESFORCE_OAUTH_SANDBOX,
 } = require('./config');
 
 const ACCESS_TOKEN_CACHE = new Cache(ACCESS_TOKEN_CACHE_TTL);
 
+// ref: https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/errorcodes.htm?q=error%20code
+/**
+ * 
+ * @param {*} response is of structure
+ * [
+ * {
+ *  "message" : "The requested resource does not exist",
+ *  "errorCode" : "NOT_FOUND"
+}
+]
+ * @returns error message
+ */
+const getErrorMessage = (response) => {
+  if (response && Array.isArray(response) && response[0]?.message?.length > 0) {
+    return response[0].message;
+  }
+  return JSON.stringify(response);
+};
+
+const handleAuthError = (
+  errorCode,
+  authKey,
+  authorizationFlow,
+  sourceMessage,
+  destResponse,
+  status,
+) => {
+  if (errorCode === 'INVALID_SESSION_ID') {
+    let authErrCategory = '';
+    if (authorizationFlow === OAUTH) {
+      authErrCategory = getAuthErrCategoryFromStCode(status);
+    } else {
+      ACCESS_TOKEN_CACHE.del(authKey);
+    }
+    throw new RetryableError(
+      `${DESTINATION} Request Failed - due to "INVALID_SESSION_ID", (${authErrCategory}) ${sourceMessage}`,
+      500,
+      destResponse,
+      authErrCategory,
+    );
+  }
+
+  throw new AbortedError(
+    `${DESTINATION} Request Failed: "${status}" due to "${getErrorMessage(destResponse.response)}", (Aborted) ${sourceMessage}`,
+    400,
+    destResponse,
+  );
+};
+
+const handleCommonAbortableError = (destResponse, sourceMessage, status) => {
+  throw new AbortedError(
+    `${DESTINATION} Request Failed: "${status}" due to "${getErrorMessage(destResponse.response)}", (Aborted) ${sourceMessage}`,
+    400,
+    destResponse,
+  );
+};
+
 /**
  * ref: https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/errorcodes.htm
  * handles Salesforce application level failures
@@ -34,72 +89,70 @@
 const salesforceResponseHandler = (destResponse, sourceMessage, authKey, authorizationFlow) => {
   const { status, response } = destResponse;
 
-  // if the response from destination is not a success case build an explicit error
-  if (!isHttpStatusSuccess(status) && status >= 400) {
-    const matchErrorCode = (errorCode) =>
-      response && Array.isArray(response) && response.some((resp) => resp?.errorCode === errorCode);
-    if (status === 401 && authKey && matchErrorCode('INVALID_SESSION_ID')) {
-      if (authorizationFlow === OAUTH) {
+  /**
+   *
+   * @param {*} errorCode
+   * response is of structure
+   * [
+   * {
+   *  "message" : "Request limit exceeded",
+   *  "errorCode" : "REQUEST_LIMIT_EXCEEDED"
+   * }
+   * ]
+   * @returns true if errorCode is found in the response
+   */
+  const matchErrorCode = (errorCode) =>
+    response && Array.isArray(response) && response.some((resp) => resp?.errorCode === errorCode);
+
+  switch (status) {
+    case 401: {
+      let errorCode = 'DEFAULT';
+      if (authKey && matchErrorCode('INVALID_SESSION_ID')) {
+        errorCode = 'INVALID_SESSION_ID';
+      }
+      handleAuthError(errorCode, authKey, authorizationFlow, sourceMessage, destResponse, status);
+      break;
+    }
+    case 403:
+      if (matchErrorCode('REQUEST_LIMIT_EXCEEDED')) {
+        throw new ThrottledError(
+          `${DESTINATION} Request Failed - due to "REQUEST_LIMIT_EXCEEDED", (Throttled) ${sourceMessage}`,
+          destResponse,
+        );
+      }
+      handleCommonAbortableError(destResponse, sourceMessage, status);
+      break;
+
+    case 400:
+      if (
+        matchErrorCode('CANNOT_INSERT_UPDATE_ACTIVATE_ENTITY') &&
+        (response?.message?.includes('UNABLE_TO_LOCK_ROW') ||
+          response?.message?.includes('Too many SOQL queries'))
+      ) {
         throw new RetryableError(
-          `${DESTINATION} Request Failed - due to "INVALID_SESSION_ID", (Retryable) ${sourceMessage}`,
+          `${DESTINATION} Request Failed - "${response.message}", (Retryable) ${sourceMessage}`,
           500,
           destResponse,
-          getAuthErrCategoryFromStCode(status),
         );
       }
-      // checking for invalid/expired token errors and evicting cache in that case
-      // rudderJobMetadata contains some destination info which is being used to evict the cache
-      ACCESS_TOKEN_CACHE.del(authKey);
-      throw new RetryableError(
-        `${DESTINATION} Request Failed - due to "INVALID_SESSION_ID", (Retryable) ${sourceMessage}`,
-        500,
-        destResponse,
-      );
-    } else if (status === 403 && matchErrorCode('REQUEST_LIMIT_EXCEEDED')) {
-      // If the error code is REQUEST_LIMIT_EXCEEDED, you’ve exceeded API request limits in your org.
-      throw new ThrottledError(
-        `${DESTINATION} Request Failed - due to "REQUEST_LIMIT_EXCEEDED", (Throttled) ${sourceMessage}`,
-        destResponse,
-      );
-    } else if (
-      status === 400 &&
-      matchErrorCode('CANNOT_INSERT_UPDATE_ACTIVATE_ENTITY') &&
-      (response?.message?.includes('UNABLE_TO_LOCK_ROW') ||
-        response?.message?.includes('Too many SOQL queries'))
-    ) {
-      // handling the error case where the record is locked by another background job
-      // this is a retryable error
+      handleCommonAbortableError(destResponse, sourceMessage, status);
+      break;
+
+    case 503:
+    case 500:
       throw new RetryableError(
-        `${DESTINATION} Request Failed - "${response.message}", (Retryable) ${sourceMessage}`,
+        `${DESTINATION} Request Failed: ${status} - due to "${getErrorMessage(response)}", (Retryable) ${sourceMessage}`,
         500,
         destResponse,
       );
-    } else if (status === 503 || status === 500) {
-      // The salesforce server is unavailable to handle the request. Typically this occurs if the server is down
-      // for maintenance or is currently overloaded.
-      throw new RetryableError(
-        `${DESTINATION} Request Failed - due to "${
-          response && Array.isArray(response) && response[0]?.message?.length > 0
-            ? response[0].message
-            : JSON.stringify(response)
-        }", (Retryable) ${sourceMessage}`,
-        500,
+
+    default:
+      // Default case: aborting for all other error codes
+      throw new AbortedError(
+        `${DESTINATION} Request Failed: "${status}" due to "${getErrorMessage(response)}", (Aborted) ${sourceMessage}`,
+        400,
         destResponse,
       );
-    }
-    // check the error message
-    let errorMessage = '';
-    if (response && Array.isArray(response)) {
-      errorMessage = response[0].message;
-    }
-    // aborting for all other error codes
-    throw new AbortedError(
-      `${DESTINATION} Request Failed: "${status}" due to "${
-        errorMessage || JSON.stringify(response)
-      }", (Aborted) ${sourceMessage}`,
-      400,
-      destResponse,
-    );
   }
 };
 
@@ -182,7 +235,7 @@
   let authorizationData;
   const { Name } = event.destination.DestinationDefinition;
   const lowerCaseName = Name?.toLowerCase?.();
-  if (isDefinedAndNotNull(event?.metadata?.secret) || lowerCaseName === SALESFORCE_OAUTH_SANDBOX) {
+  if (lowerCaseName === SALESFORCE_OAUTH_SANDBOX || lowerCaseName === SALESFORCE_OAUTH) {
     authorizationFlow = OAUTH;
     authorizationData = getAccessTokenOauth(event.metadata);
   } else {

src/v0/destinations/salesforce_oauth/networkHandler.js

@@ -1,18 +1,22 @@
 const { proxyRequest, prepareProxyRequest } = require('../../../adapters/network');
 const { processAxiosResponse } = require('../../../adapters/utils/networkUtils');
+const { isHttpStatusSuccess } = require('../../util');
 const { OAUTH } = require('../salesforce/config');
 const { salesforceResponseHandler } = require('../salesforce/utils');
 
 const responseHandler = (responseParams) => {
   const { destinationResponse, destType, rudderJobMetadata } = responseParams;
   const message = `Request for destination: ${destType} Processed Successfully`;
+  const { status } = destinationResponse;
 
-  salesforceResponseHandler(
-    destinationResponse,
-    'during Salesforce Response Handling',
-    rudderJobMetadata?.destInfo?.authKey,
-    OAUTH,
-  );
+  if (!isHttpStatusSuccess(status) && status >= 400) {
+    salesforceResponseHandler(
+      destinationResponse,
+      'during Salesforce Response Handling',
+      rudderJobMetadata?.destInfo?.authKey,
+      OAUTH,
+    );
+  }
 
   // else successfully return status as 200, message and original destination response
   return {

test/integrations/destinations/salesforce/dataDelivery/business.ts

@@ -150,7 +150,7 @@ export const testScenariosForV1API: ProxyV1TestData[] = [
           output: {
             status: 500,
             message:
-              'Salesforce Request Failed - due to "Session expired or invalid", (Retryable) during Salesforce Response Handling',
+              'Salesforce Request Failed: 500 - due to "Session expired or invalid", (Retryable) during Salesforce Response Handling',
             response: [
               {
                 error:
@@ -277,7 +277,7 @@ export const testScenariosForV1API: ProxyV1TestData[] = [
         body: {
           output: {
             message:
-              'Salesforce Request Failed - due to "Server Unavailable", (Retryable) during Salesforce Response Handling',
+              'Salesforce Request Failed: 503 - due to "Server Unavailable", (Retryable) during Salesforce Response Handling',
             response: [
               {
                 error: '[{"message":"Server Unavailable","errorCode":"SERVER_UNAVAILABLE"}]',

test/integrations/destinations/salesforce/dataDelivery/data.ts

@@ -112,7 +112,7 @@ const legacyTests = [
           output: {
             status: 500,
             message:
-              'Salesforce Request Failed - due to "INVALID_SESSION_ID", (Retryable) during Salesforce Response Handling',
+              'Salesforce Request Failed - due to "INVALID_SESSION_ID", () during Salesforce Response Handling',
             destinationResponse: {
               response: [
                 {
@@ -319,7 +319,7 @@ const legacyTests = [
           output: {
             status: 500,
             message:
-              'Salesforce Request Failed - due to "Server Unavailable", (Retryable) during Salesforce Response Handling',
+              'Salesforce Request Failed: 503 - due to "Server Unavailable", (Retryable) during Salesforce Response Handling',
             destinationResponse: {
               response: [
                 {
@@ -461,7 +461,7 @@ const legacyTests = [
               status: 503,
             },
             message:
-              'Salesforce Request Failed - due to "{"message":"Server Unavailable","errorCode":"SERVER_UNAVAILABLE"}", (Retryable) during Salesforce Response Handling',
+              'Salesforce Request Failed: 503 - due to "{"message":"Server Unavailable","errorCode":"SERVER_UNAVAILABLE"}", (Retryable) during Salesforce Response Handling',
             statTags: {
               destType: 'SALESFORCE',
               errorCategory: 'network',
@@ -603,7 +603,7 @@ const legacyTests = [
           output: {
             status: 500,
             message:
-              'Salesforce Request Failed - due to ""[ECONNABORTED] :: Connection aborted"", (Retryable) during Salesforce Response Handling',
+              'Salesforce Request Failed: 500 - due to ""[ECONNABORTED] :: Connection aborted"", (Retryable) during Salesforce Response Handling',
             destinationResponse: {
               response: '[ECONNABORTED] :: Connection aborted',
               status: 500,
@@ -696,7 +696,7 @@ const legacyTests = [
           output: {
             status: 500,
             message:
-              'Salesforce Request Failed - due to ""[EAI_AGAIN] :: Temporary failure in name resolution"", (Retryable) during Salesforce Response Handling',
+              'Salesforce Request Failed: 500 - due to ""[EAI_AGAIN] :: Temporary failure in name resolution"", (Retryable) during Salesforce Response Handling',
             destinationResponse: {
               response: '[EAI_AGAIN] :: Temporary failure in name resolution',
               status: 500,

test/integrations/destinations/salesforce/dataDelivery/other.ts

@@ -58,7 +58,7 @@ export const otherSalesforceScenariosV1: ProxyV1TestData[] = [
             ],
             statTags,
             message:
-              'Salesforce Request Failed - due to "{"error":{"message":"Service Unavailable","description":"The server is currently unable to handle the request due to temporary overloading or maintenance of the server. Please try again later."}}", (Retryable) during Salesforce Response Handling',
+              'Salesforce Request Failed: 503 - due to "{"error":{"message":"Service Unavailable","description":"The server is currently unable to handle the request due to temporary overloading or maintenance of the server. Please try again later."}}", (Retryable) during Salesforce Response Handling',
             status: 500,
           },
         },
@@ -96,7 +96,7 @@ export const otherSalesforceScenariosV1: ProxyV1TestData[] = [
             ],
             statTags,
             message:
-              'Salesforce Request Failed - due to ""Internal Server Error"", (Retryable) during Salesforce Response Handling',
+              'Salesforce Request Failed: 500 - due to ""Internal Server Error"", (Retryable) during Salesforce Response Handling',
             status: 500,
           },
         },