Skip to content

[TOPSORT] Add skipZeroPricePurchases setting to Topsort destination #3330

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[TOPSORT] Add skipZeroPricePurchases setting to Topsort destination #3330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions packages/destination-actions/src/destinations/topsort/generated-types.ts
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions packages/destination-actions/src/destinations/topsort/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ const destination: DestinationDefinition<Settings> = {
description: 'Created under Settings > API Integration in the Topsort Manager Platform.',
type: 'password',
required: true
},
skipZeroPricePurchases: {
label: 'Skip Zero Price Purchases',
description:
'When enabled, purchase events with items that have zero or missing unit price will be filtered out.',
type: 'boolean',
required: false,
default: false
}
}
},
Expand Down
137 changes: 137 additions & 0 deletions packages/destination-actions/src/destinations/topsort/purchase/__tests__/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,4 +157,141 @@ describe('Topsort.purchase', () => {
})
).rejects.toThrowError(AggregateAjvError)
})

it('should filter out items with zero price when skipZeroPricePurchases is enabled', async () => {
nock(/.*/).persist().post(/.*/).reply(200)

const event = createTestEvent({
properties: {
products: [
{
product_id: '123',
price: 100,
quantity: 1
},
{
product_id: '456',
price: 0,
quantity: 2
},
{
product_id: '789',
price: 50,
quantity: 1
}
]
}
})

const responses = await testDestination.testAction('purchase', {
event,
settings: {
api_key: 'bar',
skipZeroPricePurchases: true
},
useDefaultMappings: true
})

expect(responses.length).toBe(1)
expect(responses[0].status).toBe(200)
expect(responses[0].options.json).toMatchObject({
purchases: expect.arrayContaining([
expect.objectContaining({
items: [
{
productId: '123',
unitPrice: 100,
quantity: 1
},
{
productId: '789',
unitPrice: 50,
quantity: 1
}
]
})
])
})
})

it('should skip entire purchase when all items have zero price and skipZeroPricePurchases is enabled', async () => {
const event = createTestEvent({
properties: {
products: [
{
product_id: '123',
price: 0,
quantity: 1
},
{
product_id: '456',
price: 0,
quantity: 2
}
]
}
})

const responses = await testDestination.testAction('purchase', {
event,
settings: {
api_key: 'bar',
skipZeroPricePurchases: true
},
useDefaultMappings: true
})

expect(responses.length).toBe(0)
})

it('should send all items including zero price when skipZeroPricePurchases is disabled', async () => {
nock(/.*/).persist().post(/.*/).reply(200)

const event = createTestEvent({
properties: {
products: [
{
product_id: '123',
price: 100,
quantity: 1
},
{
product_id: '456',
price: 0,
quantity: 2
}
]
}
})

const responses = await testDestination.testAction('purchase', {
event,
settings: {
api_key: 'bar',
skipZeroPricePurchases: false
},
useDefaultMappings: true
})

expect(responses.length).toBe(1)
expect(responses[0].status).toBe(200)
expect(responses[0].options.json).toMatchObject({
purchases: expect.arrayContaining([
expect.objectContaining({
items: [
{
productId: '123',
unitPrice: 100,
quantity: 1
},
{
productId: '456',
unitPrice: 0,
quantity: 2
}
]
})
])
})
})
})
14 changes: 12 additions & 2 deletions packages/destination-actions/src/destinations/topsort/purchase/__tests__/snapshot.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,15 @@ describe(`Testing snapshot for ${destinationSlug}'s ${actionSlug} destination ac
const responses = await testDestination.testAction(actionSlug, {
event: event,
mapping: event.properties,
settings: settingsData,
settings: { ...settingsData, skipZeroPricePurchases: false },
auth: undefined
})

if (!responses[0].request) {
expect(responses[0].options.json).toMatchSnapshot()
return
}

const request = responses[0].request
const rawBody = await request.text()

Expand Down Expand Up @@ -57,10 +62,15 @@ describe(`Testing snapshot for ${destinationSlug}'s ${actionSlug} destination ac
const responses = await testDestination.testAction(actionSlug, {
event: event,
mapping: event.properties,
settings: settingsData,
settings: { ...settingsData, skipZeroPricePurchases: false },
auth: undefined
})

if (!responses[0].request) {
expect(responses[0].options.json).toMatchSnapshot()
return
}

const request = responses[0].request
const rawBody = await request.text()

Expand Down
11 changes: 11 additions & 0 deletions packages/destination-actions/src/destinations/topsort/purchase/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,17 @@ const action: ActionDefinition<Settings, Payload> = {
},
perform: (request, { payload, settings }) => {
const client = new TopsortAPIClient(request, settings)

if (settings.skipZeroPricePurchases) {
const filteredItems = payload.items.filter((item) => item.unitPrice != null && item.unitPrice > 0)

if (filteredItems.length === 0) {
return
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @FelipeRiveraC ,

You could throw a PayloadValidationError here if you liked - it provides feedback to the customer about what happened.

It's OK not to also. Up to you.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey, we actually dont want to provide feedback, so its ok. Thanks!

}

payload.items = filteredItems
}

return client.sendEvent({
purchases: [payload]
})
Expand Down
Loading