From c1c296a0c07672411e59d40dc413559c8a67ea70 Mon Sep 17 00:00:00 2001 From: Ryan McGuire Date: Sun, 20 Jul 2025 18:16:12 -0400 Subject: [PATCH] improve shutdown and app service boilerplate --- TODO.md | 4 +- go.mod | 3 +- go.sum | 65 +------------------------- main.go | 77 +++++++++++++++++++++---------- pkg/config/custom.go | 9 ++-- pkg/demo/demo.go | 54 ++++++++++++++++++++++ pkg/{ => demo}/demogrpc/demo.go | 4 +- pkg/{ => demo}/demogrpc/fact.go | 0 pkg/{ => demo}/demogrpc/server.go | 0 pkg/{ => demo}/demohttp/server.go | 4 +- pkg/service/service.go | 63 +++++++++++++++++++++++++ 11 files changed, 185 insertions(+), 98 deletions(-) create mode 100644 pkg/demo/demo.go rename pkg/{ => demo}/demogrpc/demo.go (94%) rename pkg/{ => demo}/demogrpc/fact.go (100%) rename pkg/{ => demo}/demogrpc/server.go (100%) rename pkg/{ => demo}/demohttp/server.go (87%) create mode 100644 pkg/service/service.go diff --git a/TODO.md b/TODO.md index dc1ada2..c73fc5f 100644 --- a/TODO.md +++ b/TODO.md @@ -1,6 +1,8 @@ # Demo app TODO -- [ ] Update README for tagging/versioning/pipeline info +- [x] Create generic interface for implenting a service +- [x] Create config sample not called demo, so it is more easily reused +- [x] Update README for tagging/versioning/pipeline info - [x] Update README for detail on installing protoc tools and make - [x] Rename project - [x] Finish grpc sample implementation diff --git a/go.mod b/go.mod index e5ad34a..e88c8b9 100644 --- a/go.mod +++ b/go.mod @@ -10,6 +10,7 @@ require ( github.com/grpc-ecosystem/grpc-gateway/v2 v2.27.1 github.com/rs/zerolog v1.34.0 go.opentelemetry.io/otel/trace v1.37.0 + golang.org/x/sync v0.16.0 golang.org/x/sys v0.34.0 google.golang.org/genproto/googleapis/api v0.0.0-20250715232539-7130f93afb79 google.golang.org/grpc v1.73.0 @@ -20,7 +21,6 @@ require ( github.com/caarlos0/env/v11 v11.3.1 // indirect github.com/felixge/httpsnoop v1.0.4 // indirect github.com/grpc-ecosystem/go-grpc-middleware/v2 v2.3.2 // indirect - github.com/klauspost/compress v1.18.0 // indirect github.com/swaggest/jsonschema-go v0.3.78 // indirect github.com/swaggest/refl v1.4.0 // indirect go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.62.0 // indirect @@ -38,7 +38,6 @@ require ( require ( github.com/beorn7/perks v1.0.1 // indirect - github.com/cenkalti/backoff/v4 v4.3.0 // indirect github.com/cenkalti/backoff/v5 v5.0.2 // indirect github.com/cespare/xxhash/v2 v2.3.0 // indirect github.com/go-logr/logr v1.4.3 // indirect diff --git a/go.sum b/go.sum index 94d9a92..d986f41 100644 --- a/go.sum +++ b/go.sum @@ -1,5 +1,3 @@ -gitea.libretechconsulting.com/rmcguire/go-app v0.9.2 h1:DTbGae0TR7O+kKI1ZE8txgFnGb0vsYX/urFUFuoZfQM= -gitea.libretechconsulting.com/rmcguire/go-app v0.9.2/go.mod h1:W6YHFSGf4nJrgs9DqEaw+3J6ufIARsr1zpOs/V6gRTQ= gitea.libretechconsulting.com/rmcguire/go-app v0.9.4 h1:KS1Jzb+FqAT+Dg8MXk6cAimd39R9qF5CmIT5/2D2C/Q= gitea.libretechconsulting.com/rmcguire/go-app v0.9.4/go.mod h1:olhFqmVpnGIrkNfMqhJRbaThcCAypf3ueoh1oe5s8Mk= github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM= @@ -10,8 +8,6 @@ github.com/bool64/shared v0.1.5 h1:fp3eUhBsrSjNCQPcSdQqZxxh9bBwrYiZ+zOKFkM0/2E= github.com/bool64/shared v0.1.5/go.mod h1:081yz68YC9jeFB3+Bbmno2RFWvGKv1lPKkMP6MHJlPs= github.com/caarlos0/env/v11 v11.3.1 h1:cArPWC15hWmEt+gWk7YBi7lEXTXCvpaSdCiZE2X5mCA= github.com/caarlos0/env/v11 v11.3.1/go.mod h1:qupehSf/Y0TUTsxKywqRt/vJjN5nz6vauiYEUUr8P4U= -github.com/cenkalti/backoff/v4 v4.3.0 h1:MyRJ/UdXutAwSAT+s3wNd7MfTIcy71VQueUuFK343L8= -github.com/cenkalti/backoff/v4 v4.3.0/go.mod h1:Y3VNntkOUPxTVeUxJ/G5vcM//AlwfmyYozVcomhLiZE= github.com/cenkalti/backoff/v5 v5.0.2 h1:rIfFVxEf1QsI7E1ZHfp/B4DF/6QBAUhmgkxc0H7Zss8= github.com/cenkalti/backoff/v5 v5.0.2/go.mod h1:rkhZdG3JZukswDf7f0cwqPNk4K0sa+F97BxZthm/crw= github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs= @@ -22,8 +18,6 @@ github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSs github.com/felixge/httpsnoop v1.0.4 h1:NFTV2Zj1bL4mc9sqWACXbQFVBBg2W3GPvqp8/ESS2Wg= github.com/felixge/httpsnoop v1.0.4/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSwevea8zH2U= github.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A= -github.com/go-logr/logr v1.4.2 h1:6pFjapn8bFcIbiKo3XT4j/BhANplGihG6tvd+8rYgrY= -github.com/go-logr/logr v1.4.2/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY= github.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI= github.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY= github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag= @@ -37,13 +31,8 @@ github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8= github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU= github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= -github.com/grpc-ecosystem/go-grpc-middleware/v2 v2.3.1 h1:KcFzXwzM/kGhIRHvc8jdixfIJjVzuUJdnv+5xsPutog= -github.com/grpc-ecosystem/go-grpc-middleware/v2 v2.3.1/go.mod h1:qOchhhIlmRcqk/O9uCo/puJlyo07YINaIqdZfZG3Jkc= github.com/grpc-ecosystem/go-grpc-middleware/v2 v2.3.2 h1:sGm2vDRFUrQJO/Veii4h4zG2vvqG6uWNkBHSTqXOZk0= github.com/grpc-ecosystem/go-grpc-middleware/v2 v2.3.2/go.mod h1:wd1YpapPLivG6nQgbf7ZkG1hhSOXDhhn4MLTknx2aAc= -github.com/grpc-ecosystem/grpc-gateway v1.16.0 h1:gmcG1KaJ57LophUzW0Hy8NmPhnMZb4M0+kPpLofRdBo= -github.com/grpc-ecosystem/grpc-gateway/v2 v2.26.3 h1:5ZPtiqj0JL5oKWmcsq4VMaAW5ukBEgSGXEN89zeH1Jo= -github.com/grpc-ecosystem/grpc-gateway/v2 v2.26.3/go.mod h1:ndYquD05frm2vACXE1nsccT4oJzjhw2arTS2cpUD1PI= github.com/grpc-ecosystem/grpc-gateway/v2 v2.27.1 h1:X5VWvz21y3gzm9Nw/kaUeku/1+uBhcekkmy4IkffJww= github.com/grpc-ecosystem/grpc-gateway/v2 v2.27.1/go.mod h1:Zanoh4+gvIgluNqcfMVTJueD4wSS5hT7zTt4Mrutd90= github.com/iancoleman/orderedmap v0.3.0 h1:5cbR2grmZR/DiVt+VJopEhtVs9YGInGIxAoMJn+Ichc= @@ -68,20 +57,12 @@ github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8m github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= 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/prometheus/client_golang v1.21.1 h1:DOvXXTqVzvkIewV/CDPFdejpMCGeMcbGCQ8YOmu+Ibk= -github.com/prometheus/client_golang v1.21.1/go.mod h1:U9NM32ykUErtVBxdvD3zfi+EuFkkaBvMb09mIfe0Zgg= github.com/prometheus/client_golang v1.22.0 h1:rb93p9lokFEsctTys46VnV1kLCDpVZ0a/Y92Vm0Zc6Q= github.com/prometheus/client_golang v1.22.0/go.mod h1:R7ljNsLXhuQXYZYtw6GAE9AZg8Y7vEW5scdCXrWRXC0= -github.com/prometheus/client_model v0.6.1 h1:ZKSh/rekM+n3CeS952MLRAdFwIKqeY8b62p8ais2e9E= -github.com/prometheus/client_model v0.6.1/go.mod h1:OrxVMOVHjw3lKMa8+x6HeMGkHMQyHDk9E3jmP2AmGiY= github.com/prometheus/client_model v0.6.2 h1:oBsgwpGs7iVziMvrGhE53c/GrLUsZdHnqNwqPLxwZyk= github.com/prometheus/client_model v0.6.2/go.mod h1:y3m2F6Gdpfy6Ut/GBsUqTWZqCUvMVzSfMLjcu6wAwpE= -github.com/prometheus/common v0.63.0 h1:YR/EIY1o3mEFP/kZCD7iDMnLPlGyuU2Gb3HIcXnA98k= -github.com/prometheus/common v0.63.0/go.mod h1:VVFF/fBIoToEnWRVkYoXEkq3R3paCoxG9PXP74SnV18= github.com/prometheus/common v0.65.0 h1:QDwzd+G1twt//Kwj/Ww6E9FQq1iVMmODnILtW1t2VzE= github.com/prometheus/common v0.65.0/go.mod h1:0gZns+BLRQ3V6NdaerOhMbwwRbNh9hkGINtQAsP5GS8= -github.com/prometheus/procfs v0.16.0 h1:xh6oHhKwnOJKMYiYBDWmkHqQPyiY40sny36Cmx2bbsM= -github.com/prometheus/procfs v0.16.0/go.mod h1:8veyXUu3nGP7oaCxhX6yeaM5u4stL2FeMXnCqhDthZg= github.com/prometheus/procfs v0.17.0 h1:FuLQ+05u4ZI+SS/w9+BWEM2TXiHKsUQ9TADiRH7DuK0= github.com/prometheus/procfs v0.17.0/go.mod h1:oPQLaDAMRbA+u8H5Pbfq+dl3VDAvHxMUOVhe0wYB2zw= github.com/rogpeppe/go-internal v1.13.1 h1:KvO1DLK/DRN07sQ1LQKScxyZJuNnedQ5/wKSR38lUII= @@ -95,12 +76,8 @@ github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOf github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= github.com/swaggest/assertjson v1.9.0 h1:dKu0BfJkIxv/xe//mkCrK5yZbs79jL7OVf9Ija7o2xQ= github.com/swaggest/assertjson v1.9.0/go.mod h1:b+ZKX2VRiUjxfUIal0HDN85W0nHPAYUbYH5WkkSsFsU= -github.com/swaggest/jsonschema-go v0.3.73 h1:gU1pBzF3pkZ1GDD3dRMdQoCjrA0sldJ+QcM7aSSPgvc= -github.com/swaggest/jsonschema-go v0.3.73/go.mod h1:qp+Ym2DIXHlHzch3HKz50gPf2wJhKOrAB/VYqLS2oJU= github.com/swaggest/jsonschema-go v0.3.78 h1:5+YFQrLxOR8z6CHvgtZc42WRy/Q9zRQQ4HoAxlinlHw= github.com/swaggest/jsonschema-go v0.3.78/go.mod h1:4nniXBuE+FIGkOGuidjOINMH7OEqZK3HCSbfDuLRI0g= -github.com/swaggest/refl v1.3.1 h1:XGplEkYftR7p9cz1lsiwXMM2yzmOymTE9vneVVpaOh4= -github.com/swaggest/refl v1.3.1/go.mod h1:4uUVFVfPJ0NSX9FPwMPspeHos9wPFlCMGoPRllUbpvA= github.com/swaggest/refl v1.4.0 h1:CftOSdTqRqs100xpFOT/Rifss5xBV/CT0S/FN60Xe9k= github.com/swaggest/refl v1.4.0/go.mod h1:4uUVFVfPJ0NSX9FPwMPspeHos9wPFlCMGoPRllUbpvA= github.com/yudai/gojsondiff v1.0.0 h1:27cbfqXLVEJ1o8I6v3y9lg8Ydm53EKqHXAOMxEGlCOA= @@ -109,91 +86,53 @@ github.com/yudai/golcs v0.0.0-20170316035057-ecda9a501e82 h1:BHyfKlQyqbsFN5p3Ifn github.com/yudai/golcs v0.0.0-20170316035057-ecda9a501e82/go.mod h1:lgjkn3NuSvDfVJdfcVVdX+jpBxNmX4rDAzaS45IcYoM= go.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA= go.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A= -go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.60.0 h1:x7wzEgXfnzJcHDwStJT+mxOz4etr2EcexjqhBvmoakw= -go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.60.0/go.mod h1:rg+RlpR5dKwaS95IyyZqj5Wd4E13lk/msnTS0Xl9lJM= go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.62.0 h1:rbRJ8BBoVMsQShESYZ0FkvcITu8X8QNwJogcLUmDNNw= go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.62.0/go.mod h1:ru6KHrNtNHxM4nD/vd6QrLVWgKhxPYgblq4VAtNawTQ= -go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.60.0 h1:sbiXRNDSWJOTobXh5HyQKjq6wUC5tNybqjIqDpAY4CU= -go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.60.0/go.mod h1:69uWxva0WgAA/4bu2Yy70SLDBwZXuQ6PbBpbsa5iZrQ= go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.62.0 h1:Hf9xI/XLML9ElpiHVDNwvqI0hIFlzV8dgIr35kV1kRU= go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.62.0/go.mod h1:NfchwuyNoMcZ5MLHwPrODwUF1HWCXWrL31s8gSAdIKY= -go.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ= -go.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y= go.opentelemetry.io/otel v1.37.0 h1:9zhNfelUvx0KBfu/gb+ZgeAfAgtWrfHJZcAqFC228wQ= go.opentelemetry.io/otel v1.37.0/go.mod h1:ehE/umFRLnuLa/vSccNq9oS1ErUlkkK71gMcN34UG8I= -go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc v1.35.0 h1:QcFwRrZLc82r8wODjvyCbP7Ifp3UANaBSmhDSFjnqSc= -go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc v1.35.0/go.mod h1:CXIWhUomyWBG/oY2/r/kLp6K/cmx9e/7DLpBuuGdLCA= go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc v1.37.0 h1:zG8GlgXCJQd5BU98C0hZnBbElszTmUgCNCfYneaDL0A= go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc v1.37.0/go.mod h1:hOfBCz8kv/wuq73Mx2H2QnWokh/kHZxkh6SNF2bdKtw= -go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.35.0 h1:1fTNlAIJZGWLP5FVu0fikVry1IsiUnXjf7QFvoNN3Xw= -go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.35.0/go.mod h1:zjPK58DtkqQFn+YUMbx0M2XV3QgKU0gS9LeGohREyK4= go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.37.0 h1:Ahq7pZmv87yiyn3jeFz/LekZmPLLdKejuO3NcK9MssM= go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.37.0/go.mod h1:MJTqhM0im3mRLw1i8uGHnCvUEeS7VwRyxlLC78PA18M= -go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.35.0 h1:m639+BofXTvcY1q8CGs4ItwQarYtJPOWmVobfM1HpVI= -go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.35.0/go.mod h1:LjReUci/F4BUyv+y4dwnq3h/26iNOeC3wAIqgvTIZVo= go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.37.0 h1:EtFWSnwW9hGObjkIdmlnWSydO+Qs8OwzfzXLUPg4xOc= go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.37.0/go.mod h1:QjUEoiGCPkvFZ/MjK6ZZfNOS6mfVEVKYE99dFhuN2LI= -go.opentelemetry.io/otel/exporters/prometheus v0.57.0 h1:AHh/lAP1BHrY5gBwk8ncc25FXWm/gmmY3BX258z5nuk= -go.opentelemetry.io/otel/exporters/prometheus v0.57.0/go.mod h1:QpFWz1QxqevfjwzYdbMb4Y1NnlJvqSGwyuU0B4iuc9c= go.opentelemetry.io/otel/exporters/prometheus v0.59.0 h1:HHf+wKS6o5++XZhS98wvILrLVgHxjA/AMjqHKes+uzo= go.opentelemetry.io/otel/exporters/prometheus v0.59.0/go.mod h1:R8GpRXTZrqvXHDEGVH5bF6+JqAZcK8PjJcZ5nGhEWiE= -go.opentelemetry.io/otel/exporters/stdout/stdoutmetric v1.35.0 h1:PB3Zrjs1sG1GBX51SXyTSoOTqcDglmsk7nT6tkKPb/k= -go.opentelemetry.io/otel/exporters/stdout/stdoutmetric v1.35.0/go.mod h1:U2R3XyVPzn0WX7wOIypPuptulsMcPDPs/oiSVOMVnHY= go.opentelemetry.io/otel/exporters/stdout/stdoutmetric v1.37.0 h1:6VjV6Et+1Hd2iLZEPtdV7vie80Yyqf7oikJLjQ/myi0= go.opentelemetry.io/otel/exporters/stdout/stdoutmetric v1.37.0/go.mod h1:u8hcp8ji5gaM/RfcOo8z9NMnf1pVLfVY7lBY2VOGuUU= -go.opentelemetry.io/otel/exporters/stdout/stdouttrace v1.35.0 h1:T0Ec2E+3YZf5bgTNQVet8iTDW7oIk03tXHq+wkwIDnE= -go.opentelemetry.io/otel/exporters/stdout/stdouttrace v1.35.0/go.mod h1:30v2gqH+vYGJsesLWFov8u47EpYTcIQcBjKpI6pJThg= go.opentelemetry.io/otel/exporters/stdout/stdouttrace v1.37.0 h1:SNhVp/9q4Go/XHBkQ1/d5u9P/U+L1yaGPoi0x+mStaI= go.opentelemetry.io/otel/exporters/stdout/stdouttrace v1.37.0/go.mod h1:tx8OOlGH6R4kLV67YaYO44GFXloEjGPZuMjEkaaqIp4= -go.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M= -go.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE= go.opentelemetry.io/otel/metric v1.37.0 h1:mvwbQS5m0tbmqML4NqK+e3aDiO02vsf/WgbsdpcPoZE= go.opentelemetry.io/otel/metric v1.37.0/go.mod h1:04wGrZurHYKOc+RKeye86GwKiTb9FKm1WHtO+4EVr2E= -go.opentelemetry.io/otel/sdk v1.35.0 h1:iPctf8iprVySXSKJffSS79eOjl9pvxV9ZqOWT0QejKY= -go.opentelemetry.io/otel/sdk v1.35.0/go.mod h1:+ga1bZliga3DxJ3CQGg3updiaAJoNECOgJREo9KHGQg= go.opentelemetry.io/otel/sdk v1.37.0 h1:ItB0QUqnjesGRvNcmAcU0LyvkVyGJ2xftD29bWdDvKI= go.opentelemetry.io/otel/sdk v1.37.0/go.mod h1:VredYzxUvuo2q3WRcDnKDjbdvmO0sCzOvVAiY+yUkAg= -go.opentelemetry.io/otel/sdk/metric v1.35.0 h1:1RriWBmCKgkeHEhM7a2uMjMUfP7MsOF5JpUCaEqEI9o= -go.opentelemetry.io/otel/sdk/metric v1.35.0/go.mod h1:is6XYCUMpcKi+ZsOvfluY5YstFnhW0BidkR+gL+qN+w= go.opentelemetry.io/otel/sdk/metric v1.37.0 h1:90lI228XrB9jCMuSdA0673aubgRobVZFhbjxHHspCPc= go.opentelemetry.io/otel/sdk/metric v1.37.0/go.mod h1:cNen4ZWfiD37l5NhS+Keb5RXVWZWpRE+9WyVCpbo5ps= -go.opentelemetry.io/otel/trace v1.35.0 h1:dPpEfJu1sDIqruz7BHFG3c7528f6ddfSWfFDVt/xgMs= -go.opentelemetry.io/otel/trace v1.35.0/go.mod h1:WUk7DtFp1Aw2MkvqGdwiXYDZZNvA/1J8o6xRXLrIkyc= go.opentelemetry.io/otel/trace v1.37.0 h1:HLdcFNbRQBE2imdSEgm/kwqmQj1Or1l/7bW6mxVK7z4= go.opentelemetry.io/otel/trace v1.37.0/go.mod h1:TlgrlQ+PtQO5XFerSPUYG0JSgGyryXewPGyayAWSBS0= -go.opentelemetry.io/proto/otlp v1.5.0 h1:xJvq7gMzB31/d406fB8U5CBdyQGw4P399D1aQWU/3i4= -go.opentelemetry.io/proto/otlp v1.5.0/go.mod h1:keN8WnHxOy8PG0rQZjJJ5A2ebUoafqWp0eVQ4yIXvJ4= go.opentelemetry.io/proto/otlp v1.7.0 h1:jX1VolD6nHuFzOYso2E73H85i92Mv8JQYk0K9vz09os= go.opentelemetry.io/proto/otlp v1.7.0/go.mod h1:fSKjH6YJ7HDlwzltzyMj036AJ3ejJLCgCSHGj4efDDo= go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto= go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE= -golang.org/x/net v0.38.0 h1:vRMAPTMaeGqVhG5QyLJHqNDwecKTomGeqbnfZyKlBI8= -golang.org/x/net v0.38.0/go.mod h1:ivrbrMbzFq5J41QOQh0siUuly180yBYtLp+CKbEaFx8= golang.org/x/net v0.42.0 h1:jzkYrhi3YQWD6MLBJcsklgQsoAcw89EcZbJw8Z614hs= golang.org/x/net v0.42.0/go.mod h1:FF1RA5d3u7nAYA4z2TkclSCKh68eSXtiFwcWQpPXdt8= +golang.org/x/sync v0.16.0 h1:ycBJEhp9p4vXvUZNszeOq0kGTPghopOL8q0fq3vstxw= +golang.org/x/sync v0.16.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA= golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.31.0 h1:ioabZlmFYtWhL+TRYpcnNlLwhyxaM9kWTDEmfnprqik= -golang.org/x/sys v0.31.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k= golang.org/x/sys v0.34.0 h1:H5Y5sJ2L2JRdyv7ROF1he/lPdvFsd0mJHFw2ThKHxLA= golang.org/x/sys v0.34.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k= -golang.org/x/text v0.23.0 h1:D71I7dUrlY+VX0gQShAThNGHFxZ13dGLBHQLVl1mJlY= -golang.org/x/text v0.23.0/go.mod h1:/BLNzu4aZCJ1+kcD0DNRotWKage4q2rGVAg4o22unh4= golang.org/x/text v0.27.0 h1:4fGWRpyh641NLlecmyl4LOe6yDdfaYNrGb2zdfo4JV4= golang.org/x/text v0.27.0/go.mod h1:1D28KMCvyooCX9hBiosv5Tz/+YLxj0j7XhWjpSUF7CU= golang.org/x/time v0.6.0 h1:eTDhh4ZXt5Qf0augr54TN6suAUudPcawVZeIAPU7D4U= golang.org/x/time v0.6.0/go.mod h1:3BpzKBy/shNhVucY/MWOyx10tF3SFh9QdLuxbVysPQM= -google.golang.org/genproto/googleapis/api v0.0.0-20250324211829-b45e905df463 h1:hE3bRWtU6uceqlh4fhrSnUyjKHMKB9KrTLLG+bc0ddM= -google.golang.org/genproto/googleapis/api v0.0.0-20250324211829-b45e905df463/go.mod h1:U90ffi8eUL9MwPcrJylN5+Mk2v3vuPDptd5yyNUiRR8= google.golang.org/genproto/googleapis/api v0.0.0-20250715232539-7130f93afb79 h1:iOye66xuaAK0WnkPuhQPUFy8eJcmwUXqGGP3om6IxX8= google.golang.org/genproto/googleapis/api v0.0.0-20250715232539-7130f93afb79/go.mod h1:HKJDgKsFUnv5VAGeQjz8kxcgDP0HoE0iZNp0OdZNlhE= -google.golang.org/genproto/googleapis/rpc v0.0.0-20250324211829-b45e905df463 h1:e0AIkUUhxyBKh6ssZNrAMeqhA7RKUj42346d1y02i2g= -google.golang.org/genproto/googleapis/rpc v0.0.0-20250324211829-b45e905df463/go.mod h1:qQ0YXyHHx3XkvlzUtpXDkS29lDSafHMZBAZDc03LQ3A= google.golang.org/genproto/googleapis/rpc v0.0.0-20250715232539-7130f93afb79 h1:1ZwqphdOdWYXsUHgMpU/101nCtf/kSp9hOrcvFsnl10= google.golang.org/genproto/googleapis/rpc v0.0.0-20250715232539-7130f93afb79/go.mod h1:qQ0YXyHHx3XkvlzUtpXDkS29lDSafHMZBAZDc03LQ3A= -google.golang.org/grpc v1.71.0 h1:kF77BGdPTQ4/JZWMlb9VpJ5pa25aqvVqogsxNHHdeBg= -google.golang.org/grpc v1.71.0/go.mod h1:H0GRtasmQOh9LkFoCPDu3ZrwUtD1YGE+b2vYBYd/8Ec= google.golang.org/grpc v1.73.0 h1:VIWSmpI2MegBtTuFt5/JWy2oXxtjJ/e89Z70ImfD2ok= google.golang.org/grpc v1.73.0/go.mod h1:50sbHOUqWoCQGI8V2HQLJM0B+LMlIUjNSZmow7EVBQc= google.golang.org/grpc/cmd/protoc-gen-go-grpc v1.5.1 h1:F29+wU6Ee6qgu9TddPgooOdaqsxTMunOoj8KA5yuS5A= diff --git a/main.go b/main.go index 45db6ef..e20eb60 100644 --- a/main.go +++ b/main.go @@ -15,20 +15,29 @@ import ( "fmt" "os" "os/signal" + "sync" + "time" - "github.com/rs/zerolog/log" + "github.com/rs/zerolog" "golang.org/x/sys/unix" "gitea.libretechconsulting.com/rmcguire/go-app/pkg/app" - optsgrpc "gitea.libretechconsulting.com/rmcguire/go-app/pkg/srv/grpc/opts" - optshttp "gitea.libretechconsulting.com/rmcguire/go-app/pkg/srv/http/opts" "gitea.libretechconsulting.com/rmcguire/go-server-with-otel/pkg/config" - "gitea.libretechconsulting.com/rmcguire/go-server-with-otel/pkg/demogrpc" - "gitea.libretechconsulting.com/rmcguire/go-server-with-otel/pkg/demohttp" + "gitea.libretechconsulting.com/rmcguire/go-server-with-otel/pkg/demo" + "gitea.libretechconsulting.com/rmcguire/go-server-with-otel/pkg/service" ) -var flagSchema bool +const terminationGracePeriod = 30 * time.Second + +var ( + flagSchema bool + + // TODO: Register your service.AppService implementers here + appServices = []service.AppService{ + &demo.DemoService{}, + } +) func main() { ctx, cncl := signal.NotifyContext(context.Background(), os.Interrupt, unix.SIGTERM) @@ -37,7 +46,9 @@ func main() { // Load configuration and setup logging. The go-app framework // will handle loading config and environment into our demo // app config struct which embeds app.AooConfig - ctx, demoApp := app.MustLoadConfigInto(ctx, &config.DemoConfig{}) + ctx, serviceConfig := app.MustLoadConfigInto(ctx, &config.ServiceConfig{}) + + log := zerolog.Ctx(ctx) // Print schema if that's all we have to do if flagSchema { @@ -45,32 +56,50 @@ func main() { os.Exit(1) } - log.Debug().Any("demoAppMergedConfig", demoApp).Msg("demo app config prepared") + log.Debug().Any("mergedConfig", serviceConfig).Msg("App configuration prepared") - // Prepare servers - demoHTTP := demohttp.NewDemoHTTPServer(ctx, demoApp) - demoGRPC := demogrpc.NewDemoGRPCServer(ctx, demoApp) + // Prepare services + var err error + sdFuncs := make([]service.ShutdownFunc, len(appServices)) + for i, svc := range appServices { + sdFuncs[i], err = svc.Init(ctx, serviceConfig) + if err != nil { + log.Fatal().Err(err).Send() + } + } - // Prepare app + // Merge all service implementations for app + grpcSvcs, httpSvcs := service.MergeServices(ctx, appServices...) + + // Prepare app with all merged services app := &app.App{ AppContext: ctx, - GRPC: &optsgrpc.AppGRPC{ - Services: demoGRPC.GetServices(), - GRPCDialOpts: demoGRPC.GetDialOpts(), - }, - HTTP: &optshttp.AppHTTP{ - Ctx: ctx, - HealthChecks: demoHTTP.GetHealthCheckFuncs(), - Funcs: demoHTTP.GetHandleFuncs(), - }, + GRPC: grpcSvcs, + HTTP: httpSvcs, } // Launch app app.MustRun() - // Wait for app to complete - // Perform any extra shutdown here + // Wait for app to complete and then perform internal shutdown <-app.Done() + + log.Info().Int("numServices", len(appServices)).Msg("shutting down app services") + + sdCtx, cncl := context.WithTimeout(context.Background(), terminationGracePeriod) + defer cncl() + + // Call registered shutdown funcs from all services + var sdWg sync.WaitGroup + for _, sdFunc := range sdFuncs { + sdWg.Add(1) + go func() { + defer sdWg.Done() + svcName, err := sdFunc(sdCtx) + log.Err(err).Str("service", svcName).Msg("terminated") + }() + } + sdWg.Wait() } // flag.Parse will be called by go-app @@ -79,7 +108,7 @@ func init() { } func printSchema() { - bytes, err := app.CustomSchema(&config.DemoConfig{}) + bytes, err := app.CustomSchema(&config.ServiceConfig{}) if err != nil { panic(err) } diff --git a/pkg/config/custom.go b/pkg/config/custom.go index d2997eb..362fb2c 100644 --- a/pkg/config/custom.go +++ b/pkg/config/custom.go @@ -1,13 +1,14 @@ -// This serves as a reference sample configuration -// to show how to merge custom config fields into -// go-app configuration +// Package config contains ServiceConfig, which is intended +// to extend go-app/pkg/config.AppConfig. Add any custom fields +// here, and it will automatically be handled by go-app, including +// overrides by environment, and json schema generation package config import ( "gitea.libretechconsulting.com/rmcguire/go-app/pkg/config" ) -type DemoConfig struct { +type ServiceConfig struct { Timezone string `yaml:"timezone" json:"timezone,omitempty" default:"UTC"` Opts *DemoOpts `yaml:"opts" json:"opts,omitempty"` diff --git a/pkg/demo/demo.go b/pkg/demo/demo.go new file mode 100644 index 0000000..e745e49 --- /dev/null +++ b/pkg/demo/demo.go @@ -0,0 +1,54 @@ +// Package demo provides a reference implementation +// of service.AppService. It packages out the GRPC and HTTP +// functionality, for the sake of structure. +package demo + +import ( + "context" + + optsgrpc "gitea.libretechconsulting.com/rmcguire/go-app/pkg/srv/grpc/opts" + optshttp "gitea.libretechconsulting.com/rmcguire/go-app/pkg/srv/http/opts" + + "gitea.libretechconsulting.com/rmcguire/go-server-with-otel/pkg/config" + "gitea.libretechconsulting.com/rmcguire/go-server-with-otel/pkg/demo/demogrpc" + "gitea.libretechconsulting.com/rmcguire/go-server-with-otel/pkg/demo/demohttp" + "gitea.libretechconsulting.com/rmcguire/go-server-with-otel/pkg/service" +) + +type DemoService struct { + ctx context.Context + config *config.ServiceConfig + http *demohttp.DemoHTTPServer + grpc *demogrpc.DemoGRPCServer +} + +func (d *DemoService) Init(ctx context.Context, config *config.ServiceConfig, +) (service.ShutdownFunc, error) { + d.config = config + d.ctx = ctx + + // These don't HAVE to be split into separate packages + // This is, after all, a demo app. Just implement the interface. + d.http = demohttp.NewDemoHTTPServer(ctx, config) + d.grpc = demogrpc.NewDemoGRPCServer(ctx, config) + + // TODO: This should actually do shutdown stuff + return func(_ context.Context) (string, error) { + return "DemoService", nil + }, nil +} + +func (d *DemoService) GetGRPC() *optsgrpc.AppGRPC { + return &optsgrpc.AppGRPC{ + Services: d.grpc.GetServices(), + GRPCDialOpts: d.grpc.GetDialOpts(), + } +} + +func (d *DemoService) GetHTTP() *optshttp.AppHTTP { + return &optshttp.AppHTTP{ + Ctx: d.ctx, + Funcs: d.http.GetHandleFuncs(), + HealthChecks: d.http.GetHealthCheckFuncs(), + } +} diff --git a/pkg/demogrpc/demo.go b/pkg/demo/demogrpc/demo.go similarity index 94% rename from pkg/demogrpc/demo.go rename to pkg/demo/demogrpc/demo.go index ddc628b..ccdb7ef 100644 --- a/pkg/demogrpc/demo.go +++ b/pkg/demo/demogrpc/demo.go @@ -27,12 +27,12 @@ const ( type DemoGRPCServer struct { tracer trace.Tracer ctx context.Context - cfg *config.DemoConfig + cfg *config.ServiceConfig client *resty.Client pb.UnimplementedDemoAppServiceServer } -func NewDemoGRPCServer(ctx context.Context, cfg *config.DemoConfig) *DemoGRPCServer { +func NewDemoGRPCServer(ctx context.Context, cfg *config.ServiceConfig) *DemoGRPCServer { if cfg.Opts == nil { cfg.Opts = &config.DemoOpts{} } diff --git a/pkg/demogrpc/fact.go b/pkg/demo/demogrpc/fact.go similarity index 100% rename from pkg/demogrpc/fact.go rename to pkg/demo/demogrpc/fact.go diff --git a/pkg/demogrpc/server.go b/pkg/demo/demogrpc/server.go similarity index 100% rename from pkg/demogrpc/server.go rename to pkg/demo/demogrpc/server.go diff --git a/pkg/demohttp/server.go b/pkg/demo/demohttp/server.go similarity index 87% rename from pkg/demohttp/server.go rename to pkg/demo/demohttp/server.go index c0f6dd2..a2603e8 100644 --- a/pkg/demohttp/server.go +++ b/pkg/demo/demohttp/server.go @@ -11,10 +11,10 @@ import ( type DemoHTTPServer struct { ctx context.Context - cfg *config.DemoConfig + cfg *config.ServiceConfig } -func NewDemoHTTPServer(ctx context.Context, cfg *config.DemoConfig) *DemoHTTPServer { +func NewDemoHTTPServer(ctx context.Context, cfg *config.ServiceConfig) *DemoHTTPServer { return &DemoHTTPServer{ ctx: ctx, cfg: cfg, diff --git a/pkg/service/service.go b/pkg/service/service.go new file mode 100644 index 0000000..e7f98ce --- /dev/null +++ b/pkg/service/service.go @@ -0,0 +1,63 @@ +// Package service defines generics around implementation of +// a new service that provides configuration for go-app +// +// The interface is meant to make the template more clear to implement +// without unnecessary changes in main.go +package service + +import ( + "context" + + "gitea.libretechconsulting.com/rmcguire/go-server-with-otel/pkg/config" + + optsgrpc "gitea.libretechconsulting.com/rmcguire/go-app/pkg/srv/grpc/opts" + optshttp "gitea.libretechconsulting.com/rmcguire/go-app/pkg/srv/http/opts" +) + +type ShutdownFunc func(ctx context.Context) (string, error) + +type AppService interface { + Init(ctx context.Context, config *config.ServiceConfig) (ShutdownFunc, error) + GetGRPC() *optsgrpc.AppGRPC + GetHTTP() *optshttp.AppHTTP +} + +// MergeServices is used if multiple services are served by this server +// with their own distinct packages and configuration +// +// You should be overriding the done chan, listener, or any other +// configuration used by the SERVER rather than the individual services. +func MergeServices(ctx context.Context, appServices ...AppService) (*optsgrpc.AppGRPC, *optshttp.AppHTTP) { + mergedGRPC := &optsgrpc.AppGRPC{} + for _, svc := range appServices { + mergedGRPC = mergeGRPC(mergedGRPC, svc.GetGRPC()) + } + + mergedHTTP := &optshttp.AppHTTP{} + for _, svc := range appServices { + mergedHTTP = mergeHTTP(mergedHTTP, svc.GetHTTP()) + } + mergedHTTP.Ctx = ctx + + return mergedGRPC, mergedHTTP +} + +func mergeHTTP(a *optshttp.AppHTTP, b *optshttp.AppHTTP) *optshttp.AppHTTP { + return &optshttp.AppHTTP{ + Funcs: append(a.Funcs, b.Funcs...), + Middleware: append(a.Middleware, b.Middleware...), + Handlers: append(a.Handlers, b.Handlers...), + HealthChecks: append(a.HealthChecks, b.HealthChecks...), + } +} + +func mergeGRPC(a *optsgrpc.AppGRPC, b *optsgrpc.AppGRPC) *optsgrpc.AppGRPC { + return &optsgrpc.AppGRPC{ + Services: append(a.Services, b.Services...), + GRPCOpts: append(a.GRPCOpts, b.GRPCOpts...), + UnaryInterceptors: append(a.UnaryInterceptors, b.UnaryInterceptors...), + StreamInterceptors: append(a.StreamInterceptors, b.StreamInterceptors...), + GRPCDialOpts: append(a.GRPCDialOpts, b.GRPCDialOpts...), + GRPCGatewayOpts: append(a.GRPCGatewayOpts, b.GRPCGatewayOpts...), + } +}