Add common packages for http and tracing (#10)

**What**

- Added common errors
- Added `BaseHandler`
- Added parameter resolution and normalization
- Added profiling endpoint
- Added error models
- Deleted obsolete tracing utils
- Added `Tracer`
- Fix linting issues and update linter
- Fix all linter issues and fix `fileutils` tests
- Disabled GitHub actions

Author: rdner

.circleci/config.yml

@@ -13,7 +13,7 @@ jobs:
       - run:
           name: Install go tools
           command: |
-            go get golang.org/x/lint/golint
+            make setup-env
       - run:
           name: Print env
           command: make env

.github/actions/golint/Dockerfile

@@ -1 +1,3 @@
-vendor
+bin
+vendor
+*~

.github/workflows/go.yml

@@ -22,14 +22,14 @@ help:
 env: ## Print debug information about your local environment
 	@echo git: $(shell git version)
 	@echo go: $(shell go version)
-	@echo golint: $(shell which golint)
+	@echo golangci-lint: $(shell which golangci-lint)
 	@echo gofmt: $(shell which gofmt)
 	@echo staticcheck: $(shell which staticcheck)
 
 .PHONY: setup-env
 setup-env:
 	$(shell go mod download)
-	$(shell go install golang.org/x/lint/golint)
+	$(shell curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh| sh -s v1.20.0)
 
 .PHONY: changelog
 changelog: ## Print git hitstory based changelog
@@ -58,9 +58,9 @@ test: ## Runs the go tests
 	@go test -cover ./...
 
 .PHONY: lint
-lint: ## Verifies `golint` passes
+lint: setup-env ## Verifies `golangci-lint` passes
 	@echo "+ $@"
-	@golint -set_exit_status  ./...
+	@./bin/golangci-lint run  ./...
 
 
 

.gitignore

@@ -4,6 +4,7 @@ require (
 	github.com/bakins/net-http-recover v0.0.0-20141007104922-6cba69d01459
 	github.com/codahale/hdrhistogram v0.0.0-20161010025455-3a0bb77429bd // indirect
 	github.com/go-chi/chi v4.0.2+incompatible
+	github.com/go-ozzo/ozzo-validation v3.6.0+incompatible
 	github.com/golang/protobuf v1.3.2
 	github.com/google/uuid v1.1.1
 	github.com/gorilla/websocket v1.4.0
@@ -13,7 +14,7 @@ require (
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.1 // indirect
 	github.com/opentracing/opentracing-go v1.1.0
-	github.com/pkg/errors v0.8.1 // indirect
+	github.com/pkg/errors v0.8.1
 	github.com/prometheus/client_golang v1.1.0
 	github.com/rs/cors v1.7.0
 	github.com/satori/go.uuid v1.2.0

Makefile

@@ -19,6 +19,8 @@ github.com/go-chi/chi v4.0.2+incompatible/go.mod h1:eB3wogJHnLi3x/kFX2A+IbTBlXxm
 github.com/go-kit/kit v0.8.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as=
 github.com/go-logfmt/logfmt v0.3.0/go.mod h1:Qt1PoO58o5twSAckw1HlFXLmHsOX5/0LbT9GBnD5lWE=
 github.com/go-logfmt/logfmt v0.4.0/go.mod h1:3RMwSq7FuexP4Kalkev3ejPJsZTpXXBr9+V4qmtdjCk=
+github.com/go-ozzo/ozzo-validation v3.6.0+incompatible h1:msy24VGS42fKO9K1vLz82/GeYW1cILu7Nuuj1N3BBkE=
+github.com/go-ozzo/ozzo-validation v3.6.0+incompatible/go.mod h1:gsEKFIVnabGBt6mXmxK0MoFy+cZoTJY6mu5Ll3LVLBU=
 github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY=
 github.com/gogo/protobuf v1.1.1/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ=
 github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b h1:VKtxabqXZkF25pY9ekfRL6a582T4P37/31XEstQ5p58=

go.mod

@@ -0,0 +1,11 @@
+package errors
+
+// ErrorType : The type of the error response
+type ErrorType string
+
+const (
+	// GeneralErrorType is a generic error type
+	GeneralErrorType ErrorType = "GeneralError"
+	// FieldErrorType is a field validation error type
+	FieldErrorType ErrorType = "FieldError"
+)

go.sum

@@ -0,0 +1,49 @@
+package errors
+
+import (
+	"errors"
+
+	validation "github.com/go-ozzo/ozzo-validation"
+)
+
+var (
+	// ErrPermission is the standard "Permission Denied" error
+	ErrPermission = errors.New("You don't have required permission to perform this action")
+	// ErrAuthorization is the standard "Unauthorized" error
+	ErrAuthorization = errors.New("User is unauthorized, make sure you've logged in")
+	// ErrInternal is the standard "Internal Server" error
+	ErrInternal = errors.New("Internal server error, please try again later")
+	// ErrInvalidParameters is the standard "Bad Request" error
+	ErrInvalidParameters = errors.New("Some of the request parameters are not correct")
+	// ErrUnmarshalling is the JSON deserialization error
+	ErrUnmarshalling = errors.New("Failed to read JSON from the request body")
+	// ErrForm is the form parsing error
+	ErrForm = errors.New("Failed to parse the submitted form")
+	// ErrNotFound is the standard entiry not found error
+	ErrNotFound = errors.New("The requested object was not found")
+	// ErrNotImplemented is intended to be used when stubbing new endpoints
+	ErrNotImplemented = errors.New("Method is not implemented")
+)
+
+// ValidationErrors contains errors organized by validated fields
+// for now it's just an alias to the validation library we use
+type ValidationErrors = validation.Errors
+
+// ValidationErrorsToFieldErrorResponse converts validation errors to the format that is
+// served by HTTP handlers
+func ValidationErrorsToFieldErrorResponse(errs ValidationErrors) (fieldErrResp FieldErrorResponse) {
+	fieldErrResp.Errors = make([]FieldError, 0, len(errs))
+	for key, fieldErr := range errs {
+		if fieldErr == nil {
+			continue
+		}
+		fieldErrResp.Errors = append(fieldErrResp.Errors, FieldError{
+			GeneralError: GeneralError{
+				Type:    FieldErrorType,
+				Message: fieldErr.Error(),
+			},
+			Key: key,
+		})
+	}
+	return fieldErrResp
+}

pkg/errors/error_type.go

@@ -0,0 +1,75 @@
+package errors
+
+import (
+	"errors"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestValidationErrorsToFieldErrorResponse(t *testing.T) {
+	cases := []struct {
+		name     string
+		errs     ValidationErrors
+		expected FieldErrorResponse
+	}{
+		{
+			name:     "Returns empty response when errors are nil",
+			expected: FieldErrorResponse{Errors: []FieldError{}},
+		},
+		{
+			name:     "Returns empty response when errors are empty",
+			errs:     ValidationErrors{},
+			expected: FieldErrorResponse{Errors: []FieldError{}},
+		},
+		{
+			name: "Returns errors in the response when errors are not empty",
+			errs: ValidationErrors{
+				"field1": errors.New("bad field1"),
+				"field2": errors.New("bad field2"),
+			},
+			expected: FieldErrorResponse{
+				Errors: []FieldError{
+					FieldError{
+						GeneralError: GeneralError{
+							Type:    FieldErrorType,
+							Message: "bad field1",
+						},
+						Key: "field1",
+					},
+					FieldError{
+						GeneralError: GeneralError{
+							Type:    FieldErrorType,
+							Message: "bad field2",
+						},
+						Key: "field2",
+					},
+				},
+			},
+		},
+		{
+			name: "Does not include nil errors in the response",
+			errs: ValidationErrors{
+				"field1": errors.New("bad field1"),
+				"field2": nil,
+			},
+			expected: FieldErrorResponse{
+				Errors: []FieldError{
+					FieldError{
+						GeneralError: GeneralError{
+							Type:    FieldErrorType,
+							Message: "bad field1",
+						},
+						Key: "field1",
+					},
+				},
+			},
+		},
+	}
+
+	for _, tc := range cases {
+		t.Run(tc.name, func(t *testing.T) {
+			require.Equal(t, tc.expected, ValidationErrorsToFieldErrorResponse(tc.errs))
+		})
+	}
+}