Interceptor¶

Interceptors provide hook functions which run before or after a request.

Interceptors can be assigned to

All URLs

An URL path (which means a group of URLs)

One URL

One URL on HTTP methods

The more precise it is, the higher priority it has.

If interceptor A is assigned to URL ‘/abc’ on HTTP method “GET”, and interceptor B is assigned to all URLs, then A is executed when “GET /abc”, and B is executed when “POST /abc”.

Now, let’s create an interceptor for URL “/hello” to log some info before and after a request.

Edit “yourservice/interceptor/log.go”:

package interceptor

import (
       "github.com/vaporz/turbo"
       "fmt"
       "net/http"
)

type LogInterceptor struct {
       // optional, BaseInterceptor allows you to create an interceptor which implements
       // Before() or After() only, or none of them.
       // If you were to implement both, you can remove this line.
       turbo.BaseInterceptor
}

func (l *LogInterceptor) Before(resp http.ResponseWriter, req *http.Request) error {
       fmt.Println("[Before] Request URL:"+req.URL.Path)
       return nil
}

func (l *LogInterceptor) After(resp http.ResponseWriter, req *http.Request) error {
       fmt.Println("[After] Request URL:"+req.URL.Path)
       return nil
}

Then assign this interceptor to URL “/hello”.

Edit “yourservice/grpcapi/component/components.go”:

package component

import (
       "github.com/vaporz/turbo-example/yourservice/gen/proto"
       "google.golang.org/grpc"
+      i "github.com/vaporz/turbo-example/yourservice/interceptor"
)

func (i *ServiceInitializer) InitService(s turbo.Servable) error {
+       s.RegisterComponent("LogInterceptor", &interceptor.LogInterceptor{})
}

Edit “yourservice/service.yaml”:

+interceptor:
+  - GET /hello LogInterceptor

Lastly, restart HTTP server and test:

$ curl -w "\n" -X GET "http://localhost:8081/hello?your_name=Alice"
{"message":"[grpc server]Hello, Alice"}

Check the server’s console:

$ go run yourservice/yourserviceapi.go
[Before] Request URL:/hello
[After] Request URL:/hello

We usually do something like validations in an interceptor, when the validation fails, the request halts, and returns an error message.

To do this, you can simply return an error:

func (l *LogInterceptor) Before(resp http.ResponseWriter, req *http.Request) error {
       fmt.Println("[Before] Request URL:"+req.URL.Path)
+      resp.Write([]byte("Encounter an error from LogInterceptor!\n"))
-      return nil
+      return errors.New("error!")
}

Test:

$ curl -w "\n" "http://localhost:8081/hello"
Encounter an error from LogInterceptor!