Merge pull request #457 from gofr-dev/release/v1.3.1

srijan-27 · web-flow · commit b1e7edcb10ae · 2024-04-10T18:02:04.000+05:30
Release v1.3.1
diff --git a/Dockerfile b/Dockerfile
@@ -1,10 +1,10 @@
-FROM golang:1.16
+FROM golang:1.21
 
 RUN mkdir -p /go/src/gofr.dev
 WORKDIR /go/src/gofr.dev
 COPY . .
 
-RUN go build -ldflags "-linkmode external -extldflags -static" -a examples/simple-api/main.go
+RUN go build -ldflags "-linkmode external -extldflags -static" -a examples/http-server/main.go
 
 FROM alpine:latest
 RUN apk add --no-cache tzdata ca-certificates
diff --git a/docs/navigation.js b/docs/navigation.js
@@ -7,7 +7,7 @@ export const navigation = [
             { title: 'Connecting Redis', href: '/docs/quick-start/connecting-redis' },
             { title: 'Connecting MySQL', href: '/docs/quick-start/connecting-mysql' },
             { title: 'Observability', href: '/docs/quick-start/observability' },
-            { title: 'Adding REST Handlers', href: '/docs/quick-start/add-rest-handler' },
+            { title: 'Adding REST Handlers', href: '/docs/quick-start/add-rest-handlers' },
         ],
     },
     {
diff --git a/docs/quick-start/observability/page.md b/docs/quick-start/observability/page.md
@@ -149,6 +149,8 @@ GoFr automatically exports traces for all requests and responses. GoFr uses
 {% new-tab-link title="OpenTelemetry" href="https://opentelemetry.io/docs/concepts/what-is-opentelemetry/" /%} , a popular tracing framework, to
 automatically add traces to all requests and responses.
 
+GoFr has support for both zipkin as well as jaeger trace exporters.
+
 **Automatic Correlation ID Propagation:**
 
 When a request enters your GoFr application, GoFr automatically generates a correlation-ID `X-Correlation-ID` and adds it
@@ -179,14 +181,15 @@ DB_NAME=test_db
 DB_PORT=3306
 
 # tracing configs
+TRACE_EXPORTER=zipkin  // Supported : zipkin,jaeger
 TRACER_HOST=localhost
 TRACER_PORT=2005
 
 LOG_LEVEL=DEBUG
 ```
 
 > **NOTE:** If the value of `TRACER_PORT` is not
-> provided, gofr uses port `9411` by default.
+> provided, gofr uses  port `9411` by default. 
 
 Open {% new-tab-link title="zipkin" href="http://localhost:2005/zipkin/" /%} and search by TraceID (correlationID) to see the trace.
 {% figure src="/quick-start-trace.png" alt="Zapin traces" /%}
diff --git a/examples/grpc-server/configs/.env b/examples/grpc-server/configs/.env
@@ -1 +1 @@
-GRPC_PORT=10000
+GRPC_PORT=10000
diff --git a/examples/http-server-using-redis/Dockerfile b/examples/http-server-using-redis/Dockerfile
@@ -1,4 +1,4 @@
-FROM golang:1.16
+FROM golang:1.21
 
 RUN mkdir /src/
 WORKDIR /src/
@@ -10,6 +10,6 @@ FROM alpine:latest
 RUN apk add --no-cache tzdata ca-certificates
 COPY --from=0 /src/main /main
 COPY --from=0 /src/configs /configs
-EXPOSE 9000
+EXPOSE 8000
 
 CMD ["/main"]
diff --git a/examples/http-server-using-redis/main_test.go b/examples/http-server-using-redis/main_test.go
@@ -32,7 +32,7 @@ func TestHTTPServerUsingRedis(t *testing.T) {
 		statusCode int
 	}{
 		{"post handler", http.MethodPost, []byte(`{"key1":"GoFr"}`), "/redis",
-			http.StatusOK},
+			http.StatusCreated},
 		{"post invalid body", http.MethodPost, []byte(`{key:abc}`), "/redis",
 			http.StatusInternalServerError},
 		{"get handler", http.MethodGet, nil, "/redis/key1", http.StatusOK},
diff --git a/examples/http-server/Dockerfile b/examples/http-server/Dockerfile
@@ -1,4 +1,4 @@
-FROM golang:1.16
+FROM golang:1.21
 
 RUN mkdir /src/
 WORKDIR /src/
diff --git a/examples/http-server/configs/.env b/examples/http-server/configs/.env
@@ -11,5 +11,6 @@ DB_NAME=test
 DB_PORT=2001
 DB_DIALECT=mysql
 
+TRACE_EXPORTER=zipkin
 TRACER_HOST=localhost
 TRACER_PORT=2005
diff --git a/examples/using-add-rest-handlers/Dockerfile b/examples/using-add-rest-handlers/Dockerfile
@@ -1,4 +1,4 @@
-FROM golang:1.16
+FROM golang:1.21
 
 RUN mkdir /src/
 WORKDIR /src/
@@ -10,6 +10,6 @@ FROM alpine:latest
 RUN apk add --no-cache tzdata ca-certificates
 COPY --from=0 /src/main /main
 COPY --from=0 /src/configs /configs
-EXPOSE 9000
+EXPOSE 9090
 
 CMD ["/main"]
diff --git a/examples/using-add-rest-handlers/configs/.env b/examples/using-add-rest-handlers/configs/.env
@@ -8,5 +8,6 @@ DB_NAME=test
 DB_PORT=2001
 DB_DIALECT=mysql
 
+TRACE_EXPORTER=zipkin
 TRACER_HOST=localhost
 TRACER_PORT=2005
diff --git a/examples/using-add-rest-handlers/main_test.go b/examples/using-add-rest-handlers/main_test.go
@@ -23,12 +23,12 @@ func TestIntegration_AddRESTHandlers(t *testing.T) {
 	}{
 		{"empty path", http.MethodGet, "/", nil, 404},
 		{"success Create", http.MethodPost, "/user",
-			[]byte(`{"id":10, "name":"john doe", "age":99, "isEmployed": true}`), 200},
+			[]byte(`{"id":10, "name":"john doe", "age":99, "isEmployed": true}`), 201},
 		{"success GetAll", http.MethodGet, "/user", nil, 200},
 		{"success Get", http.MethodGet, "/user/10", nil, 200},
 		{"success Update", http.MethodPut, "/user/10",
 			[]byte(`{"name":"john doe", "age":99, "isEmployed": false}`), 200},
-		{"success Delete", http.MethodDelete, "/user/10", nil, 200},
+		{"success Delete", http.MethodDelete, "/user/10", nil, 204},
 	}
 
 	for i, tc := range tests {
diff --git a/examples/using-custom-metrics/Dockerfile b/examples/using-custom-metrics/Dockerfile
@@ -0,0 +1,15 @@
+FROM golang:1.21
+
+RUN mkdir /src/
+WORKDIR /src/
+COPY . .
+RUN go get ./...
+RUN go build -ldflags "-linkmode external -extldflags -static" -a main.go
+
+FROM alpine:latest
+RUN apk add --no-cache tzdata ca-certificates
+COPY --from=0 /src/main /main
+COPY --from=0 /src/configs /configs
+EXPOSE 9011
+
+CMD ["/main"]
diff --git a/examples/using-file-bind/Dockerfile b/examples/using-file-bind/Dockerfile
@@ -0,0 +1,15 @@
+FROM golang:1.21
+
+RUN mkdir /src/
+WORKDIR /src/
+COPY . .
+RUN go get ./...
+RUN go build -ldflags "-linkmode external -extldflags -static" -a main.go
+
+FROM alpine:latest
+RUN apk add --no-cache tzdata ca-certificates
+COPY --from=0 /src/main /main
+COPY --from=0 /src/configs /configs
+EXPOSE 8300
+
+CMD ["/main"]
diff --git a/examples/using-file-bind/main_test.go b/examples/using-file-bind/main_test.go
@@ -30,7 +30,7 @@ func TestMain_BindError(t *testing.T) {
 	req.Header.Set("content-type", contentType)
 
 	resp, err = c.Do(req)
-	assert.Equal(t, 200, resp.StatusCode)
+	assert.Equal(t, 201, resp.StatusCode)
 }
 
 func generateMultiPartBody(t *testing.T) (*bytes.Buffer, string) {
diff --git a/examples/using-http-service/Dockerfile b/examples/using-http-service/Dockerfile
@@ -0,0 +1,15 @@
+FROM golang:1.21
+
+RUN mkdir /src/
+WORKDIR /src/
+COPY . .
+RUN go get ./...
+RUN go build -ldflags "-linkmode external -extldflags -static" -a main.go
+
+FROM alpine:latest
+RUN apk add --no-cache tzdata ca-certificates
+COPY --from=0 /src/main /main
+COPY --from=0 /src/configs /configs
+EXPOSE 9001
+
+CMD ["/main"]
diff --git a/examples/using-migrations/Dockerfile b/examples/using-migrations/Dockerfile
@@ -0,0 +1,15 @@
+FROM golang:1.21
+
+RUN mkdir /src/
+WORKDIR /src/
+COPY . .
+RUN go get ./...
+RUN go build -ldflags "-linkmode external -extldflags -static" -a main.go
+
+FROM alpine:latest
+RUN apk add --no-cache tzdata ca-certificates
+COPY --from=0 /src/main /main
+COPY --from=0 /src/configs /configs
+EXPOSE 9100
+
+CMD ["/main"]
diff --git a/examples/using-migrations/configs/.env b/examples/using-migrations/configs/.env
@@ -15,5 +15,6 @@ PUBSUB_BACKEND=KAFKA
 PUBSUB_BROKER=localhost:9092
 CONSUMER_ID=test
 
+TRACE_EXPORTER=zipkin
 TRACER_HOST=localhost
 TRACER_PORT=2005
diff --git a/examples/using-migrations/main_test.go b/examples/using-migrations/main_test.go
@@ -22,7 +22,7 @@ func TestExampleMigration(t *testing.T) {
 		statusCode int
 	}{
 		{"post new employee with valid data", http.MethodPost, "/employee",
-			[]byte(`{"id":2,"name":"John","gender":"Male","contact_number":1234567890,"dob":"2000-01-01"}`), 200},
+			[]byte(`{"id":2,"name":"John","gender":"Male","contact_number":1234567890,"dob":"2000-01-01"}`), 201},
 		{"get employee with valid name", http.MethodGet, "/employee?name=John", nil, 200},
 		{"get employee does not exist", http.MethodGet, "/employee?name=Invalid", nil, 500},
 		{"get employee with empty name", http.MethodGet, "/employee", nil, http.StatusInternalServerError},
diff --git a/examples/using-publisher/Dockerfile b/examples/using-publisher/Dockerfile
@@ -0,0 +1,15 @@
+FROM golang:1.21
+
+RUN mkdir /src/
+WORKDIR /src/
+COPY . .
+RUN go get ./...
+RUN go build -ldflags "-linkmode external -extldflags -static" -a main.go
+
+FROM alpine:latest
+RUN apk add --no-cache tzdata ca-certificates
+COPY --from=0 /src/main /main
+COPY --from=0 /src/configs /configs
+EXPOSE 8100
+
+CMD ["/main"]
diff --git a/examples/using-publisher/main_test.go b/examples/using-publisher/main_test.go
@@ -25,7 +25,7 @@ func TestExamplePublisher(t *testing.T) {
 			desc:               "valid order",
 			path:               "/publish-order",
 			body:               []byte(`{"data":{"orderId":"123","status":"pending"}}`),
-			expectedStatusCode: http.StatusOK,
+			expectedStatusCode: http.StatusCreated,
 		},
 		{
 			desc:               "invalid order",
@@ -37,7 +37,7 @@ func TestExamplePublisher(t *testing.T) {
 			desc:               "valid product",
 			path:               "/publish-product",
 			body:               []byte(`{"data":{"productId":"123","price":"599"}}`),
-			expectedStatusCode: http.StatusOK,
+			expectedStatusCode: http.StatusCreated,
 		},
 		{
 			desc:               "invalid product",
diff --git a/examples/using-subscriber/Dockerfile b/examples/using-subscriber/Dockerfile
@@ -0,0 +1,15 @@
+FROM golang:1.21
+
+RUN mkdir /src/
+WORKDIR /src/
+COPY . .
+RUN go get ./...
+RUN go build -ldflags "-linkmode external -extldflags -static" -a main.go
+
+FROM alpine:latest
+RUN apk add --no-cache tzdata ca-certificates
+COPY --from=0 /src/main /main
+COPY --from=0 /src/configs /configs
+EXPOSE 8200
+
+CMD ["/main"]
diff --git a/go.mod b/go.mod
@@ -24,6 +24,7 @@ require (
 	go.opentelemetry.io/contrib/instrumentation/net/http/httptrace/otelhttptrace v0.49.0
 	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.49.0
 	go.opentelemetry.io/otel v1.24.0
+	go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.24.0
 	go.opentelemetry.io/otel/exporters/prometheus v0.46.0
 	go.opentelemetry.io/otel/exporters/zipkin v1.24.0
 	go.opentelemetry.io/otel/metric v1.24.0
@@ -34,7 +35,7 @@ require (
 	golang.org/x/oauth2 v0.18.0
 	golang.org/x/term v0.18.0
 	google.golang.org/api v0.172.0
-	google.golang.org/grpc v1.62.1
+	google.golang.org/grpc v1.63.0
 	google.golang.org/protobuf v1.33.0
 )
 
@@ -46,19 +47,21 @@ require (
 	filippo.io/edwards25519 v1.1.0 // indirect
 	github.com/alicebob/gopher-json v0.0.0-20200520072559-a9ecdc9d1d3a // indirect
 	github.com/beorn7/perks v1.0.1 // indirect
+	github.com/cenkalti/backoff/v4 v4.3.0 // indirect
 	github.com/cespare/xxhash/v2 v2.2.0 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect
 	github.com/felixge/httpsnoop v1.0.4 // indirect
 	github.com/go-logr/logr v1.4.1 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
-	github.com/golang/protobuf v1.5.3 // indirect
+	github.com/golang/protobuf v1.5.4 // indirect
 	github.com/google/go-cmp v0.6.0 // indirect
 	github.com/google/s2a-go v0.1.7 // indirect
 	github.com/googleapis/enterprise-certificate-proxy v0.3.2 // indirect
 	github.com/googleapis/gax-go/v2 v2.12.3 // indirect
 	github.com/gorilla/websocket v1.5.0 // indirect
+	github.com/grpc-ecosystem/grpc-gateway/v2 v2.19.0 // indirect
 	github.com/klauspost/compress v1.16.6 // indirect
 	github.com/openzipkin/zipkin-go v0.4.2 // indirect
 	github.com/pierrec/lz4/v4 v4.1.17 // indirect
@@ -73,15 +76,17 @@ require (
 	go.einride.tech/aip v0.66.0 // indirect
 	go.opencensus.io v0.24.0 // indirect
 	go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.49.0 // indirect
+	go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.24.0 // indirect
+	go.opentelemetry.io/proto/otlp v1.1.0 // indirect
 	golang.org/x/crypto v0.21.0 // indirect
-	golang.org/x/net v0.22.0 // indirect
+	golang.org/x/net v0.23.0 // indirect
 	golang.org/x/sync v0.6.0 // indirect
 	golang.org/x/sys v0.18.0 // indirect
 	golang.org/x/text v0.14.0 // indirect
 	golang.org/x/time v0.5.0 // indirect
 	google.golang.org/appengine v1.6.8 // indirect
-	google.golang.org/genproto v0.0.0-20240213162025-012b6fc9bca9 // indirect
+	google.golang.org/genproto v0.0.0-20240227224415-6ceb2ff114de // indirect
 	google.golang.org/genproto/googleapis/api v0.0.0-20240311132316-a219d84964c2 // indirect
-	google.golang.org/genproto/googleapis/rpc v0.0.0-20240318140521-94a12d6c2237 // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20240401170217-c3f982113cda // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )
diff --git a/go.sum b/go.sum
diff --git a/pkg/gofr/crud_handlers_test.go b/pkg/gofr/crud_handlers_test.go
diff --git a/pkg/gofr/datasource/pubsub/google/google_test.go b/pkg/gofr/datasource/pubsub/google/google_test.go
diff --git a/pkg/gofr/gofr.go b/pkg/gofr/gofr.go
diff --git a/pkg/gofr/gofr_test.go b/pkg/gofr/gofr_test.go
diff --git a/pkg/gofr/handler.go b/pkg/gofr/handler.go
diff --git a/pkg/gofr/handler_test.go b/pkg/gofr/handler_test.go
diff --git a/pkg/gofr/http/responder.go b/pkg/gofr/http/responder.go
diff --git a/pkg/gofr/http/responder_test.go b/pkg/gofr/http/responder_test.go
diff --git a/pkg/gofr/version/version.go b/pkg/gofr/version/version.go

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ export const navigation = [`
`7`	`7`	`{ title: 'Connecting Redis', href: '/docs/quick-start/connecting-redis' },`
`8`	`8`	`{ title: 'Connecting MySQL', href: '/docs/quick-start/connecting-mysql' },`
`9`	`9`	`{ title: 'Observability', href: '/docs/quick-start/observability' },`
`10`		`- { title: 'Adding REST Handlers', href: '/docs/quick-start/add-rest-handler' },`
	`10`	`+ { title: 'Adding REST Handlers', href: '/docs/quick-start/add-rest-handlers' },`
`11`	`11`	`],`
`12`	`12`	`},`
`13`	`13`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-FROM golang:1.16`
	`1`	`+FROM golang:1.21`
`2`	`2`
`3`	`3`	`RUN mkdir /src/`
`4`	`4`	`WORKDIR /src/`