Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[STRATCONN-5399]-Handles refresh token retry for multistatus responses #2674

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[STRATCONN-5399]-Handles refresh token retry for multistatus responses #2674

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
57b6f4f
Handles refresh token retry for multistatus responses
varadarajan-tw Jan 10, 2025
778f698
Add more assertions to tests
varadarajan-tw Jan 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
339 changes: 337 additions & 2 deletions packages/core/src/__tests__/destination-kit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ import {
TransactionContext,
AuthenticationScheme,
RefreshAccessTokenResult,
AudienceDestinationDefinition
AudienceDestinationDefinition,
OAuth2Authentication,
OAuthManagedAuthentication
} from '../destination-kit'
import { JSONObject } from '../json-object'
import { SegmentEvent } from '../segment-event'
Expand Down Expand Up @@ -374,7 +376,7 @@ const multiStatusCompatibleDestination: DestinationDefinition<JSONObject> = {
message: 'success'
}
},
performBatch: (_request, { payload }) => {
performBatch: (_request, { payload, auth }) => {
const response = new MultiStatusResponse()
payload.forEach((event) => {
// Emulate an API error
Expand All @@ -392,6 +394,21 @@ const multiStatusCompatibleDestination: DestinationDefinition<JSONObject> = {
return
}

// Emulate Auth error
if (auth?.accessToken === 'OldToken') {
response.pushErrorResponse({
status: 401,
errortype: ErrorCodes.INVALID_AUTHENTICATION,
errormessage: 'Invalid Auth',
sent: event,
body: {
events_processed: 0,
message: 'Invalid Auth'
}
})
return
}

if (event?.email) {
response.pushSuccessResponse({
body: {},
Expand Down Expand Up @@ -1919,5 +1936,323 @@ describe('destination kit', () => {
]
`)
})
test('should refresh access token and retry events in case multistatus response contains 401 for oauth2 destinations', async () => {
const mockRefreshToken = jest.fn().mockReturnValue({
accessToken: 'new-access-token'
})
const mockOnTokenRefresh = jest.fn().mockReturnValue(Promise.resolve())
const destinationWithOAuth = {
...multiStatusCompatibleDestination,
authentication: {
scheme: 'oauth2',
fields: {},
refreshAccessToken: mockRefreshToken
} as OAuth2Authentication<any>
}
const multiStatusDestination = new Destination(destinationWithOAuth)

const receivedAt = '2024-08-03T17:40:04.055Z'

const events: SegmentEvent[] = [
{
event: 'Add to Cart',
type: 'track',
properties: {
email: '[email protected]'
},
receivedAt
},
{
// Missing required fields
event: 'Add to Cart',
type: 'track',
properties: {},
receivedAt
}
]

const settings = {
apiSecret: 'test_key',
oauth: {
access_token: 'OldToken'
},
subscription: {
subscribe: 'type = "track" and event != "Order Completed"',
partnerAction: 'trackEvent',
mapping: {
name: { '@path': '$.event' },
email: { '@path': '$.properties.email' },
phone: { '@path': '$.properties.phone' }
}
}
}

multiStatusDestination.refreshAccessToken = mockRefreshToken

const response = await multiStatusDestination.onBatch(events, settings, {
onTokenRefresh: mockOnTokenRefresh
})
// assert that the refresh token was called once
expect(mockRefreshToken).toHaveBeenCalledTimes(1)
expect(mockOnTokenRefresh).toHaveBeenCalledWith(expect.objectContaining({ accessToken: 'new-access-token' }))
expect(response).toMatchInlineSnapshot(`
Array [
Object {
"multistatus": Array [
Object {
"body": Object {},
"sent": Object {},
"status": 200,
},
Object {
"errormessage": "Email is required",
"errorreporter": "INTEGRATIONS",
"errortype": "PAYLOAD_VALIDATION_FAILED",
"status": 400,
},
],
},
]
`)
})
test('should refresh access token and retry events in case multistatus response contains 401 for oauth-managed destinations', async () => {
const mockRefreshToken = jest.fn().mockReturnValue({
accessToken: 'new-access-token'
})
const mockOnTokenRefresh = jest.fn().mockReturnValue(Promise.resolve())
const destinationWithOAuth = {
...multiStatusCompatibleDestination,
authentication: {
scheme: 'oauth-managed',
fields: {},
refreshAccessToken: mockRefreshToken
} as OAuthManagedAuthentication<any>
}
const multiStatusDestination = new Destination(destinationWithOAuth)

const receivedAt = '2024-08-03T17:40:04.055Z'

const events: SegmentEvent[] = [
{
event: 'Add to Cart',
type: 'track',
properties: {
email: '[email protected]'
},
receivedAt
},
{
// Missing required fields
event: 'Add to Cart',
type: 'track',
properties: {},
receivedAt
}
]

const settings = {
apiSecret: 'test_key',
oauth: {
access_token: 'OldToken'
},
subscription: {
subscribe: 'type = "track" and event != "Order Completed"',
partnerAction: 'trackEvent',
mapping: {
name: { '@path': '$.event' },
email: { '@path': '$.properties.email' },
phone: { '@path': '$.properties.phone' }
}
}
}

multiStatusDestination.refreshAccessToken = mockRefreshToken

const response = await multiStatusDestination.onBatch(events, settings, {
onTokenRefresh: mockOnTokenRefresh
})
// assert that the refresh token was called once
expect(mockRefreshToken).toHaveBeenCalledTimes(1)
// assert that the onTokenRefresh was called once
expect(mockOnTokenRefresh).toHaveBeenCalledWith(expect.objectContaining({ accessToken: 'new-access-token' }))
expect(response).toMatchInlineSnapshot(`
Array [
Object {
"multistatus": Array [
Object {
"body": Object {},
"sent": Object {},
"status": 200,
},
Object {
"errormessage": "Email is required",
"errorreporter": "INTEGRATIONS",
"errortype": "PAYLOAD_VALIDATION_FAILED",
"status": 400,
},
],
},
]
`)
})
test('should not retry events in case multistatus response doesnot contain 401 errors for oauth destinations', async () => {
const mockRefreshToken = jest.fn().mockReturnValue({
accessToken: 'new-access-token'
})
const destinationWithOAuth = {
...multiStatusCompatibleDestination,
authentication: {
scheme: 'oauth-managed',
fields: {},
refreshAccessToken: mockRefreshToken
} as OAuthManagedAuthentication<any>
}
const multiStatusDestination = new Destination(destinationWithOAuth)

const receivedAt = '2024-08-03T17:40:04.055Z'

const events: SegmentEvent[] = [
{
event: 'Add to Cart',
type: 'track',
properties: {
email: '[email protected]'
},
receivedAt
},
{
// Missing required fields
event: 'Add to Cart',
type: 'track',
properties: {},
receivedAt
}
]

const settings = {
apiSecret: 'test_key',
oauth: {},
subscription: {
subscribe: 'type = "track" and event != "Order Completed"',
partnerAction: 'trackEvent',
mapping: {
name: { '@path': '$.event' },
email: { '@path': '$.properties.email' },
phone: { '@path': '$.properties.phone' }
}
}
}

const response = await multiStatusDestination.onBatch(events, settings, {})
expect(mockRefreshToken).not.toHaveBeenCalled()
expect(response).toMatchInlineSnapshot(`
Array [
Object {
"multistatus": Array [
Object {
"body": Object {},
"sent": Object {},
"status": 200,
},
Object {
"errormessage": "Email is required",
"errorreporter": "INTEGRATIONS",
"errortype": "PAYLOAD_VALIDATION_FAILED",
"status": 400,
},
],
},
]
`)
})
test('should not retry events more than max retry attempts for 401 errors', async () => {
const mockRefreshToken = jest.fn().mockReturnValue({
accessToken: 'OldToken'
})
const destinationWithOAuth = {
...multiStatusCompatibleDestination,
authentication: {
scheme: 'oauth-managed',
fields: {},
refreshAccessToken: mockRefreshToken
} as OAuthManagedAuthentication<any>
}
const multiStatusDestination = new Destination(destinationWithOAuth)

const receivedAt = '2024-08-03T17:40:04.055Z'

const events: SegmentEvent[] = [
{
event: 'Add to Cart',
type: 'track',
properties: {
email: '[email protected]'
},
receivedAt
},
{
// Missing required fields
event: 'Add to Cart',
type: 'track',
properties: {},
receivedAt
}
]

const settings = {
apiSecret: 'test_key',
oauth: {
access_token: 'OldToken'
},
subscription: {
subscribe: 'type = "track" and event != "Order Completed"',
partnerAction: 'trackEvent',
mapping: {
name: { '@path': '$.event' },
email: { '@path': '$.properties.email' },
phone: { '@path': '$.properties.phone' }
}
}
}

const response = await multiStatusDestination.onBatch(events, settings, {})
// Default retry attempts is 2
expect(mockRefreshToken).toHaveBeenCalledTimes(2)
expect(response).toMatchInlineSnapshot(`
Array [
Object {
"multistatus": Array [
Object {
"body": Object {
"events_processed": 0,
"message": "Invalid Auth",
},
"errormessage": "Invalid Auth",
"errorreporter": "DESTINATION",
"errortype": "INVALID_AUTHENTICATION",
"sent": Object {
"email": "[email protected]",
"name": "Add to Cart",
},
"status": 401,
},
Object {
"body": Object {
"events_processed": 0,
"message": "Invalid Auth",
},
"errormessage": "Invalid Auth",
"errorreporter": "DESTINATION",
"errortype": "INVALID_AUTHENTICATION",
"sent": Object {
"name": "Add to Cart",
},
"status": 401,
},
],
},
]
`)
})
})
})
Loading
Loading