feat: add grpc gateway

Makefile

@@ -3,6 +3,10 @@ GOVERSION := $(shell go version | cut -d ' ' -f 3 | cut -d '.' -f 2)
 .PHONY: build check fmt lint test test-race vet test-cover-html help install proto
 .DEFAULT_GOAL := build
 
+install:
+	@echo "Clean up imports..."
+	@go mod download
+
 build: ## build all
 	CGO_ENABLED=0 go build -o shield .
 
@@ -28,13 +32,3 @@ proto:
 help:
 	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 
-install: ## install required dependencies
-	@echo "> installing dependencies"
-	go get google.golang.org/protobuf/cmd/[email protected]
-	go get github.com/golang/protobuf/[email protected]
-	go get github.com/golang/protobuf/[email protected]
-	go get google.golang.org/[email protected]
-	go get google.golang.org/grpc/cmd/[email protected]
-	go get github.com/grpc-ecosystem/grpc-gateway/v2/[email protected]
-	go get github.com/grpc-ecosystem/grpc-gateway/v2/[email protected]
-	go get github.com/bufbuild/buf/cmd/[email protected]

api/handler/handler.go

@@ -0,0 +1,25 @@
+package handler
+
+import (
+	"context"
+	"fmt"
+	"net/http"
+
+	"github.com/odpf/salt/server"
+	v1 "github.com/odpf/shield/api/handler/v1"
+)
+
+type Deps struct {
+	V1 v1.Dep
+}
+
+func Register(ctx context.Context, s *server.MuxServer, gw *server.GRPCGateway, deps Deps) {
+	s.RegisterHandler("/ping", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		fmt.Fprintf(w, "pong")
+	}))
+
+	// grpc gateway api will have version endpoints
+	s.SetGateway("/", gw)
+
+	v1.RegisterV1(ctx, s, gw, deps.V1)
+}

api/handler/v1/group.go

@@ -0,0 +1,30 @@
+package v1
+
+import (
+	"context"
+
+	"google.golang.org/grpc/codes"
+	"google.golang.org/grpc/status"
+
+	shieldv1 "go.buf.build/odpf/gw/odpf/proton/odpf/shield/v1"
+)
+
+func (v Dep) ListGroups(ctx context.Context, request *shieldv1.ListGroupsRequest) (*shieldv1.ListGroupsResponse, error) {
+	return nil, status.Errorf(codes.Unimplemented, "method not implemented")
+}
+
+func (v Dep) CreateGroup(ctx context.Context, request *shieldv1.CreateGroupRequest) (*shieldv1.CreateGroupResponse, error) {
+	return nil, status.Errorf(codes.Unimplemented, "method not implemented")
+}
+
+func (v Dep) GetGroup(ctx context.Context, request *shieldv1.GetGroupRequest) (*shieldv1.GetGroupResponse, error) {
+	return nil, status.Errorf(codes.Unimplemented, "method not implemented")
+}
+
+func (v Dep) ListGroupUsers(ctx context.Context, request *shieldv1.ListGroupUsersRequest) (*shieldv1.ListGroupUsersResponse, error) {
+	return nil, status.Errorf(codes.Unimplemented, "method not implemented")
+}
+
+func (v Dep) UpdateGroup(ctx context.Context, request *shieldv1.UpdateGroupRequest) (*shieldv1.UpdateGroupResponse, error) {
+	return nil, status.Errorf(codes.Unimplemented, "method not implemented")
+}

api/handler/v1/org.go

@@ -0,0 +1,26 @@
+package v1
+
+import (
+	"context"
+
+	"google.golang.org/grpc/codes"
+	"google.golang.org/grpc/status"
+
+	shieldv1 "go.buf.build/odpf/gw/odpf/proton/odpf/shield/v1"
+)
+
+func (v Dep) ListOrganizations(ctx context.Context, request *shieldv1.ListOrganizationsRequest) (*shieldv1.ListOrganizationsResponse, error) {
+	return nil, status.Errorf(codes.Unimplemented, "method not implemented")
+}
+
+func (v Dep) CreateOrganization(ctx context.Context, request *shieldv1.CreateOrganizationRequest) (*shieldv1.CreateOrganizationResponse, error) {
+	return nil, status.Errorf(codes.Unimplemented, "method not implemented")
+}
+
+func (v Dep) GetOrganization(ctx context.Context, request *shieldv1.GetOrganizationRequest) (*shieldv1.GetOrganizationResponse, error) {
+	return nil, status.Errorf(codes.Unimplemented, "method not implemented")
+}
+
+func (v Dep) UpdateOrganization(ctx context.Context, request *shieldv1.UpdateOrganizationRequest) (*shieldv1.UpdateOrganizationResponse, error) {
+	return nil, status.Errorf(codes.Unimplemented, "method not implemented")
+}

api/handler/v1/project.go

@@ -0,0 +1,26 @@
+package v1
+
+import (
+	"context"
+
+	"google.golang.org/grpc/codes"
+	"google.golang.org/grpc/status"
+
+	shieldv1 "go.buf.build/odpf/gw/odpf/proton/odpf/shield/v1"
+)
+
+func (v Dep) ListProjects(ctx context.Context, request *shieldv1.ListProjectsRequest) (*shieldv1.ListProjectsResponse, error) {
+	return nil, status.Errorf(codes.Unimplemented, "method not implemented")
+}
+
+func (v Dep) CreateProject(ctx context.Context, request *shieldv1.CreateProjectRequest) (*shieldv1.CreateProjectResponse, error) {
+	return nil, status.Errorf(codes.Unimplemented, "method not implemented")
+}
+
+func (v Dep) GetProject(ctx context.Context, request *shieldv1.GetProjectRequest) (*shieldv1.GetProjectResponse, error) {
+	return nil, status.Errorf(codes.Unimplemented, "method not implemented")
+}
+
+func (v Dep) UpdateProject(ctx context.Context, request *shieldv1.UpdateProjectRequest) (*shieldv1.UpdateProjectResponse, error) {
+	return nil, status.Errorf(codes.Unimplemented, "method not implemented")
+}

api/handler/v1/role.go

@@ -0,0 +1,26 @@
+package v1
+
+import (
+	"context"
+
+	"google.golang.org/grpc/codes"
+	"google.golang.org/grpc/status"
+
+	shieldv1 "go.buf.build/odpf/gw/odpf/proton/odpf/shield/v1"
+)
+
+func (v Dep) ListRoles(ctx context.Context, request *shieldv1.ListRolesRequest) (*shieldv1.ListRolesResponse, error) {
+	return nil, status.Errorf(codes.Unimplemented, "method not implemented")
+}
+
+func (v Dep) CreateRole(ctx context.Context, request *shieldv1.CreateRoleRequest) (*shieldv1.CreateRoleResponse, error) {
+	return nil, status.Errorf(codes.Unimplemented, "method not implemented")
+}
+
+func (v Dep) GetRole(ctx context.Context, request *shieldv1.GetRoleRequest) (*shieldv1.GetRoleResponse, error) {
+	return nil, status.Errorf(codes.Unimplemented, "method not implemented")
+}
+
+func (v Dep) UpdateRole(ctx context.Context, request *shieldv1.UpdateRoleRequest) (*shieldv1.UpdateRoleResponse, error) {
+	return nil, status.Errorf(codes.Unimplemented, "method not implemented")
+}

api/handler/v1/user.go

@@ -0,0 +1,34 @@
+package v1
+
+import (
+	"context"
+
+	"google.golang.org/grpc/codes"
+	"google.golang.org/grpc/status"
+
+	shieldv1 "go.buf.build/odpf/gw/odpf/proton/odpf/shield/v1"
+)
+
+func (v Dep) ListUsers(ctx context.Context, request *shieldv1.ListUsersRequest) (*shieldv1.ListUsersResponse, error) {
+	return nil, status.Errorf(codes.Unimplemented, "method not implemented")
+}
+
+func (v Dep) CreateUser(ctx context.Context, request *shieldv1.CreateUserRequest) (*shieldv1.CreateUserResponse, error) {
+	return nil, status.Errorf(codes.Unimplemented, "method not implemented")
+}
+
+func (v Dep) GetUser(ctx context.Context, request *shieldv1.GetUserRequest) (*shieldv1.GetUserResponse, error) {
+	panic("get user was called")
+}
+
+func (v Dep) GetCurrentUser(ctx context.Context, request *shieldv1.GetCurrentUserRequest) (*shieldv1.GetCurrentUserResponse, error) {
+	panic("get CURRENT user was called")
+}
+
+func (v Dep) UpdateUser(ctx context.Context, request *shieldv1.UpdateUserRequest) (*shieldv1.UpdateUserResponse, error) {
+	return nil, status.Errorf(codes.Unimplemented, "method not implemented")
+}
+
+func (v Dep) UpdateCurrentUser(ctx context.Context, request *shieldv1.UpdateCurrentUserRequest) (*shieldv1.UpdateCurrentUserResponse, error) {
+	return nil, status.Errorf(codes.Unimplemented, "method not implemented")
+}

api/handler/v1/v1.go

@@ -0,0 +1,22 @@
+package v1
+
+import (
+	"context"
+
+	"github.com/odpf/salt/server"
+
+	shieldv1 "go.buf.build/odpf/gw/odpf/proton/odpf/shield/v1"
+)
+
+type Dep struct {
+	shieldv1.UnimplementedShieldServiceServer
+}
+
+func RegisterV1(ctx context.Context, s *server.MuxServer, gw *server.GRPCGateway, dep Dep) {
+	gw.RegisterHandler(ctx, shieldv1.RegisterShieldServiceHandlerFromEndpoint)
+
+	s.RegisterService(
+		&shieldv1.ShieldService_ServiceDesc,
+		&dep,
+	)
+}

cmd/serve.go

@@ -12,6 +12,6 @@ func serveCommand(logger log.Logger, appConfig *config.Shield) *cli.Command {
 		Short: "Start server and proxy default on port 8080",
 	}
 	c.AddCommand(proxyCommand(logger, appConfig))
-	c.AddCommand(adminCommand())
+	c.AddCommand(apiCommand(logger, appConfig))
 	return c
 }

cmd/serve_api.go

@@ -0,0 +1,52 @@
+package cmd
+
+import (
+	"context"
+	"time"
+
+	"github.com/odpf/salt/log"
+	"github.com/odpf/salt/server"
+	"github.com/odpf/shield/api/handler"
+	v1 "github.com/odpf/shield/api/handler/v1"
+	"github.com/odpf/shield/config"
+	cli "github.com/spf13/cobra"
+)
+
+func apiCommand(logger log.Logger, appConfig *config.Shield) *cli.Command {
+	c := &cli.Command{
+		Use:     "api",
+		Short:   "Start shield api server",
+		Example: "shield serve api",
+		RunE: func(c *cli.Command, args []string) error {
+			ctx, cancelFunc := context.WithCancel(server.HandleSignals(context.Background()))
+			defer cancelFunc()
+
+			s, err := server.NewMux(server.Config{
+				Port: appConfig.App.Port,
+			}, server.WithMuxGRPCServerOptions(getGRPCMiddleware(appConfig, logger)))
+			if err != nil {
+				panic(err)
+			}
+
+			gw, err := server.NewGateway("", appConfig.App.Port)
+			if err != nil {
+				panic(err)
+			}
+
+			handler.Register(ctx, s, gw, handler.Deps{
+				V1: v1.Dep{},
+			})
+
+			go s.Serve()
+			<-ctx.Done()
+
+			shutdownCtx, shutdownCancel := context.WithTimeout(context.Background(), time.Second*10)
+			defer shutdownCancel()
+
+			s.Shutdown(shutdownCtx)
+
+			return nil
+		},
+	}
+	return c
+}

cmd/setup.go

@@ -0,0 +1,38 @@
+package cmd
+
+import (
+	"go.uber.org/zap"
+
+	"google.golang.org/grpc"
+
+	grpcMiddleware "github.com/grpc-ecosystem/go-grpc-middleware"
+	grpczap "github.com/grpc-ecosystem/go-grpc-middleware/logging/zap"
+	grpcRecovery "github.com/grpc-ecosystem/go-grpc-middleware/recovery"
+	grpcctxtags "github.com/grpc-ecosystem/go-grpc-middleware/tags"
+	newrelic "github.com/newrelic/go-agent"
+	"github.com/newrelic/go-agent/_integrations/nrgrpc"
+	"github.com/odpf/salt/log"
+	"github.com/odpf/shield/config"
+)
+
+func setupNewRelic(cfg config.NewRelic, logger log.Logger) newrelic.Application {
+	nrCfg := newrelic.NewConfig(cfg.AppName, cfg.License)
+	nrCfg.Enabled = cfg.Enabled
+
+	nrApp, err := newrelic.NewApplication(nrCfg)
+	if err != nil {
+		logger.Fatal("failed to load Newrelic Application")
+	}
+	return nrApp
+}
+
+// REVISIT: passing config.Shield as reference
+func getGRPCMiddleware(cfg *config.Shield, logger log.Logger) grpc.ServerOption {
+	return grpc.UnaryInterceptor(
+		grpcMiddleware.ChainUnaryServer(
+			grpcRecovery.UnaryServerInterceptor(),
+			grpcctxtags.UnaryServerInterceptor(),
+			grpczap.UnaryServerInterceptor(zap.NewExample()),
+			nrgrpc.UnaryServerInterceptor(setupNewRelic(cfg.NewRelic, logger)),
+		))
+}