Pass in the app env (#23)

* add more args to linter

* pass env data from app to a handler

Author: jinut2

.github/workflows/golangci-lint.yml

@@ -20,13 +20,13 @@ jobs:
         uses: golangci/golangci-lint-action@v2
         with:
           # Optional: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
-          version: v1.29
+          version: latest
 
           # Optional: working directory, useful for monorepos
           # working-directory: somedir
 
           # Optional: golangci-lint command line arguments.
-          # args: --issues-exit-code=0
+          # args: -E gosec -E megacheck -E govet -E goconst -E lll -E gocritic -E gocyclo -E godox -E dupl -E depguard
 
           # Optional: show only new issues if it's a pull request. The default value is `false`.
           # only-new-issues: true

.golangci.yml

@@ -0,0 +1,101 @@
+# This file contains all available configuration options
+# with their default values.
+
+# options for analysis running
+run:
+  # default concurrency is a available CPU number
+  concurrency: 4
+
+  # timeout for analysis, e.g. 30s, 5m, default is 1m
+  timeout: 1m
+
+  # exit code when at least one issue was found, default is 1
+  issues-exit-code: 1
+
+  # include test files or not, default is true
+  tests: true
+
+  # list of build tags, all linters use it. Default is empty list.
+  build-tags:
+    
+
+  # which dirs to skip: issues from them won't be reported;
+  # can use regexp here: generated.*, regexp is applied on full path;
+  # default value is empty list, but default dirs are skipped independently
+  # from this option's value (see skip-dirs-use-default).
+  # "/" will be replaced by current OS file path separator to properly work
+  # on Windows.
+  skip-dirs:
+    
+
+  # default is true. Enables skipping of directories:
+  #   vendor$, third_party$, testdata$, examples$, Godeps$, builtin$
+  skip-dirs-use-default: true
+
+  # which files to skip: they will be analyzed, but issues from them
+  # won't be reported. Default value is empty list, but there is
+  # no need to include all autogenerated files, we confidently recognize
+  # autogenerated files. If it's not please let us know.
+  # "/" will be replaced by current OS file path separator to properly work
+  # on Windows.
+  skip-files:
+    
+
+  # by default isn't set. If set we pass it to "go list -mod={option}". From "go help modules":
+  # If invoked with -mod=readonly, the go command is disallowed from the implicit
+  # automatic updating of go.mod described above. Instead, it fails when any changes
+  # to go.mod are needed. This setting is most useful to check that go.mod does
+  # not need updates, such as in a continuous integration and testing system.
+  # If invoked with -mod=vendor, the go command assumes that the vendor
+  # directory holds the correct copies of dependencies and ignores
+  # the dependency descriptions in go.mod.
+  modules-download-mode: readonly
+
+  # Allow multiple parallel golangci-lint instances running.
+  # If false (default) - golangci-lint acquires file lock on start.
+  allow-parallel-runners: false
+
+
+# output configuration options
+output:
+  # colored-line-number|line-number|json|tab|checkstyle|code-climate|junit-xml|github-actions
+  # default is "colored-line-number"
+  format: colored-line-number
+
+  # print lines of code with issue, default is true
+  print-issued-lines: true
+
+  # print linter name in the end of issue text, default is true
+  print-linter-name: true
+
+  # make issues output unique by line, default is true
+  uniq-by-line: true
+
+  # add a prefix to the output file references; default is no prefix
+  path-prefix: ""
+
+  # sorts results by: filepath, line and column
+  sort-results: true
+
+linters:
+  enable:
+    - gosec
+    - megacheck
+    - govet
+    - goconst
+    - importas
+    - lll
+    - gocritic
+    - gocyclo
+    - godox
+    - gci
+    - dupl
+    - cyclop
+    - depguard
+  presets:
+    - bugs
+    - unused
+  disable:
+    - scopelint
+  fast: false
+

apihandler.go

@@ -14,7 +14,12 @@ import (
 	"github.com/gorilla/mux"
 )
 
-func apiHandler(hf Handler, api HTTPService, path, method string, ll logger.LogLevel, env *sync.Map) http.Handler {
+func apiHandler(hf Handler,
+	api HTTPService,
+	path, method string,
+	ll logger.LogLevel,
+	envs []*sync.Map,
+) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		rl := &responseLogger{w: w, status: http.StatusOK}
 		w = httpsnoop.Wrap(w, httpsnoop.Hooks{
@@ -26,10 +31,14 @@ func apiHandler(hf Handler, api HTTPService, path, method string, ll logger.LogL
 			},
 		})
 		ctx := NewServerContext(r.Context(), ll, w, r)
-		env.Range(func(key, value interface{}) bool {
-			ctx.Set(fmt.Sprint(key), value)
-			return true
-		})
+
+		for _, each := range envs {
+			env := each
+			env.Range(func(key, value interface{}) bool {
+				ctx.Set(fmt.Sprint(key), value)
+				return true
+			})
+		}
 		t := time.Now()
 
 		defer func() {

app.go

@@ -4,14 +4,13 @@ import (
 	"fmt"
 	"net/http"
 	"strconv"
+	"sync"
 	"time"
 
 	"github.com/galentuo/goframe/logger"
 )
 
-var (
-	cl *logger.CoreLogger
-)
+var cl *logger.CoreLogger
 
 func init() {
 	cl = logger.NewCoreLogger()
@@ -22,15 +21,26 @@ type app struct {
 	name   string
 	config Config
 	mux    Router
+	env    *sync.Map
 }
 
-func (a *app) Name() string              { return a.name }
+// Name returns the name of the app
+func (a *app) Name() string { return a.name }
+
+// LogLevel returns the log level of the app
 func (a *app) LogLevel() logger.LogLevel { return a.ll }
 
+// CustomCoreLogger is used to replace the core logger with a custom one
+// if required
 func (a *app) CustomCoreLogger(clIn *logger.CoreLogger) {
 	cl = clIn
 }
 
+// SetInCtx is used to set data into ctx
+func (a *app) SetInCtx(key string, value interface{}) {
+	a.env.Store(key, value)
+}
+
 // Config returns the config reader.
 // Config values can be fetched by keys eg. "server.host".
 // In production configs can be stored as env vars.
@@ -62,19 +72,23 @@ func NewApp(name string, strictSlash bool, cr Config) *app {
 		name:   name,
 		config: cr,
 		mux:    NewRouter(strictSlash),
+		env:    &sync.Map{},
 	}
 
 	ll := logger.LogLevelFromStr(a.config.GetString("log.level"))
 	a.ll = ll
 	return &a
 }
 
-func (a *app) Register(_svc Service) {
+// Register registers the service to the app.
+// A service must be registered to the app for it to run.
+func (a *app) Register(svcIn Service) {
 	var (
 		api HTTPService
 		bg  BackgroundService
 	)
-	switch svc := _svc.(type) {
+
+	switch svc := svcIn.(type) {
 	case HTTPService:
 		api = svc
 	case BackgroundService:
@@ -86,7 +100,12 @@ func (a *app) Register(_svc Service) {
 	if api != nil {
 		for path, routes := range api.routes() {
 			for _, endpoint := range routes {
-				a.mux.Handle(endpoint.Method(), api.prefix()+path, apiHandler(endpoint.Handler(), api, path, endpoint.Method(), a.LogLevel(), api.getCtxData()))
+				a.mux.Handle(endpoint.Method(), api.prefix()+path,
+					apiHandler(endpoint.Handler(), api, path,
+						endpoint.Method(), a.LogLevel(),
+						[]*sync.Map{a.env, api.getCtxData()},
+					),
+				)
 			}
 		}
 		for _, each := range api.getChildren() {

default_context.go

@@ -83,7 +83,11 @@ func NewContext(ctx context.Context, ll logger.LogLevel) *defaultContext {
 
 // NewServerContext is used to get an instance of the default implementation
 // of goframe.ServerContext
-func NewServerContext(ctx context.Context, ll logger.LogLevel, res http.ResponseWriter, req *http.Request) *defaultServerContext {
+func NewServerContext(ctx context.Context,
+	ll logger.LogLevel,
+	res http.ResponseWriter,
+	req *http.Request,
+) *defaultServerContext {
 	llh := req.Header.Get("X-Request-LogLevel")
 	if llh == "debug" {
 		ll = logger.LogLevelDebug

default_response_writer.go

@@ -2,6 +2,7 @@ package goframe
 
 import (
 	"encoding/json"
+	"errors"
 	"fmt"
 	"net/http"
 )
@@ -51,10 +52,11 @@ func (drw *defaultResponseWriter) ErrorJSON(err error) error {
 	}
 	httpCode := int(500)
 
-	if ie, ok := err.(*goframeError); ok {
-		httpCode = ie.HttpCode()
-		responseJson.ErrorCode = ie.ErrCode()
-		responseJson.Message = ie.Message()
+	gfErr := goframeError{}
+	if ok := errors.As(err, &gfErr); ok {
+		httpCode = gfErr.HttpCode()
+		responseJson.ErrorCode = gfErr.ErrCode()
+		responseJson.Message = gfErr.Message()
 	} else {
 		responseJson.ErrorCode = "dev"
 		responseJson.Message = err.Error()

default_services.go

@@ -10,10 +10,12 @@ type service struct {
 	env  *sync.Map
 }
 
+// Name returns the name of the service
 func (ds *service) Name() string {
 	return ds.name
 }
 
+// SetInCtx is used to set data into ctx
 func (ds *service) SetInCtx(key string, value interface{}) {
 	ds.env.Store(key, value)
 }

golangci.yml

@@ -0,0 +1,101 @@
+## This file contains all available configuration options
+## with their default values.
+#
+## options for analysis running
+#run:
+#  # default concurrency is a available CPU number
+#  concurrency: 4
+#
+#  # timeout for analysis, e.g. 30s, 5m, default is 1m
+#  timeout: 1m
+#
+#  # exit code when at least one issue was found, default is 1
+#  issues-exit-code: 1
+#
+#  # include test files or not, default is true
+#  tests: true
+#
+#  # list of build tags, all linters use it. Default is empty list.
+#  build-tags:
+#    
+#
+#  # which dirs to skip: issues from them won't be reported;
+#  # can use regexp here: generated.*, regexp is applied on full path;
+#  # default value is empty list, but default dirs are skipped independently
+#  # from this option's value (see skip-dirs-use-default).
+#  # "/" will be replaced by current OS file path separator to properly work
+#  # on Windows.
+#  skip-dirs:
+#    
+#
+#  # default is true. Enables skipping of directories:
+#  #   vendor$, third_party$, testdata$, examples$, Godeps$, builtin$
+#  skip-dirs-use-default: true
+#
+#  # which files to skip: they will be analyzed, but issues from them
+#  # won't be reported. Default value is empty list, but there is
+#  # no need to include all autogenerated files, we confidently recognize
+#  # autogenerated files. If it's not please let us know.
+#  # "/" will be replaced by current OS file path separator to properly work
+#  # on Windows.
+#  skip-files:
+#    
+#
+#  # by default isn't set. If set we pass it to "go list -mod={option}". From "go help modules":
+#  # If invoked with -mod=readonly, the go command is disallowed from the implicit
+#  # automatic updating of go.mod described above. Instead, it fails when any changes
+#  # to go.mod are needed. This setting is most useful to check that go.mod does
+#  # not need updates, such as in a continuous integration and testing system.
+#  # If invoked with -mod=vendor, the go command assumes that the vendor
+#  # directory holds the correct copies of dependencies and ignores
+#  # the dependency descriptions in go.mod.
+#  modules-download-mode: mod
+#
+#  # Allow multiple parallel golangci-lint instances running.
+#  # If false (default) - golangci-lint acquires file lock on start.
+#  allow-parallel-runners: false
+#
+#
+## output configuration options
+#output:
+#  # colored-line-number|line-number|json|tab|checkstyle|code-climate|junit-xml|github-actions
+#  # default is "colored-line-number"
+#  format: colored-line-number
+#
+#  # print lines of code with issue, default is true
+#  print-issued-lines: true
+#
+#  # print linter name in the end of issue text, default is true
+#  print-linter-name: true
+#
+#  # make issues output unique by line, default is true
+#  uniq-by-line: true
+#
+#  # add a prefix to the output file references; default is no prefix
+#  path-prefix: ""
+#
+#  # sorts results by: filepath, line and column
+#  sort-results: true
+#
+#linters:
+#  enable:
+#    - gosec
+#    - megacheck
+#    - govet
+#    - goconst
+#    - importas
+#    - lll
+#    - gocritic
+#    - gocyclo
+#    - godox
+#    - gci
+#    - dupl
+#    - cyclop
+#    - depguard
+#  presets:
+#    - bugs
+#    - unused
+#  disable:
+#    - scopelint
+#  fast: false
+#