fix(api-service): move workflow dto from shared to api #8009

tatarco · 2025-03-26T22:47:33Z

Resolve Workflow DTO Issues

What changed? Why was the change needed?

DTO Migration and Enhancements

All DTOs were moved from shared into API, converted to classes, and assigned the correct OpenAPI decorators.
All of the workflow V2 DTOs are now generated under the @novu-api. All of our E2E tests are now using the SDK and dogfooding the OpenAPI structure.
Error DTOs have been enhanced due to issues found in implementation.
Class validators are now working on DTOs, enforcing bad data from getting into the service.
The filter has been updated to parse those errors elegantly as well.
Decoupled the interfaces created in shared from entities; they should not be used anymore. We generate DTOs now, and the client should not care about our database entity; all is clearly presented to him.
JSON schema was a complete mess; aligned it all the way to the DAL layer. Some as unknown had to be added in the framework to minimize scope.
The preference controller has been deprecated along with all its DTOs since naming was a big confusion and duplication. Deprecated them all in order to know what is new and what is old.
Separated DTOs into separate properly named files.

Screenshots

Expand for optional sections

Related enterprise PR

Special notes for your reviewer

linear · 2025-03-26T22:47:36Z

NV-5295 Align Workflow Controller to SDK

pkg-pr-new · 2025-03-26T23:03:17Z

Open in StackBlitz

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

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

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

commit: 0b93f24

netlify · 2025-03-31T05:27:21Z

👷 Deploy Preview for dashboard-v2-novu-staging processing.

Name	Link
🔨 Latest commit	`0b93f24`
🔍 Latest deploy log	https://app.netlify.com/sites/dashboard-v2-novu-staging/deploys/68007a7a0591fb0008d1787d

apps/api/src/app/inbox/usecases/session/session.usecase.ts

apps/api/src/config/cors.config.ts

SokratisVidros

This is an initial high level review. We are in the right direction and I am noting down the next actions in order to wrap this effort up:

We need to do another pass around the Preference and Workflow V2 DTOs. There still a lot of duplication between these DTOs for request and responses.
We need to solve the dual export issue for the internal SDK generated by speakeasy.

apps/api/src/app/bridge/usecases/preview-step/preview-step.usecase.ts

.cspell.json

SokratisVidros · 2025-04-02T14:30:02Z

...nvironments-v1/usecases/construct-framework-workflow/construct-framework-workflow.usecase.ts

@@ -54,7 +54,7 @@ export class ConstructFrameworkWorkflow {
      dbWorkflow.triggers[0].identifier,
      async ({ step, payload, subscriber }) => {
        const fullPayloadForRender: FullPayloadForRender = { payload, subscriber, steps: {} };
-        for await (const staticStep of dbWorkflow.steps) {
+        for (const staticStep of dbWorkflow.steps) {


@tatarco, why did we remove the await here? The dynamic workflow generation should be an async iterator.

it doesn't make any sense, it's an object not a promise, why async iterator?

apps/api/src/app/messages/e2e/get-messages.e2e.ts

apps/api/src/app/shared/dtos/preference-channels.ts

SokratisVidros · 2025-04-02T14:56:00Z

apps/api/src/app/shared/helpers/e2e/sdk/e2e-sdk.helper.ts

@@ -82,3 +118,32 @@ export async function expectSdkValidationExceptionGeneric<U>(
    return { error: handleValidationErrorDto(e) };
  }
 }
+export class CustomHeaderHTTPClient extends HTTPClient {


Do we really need to extend the Speakeasy client at this point? Doesn't it allow us to override its headers on the spot?

it allows us to do it only at the calls signature, I want to have it injected in all calls done with the instance, hence the requirement for this change.

SokratisVidros · 2025-04-02T14:59:19Z

apps/api/src/app/subscribers/dtos/subscriber-preference-template-response.dto.ts

@@ -0,0 +1,22 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+export class SubscriberPreferenceTemplateResponseDto {


Template is the internal modelling of workflows. Some preference DTOs use the term workflow, others the term template. We should stick to workflow.

I really don't want to make any additional changes besides whats a must in this huge PR, the purpose here is to document the existing state, lets move this to a seperate task

fixed wierd msg test fix test rebase fixes fixed wierd msg test remove bail fix excpetion mapper topics fixed. topics fixed. Revert "test skips" This reverts commit f9d2c46. test skips fix failing test on usage reports fix failing test on usage reports fix failing test on usage reports Refactor WorkflowController to use internal SDK

github-actions bot added @novu/dal @novu/shared @novu/worker @novu/dashboard @novu/api-service labels Mar 26, 2025

tatarco force-pushed the nv-5295-align-workflow-controller-to-sdk branch from 227fbd3 to 19f82c4 Compare March 28, 2025 08:56

tatarco temporarily deployed to Linting March 28, 2025 08:56 — with GitHub Actions Inactive

tatarco had a problem deploying to Linting March 28, 2025 08:56 — with GitHub Actions Failure

tatarco temporarily deployed to Linting March 28, 2025 08:58 — with GitHub Actions Inactive

tatarco had a problem deploying to Linting March 28, 2025 08:58 — with GitHub Actions Failure

tatarco temporarily deployed to Linting March 28, 2025 09:44 — with GitHub Actions Inactive

tatarco had a problem deploying to Linting March 28, 2025 09:44 — with GitHub Actions Failure

tatarco temporarily deployed to Linting March 28, 2025 10:57 — with GitHub Actions Inactive

tatarco had a problem deploying to Linting March 28, 2025 10:57 — with GitHub Actions Failure

tatarco force-pushed the nv-5295-align-workflow-controller-to-sdk branch from 4ce2174 to 3080a38 Compare March 31, 2025 05:27

tatarco force-pushed the nv-5295-align-workflow-controller-to-sdk branch from 3080a38 to 1b85ee4 Compare March 31, 2025 10:08

tatarco temporarily deployed to Linting March 31, 2025 10:08 — with GitHub Actions Inactive

tatarco had a problem deploying to Linting March 31, 2025 10:08 — with GitHub Actions Failure

github-advanced-security bot found potential problems Mar 31, 2025

View reviewed changes

apps/api/src/app/inbox/usecases/session/session.usecase.ts Fixed Show fixed Hide fixed

apps/api/src/config/cors.config.ts Fixed Show fixed Hide fixed

tatarco force-pushed the nv-5295-align-workflow-controller-to-sdk branch from 1b85ee4 to 345883d Compare March 31, 2025 10:31

tatarco had a problem deploying to Linting March 31, 2025 10:32 — with GitHub Actions Failure

tatarco temporarily deployed to Linting March 31, 2025 10:32 — with GitHub Actions Inactive

tatarco temporarily deployed to Linting April 2, 2025 08:29 — with GitHub Actions Inactive

tatarco had a problem deploying to Linting April 2, 2025 08:29 — with GitHub Actions Failure

tatarco force-pushed the nv-5295-align-workflow-controller-to-sdk branch 2 times, most recently from 308b23b to 3531159 Compare April 2, 2025 14:05

tatarco temporarily deployed to Linting April 2, 2025 14:05 — with GitHub Actions Inactive

tatarco had a problem deploying to Linting April 2, 2025 14:05 — with GitHub Actions Failure

tatarco temporarily deployed to Linting April 2, 2025 14:23 — with GitHub Actions Inactive

tatarco had a problem deploying to Linting April 2, 2025 14:23 — with GitHub Actions Failure

tatarco temporarily deployed to Linting April 2, 2025 14:23 — with GitHub Actions Inactive

tatarco temporarily deployed to Linting April 2, 2025 14:33 — with GitHub Actions Inactive

tatarco had a problem deploying to Linting April 2, 2025 14:33 — with GitHub Actions Failure

tatarco temporarily deployed to Linting April 2, 2025 14:33 — with GitHub Actions Inactive

SokratisVidros requested changes Apr 2, 2025

View reviewed changes

tatarco force-pushed the nv-5295-align-workflow-controller-to-sdk branch from 54d62b9 to 6bafc02 Compare April 16, 2025 06:33

tatarco temporarily deployed to Linting April 16, 2025 06:33 — with GitHub Actions Inactive

tatarco had a problem deploying to Linting April 16, 2025 06:33 — with GitHub Actions Failure

tatarco temporarily deployed to Linting April 16, 2025 06:33 — with GitHub Actions Inactive

ChmaraX and others added 5 commits April 16, 2025 16:22

fix: e2e test

d36d8b2

finished rebasing

dd76165

finished rebasing

c650185

finished rebasing

f999fc0

tatarco force-pushed the nv-5295-align-workflow-controller-to-sdk branch from 7585932 to f999fc0 Compare April 16, 2025 09:24

tatarco had a problem deploying to Linting April 16, 2025 09:24 — with GitHub Actions Failure

tatarco temporarily deployed to Linting April 16, 2025 09:24 — with GitHub Actions Inactive

tatarco had a problem deploying to Linting April 16, 2025 09:24 — with GitHub Actions Failure

tatarco added 3 commits April 16, 2025 18:22

finished rebasing

28e0c16

fix tests

566f41b

fix tests

0b93f24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(api-service): move workflow dto from shared to api #8009

fix(api-service): move workflow dto from shared to api #8009

tatarco commented Mar 26, 2025 •

edited

Loading

linear bot commented Mar 26, 2025

pkg-pr-new bot commented Mar 26, 2025 •

edited

Loading

netlify bot commented Mar 31, 2025 •

edited

Loading

SokratisVidros left a comment

SokratisVidros Apr 2, 2025

tatarco Apr 16, 2025

SokratisVidros Apr 2, 2025

tatarco Apr 16, 2025

SokratisVidros Apr 2, 2025

tatarco Apr 16, 2025

		@@ -0,0 +1,22 @@
		import { ApiProperty } from '@nestjs/swagger';

		export class SubscriberPreferenceTemplateResponseDto {

fix(api-service): move workflow dto from shared to api #8009

Are you sure you want to change the base?

fix(api-service): move workflow dto from shared to api #8009

Conversation

tatarco commented Mar 26, 2025 • edited Loading

What changed? Why was the change needed?

DTO Migration and Enhancements

Screenshots

Related enterprise PR

Special notes for your reviewer

linear bot commented Mar 26, 2025

pkg-pr-new bot commented Mar 26, 2025 • edited Loading

netlify bot commented Mar 31, 2025 • edited Loading

👷 Deploy Preview for dashboard-v2-novu-staging processing.

SokratisVidros left a comment

Choose a reason for hiding this comment

SokratisVidros Apr 2, 2025

Choose a reason for hiding this comment

tatarco Apr 16, 2025

Choose a reason for hiding this comment

SokratisVidros Apr 2, 2025

Choose a reason for hiding this comment

tatarco Apr 16, 2025

Choose a reason for hiding this comment

SokratisVidros Apr 2, 2025

Choose a reason for hiding this comment

tatarco Apr 16, 2025

Choose a reason for hiding this comment

tatarco commented Mar 26, 2025 •

edited

Loading

pkg-pr-new bot commented Mar 26, 2025 •

edited

Loading

netlify bot commented Mar 31, 2025 •

edited

Loading