✨ new feat: selector middleware #511

aimuz · 2022-09-02T02:58:41Z

It allows to set check rules to whitelist or blacklist middleware such as Auth
Requests that match the rules will go to the next level of middleware

johanbrandhorst

This looks cool, but I think it's missing some things:

Where are the tests? We should include some tests of this new functionality.
Could you include an selector_example_test.go file with an example of how to use this? It will automatically be shown as part of the documentation. See https://go.dev/blog/examples.

aimuz · 2022-09-03T10:58:55Z

Yes, that's how it should be. I'll take care of it.

codecov-commenter · 2022-09-03T17:47:09Z

Codecov Report

Base: 84.01% // Head: 58.74% // Decreases project coverage by -25.26% ⚠️

Coverage data is based on head (eda6e54) compared to base (6e2c2ac).
Patch coverage: 50.91% of modified lines in pull request are covered.

❗ Current head eda6e54 differs from pull request most recent head f7fa9eb. Consider uploading reports for the commit f7fa9eb to get more accurate results

Additional details and impacted files

@@             Coverage Diff             @@
##               v2     #511       +/-   ##
===========================================
- Coverage   84.01%   58.74%   -25.27%     
===========================================
  Files          30       31        +1     
  Lines         932     1583      +651     
===========================================
+ Hits          783      930      +147     
- Misses        110      590      +480     
- Partials       39       63       +24

Impacted Files	Coverage Δ
chain.go	`0.00% <ø> (-90.91%)`	⬇️
interceptors/auth/auth.go	`100.00% <ø> (ø)`
interceptors/ratelimit/ratelimit.go	`60.00% <0.00%> (-40.00%)`	⬇️
interceptors/recovery/options.go	`78.57% <ø> (ø)`
metadata/single_key.go	`60.00% <ø> (ø)`
testing/testpb/interceptor_suite.go	`0.00% <0.00%> (ø)`
testing/testpb/test.manual_validator.pb.go	`0.00% <0.00%> (ø)`
util/backoffutils/backoff.go	`60.00% <ø> (ø)`
wrappers.go	`66.66% <ø> (-33.34%)`	⬇️
interceptors/reporter.go	`45.45% <20.00%> (-17.05%)`	⬇️
... and 28 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

johanbrandhorst

Thanks for the tests, just a few suggestions

johanbrandhorst · 2022-09-03T17:46:24Z

interceptors/selector/doc.go

+`selector` a generic server-side selector middleware for gRPC.
+
+# Server Side Selector Middleware
+It allows to set check rules to whitelist or blacklist middleware such as Auth


Thanks for the updates, do you mind changing these phrases to allowlist and blocklist consistently through this PR?

Suggested change

It allows to set check rules to whitelist or blacklist middleware such as Auth

It allows to set check rules to allowlist or blocklist middleware such as Auth

johanbrandhorst · 2022-09-03T17:49:29Z

interceptors/selector/selector.go

+
+type Option func(o *options)
+
+// WithMatch ...


I think this comment needs improving

Suggested change

// WithMatch ...

// WithMatch configures what condition should trigger the selector to run the interceptor.

// If used multiple times, the last one specified will be used.

johanbrandhorst · 2022-09-03T17:49:56Z

interceptors/selector/selector.go

+	return optCopy
+}
+
+// AlwaysMatch is the default implementation, always selected


Suggested change

// AlwaysMatch is the default implementation, always selected

// AlwaysMatch can be used to always run the interceptor. This is the default behavior.

johanbrandhorst · 2022-09-03T17:51:13Z

interceptors/selector/selector.go

+	return true
+}
+
+// UnaryServerInterceptor returns a new unary server interceptors that performs per-request selector.


Suggested change

// UnaryServerInterceptor returns a new unary server interceptors that performs per-request selector.

// UnaryServerInterceptor returns a new unary server interceptor that will decide whether to call the interceptor on the behavior of the MatchFunc.

johanbrandhorst · 2022-09-03T17:52:12Z

interceptors/selector/selector.go

+}
+
+// UnaryServerInterceptor returns a new unary server interceptors that performs per-request selector.
+func UnaryServerInterceptor(interceptors grpc.UnaryServerInterceptor, opts ...Option) grpc.UnaryServerInterceptor {


I'm leaning towards removing MatchFunc as an option and making it a required parameter. This solves two problems:

If you accidentally use the selector without a match func, you gain no utility from it.

If you accidentally specify two match func options, you might be confused about which to use.

That simplifies things generally, no need for the AlwaysMatch function, etc.

Yes, I readjusted it, can you help me in seeing what is wrong?

johanbrandhorst · 2022-09-03T17:53:27Z

interceptors/selector/doc.go

+
+# Server Side Selector Middleware
+It allows to set check rules to whitelist or blacklist middleware such as Auth
+Requests that match the rules will go to the next level of middleware


Suggested change

Requests that match the rules will go to the next level of middleware

interceptors to toggle behavior on or off based on the request path.

johanbrandhorst · 2022-09-03T17:56:02Z

interceptors/selector/selector_example_test.go

+}
+
+func loginSkip(ctx context.Context, fullMethod string) bool {
+	return fullMethod != "login"


Lets use a realistic looking path, like you are doing in the tests

Suggested change

return fullMethod != "login"

return fullMethod != "/auth.v1.AuthService/Login"

johanbrandhorst · 2022-09-05T04:48:34Z

interceptors/selector/selector.go

+// Allow After the method is matched, the interceptor is run
+func Allow(methods []string) MatchFunc {
+	return func(ctx context.Context, fullMethod string) bool {
+		for _, s := range methods {
+			if s == fullMethod {
+				return true
+			}
+		}
+		return false
+	}
+}
+
+// Block the interceptor will not run after the method matches
+func Block(methods []string) MatchFunc {
+	allow := Allow(methods)
+	return func(ctx context.Context, fullMethod string) bool {
+		return !allow(ctx, fullMethod)
+	}
+}


I don't think we need these, to be honest. Users can easily implement these themselves.

johanbrandhorst · 2022-09-05T04:50:13Z

interceptors/selector/selector_test.go

+	"testing"
+)
+
+var whiteList = []string{"/auth.v1beta1.AuthService/Login"}


Suggested change

var whiteList = []string{"/auth.v1beta1.AuthService/Login"}

var allowList = []string{"/auth.v1beta1.AuthService/Login"}

I have adjusted

johanbrandhorst · 2022-09-05T18:48:56Z

testing/testpb/test.pb.go

@@ -1,18 +1,16 @@
 // Code generated by protoc-gen-go. DO NOT EDIT.
 // versions:
-// 	protoc-gen-go v1.25.0
+// 	protoc-gen-go v1.28.0


Can you revert these changes, I don't think these should need to be changed?

johanbrandhorst · 2022-09-07T00:08:54Z

Looks like there is a formatting issue, can you run make lint?

Signed-off-by: aimuz <mr.imuz@gmail.com>

aimuz · 2022-09-07T05:35:44Z

done

johanbrandhorst · 2022-09-07T14:15:15Z

Thank you for your contribution!

aimuz force-pushed the v2-selector branch from c564ff3 to 923dae4 Compare September 2, 2022 02:59

johanbrandhorst requested changes Sep 3, 2022

View reviewed changes

aimuz requested a review from johanbrandhorst September 3, 2022 12:31

johanbrandhorst requested changes Sep 3, 2022

View reviewed changes

aimuz force-pushed the v2-selector branch 2 times, most recently from e3b9f5e to d3ce045 Compare September 4, 2022 07:10

aimuz requested a review from johanbrandhorst September 4, 2022 07:11

aimuz force-pushed the v2-selector branch from d3ce045 to 1247fb6 Compare September 4, 2022 07:32

johanbrandhorst requested changes Sep 5, 2022

View reviewed changes

aimuz force-pushed the v2-selector branch from 1247fb6 to acbec6b Compare September 5, 2022 08:34

aimuz requested a review from johanbrandhorst September 5, 2022 08:34

johanbrandhorst requested changes Sep 5, 2022

View reviewed changes

aimuz force-pushed the v2-selector branch from acbec6b to eda6e54 Compare September 6, 2022 01:41

aimuz requested a review from johanbrandhorst September 6, 2022 01:41

johanbrandhorst approved these changes Sep 6, 2022

View reviewed changes

aimuz force-pushed the v2-selector branch 2 times, most recently from 9add81a to 948425e Compare September 7, 2022 05:07

✨ new feat: selector middleware

f7fa9eb

Signed-off-by: aimuz <mr.imuz@gmail.com>

aimuz force-pushed the v2-selector branch from 948425e to f7fa9eb Compare September 7, 2022 05:33

johanbrandhorst merged commit 001ba37 into grpc-ecosystem:v2 Sep 7, 2022

aimuz deleted the v2-selector branch September 7, 2022 14:22

aimuz mentioned this pull request Mar 8, 2023

docs: add logging.InjectFields usage description #540

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ new feat: selector middleware #511

✨ new feat: selector middleware #511

aimuz commented Sep 2, 2022

johanbrandhorst left a comment

aimuz commented Sep 3, 2022

codecov-commenter commented Sep 3, 2022 •

edited

johanbrandhorst left a comment

johanbrandhorst Sep 3, 2022

johanbrandhorst Sep 3, 2022

johanbrandhorst Sep 3, 2022

johanbrandhorst Sep 3, 2022

johanbrandhorst Sep 3, 2022

aimuz Sep 4, 2022

johanbrandhorst Sep 3, 2022

johanbrandhorst Sep 3, 2022

johanbrandhorst Sep 5, 2022

johanbrandhorst Sep 5, 2022

aimuz Sep 5, 2022

johanbrandhorst Sep 5, 2022

johanbrandhorst commented Sep 7, 2022

aimuz commented Sep 7, 2022

johanbrandhorst commented Sep 7, 2022

	It allows to set check rules to whitelist or blacklist middleware such as Auth
	It allows to set check rules to allowlist or blocklist middleware such as Auth

	// WithMatch ...
	// WithMatch configures what condition should trigger the selector to run the interceptor.
	// If used multiple times, the last one specified will be used.

	// AlwaysMatch is the default implementation, always selected
	// AlwaysMatch can be used to always run the interceptor. This is the default behavior.

	// UnaryServerInterceptor returns a new unary server interceptors that performs per-request selector.
	// UnaryServerInterceptor returns a new unary server interceptor that will decide whether to call the interceptor on the behavior of the MatchFunc.

	Requests that match the rules will go to the next level of middleware
	interceptors to toggle behavior on or off based on the request path.

	return fullMethod != "login"
	return fullMethod != "/auth.v1.AuthService/Login"

	var whiteList = []string{"/auth.v1beta1.AuthService/Login"}
	var allowList = []string{"/auth.v1beta1.AuthService/Login"}

✨ new feat: selector middleware #511

✨ new feat: selector middleware #511

Conversation

aimuz commented Sep 2, 2022

johanbrandhorst left a comment

Choose a reason for hiding this comment

aimuz commented Sep 3, 2022

codecov-commenter commented Sep 3, 2022 • edited

Codecov Report

johanbrandhorst left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

johanbrandhorst commented Sep 7, 2022

aimuz commented Sep 7, 2022

johanbrandhorst commented Sep 7, 2022

codecov-commenter commented Sep 3, 2022 •

edited