chore(shared): Eliminate circular dependencies #6743
+739
−710
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SokratisVidros
temporarily deployed
to
Linting
GitHub Actions
Inactive
SokratisVidros
temporarily deployed
to
Linting
GitHub Actions
Inactive
SokratisVidros
had a problem deploying
to
Linting
GitHub Actions
Failure
❌ Deploy Preview for novu-stg-vite-dashboard-poc failed. Why did it fail? →
|
SokratisVidros
commented
Oct 22, 2024
| @@ -1,4 +1,4 @@ | |||
| import { PreferencesResponseDto, StepResponseDto, WorkflowCommonsFields } from './workflow-commons-fields'; | |||
| import { PreferencesResponseDto, StepResponseDto, WorkflowCommonsFields } from './workflow-response.dto'; | |||
There was a problem hiding this comment.
@tatarco I think we made the exact parallel change in two PRs. Let's chat tomorrow to see how can we merge, the workflow-response.dtoor workflow-response-dto.
rifont
reviewed
Oct 23, 2024
packages/framework/package.json
Outdated
| @@ -26,11 +26,12 @@ | |||
| "format:fix": "prettier --write --ignore-path .gitignore .", | |||
| "build": "tsup && pnpm check:circulars", | |||
There was a problem hiding this comment.
We should remove the addition invocation of check:circulars in build now that we have postbuild
Suggested change
| "build": "tsup && pnpm check:circulars", | |
| "build": "tsup", |
SokratisVidros
force-pushed
the
eliminate_circular_dependencies
branch
from
528ac3a
to
c205d5a
Compare
SokratisVidros
temporarily deployed
to
Linting
GitHub Actions
Inactive
SokratisVidros
temporarily deployed
to
Linting
GitHub Actions
Inactive
SokratisVidros
had a problem deploying
to
Linting
GitHub Actions
Failure
@novu/client
@novu/framework
@novu/headless
@novu/js
@novu/nest
@novu/nextjs
@novu/node
@novu/notification-center
novu
@novu/providers
@novu/react
@novu/react-native
@novu/shared
@novu/stateless
commit: |
The rule is: Entities depend on DTOs and Types. DTOs depend on Types Based on that all circular type dependencies under /types are resolved.
That is, make the check much stricter.
SokratisVidros
force-pushed
the
eliminate_circular_dependencies
branch
from
c205d5a
to
dd3b321
Compare
SokratisVidros
temporarily deployed
to
Linting
GitHub Actions
Inactive
SokratisVidros
had a problem deploying
to
Linting
GitHub Actions
Failure
SokratisVidros
temporarily deployed
to
Linting
GitHub Actions
Inactive
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changed? Why was the change needed?
Cause, why not ❓
@novu/shared doesn't have strict conventions regarding its folder structure. As a result, types import entities, dtos import types or entities, and so on. This resulted in a very large number of TS circular imports, causing unexpected issues and TS headaches.
This PR addresses that with the help of madge. 🙌
Consider it, as a first step towards a more structured, treeshakable
@novu/shared, that contains meaningful share utility functions and types.