[Salesforce] Alternative authentication flow

packages/core/src/index.ts

@@ -29,6 +29,7 @@ export {
 export { createTestEvent } from './create-test-event'
 export { createTestIntegration } from './create-test-integration'
 export { default as createInstance } from './request-client'
+export { default as createRequestClient } from './create-request-client'
 export { defaultValues } from './defaults'
 export {
   IntegrationError,

packages/destination-actions/src/destinations/salesforce/__tests__/sf-operations.test.ts

@@ -1,8 +1,9 @@
 import nock from 'nock'
 import createRequestClient from '../../../../../core/src/create-request-client'
-import Salesforce from '../sf-operations'
+import Salesforce, { authenticateWithPassword } from '../sf-operations'
 import { API_VERSION } from '../sf-operations'
 import type { GenericPayload } from '../sf-types'
+import { Settings } from '../generated-types'
 
 const settings = {
   instanceUrl: 'https://test.salesforce.com/'
@@ -771,4 +772,70 @@ describe('Salesforce', () => {
       )
     })
   })
+
+  describe('Username & Password flow', () => {
+    const usernamePasswordOnly: Settings = {
+      username: '[email protected]',
+      auth_password: 'gary1997',
+      instanceUrl: 'https://spongebob.salesforce.com/',
+      isSandbox: false
+    }
+
+    const usernamePasswordAndToken: Settings = {
+      username: '[email protected]',
+      auth_password: 'gary1997',
+      instanceUrl: 'https://spongebob.salesforce.com/',
+      isSandbox: false,
+      security_token: 'abc123'
+    }
+
+    process.env['SALESFORCE_CLIENT_ID'] = 'id'
+    process.env['SALESFORCE_CLIENT_SECRET'] = 'secret'
+
+    it('should authenticate using the username and password flow when only the username and password are provided', async () => {
+      nock('https://login.salesforce.com/services/oauth2/token')
+        .post('', {
+          grant_type: 'password',
+          client_id: 'id',
+          client_secret: 'secret',
+          username: usernamePasswordOnly.username,
+          password: usernamePasswordOnly.auth_password
+        })
+        .reply(201, {
+          access_token: 'abc'
+        })
+
+      const res = await authenticateWithPassword(
+        usernamePasswordOnly.username as string, // tells typescript that these are defined
+        usernamePasswordOnly.auth_password as string,
+        usernamePasswordOnly.security_token,
+        usernamePasswordOnly.isSandbox
+      )
+
+      expect(res.accessToken).toEqual('abc')
+    })
+
+    it('should authenticate using the username and password flow when the username, password and security token are provided', async () => {
+      nock('https://login.salesforce.com/services/oauth2/token')
+        .post('', {
+          grant_type: 'password',
+          client_id: 'id',
+          client_secret: 'secret',
+          username: usernamePasswordAndToken.username,
+          password: `${usernamePasswordAndToken.auth_password}${usernamePasswordAndToken.security_token}`
+        })
+        .reply(201, {
+          access_token: 'abc'
+        })
+
+      const res = await authenticateWithPassword(
+        usernamePasswordAndToken.username as string, // tells typescript that these are defined
+        usernamePasswordAndToken.auth_password as string,
+        usernamePasswordAndToken.security_token,
+        usernamePasswordAndToken.isSandbox
+      )
+
+      expect(res.accessToken).toEqual('abc')
+    })
+  })
 })

packages/destination-actions/src/destinations/salesforce/account/index.ts

@@ -1,6 +1,6 @@
 import { ActionDefinition, IntegrationError } from '@segment/actions-core'
 import type { Settings } from '../generated-types'
-import Salesforce from '../sf-operations'
+import Salesforce, { generateSalesforceRequest } from '../sf-operations'
 import {
   bulkUpsertExternalId,
   bulkUpdateRecordId,
@@ -181,7 +181,7 @@ const action: ActionDefinition<Settings, Payload> = {
     customFields: customFields
   },
   perform: async (request, { settings, payload }) => {
-    const sf: Salesforce = new Salesforce(settings.instanceUrl, request)
+    const sf: Salesforce = new Salesforce(settings.instanceUrl, await generateSalesforceRequest(settings, request))
 
     if (payload.operation === 'create') {
       if (!payload.name) {
@@ -208,7 +208,7 @@ const action: ActionDefinition<Settings, Payload> = {
     }
   },
   performBatch: async (request, { settings, payload }) => {
-    const sf: Salesforce = new Salesforce(settings.instanceUrl, request)
+    const sf: Salesforce = new Salesforce(settings.instanceUrl, await generateSalesforceRequest(settings, request))
 
     if (payload[0].operation === 'upsert') {
       if (!payload[0].name) {

packages/destination-actions/src/destinations/salesforce/cases/index.ts

@@ -12,7 +12,7 @@ import {
   recordMatcherOperator,
   batch_size
 } from '../sf-properties'
-import Salesforce from '../sf-operations'
+import Salesforce, { generateSalesforceRequest } from '../sf-operations'
 
 const OBJECT_NAME = 'Case'
 
@@ -35,7 +35,7 @@ const action: ActionDefinition<Settings, Payload> = {
     customFields: customFields
   },
   perform: async (request, { settings, payload }) => {
-    const sf: Salesforce = new Salesforce(settings.instanceUrl, request)
+    const sf: Salesforce = new Salesforce(settings.instanceUrl, await generateSalesforceRequest(settings, request))
 
     if (payload.operation === 'create') {
       return await sf.createRecord(payload, OBJECT_NAME)
@@ -56,7 +56,7 @@ const action: ActionDefinition<Settings, Payload> = {
     }
   },
   performBatch: async (request, { settings, payload }) => {
-    const sf: Salesforce = new Salesforce(settings.instanceUrl, request)
+    const sf: Salesforce = new Salesforce(settings.instanceUrl, await generateSalesforceRequest(settings, request))
 
     return sf.bulkHandler(payload, OBJECT_NAME)
   }

packages/destination-actions/src/destinations/salesforce/contact/index.ts

@@ -12,7 +12,7 @@ import {
   recordMatcherOperator,
   batch_size
 } from '../sf-properties'
-import Salesforce from '../sf-operations'
+import Salesforce, { generateSalesforceRequest } from '../sf-operations'
 
 const OBJECT_NAME = 'Contact'
 
@@ -132,7 +132,7 @@ const action: ActionDefinition<Settings, Payload> = {
     customFields: customFields
   },
   perform: async (request, { settings, payload }) => {
-    const sf: Salesforce = new Salesforce(settings.instanceUrl, request)
+    const sf: Salesforce = new Salesforce(settings.instanceUrl, await generateSalesforceRequest(settings, request))
 
     if (payload.operation === 'create') {
       if (!payload.last_name) {
@@ -159,7 +159,7 @@ const action: ActionDefinition<Settings, Payload> = {
     }
   },
   performBatch: async (request, { settings, payload }) => {
-    const sf: Salesforce = new Salesforce(settings.instanceUrl, request)
+    const sf: Salesforce = new Salesforce(settings.instanceUrl, await generateSalesforceRequest(settings, request))
 
     if (payload[0].operation === 'upsert') {
       if (!payload[0].last_name) {

packages/destination-actions/src/destinations/salesforce/customObject/index.ts

@@ -12,7 +12,7 @@ import {
   recordMatcherOperator,
   batch_size
 } from '../sf-properties'
-import Salesforce from '../sf-operations'
+import Salesforce, { generateSalesforceRequest } from '../sf-operations'
 import { PayloadValidationError } from '@segment/actions-core'
 const OPERATIONS_WITH_CUSTOM_FIELDS = ['create', 'update', 'upsert']
 
@@ -39,7 +39,10 @@ const action: ActionDefinition<Settings, Payload> = {
   },
   dynamicFields: {
     customObjectName: async (request, data) => {
-      const sf: Salesforce = new Salesforce(data.settings.instanceUrl, request)
+      const sf: Salesforce = new Salesforce(
+        data.settings.instanceUrl,
+        await generateSalesforceRequest(data.settings, request)
+      )
 
       return sf.customObjectName()
     }
@@ -49,7 +52,7 @@ const action: ActionDefinition<Settings, Payload> = {
       throw new PayloadValidationError('Custom fields are required for this operation.')
     }
 
-    const sf: Salesforce = new Salesforce(settings.instanceUrl, request)
+    const sf: Salesforce = new Salesforce(settings.instanceUrl, await generateSalesforceRequest(settings, request))
 
     if (payload.operation === 'create') {
       return await sf.createRecord(payload, payload.customObjectName)
@@ -74,7 +77,7 @@ const action: ActionDefinition<Settings, Payload> = {
       throw new PayloadValidationError('Custom fields are required for this operation.')
     }
 
-    const sf: Salesforce = new Salesforce(settings.instanceUrl, request)
+    const sf: Salesforce = new Salesforce(settings.instanceUrl, await generateSalesforceRequest(settings, request))
 
     return sf.bulkHandler(payload, payload[0].customObjectName)
   }

packages/destination-actions/src/destinations/salesforce/index.ts

@@ -1,4 +1,4 @@
-import type { DestinationDefinition } from '@segment/actions-core'
+import { DestinationDefinition } from '@segment/actions-core'
 import type { Settings } from './generated-types'
 // This has to be 'cases' because 'case' is a Javascript reserved word
 import cases from './cases'
@@ -7,6 +7,7 @@ import opportunity from './opportunity'
 import customObject from './customObject'
 import contact from './contact'
 import account from './account'
+import { authenticateWithPassword } from './sf-operations'
 
 interface RefreshTokenResponse {
   access_token: string
@@ -33,9 +34,39 @@ const destination: DestinationDefinition<Settings> = {
           'Enable to authenticate into a sandbox instance. You can log in to a sandbox by appending the sandbox name to your Salesforce username. For example, if a username for a production org is [email protected] and the sandbox is named test, the username to log in to the sandbox is [email protected]. If you are already authenticated, please disconnect and reconnect with your sandbox username.',
         type: 'boolean',
         default: false
+      },
+      username: {
+        label: 'Username',
+        description:
+          'The username of the Salesforce account you want to connect to. When all three of username, password, and security token are provided, a username-password flow is used to authenticate. This field is hidden to all users except those who have opted in to the username+password flow.',
+        type: 'string'
+      },
+      auth_password: {
+        // auth_ prefix is used because password is a reserved word
+        label: 'Password',
+        description:
+          'The password of the Salesforce account you want to connect to. When all three of username, password, and security token are provided, a username-password flow is used to authenticate. This field is hidden to all users except those who have opted in to the username+password flow.',
+        type: 'string'
+      },
+      security_token: {
+        label: 'Security Token',
+        description:
+          'The security token of the Salesforce account you want to connect to. When all three of username, password, and security token are provided, a username-password flow is used to authenticate. This value will be appended to the password field to construct the credential used for authentication. This field is hidden to all users except those who have opted in to the username+password flow.',
+        type: 'string'
       }
     },
     refreshAccessToken: async (request, { auth, settings }) => {
+      if (settings.username && settings.auth_password) {
+        const { accessToken } = await authenticateWithPassword(
+          settings.username,
+          settings.auth_password,
+          settings.security_token,
+          settings.isSandbox
+        )
+
+        return { accessToken }
+      }
+
       // Return a request that refreshes the access_token if the API supports it
       const baseUrl = settings.isSandbox ? 'https://test.salesforce.com' : 'https://login.salesforce.com'
       const res = await request<RefreshTokenResponse>(`${baseUrl}/services/oauth2/token`, {

packages/destination-actions/src/destinations/salesforce/lead/index.ts

@@ -12,7 +12,7 @@ import {
   recordMatcherOperator,
   batch_size
 } from '../sf-properties'
-import Salesforce from '../sf-operations'
+import Salesforce, { generateSalesforceRequest } from '../sf-operations'
 
 const OBJECT_NAME = 'Lead'
 
@@ -139,7 +139,7 @@ const action: ActionDefinition<Settings, Payload> = {
     customFields: customFields
   },
   perform: async (request, { settings, payload }) => {
-    const sf: Salesforce = new Salesforce(settings.instanceUrl, request)
+    const sf: Salesforce = new Salesforce(settings.instanceUrl, await generateSalesforceRequest(settings, request))
 
     if (payload.operation === 'create') {
       if (!payload.last_name) {
@@ -166,7 +166,7 @@ const action: ActionDefinition<Settings, Payload> = {
     }
   },
   performBatch: async (request, { settings, payload }) => {
-    const sf: Salesforce = new Salesforce(settings.instanceUrl, request)
+    const sf: Salesforce = new Salesforce(settings.instanceUrl, await generateSalesforceRequest(settings, request))
 
     if (payload[0].operation === 'upsert') {
       if (!payload[0].last_name) {

packages/destination-actions/src/destinations/salesforce/opportunity/index.ts

@@ -1,6 +1,6 @@
 import { ActionDefinition, IntegrationError } from '@segment/actions-core'
 import type { Settings } from '../generated-types'
-import Salesforce from '../sf-operations'
+import Salesforce, { generateSalesforceRequest } from '../sf-operations'
 import {
   bulkUpsertExternalId,
   bulkUpdateRecordId,
@@ -56,7 +56,7 @@ const action: ActionDefinition<Settings, Payload> = {
     customFields: customFields
   },
   perform: async (request, { settings, payload }) => {
-    const sf: Salesforce = new Salesforce(settings.instanceUrl, request)
+    const sf: Salesforce = new Salesforce(settings.instanceUrl, await generateSalesforceRequest(settings, request))
 
     if (payload.operation === 'create') {
       if (!payload.close_date || !payload.name || !payload.stage_name) {
@@ -83,7 +83,7 @@ const action: ActionDefinition<Settings, Payload> = {
     }
   },
   performBatch: async (request, { settings, payload }) => {
-    const sf: Salesforce = new Salesforce(settings.instanceUrl, request)
+    const sf: Salesforce = new Salesforce(settings.instanceUrl, await generateSalesforceRequest(settings, request))
 
     if (payload[0].operation === 'upsert') {
       if (!payload[0].close_date || !payload[0].name || !payload[0].stage_name) {