feat(config): add deprecation warnings for legacy config fields (Phase 1: warnings in 2.x)#1626
Open
re-vlad wants to merge 1 commit into
Open
feat(config): add deprecation warnings for legacy config fields (Phase 1: warnings in 2.x)#1626re-vlad wants to merge 1 commit into
re-vlad wants to merge 1 commit into
Conversation
✅ Deploy Preview for endearing-brigadeiros-63f9d0 canceled.
|
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1626 +/- ##
==========================================
- Coverage 85.67% 85.67% -0.01%
==========================================
Files 83 84 +1
Lines 7967 7986 +19
Branches 1342 1347 +5
==========================================
+ Hits 6826 6842 +16
- Misses 1114 1117 +3
Partials 27 27 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Contributor
Author
|
@kriswest can we add this proposition to agenda? |
This file contains hidden or 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
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.
Description
Phase 1 of the deprecated config migration (non-breaking, target 2.1).
Logs
console.warnwhen user config overrides still use legacy top-level fields:sslKeyPemPathwithouttls.keysslCertPemPathwithouttls.certproxyUrl(deprecated and ignored at runtime)Warnings are based on user overrides only (
CONFIG_FILE), evaluated inloadFullConfiguration()before merge. Existing fallback behaviour from #1514 is unchanged.Strict removal of these fields and startup failure for legacy-only configs remains planned for 3.0 (#1545).
Related Issue
Related to #1545 (Phase 1: warnings in 2.x; Phase 2: removal in 3.0).
Checklist
General
Documentation
Configuration
config.schema.json) was modified: (N/A — schema not changed)npm run generate-config-types)npm run gen-schema-doc)Tests
npm test -- test/deprecatedFields.test.ts test/testConfig.test.ts)npm run linton changed files)npm run check-types) (or note:check-types:serverif full check fails on unrelated local issues)Test plan
npm test -- test/deprecatedFields.test.tsnpm test -- test/testConfig.test.ts(legacy TLS fallback still works; stderr shows expected warnings)npm run lint -- src/config/deprecatedFields.ts src/config/index.ts test/deprecatedFields.test.ts