Merge pull request #4 from korovindenis/iter16

Iter16

.gitignore

@@ -21,4 +21,8 @@
 # Go workspace file
 go.work
 
-.vscode
+.vscode
+
+heap
+
+pgadmindata

Makefile

@@ -15,7 +15,7 @@ gotest:
 	go test `go list ./... | grep -v test` -count 1
 
 gotestcover:
-	go test -covermode=count -coverprofile=coverage.out $(shell go list ./... | egrep -v '(/test|/test/mock)$$')
+	go test -covermode=count -coverprofile=coverage.out $(shell go list ./... | egrep -v '(/test|/test/mock)$$') && go tool cover -func cover.out
 
 get:
 	@echo "  >  Checking dependencies"

cmd/gophermart/main.go

@@ -1,3 +1,5 @@
+// Main module
+// Dependencies are initialized, and the HTTP server is started.
 package main
 
 import (
@@ -17,8 +19,12 @@ import (
 	"go.uber.org/zap"
 )
 
+// Return code for
 const (
+	// a successful exit from the application
 	ExitSucces = iota
+
+	// an unsuccessful exit from the application
 	ExitWithError
 )
 

internal/adapters/accrual/accrual.go

@@ -11,13 +11,17 @@ import (
 	"github.com/korovindenis/go-market/internal/domain/entity"
 )
 
+// max goroutine
 const maxWorker = 10
 
+// get/set for BD
 type storage interface {
 	GetAllNotProcessedOrders(ctx context.Context) ([]entity.Order, error)
 
 	SetOrderStatusAndAccrual(ctx context.Context, order entity.Order) error
 }
+
+// configuration
 type config interface {
 	GetAccrualAddress() string
 }
@@ -27,6 +31,7 @@ type Accrual struct {
 	config
 }
 
+// response data
 type accrualRespose struct {
 	Number  string  `json:"order"`
 	Status  string  `json:"status"`

internal/adapters/auth/auth.go

@@ -19,6 +19,7 @@ type Auth struct {
 	config
 }
 
+// info in jwt token
 type claims struct {
 	entity.User
 	jwt.RegisteredClaims

internal/adapters/config/config.go

@@ -15,6 +15,7 @@ import (
 
 const configDefaultPath = "./configs/config.dev.yaml"
 
+// data in configDefaultPath
 type config struct {
 	App        `koanf:"app"`
 	Httpserver `koanf:"http_server"`

internal/adapters/ctxinfo/ctxinfo.go

@@ -1,3 +1,4 @@
+// Work with context
 package ctxinfo
 
 import (

internal/adapters/logger/logger.go

@@ -1,3 +1,4 @@
+// log data
 package logger
 
 import (

internal/adapters/storage/postgresql/init.go

@@ -1,3 +1,4 @@
+// work with db
 package postgresql
 
 import (

internal/domain/entity/balance.go

@@ -6,11 +6,13 @@ import (
 	"github.com/ShiraazMoollatjie/goluhn"
 )
 
+// struct for user Balance
 type Balance struct {
 	Current   float64 `json:"current"`
 	Withdrawn float64 `json:"withdrawn"`
 }
 
+// struct for update user Balance
 type BalanceUpdate struct {
 	Order      string    `json:"order"`
 	Sum        float64   `json:"sum"`

internal/domain/entity/doc.go

@@ -0,0 +1,2 @@
+// Domain entities
+package entity

internal/domain/entity/errors.go

@@ -2,23 +2,18 @@ package entity
 
 import "errors"
 
+// define errors
 var (
-	// ErrMetricNotFound            = errors.New("metric not set")
-	ErrEnvVarNotFound = errors.New("env var not set")
-	// ErrInvalidURLFormat          = errors.New("invalid URL format")
-	ErrMethodNotAllowed     = errors.New("method not allowed")
-	ErrUnsupportedMediaType = errors.New("unsupported media type")
-	ErrInternalServerError  = errors.New("internal server error")
-	// ErrInputVarIsWrongType       = errors.New("metric value is wrong type")
+	ErrEnvVarNotFound                  = errors.New("env var not set")
+	ErrMethodNotAllowed                = errors.New("method not allowed")
+	ErrUnsupportedMediaType            = errors.New("unsupported media type")
+	ErrInternalServerError             = errors.New("internal server error")
 	ErrStatusBadRequest                = errors.New("bad request")
 	ErrUserLoginNotUnique              = errors.New("login not unique")
 	ErrUserLoginUnauthorized           = errors.New("user unauthorized")
 	ErrUnprocessableEntity             = errors.New("unprocessable entity")
 	ErrOrderAlreadyUploadedAnotherUser = errors.New("order already uploaded another user")
 	ErrOrderAlreadyUploaded            = errors.New("order already uploaded")
-	// ErrInvalidGzipData           = errors.New("invalid gzip data")
-	// ErrReadingRequestBody        = errors.New("error reading request body")
-	ErrNoContent = errors.New("no content")
-	// ErrNotImplementedServerError = errors.New("not implemented server error")
-	ErrInsufficientBalance = errors.New("insufficient balance")
+	ErrNoContent                       = errors.New("no content")
+	ErrInsufficientBalance             = errors.New("insufficient balance")
 )

internal/domain/entity/order.go

@@ -6,6 +6,7 @@ import (
 	"github.com/ShiraazMoollatjie/goluhn"
 )
 
+// order status
 const (
 	StatusNew        = "NEW"
 	StatusRegistered = "REGISTERED"
@@ -14,6 +15,7 @@ const (
 	StatusProcessing = "PROCESSING"
 )
 
+// struct for user Order
 type Order struct {
 	Number     string    `json:"number"`
 	Status     string    `json:"Status"`

internal/domain/entity/user.go

@@ -1,5 +1,6 @@
 package entity
 
+// struct for User
 type User struct {
 	Login     string `json:"login" binding:"required"`
 	Password  string `json:"password" binding:"required"`

internal/domain/usecases/doc.go

@@ -0,0 +1,2 @@
+// Domain usecases
+package usecases

internal/port/http/handler/auth.go

@@ -10,6 +10,7 @@ import (
 	"github.com/korovindenis/go-market/internal/domain/entity"
 )
 
+// Used during user registration
 func (h *Handler) Register(c *gin.Context) {
 	ctx := c.Request.Context()
 	var user entity.User
@@ -118,6 +119,7 @@ func (h *Handler) Login(c *gin.Context) {
 	c.Status(http.StatusOK)
 }
 
+// Used during user authentication
 func (h *Handler) createCookie(token string) (*http.Cookie, error) {
 	return &http.Cookie{
 		Name:     h.GetTokenName(),

internal/port/http/handler/balance.go

@@ -9,6 +9,7 @@ import (
 	"github.com/korovindenis/go-market/internal/domain/entity"
 )
 
+// Displays the user's balance, returned as entity.Balance
 func (h *Handler) GetBalance(c *gin.Context) {
 	userID, err := h.GetUserIDFromCtx(c)
 	if err != nil {

internal/port/http/handler/doc.go

@@ -0,0 +1,2 @@
+// Module with handlers
+package handler

internal/port/http/handler/auth_test.go → internal/port/http/handler/example_test.go

@@ -22,6 +22,14 @@ type callTimes struct {
 	getUser       int
 }
 
+func Example() {
+	t := &testing.T{}
+
+	// run test with testify
+	TestHandler_AuthRegister(t)
+	TestHandler_AuthLogin(t)
+}
+
 func TestHandler_AuthRegister(t *testing.T) {
 	config := mocks.NewConfig(t)
 	usecase := mocks.NewUsecase(t)

internal/port/http/handler/order.go

@@ -10,6 +10,7 @@ import (
 	"github.com/korovindenis/go-market/internal/domain/entity"
 )
 
+// Used to add a new order
 func (h *Handler) SetOrder(c *gin.Context) {
 	ctx := c.Request.Context()
 
@@ -61,6 +62,7 @@ func (h *Handler) SetOrder(c *gin.Context) {
 	c.Status(http.StatusAccepted)
 }
 
+// Returns a list of all purchases
 func (h *Handler) GetAllOrders(c *gin.Context) {
 	ctx := c.Request.Context()
 	userID, err := h.GetUserIDFromCtx(c)

internal/port/http/handler/withdrawals.go

@@ -9,6 +9,7 @@ import (
 	"github.com/korovindenis/go-market/internal/domain/entity"
 )
 
+// handler for get Withdrawals
 func (h *Handler) Withdrawals(c *gin.Context) {
 	ctx := c.Request.Context()
 	userID, err := h.GetUserIDFromCtx(c)

internal/port/http/server/server.go

@@ -1,3 +1,4 @@
+// init api (http server)
 package server
 
 import (
@@ -10,9 +11,11 @@ import (
 
 	"github.com/gin-contrib/gzip"
 	"github.com/gin-gonic/gin"
-	//"github.com/gin-contrib/pprof"
+
+	"github.com/gin-contrib/pprof"
 )
 
+// handler for http server
 type handler interface {
 	Register(c *gin.Context)
 	Login(c *gin.Context)
@@ -26,6 +29,7 @@ type handler interface {
 	Withdrawals(c *gin.Context)
 }
 
+// middleware for http server
 type middleware interface {
 	CheckMethod() gin.HandlerFunc
 
@@ -36,6 +40,7 @@ type middleware interface {
 	AddUserInfoToCtx() gin.HandlerFunc
 }
 
+// configuration
 type config interface {
 	GetServerAddress() string
 	GetServerMode() string
@@ -45,6 +50,7 @@ type config interface {
 	GetServerMaxHeaderBytes() int
 }
 
+// run http server
 func Run(ctx context.Context, config config, handler handler, middleware middleware) error {
 	// init http
 	gin.SetMode(config.GetServerMode())
@@ -75,7 +81,7 @@ func Run(ctx context.Context, config config, handler handler, middleware middlew
 	}
 
 	// add pprof
-	//pprof.Register(router)
+	pprof.Register(router)
 
 	// server settings
 	srv := &http.Server{

profiles/pprof diff.log

@@ -0,0 +1,25 @@
+go tool pprof -top -diff_base=.\profiles\base.pprof .\profiles\result.pprof
+
+File: main.exe
+Type: inuse_space
+Time: Dec 21, 2023 at 1:46pm (MSK)
+Showing nodes accounting for 4.02MB, 100% of 4.02MB total
+      flat  flat%   sum%        cum   cum%
+    1.01MB 25.13% 25.13%     1.01MB 25.13%  github.com/go-playground/validator/v10.map.init.1
+    1.01MB 25.13% 50.26%     1.01MB 25.13%  regexp/syntax.(*compiler).inst (inline)
+       1MB 24.87% 75.13%        1MB 24.87%  regexp/syntax.(*parser).newRegexp (inline)
+       1MB 24.87%   100%        1MB 24.87%  github.com/gabriel-vasile/mimetype/internal/magic.init
+         0     0%   100%     2.02MB 50.26%  github.com/go-playground/validator/v10.init
+         0     0%   100%        1MB 24.87%  github.com/go-playground/validator/v10.init.0
+         0     0%   100%     2.01MB 50.00%  regexp.Compile (inline)
+         0     0%   100%     2.01MB 50.00%  regexp.MustCompile
+         0     0%   100%     2.01MB 50.00%  regexp.compile
+         0     0%   100%     1.01MB 25.13%  regexp/syntax.(*compiler).compile
+         0     0%   100%     1.01MB 25.13%  regexp/syntax.(*compiler).rune
+         0     0%   100%        1MB 24.87%  regexp/syntax.(*parser).literal
+         0     0%   100%     1.01MB 25.13%  regexp/syntax.Compile
+         0     0%   100%        1MB 24.87%  regexp/syntax.Parse (inline)
+         0     0%   100%        1MB 24.87%  regexp/syntax.parse
+         0     0%   100%     4.02MB   100%  runtime.doInit (inline)
+         0     0%   100%     4.02MB   100%  runtime.doInit1
+         0     0%   100%     4.02MB   100%  runtime.main