Skip to content

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
finos:mainfrom
re-vlad:feat/warn-deprecated-config-fields
Open

feat(config): add deprecation warnings for legacy config fields (Phase 1: warnings in 2.x)#1626
re-vlad wants to merge 1 commit into
finos:mainfrom
re-vlad:feat/warn-deprecated-config-fields

Conversation

@re-vlad

@re-vlad re-vlad commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Description

Phase 1 of the deprecated config migration (non-breaking, target 2.1).

Logs console.warn when user config overrides still use legacy top-level fields:

  • sslKeyPemPath without tls.key
  • sslCertPemPath without tls.cert
  • proxyUrl (deprecated and ignored at runtime)

Warnings are based on user overrides only (CONFIG_FILE), evaluated in loadFullConfiguration() 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

  • Documentation has been added/updated for any new features (N/A — warn-only, no user-facing config schema change)

Configuration

  • If configuration schema (config.schema.json) was modified: (N/A — schema not changed)
    • TypeScript types regenerated (npm run generate-config-types)
    • Schema reference docs regenerated (npm run gen-schema-doc)

Tests

  • Tests have been added/updated for new functionality
  • Unit tests pass (npm test -- test/deprecatedFields.test.ts test/testConfig.test.ts)
  • Linting and formatting pass (npm run lint on changed files)
  • Type checks pass (npm run check-types) (or note: check-types:server if full check fails on unrelated local issues)

Test plan

  • npm test -- test/deprecatedFields.test.ts
  • npm 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

@re-vlad re-vlad requested a review from a team as a code owner June 30, 2026 16:28
@netlify

netlify Bot commented Jun 30, 2026

Copy link
Copy Markdown

Deploy Preview for endearing-brigadeiros-63f9d0 canceled.

Name Link
🔨 Latest commit c297827
🔍 Latest deploy log https://app.netlify.com/projects/endearing-brigadeiros-63f9d0/deploys/6a43ee9efe3dfd0008cc7bbc

@re-vlad re-vlad self-assigned this Jun 30, 2026
@re-vlad re-vlad added the enhancement New feature or request label Jun 30, 2026
@codecov

codecov Bot commented Jun 30, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 84.21053% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 85.67%. Comparing base (7fe2e29) to head (c297827).

Files with missing lines Patch % Lines
src/config/deprecatedFields.ts 80.00% 3 Missing ⚠️
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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@re-vlad

re-vlad commented Jul 10, 2026

Copy link
Copy Markdown
Contributor Author

@kriswest can we add this proposition to agenda?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant