fix(api): api docs not generated and added more e2e tests #2665

p-fernandez · 2023-02-01T17:27:41Z

What change does this PR introduce?

Adds more defensive checks in the code and avoids to accept bad formatted payloads. Adds more E2E tests for the update of the subscriber preferences after some investigation regarding potential bugs reported by users. Also improves the API docs with more detailed descriptions.

Why was this change needed?

Improve the confidence in the code and clarify the intention to the users.

Other information (Screenshots)

linear · 2023-02-01T17:27:44Z

NV-1620 🐛 Bug Report: Update subscriber preferences expected payload and validation mismatch

📜 Description

Some of our users have reported that the endpoint PATCH /subscribers/:subscriberId/preferences/:templateId is not working properly.

The endpoint controller logic (

novu/apps/api/src/app/subscribers/subscribers.controller.ts

Line 304 in 1297d61

channel: body.channel,

) is expecting a payload in the shape:

interface Body {
  channel?: ChannelTypeEnum;
  enabled?: boolean;
}

But the validation applied is reused from the Widget module DTO UpdateSubscriberPreferenceRequestDto:

novu/apps/api/src/app/widgets/dtos/update-subscriber-preference-request.dto.ts

Line 12 in 1297d61

channel?: ChannelPreference;

There the type assigned to channel is ChannelPreference.

novu/apps/api/src/app/shared/dtos/channel-preference.ts

Line 4 in 2d3050a

export class ChannelPreference {

Which is expected to be a nested object in the shape of:

export class ChannelPreference {
  type: ChannelTypeEnum;
  enabled: boolean;
}

👟 Reproduction steps

In any environment to do a cURL call to the API.
For example, in local environment:

curl -X PATCH \                                                     
 -H "Authorization: ApiKey <API_KEY>" \
 -H "Content-Type: application/json" \
 -d '{
      "channel": "email",
      "enabled": true
    }' \
http://localhost:3000/v1/subscribers/1/preferences/1

This will raise an error:

{"statusCode":400,"message":["nested property channel must be either object or array"],"error":"Bad Request"}%

👍 Expected behavior

Update the controller to satisfy the validation and follow the same structure as in the Widget module.

👎 Actual Behavior with Screenshots

--

📃 Provide any additional context for the Bug.

Test suite for update subscriber preferences is applying a different payload (the one used in Widget module). This means the tests are not accurate. Also we are not checking if the values are updated properly.
We need to increase the test suite robustness to be able to catch these bugs.

👀 Have you spent some time to check if this bug has been raised before?

I checked and didn't find similar issue

🏢 Have you read the Contributing Guidelines?

I have read the Contributing Guidelines

Are you willing to submit PR?

Yes I am willing to submit a PR!

p-fernandez · 2023-02-01T17:28:26Z

apps/api/src/app/subscribers/e2e/create-subscriber.e2e.ts

+    expect(createdSubscriber?.firstName).to.equal('John');
+    expect(createdSubscriber?.email).to.equal('john@doe.com');
+    expect(createdSubscriber?.phone).to.equal('+972523333333');
+    expect(createdSubscriber?.locale).to.equal('en');


Linter warnings fixes

p-fernandez · 2023-02-01T17:28:31Z

apps/api/src/app/subscribers/e2e/create-subscriber.e2e.ts

+    expect(createdSubscriber?.firstName).to.equal('Mary');
+    expect(createdSubscriber?.email).to.equal('john@doe.com');
+    expect(createdSubscriber?.locale).to.equal('en');


Linter warnings fixes

ghost · 2023-02-01T17:28:49Z

👇 Click on the image for a new way to code review

Make big changes easier — review code in small groups of related files
Know where to start — see the whole change at a glance
Take a code tour — explore the change with an interactive tour
Make comments and review — all fully sync’ed with github

Try it now!

Legend

p-fernandez · 2023-02-01T17:28:52Z

apps/api/src/app/subscribers/e2e/remove-subscriber.e2e.ts

@@ -32,7 +32,7 @@ describe('Delete Subscriber - /subscribers/:subscriberId (DELETE)', function ()
    );

    const createdSubscriber = await subscriberRepository.findBySubscriberId(session.environment._id, '123');
-    expect(createdSubscriber.subscriberId).to.equal('123');
+    expect(createdSubscriber?.subscriberId).to.equal('123');


Linter warnings fixes

p-fernandez · 2023-02-01T17:29:21Z

apps/api/src/app/subscribers/e2e/update-subscriber.e2e.ts

+    expect(createdSubscriber?.firstName).to.equal('John');
+    expect(createdSubscriber?.lastName).to.equal('Test Changed');
+    expect(createdSubscriber?.email).to.equal('changed@mail.com');
+    expect(createdSubscriber?.phone).to.equal('+972523333333');
+    expect(createdSubscriber?.locale).to.equal('sv');


Linter warnings fixes

p-fernandez · 2023-02-01T17:29:29Z

apps/api/src/app/subscribers/e2e/update-subscriber.e2e.ts

+    const subscriberChannel = createdSubscriber?.channels?.find((channel) => channel.providerId === 'slack');

-    expect(subscriberChannel.providerId).to.equal('slack');
-    expect(subscriberChannel.credentials.webhookUrl).to.equal('webhookUrlNew');
+    expect(subscriberChannel?.providerId).to.equal('slack');
+    expect(subscriberChannel?.credentials.webhookUrl).to.equal('webhookUrlNew');


Linter warnings fixes

p-fernandez · 2023-02-01T17:29:40Z

apps/api/src/app/subscribers/subscribers.controller.ts

+      ...(typeof body.enabled === 'boolean' && { enabled: body.enabled }),
+      ...(body.channel && { channel: body.channel }),


Protection against wrong payloads.

is undefined considered a wrong payload? if yes shouldn't we then modify the UpdateSubscriberPreferenceRequestDto class?

Is used in other controller endpoints so for now I'd rather not touch it, just in case.

LetItRock

you rock🤘

LetItRock · 2023-02-03T12:58:10Z

apps/api/src/app/subscribers/subscribers.controller.ts

+      ...(typeof body.enabled === 'boolean' && { enabled: body.enabled }),
+      ...(body.channel && { channel: body.channel }),


is undefined considered a wrong payload? if yes shouldn't we then modify the UpdateSubscriberPreferenceRequestDto class?

LetItRock · 2023-02-03T12:59:56Z

...pp/subscribers/usecases/update-subscriber-preference/update-subscriber-preference.usecase.ts

+       * Unless explicitly set to false when creating a user preference we want it to be enabled
+       * even if not passing at first enabled to true.
+       */
+      enabled: command.enabled !== false,


Suggested change

enabled: command.enabled !== false,

enabled: command.enabled ?? true,

p-fernandez requested review from scopsy and djabarovgeorge February 1, 2023 17:27

p-fernandez self-assigned this Feb 1, 2023

github-actions bot added @novu/api @novu/web labels Feb 1, 2023

p-fernandez commented Feb 1, 2023

View reviewed changes

p-fernandez force-pushed the nv-1620-bug-report-update-subscriber-preferences branch from 47d87ff to aa02ec0 Compare February 1, 2023 17:30

github-actions bot removed the @novu/web label Feb 1, 2023

LetItRock approved these changes Feb 3, 2023

View reviewed changes

p-fernandez force-pushed the nv-1620-bug-report-update-subscriber-preferences branch from 06b0bc9 to cd6e76c Compare February 9, 2023 18:31

fix(api): api docs not generated and added more e2e tests

ebde451

p-fernandez force-pushed the nv-1620-bug-report-update-subscriber-preferences branch from cd6e76c to ebde451 Compare February 9, 2023 18:34

p-fernandez added this pull request to the merge queue Feb 9, 2023

Merged via the queue into next with commit d85ef4f Feb 9, 2023

p-fernandez deleted the nv-1620-bug-report-update-subscriber-preferences branch February 9, 2023 18:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(api): api docs not generated and added more e2e tests #2665

fix(api): api docs not generated and added more e2e tests #2665

p-fernandez commented Feb 1, 2023

linear bot commented Feb 1, 2023

📜 Description

👟 Reproduction steps

👍 Expected behavior

👎 Actual Behavior with Screenshots

📃 Provide any additional context for the Bug.

👀 Have you spent some time to check if this bug has been raised before?

🏢 Have you read the Contributing Guidelines?

Are you willing to submit PR?

p-fernandez Feb 1, 2023

p-fernandez Feb 1, 2023

ghost commented Feb 1, 2023 •

edited by ghost

p-fernandez Feb 1, 2023

p-fernandez Feb 1, 2023

p-fernandez Feb 1, 2023

p-fernandez Feb 1, 2023

LetItRock Feb 3, 2023

p-fernandez Feb 9, 2023

LetItRock left a comment

LetItRock Feb 3, 2023

LetItRock Feb 3, 2023

		...(typeof body.enabled === 'boolean' && { enabled: body.enabled }),
		...(body.channel && { channel: body.channel }),

	enabled: command.enabled !== false,
	enabled: command.enabled ?? true,

fix(api): api docs not generated and added more e2e tests #2665

fix(api): api docs not generated and added more e2e tests #2665

Conversation

p-fernandez commented Feb 1, 2023

What change does this PR introduce?

Why was this change needed?

Other information (Screenshots)

linear bot commented Feb 1, 2023

📜 Description

👟 Reproduction steps

👍 Expected behavior

👎 Actual Behavior with Screenshots

📃 Provide any additional context for the Bug.

👀 Have you spent some time to check if this bug has been raised before?

🏢 Have you read the Contributing Guidelines?

Are you willing to submit PR?

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost commented Feb 1, 2023 • edited by ghost

Legend

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

LetItRock left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost commented Feb 1, 2023 •

edited by ghost