feat(proto): buf generate

Author: xmlking

.editorconfig

@@ -30,3 +30,8 @@ indent_size = 4
 
 [Makefile]
 indent_style = tab
+
+[*.proto]
+indent_size = 2
+indent_style = space
+insert_final_newline = true

.gitignore

@@ -1,4 +1,10 @@
+# Created by https://www.toptal.com/developers/gitignore/api/macos,go,visualstudiocode,goland
+# Edit at https://www.toptal.com/developers/gitignore?templates=macos,go,visualstudiocode,goland
+
 ### Go ###
+# If you prefer the allow list template instead of the deny list, see community template:
+# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
+#
 # Binaries for programs and plugins
 *.exe
 *.exe~
@@ -12,8 +18,15 @@
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
 
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# Go workspace file
+go.work
+go.work.sum
+
 ### Go Patch ###
-# /vendor/
+/vendor/
 /Godeps/
 
 # OS generated files #

apps/hello/go.sum

@@ -1,5 +1,6 @@
 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/gomarkdown/markdown v0.0.0-20210408062403-ad838ccf8cdd/go.mod h1:aii0r/K0ZnHv7G0KF7xy1v0A7s2Ljrb5byB7MO5p6TU=
 github.com/google/uuid v1.2.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
@@ -11,6 +12,7 @@ github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZN
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.7.1 h1:5TQK59W5E3v0r2duFAb7P95B6hEeOyEnHRa8MjYSMTY=
+github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 golang.org/dl v0.0.0-20190829154251-82a15e2f2ead/go.mod h1:IUMfjQLJQd4UTqG1Z90tenwKoCX93Gn3MAQJMOSBsDQ=
 golang.org/x/net v0.0.0-20210415231046-e915ea6b2b7d/go.mod h1:9tjilg8BloeKEkVJvy7fQ90B1CfIiPueXVOjqfkSzI8=
 golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
@@ -21,3 +23,4 @@ golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGm
 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.0-20210107192922-496545a6307b h1:h8qDotaEPuJATrMmW04NCwg7v22aHH28wwpauUhK9Oo=
+gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

buf.gen.yaml

@@ -1,38 +1,32 @@
 version: v1
-
 managed:
   enabled: true
   go_package_prefix:
     default: github.com/xmlking/grpc-starter-kit
     except:
       - buf.build/googleapis/googleapis
-      - buf.build/envoyproxy/protoc-gen-validate
       - buf.build/srikrsna/protoc-gen-gotag
+      - buf.build/go-sdk/protoc-gen-validate
   java_multiple_files: true
 #  java_package_prefix: com
 
 plugins:
-  - name: go
-    out: .
-    opt: paths=source_relative
 # FIXME: https://github.com/srikrsna/protoc-gen-gotag/issues/26
 #  - name: gotag
 #    out: .
 #    opt:
 #      - paths=source_relative
-  - name: go-grpc
+  - remote: buf.build/protocolbuffers/plugins/go:v1.28.0-1
     out: .
     opt:
       - paths=source_relative
-      - require_unimplemented_servers=false
-  - name: validate
+  - remote: buf.build/grpc/plugins/go:v1.2.0-1
     out: .
     opt:
       - paths=source_relative
+      - require_unimplemented_servers=false
+  - remote: buf.build/go-sdk/plugins/protoc-gen-validate:v0.6.7-1
+    out: .
+    opt:
       - lang=go
-
-#  - name: descriptor_set
-#    out: ./descriptor
-#    file_sufix: bin
-#    include_imports: true
-#    include_source_info: true
+      - paths=source_relative

dkit/bigquery/v1/bigquery_options.pb.go

@@ -8,42 +8,56 @@
 
 ## Prerequisites
 
-```bash
+```shell
 # buf: proto tool https://buf.build/docs/tour-1
+brew install bufbuild/buf/buf
 # or use `go install` to install Buf
 go install github.com/bufbuild/buf/cmd/buf@latest
 
 # Install protoc plugins
 go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
 go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
 go install github.com/srikrsna/protoc-gen-gotag@latest
+
+go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
+# Installing PGV can currently only be done from source: 
+# from user's home directory, run
+go get -d github.com/envoyproxy/protoc-gen-validate
+cd ~/go/src/github.com/envoyproxy/protoc-gen-validate
+git pull
+make build
 ```
 
+[Editor Integration](https://docs.buf.build/editor-integration) (Optional)
+![goland-buf-watch](../images/goland-buf-watch.png)
+Add `Import Paths` and `google/protobuf/descriptor.proto` in **GoLand/IntelliJ** as described [here](https://github.com/jvolkman/intellij-protobuf-editor/issues/33#issuecomment-898466971) 👇 
+![goland-proto-import](../images/goland-proto-import.png)
+
 ## Developer Workflow
 
 ### Info
 
-```bash
+```shell
 # To list all files Buf is configured to use:
 buf ls-files
 # To see your currently configured lint or breaking checkers:
-buf config ls-lint-rules
-buf config ls-breaking-rules
+buf mod ls-lint-rules
+buf mod ls-breaking-rules
 # To see all available lint checkers independent of configuration/defaults:
-buf config ls-lint-rules --all
+buf mod ls-lint-rules --all
 ```
 
 ### Build
 
-```bash
+```shell
 # check
 buf build -o /dev/null
 buf build -o image.bin
 ```
 
 ### Lint
 
-```bash
+```shell
 buf lint
 # We can also output errors in a format you can then copy into your buf.yaml file
 buf lint --error-format=config-ignore-yaml
@@ -61,13 +75,13 @@ buf breaking --against "$(HTTPS_GIT)#branch=main"
 ### Generate
 
 Cleanup
-```bash
+```shell
 rm -rf dkit
 rm -rf mkit
 ```
 
 Generate
-```bash
+```shell
 buf generate proto/dkit
 buf generate proto/mkit
 buf generate
@@ -84,16 +98,18 @@ Buf support modules [dependencies](https://docs.buf.build/tour/add-a-dependency)
 #### Login to buf registry. 
 This command will create `/Users/<username>/.netrc` file
 
-```bash
+```shell
 # fill the username and token
-BUF_USER=
-BUF_API_TOKEN=
+export BUF_USER=chintha
+export BUF_API_TOKEN=
 echo ${BUF_API_TOKEN} | buf registry login --username ${BUF_USER} --token-stdin
+# to logout
+buf registry logout
 ```
 
 #### Create buf lock files
 one-time-setup
-```bash
+```shell
 cd proto/dkit
 buf mod update
 cd proto/mkit
@@ -102,21 +118,21 @@ buf mod update
 This will pull deps into `$HOME/.cache/buf`
 
 #### Create a Repository
-```bash
+```shell
 buf beta registry repository create buf.build/chintha/dkit --visibility private
 buf beta registry repository create buf.build/chintha/dkit --visibility public
 
 buf beta registry repository create buf.build/chintha/mkit --visibility private
 ```
 
 #### List Modules
-```bash
+```shell
 buf beta registry repository list  buf.build --page-size 100
 buf beta registry repository get    buf.build/googleapis/googleapis
 ```
 
 #### Push the Module
-```bash
+```shell
 cd proto/dkit
 buf push
 cd proto/mkit
@@ -125,7 +141,7 @@ buf push
 
 ### Format
 
-```bash
+```shell
 # FIXME buf don't have proto formatter yet 
 prototool format -w proto;
 ```
@@ -134,14 +150,14 @@ prototool format -w proto;
 
 ### grpcurl
 
-```bash
+```shell
 # To use Buf-produced FileDescriptorSets with grpcurl on the fly:
 grpcurl -protoset <(buf build -o -) ...
 ```
 
 ### ghz
 
-```bash
+```shell
 # To use Buf-produced FileDescriptorSets with ghz on the fly:
 ghz --protoset <(buf build -o -) ...
 ```

dkit/bigquery/v1/bigquery_options.pb.validate.go

@@ -27,10 +27,10 @@ require (
 	github.com/xmlking/toolkit/logger v0.2.4
 	github.com/xmlking/toolkit/telemetry v0.2.4
 	github.com/xmlking/toolkit/xds v0.2.4
-	go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.30.0
-	go.opentelemetry.io/otel v1.6.0
+	go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.31.0
+	go.opentelemetry.io/otel v1.6.1
 	go.opentelemetry.io/otel/metric v0.26.0
-	go.opentelemetry.io/otel/trace v1.6.0
+	go.opentelemetry.io/otel/trace v1.6.1
 	golang.org/x/sync v0.0.0-20210220032951-036812b2e83c
 	google.golang.org/grpc v1.45.0
 	google.golang.org/protobuf v1.28.0

dkit/privacy/v1/privacy_options.pb.go

@@ -701,17 +701,16 @@ go.opencensus.io v0.22.4/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw=
 go.opencensus.io v0.22.5/go.mod h1:5pWMHQbX5EPX2/62yrJeAkowc+lfs/XD7Uxpq3pI6kk=
 go.opencensus.io v0.23.0 h1:gqCw0LfLxScz8irSi8exQc7fyQ0fKQU/qnC/X8+V/1M=
 go.opencensus.io v0.23.0/go.mod h1:XItmlyltB5F7CS4xOC1DcqMoFqwtC6OG2xF7mCv7P7E=
-go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.30.0 h1:3rCOYB0P/u0/MXyLGuRuc/VdBsQuxKgj/dvIpVI0lS4=
-go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.30.0/go.mod h1:L02XUVEqBFpJPJmaKLi5sXFiMwzd152PNMsCThH7dHc=
+go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.31.0 h1:li8u9OSMvLau7rMs8bmiL82OazG6MAkwPz2i6eS8TBQ=
+go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.31.0/go.mod h1:SY9qHHUES6W3oZnO1H2W8NvsSovIoXRg/A1AH9px8+I=
 go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.24.0 h1:qW6j1kJU24yo2xIu16Py4m4AXn1dd+s2uKllGnTFAm0=
 go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.24.0/go.mod h1:7W3JSDYTtH3qKKHrS1fMiwLtK7iZFLPq1+7htfspX/E=
 go.opentelemetry.io/otel v1.0.0-RC3/go.mod h1:Ka5j3ua8tZs4Rkq4Ex3hwgBgOchyPVq5S6P2lz//nKQ=
 go.opentelemetry.io/otel v1.0.0/go.mod h1:AjRVh9A5/5DE7S+mZtTR6t8vpKKryam+0lREnfmS4cg=
 go.opentelemetry.io/otel v1.0.1/go.mod h1:OPEOD4jIT2SlZPMmwT6FqZz2C0ZNdQqiWcoK6M0SNFU=
 go.opentelemetry.io/otel v1.3.0/go.mod h1:PWIKzi6JCp7sM0k9yZ43VX+T345uNbAkDKwHVjb2PTs=
-go.opentelemetry.io/otel v1.5.0/go.mod h1:Jm/m+rNp/z0eqJc74H7LPwQ3G87qkU/AnnAydAjSAHk=
-go.opentelemetry.io/otel v1.6.0 h1:YV6GkGe/Ag2PKsm4rjlqdSNs0w0A5ZzxeGkxhx1T+t4=
-go.opentelemetry.io/otel v1.6.0/go.mod h1:bfJD2DZVw0LBxghOTlgnlI0CV3hLDu9XF/QKOUXMTQQ=
+go.opentelemetry.io/otel v1.6.1 h1:6r1YrcTenBvYa1x491d0GGpTVBsNECmrc/K6b+zDeis=
+go.opentelemetry.io/otel v1.6.1/go.mod h1:blzUabWHkX6LJewxvadmzafgh/wnvBSDBdOuwkAtrWQ=
 go.opentelemetry.io/otel/exporters/prometheus v0.26.0 h1:qsF1KFEE+dIRoQN0M0D/A9mdhu0TqQCNAzl0o1S2CIM=
 go.opentelemetry.io/otel/exporters/prometheus v0.26.0/go.mod h1:0/uJZI7H2y0FgMVCgCWdPzZpxPx3X3F5uInY32I9foI=
 go.opentelemetry.io/otel/exporters/stdout/stdoutmetric v0.26.0 h1:w7fF+cx3zdxURlLuVhzuYt6BT9COyecNfYYhtHXZoDc=
@@ -735,9 +734,8 @@ go.opentelemetry.io/otel/trace v1.0.0-RC3/go.mod h1:VUt2TUYd8S2/ZRX09ZDFZQwn2Rqf
 go.opentelemetry.io/otel/trace v1.0.0/go.mod h1:PXTWqayeFUlJV1YDNhsJYB184+IvAH814St6o6ajzIs=
 go.opentelemetry.io/otel/trace v1.0.1/go.mod h1:5g4i4fKLaX2BQpSBsxw8YYcgKpMMSW3x7ZTuYBr3sUk=
 go.opentelemetry.io/otel/trace v1.3.0/go.mod h1:c/VDhno8888bvQYmbYLqe41/Ldmr/KKunbvWM4/fEjk=
-go.opentelemetry.io/otel/trace v1.5.0/go.mod h1:sq55kfhjXYr1zVSyexg0w1mpa03AYXR5eyTkB9NPPdE=
-go.opentelemetry.io/otel/trace v1.6.0 h1:NDzPermp9ISkhxIaJXjBTi2O60xOSHDHP/EezjOL2wo=
-go.opentelemetry.io/otel/trace v1.6.0/go.mod h1:qs7BrU5cZ8dXQHBGxHMOxwME/27YH2qEp4/+tZLLwJE=
+go.opentelemetry.io/otel/trace v1.6.1 h1:f8c93l5tboBYZna1nWk0W9DYyMzJXDWdZcJZ0Kb400U=
+go.opentelemetry.io/otel/trace v1.6.1/go.mod h1:RkFRM1m0puWIq10oxImnGEduNBzxiN7TXluRBtE+5j0=
 go.opentelemetry.io/proto/otlp v0.7.0/go.mod h1:PqfVotwruBrMGOCsRd/89rSnXhoiJIqeYNgFYFoEGnI=
 go.uber.org/atomic v1.4.0/go.mod h1:gD2HeocX3+yG+ygLZcrzQJaqmWj9AIm7n08wl/qW/PE=
 go.uber.org/atomic v1.6.0/go.mod h1:sABNBOSYdrvTF6hTgEIbc7YasKWGhgEQZyfxyTvoXHQ=

dkit/privacy/v1/privacy_options.pb.validate.go

@@ -13,8 +13,9 @@ use (
 
 //replace github.com/xmlking/toolkit/telemetry => ../toolkit/telemetry
 
-//replace github.com/xmlking/toolkit => github.com/xmlking/toolkit v0.1.2-0.20210125025404-51fc2d71fb2d
-
 //replace github.com/xmlking/toolkit/xds => ../toolkit/xds
 
-replace github.com/xmlking/toolkit/xds => github.com/xmlking/toolkit/xds v0.2.5-0.20220327073200-7a0bd5cf638b
+replace github.com/xmlking/toolkit/xds => github.com/xmlking/toolkit/xds v0.2.5-0.20220329222226-895ec254c86c
+
+replace github.com/xmlking/toolkit => github.com/xmlking/toolkit v0.2.5-0.20220329222226-895ec254c86c
+