[Http] Added version header to unversioned, public routes #195464
Merged
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
jloleysens
added
Feature:http
Team:Core
|
Pinging @elastic/kibana-core (Team:Core) |
jloleysens
commented
Oct 8, 2024
| code: jest.fn().mockImplementation(() => mockResponse), | ||
| header: jest.fn().mockImplementation(() => mockResponse), | ||
| }; | ||
| const mockResponseToolkit: any = { | ||
| } as unknown as jest.Mocked<ResponseObject>; |
There was a problem hiding this comment.
Slightly better than any, at least we can use a typed object in these tests
packages/core/http/core-http-router-server-internal/src/router.ts
Outdated
Show resolved
Hide resolved
Comment on lines
+138
to
+140
| ).resolves.toMatchObject({ | ||
| message: expect.stringMatching(/Invalid version/), | ||
| }); |
There was a problem hiding this comment.
Replaced use of toEqual(expect.objectContaining({... for more terse toMatchObject({... API
💛 Build succeeded, but was flaky
Failed CI StepsTest Failures
Metrics [docs]
cc @jloleysens |
Bamieh
reviewed
Oct 9, 2024
| const [first, second] = mockResponse.header.mock.calls | ||
| .concat() | ||
| .sort(([k1], [k2]) => k1.localeCompare(k2)); | ||
| expect(first).toEqual(['AAAA', 'test']); |
|
Starting backport for target branches: 8.x https://github.com/elastic/kibana/actions/runs/11259229795 |
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
kibanamachine
added a commit
that referenced
this pull request
Oct 9, 2024
) (#195646) # Backport This will backport the following commits from `main` to `8.x`: - [[Http] Added version header to unversioned, public routes (#195464)](#195464) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Jean-Louis Leysens","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-10-09T16:33:54Z","message":"[Http] Added version header to unversioned, public routes (#195464)","sha":"61251bfdaffdb621558fff96d78cc8b2260c0abe","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:http","Team:Core","release_note:skip","v9.0.0","v8.16.0","backport:version"],"title":"[Http] Added version header to unversioned, public routes","number":195464,"url":"https://github.com/elastic/kibana/pull/195464","mergeCommit":{"message":"[Http] Added version header to unversioned, public routes (#195464)","sha":"61251bfdaffdb621558fff96d78cc8b2260c0abe"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/195464","number":195464,"mergeCommit":{"message":"[Http] Added version header to unversioned, public routes (#195464)","sha":"61251bfdaffdb621558fff96d78cc8b2260c0abe"}},{"branch":"8.x","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Jean-Louis Leysens <[email protected]>
1 task
jloleysens
added a commit
that referenced
this pull request
Oct 15, 2024
…#195940) ## Summary Follow up on #195464 Adds public route registrar option `httpResource` to distinguish API routes from routes intended to be used for loading resources, [for ex](https://github.com/elastic/kibana/blob/bd22f1370fc55179ea6f2737176570176f700b6e/x-pack/plugins/security/server/routes/authentication/oidc.ts#L36). This enables us to avoid returning the version header `elastic-api-version` for HTTP resource routes. It's still possible for API authors to use the versioned router for things that should be HTTP resources, but it's assumed that all routes registered through HTTP resources services are: 1. Public 2. Not versioned (focus of this PR) 3. Not documented (done in #192675) ### Checklist - [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 --------- Co-authored-by: kibanamachine <[email protected]>
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Oct 15, 2024
…elastic#195940) ## Summary Follow up on elastic#195464 Adds public route registrar option `httpResource` to distinguish API routes from routes intended to be used for loading resources, [for ex](https://github.com/elastic/kibana/blob/bd22f1370fc55179ea6f2737176570176f700b6e/x-pack/plugins/security/server/routes/authentication/oidc.ts#L36). This enables us to avoid returning the version header `elastic-api-version` for HTTP resource routes. It's still possible for API authors to use the versioned router for things that should be HTTP resources, but it's assumed that all routes registered through HTTP resources services are: 1. Public 2. Not versioned (focus of this PR) 3. Not documented (done in elastic#192675) ### Checklist - [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 --------- Co-authored-by: kibanamachine <[email protected]> (cherry picked from commit 72f3d2d)
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.
Summary
Close #190735
All unversioned, public routes, like versioned routes, will now include the following header in responses:
...when:
(1) The route produces a response from the handler (any status code)
(2) The route validation failed (400 bad request)
The header will not be included if we encounter a 500 or encounter some issue before reaching the router.
How to test
At time of PR
/api/statsis not versioned, but public so useful to test with:Checklist