feat: api v2 init

Taskfile.yml

@@ -48,3 +48,9 @@ tasks:
     cmds:
       - task: seed
       - pnpm test:integration
+
+
+  generate-sql:
+    dir: internal/db
+    cmds:
+      - pnpm drizzle-kit generate --dialect=mysql

apps/agent/pkg/openapi/openapi.json

@@ -623,9 +623,9 @@
         "tags": ["ratelimit"]
       }
     },
-    "/ratelimit.v1.RatelimitService/Ratelimit": {
+    "/v1/ratelimit.limit": {
       "post": {
-        "operationId": "ratelimit.v1.ratelimit",
+        "operationId": "v1.ratelimit.limit",
         "requestBody": {
           "content": {
             "application/json": {

deployment/docker-compose.yaml

@@ -31,6 +31,23 @@ services:
     ports:
       - 3900:3900
 
+  apiv2:
+    deploy:
+      replicas: 1
+      endpoint_mode: vip
+
+    command:  [ "api", "--config", "config.docker.json"]
+    build:
+      context: ../go
+      dockerfile: ./Dockerfile
+    depends_on:
+      - mysql
+      - clickhouse
+    environment:
+      PORT: 8080
+      DATABASE_PRIMARY_DSN: "mysql://unkey:password@tcp(mysql:3900)/unkey"
+      CLICKHOUSE_URL: "clickhouse://default:password@clickhouse:9000"
+
   agent:
     deploy:
       replicas: 3

go/Dockerfile

@@ -0,0 +1,20 @@
+FROM golang:1.23-alpine AS builder
+
+
+
+WORKDIR /go/src/github.com/unkeyed/unkey/go
+COPY go.sum go.mod ./
+RUN go mod download
+
+COPY . .
+ARG VERSION
+RUN go build -o bin/unkey -ldflags "-X 'github.com/unkeyed/unkey/go/pkg/version.Version=${VERSION}'"  ./cmd/main.go
+
+FROM golang:1.23-alpine
+WORKDIR  /usr/local/bin
+COPY --from=builder /go/src/github.com/unkeyed/unkey/go/bin/unkey .
+COPY --from=builder /go/src/github.com/unkeyed/unkey/go/config.local.json .
+COPY --from=builder /go/src/github.com/unkeyed/unkey/go/config.docker.json .
+COPY --from=builder /go/src/github.com/unkeyed/unkey/go/pkg/openapi/openapi.json ./pkg/openapi/openapi.json
+
+ENTRYPOINT [ "/usr/local/bin/unkey"]

go/Taskfile.yml

@@ -0,0 +1,22 @@
+version: '3'
+
+tasks:
+  install:
+    cmd:
+      go mod tidy
+  fmt:
+    cmds:
+      - go fmt ./...
+      - task: lint
+  test:
+    cmds:
+      - go test -cover -json -failfast ./... | tparse -all -progress
+
+  build:
+    cmds:
+      - go build -o unkey ./cmd/main.go
+
+
+  lint:
+    cmds:
+      - golangci-lint run

go/cmd/api/config.go

@@ -0,0 +1,27 @@
+package api
+
+type nodeConfig struct {
+	Platform string `json:"platform,omitempty" description:"The platform this agent is running on"`
+	NodeId   string `json:"nodeId,omitempty" description:"A unique node id"`
+	Image    string `json:"image,omitempty" description:"The image this agent is running"`
+
+	Schema    string `json:"$schema,omitempty" description:"Make jsonschema happy"`
+	Region    string `json:"region,omitempty" description:"The region this agent is running in"`
+	Port      string `json:"port,omitempty" default:"8080" description:"Port to listen on"`
+	Heartbeat *struct {
+		URL      string `json:"url" minLength:"1" description:"URL to send heartbeat to"`
+		Interval int    `json:"interval" min:"1" description:"Interval in seconds to send heartbeat"`
+	} `json:"heartbeat,omitempty" description:"Send heartbeat to a URL"`
+
+	Clickhouse *struct {
+		Url string `json:"url" minLength:"1"`
+	} `json:"clickhouse,omitempty"`
+
+	Database struct {
+		// DSN of the primary database for reads and writes.
+		Primary string `json:"primary"`
+
+		// An optional read replica DSN.
+		ReadonlyReplica string `json:"readonlyReplica,omitempty"`
+	} `json:"database"`
+}

go/cmd/api/main.go

@@ -0,0 +1,119 @@
+package api
+
+import (
+	"fmt"
+	"log/slog"
+	"os"
+	"os/signal"
+	"runtime/debug"
+	"syscall"
+
+	"github.com/unkeyed/unkey/go/pkg/config"
+	"github.com/unkeyed/unkey/go/pkg/logging"
+	"github.com/unkeyed/unkey/go/pkg/uid"
+	"github.com/unkeyed/unkey/go/pkg/version"
+	"github.com/unkeyed/unkey/go/pkg/zen"
+	"github.com/unkeyed/unkey/go/pkg/zen/validation"
+	"github.com/urfave/cli/v2"
+)
+
+var Cmd = &cli.Command{
+	Name: "api",
+	Flags: []cli.Flag{
+		&cli.StringFlag{
+			Name:        "config",
+			Aliases:     []string{"c"},
+			Usage:       "Load configuration file",
+			Value:       "unkey.json",
+			DefaultText: "unkey.json",
+			EnvVars:     []string{"AGENT_CONFIG_FILE"},
+		},
+	},
+	Action: run,
+}
+
+func run(c *cli.Context) error {
+	configFile := c.String("config")
+
+	cfg := nodeConfig{}
+	err := config.LoadFile(&cfg, configFile)
+	if err != nil {
+		return err
+	}
+
+	if cfg.NodeId == "" {
+		cfg.NodeId = uid.Node()
+
+	}
+
+	if cfg.Region == "" {
+		cfg.Region = "unknown"
+	}
+	logger := logging.New(logging.Config{Development: true})
+	logger = logger.With(
+
+		slog.String("nodeId", cfg.NodeId),
+		slog.String("platform", cfg.Platform),
+		slog.String("region", cfg.Region),
+		slog.String("version", version.Version),
+	)
+
+	// Catch any panics now after we have a logger but before we start the server
+	defer func() {
+		if r := recover(); r != nil {
+			logger.Error(c.Context, "panic",
+				slog.Any("panic", r),
+				slog.String("stack", string(debug.Stack())),
+			)
+		}
+	}()
+
+	logger.Info(c.Context, "configration loaded", slog.String("file", configFile))
+
+	srv, err := zen.New(zen.Config{
+		NodeId:     cfg.NodeId,
+		Logger:     logger,
+		Clickhouse: nil,
+	})
+	if err != nil {
+		return err
+	}
+
+	validator, err := validation.New()
+	if err != nil {
+		return err
+	}
+
+	srv.SetGlobalMiddleware(
+		// metrics should always run first, so it can capture the latency of the entire request
+		zen.WithMetrics(nil), // TODO: add eventbuffer
+		zen.WithLogging(logger),
+		zen.WithErrorHandling(),
+		zen.WithValidation(validator),
+	)
+
+	go func() {
+		listenErr := srv.Listen(c.Context, fmt.Sprintf(":%s", cfg.Port))
+		if listenErr != nil {
+			panic(listenErr)
+		}
+	}()
+
+	cShutdown := make(chan os.Signal, 1)
+	signal.Notify(cShutdown, os.Interrupt, syscall.SIGTERM)
+
+	<-cShutdown
+	logger.Info(c.Context, "shutting down")
+
+	return nil
+}
+
+// TODO: generating this every time is a bit stupid, we should make this its own command
+//
+//	and then run it as part of the build process
+func init() {
+	_, err := config.GenerateJsonSchema(nodeConfig{}, "schema.json")
+	if err != nil {
+		panic(err)
+	}
+}

go/cmd/main.go

@@ -0,0 +1,40 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/Southclaws/fault"
+	"github.com/unkeyed/unkey/go/cmd/api"
+	"github.com/urfave/cli/v2"
+)
+
+func main() {
+	app := &cli.App{
+		Name:  "unkey",
+		Usage: "Run unkey ",
+
+		Commands: []*cli.Command{
+			api.Cmd,
+		},
+	}
+
+	err := app.Run(os.Args)
+	if err != nil {
+		chain := fault.Flatten(err)
+
+		fmt.Println()
+		fmt.Println()
+
+		for _, e := range chain {
+			fmt.Printf(" - ")
+			if e.Location != "" {
+				fmt.Printf("%s\n", e.Location)
+				fmt.Printf("    > ")
+			}
+			fmt.Printf("%s\n", e.Message)
+		}
+		fmt.Println()
+		os.Exit(1)
+	}
+}

go/config.docker.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "schema.json",
+  "port": "8080",
+  "nodeId": "node_1",
+  "database": {
+    "primary": "mysql://"
+  }
+}

go/config.local.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "schema.json",
+  "port": "8080",
+  "nodeId": "node_1",
+  "database": {
+    "primary": "${DATABASE_PRIMARY_DSN}"
+  }
+}