Skip to content

Remove deprecated field from Discovery#5469

Open
jmwample wants to merge 1 commit into
developfrom
jmwample/net-compat
Open

Remove deprecated field from Discovery#5469
jmwample wants to merge 1 commit into
developfrom
jmwample/net-compat

Conversation

@jmwample
Copy link
Copy Markdown
Contributor

@jmwample jmwample commented Jun 1, 2026

Description

Remove deprecated element of discovery which has been moved to a different place in the configuration structure.

The network_compatibility information was moved into the system_configuration structure over a year ago and is no longer referenced in the code.
Network compatibility added (merged 3/6/25): 32f1974
Network compatibility moved to system_configuration (merged 4/2/25): 470012f

I believe there should be no clients old enough that this could be a breaking change.

Checklist:

  • Remove deprecated network_compatibility field from discovery.

This change is Reviewable

Summary by CodeRabbit

  • Refactor
    • Reorganized discovery endpoint response structure and consolidated system configuration settings.

@jmwample jmwample added this to the v2026.10 - Tatry milestone Jun 1, 2026
@github-actions github-actions Bot requested review from neacsu and pronebird June 1, 2026 16:41
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 1, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

This PR consolidates network version compatibility management in the VPN discovery API response by removing the redundant network_compatibility field and relying on existing version thresholds in system_configuration.min_supported_app_versions. The Rust struct, all discovery configuration files, and test fixtures are updated consistently.

Changes

Network Compatibility Field Consolidation

Layer / File(s) Summary
Discovery response contract update
nym-vpn-core/crates/nym-vpn-api-client/src/response.rs
NymWellknownDiscoveryItemResponse removes the network_compatibility optional field and keeps feature_flags, system_messages, and system_configuration fields.
Network configuration updates
nym-vpn-core/crates/nym-vpn-network-config/default/canary_discovery.json, nym-vpn-core/crates/nym-vpn-network-config/default/mainnet_discovery.json, nym-vpn-core/crates/nym-vpn-network-config/default/sandbox_discovery.json
All three discovery configuration files remove their top-level network_compatibility blocks. Mainnet also adds a statistics_api URL field to system_configuration.
Test fixture alignment
nym-vpn-core/crates/nym-vpn-network-config/src/discovery.rs
The test_parse_discovery_response JSON fixture is updated to remove the network_compatibility field from the embedded response data.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A hop, a skip through fields so clean,
Network compat fields no longer seen!
Consolidate we do with care,
Three config files, now light as air.
Version thresholds unified,
In system_configuration they'll reside! 🎉

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Remove deprecated field from Discovery' accurately summarizes the main change—removing the deprecated network_compatibility field from the discovery endpoint.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description check ✅ Passed The pull request description is mostly complete and follows the template structure with a clear description of changes and context.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch jmwample/net-compat

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions Bot requested a review from trojanfoe June 1, 2026 16:41
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Jun 1, 2026

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants