feat(api-service): get subscriber preferences v2 endpoint #7613

ChmaraX · 2025-01-29T16:15:19Z

What changed? Why was the change needed?

TODO:

Speakeasy annotations - replace with legacy endpoints

linear · 2025-01-29T16:15:22Z

netlify · 2025-01-29T16:15:40Z

✅ Deploy Preview for dev-web-novu ready!

Name	Link
🔨 Latest commit	`ad4666b`
🔍 Latest deploy log	https://app.netlify.com/sites/dev-web-novu/deploys/679cd7639faed100089f6451
😎 Deploy Preview	https://deploy-preview-7613.dashboard.novu-staging.co
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify · 2025-01-29T16:15:48Z

✅ Deploy Preview for dashboard-v2-novu-staging ready!

Name	Link
🔨 Latest commit	`ad4666b`
🔍 Latest deploy log	https://app.netlify.com/sites/dashboard-v2-novu-staging/deploys/679cd763d9594e0008411e9c
😎 Deploy Preview	https://deploy-preview-7613.dashboard-v2.novu-staging.co
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

pkg-pr-new · 2025-01-30T11:40:38Z

Open in Stackblitz

@novu/client

npm i https://pkg.pr.new/novuhq/novu/@novu/client@7613

@novu/headless

npm i https://pkg.pr.new/novuhq/novu/@novu/headless@7613

@novu/node

npm i https://pkg.pr.new/novuhq/novu/@novu/node@7613

@novu/notification-center

npm i https://pkg.pr.new/novuhq/novu/@novu/notification-center@7613

novu

npm i https://pkg.pr.new/novuhq/novu@7613

@novu/providers

npm i https://pkg.pr.new/novuhq/novu/@novu/providers@7613

@novu/shared

npm i https://pkg.pr.new/novuhq/novu/@novu/shared@7613

commit: ad4666b

ChmaraX · 2025-01-30T11:41:33Z

packages/shared/src/dto/subscriber/get-subscriber-preferences.dto.ts

+
+export interface IGetSubscriberPreferencesResponseDto {
+  global: {
+    enabled: boolean;


Fun fact:
we allow enabled in update DTO, to disable all global preferences as I understand, but we never use it anywhere:

export type UpdateSubscriberGlobalPreferencesRequestDto = { /** * Enable or disable the subscriber global preferences. */ enabled?: boolean | undefined; /** * The subscriber global preferences for every ChannelTypeEnum. */ preferences?: Array<ChannelPreference> | undefined; };

we always return enabled: true so you can't in fact disable all preferences globally.

novu/libs/application-generic/src/usecases/get-subscriber-template-preference/get-subscriber-template-preference.usecase.ts

Line 110 in 368050c

const enabled = true;

apps/api/src/app/subscribers-v2/subscribers.module.ts

ChmaraX · 2025-01-30T14:10:04Z

packages/shared/src/entities/subscriber-preference/subscriber-preference.interface.ts

-export interface ISubscriberWorkflowPreferenceResponse extends IPreferenceResponse {
-  workflow: ITemplateConfiguration;
-  level: PreferenceLevelEnum.TEMPLATE;
-}
-
-export interface IWorkflow extends Omit<ITemplateConfiguration, '_id'> {
-  id: string;
-}
-export interface ISubscriberPreferences {
-  level: PreferenceLevelEnum;
-  workflow?: IWorkflow;
-  enabled: boolean;
-  channels: IPreferenceChannels;
-  overrides?: IPreferenceOverride[];
-}
-
-export interface IPreferenceResponse {


Not used so I removed it.

ChmaraX · 2025-01-30T15:05:29Z

...app/subscribers-v2/usecases/get-subscriber-preferences/get-subscriber-preferences.usecase.ts

+    return plainToInstance(GetSubscriberPreferencesDto, {
+      global: globalPreference,
+      workflows: workflowPreferences,
+    });


I think we should serialize response to DTO like this in all new endpoints, maybe better in controller instead of usecase - it ensures response is validated and transformed to what is specified in DTO class.

It can be also setup globally on all controlles so this line is not needed.
https://docs.nestjs.com/techniques/serialization#overview

Between usecases, I would left just regular types.

I think this would lead to generally cleaner experience.

I'm not sure if that is needed because everything that comes from the DAL layer should already be valid. Otherwise, it means that we have a corrupted state in DB.
But I would like to hear some other opinions.

BTW plainToInstance can be done on the base class that we can extend from, so we don't need to do it every time.

What I mean is the DTO that comes as a response from API, DAL layer is business logic, this is to better illustrate - we dont serialize and we think we do, in order for ClassSerializer decorator to work, you need to return instance from a controller (or it can be also automatized by other decorator) - but we dont do it correctly.

apps/api/src/app/subscribers-v2/e2e/get-subscriber-preferences.e2e.ts

LetItRock · 2025-01-31T09:11:22Z

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

+    summary: 'Get subscriber preferences',
+    description: 'Get subscriber preferences',
+  })
+  async getSubscriberPreferences(


Do we want also to define a custom sdk method name? I'm wondering how it will name it by default.

I've named it retrieve, I think thats the convention

apps/api/src/app/subscribers-v2/subscribers.module.ts

LetItRock · 2025-01-31T09:19:10Z

...app/subscribers-v2/usecases/get-subscriber-preferences/get-subscriber-preferences.usecase.ts

+    return plainToInstance(GetSubscriberPreferencesDto, {
+      global: globalPreference,
+      workflows: workflowPreferences,
+    });


I'm not sure if that is needed because everything that comes from the DAL layer should already be valid. Otherwise, it means that we have a corrupted state in DB.
But I would like to hear some other opinions.

BTW plainToInstance can be done on the base class that we can extend from, so we don't need to do it every time.

LetItRock · 2025-01-31T09:21:08Z

...app/subscribers-v2/usecases/get-subscriber-preferences/get-subscriber-preferences.usecase.ts

+  }
+
+  private mapToWorkflowPreference(subscriberWorkflowPreference: ISubscriberPreferenceResponse): WorkflowPreferenceDto {
+    const { preference, template } = subscriberWorkflowPreference;


we should have workflow instead of template

This is a return type from already existing getSubscriberPreference usecase which is reused in other places across the app.

LetItRock · 2025-01-31T09:22:35Z

...ic/src/usecases/get-subscriber-global-preference/get-subscriber-global-preference.usecase.ts

+      throw new NotFoundException(
+        `Subscriber ${command.subscriberId} not found`,
+      );


did you verify that this usecase is not used in worker?

Yes - from what I see, worker is using just GetSubscriberPreference usecase, but even for that usecase I can't find any use inside worker - I will check if we can remove it possibly in next PR.

feat(api-service): subscriber preferences WIP

d3ed304

github-actions bot added @novu/shared @novu/api-service labels Jan 29, 2025

feat(api-service): add e2e tests

d112829

ChmaraX commented Jan 30, 2025

View reviewed changes

ChmaraX added 2 commits January 30, 2025 13:08

Merge branch 'next' into nv-5278-api-get-preferences-endpoint

7c9ed61

feat(api-service): merge with upstream

518bd9c

ChmaraX temporarily deployed to Linting January 30, 2025 12:19 — with GitHub Actions Inactive

fix(api-service): import

35018db

ChmaraX temporarily deployed to Linting January 30, 2025 14:04 — with GitHub Actions Inactive

ChmaraX changed the title ~~feat(api-service): subscriber preferences WIP~~ feat(api-service): subscriber preferences Jan 30, 2025

ChmaraX marked this pull request as ready for review January 30, 2025 14:05

ChmaraX commented Jan 30, 2025

View reviewed changes

apps/api/src/app/subscribers-v2/subscribers.module.ts Show resolved Hide resolved

ChmaraX commented Jan 30, 2025

View reviewed changes

ChmaraX requested review from SokratisVidros, LetItRock and BiswaViraj January 30, 2025 14:10

fix(api-service): dtos and types

0330809

ChmaraX temporarily deployed to Linting January 30, 2025 14:42 — with GitHub Actions Inactive

feat(api-service): serialzie response

ad52649

ChmaraX temporarily deployed to Linting January 30, 2025 15:02 — with GitHub Actions Inactive

ChmaraX commented Jan 30, 2025

View reviewed changes

ChmaraX requested a review from djabarovgeorge January 30, 2025 15:09

ChmaraX changed the title ~~feat(api-service): subscriber preferences~~ feat(api-service): get subscriber preferences v2 endpoint Jan 30, 2025

LetItRock reviewed Jan 31, 2025

View reviewed changes

feat(api-service): add SDK retrieve methods

d7aa6de

ChmaraX temporarily deployed to Linting January 31, 2025 09:38 — with GitHub Actions Inactive

feat(api-service): speakeasy SDKs

9cd9e56

ChmaraX temporarily deployed to Linting January 31, 2025 10:19 — with GitHub Actions Inactive

SokratisVidros approved these changes Jan 31, 2025

View reviewed changes

fix: reuse dtos

ad4666b

ChmaraX temporarily deployed to Linting January 31, 2025 14:00 — with GitHub Actions Inactive

ChmaraX merged commit 5d756e5 into next Jan 31, 2025
40 checks passed

ChmaraX deleted the nv-5278-api-get-preferences-endpoint branch January 31, 2025 14:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(api-service): get subscriber preferences v2 endpoint #7613

feat(api-service): get subscriber preferences v2 endpoint #7613

ChmaraX commented Jan 29, 2025 •

edited

Loading

linear bot commented Jan 29, 2025

netlify bot commented Jan 29, 2025 •

edited

Loading

netlify bot commented Jan 29, 2025 •

edited

Loading

pkg-pr-new bot commented Jan 30, 2025 •

edited

Loading

ChmaraX Jan 30, 2025

ChmaraX Jan 30, 2025

ChmaraX Jan 30, 2025 •

edited

Loading

LetItRock Jan 31, 2025

ChmaraX Jan 31, 2025

LetItRock Jan 31, 2025

ChmaraX Jan 31, 2025

LetItRock Jan 31, 2025

LetItRock Jan 31, 2025

ChmaraX Jan 31, 2025

LetItRock Jan 31, 2025

ChmaraX Jan 31, 2025

feat(api-service): get subscriber preferences v2 endpoint #7613

feat(api-service): get subscriber preferences v2 endpoint #7613

Conversation

ChmaraX commented Jan 29, 2025 • edited Loading

What changed? Why was the change needed?

linear bot commented Jan 29, 2025

netlify bot commented Jan 29, 2025 • edited Loading

✅ Deploy Preview for dev-web-novu ready!

netlify bot commented Jan 29, 2025 • edited Loading

✅ Deploy Preview for dashboard-v2-novu-staging ready!

pkg-pr-new bot commented Jan 30, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ChmaraX Jan 30, 2025 • edited Loading

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

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

ChmaraX commented Jan 29, 2025 •

edited

Loading

netlify bot commented Jan 29, 2025 •

edited

Loading

netlify bot commented Jan 29, 2025 •

edited

Loading

pkg-pr-new bot commented Jan 30, 2025 •

edited

Loading

ChmaraX Jan 30, 2025 •

edited

Loading