Skip to content

CDP-6131: make triggerBroadcast data and recipients params optional (impl-robust) #219

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

Closed
talon-github-manager wants to merge 1 commit into from
Closed

CDP-6131: make triggerBroadcast data and recipients params optional (impl-robust) #219

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
27 changes: 15 additions & 12 deletions lib/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,19 +226,22 @@ export class APIClient {
* @param recipients Recipient selector. See above.
* @returns The parsed JSON response body.
*/
triggerBroadcast(broadcastId: string | number, data: RequestData, recipients: Recipients) {
let payload = {};
let customRecipientField = (
Object.keys(BROADCASTS_ALLOWED_RECIPIENT_FIELDS) as BroadcastsAllowedRecipientFieldsKeys[]
).find((field) => recipients[field]);

if (customRecipientField) {
payload = Object.assign({ data }, filterRecipientsDataForField(recipients, customRecipientField));
triggerBroadcast(broadcastId: string | number, data: RequestData = {}, recipients: Recipients = {}) {
let payload: Record<string, unknown>;
const hasRecipients = Object.keys(recipients).length > 0;

if (hasRecipients) {
const customRecipientField = (
Object.keys(BROADCASTS_ALLOWED_RECIPIENT_FIELDS) as BroadcastsAllowedRecipientFieldsKeys[]
).find((field) => recipients[field]);

if (customRecipientField) {
payload = Object.assign({ data }, filterRecipientsDataForField(recipients, customRecipientField));
} else {
payload = { data, recipients };
}
} else {
payload = {
data,
recipients,
};
payload = { data };
}

return this.request.post(`${this.apiRoot}/campaigns/${encodeURIComponent(broadcastId)}/triggers`, payload);
Expand Down
50 changes: 50 additions & 0 deletions test/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,6 +390,56 @@ test('#triggerBroadcast discards extraneous fields', (t) => {
);
});

test('#triggerBroadcast works with no data and no recipients', (t) => {
sinon.stub(t.context.client.request, 'post');
t.context.client.triggerBroadcast(1);
t.truthy(
(t.context.client.request.post as SinonStub).calledWith(`${RegionUS.apiUrl}/campaigns/1/triggers`, {
data: {},
}),
);
});

test('#triggerBroadcast works with data only (no recipients)', (t) => {
sinon.stub(t.context.client.request, 'post');
t.context.client.triggerBroadcast(1, { type: 'data' });
t.truthy(
(t.context.client.request.post as SinonStub).calledWith(`${RegionUS.apiUrl}/campaigns/1/triggers`, {
data: { type: 'data' },
}),
);
});

test('#triggerBroadcast works with empty recipients object', (t) => {
sinon.stub(t.context.client.request, 'post');
t.context.client.triggerBroadcast(1, { type: 'data' }, {});
t.truthy(
(t.context.client.request.post as SinonStub).calledWith(`${RegionUS.apiUrl}/campaigns/1/triggers`, {
data: { type: 'data' },
}),
);
});

test('#triggerBroadcast works with undefined data and undefined recipients', (t) => {
sinon.stub(t.context.client.request, 'post');
t.context.client.triggerBroadcast(1, undefined, undefined);
t.truthy(
(t.context.client.request.post as SinonStub).calledWith(`${RegionUS.apiUrl}/campaigns/1/triggers`, {
data: {},
}),
);
});

test('#triggerBroadcast works with empty data and empty recipients', (t) => {
sinon.stub(t.context.client.request, 'post');
t.context.client.triggerBroadcast(1, {}, {});
t.truthy(
(t.context.client.request.post as SinonStub).calledWith(`${RegionUS.apiUrl}/campaigns/1/triggers`, {
data: {},
}),
);
});

test('#listExports: success', (t) => {
sinon.stub(t.context.client.request, 'get');
t.context.client.listExports();
Expand Down