Skip to content

[Recombee] Add internalAdditionalData field to actions #2856

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

[Recombee] Add internalAdditionalData field to actions #2856

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
7 changes: 7 additions & 0 deletions ...stination-actions/src/destinations/recombee/__tests__/__snapshots__/snapshot.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Object {

exports[`Testing snapshot for actions-recombee destination: addBookmark action - required fields 1`] = `
Object {
"additionalData": Object {},
"cascadeCreate": true,
"itemId": "7(iq3vwM",
"userId": "7(iq3vwM",
Expand All @@ -38,6 +39,7 @@ Object {

exports[`Testing snapshot for actions-recombee destination: addCartAddition action - required fields 1`] = `
Object {
"additionalData": Object {},
"cascadeCreate": true,
"itemId": "fSK%!$(3gz2peZ!&@L@D",
"userId": "fSK%!$(3gz2peZ!&@L@D",
Expand All @@ -60,6 +62,7 @@ Object {

exports[`Testing snapshot for actions-recombee destination: addDetailView action - required fields 1`] = `
Object {
"additionalData": Object {},
"cascadeCreate": true,
"itemId": "VhiOfa#s6#B[CQDV",
"userId": "VhiOfa#s6#B[CQDV",
Expand Down Expand Up @@ -96,6 +99,7 @@ Object {
Object {
"method": "POST",
"params": Object {
"additionalData": Object {},
"cascadeCreate": true,
"itemId": "!D2A1H%v%jv&r",
"userId": "!D2A1H%v%jv&r",
Expand All @@ -122,6 +126,7 @@ Object {

exports[`Testing snapshot for actions-recombee destination: addRating action - required fields 1`] = `
Object {
"additionalData": Object {},
"cascadeCreate": true,
"itemId": "X9m9Urlsqof(&*PN!s",
"rating": 63040185947914.24,
Expand Down Expand Up @@ -180,6 +185,7 @@ Object {

exports[`Testing snapshot for actions-recombee destination: setViewPortion action - required fields 1`] = `
Object {
"additionalData": Object {},
"cascadeCreate": true,
"itemId": "D9^z[P*Zv",
"portion": -42971588743659.52,
Expand All @@ -204,6 +210,7 @@ Object {

exports[`Testing snapshot for actions-recombee destination: setViewPortionFromWatchTime action - required fields 1`] = `
Object {
"additionalData": Object {},
"cascadeCreate": true,
"itemId": "gpLV6!FLD#$6^LR77nTN",
"portion": 1,
Expand Down
1 change: 1 addition & 0 deletions ...tions/src/destinations/recombee/addBookmark/__tests__/__snapshots__/snapshot.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Object {

exports[`Testing snapshot for Recombee's addBookmark destination action: required fields 1`] = `
Object {
"additionalData": Object {},
"cascadeCreate": true,
"itemId": "GxFzk&V2a4R8iF62G9]q",
"userId": "GxFzk&V2a4R8iF62G9]q",
Expand Down
6 changes: 6 additions & 0 deletions packages/destination-actions/src/destinations/recombee/addBookmark/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.

17 changes: 15 additions & 2 deletions packages/destination-actions/src/destinations/recombee/addBookmark/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,25 @@ const action: ActionDefinition<Settings, Payload> = {
},
perform: async (request, data) => {
const client = new RecombeeApiClient(data.settings, request)
await client.send(new AddBookmark(data.payload))
await client.send(payloadToBookmark(data.payload))
},
performBatch: async (request, data) => {
const client = new RecombeeApiClient(data.settings, request)
await client.send(new Batch(data.payload.map((payload) => new AddBookmark(payload))))
await client.send(new Batch(data.payload.map((payload) => payloadToBookmark(payload))))
}
}

function payloadToBookmark(payload: Payload): AddBookmark {
return new AddBookmark({
userId: payload.userId,
itemId: payload.itemId,
timestamp: payload.timestamp,
recommId: payload.recommId,
additionalData: {
...(payload.internalAdditionalData ?? {}),
...(payload.additionalData ?? {})
}
})
}
Comment on lines +57 to +68
Copy link
Contributor

Choose a reason for hiding this comment

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

Hi @mstieranka thanks for raising this PR.
My main question regards the addition of these new wrapper functions. Why are they needed?

For example why can the additional work of merging the new internalAdditionalData into the additionalData object not be done in the AddBookmark class?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It can be done in the class, that's a good point. I kept it this way so that it conforms exactly to our API schema, but since this is a specialized API implementation and not a generalized API client (which I'm used to developing), I guess it can be moved into the classes.

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks @mstieranka - it might be neater to have the logic all in one place here if possible. Are you OK updating it please?


export default action
1 change: 1 addition & 0 deletions ...s/src/destinations/recombee/addCartAddition/__tests__/__snapshots__/snapshot.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Object {

exports[`Testing snapshot for Recombee's addCartAddition destination action: required fields 1`] = `
Object {
"additionalData": Object {},
"cascadeCreate": true,
"itemId": "E$o]!yX^hLQ^46#)",
"userId": "E$o]!yX^hLQ^46#)",
Expand Down
6 changes: 6 additions & 0 deletions packages/destination-actions/src/destinations/recombee/addCartAddition/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.

11 changes: 7 additions & 4 deletions packages/destination-actions/src/destinations/recombee/addCartAddition/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,21 +72,24 @@ const action: ActionDefinition<Settings, Payload> = {
},
perform: async (request, data) => {
const client = new RecombeeApiClient(data.settings, request)
await client.send(payloadToInteraction(data.payload))
await client.send(payloadToCartAddition(data.payload))
},
performBatch: async (request, data) => {
const client = new RecombeeApiClient(data.settings, request)
await client.send(new Batch(data.payload.map(payloadToInteraction)))
await client.send(new Batch(data.payload.map(payloadToCartAddition)))
}
}

function payloadToInteraction(payload: Payload): AddCartAddition {
function payloadToCartAddition(payload: Payload): AddCartAddition {
return new AddCartAddition({
userId: payload.userId,
...payload.item,
timestamp: payload.timestamp,
recommId: payload.recommId,
additionalData: payload.additionalData
additionalData: {
...(payload.internalAdditionalData ?? {}),
...(payload.additionalData ?? {})
}
})
}

Expand Down
1 change: 1 addition & 0 deletions ...ons/src/destinations/recombee/addDetailView/__tests__/__snapshots__/snapshot.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Object {

exports[`Testing snapshot for Recombee's addDetailView destination action: required fields 1`] = `
Object {
"additionalData": Object {},
"cascadeCreate": true,
"itemId": "nW8&[lpB",
"userId": "nW8&[lpB",
Expand Down
6 changes: 6 additions & 0 deletions packages/destination-actions/src/destinations/recombee/addDetailView/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.

18 changes: 16 additions & 2 deletions packages/destination-actions/src/destinations/recombee/addDetailView/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,26 @@ const action: ActionDefinition<Settings, Payload> = {
},
perform: async (request, data) => {
const client = new RecombeeApiClient(data.settings, request)
await client.send(new AddDetailView(data.payload))
await client.send(payloadToDetailView(data.payload))
},
performBatch: async (request, data) => {
const client = new RecombeeApiClient(data.settings, request)
await client.send(new Batch(data.payload.map((payload) => new AddDetailView(payload))))
await client.send(new Batch(data.payload.map((payload) => payloadToDetailView(payload))))
}
}

function payloadToDetailView(payload: Payload): AddDetailView {
return new AddDetailView({
userId: payload.userId,
itemId: payload.itemId,
timestamp: payload.timestamp,
duration: payload.duration,
recommId: payload.recommId,
additionalData: {
...(payload.internalAdditionalData ?? {}),
...(payload.additionalData ?? {})
}
})
}

export default action
1 change: 1 addition & 0 deletions ...tions/src/destinations/recombee/addPurchase/__tests__/__snapshots__/snapshot.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Object {
Object {
"method": "POST",
"params": Object {
"additionalData": Object {},
"cascadeCreate": true,
"itemId": "o@fME^0ckHa[VN6e&Zv*",
"userId": "o@fME^0ckHa[VN6e&Zv*",
Expand Down
6 changes: 6 additions & 0 deletions packages/destination-actions/src/destinations/recombee/addPurchase/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.

11 changes: 7 additions & 4 deletions packages/destination-actions/src/destinations/recombee/addPurchase/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,23 +92,26 @@ const action: ActionDefinition<Settings, Payload> = {
},
perform: async (request, data) => {
const client = new RecombeeApiClient(data.settings, request)
await client.send(new Batch(payloadToInteractions(data.payload)))
await client.send(new Batch(payloadToPurchases(data.payload)))
},
performBatch: async (request, data) => {
const client = new RecombeeApiClient(data.settings, request)
await client.send(new Batch(data.payload.flatMap(payloadToInteractions)))
await client.send(new Batch(data.payload.flatMap(payloadToPurchases)))
}
}

function payloadToInteractions(payload: Payload): AddPurchase[] {
function payloadToPurchases(payload: Payload): AddPurchase[] {
return payload.items.map(
(item) =>
new AddPurchase({
userId: payload.userId,
...item,
timestamp: payload.timestamp,
recommId: payload.recommId,
additionalData: payload.additionalData
additionalData: {
...(payload.internalAdditionalData ?? {}),
...(payload.additionalData ?? {})
}
})
)
}
Expand Down
1 change: 1 addition & 0 deletions ...actions/src/destinations/recombee/addRating/__tests__/__snapshots__/snapshot.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Object {

exports[`Testing snapshot for Recombee's addRating destination action: required fields 1`] = `
Object {
"additionalData": Object {},
"cascadeCreate": true,
"itemId": "ANsNPl1sV!#5(%#",
"rating": 29019912231976.96,
Expand Down
6 changes: 6 additions & 0 deletions packages/destination-actions/src/destinations/recombee/addRating/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.

18 changes: 16 additions & 2 deletions packages/destination-actions/src/destinations/recombee/addRating/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,26 @@ const action: ActionDefinition<Settings, Payload> = {
},
perform: async (request, data) => {
const client = new RecombeeApiClient(data.settings, request)
await client.send(new AddRating(data.payload))
await client.send(payloadToRating(data.payload))
},
performBatch: async (request, data) => {
const client = new RecombeeApiClient(data.settings, request)
await client.send(new Batch(data.payload.map((payload) => new AddRating(payload))))
await client.send(new Batch(data.payload.map((payload) => payloadToRating(payload))))
}
}

function payloadToRating(payload: Payload): AddRating {
return new AddRating({
userId: payload.userId,
itemId: payload.itemId,
rating: payload.rating,
timestamp: payload.timestamp,
recommId: payload.recommId,
additionalData: {
...(payload.internalAdditionalData ?? {}),
...(payload.additionalData ?? {})
}
})
}

export default action
23 changes: 22 additions & 1 deletion packages/destination-actions/src/destinations/recombee/commonFields.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,33 @@ export function interactionFields(interactionName: string): Record<string, Input
'@path': '$.properties.recomm_id'
}
},
internalAdditionalData: {
label: 'Internal Additional Data',
description: `Internal additional data to be stored with the ${interactionName}.`,
type: 'object',
defaultObjectUI: 'keyvalue:only',
readOnly: true,
unsafe_hidden: true,
default: {
segmentEventType: {
'@path': '$.type'
},
segmentEventName: {
'@if': {
exists: { '@path': '$.event' },
then: { '@path': '$.event' },
else: { '@path': '$.name' }
}
}
}
},
additionalData: {
label: 'Additional Data',
description: `Additional data to be stored with the ${interactionName}. *Keep this field empty unless instructed by the Recombee Support team.*`,
type: 'object',
required: false,
displayMode: 'collapsed'
displayMode: 'collapsed',
defaultObjectUI: 'keyvalue:only'
}
}
}
Expand Down
1 change: 1 addition & 0 deletions ...ns/src/destinations/recombee/setViewPortion/__tests__/__snapshots__/snapshot.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Object {

exports[`Testing snapshot for Recombee's setViewPortion destination action: required fields 1`] = `
Object {
"additionalData": Object {},
"cascadeCreate": true,
"itemId": "Np8pbQ",
"portion": -70298178955509.76,
Expand Down
6 changes: 6 additions & 0 deletions packages/destination-actions/src/destinations/recombee/setViewPortion/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.

19 changes: 17 additions & 2 deletions packages/destination-actions/src/destinations/recombee/setViewPortion/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,27 @@ const action: ActionDefinition<Settings, Payload> = {
},
perform: async (request, data) => {
const client = new RecombeeApiClient(data.settings, request)
await client.send(new SetViewPortion(data.payload))
await client.send(payloadToViewPortion(data.payload))
},
performBatch: async (request, data) => {
const client = new RecombeeApiClient(data.settings, request)
await client.send(new Batch(data.payload.map((event) => new SetViewPortion(event))))
await client.send(new Batch(data.payload.map((event) => payloadToViewPortion(event))))
}
}

function payloadToViewPortion(payload: Payload): SetViewPortion {
return new SetViewPortion({
userId: payload.userId,
itemId: payload.itemId,
portion: payload.portion,
sessionId: payload.sessionId,
timestamp: payload.timestamp,
recommId: payload.recommId,
additionalData: {
...(payload.internalAdditionalData ?? {}),
...(payload.additionalData ?? {})
}
})
}

export default action
Loading
Loading