[8.15] [Http] Gracefully onboarding internal routes to VersionedRouter (#194789)
#194905
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
…astic#194789) ## Summary If an internal route goes from unversioned -> versioned today this will surface as a breaking change. This PR allows internal routes to gracefully onboard to the versioned router. The fix is to default to version `1` of an internal route if no version is provided. In this way old clients can continue to interact with the new servers as developers onboard to the versioned router and roll out v2+ of an internal route. ## Notes We could use `buildNr` to narrow down internal routes defaulting to v1 to older clients only. IMO this would be more accurate, but also of marginal value. My rationale is: by requiring explicit versions during dev time the risk of us shipping new builds that don't provide a version is effectively nullified. Additionally we already run this risk with our public route default behaviour (we even require that public routes have explicit version in dev to mitigate this same risk for existing public clients). If reviewers feel otherwise I'm happy to revisit this! ### Checklist Delete any items that are not applicable to this PR. - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### Risk Matrix | Risk | Probability | Severity | Mitigation/Notes | |---------------------------|-------------|----------|-------------------------| | By defaulting internal routes to v1 it's possible that behaviour becomes less predictable. | Low | Low | This is already true for public routes and we are allowing a more limited/more predictable version of that here. | (cherry picked from commit afecfd8) # Conflicts: # packages/core/http/core-http-router-server-internal/src/versioned_router/core_versioned_route.test.ts # packages/core/http/core-http-router-server-internal/src/versioned_router/core_versioned_route.ts
1 task
gsoldevila
approved these changes
Oct 7, 2024
|
@gsoldevila I responded, let me know what you think! |
💚 Build Succeeded
Metrics [docs]
History
To update your PR or re-run it, just comment 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.
Backport
This will backport the following commits from
mainto8.15:VersionedRouter(#194789)Questions ?
Please refer to the Backport tool documentation