route: keep the matched virtual host in the stream info #40065

wbpcode · 2025-06-29T05:52:57Z

Commit Message: route: keep the matched virtual host in the stream info
Additional Description:

Now the virtual host will also be kept in the stream info. This is useful if there is a partial match. Then although the route is not found, we still could log some virtual host related metadata in the log.

To close #39391

Risk Level: low. The core code change is very minor.
Testing: unit/intergation.
Docs Changes: n/a.
Release Notes: added.
Platform Specific Features: n/a.

Signed-off-by: wangbaiping(wbpcode) <wbphub@gmail.com>

wbpcode · 2025-06-29T05:54:47Z

Hi, @kyessenov , could you give first pass when you get some free time because seem you have some context of #39391. Thanks.

Signed-off-by: wangbaiping(wbpcode) <wbphub@gmail.com>

…eep-virtualhost

Signed-off-by: wangbaiping(wbpcode) <wbphub@gmail.com>

kyessenov

Some initial thoughts...

changelogs/current.yaml

envoy/router/router.h

source/common/http/filter_manager.h

kyessenov · 2025-06-30T18:01:13Z

source/common/stream_info/stream_info_impl.h

@@ -299,6 +299,13 @@ struct StreamInfoImpl : public StreamInfo {
    return *downstream_connection_info_provider_;
  }

+  const Router::VHostConstSharedPtr& vhost() const override {
+    // TODO(wbpcode): There is an edge case where the route and virtual host be override
+    // by the setRoute() of HTTP filter callbacks. But in that case the virtual host stored


That seems problematic? Filters can reprogram a route AFAIR?

Basically, there should no developer will override the virtualhost in practices (although they could). This is an edge case that may never happen. So, I left a TODO here.

I actually think we can remove the reference of vhost in the route in the next PR. Then the one who override virtualhost will encounter a compile error. Then he could create a issue to require new solution for virtulhost override if there is an actual scenario.

I refactor the implmentation, so we can get the vhost from the route if the setRoute() method is called. This resolve the problem the comment referred.

Signed-off-by: wangbaiping(wbpcode) <wbphub@gmail.com>

wbpcode · 2025-07-01T06:27:44Z

/retest

…eep-virtualhost

Signed-off-by: wangbaiping(wbpcode) <wbphub@gmail.com>

wbpcode · 2025-07-02T00:35:50Z

/retest

Copilot

Pull Request Overview

This PR updates the routing code to preserve and expose the matched virtual host in StreamInfo, even when no route entry is found. Key changes include:

Introducing a new vhost() accessor and VHostRoute struct to carry both virtual host and route pointers through routing APIs.
Updating all call sites, mocks, and tests to use the new virtualHost()->... and stream_info.vhost().
Adjusting METADATA and CEL formatters to pull metadata from vhost() when present, and adding an integration test for logging vhost metadata on unmatched routes.

Reviewed Changes

Copilot reviewed 44 out of 44 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
envoy/stream_info/stream_info.h	Add pure-virtual `vhost()` to `StreamInfo` API
source/common/stream_info/stream_info_impl.h	Implement and store `vhost_` in stream info
envoy/router/router.h	Introduce `VHostRoute` struct and change `Config::route` API
source/common/router/*	Update internal routing to return and propagate `vhost()`
source/extensions/formatter/metadata/*	Switch metadata formatter to use `vhost()`
test/*	Update dozens of mocks and test assertions to reflect new API

Comments suppressed due to low confidence (3)

test/extensions/formatter/metadata/metadata_test.cc:183

[nitpick] Consider adding a unit test for the scenario where the route lookup fails but a virtual host is still matched (i.e. route()==nullptr but vhost()!=nullptr) to ensure the formatter returns the vhost metadata as expected.

TEST_F(MetadataFormatterTest, VirtualHostMetadataNoVirtualHost) {

envoy/router/router.h:1374

Add a brief comment above this struct explaining that it carries both the matched virtual host and the route pointer, and that consumers should check .route before dereferencing.

struct VHostRoute {

envoy/stream_info/stream_info.h:850

Update the doc comment to note that vhost() may be nullptr if no virtual host was matched, so callers should guard accordingly.

  virtual const Router::VHostConstSharedPtr& vhost() const PURE;

envoy/stream_info/stream_info.h

kyessenov · 2025-07-02T21:15:21Z

source/common/router/config_impl.h

+    // The method cannot return the vhost_ directly because the vhost_ has different type with
+    // the VHostConstSharedPtr and will create a temporary copy implicitly and result in error
+    // of returning reference to local temporary object.
+    return vhost_copy_;


Did we change signature to be able to store vhost shared ptr in stream info?

Sorry, I missed this comment. Yeah, this change is necessary to ensure the vhost pointer in the stream info is always correct even when the setRoute is used.

It's possible that the developers re-program the route in a custom filter and override the virtual host. This method ensure we can get a shared point from the route that provided by the custom filter.

kyessenov

Oooof, this is a quite a large refactor, but I think the interface for stream info / route looks clean, and that's where most of the changes come from.

wbpcode · 2025-07-02T23:34:10Z

/assign-from @envoyproxy/senior-maintainers

repokitteh-read-only · 2025-07-02T23:34:17Z

@envoyproxy/senior-maintainers assignee is @phlax

🐱

Caused by: a #40065 (comment) was created by @wbpcode.

see: more, trace.

wbpcode · 2025-07-02T23:35:49Z

/assign-from @envoyproxy/senior-maintainers

repokitteh-read-only · 2025-07-02T23:35:55Z

@envoyproxy/senior-maintainers assignee is @RyanTheOptimist

🐱

Caused by: a #40065 (comment) was created by @wbpcode.

see: more, trace.

wbpcode · 2025-07-02T23:38:03Z

Oooof, this is a quite a large refactor, but I think the interface for stream info / route looks clean, and that's where most of the changes come from.

Thanks for the review!!! Most changes are test code to adapt to new interfaces. The actual core code changes are limited.

Signed-off-by: wangbaiping(wbpcode) <wbphub@gmail.com>

wbpcode · 2025-07-03T08:35:27Z

The latest commit do following changes after @kyessenov 's approval:

rename the VirtualHostSharedPtr (alias of std::shared_ptr<VirtualHostImpl>) -> VirtualHostImplSharedPtr.
rename the VHostConstSharedPtr to VirtualHostConstSharedPtr (use fullname of virtual host in the type per reviewer comment.).
rename the vhost() to virtualHost() per reviewer comment.

Signed-off-by: wangbaiping(wbpcode) <wbphub@gmail.com>

wbpcode · 2025-07-03T11:26:07Z

/retest

…0065) Commit Message: route: keep the matched virtual host in the stream info Additional Description: Now the virtual host will also be kept in the stream info. This is useful if there is a partial match. Then although the route is not found, we still could log some virtual host related metadata in the log. To close envoyproxy#39391 Risk Level: low. The core code change is very minor. Testing: unit/intergation. Docs Changes: n/a. Release Notes: added. Platform Specific Features: n/a. --------- Signed-off-by: wangbaiping(wbpcode) <wbphub@gmail.com> Signed-off-by: Anirban Nandi <anirbannandi@google.com>

route: keep the matched virtual host in the stream info

b99ea4a

Signed-off-by: wangbaiping(wbpcode) <wbphub@gmail.com>

wbpcode requested review from ravenblackx and nezdolik as code owners June 29, 2025 05:52

wbpcode assigned kyessenov Jun 29, 2025

wbpcode added 3 commits June 29, 2025 05:58

add change log

6f3fad9

Signed-off-by: wangbaiping(wbpcode) <wbphub@gmail.com>

fix more tests

81fd448

Signed-off-by: wangbaiping(wbpcode) <wbphub@gmail.com>

fix more tests

787311e

Signed-off-by: wangbaiping(wbpcode) <wbphub@gmail.com>

wbpcode requested a review from mattklein123 as a code owner June 29, 2025 06:19

wbpcode added 5 commits June 29, 2025 15:05

fix more tests

e71f2ad

Signed-off-by: wangbaiping(wbpcode) <wbphub@gmail.com>

fix cors tests

1c45142

Signed-off-by: wangbaiping(wbpcode) <wbphub@gmail.com>

fix more tests

a1b6365

Signed-off-by: wangbaiping(wbpcode) <wbphub@gmail.com>

Merge branch 'main' of https://github.com/envoyproxy/envoy into dev-k…

0ea1074

…eep-virtualhost

minor update

c40d3e3

Signed-off-by: wangbaiping(wbpcode) <wbphub@gmail.com>

kyessenov reviewed Jun 30, 2025

View reviewed changes

try fix tests

8012816

Signed-off-by: wangbaiping(wbpcode) <wbphub@gmail.com>

wbpcode added 2 commits July 1, 2025 09:22

Merge branch 'main' of https://github.com/envoyproxy/envoy into dev-k…

a7daa64

…eep-virtualhost

refactor to address comments

b1f5a11

Signed-off-by: wangbaiping(wbpcode) <wbphub@gmail.com>

wbpcode requested a review from Copilot July 2, 2025 11:02

Copilot AI reviewed Jul 2, 2025

View reviewed changes

kyessenov reviewed Jul 2, 2025

View reviewed changes

envoy/stream_info/stream_info.h Outdated Show resolved Hide resolved

kyessenov reviewed Jul 2, 2025

View reviewed changes

kyessenov previously approved these changes Jul 2, 2025

View reviewed changes

repokitteh-read-only bot assigned phlax Jul 2, 2025

wbpcode unassigned phlax Jul 2, 2025

repokitteh-read-only bot assigned RyanTheOptimist Jul 2, 2025

renaming and address comments

fd3cd4b

Signed-off-by: wangbaiping(wbpcode) <wbphub@gmail.com>

wbpcode dismissed kyessenov’s stale review via fd3cd4b July 3, 2025 08:31

wbpcode added 2 commits July 3, 2025 08:38

update comment

0c50274

Signed-off-by: wangbaiping(wbpcode) <wbphub@gmail.com>

revert unncessary change

524d6fa

Signed-off-by: wangbaiping(wbpcode) <wbphub@gmail.com>

RyanTheOptimist approved these changes Jul 8, 2025

View reviewed changes

wbpcode merged commit 9172ed8 into envoyproxy:main Jul 8, 2025
25 checks passed

wbpcode deleted the dev-keep-virtualhost branch July 8, 2025 03:29

route: keep the matched virtual host in the stream info #40065

route: keep the matched virtual host in the stream info #40065

Uh oh!

Conversation

wbpcode commented Jun 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wbpcode commented Jun 29, 2025

Uh oh!

kyessenov left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kyessenov Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

wbpcode Jul 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wbpcode Jul 1, 2025

Choose a reason for hiding this comment

Uh oh!

wbpcode commented Jul 1, 2025

Uh oh!

wbpcode commented Jul 2, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

kyessenov Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

wbpcode Jul 8, 2025

Choose a reason for hiding this comment

Uh oh!

kyessenov left a comment

Choose a reason for hiding this comment

Uh oh!

wbpcode commented Jul 2, 2025

Uh oh!

repokitteh-read-only bot commented Jul 2, 2025

Uh oh!

wbpcode commented Jul 2, 2025

Uh oh!

repokitteh-read-only bot commented Jul 2, 2025

Uh oh!

wbpcode commented Jul 2, 2025

Uh oh!

wbpcode commented Jul 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wbpcode commented Jul 3, 2025

Uh oh!

Uh oh!

Uh oh!

wbpcode commented Jun 29, 2025 •

edited

Loading

wbpcode Jul 1, 2025 •

edited

Loading

wbpcode commented Jul 3, 2025 •

edited

Loading