Merge pull request #98 from slok/pr/97

Author: slok

.github/workflows/ci.yml

@@ -19,7 +19,7 @@ jobs:
       - uses: actions/checkout@v2.4.0
       - uses: actions/setup-go@v2.1.4
         with:
-          go-version: 1.16
+          go-version: 1.17
       - run: make test
 
   integration-test:
@@ -30,5 +30,5 @@ jobs:
       - uses: actions/checkout@v2.4.0
       - uses: actions/setup-go@v2.1.4
         with:
-          go-version: 1.16
+          go-version: 1.17
       - run: make integration-test

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## [Unreleased]
 
+### Added
+
+- Support Iris library.
+
 ## [0.10.0] - 2021-11-16
 
 ### Added

examples/iris/main.go

@@ -0,0 +1,73 @@
+package main
+
+import (
+	"log"
+	"net/http"
+	"os"
+	"os/signal"
+	"syscall"
+
+	"github.com/kataras/iris/v12"
+	"github.com/prometheus/client_golang/prometheus/promhttp"
+	metrics "github.com/slok/go-http-metrics/metrics/prometheus"
+	"github.com/slok/go-http-metrics/middleware"
+	irismiddleware "github.com/slok/go-http-metrics/middleware/iris"
+)
+
+const (
+	srvAddr     = ":8080"
+	metricsAddr = ":8081"
+)
+
+func main() {
+	// Create our middleware.
+	mdlw := middleware.New(middleware.Config{
+		Recorder: metrics.NewRecorder(metrics.Config{}),
+	})
+
+	// Create Iris engine and global middleware.
+	app := iris.New()
+	app.Use(irismiddleware.Handler("", mdlw))
+
+	// Add our handler.
+	app.Get("/", func(ctx iris.Context) {
+		ctx.StatusCode(iris.StatusAccepted)
+		_, _ = ctx.WriteString("Hello world!")
+	})
+
+	app.Get("/json", func(ctx iris.Context) {
+		ctx.JSON(map[string]string{"hello": "world"}) // nolint: errcheck
+	})
+
+	app.Get("/wrong", func(ctx iris.Context) {
+		ctx.StatusCode(iris.StatusTooManyRequests)
+		_, _ = ctx.WriteString("oops")
+
+	})
+
+	err := app.Build()
+	if err != nil {
+		panic(err)
+	}
+
+	// Serve our handler.
+	go func() {
+		log.Printf("server listening at %s", srvAddr)
+		if err := http.ListenAndServe(srvAddr, app); err != nil {
+			log.Panicf("error while serving: %s", err)
+		}
+	}()
+
+	// Serve our metrics.
+	go func() {
+		log.Printf("metrics listening at %s", metricsAddr)
+		if err := http.ListenAndServe(metricsAddr, promhttp.Handler()); err != nil {
+			log.Panicf("error while serving metrics: %s", err)
+		}
+	}()
+
+	// Wait until some signal is captured.
+	sigC := make(chan os.Signal, 1)
+	signal.Notify(sigC, syscall.SIGTERM, syscall.SIGINT)
+	<-sigC
+}

go.mod

@@ -8,8 +8,8 @@ require (
 	github.com/go-chi/chi v4.1.2+incompatible
 	github.com/gorilla/mux v1.8.0
 	github.com/julienschmidt/httprouter v1.3.0
-	github.com/kataras/iris/v12 v12.2.0-alpha5
 	github.com/justinas/alice v1.2.0
+	github.com/kataras/iris/v12 v12.2.0-alpha5
 	github.com/labstack/echo/v4 v4.6.1
 	github.com/prometheus/client_golang v1.11.0
 	github.com/stretchr/testify v1.7.0

go.sum

@@ -25,7 +25,7 @@ func Example_irisMiddleware() {
 
 	// Add our handler and middleware
 	h := func(ctx iris.Context) {
-		ctx.WriteString("Hello world")
+		ctx.WriteString("Hello world") // nolint: errcheck
 	}
 	app.Get("/", irismiddleware.Handler("", mdlw), h)
 

middleware/iris/example_test.go

@@ -9,7 +9,7 @@ import (
 	"github.com/slok/go-http-metrics/middleware"
 )
 
-// Handler returns a Gin measuring middleware.
+// Handler returns a Iris measuring middleware.
 func Handler(handlerID string, m middleware.Middleware) iris.Handler {
 	return func(ctx iris.Context) {
 		r := &reporter{ctx: ctx}

middleware/iris/iris.go

@@ -51,7 +51,7 @@ func TestMiddleware(t *testing.T) {
 			handler: func() iris.Handler {
 				return func(ctx iris.Context) {
 					ctx.StatusCode(iris.StatusAccepted)
-					ctx.WriteString("test1")
+					_, _ = ctx.WriteString("test1")
 				}
 			},
 			expRespCode: 202,
@@ -82,7 +82,7 @@ func TestMiddleware(t *testing.T) {
 			handler: func() iris.Handler {
 				return func(ctx iris.Context) {
 					ctx.StatusCode(iris.StatusAccepted)
-					ctx.JSON(map[string]string{"test": "one"})
+					ctx.JSON(map[string]string{"test": "one"}) // nolint: errcheck
 				}
 			},
 			expRespCode: 202,
@@ -109,9 +109,8 @@ func TestMiddleware(t *testing.T) {
 
 			// Make the request.
 			resp := httptest.NewRecorder()
-			if err := app.Build(); err != nil {
-				t.Fatal(err)
-			}
+			err := app.Build()
+			require.NoError(err)
 			app.ServeHTTP(resp, req)
 
 			// Check.

middleware/iris/iris_test.go

@@ -15,6 +15,7 @@ import (
 	"github.com/gorilla/mux"
 	"github.com/julienschmidt/httprouter"
 	"github.com/justinas/alice"
+	"github.com/kataras/iris/v12"
 	"github.com/labstack/echo/v4"
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/prometheus/client_golang/prometheus/promhttp"
@@ -33,6 +34,7 @@ import (
 	gojimiddleware "github.com/slok/go-http-metrics/middleware/goji"
 	gorestfulmiddleware "github.com/slok/go-http-metrics/middleware/gorestful"
 	httproutermiddleware "github.com/slok/go-http-metrics/middleware/httprouter"
+	irismiddleware "github.com/slok/go-http-metrics/middleware/iris"
 	negronimiddleware "github.com/slok/go-http-metrics/middleware/negroni"
 	stdmiddleware "github.com/slok/go-http-metrics/middleware/std"
 )
@@ -82,6 +84,7 @@ func TestMiddlewarePrometheus(t *testing.T) {
 		"Alice":            {server: prepareHandlerAlice},
 		"Gorilla":          {server: prepareHandlerGorilla},
 		"Fasthttp":         {server: prepareHandlerFastHTTP},
+		"Iris":             {server: prepareHandlerIris},
 	}
 
 	for name, test := range tests {
@@ -382,3 +385,23 @@ func prepareHandlerFastHTTP(m middleware.Middleware, hc []handlerConfig) server
 
 	return netListenerServer{ln: ln}
 }
+
+func prepareHandlerIris(m middleware.Middleware, hc []handlerConfig) server {
+	// Setup server and middleware.
+	app := iris.New()
+	app.Use(irismiddleware.Handler("", m))
+
+	// Set handlers.
+	for _, h := range hc {
+		h := h
+		app.Handle(h.Method, h.Path, iris.Handler(func(ctx iris.Context) {
+			time.Sleep(h.SleepDuration)
+			ctx.StatusCode(h.Code)
+			ctx.WriteString(h.ReturnData) // nolint: errcheck
+		}))
+	}
+
+	app.Build() // nolint: errcheck
+
+	return testServer{server: httptest.NewServer(app)}
+}