diff --git a/go.mod b/go.mod index ed71d6f..de2fbee 100644 --- a/go.mod +++ b/go.mod @@ -19,6 +19,8 @@ require ( github.com/hashicorp/golang-lru v0.5.3 github.com/jackc/pgx/v4 v4.10.1 github.com/lib/pq v1.9.0 // indirect + github.com/mattheath/base62 v0.0.0-20150408093626-b80cdc656a7a // indirect + github.com/mattheath/kala v0.0.0-20171219141654-d6276794bf0e github.com/micro/dev v0.0.0-20201117163752-d3cfc9788dfa github.com/micro/micro/v3 v3.2.2-0.20210607154842-ec8964031a93 github.com/miekg/dns v1.1.31 // indirect diff --git a/go.sum b/go.sum index c7602e9..57cb396 100644 --- a/go.sum +++ b/go.sum @@ -320,6 +320,10 @@ github.com/lib/pq v1.9.0 h1:L8nSXQQzAYByakOFMTwpjRoHsMJklur4Gi59b6VivR8= github.com/lib/pq v1.9.0/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o= github.com/linode/linodego v0.10.0/go.mod h1:cziNP7pbvE3mXIPneHj0oRY8L1WtGEIKlZ8LANE4eXA= github.com/liquidweb/liquidweb-go v1.6.0/go.mod h1:UDcVnAMDkZxpw4Y7NOHkqoeiGacVLEIG/i5J9cyixzQ= +github.com/mattheath/base62 v0.0.0-20150408093626-b80cdc656a7a h1:rnrxZue85aKdMU4nJ50GgKA31lCaVbft+7Xl8OXj55U= +github.com/mattheath/base62 v0.0.0-20150408093626-b80cdc656a7a/go.mod h1:hJJYoBMTZIONmUEpX3+9v2057zuRM0n3n77U4Ob4wE4= +github.com/mattheath/kala v0.0.0-20171219141654-d6276794bf0e h1:cj+w63ez19o7y7vunA8Q3rUIWwKEOUx7foqjnr4qbtI= +github.com/mattheath/kala v0.0.0-20171219141654-d6276794bf0e/go.mod h1:OFd5kqMcMRr5LyBjZulGPJxaEK9r/jQ6JCV4Xi32bKo= github.com/mattn/go-colorable v0.1.1/go.mod h1:FuOcm+DKB9mbwrcAfNl7/TZVBZ6rcnceauSikq3lYCQ= github.com/mattn/go-colorable v0.1.2/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE= github.com/mattn/go-colorable v0.1.6 h1:6Su7aK7lXmJ/U79bYtBjLNaha4Fs1Rg9plHpcH+vvnE= diff --git a/id/.gitignore b/id/.gitignore new file mode 100644 index 0000000..6d8fd0d --- /dev/null +++ b/id/.gitignore @@ -0,0 +1,2 @@ + +id diff --git a/id/Dockerfile b/id/Dockerfile new file mode 100644 index 0000000..37bbfe5 --- /dev/null +++ b/id/Dockerfile @@ -0,0 +1,3 @@ +FROM alpine +ADD id /id +ENTRYPOINT [ "/id" ] diff --git a/id/Makefile b/id/Makefile new file mode 100644 index 0000000..4fc82e5 --- /dev/null +++ b/id/Makefile @@ -0,0 +1,28 @@ + +GOPATH:=$(shell go env GOPATH) +.PHONY: init +init: + go get -u github.com/golang/protobuf/proto + go get -u github.com/golang/protobuf/protoc-gen-go + go get github.com/micro/micro/v3/cmd/protoc-gen-micro + go get github.com/micro/micro/v3/cmd/protoc-gen-openapi + +.PHONY: api +api: + protoc --openapi_out=. --proto_path=. proto/id.proto + +.PHONY: proto +proto: + protoc --proto_path=. --micro_out=. --go_out=:. proto/id.proto + +.PHONY: build +build: + go build -o id *.go + +.PHONY: test +test: + go test -v ./... -cover + +.PHONY: docker +docker: + docker build . -t id:latest diff --git a/id/README.md b/id/README.md new file mode 100644 index 0000000..a235c58 --- /dev/null +++ b/id/README.md @@ -0,0 +1,6 @@ +Generate unique IDs (uuid, snowflake, etc) + +# ID Service + +The ID service provides unique ID generation. Including uuid, snowflake (64 bit) and bigflake (128 bit) + diff --git a/id/generate.go b/id/generate.go new file mode 100644 index 0000000..7d9db91 --- /dev/null +++ b/id/generate.go @@ -0,0 +1,3 @@ +package main + +//go:generate make proto diff --git a/id/handler/id.go b/id/handler/id.go new file mode 100644 index 0000000..1fa61d1 --- /dev/null +++ b/id/handler/id.go @@ -0,0 +1,78 @@ +package handler + +import ( + "context" + "fmt" + "math/rand" + + "github.com/teris-io/shortid" + "github.com/google/uuid" + "github.com/mattheath/kala/bigflake" + "github.com/mattheath/kala/snowflake" + "github.com/micro/micro/v3/service/logger" + "github.com/micro/micro/v3/service/errors" + pb "github.com/micro/services/id/proto" +) + +type Id struct { + Snowflake *snowflake.Snowflake + Bigflake *bigflake.Bigflake +} + +func New() *Id { + id := rand.Intn(100) + + sf, err := snowflake.New(uint32(id)) + if err != nil { + panic(err.Error()) + } + bg, err := bigflake.New(uint64(id)) + if err != nil { + panic(err.Error()) + } + + return &Id{ + Snowflake: sf, + Bigflake: bg, + } +} + +func (id *Id) Generate(ctx context.Context, req *pb.GenerateRequest, rsp *pb.GenerateResponse) error { + if len(req.Type) == 0 { + req.Type = "uuid" + } + + switch req.Type { + case "uuid": + rsp.Type = "uuid" + rsp.Id = uuid.New().String() + case "snowflake": + id, err := id.Snowflake.Mint() + if err != nil { + logger.Errorf("Failed to generate snowflake id: %v", err) + return errors.InternalServerError("id.generate", "failed to mint snowflake id") + } + rsp.Type = "snowflake" + rsp.Id = fmt.Sprintf("%v", id) + case "bigflake": + id, err := id.Bigflake.Mint() + if err != nil { + logger.Errorf("Failed to generate bigflake id: %v", err) + return errors.InternalServerError("id.generate", "failed to mint bigflake id") + } + rsp.Type = "bigflake" + rsp.Id = fmt.Sprintf("%v", id) + case "shortid": + id, err := shortid.Generate() + if err != nil { + logger.Errorf("Failed to generate shortid id: %v", err) + return errors.InternalServerError("id.generate", "failed to generate short id") + } + rsp.Type = "shortid" + rsp.Id = id + default: + return errors.BadRequest("id.generate", "unsupported id type") + } + + return nil +} diff --git a/id/main.go b/id/main.go new file mode 100644 index 0000000..b2ab89f --- /dev/null +++ b/id/main.go @@ -0,0 +1,31 @@ +package main + +import ( + "math/rand" + "time" + + "github.com/micro/micro/v3/service" + "github.com/micro/micro/v3/service/logger" + "github.com/micro/services/id/handler" + pb "github.com/micro/services/id/proto" +) + +func init() { + rand.Seed(time.Now().UnixNano()) +} + +func main() { + // Create service + srv := service.New( + service.Name("id"), + service.Version("latest"), + ) + + // Register handler + pb.RegisterIdHandler(srv.Server(), handler.New()) + + // Run service + if err := srv.Run(); err != nil { + logger.Fatal(err) + } +} diff --git a/id/micro.mu b/id/micro.mu new file mode 100644 index 0000000..a98316e --- /dev/null +++ b/id/micro.mu @@ -0,0 +1 @@ +service id diff --git a/id/proto/id.pb.go b/id/proto/id.pb.go new file mode 100644 index 0000000..028d07d --- /dev/null +++ b/id/proto/id.pb.go @@ -0,0 +1,223 @@ +// Code generated by protoc-gen-go. DO NOT EDIT. +// versions: +// protoc-gen-go v1.26.0 +// protoc v3.15.6 +// source: proto/id.proto + +package id + +import ( + protoreflect "google.golang.org/protobuf/reflect/protoreflect" + protoimpl "google.golang.org/protobuf/runtime/protoimpl" + reflect "reflect" + sync "sync" +) + +const ( + // Verify that this generated code is sufficiently up-to-date. + _ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion) + // Verify that runtime/protoimpl is sufficiently up-to-date. + _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) +) + +// Generate a unique ID. Defaults to uuid. +type GenerateRequest struct { + state protoimpl.MessageState + sizeCache protoimpl.SizeCache + unknownFields protoimpl.UnknownFields + + // type of id e.g uuid, snowflake (64 bit), bigflake (128 bit) + Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"` +} + +func (x *GenerateRequest) Reset() { + *x = GenerateRequest{} + if protoimpl.UnsafeEnabled { + mi := &file_proto_id_proto_msgTypes[0] + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + ms.StoreMessageInfo(mi) + } +} + +func (x *GenerateRequest) String() string { + return protoimpl.X.MessageStringOf(x) +} + +func (*GenerateRequest) ProtoMessage() {} + +func (x *GenerateRequest) ProtoReflect() protoreflect.Message { + mi := &file_proto_id_proto_msgTypes[0] + if protoimpl.UnsafeEnabled && x != nil { + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + if ms.LoadMessageInfo() == nil { + ms.StoreMessageInfo(mi) + } + return ms + } + return mi.MessageOf(x) +} + +// Deprecated: Use GenerateRequest.ProtoReflect.Descriptor instead. +func (*GenerateRequest) Descriptor() ([]byte, []int) { + return file_proto_id_proto_rawDescGZIP(), []int{0} +} + +func (x *GenerateRequest) GetType() string { + if x != nil { + return x.Type + } + return "" +} + +type GenerateResponse struct { + state protoimpl.MessageState + sizeCache protoimpl.SizeCache + unknownFields protoimpl.UnknownFields + + // the unique id generated + Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` + // the type of id generated + Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"` +} + +func (x *GenerateResponse) Reset() { + *x = GenerateResponse{} + if protoimpl.UnsafeEnabled { + mi := &file_proto_id_proto_msgTypes[1] + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + ms.StoreMessageInfo(mi) + } +} + +func (x *GenerateResponse) String() string { + return protoimpl.X.MessageStringOf(x) +} + +func (*GenerateResponse) ProtoMessage() {} + +func (x *GenerateResponse) ProtoReflect() protoreflect.Message { + mi := &file_proto_id_proto_msgTypes[1] + if protoimpl.UnsafeEnabled && x != nil { + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + if ms.LoadMessageInfo() == nil { + ms.StoreMessageInfo(mi) + } + return ms + } + return mi.MessageOf(x) +} + +// Deprecated: Use GenerateResponse.ProtoReflect.Descriptor instead. +func (*GenerateResponse) Descriptor() ([]byte, []int) { + return file_proto_id_proto_rawDescGZIP(), []int{1} +} + +func (x *GenerateResponse) GetId() string { + if x != nil { + return x.Id + } + return "" +} + +func (x *GenerateResponse) GetType() string { + if x != nil { + return x.Type + } + return "" +} + +var File_proto_id_proto protoreflect.FileDescriptor + +var file_proto_id_proto_rawDesc = []byte{ + 0x0a, 0x0e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x2f, 0x69, 0x64, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, + 0x12, 0x02, 0x69, 0x64, 0x22, 0x25, 0x0a, 0x0f, 0x47, 0x65, 0x6e, 0x65, 0x72, 0x61, 0x74, 0x65, + 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x12, 0x0a, 0x04, 0x74, 0x79, 0x70, 0x65, 0x18, + 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 0x74, 0x79, 0x70, 0x65, 0x22, 0x36, 0x0a, 0x10, 0x47, + 0x65, 0x6e, 0x65, 0x72, 0x61, 0x74, 0x65, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, + 0x0e, 0x0a, 0x02, 0x69, 0x64, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x02, 0x69, 0x64, 0x12, + 0x12, 0x0a, 0x04, 0x74, 0x79, 0x70, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 0x74, + 0x79, 0x70, 0x65, 0x32, 0x3d, 0x0a, 0x02, 0x49, 0x64, 0x12, 0x37, 0x0a, 0x08, 0x47, 0x65, 0x6e, + 0x65, 0x72, 0x61, 0x74, 0x65, 0x12, 0x13, 0x2e, 0x69, 0x64, 0x2e, 0x47, 0x65, 0x6e, 0x65, 0x72, + 0x61, 0x74, 0x65, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x14, 0x2e, 0x69, 0x64, 0x2e, + 0x47, 0x65, 0x6e, 0x65, 0x72, 0x61, 0x74, 0x65, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, + 0x22, 0x00, 0x42, 0x0c, 0x5a, 0x0a, 0x2e, 0x2f, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x3b, 0x69, 0x64, + 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33, +} + +var ( + file_proto_id_proto_rawDescOnce sync.Once + file_proto_id_proto_rawDescData = file_proto_id_proto_rawDesc +) + +func file_proto_id_proto_rawDescGZIP() []byte { + file_proto_id_proto_rawDescOnce.Do(func() { + file_proto_id_proto_rawDescData = protoimpl.X.CompressGZIP(file_proto_id_proto_rawDescData) + }) + return file_proto_id_proto_rawDescData +} + +var file_proto_id_proto_msgTypes = make([]protoimpl.MessageInfo, 2) +var file_proto_id_proto_goTypes = []interface{}{ + (*GenerateRequest)(nil), // 0: id.GenerateRequest + (*GenerateResponse)(nil), // 1: id.GenerateResponse +} +var file_proto_id_proto_depIdxs = []int32{ + 0, // 0: id.Id.Generate:input_type -> id.GenerateRequest + 1, // 1: id.Id.Generate:output_type -> id.GenerateResponse + 1, // [1:2] is the sub-list for method output_type + 0, // [0:1] is the sub-list for method input_type + 0, // [0:0] is the sub-list for extension type_name + 0, // [0:0] is the sub-list for extension extendee + 0, // [0:0] is the sub-list for field type_name +} + +func init() { file_proto_id_proto_init() } +func file_proto_id_proto_init() { + if File_proto_id_proto != nil { + return + } + if !protoimpl.UnsafeEnabled { + file_proto_id_proto_msgTypes[0].Exporter = func(v interface{}, i int) interface{} { + switch v := v.(*GenerateRequest); i { + case 0: + return &v.state + case 1: + return &v.sizeCache + case 2: + return &v.unknownFields + default: + return nil + } + } + file_proto_id_proto_msgTypes[1].Exporter = func(v interface{}, i int) interface{} { + switch v := v.(*GenerateResponse); i { + case 0: + return &v.state + case 1: + return &v.sizeCache + case 2: + return &v.unknownFields + default: + return nil + } + } + } + type x struct{} + out := protoimpl.TypeBuilder{ + File: protoimpl.DescBuilder{ + GoPackagePath: reflect.TypeOf(x{}).PkgPath(), + RawDescriptor: file_proto_id_proto_rawDesc, + NumEnums: 0, + NumMessages: 2, + NumExtensions: 0, + NumServices: 1, + }, + GoTypes: file_proto_id_proto_goTypes, + DependencyIndexes: file_proto_id_proto_depIdxs, + MessageInfos: file_proto_id_proto_msgTypes, + }.Build() + File_proto_id_proto = out.File + file_proto_id_proto_rawDesc = nil + file_proto_id_proto_goTypes = nil + file_proto_id_proto_depIdxs = nil +} diff --git a/id/proto/id.pb.micro.go b/id/proto/id.pb.micro.go new file mode 100644 index 0000000..aa2d166 --- /dev/null +++ b/id/proto/id.pb.micro.go @@ -0,0 +1,93 @@ +// Code generated by protoc-gen-micro. DO NOT EDIT. +// source: proto/id.proto + +package id + +import ( + fmt "fmt" + proto "github.com/golang/protobuf/proto" + math "math" +) + +import ( + context "context" + api "github.com/micro/micro/v3/service/api" + client "github.com/micro/micro/v3/service/client" + server "github.com/micro/micro/v3/service/server" +) + +// Reference imports to suppress errors if they are not otherwise used. +var _ = proto.Marshal +var _ = fmt.Errorf +var _ = math.Inf + +// This is a compile-time assertion to ensure that this generated file +// is compatible with the proto package it is being compiled against. +// A compilation error at this line likely means your copy of the +// proto package needs to be updated. +const _ = proto.ProtoPackageIsVersion3 // please upgrade the proto package + +// Reference imports to suppress errors if they are not otherwise used. +var _ api.Endpoint +var _ context.Context +var _ client.Option +var _ server.Option + +// Api Endpoints for Id service + +func NewIdEndpoints() []*api.Endpoint { + return []*api.Endpoint{} +} + +// Client API for Id service + +type IdService interface { + Generate(ctx context.Context, in *GenerateRequest, opts ...client.CallOption) (*GenerateResponse, error) +} + +type idService struct { + c client.Client + name string +} + +func NewIdService(name string, c client.Client) IdService { + return &idService{ + c: c, + name: name, + } +} + +func (c *idService) Generate(ctx context.Context, in *GenerateRequest, opts ...client.CallOption) (*GenerateResponse, error) { + req := c.c.NewRequest(c.name, "Id.Generate", in) + out := new(GenerateResponse) + err := c.c.Call(ctx, req, out, opts...) + if err != nil { + return nil, err + } + return out, nil +} + +// Server API for Id service + +type IdHandler interface { + Generate(context.Context, *GenerateRequest, *GenerateResponse) error +} + +func RegisterIdHandler(s server.Server, hdlr IdHandler, opts ...server.HandlerOption) error { + type id interface { + Generate(ctx context.Context, in *GenerateRequest, out *GenerateResponse) error + } + type Id struct { + id + } + h := &idHandler{hdlr} + return s.Handle(s.NewHandler(&Id{h}, opts...)) +} + +type idHandler struct { + IdHandler +} + +func (h *idHandler) Generate(ctx context.Context, in *GenerateRequest, out *GenerateResponse) error { + return h.IdHandler.Generate(ctx, in, out) +} diff --git a/id/proto/id.proto b/id/proto/id.proto new file mode 100644 index 0000000..9db8def --- /dev/null +++ b/id/proto/id.proto @@ -0,0 +1,23 @@ +syntax = "proto3"; + +package id; + +option go_package = "./proto;id"; + +service Id { + rpc Generate(GenerateRequest) returns (GenerateResponse) {} +} + +// Generate a unique ID. Defaults to uuid. +message GenerateRequest { + // type of id e.g uuid, shortid, snowflake (64 bit), bigflake (128 bit) + string type = 1; +} + +message GenerateResponse { + // the unique id generated + string id = 1; + // the type of id generated + string type = 2; +} +