feat: update how report backend works

Author: tobidae-cb

.gitignore

@@ -1,6 +1,6 @@
 .DS_Store
 /.idea/
-/bin/
+**/bin/
 data-dir/
 output/
 .vercel

Makefile

@@ -19,6 +19,9 @@ LDFLAGSSTRING +=-X main.GitDate=$(GITDATE)
 LDFLAGSSTRING +=-X main.Version=$(VERSION)
 LDFLAGS := -ldflags "$(LDFLAGSSTRING)"
 
+# Include .env file if it exists
+-include .env
+
 # first so that make defaults to building the benchmark
 .PHONY: build
 build:
@@ -50,3 +53,19 @@ build-rbuilder:
 
 .PHONY: build-binaries
 build-binaries: build-reth build-geth build-rbuilder
+
+.PHONY: build-backend
+build-backend:
+	cd report/backend && env GO111MODULE=on GOOS=$(TARGETOS) GOARCH=$(TARGETARCH) CGO_ENABLED=0 go build -v $(LDFLAGS) -o ../../bin/base-bench-api cmd/main.go
+
+.PHONY: run-backend
+run-backend:
+	./bin/base-bench-api --enable-s3=true --s3-bucket ${BASE_BENCH_API_S3_BUCKET}
+
+.PHONY: run-backend
+run-backend:
+	./bin/base-bench-api --s3-bucket ${BASE_BENCH_API_S3_BUCKET}
+
+.PHONY: run-backfill
+run-backfill:
+	./bin/base-bench backfill-benchmark-run-id --enable-s3=true --s3-bucket ${BASE_BENCH_API_S3_BUCKET} metadata.json

benchmark/flags/flags.go

@@ -15,13 +15,14 @@ func prefixEnvVars(name string) []string {
 }
 
 const (
-	ConfigFlagName    = "config"
-	RootDirFlagName   = "root-dir"
-	OutputDirFlagName = "output-dir"
-	EnableS3FlagName  = "enable-s3"
-	S3BucketFlagName  = "s3-bucket"
-	TxFuzzBinFlagName = "tx-fuzz-bin"
-	ProxyPortFlagName = "proxy-port"
+	ConfigFlagName         = "config"
+	RootDirFlagName        = "root-dir"
+	OutputDirFlagName      = "output-dir"
+	EnableS3FlagName       = "enable-s3"
+	S3BucketFlagName       = "s3-bucket"
+	TxFuzzBinFlagName      = "tx-fuzz-bin"
+	ProxyPortFlagName      = "proxy-port"
+	BenchmarkRunIDFlagName = "benchmark-run-id"
 )
 
 // TxFuzz defaults
@@ -77,6 +78,12 @@ var (
 		Usage:   "S3 bucket name for storing benchmark results",
 		EnvVars: prefixEnvVars("S3_BUCKET"),
 	}
+
+	BenchmarkRunIDFlag = &cli.StringFlag{
+		Name:    BenchmarkRunIDFlagName,
+		Usage:   "Custom benchmark run ID (auto-generated if not provided)",
+		EnvVars: prefixEnvVars("BENCHMARK_RUN_ID"),
+	}
 )
 
 // Flags contains the list of configuration options available to the binary.
@@ -90,6 +97,7 @@ var RunFlags = []cli.Flag{
 	ProxyPortFlag,
 	EnableS3Flag,
 	S3BucketFlag,
+	BenchmarkRunIDFlag,
 }
 
 func init() {

report/backend/Dockerfile

@@ -1,40 +1,49 @@
-# Build stage
-FROM golang:1.21-alpine AS builder
-
-# Install build dependencies
-RUN apk add --no-cache git ca-certificates
+FROM ubuntu:22.04 AS base
+
+ENV DEBIAN_FRONTEND=noninteractive
+ENV PATH="/root/.cargo/bin:${PATH}"
+
+# Install system dependencies
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    build-essential \
+    curl \
+    git \
+    make \
+    cmake \
+    pkg-config \
+    libssl-dev \
+    libpq-dev \
+    libclang-dev \
+    ca-certificates \
+    sudo \
+    && rm -rf /var/lib/apt/lists/*
 
 WORKDIR /app
 
-# Copy go mod files
-COPY go.mod go.sum ./
+# Install Go manually using curl
+RUN curl -fsSL https://go.dev/dl/go1.23.0.linux-amd64.tar.gz | tar -C /usr/local -xz
+ENV PATH="/usr/local/go/bin:$PATH"
 
-# Download dependencies
+COPY go.mod go.sum ./
 RUN go mod download
 
-# Copy source code
 COPY . .
+RUN CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o base-bench-api ./cmd/main.go
 
-# Build the application
-RUN CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o main .
+FROM ubuntu:22.04 AS runtime
 
-# Final stage
-FROM alpine:latest
+# Install minimal runtime dependencies
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    ca-certificates && \
+    rm -rf /var/lib/apt/lists/*
 
-# Install ca-certificates for HTTPS requests
-RUN apk --no-cache add ca-certificates
-
-WORKDIR /root/
+WORKDIR /app
 
-# Copy the binary from builder stage
-COPY --from=builder /app/main .
+COPY --from=base /app/base-bench-api .
 
-# Expose port
 EXPOSE 8080
 
-# Health check
 HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \
   CMD wget --no-verbose --tries=1 --spider http://localhost:8080/api/v1/health || exit 1
 
-# Run the binary
-CMD ["./main"] 
+ENTRYPOINT ["./base-bench-api"] 

report/backend/README.md

@@ -0,0 +1,115 @@
+# Benchmark Report API
+
+A Go-based REST API for serving benchmark data from AWS S3 storage.
+
+## Project Structure
+
+This project follows the standard Go project layout:
+
+```
+benchmark/report/backend/
+├── cmd/
+│   └── api/                  # Application entrypoints
+│       └── main.go          # Main application entry point
+├── internal/                # Private application code
+│   ├── config/              # Configuration, middleware, and errors
+│   │   └── config.go        # Config, CORS, logging, and error handling
+│   ├── handlers/            # HTTP handlers
+│   │   ├── health.go        # Health check endpoint
+│   │   ├── metadata.go      # Metadata endpoint handler
+│   │   └── metrics.go       # Metrics endpoint handler
+│   └── services/            # Business logic and data models
+│       ├── cache.go         # In-memory caching with CacheItem model
+│       └── s3.go            # AWS S3 service with Benchmark models
+├── bin/                     # Compiled binaries (gitignored)
+├── flags/                   # CLI flags for the API server
+│   └── flags.go            # Command-line flag definitions
+├── go.mod                   # Go module definition
+├── go.sum                   # Go module checksums
+├── Makefile                 # Build automation
+├── Dockerfile               # Docker container definition
+├── docker-compose.yml       # Docker Compose configuration
+└── README.md               # This file
+```
+
+## Features
+
+- **REST API** for benchmark data retrieval
+- **AWS S3 integration** with intelligent caching
+- **Structured logging** with configurable levels
+- **Health checks** for monitoring
+- **CORS support** for frontend integration
+- **Graceful shutdown** handling
+- **Docker support** for containerized deployment
+
+## Environment Variables
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `PORT` | Server port | `8080` |
+| `S3_BUCKET` | AWS S3 bucket name | **Required** |
+| `AWS_REGION` | AWS region | `us-east-1` |
+| `AWS_ACCESS_KEY_ID` | AWS access key | From AWS credentials |
+| `AWS_SECRET_ACCESS_KEY` | AWS secret key | From AWS credentials |
+| `CACHE_TTL` | Cache time-to-live | `5m` |
+| `ENABLE_CACHE` | Enable/disable caching | `true` |
+| `ALLOWED_ORIGINS` | CORS allowed origins (comma-separated) | `*` |
+| `LOG_LEVEL` | Logging level (debug, info, warn, error) | `info` |
+
+## API Endpoints
+
+### Health Check
+```
+GET /api/v1/health
+```
+Returns the service health status.
+
+### Metadata
+```
+GET /api/v1/metadata
+```
+Returns benchmark run metadata from S3.
+
+### Metrics
+```
+GET /api/v1/metrics/:runId/:outputDir/:nodeType
+```
+Returns metrics data for a specific benchmark run and node type.
+
+## Development
+
+### Prerequisites
+
+- Go 1.23 or later
+- Docker (optional, for containerized development)
+- Make (optional, for build automation)
+
+### Quick Start
+
+1. **Set up environment variables:**
+   ```bash
+   export S3_BUCKET=your-bucket-name
+   export AWS_REGION=us-east-1
+   # ... other environment variables
+   ```
+
+2. **Run in development mode:**
+   ```bash
+   make run-backend
+   ```
+
+## Architecture
+
+### Layers
+
+1. **Handlers Layer** (`internal/handlers/`): HTTP request handling and response formatting
+2. **Services Layer** (`internal/services/`): Business logic, external service integration, and data models
+3. **Configuration Layer** (`internal/config/`): Application configuration, middleware, and error handling
+
+### Key Components
+
+- **S3Service**: Handles AWS S3 interactions with intelligent caching (includes BenchmarkRuns/BenchmarkRun models)
+- **MemoryCache**: Provides in-memory caching with TTL support (includes CacheItem model)
+- **Configuration**: Environment-based configuration with validation, CORS, and logging setup
+- **Handlers**: Clean HTTP handlers following single responsibility principle
+- **Flags**: CLI flag definitions for server configuration