fix: cleanup dangling route status conditions by y-rabie · Pull Request #6812 · envoyproxy/gateway

y-rabie · 2025-08-18T12:53:09Z

What type of PR is this?

fix: cleanup dangling route status conditions

What this PR does / why we need it:

Currently, dangling parentRefs in the routes' statuses aren't cleaned up. That is, if a parentRef exist in the spec and status, and then is removed from the spec, the merge function logic causes it to stay there forever.

Since we compute the full status for all our spec parentRefs every time, that means any parentRef (of ours) that doesn't exist in the new computed status shouldn't be preserved in the final status.

Status parentRefs of other controllers stay untouched.

Apologies for the boilerplate code in the test cases, but these should be comprehensive to cover all cases. I could've written a function for test case generation that should reduce that somewhat, but I thought it will be less clear.

TODO: as per the comment in the test file, later we may need to solve for the case where, say a route references us through 1 parentRef, and then this parentRef is removed. Currently the route will forever have a dangling status parentRef for that, and will never be cleaned up. This fix however must be earlier in the code path where we consider which routes are relevant to us

Which issue(s) this PR fixes:

Fixes #

Release Notes: Yes/No

codecov · 2025-08-18T13:01:48Z

Codecov Report

❌ Patch coverage is 82.75862% with 5 lines in your changes missing coverage. Please review.
✅ Project coverage is 71.10%. Comparing base (a20a87d) to head (e7e7db8).
⚠️ Report is 56 commits behind head on main.

Files with missing lines	Patch %	Lines
internal/provider/kubernetes/status.go	82.75%	5 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6812      +/-   ##
==========================================
+ Coverage   71.08%   71.10%   +0.01%     
==========================================
  Files         225      225              
  Lines       39810    39824      +14     
==========================================
+ Hits        28300    28315      +15     
+ Misses       9846     9845       -1     
  Partials     1664     1664

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Signed-off-by: y-rabie <[email protected]>

y-rabie · 2025-08-18T14:06:13Z

/retest

y-rabie · 2025-08-18T15:13:00Z

/retest

y-rabie · 2025-08-29T11:38:55Z

@zhaohuabing Can you please take a look when you can?

zhaohuabing · 2025-08-29T15:09:22Z

@zhaohuabing Can you please take a look when you can?

Thanks for your patience — I’ll be reviewing this next week.

arkodg

LGTM thanks

Signed-off-by: y-rabie <[email protected]> Signed-off-by: shawnh2 <[email protected]>

Signed-off-by: y-rabie <[email protected]> Signed-off-by: zirain <[email protected]>

* fix: handle context errors as transient errors (#6850) * handle context errors as transient errors Signed-off-by: TomerJLevy <[email protected]> * add test cases Signed-off-by: TomerJLevy <[email protected]> * no need the new line Signed-off-by: TomerJLevy <[email protected]> * add release notes Signed-off-by: TomerJLevy <[email protected]> * Return the error as is Signed-off-by: TomerJLevy <[email protected]> * revert redundant changes Signed-off-by: TomerJLevy <[email protected]> * revert unrelated changes Signed-off-by: TomerJLevy <[email protected]> * revert more changes... Signed-off-by: TomerJLevy <[email protected]> --------- Signed-off-by: TomerJLevy <[email protected]> Co-authored-by: zirain <[email protected]> Signed-off-by: shawnh2 <[email protected]> * chore: fix CVE (#6903) Signed-off-by: Shahar Harari <[email protected]> Signed-off-by: shawnh2 <[email protected]> * fix: rm incorrectly set exclusiveMaximum field in CRD (#6926) * fix: rm incorrectly set exclusiveMaximum field in CRD * Also fix maximum value to 599 which includes 599 as a valid num Fixes: #6925 Signed-off-by: Arko Dasgupta <[email protected]> Signed-off-by: shawnh2 <[email protected]> * fix: validation for grpc routes with extension ref filters (#6949) Signed-off-by: Rudrakh Panigrahi <[email protected]> Signed-off-by: shawnh2 <[email protected]> * fix: cleanup dangling route status conditions (#6812) Signed-off-by: y-rabie <[email protected]> Signed-off-by: shawnh2 <[email protected]> * Fix: Add missing patch annotations to Compression struct for proper Merge (#6951) * fix: merge compression annotation Signed-off-by: sudipto baral <[email protected]> * test: add more compression merge test cases Signed-off-by: sudipto baral <[email protected]> --------- Signed-off-by: sudipto baral <[email protected]> Signed-off-by: shawnh2 <[email protected]> * fix: update distroless image to resolve glibc CVEs (#6953) Signed-off-by: Shahar Harari <[email protected]> Signed-off-by: shawnh2 <[email protected]> * fix gen-check Signed-off-by: shawnh2 <[email protected]> --------- Signed-off-by: TomerJLevy <[email protected]> Signed-off-by: shawnh2 <[email protected]> Signed-off-by: Shahar Harari <[email protected]> Signed-off-by: Arko Dasgupta <[email protected]> Signed-off-by: Rudrakh Panigrahi <[email protected]> Signed-off-by: y-rabie <[email protected]> Signed-off-by: sudipto baral <[email protected]> Co-authored-by: TomerJLevy <[email protected]> Co-authored-by: zirain <[email protected]> Co-authored-by: shahar-h <[email protected]> Co-authored-by: Arko Dasgupta <[email protected]> Co-authored-by: Rudrakh Panigrahi <[email protected]> Co-authored-by: Youssef Rabie <[email protected]> Co-authored-by: Sudipto Baral <[email protected]>

* fix: cluster stat name: lowercase Kind (#6780) cluster stat name: lowercase Kind Signed-off-by: Guy Daich <[email protected]> Signed-off-by: zirain <[email protected]> * fix: envoy service cluster name for zone-aware routing (#6763) * fix!: fix envoy service cluster name for zone-aware routing Signed-off-by: y-rabie <[email protected]> * extend e2e tests for zone aware routing Signed-off-by: y-rabie <[email protected]> * extend unit tests for zone aware routing Signed-off-by: y-rabie <[email protected]> --------- Signed-off-by: y-rabie <[email protected]> Signed-off-by: zirain <[email protected]> * conformance: update experimental test report (#6782) * conformance: update experimental test report Signed-off-by: zirain <[email protected]> * fix version Signed-off-by: zirain <[email protected]> * fix(api): image validation regex, support port in repository (#6819) fix: match repository in image with port Signed-off-by: Windfarer <[email protected]> Signed-off-by: zirain <[email protected]> * fix: Actually update xdsIR with maxAcceptPerSocketEvent (#6834) * Actually update xdsIR with maxAcceptPerSocketEvent Signed-off-by: jukie <[email protected]> * release note Signed-off-by: jukie <[email protected]> * newline lint Signed-off-by: jukie <[email protected]> --------- Signed-off-by: jukie <[email protected]> Signed-off-by: zirain <[email protected]> * bugfix: fix the topologyInjectorDisabled and the local cluster was not defined (#6847) * bugfix: fix the topologyInjectorDisabled and the local cluster was not defined. Signed-off-by: qicz <[email protected]> * fix ut Signed-off-by: qicz <[email protected]> * add topology-injector-enabled ut Signed-off-by: qicz <[email protected]> * add release note Signed-off-by: qi <[email protected]> --------- Signed-off-by: qicz <[email protected]> Signed-off-by: qi <[email protected]> Signed-off-by: zirain <[email protected]> * fix(logging): correct log formatting to avoid DPANIC in controller-runtime logger (#6846) * Update filters.go Signed-off-by: TomerJLevy <[email protected]> * add release notes Signed-off-by: TomerJLevy <[email protected]> --------- Signed-off-by: TomerJLevy <[email protected]> Signed-off-by: zirain <[email protected]> * fix: handle context errors as transient errors (#6850) * handle context errors as transient errors Signed-off-by: TomerJLevy <[email protected]> * add test cases Signed-off-by: TomerJLevy <[email protected]> * no need the new line Signed-off-by: TomerJLevy <[email protected]> * add release notes Signed-off-by: TomerJLevy <[email protected]> * Return the error as is Signed-off-by: TomerJLevy <[email protected]> * revert redundant changes Signed-off-by: TomerJLevy <[email protected]> * revert unrelated changes Signed-off-by: TomerJLevy <[email protected]> * revert more changes... Signed-off-by: TomerJLevy <[email protected]> --------- Signed-off-by: TomerJLevy <[email protected]> Co-authored-by: zirain <[email protected]> Signed-off-by: zirain <[email protected]> * bugfix: the controller cannot read the EnvoyProxy attached gatewayclass only. (#6838) Signed-off-by: zirain <[email protected]> * chore: fix CVE (#6903) Signed-off-by: Shahar Harari <[email protected]> Signed-off-by: zirain <[email protected]> * fix: nil pointer dereference in btp configmap indexer (#6921) Signed-off-by: Rudrakh Panigrahi <[email protected]> Signed-off-by: zirain <[email protected]> * improve targetRef selection for targetSelectors (#6917) * improve targetRef selection for targetSelectors * only select refs in the same namespace as the policy Signed-off-by: Arko Dasgupta <[email protected]> * fix lint Signed-off-by: Arko Dasgupta <[email protected]> --------- Signed-off-by: Arko Dasgupta <[email protected]> Signed-off-by: zirain <[email protected]> * fix: suppress lua validation logs (#6929) Signed-off-by: Rudrakh Panigrahi <[email protected]> Signed-off-by: zirain <[email protected]> * fix: rm incorrectly set exclusiveMaximum field in CRD (#6926) * fix: rm incorrectly set exclusiveMaximum field in CRD * Also fix maximum value to 599 which includes 599 as a valid num Fixes: #6925 Signed-off-by: Arko Dasgupta <[email protected]> Signed-off-by: zirain <[email protected]> * fix: rm Strict SameSite default (#6941) * by default it should be unset which implies `Lax` Relates to #6347 Signed-off-by: Arko Dasgupta <[email protected]> Signed-off-by: zirain <[email protected]> * Optimize pod cache (#6936) * Optimize pod cache Signed-off-by: jukie <[email protected]> * release note Signed-off-by: jukie <[email protected]> * Remove retry Signed-off-by: jukie <[email protected]> * cleanup Signed-off-by: jukie <[email protected]> --------- Signed-off-by: jukie <[email protected]> Signed-off-by: Isaac <[email protected]> Co-authored-by: zirain <[email protected]> Signed-off-by: zirain <[email protected]> * reduce DeepCopy in gateway-api layer (#6940) * reduce deep copy in gateway-api layer * also fixed the DeepCopy implementation for ControllerResources which was performing a Shallow Copy resulting it lack of isolation b/w provider and gateway-api layer Relates to #6919 Signed-off-by: Arko Dasgupta <[email protected]> * fix lint Signed-off-by: Arko Dasgupta <[email protected]> --------- Signed-off-by: Arko Dasgupta <[email protected]> Signed-off-by: zirain <[email protected]> * fix: validation for grpc routes with extension ref filters (#6949) Signed-off-by: Rudrakh Panigrahi <[email protected]> Signed-off-by: zirain <[email protected]> * fix: cleanup dangling route status conditions (#6812) Signed-off-by: y-rabie <[email protected]> Signed-off-by: zirain <[email protected]> * Fix: Add missing patch annotations to Compression struct for proper Merge (#6951) * fix: merge compression annotation Signed-off-by: sudipto baral <[email protected]> * test: add more compression merge test cases Signed-off-by: sudipto baral <[email protected]> --------- Signed-off-by: sudipto baral <[email protected]> Signed-off-by: zirain <[email protected]> * fix: update distroless image to resolve glibc CVEs (#6953) Signed-off-by: Shahar Harari <[email protected]> Signed-off-by: zirain <[email protected]> * chore: bump golang to 1.24.7 (#6959) chore: bump golang Signed-off-by: zirain <[email protected]> * fix: Make sure proxy protocol filter is the first listener filter (#6972) Fixes: #6873 Signed-off-by: Arko Dasgupta <[email protected]> Co-authored-by: Jacob Neil Taylor <[email protected]> Signed-off-by: zirain <[email protected]> * release notes Signed-off-by: zirain <[email protected]> * Removes reflection from RouteContext to reduce allocations (#6820) * bench: adds APIToXDS bench & small opt Signed-off-by: Takeshi Yoneda <[email protected]> * no refect goos: darwin goarch: arm64 pkg: github.com/envoyproxy/gateway/test/gobench cpu: Apple M1 Pro │ old.txt │ new.txt │ │ sec/op │ sec/op vs base │ GatewayAPItoXDS/small-10 881.2µ ± 7% 803.4µ ± 1% -8.82% (p=0.000 n=10) GatewayAPItoXDS/medium-10 4.130m ± 26% 2.959m ± 4% -28.36% (p=0.000 n=10) GatewayAPItoXDS/large-10 5.375 ± 2% 4.553 ± 1% -15.28% (p=0.000 n=10) geomean 26.94m 22.12m -17.90% │ old.txt │ new.txt │ │ B/op │ B/op vs base │ GatewayAPItoXDS/small-10 507.2Ki ± 0% 492.9Ki ± 0% -2.83% (p=0.000 n=10) GatewayAPItoXDS/medium-10 2.545Mi ± 7% 1.954Mi ± 2% -23.21% (p=0.000 n=10) GatewayAPItoXDS/large-10 2.832Gi ± 0% 2.831Gi ± 0% ~ (p=0.529 n=10) geomean 15.40Mi 13.97Mi -9.31% │ old.txt │ new.txt │ │ allocs/op │ allocs/op vs base │ GatewayAPItoXDS/small-10 8.328k ± 0% 8.017k ± 0% -3.73% (p=0.000 n=10) GatewayAPItoXDS/medium-10 39.45k ± 6% 29.74k ± 2% -24.60% (p=0.000 n=10) GatewayAPItoXDS/large-10 38.75M ± 0% 38.71M ± 0% -0.11% (p=0.000 n=10) geomean 233.5k 209.8k -10.16% Signed-off-by: Takeshi Yoneda <[email protected]> * removes garbage Signed-off-by: Takeshi Yoneda <[email protected]> * more tests Signed-off-by: Takeshi Yoneda <[email protected]> * more tests Signed-off-by: Takeshi Yoneda <[email protected]> --------- Signed-off-by: Takeshi Yoneda <[email protected]> --------- Signed-off-by: Guy Daich <[email protected]> Signed-off-by: zirain <[email protected]> Signed-off-by: y-rabie <[email protected]> Signed-off-by: Windfarer <[email protected]> Signed-off-by: jukie <[email protected]> Signed-off-by: qicz <[email protected]> Signed-off-by: qi <[email protected]> Signed-off-by: TomerJLevy <[email protected]> Signed-off-by: Shahar Harari <[email protected]> Signed-off-by: Rudrakh Panigrahi <[email protected]> Signed-off-by: Arko Dasgupta <[email protected]> Signed-off-by: Isaac <[email protected]> Signed-off-by: sudipto baral <[email protected]> Signed-off-by: Takeshi Yoneda <[email protected]> Co-authored-by: Guy Daich <[email protected]> Co-authored-by: Youssef Rabie <[email protected]> Co-authored-by: Windfarer <[email protected]> Co-authored-by: Isaac <[email protected]> Co-authored-by: qi <[email protected]> Co-authored-by: TomerJLevy <[email protected]> Co-authored-by: shahar-h <[email protected]> Co-authored-by: Rudrakh Panigrahi <[email protected]> Co-authored-by: Arko Dasgupta <[email protected]> Co-authored-by: Sudipto Baral <[email protected]> Co-authored-by: Jacob Neil Taylor <[email protected]> Co-authored-by: Takeshi Yoneda <[email protected]>

y-rabie requested a review from a team as a code owner August 18, 2025 12:53

fix: cleanup dangling route status conditions

e7e7db8

Signed-off-by: y-rabie <[email protected]>

y-rabie force-pushed the fix-httproute-status branch from 70802ec to e7e7db8 Compare August 18, 2025 13:05

arkodg requested a review from zhaohuabing August 18, 2025 13:46

arkodg added cherrypick/release-v1.5.1 cherrypick/release-v1.4.4 kind/bug Something isn't working labels Sep 3, 2025

kkk777-7 mentioned this pull request Sep 10, 2025

HTTPRoute status updater does not remove non-targeted Gateway #6933

Closed

jukie approved these changes Sep 12, 2025

View reviewed changes

arkodg approved these changes Sep 13, 2025

View reviewed changes

arkodg merged commit 44f43ea into envoyproxy:main Sep 13, 2025
70 of 75 checks passed

shawnh2 pushed a commit to shawnh2/gateway that referenced this pull request Sep 15, 2025

fix: cleanup dangling route status conditions (envoyproxy#6812)

b7daceb

Signed-off-by: y-rabie <[email protected]> Signed-off-by: shawnh2 <[email protected]>

shawnh2 pushed a commit to shawnh2/gateway that referenced this pull request Sep 15, 2025

fix: cleanup dangling route status conditions (envoyproxy#6812)

c1ab45a

Signed-off-by: y-rabie <[email protected]> Signed-off-by: shawnh2 <[email protected]>

zirain mentioned this pull request Sep 16, 2025

[release/v1.5] cherry pick for v1.5.1 #6974

Closed

zirain pushed a commit to zirain/gateway that referenced this pull request Sep 16, 2025

fix: cleanup dangling route status conditions (envoyproxy#6812)

6c38467

Signed-off-by: y-rabie <[email protected]> Signed-off-by: zirain <[email protected]>

zirain pushed a commit to zirain/gateway that referenced this pull request Sep 16, 2025

fix: cleanup dangling route status conditions (envoyproxy#6812)

8d8c7c6

Signed-off-by: y-rabie <[email protected]> Signed-off-by: zirain <[email protected]>

zirain mentioned this pull request Sep 16, 2025

[release/v1.5] cherry pick for v1.5.1 #6975

Merged

This was referenced Sep 25, 2025

Routes with multiple parent references only update status for one parent (v1.5.1 regression) #7067

Closed

Fix: Preserve route parent status for multi-parent routes #7068

Merged

y-rabie mentioned this pull request Oct 22, 2025

fix: cleanup dangling parents in route and policy statuses #7307

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: cleanup dangling route status conditions#6812

fix: cleanup dangling route status conditions#6812
arkodg merged 1 commit intoenvoyproxy:mainfrom
y-rabie:fix-httproute-status

y-rabie commented Aug 18, 2025

Uh oh!

codecov bot commented Aug 18, 2025 •

edited

Loading

Uh oh!

y-rabie commented Aug 18, 2025

Uh oh!

y-rabie commented Aug 18, 2025

Uh oh!

y-rabie commented Aug 29, 2025

Uh oh!

zhaohuabing commented Aug 29, 2025

Uh oh!

arkodg left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

y-rabie commented Aug 18, 2025

Uh oh!

codecov bot commented Aug 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

y-rabie commented Aug 18, 2025

Uh oh!

y-rabie commented Aug 18, 2025

Uh oh!

y-rabie commented Aug 29, 2025

Uh oh!

zhaohuabing commented Aug 29, 2025

Uh oh!

arkodg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov bot commented Aug 18, 2025 •

edited

Loading