feat: add build isntruction (#9)

Author: ZergsLaw

Dockerfile

@@ -7,6 +7,6 @@ FROM scratch
 WORKDIR /bin
 
 COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
-COPY /bin/easyp easyp
+COPY /bin/easyp-server easyp-server
 
-ENTRYPOINT ["easyp"]
+ENTRYPOINT ["easyp-server"]

README.md

@@ -1 +1,60 @@
-# Server
+# easyp-server
+
+TODO:
+
+* Provide an example of a proxy setup
+* Elaborate on the roadmap
+
+A backward-compatible server for working with the CLI tool [buf](https://github.com/bufbuild/buf).
+
+## Features
+
+* Support for the package manager with `buf mod update`
+
+## Installation
+
+### Steps
+
+#### Repository Setup
+
+```bash
+wget https://github.com/easyp-tech/server/blob/main/scripts/clone_repos.sh -O clone_repos.sh
+
+chmod +x clone_repos.sh
+
+./clone_repos.sh https://github.com/googleapis/googleapis.git https://github.com/bufbuild/protovalidate.git
+```
+
+#### Service Configuration
+
+Create a service configuration file, replace easyp.tech with your domain:
+
+```yaml
+server:
+  external:
+    domain: "easyp.tech"
+    host: "0.0.0.0"
+    port:
+      connect: 8080
+      metric: 8081
+storage:
+  root: "/cache"
+```
+
+#### Docker Compose Setup
+
+```yaml
+version: "3.9"
+
+services:
+
+  easyp:
+    image: easyp/server:v0.1.0
+    restart: always
+    command: [
+      "-cfg=/config.yml",
+    ]
+    volumes:
+      - "./config.yml:/config.yml"
+      - "./easyp_volume:/cache/"
+```

cmd/easyp/local.config.yml

@@ -1,4 +1,3 @@
-dev_mode: true
 server:
   external:
     domain: "127.0.0.1:8080"
@@ -8,6 +7,3 @@ server:
       metric: 8081
 storage:
   root: "../cache"
-  urls:
-    - "https://github.com/bufbuild/protoc-gen-validate.git"
-    - "https://github.com/RussianInvestments/invest-api-go-sdk.git"

cmd/easyp/main.go

@@ -7,6 +7,7 @@ import (
 	"os"
 	"os/signal"
 	"path/filepath"
+	"strings"
 	"syscall"
 	"time"
 
@@ -15,10 +16,11 @@ import (
 	"golang.org/x/exp/slog"
 	"google.golang.org/grpc/grpclog"
 
+	"github.com/easyp-tech/server/internal/logger"
+
 	"github.com/easyp-tech/server/internal/api"
 	"github.com/easyp-tech/server/internal/core"
 	"github.com/easyp-tech/server/internal/grpchelper"
-	"github.com/easyp-tech/server/internal/logkey"
 	"github.com/easyp-tech/server/internal/metrics"
 	"github.com/easyp-tech/server/internal/serve"
 	"github.com/easyp-tech/server/internal/store"
@@ -27,9 +29,8 @@ import (
 type (
 	//nolint:tagliatelle
 	config struct {
-		DevMode bool    `json:"dev_mode"`
-		Server  server  `json:"server"`
-		Store   storage `json:"storage"`
+		Server server  `json:"server"`
+		Store  storage `json:"storage"`
 	}
 	server struct {
 		External external `json:"external"`
@@ -44,8 +45,7 @@ type (
 		Port   ports  `json:"port"`
 	}
 	storage struct {
-		Root string   `json:"root"`
-		URLS []string `json:"urls"`
+		Root string `json:"root"`
 	}
 )
 
@@ -60,9 +60,9 @@ func main() {
 
 	grpclog.SetLoggerV2(grpchelper.NewLogger(log))
 
-	appName := filepath.Base(os.Args[0])
+	appName := strings.Replace(filepath.Base(os.Args[0]), "-", "_", -1)
 
-	ctxParent := logkey.NewContext(context.Background(), log)
+	ctxParent := logger.NewContext(context.Background(), log)
 
 	ctx, cancel := signal.NotifyContext(
 		ctxParent,
@@ -77,34 +77,30 @@ func main() {
 	go forceShutdown(ctx)
 
 	if err := start(ctx, cfg, appName); err != nil {
-		log.Error("shutdown", slog.String(logkey.Error, err.Error()))
+		log.Error("shutdown", slog.String(logger.Error, err.Error()))
 		os.Exit(1)
 	}
 }
 
 func start(ctx context.Context, cfg config, namespace string) error {
-	log := logkey.FromContext(ctx)
+	log := logger.FromContext(ctx)
 	reg := prometheus.NewPedanticRegistry()
 	m := metrics.New(reg, namespace)
 
-	s, err := store.New(ctx, cfg.Store.Root, cfg.Store.URLS)
-	if err != nil {
-		return fmt.Errorf("store.New: %w", err)
-	}
-
+	s := store.New(ctx, cfg.Store.Root)
 	module := core.New(s)
 	_, httpAPI := api.New(ctx, m, module, reg, namespace, cfg.Server.External.Domain)
 
 	return serve.Start( //nolint:wrapcheck
 		ctx,
 		serve.Metrics(
-			log.With(slog.String(logkey.Module, "metric")),
+			log.With(slog.String(logger.Module, "metric")),
 			cfg.Server.External.Host,
 			cfg.Server.External.Port.Metric,
 			reg,
 		),
 		serve.HTTP(
-			log.With(slog.String(logkey.Module, "gRPC-Gateway")),
+			log.With(slog.String(logger.Module, "connect")),
 			cfg.Server.External.Host,
 			cfg.Server.External.Port.Connect,
 			httpAPI,
@@ -113,7 +109,7 @@ func start(ctx context.Context, cfg config, namespace string) error {
 }
 
 func forceShutdown(ctx context.Context) {
-	log := logkey.FromContext(ctx)
+	log := logger.FromContext(ctx)
 
 	const shutdownDelay = 15 * time.Second
 

stage/Caddyfile example/Caddyfilestage/Caddyfile renamed to example/Caddyfile

@@ -12,7 +12,7 @@
      }
 }
 
-https://stage.easyp.tech {
+https://easyp.tech {
   handle {
         root          * /build
         try_files {path} /index.html

example/config.yml

@@ -0,0 +1,9 @@
+server:
+  external:
+    domain: "easyp.tech"
+    host: "0.0.0.0"
+    port:
+      connect: 8080
+      metric: 8081
+storage:
+  root: "/cache"

stage/docker-compose.yml example/docker-compose.ymlstage/docker-compose.yml renamed to example/docker-compose.yml

@@ -6,7 +6,7 @@ volumes:
 services:
 
   easyp:
-    image: cr.yandex/crplga9vcvsvk4uv6541/easyp:stage
+    image: easyp/server:v0.1.0
     restart: always
     command: [
       "-cfg=/config.yml",

internal/api/api.go

@@ -14,7 +14,7 @@ import (
 	registryv1alpha1connect "github.com/easyp-tech/server/gen/proto/buf/alpha/registry/v1alpha1/v1alpha1connect"
 	"github.com/easyp-tech/server/internal/core"
 	"github.com/easyp-tech/server/internal/grpchelper"
-	"github.com/easyp-tech/server/internal/logkey"
+	"github.com/easyp-tech/server/internal/logger"
 	"github.com/easyp-tech/server/internal/metrics"
 )
 
@@ -39,7 +39,7 @@ func New(
 	namespace,
 	domain string,
 ) (*grpc.Server, *http.ServeMux) {
-	log := logkey.FromContext(ctx)
+	log := logger.FromContext(ctx)
 	subsystem := "api"
 
 	grpcMetrics := grpchelper.NewServerMetrics(reg, namespace, subsystem)

internal/grpchelper/grpc_logs.go

@@ -9,18 +9,18 @@ import (
 	"golang.org/x/exp/slog"
 	"google.golang.org/grpc/codes"
 
-	"github.com/easyp-tech/server/internal/logkey"
+	"github.com/easyp-tech/server/internal/logger"
 	"github.com/easyp-tech/server/internal/metrics"
 )
 
 func recoveryFunc(m metrics.Metrics, err error) grpc_recovery.RecoveryHandlerFuncContext {
 	return func(ctx context.Context, p interface{}) error {
 		m.PanicsTotal.Inc()
 
-		l := logkey.FromContext(ctx)
+		l := logger.FromContext(ctx)
 		l.Error("panic",
-			slog.String(logkey.GRPCCode, codes.Internal.String()),
-			slog.Any(logkey.PanicReason, p),
+			slog.String(logger.GRPCCode, codes.Internal.String()),
+			slog.Any(logger.PanicReason, p),
 		)
 
 		return err

internal/grpchelper/logger.go

@@ -8,70 +8,70 @@ import (
 	"google.golang.org/grpc/grpclog"
 )
 
-var _ grpclog.LoggerV2 = (*logger)(nil)
+var _ grpclog.LoggerV2 = (*grpcLogger)(nil)
 
 // NewLogger returns new grpclog Logger.
-func NewLogger(l *slog.Logger) *logger {
-	return &logger{l: l}
+func NewLogger(l *slog.Logger) *grpcLogger {
+	return &grpcLogger{l: l}
 }
 
-type logger struct {
+type grpcLogger struct {
 	l *slog.Logger
 }
 
-func (l *logger) Info(args ...any) {
+func (l *grpcLogger) Info(args ...any) {
 	l.l.Info(fmt.Sprint(args...))
 }
 
-func (l *logger) Infoln(args ...any) {
+func (l *grpcLogger) Infoln(args ...any) {
 	l.l.Info(fmt.Sprint(args...))
 }
 
-func (l *logger) Infof(format string, args ...any) {
+func (l *grpcLogger) Infof(format string, args ...any) {
 	l.l.Info(fmt.Sprintf(format, args...))
 }
 
-func (l *logger) Warning(args ...any) {
+func (l *grpcLogger) Warning(args ...any) {
 	l.l.Warn(fmt.Sprint(args...))
 }
 
-func (l *logger) Warningln(args ...any) {
+func (l *grpcLogger) Warningln(args ...any) {
 	l.l.Warn(fmt.Sprint(args...))
 }
 
-func (l *logger) Warningf(format string, args ...any) {
+func (l *grpcLogger) Warningf(format string, args ...any) {
 	l.l.Warn(fmt.Sprintf(format, args...))
 }
 
-func (l *logger) Error(args ...any) {
+func (l *grpcLogger) Error(args ...any) {
 	l.l.Error(fmt.Sprint(args...))
 }
 
-func (l *logger) Errorln(args ...any) {
+func (l *grpcLogger) Errorln(args ...any) {
 	l.l.Error(fmt.Sprint(args...))
 }
 
-func (l *logger) Errorf(format string, args ...any) {
+func (l *grpcLogger) Errorf(format string, args ...any) {
 	l.l.Error(fmt.Sprintf(format, args...))
 }
 
-func (l *logger) Fatal(args ...any) {
+func (l *grpcLogger) Fatal(args ...any) {
 	l.fatal(fmt.Sprint(args...))
 }
 
-func (l *logger) Fatalln(args ...any) {
+func (l *grpcLogger) Fatalln(args ...any) {
 	l.fatal(fmt.Sprint(args...))
 }
 
-func (l *logger) Fatalf(format string, args ...any) {
+func (l *grpcLogger) Fatalf(format string, args ...any) {
 	l.fatal(fmt.Sprintf(format, args...))
 }
 
-func (l *logger) V(_ int) bool {
+func (l *grpcLogger) V(_ int) bool {
 	return true
 }
 
-func (l *logger) fatal(msg string) {
+func (l *grpcLogger) fatal(msg string) {
 	l.l.Error(msg)
 	os.Exit(1)
 }