Merge branch 'apache:develop' into develop

Author: hs80

.github/workflows/cloc.yml

@@ -36,7 +36,7 @@ jobs:
           echo "::set-output name=body::$(python3 -c "import json; j=json.load(open('cloc.json')); s=j.get('SUM',{}); print(f'Files: {s.get('files',0)}, Code: {s.get('code',0)}, Blank: {s.get('blank',0)}')")"
 
       - name: post or update PR comment with cloc summary
-        uses: peter-evans/create-or-update-comment@v3
+        uses: peter-evans/create-or-update-comment@v3 # NOSONAR
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           issue-number: ${{ github.event.pull_request.number }}

.github/workflows/github-actions.yml

@@ -62,7 +62,7 @@ jobs:
           ${{ runner.os }}-go-
 
     - name: Check Code Format
-      run: make fmt && git status && [[ -z `git status -s` ]]
+      run: make check-fmt
 
     - name: Unit Test
       run: make test

Makefile

@@ -26,7 +26,7 @@ MAKEFLAGS += --no-print-directory
 CLI_DIR = tools/dubbogo-cli
 IMPORTS_FORMATTER_DIR = tools/imports-formatter
 
-.PHONY: help test fmt clean lint
+.PHONY: help test fmt clean lint check-fmt
 
 help:
 	@echo "Available commands:"
@@ -46,6 +46,18 @@ fmt: install-imports-formatter
 	go fmt ./... && GOROOT=$(shell go env GOROOT) imports-formatter
 	cd $(CLI_DIR) && go fmt ./...
 
+# This command is used in CI to verify that code formatting is correct
+check-fmt:
+	@echo "Checking code format..."
+	@$(MAKE) fmt
+	@if ! git diff --exit-code --quiet; then \
+		echo "Error: The following files have formatting changes:"; \
+		git diff --name-only; \
+		echo ""; \
+		echo "Please run 'make fmt' to fix formatting issues and commit the changes."; \
+		exit 1; \
+	fi
+
 # Clean test generate files
 clean:
 	rm -rf coverage.txt

common/constant/otel.go

@@ -17,6 +17,6 @@
 
 package constant
 
-const (
-	OtelPackageName = "go.opentelemetry.io/otel"
-)
+// TraceScopeName is unique name of trace used for the filter
+// Reference: https://github.com/open-telemetry/opentelemetry-specification/
+const TraceScopeName = "dubbo.apache.org/dubbo-go/v3/filter/otel/trace"

filter/otel/trace/attachment.go

@@ -33,7 +33,7 @@ type metadataSupplier struct {
 	metadata map[string]any
 }
 
-var _ propagation.TextMapCarrier = &metadataSupplier{}
+var _ propagation.TextMapCarrier = (*metadataSupplier)(nil)
 
 func (s *metadataSupplier) Get(key string) string {
 	if s.metadata == nil {

filter/otel/trace/filter.go

@@ -26,7 +26,6 @@ import (
 	"go.opentelemetry.io/otel/baggage"
 	"go.opentelemetry.io/otel/codes"
 	"go.opentelemetry.io/otel/propagation"
-	"go.opentelemetry.io/otel/sdk"
 	semconv "go.opentelemetry.io/otel/semconv/v1.21.0"
 	"go.opentelemetry.io/otel/trace"
 )
@@ -55,6 +54,11 @@ func init() {
 	})
 }
 
+var _ filter.Filter = (*otelServerFilter)(nil)
+
+// otelServerFilter implements server-side tracing for Dubbo requests
+// by creating and managing trace spans using the configured propagator
+// and tracer provider.
 type otelServerFilter struct {
 	Propagators    propagation.TextMapPropagator
 	TracerProvider trace.TracerProvider
@@ -70,8 +74,8 @@ func (f *otelServerFilter) Invoke(ctx context.Context, invoker base.Invoker, inv
 	ctx = baggage.ContextWithBaggage(ctx, bags)
 
 	tracer := f.TracerProvider.Tracer(
-		constant.OtelPackageName,
-		trace.WithInstrumentationVersion(sdk.Version()),
+		constant.TraceScopeName,
+		trace.WithInstrumentationVersion(constant.Version),
 	)
 
 	ctx, span := tracer.Start(
@@ -86,16 +90,21 @@ func (f *otelServerFilter) Invoke(ctx context.Context, invoker base.Invoker, inv
 	)
 	defer span.End()
 
-	result := invoker.Invoke(ctx, invocation)
+	res := invoker.Invoke(ctx, invocation)
 
-	if result.Error() != nil {
-		span.SetStatus(codes.Error, result.Error().Error())
+	if res.Error() != nil {
+		span.SetStatus(codes.Error, res.Error().Error())
 	} else {
 		span.SetStatus(codes.Ok, codes.Ok.String())
 	}
-	return result
+	return res
 }
 
+var _ filter.Filter = (*otelClientFilter)(nil)
+
+// otelClientFilter implements client-side tracing for Dubbo requests
+// by creating and managing trace spans using the configured propagator
+// and tracer provider.
 type otelClientFilter struct {
 	Propagators    propagation.TextMapPropagator
 	TracerProvider trace.TracerProvider
@@ -107,8 +116,8 @@ func (f *otelClientFilter) OnResponse(ctx context.Context, result result.Result,
 
 func (f *otelClientFilter) Invoke(ctx context.Context, invoker base.Invoker, invocation base.Invocation) result.Result {
 	tracer := f.TracerProvider.Tracer(
-		constant.OtelPackageName,
-		trace.WithInstrumentationVersion(sdk.Version()),
+		constant.TraceScopeName,
+		trace.WithInstrumentationVersion(constant.Version),
 	)
 
 	var span trace.Span
@@ -132,12 +141,12 @@ func (f *otelClientFilter) Invoke(ctx context.Context, invoker base.Invoker, inv
 	for k, v := range attachments {
 		invocation.SetAttachment(k, v)
 	}
-	result := invoker.Invoke(ctx, invocation)
+	res := invoker.Invoke(ctx, invocation)
 
-	if result.Error() != nil {
-		span.SetStatus(codes.Error, result.Error().Error())
+	if res.Error() != nil {
+		span.SetStatus(codes.Error, res.Error().Error())
 	} else {
 		span.SetStatus(codes.Ok, codes.Ok.String())
 	}
-	return result
+	return res
 }