Merge pull request 'add request id in context' (#99) from rq into v3

Reviewed-on: #99

.github/workflows/autoapprove.yml

@@ -0,0 +1,20 @@
+name: "autoapprove"
+
+on:
+  pull_request_target:
+    types: [assigned, opened, synchronize, reopened]
+
+permissions:
+  pull-requests: write
+  contents: write
+
+jobs:
+  autoapprove:
+    runs-on: ubuntu-latest
+    steps:
+      - name: approve
+        uses: hmarr/auto-approve-action@v3
+        if: github.actor == 'vtolstov' || github.actor == 'dependabot[bot]'
+        id: approve
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/automerge.yml

@@ -0,0 +1,21 @@
+name: "automerge"
+
+on:
+  pull_request_target:
+    types: [assigned, opened, synchronize, reopened]
+
+permissions:
+  pull-requests: write
+  contents: write
+
+jobs:
+  automerge:
+    runs-on: ubuntu-latest
+    if: github.actor == 'vtolstov'
+    steps:
+      - name: merge
+        id: merge
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.TOKEN}}

.github/workflows/build.yml

@@ -3,19 +3,20 @@ on:
  push:
     branches:
     - master
+    - v3
 jobs:
   test:
     name: test
     runs-on: ubuntu-latest
     steps:
     - name: setup
-      uses: actions/setup-go@v2
+      uses: actions/setup-go@v3
       with:
-        go-version: 1.16
+        go-version: 1.17
     - name: checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
     - name: cache
-      uses: actions/cache@v2
+      uses: actions/cache@v3
       with:
         path: ~/go/pkg/mod
         key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
@@ -31,9 +32,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: lint
-        uses: golangci/golangci-lint-action@v2
+        uses: golangci/golangci-lint-action@v3.4.0
         continue-on-error: true
         with:
           # Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.

.github/workflows/codeql-analysis.yml

@@ -9,7 +9,7 @@
 # the `language` matrix defined below to confirm you have the correct set of
 # supported CodeQL languages.
 #
-name: "CodeQL"
+name: "codeql"
 
 on:
   workflow_run:
@@ -17,16 +17,16 @@ on:
     types:
       - completed
   push:
-    branches: [ master ]
+    branches: [ master, v3 ]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ master ]
+    branches: [ master, v3 ]
   schedule:
     - cron: '34 1 * * 0'
 
 jobs:
   analyze:
-    name: Analyze
+    name: analyze
     runs-on: ubuntu-latest
     permissions:
       actions: read
@@ -42,12 +42,15 @@ jobs:
         # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
 
     steps:
-    - name: Checkout repository
+    - name: checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
-
+    - name: setup
+      uses: actions/setup-go@v3
+      with:
+        go-version: 1.17
     # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
+    - name: init
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v2
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -57,8 +60,8 @@ jobs:
 
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
+    - name: autobuild
-      uses: github/codeql-action/autobuild@v1
+      uses: github/codeql-action/autobuild@v2
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -71,5 +74,5 @@ jobs:
     #   make bootstrap
     #   make release
 
-    - name: Perform CodeQL Analysis
+    - name: analyze
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v2

.github/workflows/dependabot-automerge.yml

@@ -1,66 +1,27 @@
-name: "prautomerge"
+name: "dependabot-automerge"
 
 on:
-  workflow_run:
+  pull_request_target:
-    workflows: ["prbuild"]
+    types: [assigned, opened, synchronize, reopened]
-    types:
-      - completed
 
 permissions:
-  contents: write
   pull-requests: write
+  contents: write
 
 jobs:
-  Dependabot-Automerge:
+  automerge:
     runs-on: ubuntu-latest
-    # Contains workaround to execute if dependabot updates the PR by checking for the base branch in the linked PR
+    if: github.actor == 'dependabot[bot]'
-    # The the github.event.workflow_run.event value is 'push' and not 'pull_request'
-    # dont work with multiple workflows when last returns success
-    if: >-
-      github.event.workflow_run.conclusion == 'success'
-      && github.actor == 'dependabot[bot]'
-      && github.event.sender.login == 'dependabot[bot]'
-      && github.event.sender.type == 'Bot'
-      && (github.event.workflow_run.event == 'pull_request'
-          || (github.event.workflow_run.event == 'push' && github.event.workflow_run.pull_requests[0].base.ref == github.event.repository.default_branch ))
     steps:
-      - name: Approve Changes and Merge changes if label 'dependencies' is set
+      - name: metadata
-        uses: actions/github-script@v5
+        id: metadata
+        uses: dependabot/fetch-metadata@v1.3.6
         with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
+          github-token: "${{ secrets.TOKEN }}"
-          script: |
+      - name: merge
-            console.log(context.payload.workflow_run);
+        id: merge
-            
+        if: ${{contains(steps.metadata.outputs.dependency-names, 'go.unistack.org')}}
-            var labelNames = await github.paginate(
+        run: gh pr merge --auto --merge "$PR_URL"
-              github.issues.listLabelsOnIssue,
+        env:
-              {
+          PR_URL: ${{github.event.pull_request.html_url}}
-                repo: context.repo.repo,
+          GITHUB_TOKEN: ${{secrets.TOKEN}}
-                owner: context.repo.owner,
-                issue_number: context.payload.workflow_run.pull_requests[0].number,
-              },
-              (response) => response.data.map(
-                (label) => label.name
-              )
-            );
-
-            console.log(labelNames);
-
-            if (labelNames.includes('dependencies')) {
-              console.log('Found label');
-
-              await github.pulls.createReview({
-                repo: context.repo.repo,
-                owner: context.repo.owner,
-                pull_number: context.payload.workflow_run.pull_requests[0].number,
-                event: 'APPROVE'
-              });
-              console.log('Approved PR');
-
-              await github.pulls.merge({
-                repo: context.repo.repo,
-                owner: context.repo.owner,
-                pull_number: context.payload.workflow_run.pull_requests[0].number,
-              });
-
-              console.log('Merged PR');
-            }

.github/workflows/pr.yml

@@ -3,19 +3,20 @@ on:
   pull_request:
     branches:
     - master
+    - v3
 jobs:
   test:
     name: test
     runs-on: ubuntu-latest
     steps:
     - name: setup
-      uses: actions/setup-go@v2
+      uses: actions/setup-go@v3
       with:
-        go-version: 1.16
+        go-version: 1.17
     - name: checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
     - name: cache
-      uses: actions/cache@v2
+      uses: actions/cache@v3
       with:
         path: ~/go/pkg/mod
         key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
@@ -31,9 +32,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: lint
-        uses: golangci/golangci-lint-action@v2
+        uses: golangci/golangci-lint-action@v3.4.0
         continue-on-error: true
         with:
           # Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.

go.mod

@@ -2,4 +2,4 @@ module go.unistack.org/micro-wrapper-requestid/v3
 
 go 1.16
 
-require go.unistack.org/micro/v3 v3.8.5
+require go.unistack.org/micro/v3 v3.10.19

go.sum

@@ -1,27 +1,7 @@
-github.com/ef-ds/deque v1.0.4/go.mod h1:gXDnTC3yqvBcHbq2lcExjtAcVrOnJCbMcZXmuj8Z4tg=
+github.com/imdario/mergo v0.3.14/go.mod h1:WBLT9ZmE3lPoWsEzCh9LPo3TiwVN+ZKEjmz+hD27ysY=
-github.com/golang-jwt/jwt/v4 v4.1.0/go.mod h1:/xlHOz8bRuivTWchD4jCa+NbatV+wEUSzwAxVc6locg=
-github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=
-github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
-github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
-github.com/imdario/mergo v0.3.12/go.mod h1:jmQim1M+e3UYxmgPu/WyfjB3N3VflVyUjjjwH0dnCYA=
-github.com/patrickmn/go-cache v2.1.0+incompatible h1:HRMgzkcYKYpi3C8ajMPV8OFXaaRUnok+kx1WdO15EQc=
 github.com/patrickmn/go-cache v2.1.0+incompatible/go.mod h1:3Qf8kWWT7OJRJbdiICTKqZju1ZixQ/KpMGzzAfe6+WQ=
-github.com/silas/dag v0.0.0-20210626123444-3804bac2d6d4/go.mod h1:7RTUFBdIRC9nZ7/3RyRNH1bdqIShrDejd1YbLwgPS+I=
+github.com/silas/dag v0.0.0-20211117232152-9d50aa809f35/go.mod h1:7RTUFBdIRC9nZ7/3RyRNH1bdqIShrDejd1YbLwgPS+I=
-go.unistack.org/micro-proto/v3 v3.1.0 h1:q39FwjFiRZn+Ux/tt+d3bJTmDtsQQWa+3SLYVo1vLfA=
+go.unistack.org/micro/v3 v3.10.19 h1:JtPacglETxHyb+GiuMdfxqGtnWSTYXPQm6PlDQfNIl8=
-go.unistack.org/micro-proto/v3 v3.1.0/go.mod h1:DpRhYCBXlmSJ/AAXTmntvlh7kQkYU6eFvlmYAx4BQS8=
+go.unistack.org/micro/v3 v3.10.19/go.mod h1:XIArw29f0b3uvF4cq96X/nQt2f0J2OGnjh8J+DBbC0s=
-go.unistack.org/micro/v3 v3.8.5 h1:DIYWRsQF+NPhKZP45sCtNsUhaRw6u2+Ps7U+pKU7i3s=
-go.unistack.org/micro/v3 v3.8.5/go.mod h1:KMMmOmbgo/D52/rCAbqeKbBsgEEbSKM69he54J3ZIuA=
-golang.org/x/net v0.0.0-20210928044308-7d9f5e0b762b/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
-golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
-golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
-golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
-golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
-golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE=
-golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
-google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
-google.golang.org/protobuf v1.27.1 h1:SnqbnDw1V7RiZcXPx5MEeqPv2s79L9i7BJUlG/+RurQ=
-google.golang.org/protobuf v1.27.1/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

requestid.go

@@ -10,25 +10,40 @@ import (
 	"go.unistack.org/micro/v3/util/id"
 )
 
-// MetadataKey contains metadata key
+var XRequestIDKey struct{}
-var MetadataKey = textproto.CanonicalMIMEHeaderKey("x-request-id")
 
-// MetadataFunc wil be used if user not provide own func to fill metadata
+// DefaultMetadataKey contains metadata key
-var MetadataFunc = func(ctx context.Context) (context.Context, error) {
+var DefaultMetadataKey = textproto.CanonicalMIMEHeaderKey("x-request-id")
-	md, ok := metadata.FromIncomingContext(ctx)
+
+// DefaultMetadataFunc wil be used if user not provide own func to fill metadata
+var DefaultMetadataFunc = func(ctx context.Context) (context.Context, error) {
+	imd, ok := metadata.FromIncomingContext(ctx)
 	if !ok {
-		md = metadata.New(1)
+		imd = metadata.New(1)
 	}
-	if _, ok = md.Get(MetadataKey); ok {
+	omd, ok := metadata.FromOutgoingContext(ctx)
-		return ctx, nil
+	if !ok {
+		omd = metadata.New(1)
 	}
-	uid, err := id.New()
+	v, iok := imd.Get(DefaultMetadataKey)
-	if err != nil {
+	if iok {
-		return ctx, err
+		if _, ook := omd.Get(DefaultMetadataKey); ook {
+			return ctx, nil
+		}
 	}
-	md.Set(MetadataKey, uid)
+	if !iok {
-	ctx = metadata.NewIncomingContext(ctx, md)
+		uid, err := id.New()
-	return ctx, nil
+		if err != nil {
+			return ctx, err
+		}
+		v = uid
+	}
+	imd.Set(DefaultMetadataKey, v)
+	omd.Set(DefaultMetadataKey, v)
+	ctx = metadata.NewIncomingContext(ctx, imd)
+	ctx = metadata.NewOutgoingContext(ctx, omd)
+
+	return context.WithValue(ctx, XRequestIDKey, v), nil
 }
 
 type wrapper struct {
@@ -48,7 +63,7 @@ func NewClientCallWrapper() client.CallWrapper {
 	return func(fn client.CallFunc) client.CallFunc {
 		return func(ctx context.Context, addr string, req client.Request, rsp interface{}, opts client.CallOptions) error {
 			var err error
-			if ctx, err = MetadataFunc(ctx); err != nil {
+			if ctx, err = DefaultMetadataFunc(ctx); err != nil {
 				return err
 			}
 			return fn(ctx, addr, req, rsp, opts)
@@ -58,7 +73,7 @@ func NewClientCallWrapper() client.CallWrapper {
 
 func (w *wrapper) Call(ctx context.Context, req client.Request, rsp interface{}, opts ...client.CallOption) error {
 	var err error
-	if ctx, err = MetadataFunc(ctx); err != nil {
+	if ctx, err = DefaultMetadataFunc(ctx); err != nil {
 		return err
 	}
 	return w.Client.Call(ctx, req, rsp, opts...)
@@ -66,7 +81,7 @@ func (w *wrapper) Call(ctx context.Context, req client.Request, rsp interface{},
 
 func (w *wrapper) Stream(ctx context.Context, req client.Request, opts ...client.CallOption) (client.Stream, error) {
 	var err error
-	if ctx, err = MetadataFunc(ctx); err != nil {
+	if ctx, err = DefaultMetadataFunc(ctx); err != nil {
 		return nil, err
 	}
 	return w.Client.Stream(ctx, req, opts...)
@@ -74,7 +89,7 @@ func (w *wrapper) Stream(ctx context.Context, req client.Request, opts ...client
 
 func (w *wrapper) Publish(ctx context.Context, msg client.Message, opts ...client.PublishOption) error {
 	var err error
-	if ctx, err = MetadataFunc(ctx); err != nil {
+	if ctx, err = DefaultMetadataFunc(ctx); err != nil {
 		return err
 	}
 	return w.Client.Publish(ctx, msg, opts...)
@@ -84,7 +99,7 @@ func NewServerHandlerWrapper() server.HandlerWrapper {
 	return func(fn server.HandlerFunc) server.HandlerFunc {
 		return func(ctx context.Context, req server.Request, rsp interface{}) error {
 			var err error
-			if ctx, err = MetadataFunc(ctx); err != nil {
+			if ctx, err = DefaultMetadataFunc(ctx); err != nil {
 				return err
 			}
 			return fn(ctx, req, rsp)
@@ -96,14 +111,20 @@ func NewServerSubscriberWrapper() server.SubscriberWrapper {
 	return func(fn server.SubscriberFunc) server.SubscriberFunc {
 		return func(ctx context.Context, msg server.Message) error {
 			var err error
-			md, ok := metadata.FromIncomingContext(ctx)
+			imd, ok := metadata.FromIncomingContext(ctx)
 			if !ok {
-				md = metadata.New(1)
+				imd = metadata.New(1)
 			}
-			if id, ok := msg.Header()[MetadataKey]; ok {
+			omd, ok := metadata.FromOutgoingContext(ctx)
-				md.Set(MetadataKey, id)
+			if !ok {
-				ctx = metadata.NewIncomingContext(ctx, md)
+				omd = metadata.New(1)
-			} else if ctx, err = MetadataFunc(ctx); err != nil {
+			}
+			if id, ok := msg.Header()[DefaultMetadataKey]; ok {
+				imd.Set(DefaultMetadataKey, id)
+				omd.Set(DefaultMetadataKey, id)
+				ctx = metadata.NewIncomingContext(ctx, imd)
+				ctx = metadata.NewOutgoingContext(ctx, omd)
+			} else if ctx, err = DefaultMetadataFunc(ctx); err != nil {
 				return err
 			}
 			return fn(ctx, msg)

requestid_test.go

@@ -0,0 +1,33 @@
+package requestid
+
+import (
+	"context"
+	"testing"
+
+	"go.unistack.org/micro/v3/metadata"
+)
+
+func TestDefaultMetadataFunc(t *testing.T) {
+	ctx := context.TODO()
+
+	nctx, err := DefaultMetadataFunc(ctx)
+	if err != nil {
+		t.Fatalf("%v", err)
+	}
+
+	imd, ok := metadata.FromIncomingContext(nctx)
+	if !ok {
+		t.Fatalf("md missing in incoming context")
+	}
+	omd, ok := metadata.FromOutgoingContext(nctx)
+	if !ok {
+		t.Fatalf("md missing in outgoing context")
+	}
+
+	_, iok := imd.Get(DefaultMetadataKey)
+	_, ook := omd.Get(DefaultMetadataKey)
+
+	if !iok || !ook {
+		t.Fatalf("missing metadata key value")
+	}
+}