Merge pull request #2 from fiuskyws/feat/poc-release-1

PoC - Release 1

.gitignore

@@ -13,3 +13,6 @@
 
 # Dependency directories (remove the comment below to include it)
 # vendor/
+
+# Generated proto file
+src/proto/*

.proto/pegasus.proto

@@ -0,0 +1,67 @@
+syntax = "proto3";
+
+package proto;
+option go_package = "/proto";
+
+service Pegasus {
+  rpc CreateTopic(CreateTopicRequest) returns (CreateTopicResponse);
+  rpc GetTopics(GetTopicsRequest) returns (GetTopicsResponse);
+
+  rpc Send(SendRequest) returns (SendResponse);
+  rpc Pop(PopRequest) returns (PopResponse);
+
+  rpc Consumer(ConsumerRequest) returns (stream ConsumerResponse);
+  rpc Producer(stream ProducerRequest) returns (stream ProducerResponse);
+}
+
+message GetTopicsRequest {}
+message GetTopicsResponse {
+  repeated string topics = 1;
+}
+
+message CreateTopicRequest {
+  string name = 1;
+}
+
+message CreateTopicResponse {
+  string error = 1;
+}
+
+message ConsumerRequest {
+  string topic_name = 1;
+}
+
+message ConsumerResponse {
+  string topic_name = 1;
+  string body = 2;
+}
+
+message ProducerRequest {
+  string topic_name = 1;
+  string body = 2;
+}
+
+message ProducerResponse {
+  string message = 1;
+  string error = 2;
+}
+
+message SendRequest {
+  string topic_name = 1;
+  string body = 2;
+}
+
+message SendResponse {
+  string message = 1;
+  string error = 2;
+}
+
+message PopRequest {
+  string topic_name = 1;
+}
+
+message PopResponse {
+  string topic_name = 1;
+  string body = 2;
+  string error = 3;
+}

Makefile

@@ -0,0 +1,18 @@
+main=cmd/main.go
+
+test:
+# the '@' suppress the command echo
+	@go test ./...
+
+test-v:
+# the '@' suppress the command echo
+	@go test -v ./...
+
+run:
+# the '@' suppress the command echo
+	@go run $(main)
+
+proto:
+	protoc --go_out=./src/ \
+    --go-grpc_out=./src/ \
+    .proto/pegasus.proto

README.md

@@ -1,2 +1,15 @@
 # pegasus
 Simple Message Broker service written in Go.
+
+## TODO:
+
+### POC Release 1
+- [x] Pub/Sub Logic
+- [x] Server
+- [x] Makefile:
+    - [x] `run`
+    - [x] `test`
+
+## Disclaimer
+
+This repository still in research and `PoC's` phase, meaning, it is NOT ready to be used in production environments. (if it'll be)

cmd/main.go

@@ -0,0 +1,7 @@
+package main
+
+import "fmt"
+
+func main() {
+	fmt.Println("Hey, we're doing something :D !!!")
+}

cmd/server/main.go

@@ -0,0 +1,56 @@
+package main
+
+import (
+	"os"
+	"os/signal"
+	"syscall"
+
+	"github.com/fiuskyws/pegasus/src/manager"
+	"github.com/fiuskyws/pegasus/src/server"
+	"go.uber.org/zap"
+)
+
+var (
+	port   = uint(8090)
+	topics = []string{
+		"topic-1", "topic-2",
+	}
+)
+
+func main() {
+	l, err := zap.NewProduction()
+	if err != nil {
+		panic(err)
+	}
+
+	// TODO:
+	// 	- Remove this implementation, MUST NOT use `ReplaceGlobals`
+	undo := zap.ReplaceGlobals(l)
+	defer undo()
+
+	exit := make(chan os.Signal, 1)
+
+	signal.Notify(exit, syscall.SIGTERM, syscall.SIGINT)
+
+	m := manager.NewManager()
+
+	for _, topic := range topics {
+		if err := m.NewTopic(topic); err != nil {
+			zap.L().Panic(err.Error())
+		}
+	}
+
+	g := server.NewGRPC(m)
+
+	go func() {
+		if err := g.Start(port); err != nil {
+			zap.L().Panic(err.Error())
+		}
+	}()
+
+	<-exit
+
+	if err := g.Close(); err != nil {
+		zap.L().Panic(err.Error())
+	}
+}

go.mod

@@ -0,0 +1,24 @@
+module github.com/fiuskyws/pegasus
+
+go 1.20
+
+require (
+	github.com/google/uuid v1.3.0
+	github.com/stretchr/testify v1.8.2
+	go.uber.org/zap v1.24.0
+	google.golang.org/grpc v1.54.0
+	google.golang.org/protobuf v1.30.0
+)
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/golang/protobuf v1.5.2 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	go.uber.org/atomic v1.7.0 // indirect
+	go.uber.org/multierr v1.6.0 // indirect
+	golang.org/x/net v0.8.0 // indirect
+	golang.org/x/sys v0.6.0 // indirect
+	golang.org/x/text v0.8.0 // indirect
+	google.golang.org/genproto v0.0.0-20230110181048-76db0878b65f // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)

go.sum

@@ -0,0 +1,49 @@
+github.com/benbjohnson/clock v1.1.0 h1:Q92kusRqC1XV2MjkWETPvjJVqKetz1OzxZB7mHJLju8=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=
+github.com/golang/protobuf v1.5.2 h1:ROPKBNFfQgOUMifHyP+KYbvpjbdoFNs+aK7DXlji0Tw=
+github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY=
+github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
+github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
+github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
+github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
+github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
+github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
+github.com/stretchr/testify v1.8.2 h1:+h33VjcLVPDHtOdpUCuF+7gSuG3yGIftsP1YvFihtJ8=
+github.com/stretchr/testify v1.8.2/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
+go.uber.org/atomic v1.7.0 h1:ADUqmZGgLDDfbSL9ZmPxKTybcoEYHgpYfELNoN+7hsw=
+go.uber.org/atomic v1.7.0/go.mod h1:fEN4uk6kAWBTFdckzkM89CLk9XfWZrxpCo0nPH17wJc=
+go.uber.org/goleak v1.1.11 h1:wy28qYRKZgnJTxGxvye5/wgWr1EKjmUDGYox5mGlRlI=
+go.uber.org/multierr v1.6.0 h1:y6IPFStTAIT5Ytl7/XYmHvzXQ7S3g/IeZW9hyZ5thw4=
+go.uber.org/multierr v1.6.0/go.mod h1:cdWPpRnG4AhwMwsgIHip0KRBQjJy5kYEpYjJxpXp9iU=
+go.uber.org/zap v1.24.0 h1:FiJd5l1UOLj0wCgbSE0rwwXHzEdAZS6hiiSnxJN/D60=
+go.uber.org/zap v1.24.0/go.mod h1:2kMP+WWQ8aoFoedH3T2sq6iJ2yDWpHbP0f6MQbS9Gkg=
+golang.org/x/net v0.8.0 h1:Zrh2ngAOFYneWTAIAPethzeaQLuHwhuBkuV6ZiRnUaQ=
+golang.org/x/net v0.8.0/go.mod h1:QVkue5JL9kW//ek3r6jTKnTFis1tRmNAW2P1shuFdJc=
+golang.org/x/sys v0.6.0 h1:MVltZSvRTcU2ljQOhs94SXPftV6DCNnZViHeQps87pQ=
+golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/text v0.8.0 h1:57P1ETyNKtuIjB4SRd15iJxuhj8Gc416Y78H3qgMh68=
+golang.org/x/text v0.8.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8=
+golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+google.golang.org/genproto v0.0.0-20230110181048-76db0878b65f h1:BWUVssLB0HVOSY78gIdvk1dTVYtT1y8SBWtPYuTJ/6w=
+google.golang.org/genproto v0.0.0-20230110181048-76db0878b65f/go.mod h1:RGgjbofJ8xD9Sq1VVhDM1Vok1vRONV+rg+CjzG4SZKM=
+google.golang.org/grpc v1.54.0 h1:EhTqbhiYeixwWQtAEZAxmV9MGqcjEU2mFx52xCzNyag=
+google.golang.org/grpc v1.54.0/go.mod h1:PUSEXI6iWghWaB6lXM4knEgpJNu2qUcKfDtNci3EC2g=
+google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
+google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
+google.golang.org/protobuf v1.30.0 h1:kPPoIgf3TsEvrm0PFe15JQ+570QVxYzEvvHqChK+cng=
+google.golang.org/protobuf v1.30.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

src/client/client.go

@@ -0,0 +1,12 @@
+package client
+
+import "github.com/fiuskyws/pegasus/src/proto"
+
+type (
+	Client interface {
+		Connect()
+		Close() error
+		Ping() error
+		GetClient() proto.PegasusClient
+	}
+)

src/client/grpc.go

@@ -0,0 +1,45 @@
+package client
+
+import (
+	"context"
+
+	"github.com/fiuskyws/pegasus/src/proto"
+	"go.uber.org/zap"
+	"google.golang.org/grpc"
+)
+
+type (
+	gRPC struct {
+		conn   *grpc.ClientConn
+		client proto.PegasusClient
+	}
+)
+
+func NewGRPC(target string) Client {
+	conn, err := grpc.Dial(target)
+	if err != nil {
+		zap.L().Panic(err.Error())
+	}
+	client := proto.NewPegasusClient(conn)
+	return &gRPC{
+		conn:   conn,
+		client: client,
+	}
+}
+
+// TODO:
+//   - Implement a REAL Client, not just this $hit
+func (g *gRPC) GetClient() proto.PegasusClient {
+	return g.client
+}
+
+func (g *gRPC) Ping() error {
+	_, err := g.client.GetTopics(context.Background(), &proto.GetTopicsRequest{})
+	return err
+}
+
+func (g *gRPC) Connect() {}
+
+func (g *gRPC) Close() error {
+	return g.conn.Close()
+}

src/helper/ptr.go

@@ -0,0 +1,6 @@
+package helper
+
+// ToPtr converts a given T to *T
+func ToPtr[T any](v T) *T {
+	return &v
+}