Init

Author: Alex-Bond

.gitignore

@@ -0,0 +1,2 @@
+.idea/*
+go.sum

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 SpiralScout
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,84 @@
+# RoadRunner Sentry integration
+
+Sentry events handler for RoadRunner.
+
+## Installation
+
+### QuickBuild
+
+Add to `.build.json` package `github.com/UPDG/roadrunner-sentry` and register it as `rr.Container.Register(sentry.ID, &sentry.Service{})`
+
+After it build RR using QuickBuild.
+
+Example of final file:
+```json
+{
+  "packages": [
+    "github.com/spiral/roadrunner/service/env",
+    "github.com/spiral/roadrunner/service/http",
+    "github.com/spiral/roadrunner/service/rpc",
+    "github.com/spiral/roadrunner/service/static",
+    "github.com/UPDG/roadrunner-sentry"
+  ],
+  "commands": [
+    "github.com/spiral/roadrunner/cmd/rr/http"
+  ],
+  "register": [
+    "rr.Container.Register(env.ID, &env.Service{})",
+    "rr.Container.Register(rpc.ID, &rpc.Service{})",
+    "rr.Container.Register(http.ID, &http.Service{})",
+    "rr.Container.Register(static.ID, &static.Service{})",
+    "rr.Container.Register(sentry.ID, &sentry.Service{})"
+  ]
+}
+```
+
+### Manual
+
+1. Add dependency by running `go get github.com/UPDG/roadrunner-sentry`
+
+2. Add to `cms/rr/main.go` import `github.com/UPDG/roadrunner-sentry`
+
+3. Add to `cms/rr/main.go` line `rr.Container.Register(sentry.ID, &sentry.Service{})` after `rr.Container.Register(http.ID, &http.Service{})`
+
+Final file should look like this:
+```go
+package main
+
+import (
+	"github.com/sirupsen/logrus"
+	rr "github.com/spiral/roadrunner/cmd/rr/cmd"
+
+	// services (plugins)
+	"github.com/spiral/roadrunner/service/env"
+	"github.com/spiral/roadrunner/service/http"
+	"github.com/spiral/roadrunner/service/rpc"
+	"github.com/spiral/roadrunner/service/static"
+	"github.com/UPDG/roadrunner-sentry"
+
+	// additional commands and debug handlers
+	_ "github.com/spiral/roadrunner/cmd/rr/http"
+)
+
+func main() {
+	rr.Container.Register(env.ID, &env.Service{})
+	rr.Container.Register(rpc.ID, &rpc.Service{})
+	rr.Container.Register(http.ID, &http.Service{})
+	rr.Container.Register(static.ID, &static.Service{})
+	rr.Container.Register(sentry.ID, &sentry.Service{})
+
+	rr.Logger.Formatter = &logrus.TextFormatter{ForceColors: true}
+
+	// you can register additional commands using cmd.CLI
+	rr.Execute()
+}
+```
+
+## Configuration
+
+Add your RoadRunner config (`.rr.yaml` by default) this lines:
+
+```yaml
+sentry:
+  DSN: <your senry DSN>
+```

config.go

@@ -0,0 +1,27 @@
+package sentry
+
+import (
+	"fmt"
+	"github.com/asaskevich/govalidator"
+	"github.com/spiral/roadrunner/service"
+)
+
+type Config struct {
+	// Contains Sentry DSN.
+	DSN string
+}
+
+// Hydrate must populate Config values using given Config source. Must return error if Config is not valid.
+func (c *Config) Hydrate(cfg service.Config) error {
+	if err := cfg.Unmarshal(c); err != nil {
+		return err
+	}
+	return c.Valid()
+}
+
+func (c *Config) Valid() error {
+	if !govalidator.IsRequestURL(c.DSN) {
+		return fmt.Errorf("sentry DSN in not URL")
+	}
+	return nil
+}

config_test.go

@@ -0,0 +1,33 @@
+package sentry
+
+import (
+	"encoding/json"
+	"github.com/spiral/roadrunner/service"
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+type mockCfg struct{ cfg string }
+
+func (cfg *mockCfg) Get(name string) service.Config  { return nil }
+func (cfg *mockCfg) Unmarshal(out interface{}) error { return json.Unmarshal([]byte(cfg.cfg), out) }
+
+func Test_Config_Hydrate(t *testing.T) {
+	cfg := &mockCfg{`{"DSN": "https://u:[email protected]/sentry/1"}`}
+	c := &Config{}
+
+	assert.NoError(t, c.Hydrate(cfg))
+}
+
+func Test_Config_Hydrate_Error(t *testing.T) {
+	cfg := &mockCfg{`{"enable": true,"DSN": https://u:[email protected]/sentry/1"}`}
+	c := &Config{}
+
+	assert.Error(t, c.Hydrate(cfg))
+}
+
+func Test_Config_Valid(t *testing.T) {
+	assert.NoError(t, (&Config{DSN: "https://u:[email protected]/sentry/1"}).Valid())
+	assert.Error(t, (&Config{DSN: "//u:[email protected]/sentry/1"}).Valid())
+	assert.Error(t, (&Config{DSN: "[email protected]"}).Valid())
+}

go.mod

@@ -0,0 +1,11 @@
+module github.com/UPDG/roadrunner-sentry
+
+require (
+	github.com/asaskevich/govalidator v0.0.0-20180720115003-f9ffefc3facf
+	github.com/certifi/gocertifi v0.0.0-20190105021004-abcd57078448 // indirect
+	github.com/getsentry/raven-go v0.2.0
+	github.com/pkg/errors v0.8.1 // indirect
+	github.com/sirupsen/logrus v1.1.1
+	github.com/spiral/roadrunner v1.3.1
+	github.com/stretchr/testify v1.3.0
+)

service.go

@@ -0,0 +1,98 @@
+package sentry
+
+import (
+	"bytes"
+	"fmt"
+	"github.com/getsentry/raven-go"
+	"github.com/spiral/roadrunner"
+	rr "github.com/spiral/roadrunner/cmd/rr/cmd"
+	rrhttp "github.com/spiral/roadrunner/service/http"
+	"net/http"
+)
+
+const ID = "sentry"
+
+type Service struct {
+}
+
+func (s *Service) Init(cfg *Config) (bool, error) {
+	err := raven.SetDSN(cfg.DSN)
+	if err != nil {
+		return false, err
+	}
+	svc, _ := rr.Container.Get(rrhttp.ID)
+	if svc, ok := svc.(*rrhttp.Service); ok {
+		svc.AddListener(systemListener)
+		svc.AddListener(httpListener)
+	}
+	return true, nil
+}
+
+// listener listens to http events and generates nice looking output.
+func httpListener(event int, ctx interface{}) {
+	// http events
+	switch event {
+	case rrhttp.EventError:
+		e := ctx.(*rrhttp.ErrorEvent)
+
+		buf := new(bytes.Buffer)
+		buf.ReadFrom(e.Request.Body)
+		body := buf.String()
+
+		meta := map[string]string{
+			"event":       "EventError",
+			"code":        "500",
+			"method":      e.Request.Method,
+			"site":        e.Request.Host,
+			"uri":         uri(e.Request),
+			"requestBody": body,
+		}
+		raven.CaptureErrorAndWait(e.Error, meta)
+		return
+	}
+}
+
+func systemListener(event int, ctx interface{}) {
+	switch event {
+	case roadrunner.EventWorkerError:
+		e := ctx.(roadrunner.WorkerError)
+
+		meta := map[string]string{
+			"event": "EventWorkerError",
+		}
+		raven.CaptureErrorAndWait(e.Caused, meta)
+		return
+	case roadrunner.EventWorkerDead:
+		e := ctx.(roadrunner.WorkerError)
+
+		meta := map[string]string{
+			"event": "EventWorkerDead",
+		}
+		raven.CaptureErrorAndWait(e.Caused, meta)
+		return
+	case roadrunner.EventPoolError:
+		e := ctx.(roadrunner.WorkerError)
+
+		meta := map[string]string{
+			"event": "EventPoolError",
+		}
+		raven.CaptureErrorAndWait(e.Caused, meta)
+		return
+	case roadrunner.EventWorkerKill:
+		e := ctx.(roadrunner.WorkerError)
+
+		meta := map[string]string{
+			"event": "EventWorkerKill",
+		}
+		raven.CaptureErrorAndWait(e.Caused, meta)
+		return
+	}
+}
+
+func uri(r *http.Request) string {
+	if r.TLS != nil {
+		return fmt.Sprintf("https://%s%s", r.Host, r.URL.String())
+	}
+
+	return fmt.Sprintf("http://%s%s", r.Host, r.URL.String())
+}

service_test.go

@@ -0,0 +1,82 @@
+package sentry
+
+import (
+	"crypto/tls"
+	"encoding/json"
+	"github.com/sirupsen/logrus"
+	"github.com/sirupsen/logrus/hooks/test"
+	"github.com/spiral/roadrunner/service"
+	"github.com/stretchr/testify/assert"
+	"net/http"
+	"net/url"
+	"testing"
+)
+
+type testCfg struct {
+	sentryCgf string
+	target    string
+}
+
+func (cfg *testCfg) Get(name string) service.Config {
+	if name == ID {
+		return &testCfg{target: cfg.sentryCgf}
+	}
+
+	return nil
+}
+func (cfg *testCfg) Unmarshal(out interface{}) error {
+	return json.Unmarshal([]byte(cfg.target), out)
+}
+
+func Test_Service_Init_NoProject(t *testing.T) {
+	logger, _ := test.NewNullLogger()
+	logger.SetLevel(logrus.DebugLevel)
+
+	c := service.NewContainer(logger)
+	c.Register(ID, &Service{})
+
+	assert.Error(t, c.Init(&testCfg{sentryCgf: `{"DSN":"https://u:[email protected]/sentry/"}`}))
+}
+
+func Test_Service_Init_NoUser(t *testing.T) {
+	logger, _ := test.NewNullLogger()
+	logger.SetLevel(logrus.DebugLevel)
+
+	c := service.NewContainer(logger)
+	c.Register(ID, &Service{})
+
+	assert.Error(t, c.Init(&testCfg{sentryCgf: `{"DSN":"https://example.com/sentry"}`}))
+}
+
+func Test_Service_Init_AllGood(t *testing.T) {
+	logger, _ := test.NewNullLogger()
+	logger.SetLevel(logrus.DebugLevel)
+
+	c := service.NewContainer(logger)
+	c.Register(ID, &Service{})
+
+	assert.NoError(t, c.Init(&testCfg{sentryCgf: `{"DSN":"https://u:[email protected]/sentry/1"}`}))
+}
+
+func TestService_Uri(t *testing.T) {
+	testUrl, _ := url.Parse("/sentry/1")
+	assert.Equal(t, "https://example.com/sentry/1", uri(&http.Request{
+		TLS:  &tls.ConnectionState{},
+		Host: "example.com",
+		URL:  testUrl,
+	}))
+	assert.NotEqual(t, "http://example.com/sentry/1", uri(&http.Request{
+		TLS:  &tls.ConnectionState{},
+		Host: "example.com",
+		URL:  testUrl,
+	}))
+
+	assert.Equal(t, "http://example.com/sentry/1", uri(&http.Request{
+		Host: "example.com",
+		URL:  testUrl,
+	}))
+	assert.NotEqual(t, "https://example.com/sentry/1", uri(&http.Request{
+		Host: "example.com",
+		URL:  testUrl,
+	}))
+}