Merge pull request #255 from mstrYoda/main

add newrelic middleware, unit tests

Author: ReneWerner87

.github/dependabot.yml

@@ -44,3 +44,9 @@ updates:
             - "🤖 Dependencies"
         schedule:
             interval: "daily"
+    -   package-ecosystem: "gomod"
+        directory: "/fibernewrelic/" # Location of package manifests
+        labels:
+            - "🤖 Dependencies"
+        schedule:
+            interval: "daily"

.github/workflows/security.yml

@@ -35,3 +35,7 @@ jobs:
                 working-directory: ./casbin
                 run: "`go env GOPATH`/bin/gosec -exclude-dir=internal ./..."
                 # -----
+            -   name: Run Gosec (fibernewrelic)
+                working-directory: ./fibernewrelic
+                run: "`go env GOPATH`/bin/gosec -exclude-dir=internal ./..."
+                # -----

.github/workflows/test.yml

@@ -50,3 +50,5 @@ jobs:
                 run: cd ./swagger && go test ./... -v -race
             -   name: Test casbin Middleware
                 run: cd ./casbin && go test ./... -v -race
+            -   name: Test fibernewrelic Middleware
+                run: cd ./fibernewrelic && go test ./... -v -race

README.md

@@ -28,3 +28,6 @@ Repository for third party middlewares with dependencies
 * [Casbin](/casbin) <a href="https://github.com/gofiber/contrib/actions?query=workflow%3A%22Tests%22">
     <img src="https://img.shields.io/github/workflow/status/gofiber/contrib/Tests?label=%F0%9F%A7%AA%20&style=flat&color=75C46B">
     </a>
+* [NewRelic](/fibernewrelic) <a href="https://github.com/gofiber/contrib/actions?query=workflow%3A%22Tests%22">
+    <img src="https://img.shields.io/github/workflow/status/gofiber/contrib/Tests?label=%F0%9F%A7%AA%20&style=flat&color=75C46B">
+    </a>

fibernewrelic/README.md

@@ -0,0 +1,60 @@
+### NewRelic
+![Release](https://img.shields.io/github/release/gofiber/contrib.svg)
+[![Discord](https://img.shields.io/discord/704680098577514527?style=flat&label=%F0%9F%92%AC%20discord&color=00ACD7)](https://gofiber.io/discord)
+![Test](https://github.com/gofiber/contrib/workflows/Tests/badge.svg)
+![Security](https://github.com/gofiber/contrib/workflows/Security/badge.svg)
+![Linter](https://github.com/gofiber/contrib/workflows/Linter/badge.svg)
+
+[NewRelic](https://github.com/newrelic/go-agent) support for Fiber.
+
+### Install
+
+```
+go get -u github.com/gofiber/fiber/v2
+go get -u github.com/gofiber/contrib/fibernewrelic
+```
+
+### Signature
+
+```go
+fibernewrelic.New(config fibernewrelic.Config) fiber.Handler
+```
+
+### Config
+
+| Property       | Type     | Description                      | Default     |
+|:---------------|:---------|:---------------------------------|:------------|
+| License        | `string` | Required - New Relic License Key | `""`        |
+| AppName        | `string` | New Relic Application Name       | `fiber-api` |
+| Enabled        | `bool`   | Enable/Disable New Relic         | `false`     |
+| TransportType  | `string` | Can be HTTP or HTTPS             | `"HTTP"`    |
+
+### Usage
+
+```go
+package main
+
+import (
+	"github.com/gofiber/fiber/v2"
+	"github.com/gofiber/contrib/fibernewrelic"
+)
+
+func main() {
+	app := fiber.New()
+
+	app.Get("/", func(ctx *fiber.Ctx) error {
+		return ctx.SendStatus(200)
+	})
+
+	cfg := fibernewrelic.Config{
+		License:       "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
+		AppName:       "MyCustomApi",
+		Enabled:       true,
+		TransportType: "HTTP",
+	}
+
+	app.Use(fibernewrelic.New(cfg))
+
+	app.Listen(":8080")
+}
+```

fibernewrelic/fiber.go

@@ -0,0 +1,75 @@
+package fibernewrelic
+
+import (
+	"fmt"
+	"github.com/gofiber/fiber/v2"
+	"github.com/newrelic/go-agent/v3/newrelic"
+	"net/url"
+)
+
+type Config struct {
+	// License parameter is required to initialize newrelic application
+	License string
+	// AppName parameter is required to initialize newrelic application, default is fiber-api
+	AppName string
+	// Enabled parameter passed to enable/disable newrelic
+	Enabled bool
+	// TransportType can be HTTP or HTTPS (case-sensitive), default is HTTP
+	TransportType string
+}
+
+var ConfigDefault = Config{
+	License:       "",
+	AppName:       "fiber-api",
+	Enabled:       false,
+	TransportType: string(newrelic.TransportHTTP),
+}
+
+func New(cfg Config) fiber.Handler {
+	if cfg.TransportType != "HTTP" && cfg.TransportType != "HTTPS" {
+		cfg.TransportType = ConfigDefault.TransportType
+	}
+
+	if cfg.AppName == "" {
+		cfg.AppName = ConfigDefault.AppName
+	}
+
+	if cfg.License == "" {
+		panic(fmt.Errorf("unable to create New Relic Application -> License can not be empty"))
+	}
+
+	app, err := newrelic.NewApplication(
+		newrelic.ConfigAppName(cfg.AppName),
+		newrelic.ConfigLicense(cfg.License),
+		newrelic.ConfigEnabled(cfg.Enabled),
+	)
+
+	if err != nil {
+		panic(fmt.Errorf("unable to create New Relic Application -> %w", err))
+	}
+
+	return func(c *fiber.Ctx) error {
+		txn := app.StartTransaction(c.Method() + " " + c.Path())
+		originalURL, err := url.Parse(c.OriginalURL())
+		if err != nil {
+			return c.Next()
+		}
+
+		txn.SetWebRequest(newrelic.WebRequest{
+			URL:       originalURL,
+			Method:    c.Method(),
+			Transport: newrelic.TransportType(cfg.TransportType),
+			Host:      c.Hostname(),
+		})
+
+		err = c.Next()
+		if err != nil {
+			txn.NoticeError(err)
+		}
+
+		defer txn.SetWebResponse(nil).WriteHeader(c.Response().StatusCode())
+		defer txn.End()
+
+		return err
+	}
+}

fibernewrelic/fiber_test.go

@@ -0,0 +1,57 @@
+package fibernewrelic
+
+import (
+	"github.com/gofiber/fiber/v2"
+	"github.com/stretchr/testify/assert"
+	"net/http/httptest"
+	"testing"
+)
+
+func TestNewrelicAppConfig(t *testing.T) {
+	t.Run("Panic occurs when License empty",
+		func(t *testing.T) {
+			assert.Panics(t, func() {
+				New(Config{
+					License:       "",
+					AppName:       "",
+					Enabled:       false,
+					TransportType: "",
+				})
+			})
+		})
+
+	t.Run("Run without panic when License not empty",
+		func(t *testing.T) {
+			assert.NotPanics(t, func() {
+				New(Config{
+					License:       "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
+					AppName:       "",
+					Enabled:       false,
+					TransportType: "",
+				})
+			})
+		})
+
+	t.Run("Run successfully as middleware",
+		func(t *testing.T) {
+			app := fiber.New()
+
+			app.Get("/", func(ctx *fiber.Ctx) error {
+				return ctx.SendStatus(200)
+			})
+
+			cfg := Config{
+				License:       "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
+				AppName:       "",
+				Enabled:       true,
+				TransportType: "",
+			}
+
+			app.Use(New(cfg))
+
+			r := httptest.NewRequest("GET", "/", nil)
+			resp, _ := app.Test(r, -1)
+
+			assert.Equal(t, 200, resp.StatusCode)
+		})
+}

fibernewrelic/go.mod

@@ -0,0 +1,27 @@
+module github.com/gofiber/contrib/fibernewrelic
+
+go 1.18
+
+require (
+	github.com/gofiber/fiber/v2 v2.35.0
+	github.com/newrelic/go-agent/v3 v3.17.0
+	github.com/stretchr/testify v1.5.1
+)
+
+require (
+	github.com/andybalholm/brotli v1.0.4 // indirect
+	github.com/davecgh/go-spew v1.1.0 // indirect
+	github.com/golang/protobuf v1.4.3 // indirect
+	github.com/klauspost/compress v1.15.9 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/valyala/bytebufferpool v1.0.0 // indirect
+	github.com/valyala/fasthttp v1.38.0 // indirect
+	github.com/valyala/tcplisten v1.0.0 // indirect
+	golang.org/x/net v0.0.0-20220225172249-27dd8689420f // indirect
+	golang.org/x/sys v0.0.0-20220727055044-e65921a090b8 // indirect
+	golang.org/x/text v0.3.7 // indirect
+	google.golang.org/genproto v0.0.0-20200526211855-cb27e3aa2013 // indirect
+	google.golang.org/grpc v1.39.0 // indirect
+	google.golang.org/protobuf v1.25.0 // indirect
+	gopkg.in/yaml.v2 v2.2.3 // indirect
+)