[Http] Make HTTP resource routes respond without the versioned header #195940
+118
−41
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
|
🤖 Jobs for this PR can be triggered through checkboxes. 🚧
ℹ️ To trigger the CI, please tick the checkbox below 👇
|
jloleysens
commented
Oct 11, 2024
| @@ -84,7 +85,7 @@ export class HttpResourcesService implements CoreService<InternalHttpResourcesSe | |||
| route: RouteConfig<P, Q, B, 'get'>, | |||
| handler: HttpResourcesRequestHandler<P, Q, B, Context> | |||
| ) => { | |||
| return router.get<P, Q, B>( | |||
| return (router as unknown as Router<RequestHandlerContext>).get<P, Q, B>( | |||
There was a problem hiding this comment.
This was the simplest way to get this working end-to-end without a larger refactor to pass Router in directly.
IMO it's OK for the internal http resources to have privileged knowledge of Router types (i.e. the internal options). Just didn't want to make this too big of a refactor for now.
Happy to take other ideas.
src/core/server/integration_tests/http_resources/http_resources_service.test.ts
Outdated
Show resolved
Hide resolved
|
/ci |
jloleysens
commented
Oct 11, 2024
|
|
||
| await root.start(); | ||
| const { header } = await request.get(root, '/render-html').expect(200); | ||
| expect(header).not.toMatchObject({ 'elastic-api-version': expect.any(String) }); |
There was a problem hiding this comment.
Making this test work is the main focus of the PR.
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
Adds the internal route registrar option
isHTTPResourceto distinguish API routes from routes intended to be used for loading resources, for ex.This enables us to avoid returning the version header
elastic-api-versionfor these 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:
This PR addresses the second point.
Checklist