Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

When route is registered with empty path it is normalized to /. #2616

Merged
merged 1 commit into from
Mar 27, 2024

Conversation

aldas
Copy link
Contributor

@aldas aldas commented Mar 24, 2024

When route is registered with empty path it is normalized to /. Make sure that returned echo.Route structs reflect that behavior. Internally router has changed `` (empty path) to / for a long time but Route that is returned did not reflect that. Is is problematic with `Reverse` function that uses empty string as "not found"

Related to #2615

Previous behavior can be seen with this test:

func TestTest(t *testing.T) {
	e := echo.New()

	handler := func(c echo.Context) error {
		return c.String(http.StatusNotImplemented, "Nope")
	}
	r := e.GET("", handler) // path is registered as "" previously. After change `/` is registered
	r.Name = "test"

	existingEmpty := e.Reverse("test")
	assert.Equal(t, "", existingEmpty)

	notExistingEmpty := e.Reverse("not-existing")
	assert.Equal(t, "", notExistingEmpty)
}

whis this change assert.Equal(t, "", existingEmpty) shoulb be change to assert.Equal(t, "/", existingEmpty)to pass the test

…e sure that returned echo.Route structs reflect that behavior.
Copy link

codecov bot commented Mar 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.03%. Comparing base (d549290) to head (65d0914).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2616   +/-   ##
=======================================
  Coverage   93.02%   93.03%           
=======================================
  Files          41       41           
  Lines        4703     4707    +4     
=======================================
+ Hits         4375     4379    +4     
  Misses        236      236           
  Partials       92       92           

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

@aldas aldas merged commit 447c92d into labstack:master Mar 27, 2024
16 checks passed
@aldas aldas deleted the normalize_path branch March 27, 2024 10:28
nono referenced this pull request in cozy/cozy-stack Apr 22, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [github.com/labstack/echo/v4](https://togithub.com/labstack/echo) |
`v4.11.4` -> `v4.12.0` |
[![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2flabstack%2fecho%2fv4/v4.12.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/go/github.com%2flabstack%2fecho%2fv4/v4.12.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/go/github.com%2flabstack%2fecho%2fv4/v4.11.4/v4.12.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2flabstack%2fecho%2fv4/v4.11.4/v4.12.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>labstack/echo (github.com/labstack/echo/v4)</summary>

###
[`v4.12.0`](https://togithub.com/labstack/echo/blob/HEAD/CHANGELOG.md#v4120---2024-04-15)

[Compare
Source](https://togithub.com/labstack/echo/compare/v4.11.4...v4.12.0)

**Security**

- Update golang.org/x/net dep because of
[GO-2024-2687](https://pkg.go.dev/vuln/GO-2024-2687) by
[@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2625](https://togithub.com/labstack/echo/pull/2625)

**Enhancements**

- binder: make binding to Map work better with string destinations by
[@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2554](https://togithub.com/labstack/echo/pull/2554)
- README.md: add Encore as sponsor by
[@&#8203;marcuskohlberg](https://togithub.com/marcuskohlberg) in
[https://github.com/labstack/echo/pull/2579](https://togithub.com/labstack/echo/pull/2579)
- Reorder paragraphs in README.md by
[@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2581](https://togithub.com/labstack/echo/pull/2581)
- CI: upgrade actions/checkout to v4 by
[@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2584](https://togithub.com/labstack/echo/pull/2584)
- Remove default charset from 'application/json' Content-Type header by
[@&#8203;doortts](https://togithub.com/doortts) in
[https://github.com/labstack/echo/pull/2568](https://togithub.com/labstack/echo/pull/2568)
- CI: Use Go 1.22 by [@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2588](https://togithub.com/labstack/echo/pull/2588)
- binder: allow binding to a nil map by
[@&#8203;georgmu](https://togithub.com/georgmu) in
[https://github.com/labstack/echo/pull/2574](https://togithub.com/labstack/echo/pull/2574)
- Add Skipper Unit Test In BasicBasicAuthConfig and Add More Detail
Explanation regarding BasicAuthValidator by
[@&#8203;RyoKusnadi](https://togithub.com/RyoKusnadi) in
[https://github.com/labstack/echo/pull/2461](https://togithub.com/labstack/echo/pull/2461)
- fix some typos by
[@&#8203;teslaedison](https://togithub.com/teslaedison) in
[https://github.com/labstack/echo/pull/2603](https://togithub.com/labstack/echo/pull/2603)
- fix: some typos by [@&#8203;pomadev](https://togithub.com/pomadev) in
[https://github.com/labstack/echo/pull/2596](https://togithub.com/labstack/echo/pull/2596)
- Allow ResponseWriters to unwrap writers when flushing/hijacking by
[@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2595](https://togithub.com/labstack/echo/pull/2595)
- Add SPDX licence comments to files. by
[@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2604](https://togithub.com/labstack/echo/pull/2604)
- Upgrade deps by [@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2605](https://togithub.com/labstack/echo/pull/2605)
- Change type definition blocks to single declarations. This helps copy…
by [@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2606](https://togithub.com/labstack/echo/pull/2606)
- Fix Real IP logic by [@&#8203;cl-bvl](https://togithub.com/cl-bvl) in
[https://github.com/labstack/echo/pull/2550](https://togithub.com/labstack/echo/pull/2550)
- Default binder can use `UnmarshalParams(params []string) error` inter…
by [@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2607](https://togithub.com/labstack/echo/pull/2607)
- Default binder can bind pointer to slice as struct field. For example
`*[]string` by [@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2608](https://togithub.com/labstack/echo/pull/2608)
- Remove maxparam dependence from Context by
[@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2611](https://togithub.com/labstack/echo/pull/2611)
- When route is registered with empty path it is normalized to `/`. by
[@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2616](https://togithub.com/labstack/echo/pull/2616)
- proxy middleware should use httputil.ReverseProxy for SSE requests by
[@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2624](https://togithub.com/labstack/echo/pull/2624)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "before 6am on Monday" in timezone
Europe/Paris, Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/cozy/cozy-stack).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zMTMuMSIsInVwZGF0ZWRJblZlciI6IjM3LjMxMy4xIiwidGFyZ2V0QnJhbmNoIjoibWFzdGVyIiwibGFiZWxzIjpbXX0=-->
mikemrm added a commit to infratographer/x that referenced this pull request Aug 8, 2024
An update in v4.12.0 introduced normalized paths which ensures
empty paths or paths without a prefixed `/` start with a `/`.

This is something we ran into previously which is why we had these tests.

Now that these routes are handled properly, we needed to update our tests
as all paths are prefixed with `/` now.

Relevant PR: labstack/echo#2616

Signed-off-by: Mike Mason <[email protected]>
github-merge-queue bot referenced this pull request in infratographer/x Aug 8, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [github.com/labstack/echo/v4](https://togithub.com/labstack/echo) |
`v4.11.4` -> `v4.12.0` |
[![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2flabstack%2fecho%2fv4/v4.12.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/go/github.com%2flabstack%2fecho%2fv4/v4.12.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/go/github.com%2flabstack%2fecho%2fv4/v4.11.4/v4.12.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2flabstack%2fecho%2fv4/v4.11.4/v4.12.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>labstack/echo (github.com/labstack/echo/v4)</summary>

###
[`v4.12.0`](https://togithub.com/labstack/echo/blob/HEAD/CHANGELOG.md#v4120---2024-04-15)

[Compare
Source](https://togithub.com/labstack/echo/compare/v4.11.4...v4.12.0)

**Security**

- Update golang.org/x/net dep because of
[GO-2024-2687](https://pkg.go.dev/vuln/GO-2024-2687) by
[@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2625](https://togithub.com/labstack/echo/pull/2625)

**Enhancements**

- binder: make binding to Map work better with string destinations by
[@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2554](https://togithub.com/labstack/echo/pull/2554)
- README.md: add Encore as sponsor by
[@&#8203;marcuskohlberg](https://togithub.com/marcuskohlberg) in
[https://github.com/labstack/echo/pull/2579](https://togithub.com/labstack/echo/pull/2579)
- Reorder paragraphs in README.md by
[@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2581](https://togithub.com/labstack/echo/pull/2581)
- CI: upgrade actions/checkout to v4 by
[@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2584](https://togithub.com/labstack/echo/pull/2584)
- Remove default charset from 'application/json' Content-Type header by
[@&#8203;doortts](https://togithub.com/doortts) in
[https://github.com/labstack/echo/pull/2568](https://togithub.com/labstack/echo/pull/2568)
- CI: Use Go 1.22 by [@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2588](https://togithub.com/labstack/echo/pull/2588)
- binder: allow binding to a nil map by
[@&#8203;georgmu](https://togithub.com/georgmu) in
[https://github.com/labstack/echo/pull/2574](https://togithub.com/labstack/echo/pull/2574)
- Add Skipper Unit Test In BasicBasicAuthConfig and Add More Detail
Explanation regarding BasicAuthValidator by
[@&#8203;RyoKusnadi](https://togithub.com/RyoKusnadi) in
[https://github.com/labstack/echo/pull/2461](https://togithub.com/labstack/echo/pull/2461)
- fix some typos by
[@&#8203;teslaedison](https://togithub.com/teslaedison) in
[https://github.com/labstack/echo/pull/2603](https://togithub.com/labstack/echo/pull/2603)
- fix: some typos by [@&#8203;pomadev](https://togithub.com/pomadev) in
[https://github.com/labstack/echo/pull/2596](https://togithub.com/labstack/echo/pull/2596)
- Allow ResponseWriters to unwrap writers when flushing/hijacking by
[@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2595](https://togithub.com/labstack/echo/pull/2595)
- Add SPDX licence comments to files. by
[@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2604](https://togithub.com/labstack/echo/pull/2604)
- Upgrade deps by [@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2605](https://togithub.com/labstack/echo/pull/2605)
- Change type definition blocks to single declarations. This helps copy…
by [@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2606](https://togithub.com/labstack/echo/pull/2606)
- Fix Real IP logic by [@&#8203;cl-bvl](https://togithub.com/cl-bvl) in
[https://github.com/labstack/echo/pull/2550](https://togithub.com/labstack/echo/pull/2550)
- Default binder can use `UnmarshalParams(params []string) error` inter…
by [@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2607](https://togithub.com/labstack/echo/pull/2607)
- Default binder can bind pointer to slice as struct field. For example
`*[]string` by [@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2608](https://togithub.com/labstack/echo/pull/2608)
- Remove maxparam dependence from Context by
[@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2611](https://togithub.com/labstack/echo/pull/2611)
- When route is registered with empty path it is normalized to `/`. by
[@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2616](https://togithub.com/labstack/echo/pull/2616)
- proxy middleware should use httputil.ReverseProxy for SSE requests by
[@&#8203;aldas](https://togithub.com/aldas) in
[https://github.com/labstack/echo/pull/2624](https://togithub.com/labstack/echo/pull/2624)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR was generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View the
[repository job log](https://developer.mend.io/github/infratographer/x).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yOTMuMCIsInVwZGF0ZWRJblZlciI6IjM3LjQzOC4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119-->

---------

Signed-off-by: Mike Mason <[email protected]>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Mike Mason <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant