feat(api): notifications feed filtering by partial payload object #3939
Conversation
NV-2374 Allow notifications feed filtering by custom payload data
What?Allow filtering the notifications feed by a value from the custom payload object passed to the trigger event. Note:
Why? (Context)Currently it's only possible to query the notifications feed by: Definition of Done
|
| @ApiPropertyOptional({ | ||
| required: false, | ||
| type: 'string', | ||
| description: 'Base64 encoded string of the partial payload JSON object', | ||
| example: 'btoa(JSON.stringify({ foo: 123 })) results in base64 encoded string like eyJmb28iOjEyM30=', | ||
| }) | ||
| payload?: string; |
There was a problem hiding this comment.
The two feed endpoints now do take the payload query param which is the base64 encoded string of the partial payload JSON object. Check the description for more info.
| private getPayloadObject(payload?: string): object | undefined { | ||
| if (!payload) { | ||
| return; | ||
| } | ||
|
|
||
| try { | ||
| return JSON.parse(Buffer.from(payload, 'base64').toString()); | ||
| } catch (e) { | ||
| throw new BadRequestException('Invalid payload, the JSON object should be encoded to base64 string.'); | ||
| } | ||
| } |
There was a problem hiding this comment.
convert the base64 string payload to the JS object
| @@ -47,7 +61,7 @@ export class GetNotificationsFeed { | |||
| command.environmentId, | |||
| subscriber._id, | |||
| ChannelTypeEnum.IN_APP, | |||
| { feedId: command.feedId, seen: command.query.seen, read: command.query.read }, | |||
| { feedId: command.feedId, seen: command.query.seen, read: command.query.read, payload }, | |||
There was a problem hiding this comment.
pass the payload to the repository
| if (query.payload) { | ||
| requestQuery = { | ||
| ...requestQuery, | ||
| ...getFlatObject({ payload: query.payload }), | ||
| }; | ||
| } |
There was a problem hiding this comment.
If the payload object is passed, then prepare the flat object out of it, like if the payload is { foo: { bar: 123 } }, then the flat object would be:
{
"payload.foo.bar": 123
}
Which is passed then to the find query.
There was a problem hiding this comment.
@LetItRock really awesome work !
As I mentioned before, I feel it will have a lot of impact to add it to the node sdk and headless.
Also, probably not now, but it will be nice to add a function that does the encoding for the user, at least for the node sdk
| if (query.payload) { | ||
| requestQuery = { | ||
| ...requestQuery, | ||
| ...getFlatObject({ payload: query.payload }), |
There was a problem hiding this comment.
what if query.payload is an empty object, { }. Are we still covered with errors/will not throw errors? Also in the conversion of the payload in other places ?
There was a problem hiding this comment.
if the query.payload is {} then the getFlatObject({ payload: {} }) will return an empty object {} ;)
So basically it won't return any keys flattened if the value is an empty object, including nested objects.
LetItRock
deleted the
nv-2374-notifications-feed-filtering-by-partial-payload
branch
What change does this PR introduce?
Allow filtering of the notifications feed by the custom data from the payload object.
The two endpoints
GET /subscribers/:subscriberId/notifications/feedandGET /widgets/notifications/feednow can take the query param like?payload=eyJmb28iOjEyM30=.The value is a base64 encoded string of the partial payload JSON object.
For example, if the payload passed to the trigger event was like
{ foo: 123, bar: 'bar' }, then you filter notifications by{ foo: 123 }by doingbtoa(JSON.stringify({ foo: 123 }))that results in base64 encoded stringeyJmb28iOjEyM30=and passing it to the query param.Why was this change needed?
Allows building custom notification center experiences.
Other information (Screenshots)