feat(api): Delete subscriber channel preference when updating global channel #6767

rifont · 2024-10-24T15:25:27Z

What changed? Why was the change needed?

API
- Delete subscriber channel preference when updating global channel
  - This ensures that the global preference can take priority again after updating the global preference
- Return only the active & non-critical channels for Global Subscriber preferences
  - Previously all channels were shown regardless of the active or critical state of the Workflow. This change ensures the Subscriber only sees channels relevant to them, as all the other channels are not relevant and may cause confusion
- Persist only the provided values for all preference sets with the exception of Workflow Resource preferences, to ensure that PATCH operations for preferences don't create preferences for non-relevant channels
- Refactoring
  - Rename GetPreferences for Inbox to GetInboxPreferences to eliminate naming duplication with the generic GetPreferences use-case
  - Refactor preference use-cases to eliminate duplication and ease transition to V2 Preferences
- TODO: should we throw a 400 Bad Request response when attempting to modify global preference channels that don't have active & non-critical workflows that would be affected? Right now, the PATCH responses for global preferences return undefined for channels that are irrelevant and it doesn't make much sense. We have failing tests that need to be addressed with the outcome of this decision.
<Inbox />
- Optimistically update Subscriber Workflow preferences in <Inbox /> when modifying the Subscriber Global preferences, to ensure that the unset Workflow preferences display immediately.

Screenshots

Toggling the Subscriber Global Channel Preferences in <Inbox /> modifies the corresponding Subscriber Workflow Channel Preference fields.
Important Note: This PR only has changes to reflect local state changes optimistically, it does not refetch all Preferences from the API after the optimistic update.

global-preference-unset-workflow-pref.mov

<Inbox /> displays only Global Preference channels for active & non-critical workflow channels

Expand for optional sections

Related enterprise PR

Special notes for your reviewer

linear · 2024-10-24T15:25:30Z

NV-4498 Forget workflow subscriber preferences if global channel preference are updated

rifont · 2024-10-24T15:32:10Z

libs/dal/src/repositories/preferences/preferences.schema.ts

Removing defaults to ensure that only the provided mutation values are persisted, enabling PATCH operations to work as expected.

netlify · 2024-10-24T15:32:25Z

✅ Deploy Preview for novu-stg-vite-dashboard-poc ready!

Name	Link
🔨 Latest commit	`2137bc3`
🔍 Latest deploy log	https://app.netlify.com/sites/novu-stg-vite-dashboard-poc/deploys/671f4929be35d800080923ae
😎 Deploy Preview	https://deploy-preview-6767--novu-stg-vite-dashboard-poc.netlify.app
📱 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.

rifont · 2024-10-24T15:33:44Z

apps/api/src/app/bridge/usecases/sync/sync.usecase.ts

@@ -323,6 +329,10 @@ export class Sync {
    return notificationGroupId;
  }

+  private getWorkflowPreferences(workflow: DiscoverWorkflowOutput): WorkflowPreferencesPartial {
+    return workflow.preferences || {};


A fallback empty object is now necessary during sync after strengthening validation of the UpsertWorkflow use-case to disallow undefined preferences.

rifont · 2024-10-24T15:34:49Z

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

Here and in the following files, we'll see renaming from GetPreferences to GetInboxPreferences to eliminate the duplicated usage of GetPreferences use-case naming.

rifont · 2024-10-24T15:37:04Z

apps/api/src/app/inbox/usecases/get-inbox-preferences/get-inbox-preferences.usecase.ts

This is a slightly bad diff, as the file is not entirely new. This use-case is however now considerably simpler, owing to better encapsulation of both:

GetSubscriberGlobalPreference filtering out channels in the response to include only active & non-critical channels

GetSubscriberPreference filtering out preference sets to include only active & non-critical workflows

Full encapsulation of V1 & V2 preferences in both of the above use-cases

rifont · 2024-10-28T07:21:33Z

apps/api/src/app/inbox/usecases/get-inbox-preferences/get-inbox-preferences.spec.ts

This was a bad diff - it has an extra test spec which caused it to become bad after renaming from get-preferences -> get-inbox-preferences

pkg-pr-new · 2024-10-28T07:35:30Z

Open in Stackblitz

pnpm add https://pkg.pr.new/novuhq/novu/@novu/js@6767

pnpm add https://pkg.pr.new/novuhq/novu/@novu/nextjs@6767

pnpm add https://pkg.pr.new/novuhq/novu/@novu/react@6767

pnpm add https://pkg.pr.new/novuhq/novu/@novu/react-native@6767

commit: 2137bc3

SokratisVidros · 2024-10-28T07:49:39Z

.github/actions/setup-project/action.yml

      with:
-        mongodb-version: 4.2.8
+        mongodb-version: 5.0.29


Good call out!

SokratisVidros · 2024-10-28T07:51:54Z

libs/dal/src/repositories/preferences/preferences.schema.ts

rifont · 2024-10-28T07:54:11Z

packages/js/src/preferences/preferences.ts

-    return this.callWithSession(async () =>
-      updatePreference({ emitter: this._emitter, apiService: this._inboxService, args })
-    );
-  }


This update method on the full Preferences resource was never used, so I'm deleting it.

rifont added 16 commits October 23, 2024 14:38

refactor(preferences): enhance validation and structure

5e77371

refactor(preferences): remove default values from schema

cda73b9

fix(sync): handle undefined workflow preferences

856a947

refactor(base.command): improve error mapping logic

22346b8

refactor(upsert-preferences): remove unused import

18523d5

refactor(sync): extract getWorkflowPreferences method

8ba826f

refactor(inbox): rename GetPreferences to GetInboxPreferences

eaf6080

refactor(inbox): rename GetPreferences to GetInboxPreferences

3e3ff65

refactor(upsert-preferences): simplify preferences handling

f5c8d98

feat(preferences): add unset logic for channel types

0c41453

refactor(preferences): simplify channel handling

150e302

refactor(sync): update WorkflowPreferences type usage

6a66a12

refactor(inbox): simplify preference retrieval logic

5d99857

refactor(preference): simplify global preference logic

0fa489a

refactor(get-subscriber): improve preference handling

86b5bc6

refactor(workflows): add default workflow preferences

56f0d09

rifont temporarily deployed to Linting October 24, 2024 15:25 — with GitHub Actions Inactive

github-actions bot added @novu/api @novu/dal labels Oct 24, 2024

rifont commented Oct 24, 2024

View reviewed changes

refactor(preferences): update storePreferences method

70f22b6

rifont temporarily deployed to Linting October 24, 2024 15:44 — with GitHub Actions Inactive

rifont temporarily deployed to Linting October 26, 2024 09:42 — with GitHub Actions Inactive

rifont had a problem deploying to Linting October 26, 2024 09:42 — with GitHub Actions Error

ci: Update MongoDB version in setup action

2ee421d

rifont temporarily deployed to Linting October 26, 2024 09:43 — with GitHub Actions Inactive

rifont added 2 commits October 26, 2024 12:39

style: Adjust div height in preferences page

e383ae2

refactor(get-preferences): update preferences handling

09107f8

rifont temporarily deployed to Linting October 27, 2024 09:12 — with GitHub Actions Inactive

refactor(get-preferences): update source type definitions

33c0d8e

rifont temporarily deployed to Linting October 27, 2024 09:43 — with GitHub Actions Inactive

rifont commented Oct 28, 2024

View reviewed changes

refactor(preferences): add caching to preference update

a53724a

rifont temporarily deployed to Linting October 28, 2024 07:30 — with GitHub Actions Inactive

rifont temporarily deployed to Linting October 28, 2024 07:31 — with GitHub Actions Inactive

SokratisVidros approved these changes Oct 28, 2024

View reviewed changes

rifont commented Oct 28, 2024

View reviewed changes

test: simplify global preference channel assertions

2137bc3

rifont temporarily deployed to Linting October 28, 2024 08:19 — with GitHub Actions Inactive

rifont merged commit bd2f04d into next Oct 28, 2024
39 checks passed

rifont deleted the nv-4498-forget-workflow-subscriber-preferences-if-global-channel branch October 28, 2024 16:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(api): Delete subscriber channel preference when updating global channel #6767

feat(api): Delete subscriber channel preference when updating global channel #6767

rifont commented Oct 24, 2024 •

edited

Loading

linear bot commented Oct 24, 2024

rifont Oct 24, 2024

SokratisVidros Oct 28, 2024

netlify bot commented Oct 24, 2024 •

edited

Loading

rifont Oct 24, 2024

rifont Oct 24, 2024

rifont Oct 24, 2024 •

edited

Loading

rifont Oct 28, 2024 •

edited

Loading

pkg-pr-new bot commented Oct 28, 2024 •

edited

Loading

SokratisVidros Oct 28, 2024

SokratisVidros Oct 28, 2024

rifont Oct 28, 2024

feat(api): Delete subscriber channel preference when updating global channel #6767

feat(api): Delete subscriber channel preference when updating global channel #6767

Conversation

rifont commented Oct 24, 2024 • edited Loading

What changed? Why was the change needed?

Screenshots

Related enterprise PR

Special notes for your reviewer

linear bot commented Oct 24, 2024

rifont Oct 24, 2024

Choose a reason for hiding this comment

SokratisVidros Oct 28, 2024

Choose a reason for hiding this comment

netlify bot commented Oct 24, 2024 • edited Loading

✅ Deploy Preview for novu-stg-vite-dashboard-poc ready!

rifont Oct 24, 2024

Choose a reason for hiding this comment

rifont Oct 24, 2024

Choose a reason for hiding this comment

rifont Oct 24, 2024 • edited Loading

Choose a reason for hiding this comment

rifont Oct 28, 2024 • edited Loading

Choose a reason for hiding this comment

pkg-pr-new bot commented Oct 28, 2024 • edited Loading

SokratisVidros Oct 28, 2024

Choose a reason for hiding this comment

SokratisVidros Oct 28, 2024

Choose a reason for hiding this comment

rifont Oct 28, 2024

Choose a reason for hiding this comment

rifont commented Oct 24, 2024 •

edited

Loading

netlify bot commented Oct 24, 2024 •

edited

Loading

rifont Oct 24, 2024 •

edited

Loading

rifont Oct 28, 2024 •

edited

Loading

pkg-pr-new bot commented Oct 28, 2024 •

edited

Loading