refactor(core): Move backend config to a separate package (no-changelog) #9325
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
n8n-assistant
bot
added
core
ivov
reviewed
May 15, 2024
…ing `_FILE` suffixed env variables
ivov
reviewed
Jul 4, 2024
|
|
||
| @Config | ||
| export class TemplateConfig { | ||
| /** Overrides default HTML template for inviting new people (use full path) */ |
There was a problem hiding this comment.
Not clear what full path means exactly. Maybe an example? Same below.
|
|
||
| @Config | ||
| export class EmailConfig { | ||
| /** How to send emails */ |
There was a problem hiding this comment.
almost all the comments here are literally copy-pasted from what we have in schema.ts. We should definitely improve all these docs, but I don't think we need to block this PR on these docs.
It might make sense to get the docs team involved once the new package has all the config variables in it.
Co-authored-by: Iván Ovejero <ivov.src@gmail.com>
|
Addressed most of the comments. But overall, I don't think this PR should be fixing the existing docs for these config variables. We need a more involved overhaul of these docs, collaborating with the docs team. Regarding the mailer changes, those could be a separate PR. Please let me know if you prefer it that way 🙏🏽 |
|
Tested {
"database": {
"type": "postgresdb",
"postgresdb": {
"database": "n8n",
"host": "localhost",
"port": "5432",
"schema": "public",
"user": "postgres",
"password": "some-password"
}
}
}And seeing this: |
|
The plan was to add support for |
ivov
approved these changes
Jul 5, 2024
| const classMetadata = globalMetadata.get(ConfigClass); | ||
| if (!classMetadata) { | ||
| // eslint-disable-next-line n8n-local-rules/no-plain-errors | ||
| throw new Error('Invalid config class: ' + ConfigClass.name); |
There was a problem hiding this comment.
Should we enable n8n-local-rules/no-plain-errors for this package? In this case it makes no difference as failing here breaks the build and is not reportable, but for future proofing any other errors we may need to throw in this package. Maybe the rule should be live at the top lint config file and be disabled on a case-by-case basis.
There was a problem hiding this comment.
I'd like to see if we can make the type-checker somehow catch these kind of errors, to prevent stuff like this even reaching runtime.
| ignoreTLS: !config.getEnv('userManagement.emails.smtp.startTLS'), | ||
| }; | ||
| constructor( | ||
| globalConfig: GlobalConfig, |
There was a problem hiding this comment.
Suggested change
| globalConfig: GlobalConfig, | |
| readonly globalConfig: GlobalConfig, |
There was a problem hiding this comment.
will update in the next PR
| globalConfig: GlobalConfig, | ||
| private readonly logger: Logger, | ||
| ) { | ||
| const smtpConfig = globalConfig.userManagement.emails.smtp; |
There was a problem hiding this comment.
Can a consumer of globalConfig mutate it by accident? If so should we prevent this?
There was a problem hiding this comment.
right now, unfortunately yes. The plan is to switch to read-only proxies for the config eventually so that we can
- prevent writes
- block any callers from outside our packages from reading any config
Created ENG-134 for that.
|
|
||
| constructor( | ||
| private readonly userRepository: UserRepository, | ||
| globalConfig: GlobalConfig, |
There was a problem hiding this comment.
Suggested change
| globalConfig: GlobalConfig, | |
| readonly globalConfig: GlobalConfig, |
| config.getEnv('userManagement.emails.mode') === 'smtp' && | ||
| config.getEnv('userManagement.emails.smtp.host') !== ''; | ||
| const emailsConfig = globalConfig.userManagement.emails; | ||
| this.isEmailSetUp = emailsConfig.mode === 'smtp' && emailsConfig.smtp.host !== ''; |
There was a problem hiding this comment.
We could consider 'getters' for the new config.
There was a problem hiding this comment.
That is also a part of the plan, to have more utility methods/getters on the config classes.
| if (loggingOption) { | ||
| const optionsString = config.getEnv('database.logging.options').replace(/\s+/g, ''); | ||
|
|
||
| const optionsString = loggingConfig.options.replace(/\s+/g, ''); |
There was a problem hiding this comment.
Also in future we could have config doing its own validation.
There was a problem hiding this comment.
Yes. not only validation, but also transformation. so that JSON values could be auto-parsed, and we don't need to manually parse them, like we do for credentials.overwrite.data, and a few other properties.
3 flaky tests on run #5797 ↗︎
Details:
|
||||||||||||||||||||||||||||||
| Test | Artifacts | |
|---|---|---|
| NDV > should not retrieve remote options when required params throw errors |
Screenshots
Video
|
|
| NDV > Stop listening for trigger event from NDV |
Screenshots
Video
|
|
10-undo-redo.cy.ts • 1 flaky test
| Test | Artifacts | |
|---|---|---|
| Undo/Redo > should undo/redo adding nodes |
Test Replay
Screenshots
Video
|
|
Review all test suite changes for PR #9325 ↗︎
|
✅ All Cypress E2E specs passed |
netroy
changed the title
|
Got released with |
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.
This PR moves the config related code into a separate
@n8n/configpackage so that we can use the config on all backend packages (likecoreandnodes-base) without creating a circular dependency withcli.This PR also changes the config object to be
packages/cli/node_modules/@types/convict/index.d.tsEvery sub-section in the config is also now separately injectable, which we can use to create config objects specific to certain sections of the codebase, instead of using this one global config everywhere.
Ticket
ENG-126 & ENG-126
Review / Merge checklist