[fix] Fixed all linters warnings

pkg/cache/cache.go

@@ -7,6 +7,7 @@
 // Copyright (c) 2021 Piotr Biernat. https://pbiernat.dev. MIT License
 // Repo: https://git.pbiernat.dev/golang/vegvisir
 
+// Package cache whole cache functionality
 package cache
 
 import (

pkg/cache/manager.go

@@ -27,6 +27,7 @@ import (
 	"time"
 )
 
+// Manager main struct
 type Manager struct {
 	sync.RWMutex
 	datastore Datastore
@@ -46,7 +47,8 @@ type entry struct {
 	ready chan struct{} // closed when res is ready
 }
 
-type HandlerFunc func(url, method string, route *RouteCache) (error, *ResponseCache)
+// HandlerFunc non-blocking cache handler func signature definition
+type HandlerFunc func(url, method string, route *RouteCache) (*ResponseCache, error)
 
 type queue struct {
 	items chan queueItem
@@ -64,9 +66,10 @@ type queueItem struct {
 
 //var reqsSend = 0
 
-func NewCachedManager(datastore Datastore, prefix string, ttl int, handler HandlerFunc) Manager {
+// NewCachedManager Creates instance of non-blocking cache manager
+func NewCachedManager(datastore Datastore, prefix string, ttl int, handler HandlerFunc) *Manager {
 	//log.Printf("Create DS: %s %d", prefix, ttl)
-	m := Manager{
+	m := &Manager{
 		datastore: datastore,
 		prefix:    prefix,
 		ttl:       ttl,
@@ -78,7 +81,8 @@ func NewCachedManager(datastore Datastore, prefix string, ttl int, handler Handl
 	return m
 }
 
-func HttpRequestHandler(url, method string, route *RouteCache) (error, *ResponseCache) { // FIXME: Refactor|Move to handler/
+// HTTPRequestHandler HTTP Handler for non-blocking cache reads
+func HTTPRequestHandler(url, method string, route *RouteCache) (*ResponseCache, error) { // FIXME: Refactor|Move to handler/
 	//start := time.Now()
 	bckReq := fasthttp.AcquireRequest()
 	bckResp := fasthttp.AcquireResponse()
@@ -91,7 +95,7 @@ func HttpRequestHandler(url, method string, route *RouteCache) (error, *Response
 
 	err := fasthttp.Do(bckReq, bckResp)
 	if err != nil {
-		return err, nil
+		return nil, err
 	}
 
 	body, code := string(bckResp.Body()), bckResp.StatusCode()
@@ -101,11 +105,12 @@ func HttpRequestHandler(url, method string, route *RouteCache) (error, *Response
 	// ^^ FIXME: rename NewResponseCache(with all depend struct) and move to handler/ (without dependencies)
 
 	//reqsSend++
-	log.Println(time.Now().Nanosecond(), "HttpRequestHandler() done:", route.TargetURL, url)
+	log.Println(time.Now().Nanosecond(), "HTTPRequestHandler() done:", route.TargetURL, url)
 
-	return nil, respCache
+	return respCache, nil
 }
 
+// Fetch Non-blocking cache response read
 // FIXME: #68 - refactor
 func (m *Manager) Fetch(url, method string, route *RouteCache) (*ResponseCache, error) {
 	//log.Println("Response CM: Fetch()")
@@ -116,11 +121,12 @@ func (m *Manager) Fetch(url, method string, route *RouteCache) (*ResponseCache,
 	return res.body, res.err
 }
 
+// Close exec while server shutting down
 func (m *Manager) Close() {
 	close(m.queue.items)
 }
 
-func (m *Manager) load(url, method string, route *RouteCache/*, output interface{}*/) (bool, *entry) { // FIXME second return type( interface{} )
+func (m *Manager) load(url, method string, route *RouteCache /*, output interface{}*/) (bool, *entry) { // FIXME second return type( interface{} )
 	//log.Println("Response CM: load()")
 
 	key := m.prefix + method + "_" + url
@@ -173,7 +179,7 @@ func (m *Manager) save(name string, r interface{}) bool { // FIXME second argume
 func (m *Manager) server(handler HandlerFunc) {
 	for item := range m.queue.items {
 		m.Lock()
-		ok, e := m.load(item.url, item.method, item.route/*, &ResponseCache{}*/) // FIXME: &responseCache{} tmp fix
+		ok, e := m.load(item.url, item.method, item.route /*, &ResponseCache{}*/) // FIXME: &responseCache{} tmp fix
 		m.Unlock()
 		if !ok {
 			//e = &entry{ready: make(chan struct{})/*, called: make(chan struct{})*/}
@@ -188,7 +194,7 @@ func (m *Manager) server(handler HandlerFunc) {
 func (m *Manager) call(e *entry, f HandlerFunc, url, method string, route *RouteCache) {
 	e.res.name = method + "_" + url // FIXME: hardcoded key pattern
 	m.RLock()
-	e.res.err, e.res.body = f(url, method, route)
+	e.res.body, e.res.err = f(url, method, route)
 	m.save(e.res.name, e.res.body)
 	m.RUnlock()
 

pkg/cache/response.go

@@ -23,6 +23,7 @@ type ResponseCache struct {
 	Headers *fasthttp.ResponseHeader
 }
 
+// NewResponseCache Creates new ResponseCache structure
 func NewResponseCache(url, method, body string, code int, headers *fasthttp.ResponseHeader) *ResponseCache {
 	return &ResponseCache{url, method, body, code, headers}
 }

pkg/cache/route.go

@@ -9,11 +9,13 @@
 
 package cache
 
+// RouteCache struct corresponding route cache item
 type RouteCache struct {
 	SourceURL string
 	TargetURL string
 }
 
+// NewRouteCache Creates new router instance
 func NewRouteCache(source, target string) *RouteCache {
 	return &RouteCache{
 		SourceURL: source,

pkg/client/http.go

@@ -7,6 +7,7 @@
 // Copyright (c) 2021 Piotr Biernat. https://pbiernat.dev. MIT License
 // Repo: https://git.pbiernat.dev/golang/vegvisir
 
+// Package client all available clients lives here (httpo, https, grpc etc.)
 package client
 
 import "github.com/valyala/fasthttp"

pkg/config/config.go

@@ -7,6 +7,7 @@
 // Copyright (c) 2021 Piotr Biernat. https://pbiernat.dev. MIT License
 // Repo: https://git.pbiernat.dev/golang/vegvisir
 
+// Package config main config file structs
 package config
 
 import (

pkg/handler/handler.go

@@ -7,4 +7,5 @@
 // Copyright (c) 2021 Piotr Biernat. https://pbiernat.dev. MIT License
 // Repo: https://git.pbiernat.dev/golang/vegvisir
 
+// Package handler all handlers will be placed here in future...
 package handler

pkg/server/router.go

@@ -21,17 +21,14 @@ import (
 // Router struct
 type Router struct {
 	config *config.Config
-	//cache  map[string]cache.RouteCache
 	cache  *cache.MemoryDatastore
-	//cache  *cache.RedisDatastore
 }
 
 // NewRouter function
-func NewRouter(config *config.Config, ds cache.Datastore, ttl int) *Router {
+func NewRouter(config *config.Config, ds *cache.MemoryDatastore, ttl int) *Router {
 	return &Router{
 		config: config,
-		//cache: make(map[string]cache.RouteCache),
+		cache:  ds,
-		cache: cache.NewMemoryDatastore(),
 		//cache: cache.NewRedisDatastore(config.Cache.Host, config.Cache.Password, config.Cache.Database, config.Cache.Port),
 	}
 }

pkg/server/server.go

@@ -7,6 +7,7 @@
 // Copyright (c) 2021 Piotr Biernat. https://pbiernat.dev. MIT License
 // Repo: https://git.pbiernat.dev/golang/vegvisir
 
+// Package server contains main sever files
 package server
 
 import (
@@ -33,7 +34,7 @@ const (
 type Server struct {
 	config *config.Config
 	router *Router
-	respCM cache.Manager
+	respCM *cache.Manager
 	daemon *fasthttp.Server
 }
 
@@ -51,7 +52,7 @@ func NewServer(cPath string) *Server {
 		config: cfg,
 		router: NewRouter(cfg, cache.NewMemoryDatastore(), cfg.Cache.RouteTTL),
 		// ^^ INFO: Routes always use memoryCache cause low size and fast read time (optimalization)
-		respCM: cache.NewCachedManager(*datastore, "response_", cfg.Cache.ResponseTTL, cache.HttpRequestHandler),
+		respCM: cache.NewCachedManager(*datastore, "response_", cfg.Cache.ResponseTTL, cache.HTTPRequestHandler),
 		// ^^ FIXME: add handler detection option by config etc...
 	}
 }