ref

Author: Maksim Grafskiy

.dockerignore

@@ -2,7 +2,6 @@
 configs
 deployments
 migrations
-proto
 .gitignore
 .gitlab-ci.yml
 .golangci.yml

.gitignore

@@ -1,2 +1,3 @@
+.idea
 /configs/.env
 /configs/.env_localhost

.golangci.yml

@@ -46,7 +46,7 @@ linters:
     - nakedret
     - noctx
     # - nolintlint
-    - revive
+    # - revive
     - staticcheck
     - stylecheck
     - testifylint
@@ -90,7 +90,11 @@ linters-settings:
       - dupImport # https://github.com/go-critic/go-critic/issues/845
       - ifElseChain
       - octalLiteral
-      - whyNoLint
+    settings:
+      hugeParam:
+        # Size in bytes that makes the warning trigger.
+        # Default: 80
+        sizeThreshold: 80
   gocyclo:
     min-complexity: 15
   godox:

Makefile

@@ -1,5 +1,43 @@
 export
 
+## Installation
+
+.PHONY: install
+install: ## Install development utils
+	@echo "* Running migrate-install..."
+	$(MAKE) migrate-install
+	@echo "* Running lint-install..."
+	$(MAKE) openapi-generate
+	@echo "* Running generate-install..."
+	$(MAKE) generate-install
+
+## Generation
+
+.PHONY: generate-install
+generate-install:
+	go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
+	go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
+	go install github.com/swaggo/swag/cmd/swag@latest
+
+.PHONY: proto-generate
+proto-generate:
+	protoc --go_out=proto/gen --go-grpc_out=proto/gen --proto_path=proto proto/shortener_v1.proto
+
+.PHONY: openapi-generate
+openapi-generate:
+	swag init --generalInfo ./pkg/http/server.go --parseInternal
+
+.PHONY: generate
+generate: ## Generate artifacts
+	@echo "* Running proto-generate..."
+	$(MAKE) proto-generate
+	@echo "* Running openapi-generate..."
+	$(MAKE) openapi-generate
+	@echo "* Running go generate..."
+	go generate ./...
+	$(MAKE) fmt
+
+
 ## Migrations
 
 DB_MIGRATE_URL = postgres://login:pass@localhost:5432/app-db?sslmode=disable
@@ -21,23 +59,6 @@ migrate-up:
 migrate-down:
 	migrate -database "$(DB_MIGRATE_URL)" -path "$(MIGRATE_PATH)" down -all
 
-## Proto
-
-.PHONY: proto-install
-proto-install:
-	go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
-	go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
-
-.PHONY: proto-generate
-proto-generate:
-	protoc --go_out=generated/protobuf --go-grpc_out=generated/protobuf --proto_path=proto proto/shortener_v1.proto
-
-## Openapi
-
-.PHONY: openapi-generate
-openapi-generate:
-	swag init --generalInfo ./pkg/http/server.go --parseInternal
-
 ## docker compose
 
 .PHONY: up
@@ -63,7 +84,7 @@ lint: ## 🚨 Run lint checks
 .PHONY: fmt
 fmt: ## 🎨 Fix code format issues
 	gofumpt -w .
-	goimports -w -local github.com/xgmsx/go-url-shortener .
+	goimports -w -local github.com/xgmsx/go-tiny-url .
 
 ## Building, running, escape analysis
 
@@ -79,13 +100,6 @@ run: ## 🚶 Run the program
 rune: ## 🔎 Run the program with escape analysis
 	go run -gcflags='-m=3' ./cmd/app
 
-.PHONY: generate
-generate: ## Generate artifacts
-	@echo "* Running proto-generate..."
-	$(MAKE) proto-generate
-	@echo "* Running openapi-generate..."
-	$(MAKE) openapi-generate
-
 ## Tests, tests, tests...
 
 .PHONY: cov

README.md

@@ -1,11 +1,11 @@
-# go-url-shortener-ddd
+# go-tiny-url
 
-[![Linting](https://github.com/xgmsx/go-url-shortener-ddd/actions/workflows/golangci-lint.yml/badge.svg?branch=main)](https://github.com/xgmsx/go-url-shortener-ddd/actions/workflows/golangci-lint.yml)
-[![Tests](https://github.com/xgmsx/go-url-shortener-ddd/actions/workflows/coverage.yml/badge.svg?branch=main)](https://github.com/xgmsx/go-url-shortener-ddd/actions/workflows/coverage.yml)
-[![CodeQL](https://github.com/xgmsx/go-url-shortener-ddd/actions/workflows/codeql.yml/badge.svg?branch=main)](https://github.com/xgmsx/go-url-shortener-ddd/actions/workflows/codeql.yml)
-[![Coverage_Report](https://img.shields.io/badge/Coverage_Report-30.8%25-yellow)](https://xgmsx.github.io/go-url-shortener-ddd)
+[![Linting](https://github.com/xgmsx/go-tiny-url/actions/workflows/golangci-lint.yml/badge.svg?branch=main)](https://github.com/xgmsx/go-tiny-url/actions/workflows/golangci-lint.yml)
+[![Tests](https://github.com/xgmsx/go-tiny-url/actions/workflows/coverage.yml/badge.svg?branch=main)](https://github.com/xgmsx/go-tiny-url/actions/workflows/coverage.yml)
+[![CodeQL](https://github.com/xgmsx/go-tiny-url/actions/workflows/codeql.yml/badge.svg?branch=main)](https://github.com/xgmsx/go-tiny-url/actions/workflows/codeql.yml)
+[![Coverage_Report](https://img.shields.io/badge/Coverage_Report-57.9%25-yellow)](https://xgmsx.github.io/go-tiny-url)
 
-**go-url-shortener-ddd** — это сокращатель ссылок на Go, реализованный с использованием архитектурного подхода Domain-Driven Design (DDD).
+Проект для демонстрации разработки на Golang с использованием gRPC, REST HTTP, Kafka, Postgres, Observability, Unit-testing.
 
 Структура:
 * [internal](internal) содержит пакеты относящиеся к проекту - app, config, shortener.
@@ -35,8 +35,8 @@ Table of Contents:
 <div class="termy">
 
 ```console
-git clone https://github.com/xgmsx/go-url-shortener-ddd
-cd go-url-shortener-ddd
+git clone https://github.com/xgmsx/go-tiny-url
+cd go-tiny-url
 cp ./configs/.env_example ./configs/.env
 cd ./configs/.env_localhost_example ./configs/.env_localhost
 ```
@@ -45,61 +45,56 @@ cd ./configs/.env_localhost_example ./configs/.env_localhost
 
 ## Quick start
 
-#### Запуск сервиса с зависимостями (postgres, redis, kafka, jaeger, prometheus, grafana) в Docker:
+#### Установка инструментов для разработки
 
-<div class="termy">
+```shell
+make install
+```
 
-```console
-$ docker compose up -d --build
+Проверка работы установленных инструментов: 
 
- ✔ Network go-url-shortener-ddd_default         Created                                                                                                                                                                       0.1s 
- ✔ Container go-url-shortener-ddd-app-1         Started                                                                                                                                                                       0.4s 
- ✔ Container go-url-shortener-ddd-postgres-1    Started                                                                                                                                                                       0.2s 
- ✔ Container go-url-shortener-ddd-redis-1       Started                                                                                                                                                                       0.2s 
- ✔ Container go-url-shortener-ddd-redis-ui-1    Started                                                                                                                                                                       0.2s 
- ✔ Container go-url-shortener-ddd-kafka-1       Started                                                                                                                                                                       0.2s 
- ✔ Container go-url-shortener-ddd-kafka-init-1  Started   
- ✔ Container go-url-shortener-ddd-kafka-ui-1    Started                                                                                                                                                                       0.3s 
+```shell
+make generate
+make fmt
+make lint
 ```
 
-</div>
-
-#### Локальный запуск сервиса в Linux и MacOS:
+#### Запуск сервиса с зависимостями (postgres, redis, kafka, jaeger, prometheus, grafana) в Docker
 
 <div class="termy">
 
 ```console
-$ export $(grep -v '^#' ./configs/.env_localhost | xargs) && go run ./cmd/app
+$ docker compose up -d --build
 
-2025/01/01 12:00:00 maxprocs: Leaving GOMAXPROCS=8: CPU quota undefined
-12:00:00 INF Logger initialized
-12:00:00 INF App starting...
-12:00:00 INF Sentry is disabled
-12:00:00 INF Tracer is disabled
-12:00:00 INF HTTP server started on port: 8000
-12:00:00 INF gRPC server started on port: 50051
-12:00:00 INF Kafka consumer started
-12:00:00 INF App started
+ ✔ Network go-tiny-url_default         Created                                                                                                                                                                       0.1s 
+ ✔ Container go-tiny-url-app-1         Started                                                                                                                                                                       0.4s 
+ ✔ Container go-tiny-url-postgres-1    Started                                                                                                                                                                       0.2s 
+ ✔ Container go-tiny-url-redis-1       Started                                                                                                                                                                       0.2s 
+...                                                                                                                                                                     0.3s 
 ```
 
 </div>
 
-#### Локальный запуск сервиса в Windows Git Bash:
+#### Локальный запуск сервиса в Linux и MacOS
+
+<div class="termy">
 
 ```console
+# Linux, MacOS
+$ export $(grep -v '^#' ./configs/.env_localhost | xargs) && go run ./cmd/app
+
+# Windows Git Bash
 $ env $(grep -v '^#' ./configs/.env_localhost | xargs) go run ./cmd/app
 
 2025/01/01 12:00:00 maxprocs: Leaving GOMAXPROCS=8: CPU quota undefined
 12:00:00 INF Logger initialized
 12:00:00 INF App starting...
-12:00:00 INF Sentry is disabled
-12:00:00 INF Tracer is disabled
-12:00:00 INF HTTP server started on port: 8000
-12:00:00 INF gRPC server started on port: 50051
-12:00:00 INF Kafka consumer started
+...
 12:00:00 INF App started
 ```
 
+</div>
+
 ## Usage
 
 #### Migrations
@@ -187,7 +182,7 @@ $ grpcurl -d '{"url": "https://google.com"}' -plaintext localhost:50051 shortene
 
 Получение полной ссылки:
 ```shell
-$ grpcurl -d '{"alias": "IFIYr0OGRKeqF9jPUIbwww"}' -plaintext localhost:50051 shortener_v1.Shortener/GetLink
+$ grpcurl -d '{"alias": "IFIYr0OGRKeqF9jPUIbwww"}' -plaintext localhost:50051 shortener_v1.Shortener/FetchLink
 
 # {"url": "https://google.com", "alias": "IFIYr0OGRKeqF9jPUIbwww", "expired_at": "2025-01-02T12:00:00.000000000Z"}
 ```

cmd/app/contract.go

@@ -0,0 +1,17 @@
+package main
+
+import (
+	"context"
+
+	"github.com/xgmsx/go-tiny-url/internal/config"
+)
+
+//go:generate mockgen -source=contract.go -destination=mocks/contract.go
+
+type appRunner interface {
+	Run(ctx context.Context, c *config.Config) error
+}
+
+type configLoader interface {
+	Load(ctx context.Context) (*config.Config, error)
+}

cmd/app/main.go

@@ -6,44 +6,47 @@ import (
 	"github.com/rs/zerolog/log"
 	_ "go.uber.org/automaxprocs"
 
-	"github.com/xgmsx/go-url-shortener-ddd/internal/app"
-	"github.com/xgmsx/go-url-shortener-ddd/internal/config"
-	"github.com/xgmsx/go-url-shortener-ddd/pkg/logger"
-	"github.com/xgmsx/go-url-shortener-ddd/pkg/observability/otel"
-	"github.com/xgmsx/go-url-shortener-ddd/pkg/observability/sentry"
+	"github.com/xgmsx/go-tiny-url/internal/app"
+	"github.com/xgmsx/go-tiny-url/internal/config"
+	"github.com/xgmsx/go-tiny-url/pkg/logger"
+	"github.com/xgmsx/go-tiny-url/pkg/observability/otel"
+	"github.com/xgmsx/go-tiny-url/pkg/observability/sentry"
 )
 
-func run(run func(context.Context, *config.Config) error) {
-	c, err := config.New()
+var (
+	cl configLoader = config.New()
+	ar appRunner    = app.New()
+)
+
+func run(ctx context.Context, cl configLoader, ar appRunner) error {
+	c, err := cl.Load(ctx)
 	if err != nil {
-		log.Fatal().Err(err).Msg("config.New")
+		log.Error().Err(err).Msg("config.New")
+		return err
 	}
 
 	logger.Init(c.Logger, c.App.Name, c.App.Version)
 	log.Info().Msg("App starting...")
 	defer log.Info().Msg("App stopped")
 
-	ctx, cancel := context.WithCancel(context.Background())
-	defer cancel()
-
-	err = sentry.Init(c.Sentry, c.App.Name, c.App.Version, c.App.Env)
-	if err != nil {
-		log.Error().Err(err).Msg("sentry.Init")
-	}
+	sentry.Init(c.Sentry, c.App.Name, c.App.Version, c.App.Env)
 	defer sentry.Close()
 
-	err = otel.Init(ctx, c.Otel, c.App.Name, c.App.Version)
-	if err != nil {
-		log.Error().Err(err).Msg("otel.Init")
-	}
+	otel.Init(ctx, c.Otel, c.App.Name, c.App.Version)
 	defer otel.Close()
 
-	err = run(ctx, c)
+	err = ar.Run(ctx, c)
 	if err != nil {
 		log.Error().Err(err).Msg("app.Run")
 	}
+	return err
 }
 
 func main() {
-	run(app.Run)
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
+
+	if err := run(ctx, cl, ar); err != nil {
+		panic(err)
+	}
 }