Add loger, tally and renames and decouple the server from controllers

Author: behinddwalls

.envrc

@@ -1,7 +1,4 @@
-GOPATH=$(pwd)
-export GOPATH
 PATH_add tools
 
-
-WORKSPACE_ROOT=$(pwd)
-export WORKSPACE_ROOT
+REPO_ROOT=$(pwd)
+export REPO_ROOT

.github/workflows/build_and_test.yml

@@ -9,7 +9,6 @@ on:
       - opened
       - reopened
       - synchronize
-      - ready_for_review
 
 jobs:
   build-and-test:

.gitignore

@@ -5,6 +5,7 @@ MODULE.bazel.lock
 .vscode/
 .idea/
 .claude/
+.ijwb/
 
 
 # Built binaries

MODULE.bazel

@@ -37,8 +37,10 @@ go_deps.from_file(go_mod = "//:go.mod")
 use_repo(
     go_deps,
     "com_github_gogo_protobuf",
+    "com_github_uber_go_tally_v4",
     "org_golang_google_grpc",
     "org_golang_google_protobuf",
     "org_uber_go_fx",
     "org_uber_go_yarpc",
+    "org_uber_go_zap",
 )

Makefile

@@ -20,19 +20,10 @@ proto:
 	  --proto_path=speculator/proto speculator/proto/speculator.proto
 	@echo "Protobuf files generated successfully!"
 
-# Build all services and examples using Bazel
+# Build everything in the project using Bazel
 build:
-	@echo "Building all services with Bazel..."
-	@$(BAZEL) build //gateway:gateway
-	@$(BAZEL) build //orchestrator:orchestrator
-	@$(BAZEL) build //speculator:speculator
-	@echo "Building example servers and clients..."
-	@$(BAZEL) build //examples/server/gateway:gateway
-	@$(BAZEL) build //examples/server/orchestrator:orchestrator
-	@$(BAZEL) build //examples/server/speculator:speculator
-	@$(BAZEL) build //examples/client/gateway:gateway
-	@$(BAZEL) build //examples/client/orchestrator:orchestrator
-	@$(BAZEL) build //examples/client/speculator:speculator
+	@echo "Building all targets with Bazel..."
+	@$(BAZEL) build //...
 	@echo "Copying binaries to ./bin/..."
 	@mkdir -p bin
 	@cp -f bazel-bin/examples/server/gateway/gateway_/gateway bin/gateway_server 2>/dev/null || \

README.md

@@ -11,9 +11,9 @@ Submit Queue consists of three main services:
 ## gRPC API
 
 Each service has its own proto definitions and exposes its own gRPC API:
-- **GatewayService**: Gateway API with Ping method (port 8081)
-- **OrchestratorService**: Orchestrator API with Ping method (port 8082)
-- **SpeculatorService**: Speculator API with Ping method (port 8083)
+- **SubmitQueueGateway**: Gateway API with Ping method (port 8081)
+- **SubmitQueueOrchestrator**: Orchestrator API with Ping method (port 8082)
+- **SubmitQueueSpeculator**: Speculator API with Ping method (port 8083)
 
 ### Quick Start
 
@@ -41,7 +41,7 @@ make run-client-gateway MESSAGE="hello"
 go run examples/client/gateway/main.go -message "hello"
 
 # Or using grpcurl
-grpcurl -plaintext -d '{"message": "hello"}' localhost:8081 uber.devexp.submitqueue.gateway.GatewayService/Ping
+grpcurl -plaintext -d '{"message": "hello"}' localhost:8081 uber.devexp.submitqueue.gateway.SubmitQueueGateway/Ping
 ```
 
 For detailed instructions, see [examples/README.md](examples/README.md).
@@ -50,6 +50,23 @@ For detailed instructions, see [examples/README.md](examples/README.md).
 
 See [docs/architecture/STRUCTURE.md](docs/architecture/STRUCTURE.md) for a detailed breakdown of the project structure.
 
+## Architecture
+
+The project follows clean architecture principles with clear separation of concerns:
+
+- **Controllers** (`core/controller/`): Pure business logic, independent of transport layer
+  - Only depend on logger, metrics, and protobuf types
+  - Example: `PingController` handles ping business logic
+
+- **Server Adapters** (`examples/server/`): gRPC transport layer
+  - Wrap controllers and implement gRPC service interfaces
+  - Handle protocol-specific concerns (e.g., `UnimplementedServiceServer`)
+
+- **Observability**: Built-in logging and metrics
+  - Structured logging with [Zap](https://github.com/uber-go/zap)
+  - Metrics collection with [Tally](https://github.com/uber-go/tally)
+  - Development servers use human-readable console logging
+
 ## Development
 
 ### Prerequisites
@@ -159,7 +176,6 @@ bazel build //...
 
 # Build specific components
 bazel build //gateway/protopb
-bazel build //gateway:gateway
 bazel build //examples/server/gateway:gateway
 bazel build //examples/client/gateway:gateway
 
@@ -226,7 +242,8 @@ message PingResponse {
     string message = 1;
     string service_name = 2;
     int64 timestamp = 3;
-    string hostname = 4;  // New field added
+    string hostname = 4;
+    string new_field = 5;  // New field added
 }
 ```
 
@@ -240,8 +257,8 @@ make proto
 # - gateway/protopb/gateway_grpc.pb.go
 # - gateway/protopb/gateway.pb.yarpc.go
 
-# Now update the service implementation
-# Edit gateway/core/controller/ping.go to populate the hostname field
+# Now update the controller implementation
+# Edit gateway/core/controller/ping.go to populate the new field in the PingResponse
 ```
 
 ### Testing
@@ -261,7 +278,7 @@ make proto
 3. **Or use grpcurl:**
    ```bash
    grpcurl -plaintext -d '{"message": "hello"}' \
-     localhost:8081 uber.devexp.submitqueue.gateway.GatewayService/Ping
+     localhost:8081 uber.devexp.submitqueue.gateway.SubmitQueueGateway/Ping
    ```
 
 #### Testing All Services
@@ -299,7 +316,7 @@ make test
 1. **Update the proto file:**
    ```protobuf
    // In gateway/proto/gateway.proto
-   service GatewayService {
+   service SubmitQueueGateway {
        rpc Ping(PingRequest) returns (PingResponse) {}
        rpc NewMethod(NewRequest) returns (NewResponse) {}  // Add new method
    }
@@ -313,17 +330,44 @@ make test
    make proto
    ```
 
-3. **Implement the method in the service:**
+3. **Implement the method in the controller:**
+   ```go
+   // In gateway/core/controller/ (create a new controller file)
+   type NewController struct {
+       logger       *zap.Logger
+       metricsScope tally.Scope
+   }
+
+   func NewNewController(logger *zap.Logger, scope tally.Scope) *NewController {
+       if logger == nil {
+           logger = zap.NewNop()
+       }
+       if scope == nil {
+           scope = tally.NoopScope
+       }
+       return &NewController{logger: logger, metricsScope: scope}
+   }
+
+   func (c *NewController) NewMethod(ctx context.Context, req *pb.NewRequest) (*pb.NewResponse, error) {
+       // Business logic here
+       c.logger.Info("new method called")
+       c.metricsScope.Counter("new_method_total").Inc(1)
+       // ...
+   }
+   ```
+
+4. **Create server wrapper in example:**
    ```go
-   // In gateway/core/controller/ping.go (or create a new file)
-   func (s *PingServiceImpl) NewMethod(ctx context.Context, req *pb.NewRequest) (*pb.NewResponse, error) {
-       // Implementation here
+   // In examples/server/gateway/main.go
+   // Add method delegation to GatewayServer struct:
+   func (s *GatewayServer) NewMethod(ctx context.Context, req *pb.NewRequest) (*pb.NewResponse, error) {
+       return s.newController.NewMethod(ctx, req)
    }
    ```
 
-4. **Update clients to call the new method**
+5. **Update clients to call the new method**
 
-5. **Rebuild and test:**
+6. **Rebuild and test:**
    ```bash
    make build
    ```

examples/README.md

@@ -6,9 +6,9 @@ This directory contains example gRPC servers and clients for each service in the
 
 Each service has its own proto definitions and gRPC API:
 
-- **Gateway**: GatewayService API (port 8081)
-- **Orchestrator**: OrchestratorService API (port 8082)
-- **Speculator**: SpeculatorService API (port 8083)
+- **SubmitQueueGateway**: Gateway API (port 8081)
+- **SubmitQueueOrchestrator**: Orchestrator API (port 8082)
+- **SubmitQueueSpeculator**: Speculator API (port 8083)
 
 ## Building and Running
 
@@ -141,13 +141,13 @@ go install github.com/fullstorydev/grpcurl/cmd/grpcurl@latest
 Test the ping service:
 ```bash
 # Test gateway (port 8081)
-grpcurl -plaintext -d '{"message": "hello"}' localhost:8081 uber.devexp.submitqueue.gateway.GatewayService/Ping
+grpcurl -plaintext -d '{"message": "hello"}' localhost:8081 uber.devexp.submitqueue.gateway.SubmitQueueGateway/Ping
 
 # Test orchestrator (port 8082)
-grpcurl -plaintext -d '{"message": "hello"}' localhost:8082 uber.devexp.submitqueue.orchestrator.OrchestratorService/Ping
+grpcurl -plaintext -d '{"message": "hello"}' localhost:8082 uber.devexp.submitqueue.orchestrator.SubmitQueueOrchestrator/Ping
 
 # Test speculator (port 8083)
-grpcurl -plaintext -d '{"message": "hello"}' localhost:8083 uber.devexp.submitqueue.speculator.SpeculatorService/Ping
+grpcurl -plaintext -d '{"message": "hello"}' localhost:8083 uber.devexp.submitqueue.speculator.SubmitQueueSpeculator/Ping
 ```
 
 List available services:
@@ -159,9 +159,9 @@ grpcurl -plaintext localhost:8083 list
 
 Describe a service:
 ```bash
-grpcurl -plaintext localhost:8081 describe uber.devexp.submitqueue.gateway.GatewayService
-grpcurl -plaintext localhost:8082 describe uber.devexp.submitqueue.orchestrator.OrchestratorService
-grpcurl -plaintext localhost:8083 describe uber.devexp.submitqueue.speculator.SpeculatorService
+grpcurl -plaintext localhost:8081 describe uber.devexp.submitqueue.gateway.SubmitQueueGateway
+grpcurl -plaintext localhost:8082 describe uber.devexp.submitqueue.orchestrator.SubmitQueueOrchestrator
+grpcurl -plaintext localhost:8083 describe uber.devexp.submitqueue.speculator.SubmitQueueSpeculator
 ```
 
 ## API Reference
@@ -172,17 +172,17 @@ Each service exposes a Ping method with the same request/response structure but
 
 #### Gateway Service
 
-**Service**: `uber.devexp.submitqueue.gateway.GatewayService`
+**Service**: `uber.devexp.submitqueue.gateway.SubmitQueueGateway`
 **Proto**: `gateway/proto/gateway.proto`
 
 #### Orchestrator Service
 
-**Service**: `uber.devexp.submitqueue.orchestrator.OrchestratorService`
+**Service**: `uber.devexp.submitqueue.orchestrator.SubmitQueueOrchestrator`
 **Proto**: `orchestrator/proto/orchestrator.proto`
 
 #### Speculator Service
 
-**Service**: `uber.devexp.submitqueue.speculator.SpeculatorService`
+**Service**: `uber.devexp.submitqueue.speculator.SubmitQueueSpeculator`
 **Proto**: `speculator/proto/speculator.proto`
 
 ### Ping Method
@@ -205,7 +205,7 @@ message PingResponse {
 
 **Example:**
 ```bash
-grpcurl -plaintext -d '{"message": "test"}' localhost:8081 uber.devexp.submitqueue.gateway.GatewayService/Ping
+grpcurl -plaintext -d '{"message": "test"}' localhost:8081 uber.devexp.submitqueue.gateway.SubmitQueueGateway/Ping
 ```
 
 Expected response:
@@ -249,7 +249,7 @@ import (
 
 // Use the clients
 conn, _ := grpc.NewClient("localhost:8081", grpc.WithTransportCredentials(insecure.NewCredentials()))
-client := gatewaypb.NewGatewayServiceClient(conn)
+client := gatewaypb.NewSubmitQueueGatewayClient(conn)
 resp, _ := client.Ping(context.Background(), &gatewaypb.PingRequest{Message: "hello"})
 ```
 

examples/client/gateway/main.go

@@ -36,7 +36,7 @@ func run(addr, message string, timeout time.Duration) error {
 	defer conn.Close()
 
 	// Create a client
-	client := pb.NewGatewayServiceClient(conn)
+	client := pb.NewSubmitQueueGatewayClient(conn)
 
 	// Create context with timeout
 	ctx, cancel := context.WithTimeout(context.Background(), timeout)

examples/client/orchestrator/main.go

@@ -36,7 +36,7 @@ func run(addr, message string, timeout time.Duration) error {
 	defer conn.Close()
 
 	// Create a client
-	client := pb.NewOrchestratorServiceClient(conn)
+	client := pb.NewSubmitQueueOrchestratorClient(conn)
 
 	// Create context with timeout
 	ctx, cancel := context.WithTimeout(context.Background(), timeout)

examples/client/speculator/main.go

@@ -36,7 +36,7 @@ func run(addr, message string, timeout time.Duration) error {
 	defer conn.Close()
 
 	// Create a client
-	client := pb.NewSpeculatorServiceClient(conn)
+	client := pb.NewSubmitQueueSpeculatorClient(conn)
 
 	// Create context with timeout
 	ctx, cancel := context.WithTimeout(context.Background(), timeout)