Allow different param names in different methods with same path scheme #2209

ortyomka · 2022-06-29T08:12:25Z

Relates to issues #1726 and #2201

Parameters and paths are now separated by methods within the same node.
Add new method Context, which store path, parameters, and handler.
Add test from #1726.

CC @aldas

ortyomka · 2022-06-29T08:21:26Z

@aldas could you run tests again? Added small fix

ortyomka · 2022-06-29T08:33:08Z

I forgot about middleware tests. Fixed

@aldas

Signed-off-by: ortyomka <iurin.art@gmail.com>

ortyomka · 2022-06-29T12:06:56Z

Found a quicker and easier way for the new structure. In methodHandler, I use Context instead of Handler and don't store map.

old - original
new - map with contexts
new2 - methodHandler with contexts

name \ time/op                       old.txt      new.txt      new2.txt
EchoStaticRoutes-4                   18.1µs ± 0%  18.4µs ± 0%  17.4µs ± 0%
EchoStaticRoutesMisses-4             17.7µs ± 0%  20.1µs ± 0%  17.5µs ± 0%
EchoGitHubAPI-4                      31.9µs ± 0%  34.0µs ± 0%  30.5µs ± 0%
EchoGitHubAPIMisses-4                40.7µs ± 0%  33.5µs ± 0%  31.1µs ± 0%
EchoParseAPI-4                       3.11µs ± 0%  2.30µs ± 0%  2.03µs ± 0%
RouterStaticRoutes-4                 14.0µs ± 0%  15.2µs ± 0%  13.5µs ± 0%
RouterStaticRoutesMisses-4            491ns ± 0%   492ns ± 0%   466ns ± 0%
RouterGitHubAPI-4                    25.3µs ± 0%  27.4µs ± 0%  23.7µs ± 0%
RouterGitHubAPIMisses-4               576ns ± 0%   594ns ± 0%   568ns ± 0%
RouterParseAPI-4                     1.28µs ± 0%  1.47µs ± 0%  1.23µs ± 0%
RouterParseAPIMisses-4                304ns ± 0%   363ns ± 0%   312ns ± 0%
RouterGooglePlusAPI-4                 854ns ± 0%  1137ns ± 0%   823ns ± 0%
RouterGooglePlusAPIMisses-4           466ns ± 0%   683ns ± 0%   477ns ± 0%
RouterParamsAndAnyAPI-4              1.96µs ± 0%  2.54µs ± 0%  2.03µs ± 0%

original vs current

name                                 old time/op    new time/op    delta
EchoStaticRoutes-4                     17.2µs ± 2%    17.3µs ± 2%    ~     (p=0.421 n=5+5)
EchoStaticRoutesMisses-4               17.0µs ± 2%    17.3µs ± 2%    ~     (p=0.151 n=5+5)
EchoGitHubAPI-4                        30.9µs ± 0%    31.3µs ± 3%    ~     (p=0.690 n=5+5)
EchoGitHubAPIMisses-4                  31.5µs ± 4%    31.5µs ± 5%    ~     (p=1.000 n=5+5)
EchoParseAPI-4                         2.04µs ± 3%    2.05µs ± 2%    ~     (p=0.841 n=5+5)
RouterStaticRoutes-4                   13.5µs ± 3%    13.6µs ± 2%    ~     (p=0.095 n=5+5)
RouterStaticRoutesMisses-4              474ns ± 1%     469ns ± 0%  -1.01%  (p=0.008 n=5+5)
RouterGitHubAPI-4                      23.9µs ± 1%    23.9µs ± 2%    ~     (p=0.841 n=5+5)
RouterGitHubAPIMisses-4                 577ns ± 0%     580ns ± 3%    ~     (p=0.730 n=4+5)
RouterParseAPI-4                       1.24µs ± 1%    1.24µs ± 1%    ~     (p=0.222 n=5+5)
RouterParseAPIMisses-4                  306ns ± 3%     300ns ± 0%  -1.84%  (p=0.008 n=5+5)
RouterGooglePlusAPI-4                   831ns ± 1%     806ns ± 1%  -2.93%  (p=0.008 n=5+5)
RouterGooglePlusAPIMisses-4             468ns ± 0%     462ns ± 0%  -1.29%  (p=0.008 n=5+5)
RouterParamsAndAnyAPI-4                1.94µs ± 0%    1.93µs ± 1%    ~     (p=0.071 n=5+5)

cc @aldas, ready for review

aldas

I do not understand why this new struct methodContext is necessary in this PR context? I do not see it adding any functional or performance value. Changing things from HandlerFunc to pointer seems unnecessary as function types are nillable.

ortyomka · 2022-06-29T12:24:02Z

I do not understand why this new struct methodContext is necessary in this PR context? I do not see it adding any functional or performance value. Changing things from HandlerFunc to pointer seems unnecessary as function types are nillable.

Agree, I will add functionality

Signed-off-by: ortyomka <iurin.art@gmail.com>

ortyomka · 2022-06-29T12:52:35Z

Added functionality, to store different paths and parameters in different methods

Done @aldas

ortyomka · 2022-07-05T09:01:40Z

@aldas , if you have time, please review PR

aldas · 2022-07-05T21:03:33Z

router.go

@@ -13,14 +13,17 @@ type (
 		routes map[string]*Route
 		echo   *Echo
 	}
+	methodContext struct {


I do not think that context describes this struct correctly. In world of http servers and Echo context is something more temporary. I have used routeMethod in v5 for similar struct but in v5 methodHandler struct is also renamed to routeMethods.

Renamed to routeMethod

router.go

Add paramsCount in each node for perfomance Signed-off-by: ortyomka <iurin.art@gmail.com>

ortyomka · 2022-07-06T08:45:28Z

@aldas I have fixed comments, could you take a look?

codecov · 2022-07-06T19:12:56Z

Codecov Report

Merging #2209 (627588a) into master (0644cd6) will increase coverage by 0.02%.
The diff coverage is 97.50%.

@@            Coverage Diff             @@
##           master    #2209      +/-   ##
==========================================
+ Coverage   92.26%   92.29%   +0.02%     
==========================================
  Files          37       37              
  Lines        3090     3102      +12     
==========================================
+ Hits         2851     2863      +12     
  Misses        150      150              
  Partials       89       89

Impacted Files	Coverage Δ
router.go	`96.58% <97.50%> (+0.07%)`	⬆️
middleware/logger.go	`87.71% <0.00%> (+0.44%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0644cd6...627588a. Read the comment docs.

aldas · 2022-07-07T20:08:53Z

router.go

 	} else {
 		// use previous match as basis. although we have no matching handler we have path match.
 		// so we can send http.StatusMethodNotAllowed (405) instead of http.StatusNotFound (404)
 		currentNode = previousBestMatchNode

+		ctx.path = path


See comment below. This is incorrect as path must be path of the route not path of the request.

router.go

Signed-off-by: ortyomka <iurin.art@gmail.com>

ortyomka · 2022-07-08T07:22:07Z

@aldas
I corrected comments, but a question remains. Do we need to have parameters when we have 405?

I removed them now, but if we need them, what names should they have?

ortyomka · 2022-07-11T07:38:48Z

I would like to finish this PR by Tuesday(12.07) inclusive.

If your schedule allows it, I'm willing to fix comments ASAP.

CC @aldas

aldas

LGTM

I think this PR is good enough for current state. Params for 405 etc are things we/I can address later when there is a decision what the behavior should be. These questions are not necessary to be solved with this change.

Thank you for PR.

ortyomka mentioned this pull request Jun 29, 2022

Allow different params' names in different methods #2208

Closed

Change methodHandler element type to methodContext

3e45d2a

Signed-off-by: ortyomka <iurin.art@gmail.com>

ortyomka force-pushed the fix/new-method-struct branch from ec17a4a to 3e45d2a Compare June 29, 2022 11:46

aldas reviewed Jun 29, 2022

View reviewed changes

Allow different param names in the smae path with different methods

d9b49f8

Signed-off-by: ortyomka <iurin.art@gmail.com>

ortyomka changed the title ~~New Tree Methods structure~~ Allow different param names in different methods with same path scheme Jun 29, 2022

ortyomka requested a review from aldas June 29, 2022 12:52

aldas requested changes Jul 6, 2022

View reviewed changes

Rename methodContext to routeMethod

5ec1f7e

Add paramsCount in each node for perfomance Signed-off-by: ortyomka <iurin.art@gmail.com>

ortyomka requested a review from aldas July 6, 2022 08:44

aldas requested changes Jul 7, 2022

View reviewed changes

ortyomka added 2 commits July 8, 2022 10:11

Add backtracking to nearest path

83a5acc

Signed-off-by: ortyomka <iurin.art@gmail.com>

Remove params from NotAllowed

627588a

Signed-off-by: ortyomka <iurin.art@gmail.com>

ortyomka requested a review from aldas July 8, 2022 07:22

aldas approved these changes Jul 11, 2022

View reviewed changes

aldas merged commit 9bf1e3c into labstack:master Jul 11, 2022

aldas mentioned this pull request Jul 11, 2022

Path parameter bug when registering different methods on similar route structures #2201

Closed

3 tasks

aldas mentioned this pull request Jul 30, 2022

Document path paramater behaviour for same path across different methods labstack/echox#254

Merged

aldas mentioned this pull request Nov 21, 2022

URL Path Parameter get bugged #1461

Closed

aldas mentioned this pull request Dec 14, 2022

Unable to get param value with the paths specified #2364

Closed

mahendrabishnoi2 mentioned this pull request Dec 16, 2022

Fix: Error Invalid IDs when adding a relation knadh/dictpress#25

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow different param names in different methods with same path scheme #2209

Allow different param names in different methods with same path scheme #2209

ortyomka commented Jun 29, 2022 •

edited

ortyomka commented Jun 29, 2022

ortyomka commented Jun 29, 2022

ortyomka commented Jun 29, 2022

aldas left a comment

ortyomka commented Jun 29, 2022

ortyomka commented Jun 29, 2022

ortyomka commented Jul 5, 2022

aldas Jul 5, 2022

ortyomka Jul 6, 2022

ortyomka commented Jul 6, 2022

codecov bot commented Jul 6, 2022 •

edited

aldas Jul 7, 2022

ortyomka Jul 8, 2022

ortyomka commented Jul 8, 2022

ortyomka commented Jul 11, 2022

aldas left a comment

Allow different param names in different methods with same path scheme #2209

Allow different param names in different methods with same path scheme #2209

Conversation

ortyomka commented Jun 29, 2022 • edited

ortyomka commented Jun 29, 2022

ortyomka commented Jun 29, 2022

ortyomka commented Jun 29, 2022

aldas left a comment

Choose a reason for hiding this comment

ortyomka commented Jun 29, 2022

ortyomka commented Jun 29, 2022

ortyomka commented Jul 5, 2022

aldas Jul 5, 2022

Choose a reason for hiding this comment

ortyomka Jul 6, 2022

Choose a reason for hiding this comment

ortyomka commented Jul 6, 2022

codecov bot commented Jul 6, 2022 • edited

Codecov Report

aldas Jul 7, 2022

Choose a reason for hiding this comment

ortyomka Jul 8, 2022

Choose a reason for hiding this comment

ortyomka commented Jul 8, 2022

ortyomka commented Jul 11, 2022

aldas left a comment

Choose a reason for hiding this comment

ortyomka commented Jun 29, 2022 •

edited

codecov bot commented Jul 6, 2022 •

edited