Compare commits
257 Commits
Author | SHA1 | Date | |
---|---|---|---|
be5f9ab77f | |||
144dca0cae | |||
75173560e3 | |||
9b3bccd1f1 | |||
ce125b77c1 | |||
2ee8d4ed46 | |||
f58781d076 | |||
e1af4aa3a4 | |||
1d5e795443 | |||
a3a434d923 | |||
bcc06054f1 | |||
270d26f1ae | |||
646212cc08 | |||
00c2c749db | |||
2dbada0e94 | |||
7b8f4410fb | |||
45ebef5544 | |||
cf4cac0733 | |||
50d60b5825 | |||
46ef491764 | |||
a51b8b8102 | |||
15aac48f1e | |||
078069b2d7 | |||
258812304a | |||
da5d50db5b | |||
384e4d113d | |||
dfd1da7f0d | |||
8e5015e580 | |||
bd0c309b71 | |||
b4f0c3e29a | |||
8fddaa0455 | |||
2710c269a8 | |||
70ea93e466 | |||
a87d0ab1c1 | |||
2e5e102719 | |||
36e492314d | |||
0c78873277 | |||
7f57dc09d3 | |||
447206d256 | |||
33a7feb970 | |||
3950f2ed86 | |||
68c1048a7d | |||
bff40bd317 | |||
2878d0a4ea | |||
3138a9fded | |||
742b99636a | |||
34387f129d | |||
47075acb06 | |||
09cb998ba4 | |||
b9dbfb1cfc | |||
56efccc4cf | |||
ce9f896287 | |||
83d87a40e4 | |||
75fd1e43b9 | |||
395a3eed3d | |||
3ba8cb7f9e | |||
b07806b9a1 | |||
0f583218d4 | |||
f4d0237785 | |||
0f343dad0b | |||
7c29afba0b | |||
8159b9d233 | |||
45cdac5c29 | |||
98db0dc8bc | |||
453d2232bd | |||
9b387312da | |||
84024f7713 | |||
5a554f9f0c | |||
9c33cbc8e2 | |||
848fe1c0d4 | |||
6cbf23fec5 | |||
7462b0b53c | |||
cb743cee3f | |||
d18952951c | |||
|
f6b7f1b4bc | ||
|
33fa702104 | ||
4debc392d1 | |||
7137d99102 | |||
f76b3171d9 | |||
db3fc42204 | |||
f59023d741 | |||
6f17fd891a | |||
fd93308e8e | |||
2aaa0a74d8 | |||
ccbf23688b | |||
3bd6db79cb | |||
9347bb0651 | |||
0d63723ed3 | |||
a7f84e0baa | |||
c209892ce8 | |||
421842315f | |||
25350a6531 | |||
5e47cc7e8c | |||
1687b98b11 | |||
a81649d2a2 | |||
b48faa3b2b | |||
0be584ef0d | |||
26a2d18766 | |||
25a796fe4f | |||
d23de14769 | |||
2fb108519c | |||
c7ce238da3 | |||
|
67aa79f18a | ||
e6c3d734a3 | |||
1374e27531 | |||
1060f6a4c3 | |||
7d72ab05c6 | |||
42864ff1c6 | |||
49978b75c0 | |||
|
20770b6e30 | ||
b38c6106b2 | |||
|
138c4a0888 | ||
|
22f66fc258 | ||
18fafbbbab | |||
59c08c1d9a | |||
5fbb1a923e | |||
396387d1e8 | |||
|
4c2f12a419 | ||
b2abb86971 | |||
e546eef96c | |||
91701e7a45 | |||
817bf1f4d0 | |||
4120f79b55 | |||
d659db69ff | |||
416bb313fc | |||
ec43cfea6b | |||
|
60194fb42e | ||
|
945d9d16a5 | ||
1c0e5e1a85 | |||
33591e0bc9 | |||
|
75cbaf2612 | ||
f4aee3414b | |||
9f7b61eb17 | |||
5953b5aae6 | |||
4a8f490e0c | |||
eb8c1332f0 | |||
c1c27b6d1d | |||
|
bb22b203cc | ||
|
4df2f3a5a1 | ||
b8ad19a5a2 | |||
|
d32a97c846 | ||
cfe0473ae0 | |||
c26ad51e25 | |||
aefc398b71 | |||
9af23e3e74 | |||
4ab7f19ef0 | |||
d26e9d642b | |||
f9ecb9b056 | |||
dbfcfcd288 | |||
8b6bdb857b | |||
1181e9dc5e | |||
6ac7b53d75 | |||
80d342a72a | |||
8ff312e71d | |||
20e40ccdfd | |||
d4efbb9b22 | |||
b433cbcbb6 | |||
dae3c1170b | |||
a10dd3d08a | |||
b075230ae5 | |||
289aadb28e | |||
9640cdae1a | |||
|
fb35e73731 | ||
f416cb3e0e | |||
57d06d5d27 | |||
0628408c27 | |||
206cd8c3c9 | |||
|
b38db00ee5 | ||
|
0ca39a1477 | ||
d9be99cfde | |||
b37c6006c4 | |||
12f188e3ad | |||
08aaf14a79 | |||
2ce1e94596 | |||
c5aeaf6db7 | |||
1db505decd | |||
8b1a579c9d | |||
11b614f2df | |||
fb4d747197 | |||
00439e23f3 | |||
955953b519 | |||
aa2b5ddaad | |||
46da092899 | |||
b871f64ba6 | |||
74db004f51 | |||
f93ba9d977 | |||
c7da7d5bc8 | |||
ed27647be5 | |||
|
db3b67267e | ||
9ee9cc2a4a | |||
0b41b4f9c5 | |||
8d14753931 | |||
93fc17bad3 | |||
5a1cd12d3d | |||
5c00e6763f | |||
497b82ac6c | |||
a8c6690af7 | |||
98d2264c2a | |||
63641b9840 | |||
2b28057918 | |||
25c551411b | |||
35162a82a4 | |||
0ce0855b6a | |||
226ec43ecf | |||
575af66ddc | |||
|
afb9e8c240 | ||
c10f29ee74 | |||
03410c4ab1 | |||
3805d0f067 | |||
680ac11ef9 | |||
35ab6ae84e | |||
c6c2b0884e | |||
297a80da84 | |||
2d292db7bd | |||
54c4287fab | |||
9c074e5741 | |||
290975eaf5 | |||
c64218d52c | |||
|
46c266a4a9 | ||
5527b16cd8 | |||
4904cad8ef | |||
74633f4290 | |||
|
c8ad4d772b | ||
91bd0f7efe | |||
00dc7e1bb5 | |||
5a5165a003 | |||
382e3d554b | |||
05a0c97fc6 | |||
|
5e06ae1a42 | ||
|
7ac4ad4efa | ||
|
01348bd9b2 | ||
2287c65118 | |||
b34bc7ffff | |||
|
2a0bf03d0a | ||
89114c291c | |||
|
b4b4320fac | ||
7b0d69115c | |||
f054beb6e8 | |||
9fb346594e | |||
|
cbf6fbd780 | ||
|
0392bff282 | ||
|
75b1fe5dc6 | ||
1f232ffba8 | |||
|
7f43b64fc2 | ||
d0d04a840a | |||
1dda3f0dcc | |||
1abf5e7647 | |||
f06610c9c2 | |||
df8560bb6f | |||
0257eae936 | |||
58f03d05e7 | |||
60340a749b | |||
56b0df5b7a | |||
|
bb59d5a2fd | ||
67d5dc7e28 | |||
797c0f822d | |||
8546140e22 |
18
.gitea/ISSUE_TEMPLATE/bug_report.md
Normal file
18
.gitea/ISSUE_TEMPLATE/bug_report.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
---
|
||||||
|
name: Bug report
|
||||||
|
about: For reporting bugs in micro
|
||||||
|
title: "[BUG]"
|
||||||
|
labels: ''
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Describe the bug**
|
||||||
|
|
||||||
|
1. What are you trying to do?
|
||||||
|
2. What did you expect to happen?
|
||||||
|
3. What happens instead?
|
||||||
|
|
||||||
|
**How to reproduce the bug:**
|
||||||
|
|
||||||
|
If possible, please include a minimal code snippet here.
|
17
.gitea/ISSUE_TEMPLATE/feature-request---enhancement.md
Normal file
17
.gitea/ISSUE_TEMPLATE/feature-request---enhancement.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
---
|
||||||
|
name: Feature request / Enhancement
|
||||||
|
about: If you have a need not served by micro
|
||||||
|
title: "[FEATURE]"
|
||||||
|
labels: ''
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Is your feature request related to a problem? Please describe.**
|
||||||
|
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||||
|
|
||||||
|
**Describe the solution you'd like**
|
||||||
|
A clear and concise description of what you want to happen.
|
||||||
|
|
||||||
|
**Additional context**
|
||||||
|
Add any other context or screenshots about the feature request here.
|
8
.gitea/ISSUE_TEMPLATE/question.md
Normal file
8
.gitea/ISSUE_TEMPLATE/question.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
---
|
||||||
|
name: Question
|
||||||
|
about: Ask a question about micro
|
||||||
|
title: ''
|
||||||
|
labels: ''
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
28
.gitea/autoapprove.yml
Normal file
28
.gitea/autoapprove.yml
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
name: "autoapprove"
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request_target:
|
||||||
|
types: [assigned, opened, synchronize, reopened]
|
||||||
|
workflow_run:
|
||||||
|
workflows: ["prbuild"]
|
||||||
|
types:
|
||||||
|
- completed
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
pull-requests: write
|
||||||
|
contents: write
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
autoapprove:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: approve
|
||||||
|
run: [ "curl -o tea https://dl.gitea.com/tea/main/tea-main-linux-amd64",
|
||||||
|
"chmod +x ./tea",
|
||||||
|
"./tea login add --name unistack --token ${{ secrets.GITHUB_TOKEN }} --url https://git.unistack.org",
|
||||||
|
"./tea pr --repo ${{ github.event.repository.name }}"
|
||||||
|
]
|
||||||
|
if: github.actor == 'vtolstov'
|
||||||
|
id: approve
|
||||||
|
with:
|
||||||
|
github-token: ${{ secrets.GITHUB_TOKEN }}
|
24
.gitea/workflows/lint.yml
Normal file
24
.gitea/workflows/lint.yml
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
name: lint
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
- v3
|
||||||
|
jobs:
|
||||||
|
lint:
|
||||||
|
name: lint
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: setup-go
|
||||||
|
uses: https://gitea.com/actions/setup-go@v3
|
||||||
|
with:
|
||||||
|
go-version: 1.18
|
||||||
|
- name: checkout
|
||||||
|
uses: https://gitea.com/actions/checkout@v3
|
||||||
|
- name: deps
|
||||||
|
run: go get -v -d ./...
|
||||||
|
- name: lint
|
||||||
|
uses: https://github.com/golangci/golangci-lint-action@v3.4.0
|
||||||
|
continue-on-error: true
|
||||||
|
with:
|
||||||
|
version: v1.52
|
23
.gitea/workflows/pr.yml
Normal file
23
.gitea/workflows/pr.yml
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
name: pr
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
- v3
|
||||||
|
jobs:
|
||||||
|
test:
|
||||||
|
name: test
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: checkout
|
||||||
|
uses: https://gitea.com/actions/checkout@v3
|
||||||
|
- name: setup-go
|
||||||
|
uses: https://gitea.com/actions/setup-go@v3
|
||||||
|
with:
|
||||||
|
go-version: 1.18
|
||||||
|
- name: deps
|
||||||
|
run: go get -v -t -d ./...
|
||||||
|
- name: test
|
||||||
|
env:
|
||||||
|
INTEGRATION_TESTS: yes
|
||||||
|
run: go test -mod readonly -v ./...
|
9
.github.old/PULL_REQUEST_TEMPLATE.md
Normal file
9
.github.old/PULL_REQUEST_TEMPLATE.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
## Pull Request template
|
||||||
|
Please, go through these steps before clicking submit on this PR.
|
||||||
|
|
||||||
|
1. Give a descriptive title to your PR.
|
||||||
|
2. Provide a description of your changes.
|
||||||
|
3. Make sure you have some relevant tests.
|
||||||
|
4. Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if applicable).
|
||||||
|
|
||||||
|
**PLEASE REMOVE THIS TEMPLATE BEFORE SUBMITTING**
|
24
.github.old/workflows/autoapprove.yml
Normal file
24
.github.old/workflows/autoapprove.yml
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
name: "autoapprove"
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request_target:
|
||||||
|
types: [assigned, opened, synchronize, reopened]
|
||||||
|
workflow_run:
|
||||||
|
workflows: ["prbuild"]
|
||||||
|
types:
|
||||||
|
- completed
|
||||||
|
|
||||||
|
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 }}
|
21
.github.old/workflows/automerge.yml
Normal file
21
.github.old/workflows/automerge.yml
Normal file
@@ -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}}
|
@@ -1,6 +1,6 @@
|
|||||||
name: build
|
name: build
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- master
|
- master
|
||||||
- v3
|
- v3
|
||||||
@@ -10,51 +10,35 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: setup
|
- name: setup
|
||||||
uses: actions/setup-go@v2
|
uses: actions/setup-go@v3
|
||||||
with:
|
with:
|
||||||
go-version: 1.16
|
go-version: 1.17
|
||||||
|
- name: checkout
|
||||||
|
uses: actions/checkout@v3
|
||||||
- name: cache
|
- name: cache
|
||||||
uses: actions/cache@v2
|
uses: actions/cache@v3
|
||||||
with:
|
with:
|
||||||
path: ~/go/pkg/mod
|
path: ~/go/pkg/mod
|
||||||
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
|
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
|
||||||
restore-keys: ${{ runner.os }}-go-
|
restore-keys: ${{ runner.os }}-go-
|
||||||
- name: sdk checkout
|
- name: deps
|
||||||
uses: actions/checkout@v2
|
|
||||||
- name: sdk deps
|
|
||||||
run: go get -v -t -d ./...
|
run: go get -v -t -d ./...
|
||||||
- name: sdk test
|
- name: test
|
||||||
env:
|
env:
|
||||||
INTEGRATION_TESTS: yes
|
INTEGRATION_TESTS: yes
|
||||||
run: go test -mod readonly -v ./...
|
run: go test -mod readonly -v ./...
|
||||||
- name: tests checkout
|
|
||||||
uses: actions/checkout@v2
|
|
||||||
with:
|
|
||||||
repository: unistack-org/micro-tests
|
|
||||||
ref: refs/heads/master
|
|
||||||
path: micro-tests
|
|
||||||
fetch-depth: 1
|
|
||||||
- name: tests deps
|
|
||||||
run: |
|
|
||||||
cd micro-tests
|
|
||||||
go mod edit -replace="github.com/unistack-org/micro/v3=../"
|
|
||||||
go get -v -t -d ./...
|
|
||||||
- name: tests test
|
|
||||||
env:
|
|
||||||
INTEGRATION_TESTS: yes
|
|
||||||
run: cd micro-tests && go test -mod readonly -v ./...
|
|
||||||
lint:
|
lint:
|
||||||
name: lint
|
name: lint
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: checkout
|
- name: checkout
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v3
|
||||||
- name: lint
|
- name: lint
|
||||||
uses: golangci/golangci-lint-action@v2
|
uses: golangci/golangci-lint-action@v3.4.0
|
||||||
continue-on-error: true
|
continue-on-error: true
|
||||||
with:
|
with:
|
||||||
# Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
|
# Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
|
||||||
version: v1.39
|
version: v1.30
|
||||||
# Optional: working directory, useful for monorepos
|
# Optional: working directory, useful for monorepos
|
||||||
# working-directory: somedir
|
# working-directory: somedir
|
||||||
# Optional: golangci-lint command line arguments.
|
# Optional: golangci-lint command line arguments.
|
39
.github.old/workflows/codecov.yml
Normal file
39
.github.old/workflows/codecov.yml
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
name: "codecov"
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_run:
|
||||||
|
workflows: ["build"]
|
||||||
|
types:
|
||||||
|
- completed
|
||||||
|
push:
|
||||||
|
branches: [ v3 ]
|
||||||
|
pull_request:
|
||||||
|
branches: [ v3 ]
|
||||||
|
schedule:
|
||||||
|
- cron: '34 1 * * 0'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
codecov:
|
||||||
|
name: codecov
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
actions: read
|
||||||
|
contents: read
|
||||||
|
security-events: write
|
||||||
|
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
language: [ 'go' ]
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: checkout
|
||||||
|
uses: actions/checkout@v3
|
||||||
|
- name: setup
|
||||||
|
uses: actions/setup-go@v3
|
||||||
|
with:
|
||||||
|
go-version: 1.17
|
||||||
|
- name: Run coverage
|
||||||
|
run: go test -v -race -coverprofile=coverage.out -covermode=atomic ./...
|
||||||
|
- name: codecov
|
||||||
|
uses: codecov/codecov-action@v3.1.1
|
@@ -43,14 +43,14 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: checkout
|
- name: checkout
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v3
|
||||||
- name: setup
|
- name: setup
|
||||||
uses: actions/setup-go@v2
|
uses: actions/setup-go@v3
|
||||||
with:
|
with:
|
||||||
go-version: 1.16
|
go-version: 1.17
|
||||||
# Initializes the CodeQL tools for scanning.
|
# Initializes the CodeQL tools for scanning.
|
||||||
- name: init
|
- name: init
|
||||||
uses: github/codeql-action/init@v1
|
uses: github/codeql-action/init@v2
|
||||||
with:
|
with:
|
||||||
languages: ${{ matrix.language }}
|
languages: ${{ matrix.language }}
|
||||||
# If you wish to specify custom queries, you can do so here or in a config file.
|
# If you wish to specify custom queries, you can do so here or in a config file.
|
||||||
@@ -61,7 +61,7 @@ jobs:
|
|||||||
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
|
# 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)
|
# 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.
|
# ℹ️ Command-line programs to run using the OS shell.
|
||||||
# 📚 https://git.io/JvXDl
|
# 📚 https://git.io/JvXDl
|
||||||
@@ -75,4 +75,4 @@ jobs:
|
|||||||
# make release
|
# make release
|
||||||
|
|
||||||
- name: analyze
|
- name: analyze
|
||||||
uses: github/codeql-action/analyze@v1
|
uses: github/codeql-action/analyze@v2
|
@@ -1,4 +1,4 @@
|
|||||||
name: "prautomerge"
|
name: "dependabot-automerge"
|
||||||
|
|
||||||
on:
|
on:
|
||||||
pull_request_target:
|
pull_request_target:
|
||||||
@@ -9,21 +9,17 @@ permissions:
|
|||||||
contents: write
|
contents: write
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
dependabot:
|
automerge:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
if: ${{ github.actor == 'dependabot[bot]' }}
|
if: github.actor == 'dependabot[bot]'
|
||||||
steps:
|
steps:
|
||||||
- name: metadata
|
- name: metadata
|
||||||
id: metadata
|
id: metadata
|
||||||
uses: dependabot/fetch-metadata@v1.1.1
|
uses: dependabot/fetch-metadata@v1.3.6
|
||||||
with:
|
with:
|
||||||
github-token: "${{ secrets.TOKEN }}"
|
github-token: "${{ secrets.TOKEN }}"
|
||||||
- name: approve
|
|
||||||
run: gh pr review --approve "$PR_URL"
|
|
||||||
env:
|
|
||||||
PR_URL: ${{github.event.pull_request.html_url}}
|
|
||||||
GITHUB_TOKEN: ${{secrets.TOKEN}}
|
|
||||||
- name: merge
|
- name: merge
|
||||||
|
id: merge
|
||||||
if: ${{contains(steps.metadata.outputs.dependency-names, 'go.unistack.org')}}
|
if: ${{contains(steps.metadata.outputs.dependency-names, 'go.unistack.org')}}
|
||||||
run: gh pr merge --auto --merge "$PR_URL"
|
run: gh pr merge --auto --merge "$PR_URL"
|
||||||
env:
|
env:
|
40
.github.old/workflows/pr.yml
Normal file
40
.github.old/workflows/pr.yml
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
name: prbuild
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
- v3
|
||||||
|
jobs:
|
||||||
|
test:
|
||||||
|
name: test
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: setup
|
||||||
|
uses: actions/setup-go@v3
|
||||||
|
with:
|
||||||
|
go-version: 1.17
|
||||||
|
- name: checkout
|
||||||
|
uses: actions/checkout@v3
|
||||||
|
- name: cache
|
||||||
|
uses: actions/cache@v3
|
||||||
|
with:
|
||||||
|
path: ~/go/pkg/mod
|
||||||
|
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
|
||||||
|
restore-keys: ${{ runner.os }}-go-
|
||||||
|
- name: deps
|
||||||
|
run: go get -v -t -d ./...
|
||||||
|
- name: test
|
||||||
|
env:
|
||||||
|
INTEGRATION_TESTS: yes
|
||||||
|
run: go test -mod readonly -v ./...
|
||||||
|
lint:
|
||||||
|
name: lint
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: checkout
|
||||||
|
uses: actions/checkout@v3
|
||||||
|
- name: lint
|
||||||
|
uses: golangci/golangci-lint-action@v3.4.0
|
||||||
|
continue-on-error: true
|
||||||
|
with:
|
||||||
|
version: v1.30
|
63
.github/workflows/pr.yml
vendored
63
.github/workflows/pr.yml
vendored
@@ -1,63 +0,0 @@
|
|||||||
name: prbuild
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
- v3
|
|
||||||
jobs:
|
|
||||||
test:
|
|
||||||
name: test
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: setup
|
|
||||||
uses: actions/setup-go@v2
|
|
||||||
with:
|
|
||||||
go-version: 1.16
|
|
||||||
- name: cache
|
|
||||||
uses: actions/cache@v2
|
|
||||||
with:
|
|
||||||
path: ~/go/pkg
|
|
||||||
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
|
|
||||||
restore-keys: ${{ runner.os }}-go-
|
|
||||||
- name: sdk checkout
|
|
||||||
uses: actions/checkout@v2
|
|
||||||
- name: sdk deps
|
|
||||||
run: go get -v -t -d ./...
|
|
||||||
- name: sdk test
|
|
||||||
env:
|
|
||||||
INTEGRATION_TESTS: yes
|
|
||||||
run: go test -mod readonly -v ./...
|
|
||||||
- name: tests checkout
|
|
||||||
uses: actions/checkout@v2
|
|
||||||
with:
|
|
||||||
repository: unistack-org/micro-tests
|
|
||||||
ref: refs/heads/master
|
|
||||||
path: micro-tests
|
|
||||||
fetch-depth: 1
|
|
||||||
- name: tests deps
|
|
||||||
run: |
|
|
||||||
cd micro-tests
|
|
||||||
go mod edit -replace="github.com/unistack-org/micro/v3=../"
|
|
||||||
go get -v -t -d ./...
|
|
||||||
- name: tests test
|
|
||||||
env:
|
|
||||||
INTEGRATION_TESTS: yes
|
|
||||||
run: cd micro-tests && go test -mod readonly -v ./...
|
|
||||||
lint:
|
|
||||||
name: lint
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: checkout
|
|
||||||
uses: actions/checkout@v2
|
|
||||||
- name: lint
|
|
||||||
uses: golangci/golangci-lint-action@v2
|
|
||||||
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.
|
|
||||||
version: v1.39
|
|
||||||
# Optional: working directory, useful for monorepos
|
|
||||||
# working-directory: somedir
|
|
||||||
# Optional: golangci-lint command line arguments.
|
|
||||||
# args: --issues-exit-code=0
|
|
||||||
# Optional: show only new issues if it's a pull request. The default value is `false`.
|
|
||||||
# only-new-issues: true
|
|
@@ -1,4 +1,4 @@
|
|||||||
# Micro [](https://opensource.org/licenses/Apache-2.0) [](https://pkg.go.dev/github.com/unistack-org/micro/v3?tab=overview) [](https://github.com/unistack-org/micro/actions?query=workflow%3Abuild+branch%3Amaster+event%3Apush) [](https://goreportcard.com/report/go.unistack.org/micro/v3) [](https://unistack-org.slack.com/messages/default)
|
# Micro [](https://opensource.org/licenses/Apache-2.0) [](https://pkg.go.dev/github.com/unistack-org/micro/v3?tab=overview) [](https://github.com/unistack-org/micro/actions?query=workflow%3Abuild+branch%3Amaster+event%3Apush) [](https://goreportcard.com/report/go.unistack.org/micro/v3) [](https://codecov.io/gh/unistack-org/micro)
|
||||||
|
|
||||||
Micro is a standard library for microservices.
|
Micro is a standard library for microservices.
|
||||||
|
|
||||||
|
182
api/api.go
182
api/api.go
@@ -1,182 +0,0 @@
|
|||||||
package api // import "go.unistack.org/micro/v3/api"
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"regexp"
|
|
||||||
"strings"
|
|
||||||
|
|
||||||
"go.unistack.org/micro/v3/metadata"
|
|
||||||
"go.unistack.org/micro/v3/register"
|
|
||||||
"go.unistack.org/micro/v3/server"
|
|
||||||
)
|
|
||||||
|
|
||||||
// nolint: revive
|
|
||||||
// Api interface
|
|
||||||
type Api interface {
|
|
||||||
// Initialise options
|
|
||||||
Init(...Option) error
|
|
||||||
// Get the options
|
|
||||||
Options() Options
|
|
||||||
// Register a http handler
|
|
||||||
Register(*Endpoint) error
|
|
||||||
// Register a route
|
|
||||||
Deregister(*Endpoint) error
|
|
||||||
// Implementation of api
|
|
||||||
String() string
|
|
||||||
}
|
|
||||||
|
|
||||||
// Options holds the options
|
|
||||||
type Options struct{}
|
|
||||||
|
|
||||||
// Option func signature
|
|
||||||
type Option func(*Options) error
|
|
||||||
|
|
||||||
// Endpoint is a mapping between an RPC method and HTTP endpoint
|
|
||||||
type Endpoint struct {
|
|
||||||
// Name Greeter.Hello
|
|
||||||
Name string
|
|
||||||
// Desciption for endpoint
|
|
||||||
Description string
|
|
||||||
// Handler e.g rpc, proxy
|
|
||||||
Handler string
|
|
||||||
// Body destination
|
|
||||||
// "*" or "" - top level message value
|
|
||||||
// "string" - inner message value
|
|
||||||
Body string
|
|
||||||
// Host e.g example.com
|
|
||||||
Host []string
|
|
||||||
// Method e.g GET, POST
|
|
||||||
Method []string
|
|
||||||
// Path e.g /greeter. Expect POSIX regex
|
|
||||||
Path []string
|
|
||||||
// Stream flag
|
|
||||||
Stream bool
|
|
||||||
}
|
|
||||||
|
|
||||||
// Service represents an API service
|
|
||||||
type Service struct {
|
|
||||||
// Name of service
|
|
||||||
Name string
|
|
||||||
// Endpoint for this service
|
|
||||||
Endpoint *Endpoint
|
|
||||||
// Services that provides service
|
|
||||||
Services []*register.Service
|
|
||||||
}
|
|
||||||
|
|
||||||
// Encode encodes an endpoint to endpoint metadata
|
|
||||||
func Encode(e *Endpoint) map[string]string {
|
|
||||||
if e == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// endpoint map
|
|
||||||
ep := make(map[string]string)
|
|
||||||
|
|
||||||
// set vals only if they exist
|
|
||||||
set := func(k, v string) {
|
|
||||||
if len(v) == 0 {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
ep[k] = v
|
|
||||||
}
|
|
||||||
|
|
||||||
set("endpoint", e.Name)
|
|
||||||
set("description", e.Description)
|
|
||||||
set("handler", e.Handler)
|
|
||||||
set("method", strings.Join(e.Method, ","))
|
|
||||||
set("path", strings.Join(e.Path, ","))
|
|
||||||
set("host", strings.Join(e.Host, ","))
|
|
||||||
set("body", e.Body)
|
|
||||||
|
|
||||||
return ep
|
|
||||||
}
|
|
||||||
|
|
||||||
// Decode decodes endpoint metadata into an endpoint
|
|
||||||
func Decode(e metadata.Metadata) *Endpoint {
|
|
||||||
if e == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
ep := &Endpoint{}
|
|
||||||
ep.Name, _ = e.Get("endpoint")
|
|
||||||
ep.Description, _ = e.Get("description")
|
|
||||||
epmethod, _ := e.Get("method")
|
|
||||||
ep.Method = []string{epmethod}
|
|
||||||
eppath, _ := e.Get("path")
|
|
||||||
ep.Path = []string{eppath}
|
|
||||||
ephost, _ := e.Get("host")
|
|
||||||
ep.Host = []string{ephost}
|
|
||||||
ep.Handler, _ = e.Get("handler")
|
|
||||||
ep.Body, _ = e.Get("body")
|
|
||||||
|
|
||||||
return ep
|
|
||||||
}
|
|
||||||
|
|
||||||
// Validate validates an endpoint to guarantee it won't blow up when being served
|
|
||||||
func Validate(e *Endpoint) error {
|
|
||||||
if e == nil {
|
|
||||||
return errors.New("endpoint is nil")
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(e.Name) == 0 {
|
|
||||||
return errors.New("name required")
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, p := range e.Path {
|
|
||||||
ps := p[0]
|
|
||||||
pe := p[len(p)-1]
|
|
||||||
|
|
||||||
switch {
|
|
||||||
case ps == '^' && pe == '$':
|
|
||||||
if _, err := regexp.CompilePOSIX(p); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
case ps == '^' && pe != '$':
|
|
||||||
return errors.New("invalid path")
|
|
||||||
case ps != '^' && pe == '$':
|
|
||||||
return errors.New("invalid path")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(e.Handler) == 0 {
|
|
||||||
return errors.New("invalid handler")
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
/*
|
|
||||||
Design ideas
|
|
||||||
|
|
||||||
// Gateway is an api gateway interface
|
|
||||||
type Gateway interface {
|
|
||||||
// Register a http handler
|
|
||||||
Handle(pattern string, http.Handler)
|
|
||||||
// Register a route
|
|
||||||
RegisterRoute(r Route)
|
|
||||||
// Init initialises the command line.
|
|
||||||
// It also parses further options.
|
|
||||||
Init(...Option) error
|
|
||||||
// Run the gateway
|
|
||||||
Run() error
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewGateway returns a new api gateway
|
|
||||||
func NewGateway() Gateway {
|
|
||||||
return newGateway()
|
|
||||||
}
|
|
||||||
*/
|
|
||||||
|
|
||||||
// WithEndpoint returns a server.HandlerOption with endpoint metadata set
|
|
||||||
//
|
|
||||||
// Usage:
|
|
||||||
//
|
|
||||||
// proto.RegisterHandler(service.Server(), new(Handler), api.WithEndpoint(
|
|
||||||
// &api.Endpoint{
|
|
||||||
// Name: "Greeter.Hello",
|
|
||||||
// Path: []string{"/greeter"},
|
|
||||||
// },
|
|
||||||
// ))
|
|
||||||
func WithEndpoint(e *Endpoint) server.HandlerOption {
|
|
||||||
return server.EndpointMetadata(e.Name, Encode(e))
|
|
||||||
}
|
|
152
api/api_test.go
152
api/api_test.go
@@ -1,152 +0,0 @@
|
|||||||
package api
|
|
||||||
|
|
||||||
import (
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
)
|
|
||||||
|
|
||||||
//nolint:gocyclo
|
|
||||||
func TestEncoding(t *testing.T) {
|
|
||||||
testData := []*Endpoint{
|
|
||||||
nil,
|
|
||||||
{
|
|
||||||
Name: "Foo.Bar",
|
|
||||||
Description: "A test endpoint",
|
|
||||||
Handler: "meta",
|
|
||||||
Host: []string{"foo.com"},
|
|
||||||
Method: []string{"GET"},
|
|
||||||
Path: []string{"/test"},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
compare := func(expect, got []string) bool {
|
|
||||||
// no data to compare, return true
|
|
||||||
if len(expect) == 0 && len(got) == 0 {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
// no data expected but got some return false
|
|
||||||
if len(expect) == 0 && len(got) > 0 {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
// compare expected with what we got
|
|
||||||
for _, e := range expect {
|
|
||||||
var seen bool
|
|
||||||
for _, g := range got {
|
|
||||||
if e == g {
|
|
||||||
seen = true
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if !seen {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// we're done, return true
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, d := range testData {
|
|
||||||
// encode
|
|
||||||
e := Encode(d)
|
|
||||||
// decode
|
|
||||||
de := Decode(e)
|
|
||||||
|
|
||||||
// nil endpoint returns nil
|
|
||||||
if d == nil {
|
|
||||||
if e != nil {
|
|
||||||
t.Fatalf("expected nil got %v", e)
|
|
||||||
}
|
|
||||||
if de != nil {
|
|
||||||
t.Fatalf("expected nil got %v", de)
|
|
||||||
}
|
|
||||||
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
// check encoded map
|
|
||||||
name := e["endpoint"]
|
|
||||||
desc := e["description"]
|
|
||||||
method := strings.Split(e["method"], ",")
|
|
||||||
path := strings.Split(e["path"], ",")
|
|
||||||
host := strings.Split(e["host"], ",")
|
|
||||||
handler := e["handler"]
|
|
||||||
|
|
||||||
if name != d.Name {
|
|
||||||
t.Fatalf("expected %v got %v", d.Name, name)
|
|
||||||
}
|
|
||||||
if desc != d.Description {
|
|
||||||
t.Fatalf("expected %v got %v", d.Description, desc)
|
|
||||||
}
|
|
||||||
if handler != d.Handler {
|
|
||||||
t.Fatalf("expected %v got %v", d.Handler, handler)
|
|
||||||
}
|
|
||||||
if ok := compare(d.Method, method); !ok {
|
|
||||||
t.Fatalf("expected %v got %v", d.Method, method)
|
|
||||||
}
|
|
||||||
if ok := compare(d.Path, path); !ok {
|
|
||||||
t.Fatalf("expected %v got %v", d.Path, path)
|
|
||||||
}
|
|
||||||
if ok := compare(d.Host, host); !ok {
|
|
||||||
t.Fatalf("expected %v got %v", d.Host, host)
|
|
||||||
}
|
|
||||||
|
|
||||||
if de.Name != d.Name {
|
|
||||||
t.Fatalf("expected %v got %v", d.Name, de.Name)
|
|
||||||
}
|
|
||||||
if de.Description != d.Description {
|
|
||||||
t.Fatalf("expected %v got %v", d.Description, de.Description)
|
|
||||||
}
|
|
||||||
if de.Handler != d.Handler {
|
|
||||||
t.Fatalf("expected %v got %v", d.Handler, de.Handler)
|
|
||||||
}
|
|
||||||
if ok := compare(d.Method, de.Method); !ok {
|
|
||||||
t.Fatalf("expected %v got %v", d.Method, de.Method)
|
|
||||||
}
|
|
||||||
if ok := compare(d.Path, de.Path); !ok {
|
|
||||||
t.Fatalf("expected %v got %v", d.Path, de.Path)
|
|
||||||
}
|
|
||||||
if ok := compare(d.Host, de.Host); !ok {
|
|
||||||
t.Fatalf("expected %v got %v", d.Host, de.Host)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestValidate(t *testing.T) {
|
|
||||||
epPcre := &Endpoint{
|
|
||||||
Name: "Foo.Bar",
|
|
||||||
Description: "A test endpoint",
|
|
||||||
Handler: "meta",
|
|
||||||
Host: []string{"foo.com"},
|
|
||||||
Method: []string{"GET"},
|
|
||||||
Path: []string{"^/test/?$"},
|
|
||||||
}
|
|
||||||
if err := Validate(epPcre); err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
epGpath := &Endpoint{
|
|
||||||
Name: "Foo.Bar",
|
|
||||||
Description: "A test endpoint",
|
|
||||||
Handler: "meta",
|
|
||||||
Host: []string{"foo.com"},
|
|
||||||
Method: []string{"GET"},
|
|
||||||
Path: []string{"/test/{id}"},
|
|
||||||
}
|
|
||||||
if err := Validate(epGpath); err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
epPcreInvalid := &Endpoint{
|
|
||||||
Name: "Foo.Bar",
|
|
||||||
Description: "A test endpoint",
|
|
||||||
Handler: "meta",
|
|
||||||
Host: []string{"foo.com"},
|
|
||||||
Method: []string{"GET"},
|
|
||||||
Path: []string{"/test/?$"},
|
|
||||||
}
|
|
||||||
if err := Validate(epPcreInvalid); err == nil {
|
|
||||||
t.Fatalf("invalid pcre %v", epPcreInvalid.Path[0])
|
|
||||||
}
|
|
||||||
}
|
|
@@ -1,14 +0,0 @@
|
|||||||
// Package handler provides http handlers
|
|
||||||
package handler // import "go.unistack.org/micro/v3/api/handler"
|
|
||||||
|
|
||||||
import (
|
|
||||||
"net/http"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Handler represents a HTTP handler that manages a request
|
|
||||||
type Handler interface {
|
|
||||||
// standard http handler
|
|
||||||
http.Handler
|
|
||||||
// name of handler
|
|
||||||
String() string
|
|
||||||
}
|
|
@@ -1,70 +0,0 @@
|
|||||||
package handler
|
|
||||||
|
|
||||||
import (
|
|
||||||
"go.unistack.org/micro/v3/api/router"
|
|
||||||
"go.unistack.org/micro/v3/client"
|
|
||||||
"go.unistack.org/micro/v3/logger"
|
|
||||||
)
|
|
||||||
|
|
||||||
// DefaultMaxRecvSize specifies max recv size for handler
|
|
||||||
var DefaultMaxRecvSize int64 = 1024 * 1024 * 100 // 10Mb
|
|
||||||
|
|
||||||
// Options struct holds handler options
|
|
||||||
type Options struct {
|
|
||||||
Router router.Router
|
|
||||||
Client client.Client
|
|
||||||
Logger logger.Logger
|
|
||||||
Namespace string
|
|
||||||
MaxRecvSize int64
|
|
||||||
}
|
|
||||||
|
|
||||||
// Option func signature
|
|
||||||
type Option func(o *Options)
|
|
||||||
|
|
||||||
// NewOptions creates new options struct and fills it
|
|
||||||
func NewOptions(opts ...Option) Options {
|
|
||||||
options := Options{
|
|
||||||
Client: client.DefaultClient,
|
|
||||||
Router: router.DefaultRouter,
|
|
||||||
Logger: logger.DefaultLogger,
|
|
||||||
MaxRecvSize: DefaultMaxRecvSize,
|
|
||||||
}
|
|
||||||
for _, o := range opts {
|
|
||||||
o(&options)
|
|
||||||
}
|
|
||||||
|
|
||||||
// set namespace if blank
|
|
||||||
if len(options.Namespace) == 0 {
|
|
||||||
WithNamespace("go.micro.api")(&options)
|
|
||||||
}
|
|
||||||
|
|
||||||
return options
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithNamespace specifies the namespace for the handler
|
|
||||||
func WithNamespace(s string) Option {
|
|
||||||
return func(o *Options) {
|
|
||||||
o.Namespace = s
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithRouter specifies a router to be used by the handler
|
|
||||||
func WithRouter(r router.Router) Option {
|
|
||||||
return func(o *Options) {
|
|
||||||
o.Router = r
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithClient specifies client to be used by the handler
|
|
||||||
func WithClient(c client.Client) Option {
|
|
||||||
return func(o *Options) {
|
|
||||||
o.Client = c
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithMaxRecvSize specifies max body size
|
|
||||||
func WithMaxRecvSize(size int64) Option {
|
|
||||||
return func(o *Options) {
|
|
||||||
o.MaxRecvSize = size
|
|
||||||
}
|
|
||||||
}
|
|
@@ -1,47 +0,0 @@
|
|||||||
// Package grpc resolves a grpc service like /greeter.Say/Hello to greeter service
|
|
||||||
package grpc // import "go.unistack.org/micro/v3/api/resolver/grpc"
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"net/http"
|
|
||||||
"strings"
|
|
||||||
|
|
||||||
"go.unistack.org/micro/v3/api/resolver"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Resolver struct
|
|
||||||
type Resolver struct {
|
|
||||||
opts resolver.Options
|
|
||||||
}
|
|
||||||
|
|
||||||
// Resolve func to resolve enndpoint
|
|
||||||
func (r *Resolver) Resolve(req *http.Request, opts ...resolver.ResolveOption) (*resolver.Endpoint, error) {
|
|
||||||
// parse options
|
|
||||||
options := resolver.NewResolveOptions(opts...)
|
|
||||||
|
|
||||||
// /foo.Bar/Service
|
|
||||||
if req.URL.Path == "/" {
|
|
||||||
return nil, errors.New("unknown name")
|
|
||||||
}
|
|
||||||
// [foo.Bar, Service]
|
|
||||||
parts := strings.Split(req.URL.Path[1:], "/")
|
|
||||||
// [foo, Bar]
|
|
||||||
name := strings.Split(parts[0], ".")
|
|
||||||
// foo
|
|
||||||
return &resolver.Endpoint{
|
|
||||||
Name: strings.Join(name[:len(name)-1], "."),
|
|
||||||
Host: req.Host,
|
|
||||||
Method: req.Method,
|
|
||||||
Path: req.URL.Path,
|
|
||||||
Domain: options.Domain,
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r *Resolver) String() string {
|
|
||||||
return "grpc"
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewResolver is used to create new Resolver
|
|
||||||
func NewResolver(opts ...resolver.Option) resolver.Resolver {
|
|
||||||
return &Resolver{opts: resolver.NewOptions(opts...)}
|
|
||||||
}
|
|
@@ -1,35 +0,0 @@
|
|||||||
// Package host resolves using http host
|
|
||||||
package host // import "go.unistack.org/micro/v3/api/resolver/host"
|
|
||||||
|
|
||||||
import (
|
|
||||||
"net/http"
|
|
||||||
|
|
||||||
"go.unistack.org/micro/v3/api/resolver"
|
|
||||||
)
|
|
||||||
|
|
||||||
type hostResolver struct {
|
|
||||||
opts resolver.Options
|
|
||||||
}
|
|
||||||
|
|
||||||
// Resolve endpoint
|
|
||||||
func (r *hostResolver) Resolve(req *http.Request, opts ...resolver.ResolveOption) (*resolver.Endpoint, error) {
|
|
||||||
// parse options
|
|
||||||
options := resolver.NewResolveOptions(opts...)
|
|
||||||
|
|
||||||
return &resolver.Endpoint{
|
|
||||||
Name: req.Host,
|
|
||||||
Host: req.Host,
|
|
||||||
Method: req.Method,
|
|
||||||
Path: req.URL.Path,
|
|
||||||
Domain: options.Domain,
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r *hostResolver) String() string {
|
|
||||||
return "host"
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewResolver creates new host api resolver
|
|
||||||
func NewResolver(opts ...resolver.Option) resolver.Resolver {
|
|
||||||
return &hostResolver{opts: resolver.NewOptions(opts...)}
|
|
||||||
}
|
|
@@ -1,70 +0,0 @@
|
|||||||
package resolver
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
|
|
||||||
"go.unistack.org/micro/v3/register"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Options struct
|
|
||||||
type Options struct {
|
|
||||||
// Context is for external defined options
|
|
||||||
Context context.Context
|
|
||||||
// Handler name
|
|
||||||
Handler string
|
|
||||||
// ServicePrefix is the prefix
|
|
||||||
ServicePrefix string
|
|
||||||
}
|
|
||||||
|
|
||||||
// Option func
|
|
||||||
type Option func(o *Options)
|
|
||||||
|
|
||||||
// WithHandler sets the handler being used
|
|
||||||
func WithHandler(h string) Option {
|
|
||||||
return func(o *Options) {
|
|
||||||
o.Handler = h
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithServicePrefix sets the ServicePrefix option
|
|
||||||
func WithServicePrefix(p string) Option {
|
|
||||||
return func(o *Options) {
|
|
||||||
o.ServicePrefix = p
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewOptions returns new initialised options
|
|
||||||
func NewOptions(opts ...Option) Options {
|
|
||||||
options := Options{
|
|
||||||
Context: context.Background(),
|
|
||||||
}
|
|
||||||
for _, o := range opts {
|
|
||||||
o(&options)
|
|
||||||
}
|
|
||||||
return options
|
|
||||||
}
|
|
||||||
|
|
||||||
// ResolveOptions are used when resolving a request
|
|
||||||
type ResolveOptions struct {
|
|
||||||
Domain string
|
|
||||||
}
|
|
||||||
|
|
||||||
// ResolveOption sets an option
|
|
||||||
type ResolveOption func(*ResolveOptions)
|
|
||||||
|
|
||||||
// Domain sets the resolve Domain option
|
|
||||||
func Domain(n string) ResolveOption {
|
|
||||||
return func(o *ResolveOptions) {
|
|
||||||
o.Domain = n
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewResolveOptions returns new initialised resolve options
|
|
||||||
func NewResolveOptions(opts ...ResolveOption) ResolveOptions {
|
|
||||||
options := ResolveOptions{Domain: register.DefaultDomain}
|
|
||||||
for _, o := range opts {
|
|
||||||
o(&options)
|
|
||||||
}
|
|
||||||
|
|
||||||
return options
|
|
||||||
}
|
|
@@ -1,44 +0,0 @@
|
|||||||
// Package path resolves using http path
|
|
||||||
package path // import "go.unistack.org/micro/v3/api/resolver/path"
|
|
||||||
|
|
||||||
import (
|
|
||||||
"net/http"
|
|
||||||
"strings"
|
|
||||||
|
|
||||||
"go.unistack.org/micro/v3/api/resolver"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Resolver the path resolver
|
|
||||||
type Resolver struct {
|
|
||||||
opts resolver.Options
|
|
||||||
}
|
|
||||||
|
|
||||||
// Resolve resolves endpoint
|
|
||||||
func (r *Resolver) Resolve(req *http.Request, opts ...resolver.ResolveOption) (*resolver.Endpoint, error) {
|
|
||||||
// parse options
|
|
||||||
options := resolver.NewResolveOptions(opts...)
|
|
||||||
|
|
||||||
if req.URL.Path == "/" {
|
|
||||||
return nil, resolver.ErrNotFound
|
|
||||||
}
|
|
||||||
|
|
||||||
parts := strings.Split(req.URL.Path[1:], "/")
|
|
||||||
|
|
||||||
return &resolver.Endpoint{
|
|
||||||
Name: r.opts.ServicePrefix + "." + parts[0],
|
|
||||||
Host: req.Host,
|
|
||||||
Method: req.Method,
|
|
||||||
Path: req.URL.Path,
|
|
||||||
Domain: options.Domain,
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// String retruns the string representation
|
|
||||||
func (r *Resolver) String() string {
|
|
||||||
return "path"
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewResolver returns new path resolver
|
|
||||||
func NewResolver(opts ...resolver.Option) resolver.Resolver {
|
|
||||||
return &Resolver{opts: resolver.NewOptions(opts...)}
|
|
||||||
}
|
|
@@ -1,34 +0,0 @@
|
|||||||
// Package resolver resolves a http request to an endpoint
|
|
||||||
package resolver // import "go.unistack.org/micro/v3/api/resolver"
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"net/http"
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
// ErrNotFound returned when endpoint is not found
|
|
||||||
ErrNotFound = errors.New("not found")
|
|
||||||
// ErrInvalidPath returned on invalid path
|
|
||||||
ErrInvalidPath = errors.New("invalid path")
|
|
||||||
)
|
|
||||||
|
|
||||||
// Resolver resolves requests to endpoints
|
|
||||||
type Resolver interface {
|
|
||||||
Resolve(r *http.Request, opts ...ResolveOption) (*Endpoint, error)
|
|
||||||
String() string
|
|
||||||
}
|
|
||||||
|
|
||||||
// Endpoint is the endpoint for a http request
|
|
||||||
type Endpoint struct {
|
|
||||||
// Endpoint name e.g greeter
|
|
||||||
Name string
|
|
||||||
// HTTP Host e.g example.com
|
|
||||||
Host string
|
|
||||||
// HTTP Methods e.g GET, POST
|
|
||||||
Method string
|
|
||||||
// HTTP Path e.g /greeter.
|
|
||||||
Path string
|
|
||||||
// Domain endpoint exists within
|
|
||||||
Domain string
|
|
||||||
}
|
|
@@ -1,90 +0,0 @@
|
|||||||
// Package subdomain is a resolver which uses the subdomain to determine the domain to route to. It
|
|
||||||
// offloads the endpoint resolution to a child resolver which is provided in New.
|
|
||||||
package subdomain // import "go.unistack.org/micro/v3/api/resolver/subdomain"
|
|
||||||
|
|
||||||
import (
|
|
||||||
"net"
|
|
||||||
"net/http"
|
|
||||||
"strings"
|
|
||||||
|
|
||||||
"go.unistack.org/micro/v3/api/resolver"
|
|
||||||
"go.unistack.org/micro/v3/logger"
|
|
||||||
"golang.org/x/net/publicsuffix"
|
|
||||||
)
|
|
||||||
|
|
||||||
// NewResolver creates new subdomain api resolver
|
|
||||||
func NewResolver(parent resolver.Resolver, opts ...resolver.Option) resolver.Resolver {
|
|
||||||
options := resolver.NewOptions(opts...)
|
|
||||||
return &subdomainResolver{opts: options, Resolver: parent}
|
|
||||||
}
|
|
||||||
|
|
||||||
type subdomainResolver struct {
|
|
||||||
resolver.Resolver
|
|
||||||
opts resolver.Options
|
|
||||||
}
|
|
||||||
|
|
||||||
// Resolve resolve endpoint based on subdomain
|
|
||||||
func (r *subdomainResolver) Resolve(req *http.Request, opts ...resolver.ResolveOption) (*resolver.Endpoint, error) {
|
|
||||||
if dom := r.Domain(req); len(dom) > 0 {
|
|
||||||
opts = append(opts, resolver.Domain(dom))
|
|
||||||
}
|
|
||||||
|
|
||||||
return r.Resolver.Resolve(req, opts...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Domain returns domain
|
|
||||||
func (r *subdomainResolver) Domain(req *http.Request) string {
|
|
||||||
// determine the host, e.g. foobar.m3o.app
|
|
||||||
host := req.URL.Hostname()
|
|
||||||
if len(host) == 0 {
|
|
||||||
if h, _, err := net.SplitHostPort(req.Host); err == nil {
|
|
||||||
host = h // host does contain a port
|
|
||||||
} else if strings.Contains(err.Error(), "missing port in address") {
|
|
||||||
host = req.Host // host does not contain a port
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// check for an ip address
|
|
||||||
if net.ParseIP(host) != nil {
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
// check for dev environment
|
|
||||||
if host == "localhost" || host == "127.0.0.1" {
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
// extract the top level domain plus one (e.g. 'myapp.com')
|
|
||||||
domain, err := publicsuffix.EffectiveTLDPlusOne(host)
|
|
||||||
if err != nil {
|
|
||||||
if logger.V(logger.DebugLevel) {
|
|
||||||
logger.Debug(r.opts.Context, "Unable to extract domain from %v", host)
|
|
||||||
}
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
// there was no subdomain
|
|
||||||
if host == domain {
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
// remove the domain from the host, leaving the subdomain, e.g. "staging.foo.myapp.com" => "staging.foo"
|
|
||||||
subdomain := strings.TrimSuffix(host, "."+domain)
|
|
||||||
|
|
||||||
// ignore the API subdomain
|
|
||||||
if subdomain == "api" {
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
// return the reversed subdomain as the namespace, e.g. "staging.foo" => "foo-staging"
|
|
||||||
comps := strings.Split(subdomain, ".")
|
|
||||||
for i := len(comps)/2 - 1; i >= 0; i-- {
|
|
||||||
opp := len(comps) - 1 - i
|
|
||||||
comps[i], comps[opp] = comps[opp], comps[i]
|
|
||||||
}
|
|
||||||
return strings.Join(comps, "-")
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r *subdomainResolver) String() string {
|
|
||||||
return "subdomain"
|
|
||||||
}
|
|
@@ -1,73 +0,0 @@
|
|||||||
package subdomain
|
|
||||||
|
|
||||||
import (
|
|
||||||
"net/http"
|
|
||||||
"net/url"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"go.unistack.org/micro/v3/api/resolver/vpath"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestResolve(t *testing.T) {
|
|
||||||
tt := []struct {
|
|
||||||
Name string
|
|
||||||
Host string
|
|
||||||
Result string
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
Name: "Top level domain",
|
|
||||||
Host: "micro.mu",
|
|
||||||
Result: "micro",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Name: "Effective top level domain",
|
|
||||||
Host: "micro.com.au",
|
|
||||||
Result: "micro",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Name: "Subdomain dev",
|
|
||||||
Host: "dev.micro.mu",
|
|
||||||
Result: "dev",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Name: "Subdomain foo",
|
|
||||||
Host: "foo.micro.mu",
|
|
||||||
Result: "foo",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Name: "Multi-level subdomain",
|
|
||||||
Host: "staging.myapp.m3o.app",
|
|
||||||
Result: "myapp-staging",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Name: "Dev host",
|
|
||||||
Host: "127.0.0.1",
|
|
||||||
Result: "micro",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Name: "Localhost",
|
|
||||||
Host: "localhost",
|
|
||||||
Result: "micro",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Name: "IP host",
|
|
||||||
Host: "81.151.101.146",
|
|
||||||
Result: "micro",
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range tt {
|
|
||||||
t.Run(tc.Name, func(t *testing.T) {
|
|
||||||
r := NewResolver(vpath.NewResolver())
|
|
||||||
result, err := r.Resolve(&http.Request{URL: &url.URL{Host: tc.Host, Path: "foo/bar"}})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
if result != nil {
|
|
||||||
if tc.Result != result.Domain {
|
|
||||||
t.Fatalf("Expected %v but got %v", tc.Result, result.Domain)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
@@ -1,75 +0,0 @@
|
|||||||
// Package vpath resolves using http path and recognised versioned urls
|
|
||||||
package vpath // import "go.unistack.org/micro/v3/api/resolver/vpath"
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"net/http"
|
|
||||||
"regexp"
|
|
||||||
"strings"
|
|
||||||
|
|
||||||
"go.unistack.org/micro/v3/api/resolver"
|
|
||||||
)
|
|
||||||
|
|
||||||
// NewResolver creates new vpath api resolver
|
|
||||||
func NewResolver(opts ...resolver.Option) resolver.Resolver {
|
|
||||||
return &vpathResolver{opts: resolver.NewOptions(opts...)}
|
|
||||||
}
|
|
||||||
|
|
||||||
type vpathResolver struct {
|
|
||||||
opts resolver.Options
|
|
||||||
}
|
|
||||||
|
|
||||||
var re = regexp.MustCompile("^v[0-9]+$")
|
|
||||||
|
|
||||||
// Resolve endpoint
|
|
||||||
func (r *vpathResolver) Resolve(req *http.Request, opts ...resolver.ResolveOption) (*resolver.Endpoint, error) {
|
|
||||||
if req.URL.Path == "/" {
|
|
||||||
return nil, errors.New("unknown name")
|
|
||||||
}
|
|
||||||
|
|
||||||
options := resolver.NewResolveOptions(opts...)
|
|
||||||
|
|
||||||
parts := strings.Split(req.URL.Path[1:], "/")
|
|
||||||
if len(parts) == 1 {
|
|
||||||
return &resolver.Endpoint{
|
|
||||||
Name: r.withPrefix(parts...),
|
|
||||||
Host: req.Host,
|
|
||||||
Method: req.Method,
|
|
||||||
Path: req.URL.Path,
|
|
||||||
Domain: options.Domain,
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// /v1/foo
|
|
||||||
if re.MatchString(parts[0]) {
|
|
||||||
return &resolver.Endpoint{
|
|
||||||
Name: r.withPrefix(parts[0:2]...),
|
|
||||||
Host: req.Host,
|
|
||||||
Method: req.Method,
|
|
||||||
Path: req.URL.Path,
|
|
||||||
Domain: options.Domain,
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
return &resolver.Endpoint{
|
|
||||||
Name: r.withPrefix(parts[0]),
|
|
||||||
Host: req.Host,
|
|
||||||
Method: req.Method,
|
|
||||||
Path: req.URL.Path,
|
|
||||||
Domain: options.Domain,
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r *vpathResolver) String() string {
|
|
||||||
return "vpath"
|
|
||||||
}
|
|
||||||
|
|
||||||
// withPrefix transforms "foo" into "go.micro.api.foo"
|
|
||||||
func (r *vpathResolver) withPrefix(parts ...string) string {
|
|
||||||
p := r.opts.ServicePrefix
|
|
||||||
if len(p) > 0 {
|
|
||||||
parts = append([]string{p}, parts...)
|
|
||||||
}
|
|
||||||
|
|
||||||
return strings.Join(parts, ".")
|
|
||||||
}
|
|
@@ -1,75 +0,0 @@
|
|||||||
package router
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
|
|
||||||
"go.unistack.org/micro/v3/api/resolver"
|
|
||||||
"go.unistack.org/micro/v3/api/resolver/vpath"
|
|
||||||
"go.unistack.org/micro/v3/logger"
|
|
||||||
"go.unistack.org/micro/v3/register"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Options holds the options for api router
|
|
||||||
type Options struct {
|
|
||||||
// Register for service lookup
|
|
||||||
Register register.Register
|
|
||||||
// Resolver to use
|
|
||||||
Resolver resolver.Resolver
|
|
||||||
// Logger micro logger
|
|
||||||
Logger logger.Logger
|
|
||||||
// Context is for external options
|
|
||||||
Context context.Context
|
|
||||||
// Handler name
|
|
||||||
Handler string
|
|
||||||
}
|
|
||||||
|
|
||||||
// Option func signature
|
|
||||||
type Option func(o *Options)
|
|
||||||
|
|
||||||
// NewOptions returns options struct filled by opts
|
|
||||||
func NewOptions(opts ...Option) Options {
|
|
||||||
options := Options{
|
|
||||||
Context: context.Background(),
|
|
||||||
Handler: "meta",
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, o := range opts {
|
|
||||||
o(&options)
|
|
||||||
}
|
|
||||||
|
|
||||||
if options.Resolver == nil {
|
|
||||||
options.Resolver = vpath.NewResolver(
|
|
||||||
resolver.WithHandler(options.Handler),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
return options
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithContext sets the context
|
|
||||||
func WithContext(ctx context.Context) Option {
|
|
||||||
return func(o *Options) {
|
|
||||||
o.Context = ctx
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithHandler sets the handler
|
|
||||||
func WithHandler(h string) Option {
|
|
||||||
return func(o *Options) {
|
|
||||||
o.Handler = h
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithRegister sets the register
|
|
||||||
func WithRegister(r register.Register) Option {
|
|
||||||
return func(o *Options) {
|
|
||||||
o.Register = r
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithResolver sets the resolver
|
|
||||||
func WithResolver(r resolver.Resolver) Option {
|
|
||||||
return func(o *Options) {
|
|
||||||
o.Resolver = r
|
|
||||||
}
|
|
||||||
}
|
|
@@ -1,31 +0,0 @@
|
|||||||
// Package router provides api service routing
|
|
||||||
package router // import "go.unistack.org/micro/v3/api/router"
|
|
||||||
|
|
||||||
import (
|
|
||||||
"net/http"
|
|
||||||
|
|
||||||
"go.unistack.org/micro/v3/api"
|
|
||||||
)
|
|
||||||
|
|
||||||
// DefaultRouter contains default router implementation
|
|
||||||
var DefaultRouter Router
|
|
||||||
|
|
||||||
// Router is used to determine an endpoint for a request
|
|
||||||
type Router interface {
|
|
||||||
// Returns options
|
|
||||||
Options() Options
|
|
||||||
// Init initialize router
|
|
||||||
Init(...Option) error
|
|
||||||
// Stop the router
|
|
||||||
Close() error
|
|
||||||
// Endpoint returns an api.Service endpoint or an error if it does not exist
|
|
||||||
Endpoint(r *http.Request) (*api.Service, error)
|
|
||||||
// Register endpoint in router
|
|
||||||
Register(ep *api.Endpoint) error
|
|
||||||
// Deregister endpoint from router
|
|
||||||
Deregister(ep *api.Endpoint) error
|
|
||||||
// Route returns an api.Service route
|
|
||||||
Route(r *http.Request) (*api.Service, error)
|
|
||||||
// String representation of router
|
|
||||||
String() string
|
|
||||||
}
|
|
141
auth/auth.go
141
auth/auth.go
@@ -1,141 +0,0 @@
|
|||||||
// Package auth provides authentication and authorization capability
|
|
||||||
package auth // import "go.unistack.org/micro/v3/auth"
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"go.unistack.org/micro/v3/metadata"
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
// BearerScheme used for Authorization header
|
|
||||||
BearerScheme = "Bearer "
|
|
||||||
// ScopePublic is the scope applied to a rule to allow access to the public
|
|
||||||
ScopePublic = ""
|
|
||||||
// ScopeAccount is the scope applied to a rule to limit to users with any valid account
|
|
||||||
ScopeAccount = "*"
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
// DefaultAuth holds default auth implementation
|
|
||||||
DefaultAuth Auth = NewAuth()
|
|
||||||
// ErrInvalidToken is when the token provided is not valid
|
|
||||||
ErrInvalidToken = errors.New("invalid token provided")
|
|
||||||
// ErrForbidden is when a user does not have the necessary scope to access a resource
|
|
||||||
ErrForbidden = errors.New("resource forbidden")
|
|
||||||
)
|
|
||||||
|
|
||||||
// Auth provides authentication and authorization
|
|
||||||
type Auth interface {
|
|
||||||
// Init the auth
|
|
||||||
Init(opts ...Option) error
|
|
||||||
// Options set for auth
|
|
||||||
Options() Options
|
|
||||||
// Generate a new account
|
|
||||||
Generate(id string, opts ...GenerateOption) (*Account, error)
|
|
||||||
// Verify an account has access to a resource using the rules
|
|
||||||
Verify(acc *Account, res *Resource, opts ...VerifyOption) error
|
|
||||||
// Inspect a token
|
|
||||||
Inspect(token string) (*Account, error)
|
|
||||||
// Token generated using refresh token or credentials
|
|
||||||
Token(opts ...TokenOption) (*Token, error)
|
|
||||||
// Grant access to a resource
|
|
||||||
Grant(rule *Rule) error
|
|
||||||
// Revoke access to a resource
|
|
||||||
Revoke(rule *Rule) error
|
|
||||||
// Rules returns all the rules used to verify requests
|
|
||||||
Rules(...RulesOption) ([]*Rule, error)
|
|
||||||
// String returns the name of the implementation
|
|
||||||
String() string
|
|
||||||
}
|
|
||||||
|
|
||||||
// Account provided by an auth provider
|
|
||||||
type Account struct {
|
|
||||||
// Metadata any other associated metadata
|
|
||||||
Metadata metadata.Metadata `json:"metadata"`
|
|
||||||
// ID of the account e.g. email or id
|
|
||||||
ID string `json:"id"`
|
|
||||||
// Type of the account, e.g. service
|
|
||||||
Type string `json:"type"`
|
|
||||||
// Issuer of the account
|
|
||||||
Issuer string `json:"issuer"`
|
|
||||||
// Secret for the account, e.g. the password
|
|
||||||
Secret string `json:"secret"`
|
|
||||||
// Scopes the account has access to
|
|
||||||
Scopes []string `json:"scopes"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// Token can be short or long lived
|
|
||||||
type Token struct {
|
|
||||||
// Time of token creation
|
|
||||||
Created time.Time `json:"created"`
|
|
||||||
// Time of token expiry
|
|
||||||
Expiry time.Time `json:"expiry"`
|
|
||||||
// The token to be used for accessing resources
|
|
||||||
AccessToken string `json:"access_token"`
|
|
||||||
// RefreshToken to be used to generate a new token
|
|
||||||
RefreshToken string `json:"refresh_token"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// Expired returns a boolean indicating if the token needs to be refreshed
|
|
||||||
func (t *Token) Expired() bool {
|
|
||||||
return t.Expiry.Unix() < time.Now().Unix()
|
|
||||||
}
|
|
||||||
|
|
||||||
// Resource is an entity such as a user or
|
|
||||||
type Resource struct {
|
|
||||||
// Name of the resource, e.g. go.micro.service.notes
|
|
||||||
Name string `json:"name"`
|
|
||||||
// Type of resource, e.g. service
|
|
||||||
Type string `json:"type"`
|
|
||||||
// Endpoint resource e.g NotesService.Create
|
|
||||||
Endpoint string `json:"endpoint"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// Access defines the type of access a rule grants
|
|
||||||
type Access int
|
|
||||||
|
|
||||||
const (
|
|
||||||
// AccessGranted to a resource
|
|
||||||
AccessGranted Access = iota
|
|
||||||
// AccessDenied to a resource
|
|
||||||
AccessDenied
|
|
||||||
)
|
|
||||||
|
|
||||||
// Rule is used to verify access to a resource
|
|
||||||
type Rule struct {
|
|
||||||
// Resource that rule belongs to
|
|
||||||
Resource *Resource
|
|
||||||
// ID of the rule
|
|
||||||
ID string
|
|
||||||
// Scope of the rule
|
|
||||||
Scope string
|
|
||||||
// Access flag allow/deny
|
|
||||||
Access Access
|
|
||||||
// Priority holds the rule priority
|
|
||||||
Priority int32
|
|
||||||
}
|
|
||||||
|
|
||||||
type accountKey struct{}
|
|
||||||
|
|
||||||
// AccountFromContext gets the account from the context, which
|
|
||||||
// is set by the auth wrapper at the start of a call. If the account
|
|
||||||
// is not set, a nil account will be returned. The error is only returned
|
|
||||||
// when there was a problem retrieving an account
|
|
||||||
func AccountFromContext(ctx context.Context) (*Account, bool) {
|
|
||||||
if ctx == nil {
|
|
||||||
return nil, false
|
|
||||||
}
|
|
||||||
acc, ok := ctx.Value(accountKey{}).(*Account)
|
|
||||||
return acc, ok
|
|
||||||
}
|
|
||||||
|
|
||||||
// ContextWithAccount sets the account in the context
|
|
||||||
func ContextWithAccount(ctx context.Context, account *Account) context.Context {
|
|
||||||
if ctx == nil {
|
|
||||||
ctx = context.Background()
|
|
||||||
}
|
|
||||||
return context.WithValue(ctx, accountKey{}, account)
|
|
||||||
}
|
|
79
auth/noop.go
79
auth/noop.go
@@ -1,79 +0,0 @@
|
|||||||
package auth
|
|
||||||
|
|
||||||
import (
|
|
||||||
"go.unistack.org/micro/v3/util/id"
|
|
||||||
)
|
|
||||||
|
|
||||||
type noopAuth struct {
|
|
||||||
opts Options
|
|
||||||
}
|
|
||||||
|
|
||||||
// String returns the name of the implementation
|
|
||||||
func (n *noopAuth) String() string {
|
|
||||||
return "noop"
|
|
||||||
}
|
|
||||||
|
|
||||||
// Init the auth
|
|
||||||
func (n *noopAuth) Init(opts ...Option) error {
|
|
||||||
for _, o := range opts {
|
|
||||||
o(&n.opts)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Options set for auth
|
|
||||||
func (n *noopAuth) Options() Options {
|
|
||||||
return n.opts
|
|
||||||
}
|
|
||||||
|
|
||||||
// Generate a new account
|
|
||||||
func (n *noopAuth) Generate(id string, opts ...GenerateOption) (*Account, error) {
|
|
||||||
options := NewGenerateOptions(opts...)
|
|
||||||
|
|
||||||
return &Account{
|
|
||||||
ID: id,
|
|
||||||
Secret: options.Secret,
|
|
||||||
Metadata: options.Metadata,
|
|
||||||
Scopes: options.Scopes,
|
|
||||||
Issuer: n.Options().Issuer,
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Grant access to a resource
|
|
||||||
func (n *noopAuth) Grant(rule *Rule) error {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Revoke access to a resource
|
|
||||||
func (n *noopAuth) Revoke(rule *Rule) error {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Rules used to verify requests
|
|
||||||
func (n *noopAuth) Rules(opts ...RulesOption) ([]*Rule, error) {
|
|
||||||
return []*Rule{}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Verify an account has access to a resource
|
|
||||||
func (n *noopAuth) Verify(acc *Account, res *Resource, opts ...VerifyOption) error {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Inspect a token
|
|
||||||
func (n *noopAuth) Inspect(token string) (*Account, error) {
|
|
||||||
id, err := id.New()
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return &Account{ID: id, Issuer: n.Options().Issuer}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Token generation using an account id and secret
|
|
||||||
func (n *noopAuth) Token(opts ...TokenOption) (*Token, error) {
|
|
||||||
return &Token{}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewAuth returns new noop auth
|
|
||||||
func NewAuth(opts ...Option) Auth {
|
|
||||||
return &noopAuth{opts: NewOptions(opts...)}
|
|
||||||
}
|
|
311
auth/options.go
311
auth/options.go
@@ -1,311 +0,0 @@
|
|||||||
package auth
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"go.unistack.org/micro/v3/logger"
|
|
||||||
"go.unistack.org/micro/v3/metadata"
|
|
||||||
"go.unistack.org/micro/v3/meter"
|
|
||||||
"go.unistack.org/micro/v3/store"
|
|
||||||
"go.unistack.org/micro/v3/tracer"
|
|
||||||
)
|
|
||||||
|
|
||||||
// NewOptions creates Options struct from slice of options
|
|
||||||
func NewOptions(opts ...Option) Options {
|
|
||||||
options := Options{
|
|
||||||
Tracer: tracer.DefaultTracer,
|
|
||||||
Logger: logger.DefaultLogger,
|
|
||||||
Meter: meter.DefaultMeter,
|
|
||||||
}
|
|
||||||
for _, o := range opts {
|
|
||||||
o(&options)
|
|
||||||
}
|
|
||||||
return options
|
|
||||||
}
|
|
||||||
|
|
||||||
// Options struct holds auth options
|
|
||||||
type Options struct {
|
|
||||||
// Context holds the external options
|
|
||||||
Context context.Context
|
|
||||||
// Meter used for metrics
|
|
||||||
Meter meter.Meter
|
|
||||||
// Logger used for logging
|
|
||||||
Logger logger.Logger
|
|
||||||
// Tracer used for tracing
|
|
||||||
Tracer tracer.Tracer
|
|
||||||
// Store used for stre data
|
|
||||||
Store store.Store
|
|
||||||
// Token is the services token used to authenticate itself
|
|
||||||
Token *Token
|
|
||||||
// LoginURL is the relative url path where a user can login
|
|
||||||
LoginURL string
|
|
||||||
// PrivateKey for encoding JWTs
|
|
||||||
PrivateKey string
|
|
||||||
// PublicKey for decoding JWTs
|
|
||||||
PublicKey string
|
|
||||||
// Secret is used to authenticate the service
|
|
||||||
Secret string
|
|
||||||
// ID is the services auth ID
|
|
||||||
ID string
|
|
||||||
// Issuer of the service's account
|
|
||||||
Issuer string
|
|
||||||
// Name holds the auth name
|
|
||||||
Name string
|
|
||||||
// Addrs sets the addresses of auth
|
|
||||||
Addrs []string
|
|
||||||
}
|
|
||||||
|
|
||||||
// Option func
|
|
||||||
type Option func(o *Options)
|
|
||||||
|
|
||||||
// Addrs is the auth addresses to use
|
|
||||||
func Addrs(addrs ...string) Option {
|
|
||||||
return func(o *Options) {
|
|
||||||
o.Addrs = addrs
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Name sets the name
|
|
||||||
func Name(n string) Option {
|
|
||||||
return func(o *Options) {
|
|
||||||
o.Name = n
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Issuer of the services account
|
|
||||||
func Issuer(i string) Option {
|
|
||||||
return func(o *Options) {
|
|
||||||
o.Issuer = i
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Store to back auth
|
|
||||||
func Store(s store.Store) Option {
|
|
||||||
return func(o *Options) {
|
|
||||||
o.Store = s
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// PublicKey is the JWT public key
|
|
||||||
func PublicKey(key string) Option {
|
|
||||||
return func(o *Options) {
|
|
||||||
o.PublicKey = key
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// PrivateKey is the JWT private key
|
|
||||||
func PrivateKey(key string) Option {
|
|
||||||
return func(o *Options) {
|
|
||||||
o.PrivateKey = key
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Credentials sets the auth credentials
|
|
||||||
func Credentials(id, secret string) Option {
|
|
||||||
return func(o *Options) {
|
|
||||||
o.ID = id
|
|
||||||
o.Secret = secret
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// ClientToken sets the auth token to use when making requests
|
|
||||||
func ClientToken(token *Token) Option {
|
|
||||||
return func(o *Options) {
|
|
||||||
o.Token = token
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// LoginURL sets the auth LoginURL
|
|
||||||
func LoginURL(url string) Option {
|
|
||||||
return func(o *Options) {
|
|
||||||
o.LoginURL = url
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// GenerateOptions struct
|
|
||||||
type GenerateOptions struct {
|
|
||||||
Metadata metadata.Metadata
|
|
||||||
Provider string
|
|
||||||
Type string
|
|
||||||
Secret string
|
|
||||||
Issuer string
|
|
||||||
Scopes []string
|
|
||||||
}
|
|
||||||
|
|
||||||
// GenerateOption func
|
|
||||||
type GenerateOption func(o *GenerateOptions)
|
|
||||||
|
|
||||||
// WithSecret for the generated account
|
|
||||||
func WithSecret(s string) GenerateOption {
|
|
||||||
return func(o *GenerateOptions) {
|
|
||||||
o.Secret = s
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithType for the generated account
|
|
||||||
func WithType(t string) GenerateOption {
|
|
||||||
return func(o *GenerateOptions) {
|
|
||||||
o.Type = t
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithMetadata for the generated account
|
|
||||||
func WithMetadata(md metadata.Metadata) GenerateOption {
|
|
||||||
return func(o *GenerateOptions) {
|
|
||||||
o.Metadata = metadata.Copy(md)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithProvider for the generated account
|
|
||||||
func WithProvider(p string) GenerateOption {
|
|
||||||
return func(o *GenerateOptions) {
|
|
||||||
o.Provider = p
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithScopes for the generated account
|
|
||||||
func WithScopes(s ...string) GenerateOption {
|
|
||||||
return func(o *GenerateOptions) {
|
|
||||||
o.Scopes = s
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithIssuer for the generated account
|
|
||||||
func WithIssuer(i string) GenerateOption {
|
|
||||||
return func(o *GenerateOptions) {
|
|
||||||
o.Issuer = i
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewGenerateOptions from a slice of options
|
|
||||||
func NewGenerateOptions(opts ...GenerateOption) GenerateOptions {
|
|
||||||
var options GenerateOptions
|
|
||||||
for _, o := range opts {
|
|
||||||
o(&options)
|
|
||||||
}
|
|
||||||
return options
|
|
||||||
}
|
|
||||||
|
|
||||||
// TokenOptions struct
|
|
||||||
type TokenOptions struct {
|
|
||||||
ID string
|
|
||||||
Secret string
|
|
||||||
RefreshToken string
|
|
||||||
Issuer string
|
|
||||||
Expiry time.Duration
|
|
||||||
}
|
|
||||||
|
|
||||||
// TokenOption func
|
|
||||||
type TokenOption func(o *TokenOptions)
|
|
||||||
|
|
||||||
// WithExpiry for the token
|
|
||||||
func WithExpiry(ex time.Duration) TokenOption {
|
|
||||||
return func(o *TokenOptions) {
|
|
||||||
o.Expiry = ex
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithCredentials sets tye id and secret
|
|
||||||
func WithCredentials(id, secret string) TokenOption {
|
|
||||||
return func(o *TokenOptions) {
|
|
||||||
o.ID = id
|
|
||||||
o.Secret = secret
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithToken sets the refresh token
|
|
||||||
func WithToken(rt string) TokenOption {
|
|
||||||
return func(o *TokenOptions) {
|
|
||||||
o.RefreshToken = rt
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithTokenIssuer sets the token issuer option
|
|
||||||
func WithTokenIssuer(iss string) TokenOption {
|
|
||||||
return func(o *TokenOptions) {
|
|
||||||
o.Issuer = iss
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewTokenOptions from a slice of options
|
|
||||||
func NewTokenOptions(opts ...TokenOption) TokenOptions {
|
|
||||||
var options TokenOptions
|
|
||||||
for _, o := range opts {
|
|
||||||
o(&options)
|
|
||||||
}
|
|
||||||
|
|
||||||
// set default expiry of token
|
|
||||||
if options.Expiry == 0 {
|
|
||||||
options.Expiry = time.Minute
|
|
||||||
}
|
|
||||||
|
|
||||||
return options
|
|
||||||
}
|
|
||||||
|
|
||||||
// VerifyOptions struct
|
|
||||||
type VerifyOptions struct {
|
|
||||||
Context context.Context
|
|
||||||
Namespace string
|
|
||||||
}
|
|
||||||
|
|
||||||
// VerifyOption func
|
|
||||||
type VerifyOption func(o *VerifyOptions)
|
|
||||||
|
|
||||||
// VerifyContext pass context to verify
|
|
||||||
func VerifyContext(ctx context.Context) VerifyOption {
|
|
||||||
return func(o *VerifyOptions) {
|
|
||||||
o.Context = ctx
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// VerifyNamespace sets thhe namespace for verify
|
|
||||||
func VerifyNamespace(ns string) VerifyOption {
|
|
||||||
return func(o *VerifyOptions) {
|
|
||||||
o.Namespace = ns
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// RulesOptions struct
|
|
||||||
type RulesOptions struct {
|
|
||||||
Context context.Context
|
|
||||||
Namespace string
|
|
||||||
}
|
|
||||||
|
|
||||||
// RulesOption func
|
|
||||||
type RulesOption func(o *RulesOptions)
|
|
||||||
|
|
||||||
// RulesContext pass rules context
|
|
||||||
func RulesContext(ctx context.Context) RulesOption {
|
|
||||||
return func(o *RulesOptions) {
|
|
||||||
o.Context = ctx
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// RulesNamespace sets the rule namespace
|
|
||||||
func RulesNamespace(ns string) RulesOption {
|
|
||||||
return func(o *RulesOptions) {
|
|
||||||
o.Namespace = ns
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Logger sets the logger
|
|
||||||
func Logger(l logger.Logger) Option {
|
|
||||||
return func(o *Options) {
|
|
||||||
o.Logger = l
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Meter sets the meter
|
|
||||||
func Meter(m meter.Meter) Option {
|
|
||||||
return func(o *Options) {
|
|
||||||
o.Meter = m
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Tracer sets the meter
|
|
||||||
func Tracer(t tracer.Tracer) Option {
|
|
||||||
return func(o *Options) {
|
|
||||||
o.Tracer = t
|
|
||||||
}
|
|
||||||
}
|
|
@@ -1,92 +0,0 @@
|
|||||||
package auth
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"sort"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
// VerifyAccess an account has access to a resource using the rules provided. If the account does not have
|
|
||||||
// access an error will be returned. If there are no rules provided which match the resource, an error
|
|
||||||
// will be returned
|
|
||||||
//nolint:gocyclo
|
|
||||||
func VerifyAccess(rules []*Rule, acc *Account, res *Resource) error {
|
|
||||||
// the rule is only to be applied if the type matches the resource or is catch-all (*)
|
|
||||||
validTypes := []string{"*", res.Type}
|
|
||||||
|
|
||||||
// the rule is only to be applied if the name matches the resource or is catch-all (*)
|
|
||||||
validNames := []string{"*", res.Name}
|
|
||||||
|
|
||||||
// rules can have wildcard excludes on endpoints since this can also be a path for web services,
|
|
||||||
// e.g. /foo/* would include /foo/bar. We also want to check for wildcards and the exact endpoint
|
|
||||||
validEndpoints := []string{"*", res.Endpoint}
|
|
||||||
if comps := strings.Split(res.Endpoint, "/"); len(comps) > 1 {
|
|
||||||
for i := 1; i < len(comps)+1; i++ {
|
|
||||||
wildcard := fmt.Sprintf("%v/*", strings.Join(comps[0:i], "/"))
|
|
||||||
validEndpoints = append(validEndpoints, wildcard)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// filter the rules to the ones which match the criteria above
|
|
||||||
filteredRules := make([]*Rule, 0)
|
|
||||||
for _, rule := range rules {
|
|
||||||
if !include(validTypes, rule.Resource.Type) {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
if !include(validNames, rule.Resource.Name) {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
if !include(validEndpoints, rule.Resource.Endpoint) {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
filteredRules = append(filteredRules, rule)
|
|
||||||
}
|
|
||||||
|
|
||||||
// sort the filtered rules by priority, highest to lowest
|
|
||||||
sort.SliceStable(filteredRules, func(i, j int) bool {
|
|
||||||
return filteredRules[i].Priority > filteredRules[j].Priority
|
|
||||||
})
|
|
||||||
|
|
||||||
// loop through the rules and check for a rule which applies to this account
|
|
||||||
for _, rule := range filteredRules {
|
|
||||||
// a blank scope indicates the rule applies to everyone, even nil accounts
|
|
||||||
if rule.Scope == ScopePublic && rule.Access == AccessDenied {
|
|
||||||
return ErrForbidden
|
|
||||||
} else if rule.Scope == ScopePublic && rule.Access == AccessGranted {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// all further checks require an account
|
|
||||||
if acc == nil {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
// this rule applies to any account
|
|
||||||
if rule.Scope == ScopeAccount && rule.Access == AccessDenied {
|
|
||||||
return ErrForbidden
|
|
||||||
} else if rule.Scope == ScopeAccount && rule.Access == AccessGranted {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// if the account has the necessary scope
|
|
||||||
if include(acc.Scopes, rule.Scope) && rule.Access == AccessDenied {
|
|
||||||
return ErrForbidden
|
|
||||||
} else if include(acc.Scopes, rule.Scope) && rule.Access == AccessGranted {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// if no rules matched then return forbidden
|
|
||||||
return ErrForbidden
|
|
||||||
}
|
|
||||||
|
|
||||||
// include is a helper function which checks to see if the slice contains the value. includes is
|
|
||||||
// not case sensitive.
|
|
||||||
func include(slice []string, val string) bool {
|
|
||||||
for _, s := range slice {
|
|
||||||
if strings.EqualFold(s, val) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
|
@@ -1,288 +0,0 @@
|
|||||||
package auth
|
|
||||||
|
|
||||||
import (
|
|
||||||
"testing"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestVerify(t *testing.T) {
|
|
||||||
srvResource := &Resource{
|
|
||||||
Type: "service",
|
|
||||||
Name: "go.micro.service.foo",
|
|
||||||
Endpoint: "Foo.Bar",
|
|
||||||
}
|
|
||||||
|
|
||||||
webResource := &Resource{
|
|
||||||
Type: "service",
|
|
||||||
Name: "go.micro.web.foo",
|
|
||||||
Endpoint: "/foo/bar",
|
|
||||||
}
|
|
||||||
|
|
||||||
catchallResource := &Resource{
|
|
||||||
Type: "*",
|
|
||||||
Name: "*",
|
|
||||||
Endpoint: "*",
|
|
||||||
}
|
|
||||||
|
|
||||||
tt := []struct {
|
|
||||||
Error error
|
|
||||||
Account *Account
|
|
||||||
Resource *Resource
|
|
||||||
Name string
|
|
||||||
Rules []*Rule
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
Name: "NoRules",
|
|
||||||
Rules: []*Rule{},
|
|
||||||
Account: nil,
|
|
||||||
Resource: srvResource,
|
|
||||||
Error: ErrForbidden,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Name: "CatchallPublicAccount",
|
|
||||||
Account: &Account{},
|
|
||||||
Resource: srvResource,
|
|
||||||
Rules: []*Rule{
|
|
||||||
{
|
|
||||||
Scope: "",
|
|
||||||
Resource: catchallResource,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Name: "CatchallPublicNoAccount",
|
|
||||||
Resource: srvResource,
|
|
||||||
Rules: []*Rule{
|
|
||||||
{
|
|
||||||
Scope: "",
|
|
||||||
Resource: catchallResource,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Name: "CatchallPrivateAccount",
|
|
||||||
Account: &Account{},
|
|
||||||
Resource: srvResource,
|
|
||||||
Rules: []*Rule{
|
|
||||||
{
|
|
||||||
Scope: "*",
|
|
||||||
Resource: catchallResource,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Name: "CatchallPrivateNoAccount",
|
|
||||||
Resource: srvResource,
|
|
||||||
Rules: []*Rule{
|
|
||||||
{
|
|
||||||
Scope: "*",
|
|
||||||
Resource: catchallResource,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
Error: ErrForbidden,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Name: "CatchallServiceRuleMatch",
|
|
||||||
Resource: srvResource,
|
|
||||||
Account: &Account{},
|
|
||||||
Rules: []*Rule{
|
|
||||||
{
|
|
||||||
Scope: "*",
|
|
||||||
Resource: &Resource{
|
|
||||||
Type: srvResource.Type,
|
|
||||||
Name: srvResource.Name,
|
|
||||||
Endpoint: "*",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Name: "CatchallServiceRuleNoMatch",
|
|
||||||
Resource: srvResource,
|
|
||||||
Account: &Account{},
|
|
||||||
Rules: []*Rule{
|
|
||||||
{
|
|
||||||
Scope: "*",
|
|
||||||
Resource: &Resource{
|
|
||||||
Type: srvResource.Type,
|
|
||||||
Name: "wrongname",
|
|
||||||
Endpoint: "*",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
Error: ErrForbidden,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Name: "ExactRuleValidScope",
|
|
||||||
Resource: srvResource,
|
|
||||||
Account: &Account{
|
|
||||||
Scopes: []string{"neededscope"},
|
|
||||||
},
|
|
||||||
Rules: []*Rule{
|
|
||||||
{
|
|
||||||
Scope: "neededscope",
|
|
||||||
Resource: srvResource,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Name: "ExactRuleInvalidScope",
|
|
||||||
Resource: srvResource,
|
|
||||||
Account: &Account{
|
|
||||||
Scopes: []string{"neededscope"},
|
|
||||||
},
|
|
||||||
Rules: []*Rule{
|
|
||||||
{
|
|
||||||
Scope: "invalidscope",
|
|
||||||
Resource: srvResource,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
Error: ErrForbidden,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Name: "CatchallDenyWithAccount",
|
|
||||||
Resource: srvResource,
|
|
||||||
Account: &Account{},
|
|
||||||
Rules: []*Rule{
|
|
||||||
{
|
|
||||||
Scope: "*",
|
|
||||||
Resource: catchallResource,
|
|
||||||
Access: AccessDenied,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
Error: ErrForbidden,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Name: "CatchallDenyWithNoAccount",
|
|
||||||
Resource: srvResource,
|
|
||||||
Account: &Account{},
|
|
||||||
Rules: []*Rule{
|
|
||||||
{
|
|
||||||
Scope: "*",
|
|
||||||
Resource: catchallResource,
|
|
||||||
Access: AccessDenied,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
Error: ErrForbidden,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Name: "RulePriorityGrantFirst",
|
|
||||||
Resource: srvResource,
|
|
||||||
Account: &Account{},
|
|
||||||
Rules: []*Rule{
|
|
||||||
{
|
|
||||||
Scope: "*",
|
|
||||||
Resource: catchallResource,
|
|
||||||
Access: AccessGranted,
|
|
||||||
Priority: 1,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Scope: "*",
|
|
||||||
Resource: catchallResource,
|
|
||||||
Access: AccessDenied,
|
|
||||||
Priority: 0,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Name: "RulePriorityDenyFirst",
|
|
||||||
Resource: srvResource,
|
|
||||||
Account: &Account{},
|
|
||||||
Rules: []*Rule{
|
|
||||||
{
|
|
||||||
Scope: "*",
|
|
||||||
Resource: catchallResource,
|
|
||||||
Access: AccessGranted,
|
|
||||||
Priority: 0,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Scope: "*",
|
|
||||||
Resource: catchallResource,
|
|
||||||
Access: AccessDenied,
|
|
||||||
Priority: 1,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
Error: ErrForbidden,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Name: "WebExactEndpointValid",
|
|
||||||
Resource: webResource,
|
|
||||||
Account: &Account{},
|
|
||||||
Rules: []*Rule{
|
|
||||||
{
|
|
||||||
Scope: "*",
|
|
||||||
Resource: webResource,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Name: "WebExactEndpointInalid",
|
|
||||||
Resource: webResource,
|
|
||||||
Account: &Account{},
|
|
||||||
Rules: []*Rule{
|
|
||||||
{
|
|
||||||
Scope: "*",
|
|
||||||
Resource: &Resource{
|
|
||||||
Type: webResource.Type,
|
|
||||||
Name: webResource.Name,
|
|
||||||
Endpoint: "invalidendpoint",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
Error: ErrForbidden,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Name: "WebWildcardEndpoint",
|
|
||||||
Resource: webResource,
|
|
||||||
Account: &Account{},
|
|
||||||
Rules: []*Rule{
|
|
||||||
{
|
|
||||||
Scope: "*",
|
|
||||||
Resource: &Resource{
|
|
||||||
Type: webResource.Type,
|
|
||||||
Name: webResource.Name,
|
|
||||||
Endpoint: "*",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Name: "WebWildcardPathEndpointValid",
|
|
||||||
Resource: webResource,
|
|
||||||
Account: &Account{},
|
|
||||||
Rules: []*Rule{
|
|
||||||
{
|
|
||||||
Scope: "*",
|
|
||||||
Resource: &Resource{
|
|
||||||
Type: webResource.Type,
|
|
||||||
Name: webResource.Name,
|
|
||||||
Endpoint: "/foo/*",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Name: "WebWildcardPathEndpointInvalid",
|
|
||||||
Resource: webResource,
|
|
||||||
Account: &Account{},
|
|
||||||
Rules: []*Rule{
|
|
||||||
{
|
|
||||||
Scope: "*",
|
|
||||||
Resource: &Resource{
|
|
||||||
Type: webResource.Type,
|
|
||||||
Name: webResource.Name,
|
|
||||||
Endpoint: "/bar/*",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
Error: ErrForbidden,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range tt {
|
|
||||||
t.Run(tc.Name, func(t *testing.T) {
|
|
||||||
if err := VerifyAccess(tc.Rules, tc.Account, tc.Resource); err != tc.Error {
|
|
||||||
t.Errorf("Expected %v but got %v", tc.Error, err)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
@@ -5,11 +5,12 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
|
|
||||||
|
"go.unistack.org/micro/v3/codec"
|
||||||
"go.unistack.org/micro/v3/metadata"
|
"go.unistack.org/micro/v3/metadata"
|
||||||
)
|
)
|
||||||
|
|
||||||
// DefaultBroker default memory broker
|
// DefaultBroker default memory broker
|
||||||
var DefaultBroker Broker = NewBroker()
|
var DefaultBroker = NewBroker()
|
||||||
|
|
||||||
var (
|
var (
|
||||||
// ErrNotConnected returns when broker used but not connected yet
|
// ErrNotConnected returns when broker used but not connected yet
|
||||||
@@ -50,6 +51,7 @@ type Handler func(Event) error
|
|||||||
// Events contains multiple events
|
// Events contains multiple events
|
||||||
type Events []Event
|
type Events []Event
|
||||||
|
|
||||||
|
// Ack try to ack all events and return
|
||||||
func (evs Events) Ack() error {
|
func (evs Events) Ack() error {
|
||||||
var err error
|
var err error
|
||||||
for _, ev := range evs {
|
for _, ev := range evs {
|
||||||
@@ -60,6 +62,7 @@ func (evs Events) Ack() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetError sets error on event
|
||||||
func (evs Events) SetError(err error) {
|
func (evs Events) SetError(err error) {
|
||||||
for _, ev := range evs {
|
for _, ev := range evs {
|
||||||
ev.SetError(err)
|
ev.SetError(err)
|
||||||
@@ -83,33 +86,12 @@ type Event interface {
|
|||||||
SetError(err error)
|
SetError(err error)
|
||||||
}
|
}
|
||||||
|
|
||||||
// RawMessage is a raw encoded JSON value.
|
|
||||||
// It implements Marshaler and Unmarshaler and can be used to delay decoding or precompute a encoding.
|
|
||||||
type RawMessage []byte
|
|
||||||
|
|
||||||
// MarshalJSON returns m as the JSON encoding of m.
|
|
||||||
func (m *RawMessage) MarshalJSON() ([]byte, error) {
|
|
||||||
if m == nil {
|
|
||||||
return []byte("null"), nil
|
|
||||||
}
|
|
||||||
return *m, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// UnmarshalJSON sets *m to a copy of data.
|
|
||||||
func (m *RawMessage) UnmarshalJSON(data []byte) error {
|
|
||||||
if m == nil {
|
|
||||||
return errors.New("RawMessage UnmarshalJSON on nil pointer")
|
|
||||||
}
|
|
||||||
*m = append((*m)[0:0], data...)
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Message is used to transfer data
|
// Message is used to transfer data
|
||||||
type Message struct {
|
type Message struct {
|
||||||
// Header contains message metadata
|
// Header contains message metadata
|
||||||
Header metadata.Metadata
|
Header metadata.Metadata
|
||||||
// Body contains message body
|
// Body contains message body
|
||||||
Body RawMessage
|
Body codec.RawMessage
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewMessage create broker message with topic filled
|
// NewMessage create broker message with topic filled
|
||||||
|
72
broker/context_test.go
Normal file
72
broker/context_test.go
Normal file
@@ -0,0 +1,72 @@
|
|||||||
|
package broker
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestFromContext(t *testing.T) {
|
||||||
|
ctx := context.WithValue(context.TODO(), brokerKey{}, NewBroker())
|
||||||
|
c, ok := FromContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("FromContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFromNilContext(t *testing.T) {
|
||||||
|
// nolint: staticcheck
|
||||||
|
c, ok := FromContext(nil)
|
||||||
|
if ok || c != nil {
|
||||||
|
t.Fatal("FromContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewContext(t *testing.T) {
|
||||||
|
ctx := NewContext(context.TODO(), NewBroker())
|
||||||
|
c, ok := FromContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("NewContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewNilContext(t *testing.T) {
|
||||||
|
// nolint: staticcheck
|
||||||
|
ctx := NewContext(nil, NewBroker())
|
||||||
|
c, ok := FromContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("NewContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetSubscribeOption(t *testing.T) {
|
||||||
|
type key struct{}
|
||||||
|
o := SetSubscribeOption(key{}, "test")
|
||||||
|
opts := &SubscribeOptions{}
|
||||||
|
o(opts)
|
||||||
|
|
||||||
|
if v, ok := opts.Context.Value(key{}).(string); !ok || v == "" {
|
||||||
|
t.Fatal("SetSubscribeOption not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetPublishOption(t *testing.T) {
|
||||||
|
type key struct{}
|
||||||
|
o := SetPublishOption(key{}, "test")
|
||||||
|
opts := &PublishOptions{}
|
||||||
|
o(opts)
|
||||||
|
|
||||||
|
if v, ok := opts.Context.Value(key{}).(string); !ok || v == "" {
|
||||||
|
t.Fatal("SetPublishOption not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetOption(t *testing.T) {
|
||||||
|
type key struct{}
|
||||||
|
o := SetOption(key{}, "test")
|
||||||
|
opts := &Options{}
|
||||||
|
o(opts)
|
||||||
|
|
||||||
|
if v, ok := opts.Context.Value(key{}).(string); !ok || v == "" {
|
||||||
|
t.Fatal("SetOption not works")
|
||||||
|
}
|
||||||
|
}
|
@@ -1,32 +0,0 @@
|
|||||||
// Package build is for building source into a package
|
|
||||||
package build // import "go.unistack.org/micro/v3/build"
|
|
||||||
|
|
||||||
// Build is an interface for building packages
|
|
||||||
type Build interface {
|
|
||||||
// Package builds a package
|
|
||||||
Package(name string, src *Source) (*Package, error)
|
|
||||||
// Remove removes the package
|
|
||||||
Remove(*Package) error
|
|
||||||
}
|
|
||||||
|
|
||||||
// Source is the source of a build
|
|
||||||
type Source struct {
|
|
||||||
// Path to the source if local
|
|
||||||
Path string
|
|
||||||
// Language is the language of code
|
|
||||||
Language string
|
|
||||||
// Location of the source
|
|
||||||
Repository string
|
|
||||||
}
|
|
||||||
|
|
||||||
// Package is packaged format for source
|
|
||||||
type Package struct {
|
|
||||||
// Source of the package
|
|
||||||
Source *Source
|
|
||||||
// Name of the package
|
|
||||||
Name string
|
|
||||||
// Location of the package
|
|
||||||
Path string
|
|
||||||
// Type of package e.g tarball, binary, docker
|
|
||||||
Type string
|
|
||||||
}
|
|
@@ -1,17 +0,0 @@
|
|||||||
package build
|
|
||||||
|
|
||||||
// Options struct
|
|
||||||
type Options struct {
|
|
||||||
// local path to download source
|
|
||||||
Path string
|
|
||||||
}
|
|
||||||
|
|
||||||
// Option func
|
|
||||||
type Option func(o *Options)
|
|
||||||
|
|
||||||
// Path is the Local path for repository
|
|
||||||
func Path(p string) Option {
|
|
||||||
return func(o *Options) {
|
|
||||||
o.Path = p
|
|
||||||
}
|
|
||||||
}
|
|
@@ -2,6 +2,7 @@ package client
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"math"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"go.unistack.org/micro/v3/util/backoff"
|
"go.unistack.org/micro/v3/util/backoff"
|
||||||
@@ -10,6 +11,20 @@ import (
|
|||||||
// BackoffFunc is the backoff call func
|
// BackoffFunc is the backoff call func
|
||||||
type BackoffFunc func(ctx context.Context, req Request, attempts int) (time.Duration, error)
|
type BackoffFunc func(ctx context.Context, req Request, attempts int) (time.Duration, error)
|
||||||
|
|
||||||
func exponentialBackoff(ctx context.Context, req Request, attempts int) (time.Duration, error) {
|
// BackoffExp using exponential backoff func
|
||||||
|
func BackoffExp(_ context.Context, _ Request, attempts int) (time.Duration, error) {
|
||||||
return backoff.Do(attempts), nil
|
return backoff.Do(attempts), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// BackoffInterval specifies randomization interval for backoff func
|
||||||
|
func BackoffInterval(min time.Duration, max time.Duration) BackoffFunc {
|
||||||
|
return func(_ context.Context, _ Request, attempts int) (time.Duration, error) {
|
||||||
|
td := time.Duration(math.Pow(float64(attempts), math.E)) * time.Millisecond * 100
|
||||||
|
if td < min {
|
||||||
|
return min, nil
|
||||||
|
} else if td > max {
|
||||||
|
return max, nil
|
||||||
|
}
|
||||||
|
return td, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@@ -6,7 +6,7 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestBackoff(t *testing.T) {
|
func TestBackoffExp(t *testing.T) {
|
||||||
results := []time.Duration{
|
results := []time.Duration{
|
||||||
0 * time.Second,
|
0 * time.Second,
|
||||||
100 * time.Millisecond,
|
100 * time.Millisecond,
|
||||||
@@ -22,7 +22,7 @@ func TestBackoff(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
for i := 0; i < 5; i++ {
|
for i := 0; i < 5; i++ {
|
||||||
d, err := exponentialBackoff(context.TODO(), r, i)
|
d, err := BackoffExp(context.TODO(), r, i)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
@@ -32,3 +32,25 @@ func TestBackoff(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestBackoffInterval(t *testing.T) {
|
||||||
|
min := 100 * time.Millisecond
|
||||||
|
max := 300 * time.Millisecond
|
||||||
|
|
||||||
|
r := &testRequest{
|
||||||
|
service: "test",
|
||||||
|
method: "test",
|
||||||
|
}
|
||||||
|
|
||||||
|
fn := BackoffInterval(min, max)
|
||||||
|
for i := 0; i < 5; i++ {
|
||||||
|
d, err := fn(context.TODO(), r, i)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if d < min || d > max {
|
||||||
|
t.Fatalf("Expected %v < %v < %v", min, d, max)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@@ -11,11 +11,11 @@ import (
|
|||||||
|
|
||||||
var (
|
var (
|
||||||
// DefaultClient is the global default client
|
// DefaultClient is the global default client
|
||||||
DefaultClient Client = NewClient()
|
DefaultClient = NewClient()
|
||||||
// DefaultContentType is the default content-type if not specified
|
// DefaultContentType is the default content-type if not specified
|
||||||
DefaultContentType = "application/json"
|
DefaultContentType = ""
|
||||||
// DefaultBackoff is the default backoff function for retries
|
// DefaultBackoff is the default backoff function for retries (minimum 10 millisecond and maximum 5 second)
|
||||||
DefaultBackoff = exponentialBackoff
|
DefaultBackoff = BackoffInterval(10*time.Millisecond, 5*time.Second)
|
||||||
// DefaultRetry is the default check-for-retry function for retries
|
// DefaultRetry is the default check-for-retry function for retries
|
||||||
DefaultRetry = RetryNever
|
DefaultRetry = RetryNever
|
||||||
// DefaultRetries is the default number of times a request is tried
|
// DefaultRetries is the default number of times a request is tried
|
||||||
@@ -74,7 +74,7 @@ type Request interface {
|
|||||||
type Response interface {
|
type Response interface {
|
||||||
// Read the response
|
// Read the response
|
||||||
Codec() codec.Codec
|
Codec() codec.Codec
|
||||||
// read the header
|
// Header data
|
||||||
Header() metadata.Metadata
|
Header() metadata.Metadata
|
||||||
// Read the undecoded response
|
// Read the undecoded response
|
||||||
Read() ([]byte, error)
|
Read() ([]byte, error)
|
||||||
|
26
client/client_call_options_test.go
Normal file
26
client/client_call_options_test.go
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
package client
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestNewClientCallOptions(t *testing.T) {
|
||||||
|
var flag bool
|
||||||
|
w := func(fn CallFunc) CallFunc {
|
||||||
|
flag = true
|
||||||
|
return fn
|
||||||
|
}
|
||||||
|
c := NewClientCallOptions(NewClient(),
|
||||||
|
WithAddress("127.0.0.1"),
|
||||||
|
WithCallWrapper(w),
|
||||||
|
WithRequestTimeout(1*time.Millisecond),
|
||||||
|
WithRetries(0),
|
||||||
|
WithBackoff(BackoffInterval(10*time.Millisecond, 100*time.Millisecond)),
|
||||||
|
)
|
||||||
|
_ = c.Call(context.TODO(), c.NewRequest("service", "endpoint", nil), nil)
|
||||||
|
if !flag {
|
||||||
|
t.Fatalf("NewClientCallOptions not works")
|
||||||
|
}
|
||||||
|
}
|
73
client/context_test.go
Normal file
73
client/context_test.go
Normal file
@@ -0,0 +1,73 @@
|
|||||||
|
package client
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestFromContext(t *testing.T) {
|
||||||
|
ctx := context.WithValue(context.TODO(), clientKey{}, NewClient())
|
||||||
|
|
||||||
|
c, ok := FromContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("FromContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFromNilContext(t *testing.T) {
|
||||||
|
// nolint: staticcheck
|
||||||
|
c, ok := FromContext(nil)
|
||||||
|
if ok || c != nil {
|
||||||
|
t.Fatal("FromContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewContext(t *testing.T) {
|
||||||
|
ctx := NewContext(context.TODO(), NewClient())
|
||||||
|
c, ok := FromContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("NewContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewNilContext(t *testing.T) {
|
||||||
|
// nolint: staticcheck
|
||||||
|
ctx := NewContext(nil, NewClient())
|
||||||
|
c, ok := FromContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("NewContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetPublishOption(t *testing.T) {
|
||||||
|
type key struct{}
|
||||||
|
o := SetPublishOption(key{}, "test")
|
||||||
|
opts := &PublishOptions{}
|
||||||
|
o(opts)
|
||||||
|
|
||||||
|
if v, ok := opts.Context.Value(key{}).(string); !ok || v == "" {
|
||||||
|
t.Fatal("SetPublishOption not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetCallOption(t *testing.T) {
|
||||||
|
type key struct{}
|
||||||
|
o := SetCallOption(key{}, "test")
|
||||||
|
opts := &CallOptions{}
|
||||||
|
o(opts)
|
||||||
|
|
||||||
|
if v, ok := opts.Context.Value(key{}).(string); !ok || v == "" {
|
||||||
|
t.Fatal("SetCallOption not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetOption(t *testing.T) {
|
||||||
|
type key struct{}
|
||||||
|
o := SetOption(key{}, "test")
|
||||||
|
opts := &Options{}
|
||||||
|
o(opts)
|
||||||
|
|
||||||
|
if v, ok := opts.Context.Value(key{}).(string); !ok || v == "" {
|
||||||
|
t.Fatal("SetOption not works")
|
||||||
|
}
|
||||||
|
}
|
275
client/noop.go
275
client/noop.go
@@ -2,11 +2,14 @@ package client
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
|
||||||
"go.unistack.org/micro/v3/broker"
|
"go.unistack.org/micro/v3/broker"
|
||||||
"go.unistack.org/micro/v3/codec"
|
"go.unistack.org/micro/v3/codec"
|
||||||
"go.unistack.org/micro/v3/errors"
|
"go.unistack.org/micro/v3/errors"
|
||||||
"go.unistack.org/micro/v3/metadata"
|
"go.unistack.org/micro/v3/metadata"
|
||||||
|
"go.unistack.org/micro/v3/selector"
|
||||||
)
|
)
|
||||||
|
|
||||||
// DefaultCodecs will be used to encode/decode data
|
// DefaultCodecs will be used to encode/decode data
|
||||||
@@ -181,6 +184,138 @@ func (n *noopClient) String() string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (n *noopClient) Call(ctx context.Context, req Request, rsp interface{}, opts ...CallOption) error {
|
func (n *noopClient) Call(ctx context.Context, req Request, rsp interface{}, opts ...CallOption) error {
|
||||||
|
// make a copy of call opts
|
||||||
|
callOpts := n.opts.CallOptions
|
||||||
|
for _, opt := range opts {
|
||||||
|
opt(&callOpts)
|
||||||
|
}
|
||||||
|
|
||||||
|
// check if we already have a deadline
|
||||||
|
d, ok := ctx.Deadline()
|
||||||
|
if !ok {
|
||||||
|
var cancel context.CancelFunc
|
||||||
|
// no deadline so we create a new one
|
||||||
|
ctx, cancel = context.WithTimeout(ctx, callOpts.RequestTimeout)
|
||||||
|
defer cancel()
|
||||||
|
} else {
|
||||||
|
// got a deadline so no need to setup context
|
||||||
|
// but we need to set the timeout we pass along
|
||||||
|
opt := WithRequestTimeout(time.Until(d))
|
||||||
|
opt(&callOpts)
|
||||||
|
}
|
||||||
|
|
||||||
|
// should we noop right here?
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return errors.New("go.micro.client", fmt.Sprintf("%v", ctx.Err()), 408)
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
|
||||||
|
// make copy of call method
|
||||||
|
hcall := n.call
|
||||||
|
|
||||||
|
// wrap the call in reverse
|
||||||
|
for i := len(callOpts.CallWrappers); i > 0; i-- {
|
||||||
|
hcall = callOpts.CallWrappers[i-1](hcall)
|
||||||
|
}
|
||||||
|
|
||||||
|
// use the router passed as a call option, or fallback to the rpc clients router
|
||||||
|
if callOpts.Router == nil {
|
||||||
|
callOpts.Router = n.opts.Router
|
||||||
|
}
|
||||||
|
|
||||||
|
if callOpts.Selector == nil {
|
||||||
|
callOpts.Selector = n.opts.Selector
|
||||||
|
}
|
||||||
|
|
||||||
|
// inject proxy address
|
||||||
|
// TODO: don't even bother using Lookup/Select in this case
|
||||||
|
if len(n.opts.Proxy) > 0 {
|
||||||
|
callOpts.Address = []string{n.opts.Proxy}
|
||||||
|
}
|
||||||
|
|
||||||
|
var next selector.Next
|
||||||
|
|
||||||
|
// return errors.New("go.micro.client", "request timeout", 408)
|
||||||
|
call := func(i int) error {
|
||||||
|
// call backoff first. Someone may want an initial start delay
|
||||||
|
t, err := callOpts.Backoff(ctx, req, i)
|
||||||
|
if err != nil {
|
||||||
|
return errors.InternalServerError("go.micro.client", err.Error())
|
||||||
|
}
|
||||||
|
|
||||||
|
// only sleep if greater than 0
|
||||||
|
if t.Seconds() > 0 {
|
||||||
|
time.Sleep(t)
|
||||||
|
}
|
||||||
|
|
||||||
|
if next == nil {
|
||||||
|
var routes []string
|
||||||
|
// lookup the route to send the reques to
|
||||||
|
// TODO apply any filtering here
|
||||||
|
routes, err = n.opts.Lookup(ctx, req, callOpts)
|
||||||
|
if err != nil {
|
||||||
|
return errors.InternalServerError("go.micro.client", err.Error())
|
||||||
|
}
|
||||||
|
|
||||||
|
// balance the list of nodes
|
||||||
|
next, err = callOpts.Selector.Select(routes)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
node := next()
|
||||||
|
|
||||||
|
// make the call
|
||||||
|
err = hcall(ctx, node, req, rsp, callOpts)
|
||||||
|
// record the result of the call to inform future routing decisions
|
||||||
|
if verr := n.opts.Selector.Record(node, err); verr != nil {
|
||||||
|
return verr
|
||||||
|
}
|
||||||
|
|
||||||
|
// try and transform the error to a go-micro error
|
||||||
|
if verr, ok := err.(*errors.Error); ok {
|
||||||
|
return verr
|
||||||
|
}
|
||||||
|
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
ch := make(chan error, callOpts.Retries)
|
||||||
|
var gerr error
|
||||||
|
|
||||||
|
for i := 0; i <= callOpts.Retries; i++ {
|
||||||
|
go func() {
|
||||||
|
ch <- call(i)
|
||||||
|
}()
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return errors.New("go.micro.client", fmt.Sprintf("%v", ctx.Err()), 408)
|
||||||
|
case err := <-ch:
|
||||||
|
// if the call succeeded lets bail early
|
||||||
|
if err == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
retry, rerr := callOpts.Retry(ctx, req, i, err)
|
||||||
|
if rerr != nil {
|
||||||
|
return rerr
|
||||||
|
}
|
||||||
|
|
||||||
|
if !retry {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
gerr = err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return gerr
|
||||||
|
}
|
||||||
|
|
||||||
|
func (n *noopClient) call(ctx context.Context, addr string, req Request, rsp interface{}, opts CallOptions) error {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -194,6 +329,146 @@ func (n *noopClient) NewMessage(topic string, msg interface{}, opts ...MessageOp
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (n *noopClient) Stream(ctx context.Context, req Request, opts ...CallOption) (Stream, error) {
|
func (n *noopClient) Stream(ctx context.Context, req Request, opts ...CallOption) (Stream, error) {
|
||||||
|
var err error
|
||||||
|
|
||||||
|
// make a copy of call opts
|
||||||
|
callOpts := n.opts.CallOptions
|
||||||
|
for _, o := range opts {
|
||||||
|
o(&callOpts)
|
||||||
|
}
|
||||||
|
|
||||||
|
// check if we already have a deadline
|
||||||
|
d, ok := ctx.Deadline()
|
||||||
|
if !ok && callOpts.StreamTimeout > time.Duration(0) {
|
||||||
|
var cancel context.CancelFunc
|
||||||
|
// no deadline so we create a new one
|
||||||
|
ctx, cancel = context.WithTimeout(ctx, callOpts.StreamTimeout)
|
||||||
|
defer cancel()
|
||||||
|
} else {
|
||||||
|
// got a deadline so no need to setup context
|
||||||
|
// but we need to set the timeout we pass along
|
||||||
|
o := WithStreamTimeout(time.Until(d))
|
||||||
|
o(&callOpts)
|
||||||
|
}
|
||||||
|
|
||||||
|
// should we noop right here?
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return nil, errors.New("go.micro.client", fmt.Sprintf("%v", ctx.Err()), 408)
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
// make copy of call method
|
||||||
|
hstream := h.stream
|
||||||
|
// wrap the call in reverse
|
||||||
|
for i := len(callOpts.CallWrappers); i > 0; i-- {
|
||||||
|
hstream = callOpts.CallWrappers[i-1](hstream)
|
||||||
|
}
|
||||||
|
*/
|
||||||
|
|
||||||
|
// use the router passed as a call option, or fallback to the rpc clients router
|
||||||
|
if callOpts.Router == nil {
|
||||||
|
callOpts.Router = n.opts.Router
|
||||||
|
}
|
||||||
|
|
||||||
|
if callOpts.Selector == nil {
|
||||||
|
callOpts.Selector = n.opts.Selector
|
||||||
|
}
|
||||||
|
|
||||||
|
// inject proxy address
|
||||||
|
// TODO: don't even bother using Lookup/Select in this case
|
||||||
|
if len(n.opts.Proxy) > 0 {
|
||||||
|
callOpts.Address = []string{n.opts.Proxy}
|
||||||
|
}
|
||||||
|
|
||||||
|
var next selector.Next
|
||||||
|
|
||||||
|
call := func(i int) (Stream, error) {
|
||||||
|
// call backoff first. Someone may want an initial start delay
|
||||||
|
t, cerr := callOpts.Backoff(ctx, req, i)
|
||||||
|
if cerr != nil {
|
||||||
|
return nil, errors.InternalServerError("go.micro.client", cerr.Error())
|
||||||
|
}
|
||||||
|
|
||||||
|
// only sleep if greater than 0
|
||||||
|
if t.Seconds() > 0 {
|
||||||
|
time.Sleep(t)
|
||||||
|
}
|
||||||
|
|
||||||
|
if next == nil {
|
||||||
|
var routes []string
|
||||||
|
// lookup the route to send the reques to
|
||||||
|
// TODO apply any filtering here
|
||||||
|
routes, err = n.opts.Lookup(ctx, req, callOpts)
|
||||||
|
if err != nil {
|
||||||
|
return nil, errors.InternalServerError("go.micro.client", err.Error())
|
||||||
|
}
|
||||||
|
|
||||||
|
// balance the list of nodes
|
||||||
|
next, err = callOpts.Selector.Select(routes)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
node := next()
|
||||||
|
|
||||||
|
stream, cerr := n.stream(ctx, node, req, callOpts)
|
||||||
|
|
||||||
|
// record the result of the call to inform future routing decisions
|
||||||
|
if verr := n.opts.Selector.Record(node, cerr); verr != nil {
|
||||||
|
return nil, verr
|
||||||
|
}
|
||||||
|
|
||||||
|
// try and transform the error to a go-micro error
|
||||||
|
if verr, ok := cerr.(*errors.Error); ok {
|
||||||
|
return nil, verr
|
||||||
|
}
|
||||||
|
|
||||||
|
return stream, cerr
|
||||||
|
}
|
||||||
|
|
||||||
|
type response struct {
|
||||||
|
stream Stream
|
||||||
|
err error
|
||||||
|
}
|
||||||
|
|
||||||
|
ch := make(chan response, callOpts.Retries)
|
||||||
|
var grr error
|
||||||
|
|
||||||
|
for i := 0; i <= callOpts.Retries; i++ {
|
||||||
|
go func() {
|
||||||
|
s, cerr := call(i)
|
||||||
|
ch <- response{s, cerr}
|
||||||
|
}()
|
||||||
|
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return nil, errors.New("go.micro.client", fmt.Sprintf("%v", ctx.Err()), 408)
|
||||||
|
case rsp := <-ch:
|
||||||
|
// if the call succeeded lets bail early
|
||||||
|
if rsp.err == nil {
|
||||||
|
return rsp.stream, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
retry, rerr := callOpts.Retry(ctx, req, i, err)
|
||||||
|
if rerr != nil {
|
||||||
|
return nil, rerr
|
||||||
|
}
|
||||||
|
|
||||||
|
if !retry {
|
||||||
|
return nil, rsp.err
|
||||||
|
}
|
||||||
|
|
||||||
|
grr = rsp.err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil, grr
|
||||||
|
}
|
||||||
|
|
||||||
|
func (n *noopClient) stream(ctx context.Context, addr string, req Request, opts CallOptions) (Stream, error) {
|
||||||
return &noopStream{}, nil
|
return &noopStream{}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@@ -3,6 +3,7 @@ package client
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"crypto/tls"
|
"crypto/tls"
|
||||||
|
"net"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"go.unistack.org/micro/v3/broker"
|
"go.unistack.org/micro/v3/broker"
|
||||||
@@ -56,6 +57,8 @@ type Options struct {
|
|||||||
PoolSize int
|
PoolSize int
|
||||||
// PoolTTL connection pool ttl
|
// PoolTTL connection pool ttl
|
||||||
PoolTTL time.Duration
|
PoolTTL time.Duration
|
||||||
|
// ContextDialer used to connect
|
||||||
|
ContextDialer func(context.Context, string) (net.Conn, error)
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewCallOptions creates new call options struct
|
// NewCallOptions creates new call options struct
|
||||||
@@ -95,10 +98,23 @@ type CallOptions struct {
|
|||||||
StreamTimeout time.Duration
|
StreamTimeout time.Duration
|
||||||
// RequestTimeout request timeout
|
// RequestTimeout request timeout
|
||||||
RequestTimeout time.Duration
|
RequestTimeout time.Duration
|
||||||
|
// RequestMetadata holds additional metadata for call
|
||||||
|
RequestMetadata metadata.Metadata
|
||||||
|
// ResponseMetadata holds additional metadata from call
|
||||||
|
ResponseMetadata *metadata.Metadata
|
||||||
// DialTimeout dial timeout
|
// DialTimeout dial timeout
|
||||||
DialTimeout time.Duration
|
DialTimeout time.Duration
|
||||||
// Retries specifies retries num
|
// Retries specifies retries num
|
||||||
Retries int
|
Retries int
|
||||||
|
// ContextDialer used to connect
|
||||||
|
ContextDialer func(context.Context, string) (net.Conn, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ContextDialer pass ContextDialer to client
|
||||||
|
func ContextDialer(fn func(context.Context, string) (net.Conn, error)) Option {
|
||||||
|
return func(o *Options) {
|
||||||
|
o.ContextDialer = fn
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Context pass context to client
|
// Context pass context to client
|
||||||
@@ -413,6 +429,13 @@ func PublishContext(ctx context.Context) PublishOption {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// WithContextDialer pass ContextDialer to client call
|
||||||
|
func WithContextDialer(fn func(context.Context, string) (net.Conn, error)) CallOption {
|
||||||
|
return func(o *CallOptions) {
|
||||||
|
o.ContextDialer = fn
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// WithContentType specifies call content type
|
// WithContentType specifies call content type
|
||||||
func WithContentType(ct string) CallOption {
|
func WithContentType(ct string) CallOption {
|
||||||
return func(o *CallOptions) {
|
return func(o *CallOptions) {
|
||||||
@@ -458,6 +481,20 @@ func WithRetries(i int) CallOption {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// WithResponseMetadata is a CallOption which adds metadata.Metadata to Options.CallOptions
|
||||||
|
func WithResponseMetadata(md *metadata.Metadata) CallOption {
|
||||||
|
return func(o *CallOptions) {
|
||||||
|
o.ResponseMetadata = md
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithRequestMetadata is a CallOption which adds metadata.Metadata to Options.CallOptions
|
||||||
|
func WithRequestMetadata(md metadata.Metadata) CallOption {
|
||||||
|
return func(o *CallOptions) {
|
||||||
|
o.RequestMetadata = md
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// WithRequestTimeout is a CallOption which overrides that which
|
// WithRequestTimeout is a CallOption which overrides that which
|
||||||
// set in Options.CallOptions
|
// set in Options.CallOptions
|
||||||
func WithRequestTimeout(d time.Duration) CallOption {
|
func WithRequestTimeout(d time.Duration) CallOption {
|
||||||
|
@@ -19,18 +19,32 @@ func RetryNever(ctx context.Context, req Request, retryCount int, err error) (bo
|
|||||||
return false, nil
|
return false, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// RetryOnError retries a request on a 500 or timeout error
|
// RetryOnError retries a request on a 500 or 408 (timeout) error
|
||||||
func RetryOnError(_ context.Context, _ Request, _ int, err error) (bool, error) {
|
func RetryOnError(_ context.Context, _ Request, _ int, err error) (bool, error) {
|
||||||
if err == nil {
|
if err == nil {
|
||||||
return false, nil
|
return false, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
me := errors.FromError(err)
|
me := errors.FromError(err)
|
||||||
switch me.Code {
|
switch me.Code {
|
||||||
// retry on timeout or internal server error
|
// retry on timeout or internal server error
|
||||||
case 408, 500:
|
case 408, 500:
|
||||||
return true, nil
|
return true, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
return false, nil
|
return false, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// RetryOnErrors retries a request on specified error codes
|
||||||
|
func RetryOnErrors(codes ...int32) RetryFunc {
|
||||||
|
return func(_ context.Context, _ Request, _ int, err error) (bool, error) {
|
||||||
|
if err == nil {
|
||||||
|
return false, nil
|
||||||
|
}
|
||||||
|
me := errors.FromError(err)
|
||||||
|
for _, code := range codes {
|
||||||
|
if me.Code == code {
|
||||||
|
return true, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
70
client/retry_test.go
Normal file
70
client/retry_test.go
Normal file
@@ -0,0 +1,70 @@
|
|||||||
|
package client
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"go.unistack.org/micro/v3/errors"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestRetryAlways(t *testing.T) {
|
||||||
|
tests := []error{
|
||||||
|
nil,
|
||||||
|
errors.InternalServerError("test", "%s", "test"),
|
||||||
|
fmt.Errorf("test"),
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, e := range tests {
|
||||||
|
ok, er := RetryAlways(context.TODO(), nil, 1, e)
|
||||||
|
if !ok || er != nil {
|
||||||
|
t.Fatal("RetryAlways not works properly")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRetryNever(t *testing.T) {
|
||||||
|
tests := []error{
|
||||||
|
nil,
|
||||||
|
errors.InternalServerError("test", "%s", "test"),
|
||||||
|
fmt.Errorf("test"),
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, e := range tests {
|
||||||
|
ok, er := RetryNever(context.TODO(), nil, 1, e)
|
||||||
|
if ok || er != nil {
|
||||||
|
t.Fatal("RetryNever not works properly")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRetryOnError(t *testing.T) {
|
||||||
|
tests := []error{
|
||||||
|
fmt.Errorf("test"),
|
||||||
|
errors.NotFound("test", "%s", "test"),
|
||||||
|
errors.Timeout("test", "%s", "test"),
|
||||||
|
}
|
||||||
|
|
||||||
|
for i, e := range tests {
|
||||||
|
ok, er := RetryOnError(context.TODO(), nil, 1, e)
|
||||||
|
if i == 2 && (!ok || er != nil) {
|
||||||
|
t.Fatal("RetryOnError not works properly")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRetryOnErrors(t *testing.T) {
|
||||||
|
tests := []error{
|
||||||
|
fmt.Errorf("test"),
|
||||||
|
errors.NotFound("test", "%s", "test"),
|
||||||
|
errors.Timeout("test", "%s", "test"),
|
||||||
|
}
|
||||||
|
|
||||||
|
fn := RetryOnErrors(404)
|
||||||
|
for i, e := range tests {
|
||||||
|
ok, er := fn(context.TODO(), nil, 1, e)
|
||||||
|
if i == 1 && (!ok || er != nil) {
|
||||||
|
t.Fatal("RetryOnErrors not works properly")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
@@ -27,7 +27,7 @@ var (
|
|||||||
// DefaultMaxMsgSize specifies how much data codec can handle
|
// DefaultMaxMsgSize specifies how much data codec can handle
|
||||||
DefaultMaxMsgSize = 1024 * 1024 * 4 // 4Mb
|
DefaultMaxMsgSize = 1024 * 1024 * 4 // 4Mb
|
||||||
// DefaultCodec is the global default codec
|
// DefaultCodec is the global default codec
|
||||||
DefaultCodec Codec = NewCodec()
|
DefaultCodec = NewCodec()
|
||||||
// DefaultTagName specifies struct tag name to control codec Marshal/Unmarshal
|
// DefaultTagName specifies struct tag name to control codec Marshal/Unmarshal
|
||||||
DefaultTagName = "codec"
|
DefaultTagName = "codec"
|
||||||
)
|
)
|
||||||
@@ -84,3 +84,24 @@ func MarshalAppend(buf []byte, c Codec, v interface{}, opts ...Option) ([]byte,
|
|||||||
|
|
||||||
return append(buf, mbuf...), nil
|
return append(buf, mbuf...), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// RawMessage is a raw encoded JSON value.
|
||||||
|
// It implements Marshaler and Unmarshaler and can be used to delay decoding or precompute a encoding.
|
||||||
|
type RawMessage []byte
|
||||||
|
|
||||||
|
// MarshalJSON returns m as the JSON encoding of m.
|
||||||
|
func (m *RawMessage) MarshalJSON() ([]byte, error) {
|
||||||
|
if m == nil {
|
||||||
|
return []byte("null"), nil
|
||||||
|
}
|
||||||
|
return *m, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnmarshalJSON sets *m to a copy of data.
|
||||||
|
func (m *RawMessage) UnmarshalJSON(data []byte) error {
|
||||||
|
if m == nil {
|
||||||
|
return errors.New("RawMessage UnmarshalJSON on nil pointer")
|
||||||
|
}
|
||||||
|
*m = append((*m)[0:0], data...)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
35
codec/context_test.go
Normal file
35
codec/context_test.go
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
package codec
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestFromContext(t *testing.T) {
|
||||||
|
ctx := context.WithValue(context.TODO(), codecKey{}, NewCodec())
|
||||||
|
|
||||||
|
c, ok := FromContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("FromContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewContext(t *testing.T) {
|
||||||
|
ctx := NewContext(context.TODO(), NewCodec())
|
||||||
|
|
||||||
|
c, ok := FromContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("NewContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetOption(t *testing.T) {
|
||||||
|
type key struct{}
|
||||||
|
o := SetOption(key{}, "test")
|
||||||
|
opts := &Options{}
|
||||||
|
o(opts)
|
||||||
|
|
||||||
|
if v, ok := opts.Context.Value(key{}).(string); !ok || v == "" {
|
||||||
|
t.Fatal("SetOption not works")
|
||||||
|
}
|
||||||
|
}
|
@@ -106,6 +106,9 @@ func (c *noopCodec) Unmarshal(d []byte, v interface{}, opts ...Option) error {
|
|||||||
case *string:
|
case *string:
|
||||||
*ve = string(d)
|
*ve = string(d)
|
||||||
return nil
|
return nil
|
||||||
|
case []byte:
|
||||||
|
copy(ve, d)
|
||||||
|
return nil
|
||||||
case *[]byte:
|
case *[]byte:
|
||||||
*ve = d
|
*ve = d
|
||||||
return nil
|
return nil
|
||||||
|
@@ -5,7 +5,7 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestNoopBytes(t *testing.T) {
|
func TestNoopBytesPtr(t *testing.T) {
|
||||||
req := []byte("test req")
|
req := []byte("test req")
|
||||||
rsp := make([]byte, len(req))
|
rsp := make([]byte, len(req))
|
||||||
|
|
||||||
@@ -19,6 +19,20 @@ func TestNoopBytes(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestNoopBytes(t *testing.T) {
|
||||||
|
req := []byte("test req")
|
||||||
|
var rsp []byte
|
||||||
|
|
||||||
|
nc := NewCodec()
|
||||||
|
if err := nc.Unmarshal(req, &rsp); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !bytes.Equal(req, rsp) {
|
||||||
|
t.Fatalf("req not eq rsp: %s != %s", req, rsp)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestNoopString(t *testing.T) {
|
func TestNoopString(t *testing.T) {
|
||||||
req := []byte("test req")
|
req := []byte("test req")
|
||||||
var rsp string
|
var rsp string
|
||||||
|
153
config/config.go
153
config/config.go
@@ -4,11 +4,16 @@ package config // import "go.unistack.org/micro/v3/config"
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
|
"reflect"
|
||||||
"time"
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
type Validator interface {
|
||||||
|
Validate() error
|
||||||
|
}
|
||||||
|
|
||||||
// DefaultConfig default config
|
// DefaultConfig default config
|
||||||
var DefaultConfig Config = NewConfig()
|
var DefaultConfig = NewConfig()
|
||||||
|
|
||||||
// DefaultWatcherMinInterval default min interval for poll changes
|
// DefaultWatcherMinInterval default min interval for poll changes
|
||||||
var DefaultWatcherMinInterval = 5 * time.Second
|
var DefaultWatcherMinInterval = 5 * time.Second
|
||||||
@@ -67,33 +72,64 @@ func Load(ctx context.Context, cs []Config, opts ...LoadOption) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Validate runs Validate() error func for each struct field
|
||||||
|
func Validate(ctx context.Context, cfg interface{}) error {
|
||||||
|
if cfg == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if v, ok := cfg.(Validator); ok {
|
||||||
|
if err := v.Validate(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
sv := reflect.ValueOf(cfg)
|
||||||
|
if sv.Kind() == reflect.Ptr {
|
||||||
|
sv = sv.Elem()
|
||||||
|
}
|
||||||
|
if sv.Kind() != reflect.Struct {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
typ := sv.Type()
|
||||||
|
for idx := 0; idx < typ.NumField(); idx++ {
|
||||||
|
fld := typ.Field(idx)
|
||||||
|
val := sv.Field(idx)
|
||||||
|
if !val.IsValid() || len(fld.PkgPath) != 0 {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if v, ok := val.Interface().(Validator); ok {
|
||||||
|
if err := v.Validate(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
switch val.Kind() {
|
||||||
|
case reflect.Ptr:
|
||||||
|
if reflect.Indirect(val).Kind() == reflect.Struct {
|
||||||
|
if err := Validate(ctx, val.Interface()); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
case reflect.Struct:
|
||||||
|
if err := Validate(ctx, val.Interface()); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
var (
|
var (
|
||||||
DefaultAfterLoad = func(ctx context.Context, c Config) error {
|
// DefaultBeforeLoad default func that runs before config Load
|
||||||
for _, fn := range c.Options().AfterLoad {
|
|
||||||
if err := fn(ctx, c); err != nil {
|
|
||||||
c.Options().Logger.Errorf(ctx, "%s AfterLoad err: %v", c.String(), err)
|
|
||||||
if !c.Options().AllowFail {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
DefaultAfterSave = func(ctx context.Context, c Config) error {
|
|
||||||
for _, fn := range c.Options().AfterSave {
|
|
||||||
if err := fn(ctx, c); err != nil {
|
|
||||||
c.Options().Logger.Errorf(ctx, "%s AfterSave err: %v", c.String(), err)
|
|
||||||
if !c.Options().AllowFail {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
DefaultBeforeLoad = func(ctx context.Context, c Config) error {
|
DefaultBeforeLoad = func(ctx context.Context, c Config) error {
|
||||||
for _, fn := range c.Options().BeforeLoad {
|
for _, fn := range c.Options().BeforeLoad {
|
||||||
|
if fn == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
if err := fn(ctx, c); err != nil {
|
if err := fn(ctx, c); err != nil {
|
||||||
c.Options().Logger.Errorf(ctx, "%s BeforeLoad err: %v", c.String(), err)
|
c.Options().Logger.Errorf(ctx, "%s BeforeLoad err: %v", c.String(), err)
|
||||||
if !c.Options().AllowFail {
|
if !c.Options().AllowFail {
|
||||||
@@ -103,11 +139,74 @@ var (
|
|||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
// DefaultAfterLoad default func that runs after config Load
|
||||||
|
DefaultAfterLoad = func(ctx context.Context, c Config) error {
|
||||||
|
for _, fn := range c.Options().AfterLoad {
|
||||||
|
if fn == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if err := fn(ctx, c); err != nil {
|
||||||
|
c.Options().Logger.Errorf(ctx, "%s AfterLoad err: %v", c.String(), err)
|
||||||
|
if !c.Options().AllowFail {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
// DefaultBeforeSave default func that runs befora config Save
|
||||||
DefaultBeforeSave = func(ctx context.Context, c Config) error {
|
DefaultBeforeSave = func(ctx context.Context, c Config) error {
|
||||||
for _, fn := range c.Options().BeforeSave {
|
for _, fn := range c.Options().BeforeSave {
|
||||||
|
if fn == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
if err := fn(ctx, c); err != nil {
|
if err := fn(ctx, c); err != nil {
|
||||||
c.Options().Logger.Errorf(ctx, "%s BeforeSavec err: %v", c.String(), err)
|
c.Options().Logger.Errorf(ctx, "%s BeforeSave err: %v", c.String(), err)
|
||||||
|
if !c.Options().AllowFail {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
// DefaultAfterSave default func that runs after config Save
|
||||||
|
DefaultAfterSave = func(ctx context.Context, c Config) error {
|
||||||
|
for _, fn := range c.Options().AfterSave {
|
||||||
|
if fn == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if err := fn(ctx, c); err != nil {
|
||||||
|
c.Options().Logger.Errorf(ctx, "%s AfterSave err: %v", c.String(), err)
|
||||||
|
if !c.Options().AllowFail {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
// DefaultBeforeInit default func that runs befora config Init
|
||||||
|
DefaultBeforeInit = func(ctx context.Context, c Config) error {
|
||||||
|
for _, fn := range c.Options().BeforeInit {
|
||||||
|
if fn == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if err := fn(ctx, c); err != nil {
|
||||||
|
c.Options().Logger.Errorf(ctx, "%s BeforeInit err: %v", c.String(), err)
|
||||||
|
if !c.Options().AllowFail {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
// DefaultAfterInit default func that runs after config Init
|
||||||
|
DefaultAfterInit = func(ctx context.Context, c Config) error {
|
||||||
|
for _, fn := range c.Options().AfterSave {
|
||||||
|
if fn == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if err := fn(ctx, c); err != nil {
|
||||||
|
c.Options().Logger.Errorf(ctx, "%s AfterInit err: %v", c.String(), err)
|
||||||
if !c.Options().AllowFail {
|
if !c.Options().AllowFail {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
86
config/context_test.go
Normal file
86
config/context_test.go
Normal file
@@ -0,0 +1,86 @@
|
|||||||
|
package config
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestFromNilContext(t *testing.T) {
|
||||||
|
// nolint: staticcheck
|
||||||
|
c, ok := FromContext(nil)
|
||||||
|
if ok || c != nil {
|
||||||
|
t.Fatal("FromContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewNilContext(t *testing.T) {
|
||||||
|
// nolint: staticcheck
|
||||||
|
ctx := NewContext(nil, NewConfig())
|
||||||
|
|
||||||
|
c, ok := FromContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("NewContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFromContext(t *testing.T) {
|
||||||
|
ctx := context.WithValue(context.TODO(), configKey{}, NewConfig())
|
||||||
|
|
||||||
|
c, ok := FromContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("FromContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewContext(t *testing.T) {
|
||||||
|
ctx := NewContext(context.TODO(), NewConfig())
|
||||||
|
|
||||||
|
c, ok := FromContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("NewContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetOption(t *testing.T) {
|
||||||
|
type key struct{}
|
||||||
|
o := SetOption(key{}, "test")
|
||||||
|
opts := &Options{}
|
||||||
|
o(opts)
|
||||||
|
|
||||||
|
if v, ok := opts.Context.Value(key{}).(string); !ok || v == "" {
|
||||||
|
t.Fatal("SetOption not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetSaveOption(t *testing.T) {
|
||||||
|
type key struct{}
|
||||||
|
o := SetSaveOption(key{}, "test")
|
||||||
|
opts := &SaveOptions{}
|
||||||
|
o(opts)
|
||||||
|
|
||||||
|
if v, ok := opts.Context.Value(key{}).(string); !ok || v == "" {
|
||||||
|
t.Fatal("SetSaveOption not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetLoadOption(t *testing.T) {
|
||||||
|
type key struct{}
|
||||||
|
o := SetLoadOption(key{}, "test")
|
||||||
|
opts := &LoadOptions{}
|
||||||
|
o(opts)
|
||||||
|
|
||||||
|
if v, ok := opts.Context.Value(key{}).(string); !ok || v == "" {
|
||||||
|
t.Fatal("SetLoadOption not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetWatchOption(t *testing.T) {
|
||||||
|
type key struct{}
|
||||||
|
o := SetWatchOption(key{}, "test")
|
||||||
|
opts := &WatchOptions{}
|
||||||
|
o(opts)
|
||||||
|
|
||||||
|
if v, ok := opts.Context.Value(key{}).(string); !ok || v == "" {
|
||||||
|
t.Fatal("SetWatchOption not works")
|
||||||
|
}
|
||||||
|
}
|
@@ -5,9 +5,11 @@ import (
|
|||||||
"reflect"
|
"reflect"
|
||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
"github.com/imdario/mergo"
|
"github.com/imdario/mergo"
|
||||||
rutil "go.unistack.org/micro/v3/util/reflect"
|
rutil "go.unistack.org/micro/v3/util/reflect"
|
||||||
|
mtime "go.unistack.org/micro/v3/util/time"
|
||||||
)
|
)
|
||||||
|
|
||||||
type defaultConfig struct {
|
type defaultConfig struct {
|
||||||
@@ -22,11 +24,20 @@ func (c *defaultConfig) Init(opts ...Option) error {
|
|||||||
for _, o := range opts {
|
for _, o := range opts {
|
||||||
o(&c.opts)
|
o(&c.opts)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if err := DefaultBeforeInit(c.opts.Context, c); err != nil && !c.opts.AllowFail {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := DefaultAfterInit(c.opts.Context, c); err != nil && !c.opts.AllowFail {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c *defaultConfig) Load(ctx context.Context, opts ...LoadOption) error {
|
func (c *defaultConfig) Load(ctx context.Context, opts ...LoadOption) error {
|
||||||
if err := DefaultBeforeLoad(ctx, c); err != nil {
|
if err := DefaultBeforeLoad(ctx, c); err != nil && !c.opts.AllowFail {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -49,21 +60,20 @@ func (c *defaultConfig) Load(ctx context.Context, opts ...LoadOption) error {
|
|||||||
if !c.opts.AllowFail {
|
if !c.opts.AllowFail {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
return DefaultAfterLoad(ctx, c)
|
if err = DefaultAfterLoad(ctx, c); err != nil && !c.opts.AllowFail {
|
||||||
|
return err
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if err = fillValues(reflect.ValueOf(src), c.opts.StructTag); err == nil {
|
if err = fillValues(reflect.ValueOf(src), c.opts.StructTag); err == nil {
|
||||||
err = mergo.Merge(dst, src, mopts...)
|
err = mergo.Merge(dst, src, mopts...)
|
||||||
}
|
}
|
||||||
|
|
||||||
if err != nil {
|
if err != nil && !c.opts.AllowFail {
|
||||||
c.opts.Logger.Errorf(ctx, "default load error: %v", err)
|
return err
|
||||||
if !c.opts.AllowFail {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := DefaultAfterLoad(ctx, c); err != nil {
|
if err := DefaultAfterLoad(ctx, c); err != nil && !c.opts.AllowFail {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -75,6 +85,7 @@ func fillValue(value reflect.Value, val string) error {
|
|||||||
if !rutil.IsEmpty(value) {
|
if !rutil.IsEmpty(value) {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
switch value.Kind() {
|
switch value.Kind() {
|
||||||
case reflect.Map:
|
case reflect.Map:
|
||||||
t := value.Type()
|
t := value.Type()
|
||||||
@@ -151,11 +162,26 @@ func fillValue(value reflect.Value, val string) error {
|
|||||||
}
|
}
|
||||||
value.Set(reflect.ValueOf(int32(v)))
|
value.Set(reflect.ValueOf(int32(v)))
|
||||||
case reflect.Int64:
|
case reflect.Int64:
|
||||||
v, err := strconv.ParseInt(val, 10, 64)
|
switch {
|
||||||
if err != nil {
|
case value.Type().String() == "time.Duration" && value.Type().PkgPath() == "time":
|
||||||
return err
|
v, err := time.ParseDuration(val)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
value.Set(reflect.ValueOf(v))
|
||||||
|
case value.Type().String() == "time.Duration" && value.Type().PkgPath() == "go.unistack.org/micro/v3/util/time":
|
||||||
|
v, err := mtime.ParseDuration(val)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
value.SetInt(int64(v))
|
||||||
|
default:
|
||||||
|
v, err := strconv.ParseInt(val, 10, 64)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
value.Set(reflect.ValueOf(v))
|
||||||
}
|
}
|
||||||
value.Set(reflect.ValueOf(v))
|
|
||||||
case reflect.Uint:
|
case reflect.Uint:
|
||||||
v, err := strconv.ParseUint(val, 10, 0)
|
v, err := strconv.ParseUint(val, 10, 0)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
@@ -4,34 +4,54 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
"testing"
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
"go.unistack.org/micro/v3/config"
|
"go.unistack.org/micro/v3/config"
|
||||||
|
mtime "go.unistack.org/micro/v3/util/time"
|
||||||
)
|
)
|
||||||
|
|
||||||
type Cfg struct {
|
type cfg struct {
|
||||||
|
StringValue string `default:"string_value"`
|
||||||
|
IgnoreValue string `json:"-"`
|
||||||
|
StructValue *cfgStructValue
|
||||||
|
IntValue int `default:"99"`
|
||||||
|
DurationValue time.Duration `default:"10s"`
|
||||||
|
MDurationValue mtime.Duration `default:"10s"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type cfgStructValue struct {
|
||||||
StringValue string `default:"string_value"`
|
StringValue string `default:"string_value"`
|
||||||
IgnoreValue string `json:"-"`
|
}
|
||||||
StructValue struct {
|
|
||||||
StringValue string `default:"string_value"`
|
func (c *cfg) Validate() error {
|
||||||
|
if c.IntValue != 10 {
|
||||||
|
return fmt.Errorf("invalid IntValue %d != %d", 10, c.IntValue)
|
||||||
}
|
}
|
||||||
IntValue int `default:"99"`
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *cfgStructValue) Validate() error {
|
||||||
|
if c.StringValue != "string_value" {
|
||||||
|
return fmt.Errorf("invalid StringValue %s != %s", "string_value", c.StringValue)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestDefault(t *testing.T) {
|
func TestDefault(t *testing.T) {
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
conf := &Cfg{IntValue: 10}
|
conf := &cfg{IntValue: 10}
|
||||||
blfn := func(ctx context.Context, cfg config.Config) error {
|
blfn := func(_ context.Context, c config.Config) error {
|
||||||
nconf, ok := cfg.Options().Struct.(*Cfg)
|
nconf, ok := c.Options().Struct.(*cfg)
|
||||||
if !ok {
|
if !ok {
|
||||||
return fmt.Errorf("failed to get Struct from options: %v", cfg.Options())
|
return fmt.Errorf("failed to get Struct from options: %v", c.Options())
|
||||||
}
|
}
|
||||||
nconf.StringValue = "before_load"
|
nconf.StringValue = "before_load"
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
alfn := func(ctx context.Context, cfg config.Config) error {
|
alfn := func(_ context.Context, c config.Config) error {
|
||||||
nconf, ok := cfg.Options().Struct.(*Cfg)
|
nconf, ok := c.Options().Struct.(*cfg)
|
||||||
if !ok {
|
if !ok {
|
||||||
return fmt.Errorf("failed to get Struct from options: %v", cfg.Options())
|
return fmt.Errorf("failed to get Struct from options: %v", c.Options())
|
||||||
}
|
}
|
||||||
nconf.StringValue = "after_load"
|
nconf.StringValue = "after_load"
|
||||||
return nil
|
return nil
|
||||||
@@ -50,3 +70,19 @@ func TestDefault(t *testing.T) {
|
|||||||
_ = conf
|
_ = conf
|
||||||
// t.Logf("%#+v\n", conf)
|
// t.Logf("%#+v\n", conf)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestValidate(t *testing.T) {
|
||||||
|
ctx := context.Background()
|
||||||
|
conf := &cfg{IntValue: 10}
|
||||||
|
cfg := config.NewConfig(config.Struct(conf))
|
||||||
|
if err := cfg.Init(); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := cfg.Load(ctx); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := config.Validate(ctx, conf); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@@ -28,14 +28,18 @@ type Options struct {
|
|||||||
Name string
|
Name string
|
||||||
// StructTag name
|
// StructTag name
|
||||||
StructTag string
|
StructTag string
|
||||||
// BeforeSave contains slice of funcs that runs before save
|
// BeforeSave contains slice of funcs that runs before Save
|
||||||
BeforeSave []func(context.Context, Config) error
|
BeforeSave []func(context.Context, Config) error
|
||||||
// AfterLoad contains slice of funcs that runs after load
|
// AfterSave contains slice of funcs that runs after Save
|
||||||
AfterLoad []func(context.Context, Config) error
|
|
||||||
// BeforeLoad contains slice of funcs that runs before load
|
|
||||||
BeforeLoad []func(context.Context, Config) error
|
|
||||||
// AfterSave contains slice of funcs that runs after save
|
|
||||||
AfterSave []func(context.Context, Config) error
|
AfterSave []func(context.Context, Config) error
|
||||||
|
// BeforeLoad contains slice of funcs that runs before Load
|
||||||
|
BeforeLoad []func(context.Context, Config) error
|
||||||
|
// AfterLoad contains slice of funcs that runs after Load
|
||||||
|
AfterLoad []func(context.Context, Config) error
|
||||||
|
// BeforeInit contains slice of funcs that runs before Init
|
||||||
|
BeforeInit []func(context.Context, Config) error
|
||||||
|
// AfterInit contains slice of funcs that runs after Init
|
||||||
|
AfterInit []func(context.Context, Config) error
|
||||||
// AllowFail flag to allow fail in config source
|
// AllowFail flag to allow fail in config source
|
||||||
AllowFail bool
|
AllowFail bool
|
||||||
}
|
}
|
||||||
@@ -69,6 +73,7 @@ type LoadOptions struct {
|
|||||||
Context context.Context
|
Context context.Context
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// NewLoadOptions create LoadOptions struct with provided opts
|
||||||
func NewLoadOptions(opts ...LoadOption) LoadOptions {
|
func NewLoadOptions(opts ...LoadOption) LoadOptions {
|
||||||
options := LoadOptions{}
|
options := LoadOptions{}
|
||||||
for _, o := range opts {
|
for _, o := range opts {
|
||||||
@@ -130,6 +135,20 @@ func AllowFail(b bool) Option {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// BeforeInit run funcs before config Init
|
||||||
|
func BeforeInit(fn ...func(context.Context, Config) error) Option {
|
||||||
|
return func(o *Options) {
|
||||||
|
o.BeforeInit = fn
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// AfterInit run funcs after config Init
|
||||||
|
func AfterInit(fn ...func(context.Context, Config) error) Option {
|
||||||
|
return func(o *Options) {
|
||||||
|
o.AfterInit = fn
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// BeforeLoad run funcs before config load
|
// BeforeLoad run funcs before config load
|
||||||
func BeforeLoad(fn ...func(context.Context, Config) error) Option {
|
func BeforeLoad(fn ...func(context.Context, Config) error) Option {
|
||||||
return func(o *Options) {
|
return func(o *Options) {
|
||||||
@@ -221,8 +240,10 @@ type WatchOptions struct {
|
|||||||
Coalesce bool
|
Coalesce bool
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// WatchOption func signature
|
||||||
type WatchOption func(*WatchOptions)
|
type WatchOption func(*WatchOptions)
|
||||||
|
|
||||||
|
// NewWatchOptions create WatchOptions struct with provided opts
|
||||||
func NewWatchOptions(opts ...WatchOption) WatchOptions {
|
func NewWatchOptions(opts ...WatchOption) WatchOptions {
|
||||||
options := WatchOptions{
|
options := WatchOptions{
|
||||||
Context: context.Background(),
|
Context: context.Background(),
|
||||||
|
24
context_test.go
Normal file
24
context_test.go
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
package micro
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestFromContext(t *testing.T) {
|
||||||
|
ctx := context.WithValue(context.TODO(), serviceKey{}, NewService())
|
||||||
|
|
||||||
|
c, ok := FromContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("FromContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewContext(t *testing.T) {
|
||||||
|
ctx := NewContext(context.TODO(), NewService())
|
||||||
|
|
||||||
|
c, ok := FromContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("NewContext not works")
|
||||||
|
}
|
||||||
|
}
|
@@ -3,6 +3,7 @@
|
|||||||
package errors // import "go.unistack.org/micro/v3/errors"
|
package errors // import "go.unistack.org/micro/v3/errors"
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"bytes"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
"net/http"
|
"net/http"
|
||||||
@@ -232,6 +233,27 @@ func Equal(err1 error, err2 error) bool {
|
|||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// CodeIn return true if err has specified code
|
||||||
|
func CodeIn(err interface{}, codes ...int32) bool {
|
||||||
|
var code int32
|
||||||
|
switch verr := err.(type) {
|
||||||
|
case *Error:
|
||||||
|
code = verr.Code
|
||||||
|
case int32:
|
||||||
|
code = verr
|
||||||
|
default:
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, check := range codes {
|
||||||
|
if code == check {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
// FromError try to convert go error to *Error
|
// FromError try to convert go error to *Error
|
||||||
func FromError(err error) *Error {
|
func FromError(err error) *Error {
|
||||||
if verr, ok := err.(*Error); ok && verr != nil {
|
if verr, ok := err.(*Error); ok && verr != nil {
|
||||||
@@ -261,7 +283,7 @@ func (e *Error) Reset() {
|
|||||||
|
|
||||||
// String returns error as string
|
// String returns error as string
|
||||||
func (e *Error) String() string {
|
func (e *Error) String() string {
|
||||||
return fmt.Sprintf(`{"id":"%s","detail":"%s","status":"%s","code":%d}`, e.ID, e.Detail, e.Status, e.Code)
|
return fmt.Sprintf(`{"id":"%s","detail":"%s","status":"%s","code":%d}`, addslashes(e.ID), addslashes(e.Detail), addslashes(e.Status), e.Code)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Marshal returns error data
|
// Marshal returns error data
|
||||||
@@ -282,20 +304,20 @@ func (e *Error) Unmarshal(data []byte) error {
|
|||||||
nparts := strings.FieldsFunc(part, func(r rune) bool {
|
nparts := strings.FieldsFunc(part, func(r rune) bool {
|
||||||
return r == ':'
|
return r == ':'
|
||||||
})
|
})
|
||||||
for idx := 0; idx < len(nparts); idx++ {
|
for idx := 0; idx < len(nparts)/2; idx += 2 {
|
||||||
if len(nparts[idx+1]) < 3 {
|
val := strings.Trim(nparts[idx+1], `"`)
|
||||||
idx++
|
if len(val) == 0 {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
switch {
|
switch {
|
||||||
case nparts[idx] == `"id"`:
|
case nparts[idx] == `"id"`:
|
||||||
e.ID = nparts[idx+1][1 : len(nparts[idx+1])-1]
|
e.ID = val
|
||||||
case nparts[idx] == `"detail"`:
|
case nparts[idx] == `"detail"`:
|
||||||
e.Detail = nparts[idx+1][1 : len(nparts[idx+1])-1]
|
e.Detail = val
|
||||||
case nparts[idx] == `"status"`:
|
case nparts[idx] == `"status"`:
|
||||||
e.Status = nparts[idx+1][1 : len(nparts[idx+1])-1]
|
e.Status = val
|
||||||
case nparts[idx] == `"code"`:
|
case nparts[idx] == `"code"`:
|
||||||
c, err := strconv.ParseInt(nparts[idx+1], 10, 32)
|
c, err := strconv.ParseInt(val, 10, 32)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -306,3 +328,15 @@ func (e *Error) Unmarshal(data []byte) error {
|
|||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func addslashes(str string) string {
|
||||||
|
var buf bytes.Buffer
|
||||||
|
for _, char := range str {
|
||||||
|
switch char {
|
||||||
|
case '\'', '"', '\\':
|
||||||
|
buf.WriteRune('\\')
|
||||||
|
}
|
||||||
|
buf.WriteRune(char)
|
||||||
|
}
|
||||||
|
return buf.String()
|
||||||
|
}
|
||||||
|
@@ -1,12 +1,21 @@
|
|||||||
package errors
|
package errors
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"encoding/json"
|
||||||
er "errors"
|
er "errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"net/http"
|
"net/http"
|
||||||
"testing"
|
"testing"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
func TestMarshalJSON(t *testing.T) {
|
||||||
|
e := InternalServerError("id", "err: %v", fmt.Errorf("err: %v", `xxx: "UNIX_TIMESTAMP": invalid identifier`))
|
||||||
|
_, err := json.Marshal(e)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestEmpty(t *testing.T) {
|
func TestEmpty(t *testing.T) {
|
||||||
msg := "test"
|
msg := "test"
|
||||||
var err *Error
|
var err *Error
|
||||||
@@ -87,3 +96,19 @@ func TestErrors(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestCodeIn(t *testing.T) {
|
||||||
|
err := InternalServerError("id", "%s", "msg")
|
||||||
|
|
||||||
|
if ok := CodeIn(err, 400, 500); !ok {
|
||||||
|
t.Fatalf("CodeIn not works: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if ok := CodeIn(err.(*Error).Code, 500); !ok {
|
||||||
|
t.Fatalf("CodeIn not works: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if ok := CodeIn(err, 100); ok {
|
||||||
|
t.Fatalf("CodeIn not works: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
53
flow/context_test.go
Normal file
53
flow/context_test.go
Normal file
@@ -0,0 +1,53 @@
|
|||||||
|
package flow
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestFromNilContext(t *testing.T) {
|
||||||
|
// nolint: staticcheck
|
||||||
|
c, ok := FromContext(nil)
|
||||||
|
if ok || c != nil {
|
||||||
|
t.Fatal("FromContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewNilContext(t *testing.T) {
|
||||||
|
// nolint: staticcheck
|
||||||
|
ctx := NewContext(nil, NewFlow())
|
||||||
|
|
||||||
|
c, ok := FromContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("NewContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFromContext(t *testing.T) {
|
||||||
|
ctx := context.WithValue(context.TODO(), flowKey{}, NewFlow())
|
||||||
|
|
||||||
|
c, ok := FromContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("FromContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewContext(t *testing.T) {
|
||||||
|
ctx := NewContext(context.TODO(), NewFlow())
|
||||||
|
|
||||||
|
c, ok := FromContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("NewContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetOption(t *testing.T) {
|
||||||
|
type key struct{}
|
||||||
|
o := SetOption(key{}, "test")
|
||||||
|
opts := &Options{}
|
||||||
|
o(opts)
|
||||||
|
|
||||||
|
if v, ok := opts.Context.Value(key{}).(string); !ok || v == "" {
|
||||||
|
t.Fatal("SetOption not works")
|
||||||
|
}
|
||||||
|
}
|
@@ -7,6 +7,56 @@ import (
|
|||||||
"github.com/silas/dag"
|
"github.com/silas/dag"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
func TestDeps(t *testing.T) {
|
||||||
|
t.Skip()
|
||||||
|
d := &dag.AcyclicGraph{}
|
||||||
|
|
||||||
|
v0 := d.Add(&node{"v0"})
|
||||||
|
v1 := d.Add(&node{"v1"})
|
||||||
|
v2 := d.Add(&node{"v2"})
|
||||||
|
v3 := d.Add(&node{"v3"})
|
||||||
|
v4 := d.Add(&node{"v4"})
|
||||||
|
|
||||||
|
d.Connect(dag.BasicEdge(v0, v1))
|
||||||
|
d.Connect(dag.BasicEdge(v1, v2))
|
||||||
|
d.Connect(dag.BasicEdge(v2, v4))
|
||||||
|
d.Connect(dag.BasicEdge(v0, v3))
|
||||||
|
d.Connect(dag.BasicEdge(v3, v4))
|
||||||
|
|
||||||
|
if err := d.Validate(); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
d.TransitiveReduction()
|
||||||
|
|
||||||
|
var steps [][]string
|
||||||
|
fn := func(n dag.Vertex, idx int) error {
|
||||||
|
if idx == 0 {
|
||||||
|
steps = make([][]string, 1)
|
||||||
|
steps[0] = make([]string, 0, 1)
|
||||||
|
} else if idx >= len(steps) {
|
||||||
|
tsteps := make([][]string, idx+1)
|
||||||
|
copy(tsteps, steps)
|
||||||
|
steps = tsteps
|
||||||
|
steps[idx] = make([]string, 0, 1)
|
||||||
|
}
|
||||||
|
steps[idx] = append(steps[idx], fmt.Sprintf("%s", n))
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
start := &node{"v0"}
|
||||||
|
err := d.SortedDepthFirstWalk([]dag.Vertex{start}, fn)
|
||||||
|
checkErr(t, err)
|
||||||
|
|
||||||
|
for idx, steps := range steps {
|
||||||
|
fmt.Printf("level %d steps %#+v\n", idx, steps)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(steps[2]) != 1 {
|
||||||
|
t.Logf("invalid steps %#+v", steps[2])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func checkErr(t *testing.T, err error) {
|
func checkErr(t *testing.T, err error) {
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
|
@@ -3,7 +3,6 @@ package flow
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
"path/filepath"
|
|
||||||
"sync"
|
"sync"
|
||||||
|
|
||||||
"github.com/silas/dag"
|
"github.com/silas/dag"
|
||||||
@@ -150,17 +149,17 @@ func (w *microWorkflow) getSteps(start string, reverse bool) ([][]Step, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (w *microWorkflow) Abort(ctx context.Context, id string) error {
|
func (w *microWorkflow) Abort(ctx context.Context, id string) error {
|
||||||
workflowStore := store.NewNamespaceStore(w.opts.Store, filepath.Join("workflows", id))
|
workflowStore := store.NewNamespaceStore(w.opts.Store, "workflows"+w.opts.Store.Options().Separator+id)
|
||||||
return workflowStore.Write(ctx, "status", &codec.Frame{Data: []byte(StatusAborted.String())})
|
return workflowStore.Write(ctx, "status", &codec.Frame{Data: []byte(StatusAborted.String())})
|
||||||
}
|
}
|
||||||
|
|
||||||
func (w *microWorkflow) Suspend(ctx context.Context, id string) error {
|
func (w *microWorkflow) Suspend(ctx context.Context, id string) error {
|
||||||
workflowStore := store.NewNamespaceStore(w.opts.Store, filepath.Join("workflows", id))
|
workflowStore := store.NewNamespaceStore(w.opts.Store, "workflows"+w.opts.Store.Options().Separator+id)
|
||||||
return workflowStore.Write(ctx, "status", &codec.Frame{Data: []byte(StatusSuspend.String())})
|
return workflowStore.Write(ctx, "status", &codec.Frame{Data: []byte(StatusSuspend.String())})
|
||||||
}
|
}
|
||||||
|
|
||||||
func (w *microWorkflow) Resume(ctx context.Context, id string) error {
|
func (w *microWorkflow) Resume(ctx context.Context, id string) error {
|
||||||
workflowStore := store.NewNamespaceStore(w.opts.Store, filepath.Join("workflows", id))
|
workflowStore := store.NewNamespaceStore(w.opts.Store, "workflows"+w.opts.Store.Options().Separator+id)
|
||||||
return workflowStore.Write(ctx, "status", &codec.Frame{Data: []byte(StatusRunning.String())})
|
return workflowStore.Write(ctx, "status", &codec.Frame{Data: []byte(StatusRunning.String())})
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -181,8 +180,8 @@ func (w *microWorkflow) Execute(ctx context.Context, req *Message, opts ...Execu
|
|||||||
return "", err
|
return "", err
|
||||||
}
|
}
|
||||||
|
|
||||||
stepStore := store.NewNamespaceStore(w.opts.Store, filepath.Join("steps", eid))
|
stepStore := store.NewNamespaceStore(w.opts.Store, "steps"+w.opts.Store.Options().Separator+eid)
|
||||||
workflowStore := store.NewNamespaceStore(w.opts.Store, filepath.Join("workflows", eid))
|
workflowStore := store.NewNamespaceStore(w.opts.Store, "workflows"+w.opts.Store.Options().Separator+eid)
|
||||||
|
|
||||||
options := NewExecuteOptions(opts...)
|
options := NewExecuteOptions(opts...)
|
||||||
|
|
||||||
@@ -219,7 +218,7 @@ func (w *microWorkflow) Execute(ctx context.Context, req *Message, opts ...Execu
|
|||||||
for idx := range steps {
|
for idx := range steps {
|
||||||
for nidx := range steps[idx] {
|
for nidx := range steps[idx] {
|
||||||
cstep := steps[idx][nidx]
|
cstep := steps[idx][nidx]
|
||||||
if werr := stepStore.Write(ctx, filepath.Join(cstep.ID(), "status"), &codec.Frame{Data: []byte(StatusPending.String())}); werr != nil {
|
if werr := stepStore.Write(ctx, cstep.ID()+w.opts.Store.Options().Separator+"status", &codec.Frame{Data: []byte(StatusPending.String())}); werr != nil {
|
||||||
return eid, werr
|
return eid, werr
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -246,32 +245,32 @@ func (w *microWorkflow) Execute(ctx context.Context, req *Message, opts ...Execu
|
|||||||
wg.Add(1)
|
wg.Add(1)
|
||||||
go func(step Step) {
|
go func(step Step) {
|
||||||
defer wg.Done()
|
defer wg.Done()
|
||||||
if werr := stepStore.Write(ctx, filepath.Join(step.ID(), "req"), req); werr != nil {
|
if werr := stepStore.Write(ctx, step.ID()+w.opts.Store.Options().Separator+"req", req); werr != nil {
|
||||||
cherr <- werr
|
cherr <- werr
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if werr := stepStore.Write(ctx, filepath.Join(step.ID(), "status"), &codec.Frame{Data: []byte(StatusRunning.String())}); werr != nil {
|
if werr := stepStore.Write(ctx, step.ID()+w.opts.Store.Options().Separator+"status", &codec.Frame{Data: []byte(StatusRunning.String())}); werr != nil {
|
||||||
cherr <- werr
|
cherr <- werr
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
rsp, serr := step.Execute(nctx, req, nopts...)
|
rsp, serr := step.Execute(nctx, req, nopts...)
|
||||||
if serr != nil {
|
if serr != nil {
|
||||||
step.SetStatus(StatusFailure)
|
step.SetStatus(StatusFailure)
|
||||||
if werr := stepStore.Write(ctx, filepath.Join(step.ID(), "rsp"), serr); werr != nil && w.opts.Logger.V(logger.ErrorLevel) {
|
if werr := stepStore.Write(ctx, step.ID()+w.opts.Store.Options().Separator+"rsp", serr); werr != nil && w.opts.Logger.V(logger.ErrorLevel) {
|
||||||
w.opts.Logger.Errorf(ctx, "store write error: %v", werr)
|
w.opts.Logger.Errorf(ctx, "store write error: %v", werr)
|
||||||
}
|
}
|
||||||
if werr := stepStore.Write(ctx, filepath.Join(step.ID(), "status"), &codec.Frame{Data: []byte(StatusFailure.String())}); werr != nil && w.opts.Logger.V(logger.ErrorLevel) {
|
if werr := stepStore.Write(ctx, step.ID()+w.opts.Store.Options().Separator+"status", &codec.Frame{Data: []byte(StatusFailure.String())}); werr != nil && w.opts.Logger.V(logger.ErrorLevel) {
|
||||||
w.opts.Logger.Errorf(ctx, "store write error: %v", werr)
|
w.opts.Logger.Errorf(ctx, "store write error: %v", werr)
|
||||||
}
|
}
|
||||||
cherr <- serr
|
cherr <- serr
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if werr := stepStore.Write(ctx, filepath.Join(step.ID(), "rsp"), rsp); werr != nil {
|
if werr := stepStore.Write(ctx, step.ID()+w.opts.Store.Options().Separator+"rsp", rsp); werr != nil {
|
||||||
w.opts.Logger.Errorf(ctx, "store write error: %v", werr)
|
w.opts.Logger.Errorf(ctx, "store write error: %v", werr)
|
||||||
cherr <- werr
|
cherr <- werr
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if werr := stepStore.Write(ctx, filepath.Join(step.ID(), "status"), &codec.Frame{Data: []byte(StatusSuccess.String())}); werr != nil {
|
if werr := stepStore.Write(ctx, step.ID()+w.opts.Store.Options().Separator+"status", &codec.Frame{Data: []byte(StatusSuccess.String())}); werr != nil {
|
||||||
w.opts.Logger.Errorf(ctx, "store write error: %v", werr)
|
w.opts.Logger.Errorf(ctx, "store write error: %v", werr)
|
||||||
cherr <- werr
|
cherr <- werr
|
||||||
return
|
return
|
||||||
@@ -279,32 +278,32 @@ func (w *microWorkflow) Execute(ctx context.Context, req *Message, opts ...Execu
|
|||||||
}(cstep)
|
}(cstep)
|
||||||
wg.Wait()
|
wg.Wait()
|
||||||
} else {
|
} else {
|
||||||
if werr := stepStore.Write(ctx, filepath.Join(cstep.ID(), "req"), req); werr != nil {
|
if werr := stepStore.Write(ctx, cstep.ID()+w.opts.Store.Options().Separator+"req", req); werr != nil {
|
||||||
cherr <- werr
|
cherr <- werr
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if werr := stepStore.Write(ctx, filepath.Join(cstep.ID(), "status"), &codec.Frame{Data: []byte(StatusRunning.String())}); werr != nil {
|
if werr := stepStore.Write(ctx, cstep.ID()+w.opts.Store.Options().Separator+"status", &codec.Frame{Data: []byte(StatusRunning.String())}); werr != nil {
|
||||||
cherr <- werr
|
cherr <- werr
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
rsp, serr := cstep.Execute(nctx, req, nopts...)
|
rsp, serr := cstep.Execute(nctx, req, nopts...)
|
||||||
if serr != nil {
|
if serr != nil {
|
||||||
cstep.SetStatus(StatusFailure)
|
cstep.SetStatus(StatusFailure)
|
||||||
if werr := stepStore.Write(ctx, filepath.Join(cstep.ID(), "rsp"), serr); werr != nil && w.opts.Logger.V(logger.ErrorLevel) {
|
if werr := stepStore.Write(ctx, cstep.ID()+w.opts.Store.Options().Separator+"rsp", serr); werr != nil && w.opts.Logger.V(logger.ErrorLevel) {
|
||||||
w.opts.Logger.Errorf(ctx, "store write error: %v", werr)
|
w.opts.Logger.Errorf(ctx, "store write error: %v", werr)
|
||||||
}
|
}
|
||||||
if werr := stepStore.Write(ctx, filepath.Join(cstep.ID(), "status"), &codec.Frame{Data: []byte(StatusFailure.String())}); werr != nil && w.opts.Logger.V(logger.ErrorLevel) {
|
if werr := stepStore.Write(ctx, cstep.ID()+w.opts.Store.Options().Separator+"status", &codec.Frame{Data: []byte(StatusFailure.String())}); werr != nil && w.opts.Logger.V(logger.ErrorLevel) {
|
||||||
w.opts.Logger.Errorf(ctx, "store write error: %v", werr)
|
w.opts.Logger.Errorf(ctx, "store write error: %v", werr)
|
||||||
}
|
}
|
||||||
cherr <- serr
|
cherr <- serr
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if werr := stepStore.Write(ctx, filepath.Join(cstep.ID(), "rsp"), rsp); werr != nil {
|
if werr := stepStore.Write(ctx, cstep.ID()+w.opts.Store.Options().Separator+"rsp", rsp); werr != nil {
|
||||||
w.opts.Logger.Errorf(ctx, "store write error: %v", werr)
|
w.opts.Logger.Errorf(ctx, "store write error: %v", werr)
|
||||||
cherr <- werr
|
cherr <- werr
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if werr := stepStore.Write(ctx, filepath.Join(cstep.ID(), "status"), &codec.Frame{Data: []byte(StatusSuccess.String())}); werr != nil {
|
if werr := stepStore.Write(ctx, cstep.ID()+w.opts.Store.Options().Separator+"status", &codec.Frame{Data: []byte(StatusSuccess.String())}); werr != nil {
|
||||||
cherr <- werr
|
cherr <- werr
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
13
flow/flow.go
13
flow/flow.go
@@ -11,7 +11,9 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
|
// ErrStepNotExists returns when step not found
|
||||||
ErrStepNotExists = errors.New("step not exists")
|
ErrStepNotExists = errors.New("step not exists")
|
||||||
|
// ErrMissingClient returns when client.Client is missing
|
||||||
ErrMissingClient = errors.New("client not set")
|
ErrMissingClient = errors.New("client not set")
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -36,6 +38,7 @@ func (m *RawMessage) UnmarshalJSON(data []byte) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Message used to transfer data between steps
|
||||||
type Message struct {
|
type Message struct {
|
||||||
Header metadata.Metadata
|
Header metadata.Metadata
|
||||||
Body RawMessage
|
Body RawMessage
|
||||||
@@ -67,6 +70,7 @@ type Step interface {
|
|||||||
Response() *Message
|
Response() *Message
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Status contains step current status
|
||||||
type Status int
|
type Status int
|
||||||
|
|
||||||
func (status Status) String() string {
|
func (status Status) String() string {
|
||||||
@@ -74,15 +78,22 @@ func (status Status) String() string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
const (
|
const (
|
||||||
|
// StatusPending step waiting to start
|
||||||
StatusPending Status = iota
|
StatusPending Status = iota
|
||||||
|
// StatusRunning step is running
|
||||||
StatusRunning
|
StatusRunning
|
||||||
|
// StatusFailure step competed with error
|
||||||
StatusFailure
|
StatusFailure
|
||||||
|
// StatusSuccess step completed without error
|
||||||
StatusSuccess
|
StatusSuccess
|
||||||
|
// StatusAborted step aborted while it running
|
||||||
StatusAborted
|
StatusAborted
|
||||||
|
// StatusSuspend step suspended
|
||||||
StatusSuspend
|
StatusSuspend
|
||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
|
// StatusString contains map status => string
|
||||||
StatusString = map[Status]string{
|
StatusString = map[Status]string{
|
||||||
StatusPending: "StatusPending",
|
StatusPending: "StatusPending",
|
||||||
StatusRunning: "StatusRunning",
|
StatusRunning: "StatusRunning",
|
||||||
@@ -91,6 +102,7 @@ var (
|
|||||||
StatusAborted: "StatusAborted",
|
StatusAborted: "StatusAborted",
|
||||||
StatusSuspend: "StatusSuspend",
|
StatusSuspend: "StatusSuspend",
|
||||||
}
|
}
|
||||||
|
// StringStatus contains map string => status
|
||||||
StringStatus = map[string]Status{
|
StringStatus = map[string]Status{
|
||||||
"StatusPending": StatusPending,
|
"StatusPending": StatusPending,
|
||||||
"StatusRunning": StatusRunning,
|
"StatusRunning": StatusRunning,
|
||||||
@@ -144,6 +156,7 @@ var (
|
|||||||
atomicSteps atomic.Value
|
atomicSteps atomic.Value
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// RegisterStep register own step with workflow
|
||||||
func RegisterStep(step Step) {
|
func RegisterStep(step Step) {
|
||||||
flowMu.Lock()
|
flowMu.Lock()
|
||||||
steps, _ := atomicSteps.Load().([]Step)
|
steps, _ := atomicSteps.Load().([]Step)
|
||||||
|
@@ -91,7 +91,7 @@ func Store(s store.Store) Option {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// WorflowOption func signature
|
// WorkflowOption func signature
|
||||||
type WorkflowOption func(*WorkflowOptions)
|
type WorkflowOption func(*WorkflowOptions)
|
||||||
|
|
||||||
// WorkflowOptions holds workflow options
|
// WorkflowOptions holds workflow options
|
||||||
|
126
fsm/default.go
Normal file
126
fsm/default.go
Normal file
@@ -0,0 +1,126 @@
|
|||||||
|
package fsm
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"sync"
|
||||||
|
)
|
||||||
|
|
||||||
|
type state struct {
|
||||||
|
body interface{}
|
||||||
|
name string
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ State = &state{}
|
||||||
|
|
||||||
|
func (s *state) Name() string {
|
||||||
|
return s.name
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *state) Body() interface{} {
|
||||||
|
return s.body
|
||||||
|
}
|
||||||
|
|
||||||
|
// fsm is a finite state machine
|
||||||
|
type fsm struct {
|
||||||
|
statesMap map[string]StateFunc
|
||||||
|
current string
|
||||||
|
statesOrder []string
|
||||||
|
opts Options
|
||||||
|
mu sync.Mutex
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewFSM creates a new finite state machine having the specified initial state
|
||||||
|
// with specified options
|
||||||
|
func NewFSM(opts ...Option) *fsm {
|
||||||
|
return &fsm{
|
||||||
|
statesMap: map[string]StateFunc{},
|
||||||
|
opts: NewOptions(opts...),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Current returns the current state
|
||||||
|
func (f *fsm) Current() string {
|
||||||
|
f.mu.Lock()
|
||||||
|
s := f.current
|
||||||
|
f.mu.Unlock()
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
// Current returns the current state
|
||||||
|
func (f *fsm) Reset() {
|
||||||
|
f.mu.Lock()
|
||||||
|
f.current = f.opts.Initial
|
||||||
|
f.mu.Unlock()
|
||||||
|
}
|
||||||
|
|
||||||
|
// State adds state to fsm
|
||||||
|
func (f *fsm) State(state string, fn StateFunc) {
|
||||||
|
f.mu.Lock()
|
||||||
|
f.statesMap[state] = fn
|
||||||
|
f.statesOrder = append(f.statesOrder, state)
|
||||||
|
f.mu.Unlock()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Start runs state machine with provided data
|
||||||
|
func (f *fsm) Start(ctx context.Context, args interface{}, opts ...Option) (interface{}, error) {
|
||||||
|
var err error
|
||||||
|
|
||||||
|
f.mu.Lock()
|
||||||
|
options := f.opts
|
||||||
|
|
||||||
|
for _, opt := range opts {
|
||||||
|
opt(&options)
|
||||||
|
}
|
||||||
|
|
||||||
|
sopts := []StateOption{StateDryRun(options.DryRun)}
|
||||||
|
|
||||||
|
cstate := options.Initial
|
||||||
|
states := make(map[string]StateFunc, len(f.statesMap))
|
||||||
|
for k, v := range f.statesMap {
|
||||||
|
states[k] = v
|
||||||
|
}
|
||||||
|
f.current = cstate
|
||||||
|
f.mu.Unlock()
|
||||||
|
|
||||||
|
var s State
|
||||||
|
s = &state{name: cstate, body: args}
|
||||||
|
nstate := s.Name()
|
||||||
|
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return nil, ctx.Err()
|
||||||
|
default:
|
||||||
|
fn, ok := states[nstate]
|
||||||
|
if !ok {
|
||||||
|
return nil, fmt.Errorf(`state "%s" %w`, nstate, ErrInvalidState)
|
||||||
|
}
|
||||||
|
f.mu.Lock()
|
||||||
|
f.current = nstate
|
||||||
|
f.mu.Unlock()
|
||||||
|
|
||||||
|
// wrap the handler func
|
||||||
|
for i := len(options.Wrappers); i > 0; i-- {
|
||||||
|
fn = options.Wrappers[i-1](fn)
|
||||||
|
}
|
||||||
|
|
||||||
|
s, err = fn(ctx, s, sopts...)
|
||||||
|
|
||||||
|
switch {
|
||||||
|
case err != nil:
|
||||||
|
return s.Body(), err
|
||||||
|
case s.Name() == StateEnd:
|
||||||
|
return s.Body(), nil
|
||||||
|
case s.Name() == "":
|
||||||
|
for idx := range f.statesOrder {
|
||||||
|
if f.statesOrder[idx] == nstate && len(f.statesOrder) > idx+1 {
|
||||||
|
nstate = f.statesOrder[idx+1]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
nstate = s.Name()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
29
fsm/fsm.go
Normal file
29
fsm/fsm.go
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
package fsm // import "go.unistack.org/micro/v3/fsm"
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
ErrInvalidState = errors.New("does not exists")
|
||||||
|
StateEnd = "end"
|
||||||
|
)
|
||||||
|
|
||||||
|
type State interface {
|
||||||
|
Name() string
|
||||||
|
Body() interface{}
|
||||||
|
}
|
||||||
|
|
||||||
|
// StateWrapper wraps the StateFunc and returns the equivalent
|
||||||
|
type StateWrapper func(StateFunc) StateFunc
|
||||||
|
|
||||||
|
// StateFunc called on state transition and return next step and error
|
||||||
|
type StateFunc func(ctx context.Context, state State, opts ...StateOption) (State, error)
|
||||||
|
|
||||||
|
type FSM interface {
|
||||||
|
Start(context.Context, interface{}, ...Option) (interface{}, error)
|
||||||
|
Current() string
|
||||||
|
Reset()
|
||||||
|
State(string, StateFunc)
|
||||||
|
}
|
72
fsm/fsm_test.go
Normal file
72
fsm/fsm_test.go
Normal file
@@ -0,0 +1,72 @@
|
|||||||
|
package fsm
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"go.unistack.org/micro/v3/logger"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestFSMStart(t *testing.T) {
|
||||||
|
ctx := context.TODO()
|
||||||
|
|
||||||
|
if err := logger.DefaultLogger.Init(); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
wrapper := func(next StateFunc) StateFunc {
|
||||||
|
return func(sctx context.Context, s State, opts ...StateOption) (State, error) {
|
||||||
|
sctx = logger.NewContext(sctx, logger.Fields("state", s.Name()))
|
||||||
|
return next(sctx, s, opts...)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
f := NewFSM(InitialState("1"), WrapState(wrapper))
|
||||||
|
f1 := func(sctx context.Context, s State, opts ...StateOption) (State, error) {
|
||||||
|
_, ok := logger.FromContext(sctx)
|
||||||
|
if !ok {
|
||||||
|
t.Fatal("f1 context does not have logger")
|
||||||
|
}
|
||||||
|
args := s.Body().(map[string]interface{})
|
||||||
|
if v, ok := args["request"].(string); !ok || v == "" {
|
||||||
|
return nil, fmt.Errorf("empty request")
|
||||||
|
}
|
||||||
|
return &state{name: "", body: map[string]interface{}{"response": "state1"}}, nil
|
||||||
|
}
|
||||||
|
f2 := func(sctx context.Context, s State, opts ...StateOption) (State, error) {
|
||||||
|
_, ok := logger.FromContext(sctx)
|
||||||
|
if !ok {
|
||||||
|
t.Fatal("f2 context does not have logger")
|
||||||
|
}
|
||||||
|
args := s.Body().(map[string]interface{})
|
||||||
|
if v, ok := args["response"].(string); !ok || v == "" {
|
||||||
|
return nil, fmt.Errorf("empty response")
|
||||||
|
}
|
||||||
|
return &state{name: "", body: map[string]interface{}{"response": "state2"}}, nil
|
||||||
|
}
|
||||||
|
f3 := func(sctx context.Context, s State, opts ...StateOption) (State, error) {
|
||||||
|
_, ok := logger.FromContext(sctx)
|
||||||
|
if !ok {
|
||||||
|
t.Fatal("f3 context does not have logger")
|
||||||
|
}
|
||||||
|
args := s.Body().(map[string]interface{})
|
||||||
|
if v, ok := args["response"].(string); !ok || v == "" {
|
||||||
|
return nil, fmt.Errorf("empty response")
|
||||||
|
}
|
||||||
|
return &state{name: StateEnd, body: map[string]interface{}{"response": "state3"}}, nil
|
||||||
|
}
|
||||||
|
f.State("1", f1)
|
||||||
|
f.State("2", f2)
|
||||||
|
f.State("3", f3)
|
||||||
|
rsp, err := f.Start(ctx, map[string]interface{}{"request": "state"})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
args := rsp.(map[string]interface{})
|
||||||
|
if v, ok := args["response"].(string); !ok || v == "" {
|
||||||
|
t.Fatalf("nil rsp: %#+v", args)
|
||||||
|
} else if v != "state3" {
|
||||||
|
t.Fatalf("invalid rsp %#+v", args)
|
||||||
|
}
|
||||||
|
}
|
52
fsm/options.go
Normal file
52
fsm/options.go
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
package fsm
|
||||||
|
|
||||||
|
// Options struct holding fsm options
|
||||||
|
type Options struct {
|
||||||
|
// Initial state
|
||||||
|
Initial string
|
||||||
|
// Wrappers runs before state
|
||||||
|
Wrappers []StateWrapper
|
||||||
|
// DryRun mode
|
||||||
|
DryRun bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// Option func signature
|
||||||
|
type Option func(*Options)
|
||||||
|
|
||||||
|
// StateOptions holds state options
|
||||||
|
type StateOptions struct {
|
||||||
|
DryRun bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// StateDryRun says that state executes in dry run mode
|
||||||
|
func StateDryRun(b bool) StateOption {
|
||||||
|
return func(o *StateOptions) {
|
||||||
|
o.DryRun = b
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// StateOption func signature
|
||||||
|
type StateOption func(*StateOptions)
|
||||||
|
|
||||||
|
// InitialState sets init state for state machine
|
||||||
|
func InitialState(initial string) Option {
|
||||||
|
return func(o *Options) {
|
||||||
|
o.Initial = initial
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// WrapState adds a state Wrapper to a list of options passed into the fsm
|
||||||
|
func WrapState(w StateWrapper) Option {
|
||||||
|
return func(o *Options) {
|
||||||
|
o.Wrappers = append(o.Wrappers, w)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewOptions returns new Options struct filled by passed Option
|
||||||
|
func NewOptions(opts ...Option) Options {
|
||||||
|
options := Options{}
|
||||||
|
for _, o := range opts {
|
||||||
|
o(&options)
|
||||||
|
}
|
||||||
|
return options
|
||||||
|
}
|
101
function.go
101
function.go
@@ -1,101 +0,0 @@
|
|||||||
//go:build ignore
|
|
||||||
// +build ignore
|
|
||||||
|
|
||||||
package micro
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"go.unistack.org/micro/v3/server"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Function is a one time executing Service
|
|
||||||
type Function interface {
|
|
||||||
// Inherits Service interface
|
|
||||||
Service
|
|
||||||
// Done signals to complete execution
|
|
||||||
Done() error
|
|
||||||
// Handle registers an RPC handler
|
|
||||||
Handle(v interface{}) error
|
|
||||||
// Subscribe registers a subscriber
|
|
||||||
Subscribe(topic string, v interface{}) error
|
|
||||||
}
|
|
||||||
|
|
||||||
type function struct {
|
|
||||||
cancel context.CancelFunc
|
|
||||||
Service
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewFunction returns a new Function for a one time executing Service
|
|
||||||
func NewFunction(opts ...Option) Function {
|
|
||||||
return newFunction(opts...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func fnHandlerWrapper(f Function) server.HandlerWrapper {
|
|
||||||
return func(h server.HandlerFunc) server.HandlerFunc {
|
|
||||||
return func(ctx context.Context, req server.Request, rsp interface{}) error {
|
|
||||||
defer f.Done()
|
|
||||||
return h(ctx, req, rsp)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func fnSubWrapper(f Function) server.SubscriberWrapper {
|
|
||||||
return func(s server.SubscriberFunc) server.SubscriberFunc {
|
|
||||||
return func(ctx context.Context, msg server.Message) error {
|
|
||||||
defer f.Done()
|
|
||||||
return s(ctx, msg)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func newFunction(opts ...Option) Function {
|
|
||||||
ctx, cancel := context.WithCancel(context.Background())
|
|
||||||
|
|
||||||
// force ttl/interval
|
|
||||||
fopts := []Option{
|
|
||||||
RegisterTTL(time.Minute),
|
|
||||||
RegisterInterval(time.Second * 30),
|
|
||||||
}
|
|
||||||
|
|
||||||
// prepend to opts
|
|
||||||
fopts = append(fopts, opts...)
|
|
||||||
|
|
||||||
// make context the last thing
|
|
||||||
fopts = append(fopts, Context(ctx))
|
|
||||||
|
|
||||||
service := &service{opts: NewOptions(fopts...)}
|
|
||||||
|
|
||||||
fn := &function{
|
|
||||||
cancel: cancel,
|
|
||||||
Service: service,
|
|
||||||
}
|
|
||||||
|
|
||||||
service.Server().Init(
|
|
||||||
// ensure the service waits for requests to finish
|
|
||||||
server.Wait(nil),
|
|
||||||
// wrap handlers and subscribers to finish execution
|
|
||||||
server.WrapHandler(fnHandlerWrapper(fn)),
|
|
||||||
server.WrapSubscriber(fnSubWrapper(fn)),
|
|
||||||
)
|
|
||||||
|
|
||||||
return fn
|
|
||||||
}
|
|
||||||
|
|
||||||
func (f *function) Done() error {
|
|
||||||
f.cancel()
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (f *function) Handle(v interface{}) error {
|
|
||||||
return f.Service.Server().Handle(
|
|
||||||
f.Service.Server().NewHandler(v),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (f *function) Subscribe(topic string, v interface{}) error {
|
|
||||||
return f.Service.Server().Subscribe(
|
|
||||||
f.Service.Server().NewSubscriber(topic, v),
|
|
||||||
)
|
|
||||||
}
|
|
@@ -1,67 +0,0 @@
|
|||||||
//go:build ignore
|
|
||||||
// +build ignore
|
|
||||||
|
|
||||||
package micro
|
|
||||||
|
|
||||||
/*
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"sync"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"go.unistack.org/micro/v3/register"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestFunction(t *testing.T) {
|
|
||||||
var wg sync.WaitGroup
|
|
||||||
wg.Add(1)
|
|
||||||
|
|
||||||
r := register.NewRegister()
|
|
||||||
ctx := context.TODO()
|
|
||||||
// create service
|
|
||||||
fn := NewFunction(
|
|
||||||
Register(r),
|
|
||||||
Name("test.function"),
|
|
||||||
AfterStart(func(ctx context.Context) error {
|
|
||||||
wg.Done()
|
|
||||||
return nil
|
|
||||||
}),
|
|
||||||
)
|
|
||||||
|
|
||||||
// we can't test fn.Init as it parses the command line
|
|
||||||
// fn.Init()
|
|
||||||
|
|
||||||
ch := make(chan error, 2)
|
|
||||||
|
|
||||||
go func() {
|
|
||||||
// run service
|
|
||||||
ch <- fn.Run()
|
|
||||||
}()
|
|
||||||
|
|
||||||
// wait for start
|
|
||||||
wg.Wait()
|
|
||||||
|
|
||||||
// test call debug
|
|
||||||
req := fn.Client().NewRequest(
|
|
||||||
"test.function",
|
|
||||||
"Debug.Health",
|
|
||||||
new(proto.HealthRequest),
|
|
||||||
)
|
|
||||||
|
|
||||||
rsp := new(proto.HealthResponse)
|
|
||||||
|
|
||||||
err := fn.Client().Call(context.TODO(), req, rsp)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if rsp.Status != "ok" {
|
|
||||||
t.Fatalf("function response: %s", rsp.Status)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := <-ch; err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
*/
|
|
11
go.mod
11
go.mod
@@ -1,14 +1,9 @@
|
|||||||
module go.unistack.org/micro/v3
|
module go.unistack.org/micro/v3
|
||||||
|
|
||||||
go 1.16
|
go 1.19
|
||||||
|
|
||||||
require (
|
require (
|
||||||
github.com/ef-ds/deque v1.0.4
|
github.com/imdario/mergo v0.3.14
|
||||||
github.com/golang-jwt/jwt/v4 v4.2.0
|
|
||||||
github.com/imdario/mergo v0.3.12
|
|
||||||
github.com/patrickmn/go-cache v2.1.0+incompatible
|
github.com/patrickmn/go-cache v2.1.0+incompatible
|
||||||
github.com/silas/dag v0.0.0-20210626123444-3804bac2d6d4
|
github.com/silas/dag v0.0.0-20211117232152-9d50aa809f35
|
||||||
go.unistack.org/micro-proto/v3 v3.1.1
|
|
||||||
golang.org/x/net v0.0.0-20210928044308-7d9f5e0b762b
|
|
||||||
golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
|
|
||||||
)
|
)
|
||||||
|
34
go.sum
34
go.sum
@@ -1,31 +1,9 @@
|
|||||||
github.com/ef-ds/deque v1.0.4 h1:iFAZNmveMT9WERAkqLJ+oaABF9AcVQ5AjXem/hroniI=
|
github.com/imdario/mergo v0.3.14 h1:fOqeC1+nCuuk6PKQdg9YmosXX7Y7mHX6R/0ZldI9iHo=
|
||||||
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.2.0 h1:besgBTC8w8HjP6NzQdxwKH9Z5oQMZ24ThTrHp3cZ8eU=
|
|
||||||
github.com/golang-jwt/jwt/v4 v4.2.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 h1:b6R2BslTbIEToALKP7LxUvijTsNI9TAe80pLWN2g/HU=
|
|
||||||
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 h1:HRMgzkcYKYpi3C8ajMPV8OFXaaRUnok+kx1WdO15EQc=
|
||||||
github.com/patrickmn/go-cache v2.1.0+incompatible/go.mod h1:3Qf8kWWT7OJRJbdiICTKqZju1ZixQ/KpMGzzAfe6+WQ=
|
github.com/patrickmn/go-cache v2.1.0+incompatible/go.mod h1:3Qf8kWWT7OJRJbdiICTKqZju1ZixQ/KpMGzzAfe6+WQ=
|
||||||
github.com/silas/dag v0.0.0-20210626123444-3804bac2d6d4 h1:fOH64AB0C3ixGf9emky61STvPJL3smxJg+1Zwx1oCdg=
|
github.com/silas/dag v0.0.0-20211117232152-9d50aa809f35 h1:4mohWoM/UGg1BvFFiqSPRl5uwJY3rVV0HQX0ETqauqQ=
|
||||||
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.1 h1:78qRmltwGek5kSQ9tNmDZ9TCRvZM7YDIOgzriKvabjA=
|
|
||||||
go.unistack.org/micro-proto/v3 v3.1.1/go.mod h1:DpRhYCBXlmSJ/AAXTmntvlh7kQkYU6eFvlmYAx4BQS8=
|
|
||||||
golang.org/x/net v0.0.0-20210928044308-7d9f5e0b762b h1:eB48h3HiRycXNy8E0Gf5e0hv7YT6Kt14L/D73G1fuwo=
|
|
||||||
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/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||||
gopkg.in/yaml.v2 v2.3.0 h1:clyUAQHOM3G0M3f5vQj7LuJrETvjVot3Z5el9nffUtU=
|
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||||
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=
|
||||||
|
53
logger/context_test.go
Normal file
53
logger/context_test.go
Normal file
@@ -0,0 +1,53 @@
|
|||||||
|
package logger
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestFromNilContext(t *testing.T) {
|
||||||
|
// nolint: staticcheck
|
||||||
|
c, ok := FromContext(nil)
|
||||||
|
if ok || c != nil {
|
||||||
|
t.Fatal("FromContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewNilContext(t *testing.T) {
|
||||||
|
// nolint: staticcheck
|
||||||
|
ctx := NewContext(nil, NewLogger())
|
||||||
|
|
||||||
|
c, ok := FromContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("NewContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFromContext(t *testing.T) {
|
||||||
|
ctx := context.WithValue(context.TODO(), loggerKey{}, NewLogger())
|
||||||
|
|
||||||
|
c, ok := FromContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("FromContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewContext(t *testing.T) {
|
||||||
|
ctx := NewContext(context.TODO(), NewLogger())
|
||||||
|
|
||||||
|
c, ok := FromContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("NewContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetOption(t *testing.T) {
|
||||||
|
type key struct{}
|
||||||
|
o := SetOption(key{}, "test")
|
||||||
|
opts := &Options{}
|
||||||
|
o(opts)
|
||||||
|
|
||||||
|
if v, ok := opts.Context.Value(key{}).(string); !ok || v == "" {
|
||||||
|
t.Fatal("SetOption not works")
|
||||||
|
}
|
||||||
|
}
|
@@ -12,10 +12,8 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
type defaultLogger struct {
|
type defaultLogger struct {
|
||||||
enc *json.Encoder
|
enc *json.Encoder
|
||||||
logFunc LogFunc
|
opts Options
|
||||||
logfFunc LogfFunc
|
|
||||||
opts Options
|
|
||||||
sync.RWMutex
|
sync.RWMutex
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -27,10 +25,6 @@ func (l *defaultLogger) Init(opts ...Option) error {
|
|||||||
}
|
}
|
||||||
l.enc = json.NewEncoder(l.opts.Out)
|
l.enc = json.NewEncoder(l.opts.Out)
|
||||||
// wrap the Log func
|
// wrap the Log func
|
||||||
for i := len(l.opts.Wrappers); i > 0; i-- {
|
|
||||||
l.logFunc = l.opts.Wrappers[i-1].Log(l.logFunc)
|
|
||||||
l.logfFunc = l.opts.Wrappers[i-1].Logf(l.logfFunc)
|
|
||||||
}
|
|
||||||
l.Unlock()
|
l.Unlock()
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -47,17 +41,10 @@ func (l *defaultLogger) Clone(opts ...Option) Logger {
|
|||||||
o(&oldopts)
|
o(&oldopts)
|
||||||
}
|
}
|
||||||
|
|
||||||
oldopts.Wrappers = newopts.Wrappers
|
|
||||||
l.Lock()
|
l.Lock()
|
||||||
cl := &defaultLogger{opts: oldopts, logFunc: l.logFunc, logfFunc: l.logfFunc}
|
cl := &defaultLogger{opts: oldopts, enc: json.NewEncoder(l.opts.Out)}
|
||||||
l.Unlock()
|
l.Unlock()
|
||||||
|
|
||||||
// wrap the Log func
|
|
||||||
for i := len(newopts.Wrappers); i > 0; i-- {
|
|
||||||
cl.logFunc = newopts.Wrappers[i-1].Log(cl.logFunc)
|
|
||||||
cl.logfFunc = newopts.Wrappers[i-1].Logf(cl.logfFunc)
|
|
||||||
}
|
|
||||||
|
|
||||||
return cl
|
return cl
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -75,15 +62,17 @@ func (l *defaultLogger) Level(level Level) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (l *defaultLogger) Fields(fields ...interface{}) Logger {
|
func (l *defaultLogger) Fields(fields ...interface{}) Logger {
|
||||||
|
l.RLock()
|
||||||
nl := &defaultLogger{opts: l.opts, enc: l.enc}
|
nl := &defaultLogger{opts: l.opts, enc: l.enc}
|
||||||
if len(fields) == 0 {
|
if len(fields) == 0 {
|
||||||
|
l.RUnlock()
|
||||||
return nl
|
return nl
|
||||||
} else if len(fields)%2 != 0 {
|
} else if len(fields)%2 != 0 {
|
||||||
fields = fields[:len(fields)-1]
|
fields = fields[:len(fields)-1]
|
||||||
}
|
}
|
||||||
nl.logFunc = l.logFunc
|
nl.opts.Fields = copyFields(l.opts.Fields)
|
||||||
nl.logfFunc = l.logfFunc
|
|
||||||
nl.opts.Fields = append(nl.opts.Fields, fields...)
|
nl.opts.Fields = append(nl.opts.Fields, fields...)
|
||||||
|
l.RUnlock()
|
||||||
return nl
|
return nl
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -143,27 +132,27 @@ func (l *defaultLogger) Fatal(ctx context.Context, args ...interface{}) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (l *defaultLogger) Infof(ctx context.Context, msg string, args ...interface{}) {
|
func (l *defaultLogger) Infof(ctx context.Context, msg string, args ...interface{}) {
|
||||||
l.logfFunc(ctx, InfoLevel, msg, args...)
|
l.Logf(ctx, InfoLevel, msg, args...)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *defaultLogger) Errorf(ctx context.Context, msg string, args ...interface{}) {
|
func (l *defaultLogger) Errorf(ctx context.Context, msg string, args ...interface{}) {
|
||||||
l.logfFunc(ctx, ErrorLevel, msg, args...)
|
l.Logf(ctx, ErrorLevel, msg, args...)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *defaultLogger) Debugf(ctx context.Context, msg string, args ...interface{}) {
|
func (l *defaultLogger) Debugf(ctx context.Context, msg string, args ...interface{}) {
|
||||||
l.logfFunc(ctx, DebugLevel, msg, args...)
|
l.Logf(ctx, DebugLevel, msg, args...)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *defaultLogger) Warnf(ctx context.Context, msg string, args ...interface{}) {
|
func (l *defaultLogger) Warnf(ctx context.Context, msg string, args ...interface{}) {
|
||||||
l.logfFunc(ctx, WarnLevel, msg, args...)
|
l.Logf(ctx, WarnLevel, msg, args...)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *defaultLogger) Tracef(ctx context.Context, msg string, args ...interface{}) {
|
func (l *defaultLogger) Tracef(ctx context.Context, msg string, args ...interface{}) {
|
||||||
l.logfFunc(ctx, TraceLevel, msg, args...)
|
l.Logf(ctx, TraceLevel, msg, args...)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *defaultLogger) Fatalf(ctx context.Context, msg string, args ...interface{}) {
|
func (l *defaultLogger) Fatalf(ctx context.Context, msg string, args ...interface{}) {
|
||||||
l.logfFunc(ctx, FatalLevel, msg, args...)
|
l.Logf(ctx, FatalLevel, msg, args...)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -236,8 +225,6 @@ func NewLogger(opts ...Option) Logger {
|
|||||||
l := &defaultLogger{
|
l := &defaultLogger{
|
||||||
opts: NewOptions(opts...),
|
opts: NewOptions(opts...),
|
||||||
}
|
}
|
||||||
l.logFunc = l.Log
|
|
||||||
l.logfFunc = l.Logf
|
|
||||||
l.enc = json.NewEncoder(l.opts.Out)
|
l.enc = json.NewEncoder(l.opts.Out)
|
||||||
return l
|
return l
|
||||||
}
|
}
|
||||||
|
@@ -8,9 +8,9 @@ import (
|
|||||||
|
|
||||||
var (
|
var (
|
||||||
// DefaultLogger variable
|
// DefaultLogger variable
|
||||||
DefaultLogger Logger = NewLogger(WithLevel(ParseLevel(os.Getenv("MICRO_LOG_LEVEL"))))
|
DefaultLogger = NewLogger(WithLevel(ParseLevel(os.Getenv("MICRO_LOG_LEVEL"))))
|
||||||
// DefaultLevel used by logger
|
// DefaultLevel used by logger
|
||||||
DefaultLevel Level = InfoLevel
|
DefaultLevel = InfoLevel
|
||||||
// DefaultCallerSkipCount used by logger
|
// DefaultCallerSkipCount used by logger
|
||||||
DefaultCallerSkipCount = 2
|
DefaultCallerSkipCount = 2
|
||||||
)
|
)
|
||||||
|
@@ -32,7 +32,33 @@ func TestFields(t *testing.T) {
|
|||||||
if err := l.Init(); err != nil {
|
if err := l.Init(); err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
l.Fields("key", "val").Info(ctx, "message")
|
|
||||||
|
nl := l.Fields("key", "val")
|
||||||
|
|
||||||
|
nl.Info(ctx, "message")
|
||||||
|
if !bytes.Contains(buf.Bytes(), []byte(`"key":"val"`)) {
|
||||||
|
t.Fatalf("logger fields not works, buf contains: %s", buf.Bytes())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFromContextWithFields(t *testing.T) {
|
||||||
|
ctx := context.TODO()
|
||||||
|
buf := bytes.NewBuffer(nil)
|
||||||
|
var ok bool
|
||||||
|
l := NewLogger(WithLevel(TraceLevel), WithOutput(buf))
|
||||||
|
if err := l.Init(); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
nl := l.Fields("key", "val")
|
||||||
|
|
||||||
|
ctx = NewContext(ctx, nl)
|
||||||
|
|
||||||
|
l, ok = FromContext(ctx)
|
||||||
|
if !ok {
|
||||||
|
t.Fatalf("context does not have logger")
|
||||||
|
}
|
||||||
|
|
||||||
|
l.Info(ctx, "message")
|
||||||
if !bytes.Contains(buf.Bytes(), []byte(`"key":"val"`)) {
|
if !bytes.Contains(buf.Bytes(), []byte(`"key":"val"`)) {
|
||||||
t.Fatalf("logger fields not works, buf contains: %s", buf.Bytes())
|
t.Fatalf("logger fields not works, buf contains: %s", buf.Bytes())
|
||||||
}
|
}
|
||||||
@@ -110,39 +136,3 @@ func TestLogger(t *testing.T) {
|
|||||||
t.Fatalf("logger error, buf %s", buf.Bytes())
|
t.Fatalf("logger error, buf %s", buf.Bytes())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestLoggerWrapper(t *testing.T) {
|
|
||||||
ctx := context.TODO()
|
|
||||||
buf := bytes.NewBuffer(nil)
|
|
||||||
l := NewLogger(WithLevel(TraceLevel), WithOutput(buf))
|
|
||||||
if err := l.Init(WrapLogger(NewOmitWrapper())); err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
type secret struct {
|
|
||||||
Name string
|
|
||||||
Passw string `logger:"omit"`
|
|
||||||
}
|
|
||||||
s := &secret{Name: "name", Passw: "secret"}
|
|
||||||
l.Errorf(ctx, "test %#+v", s)
|
|
||||||
if !bytes.Contains(buf.Bytes(), []byte(`logger.secret{Name:\"name\", Passw:\"\"}"`)) {
|
|
||||||
t.Fatalf("omit not works, struct: %v, output: %s", s, buf.Bytes())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestOmitLoggerWrapper(t *testing.T) {
|
|
||||||
ctx := context.TODO()
|
|
||||||
buf := bytes.NewBuffer(nil)
|
|
||||||
l := NewOmitLogger(NewLogger(WithLevel(TraceLevel), WithOutput(buf)))
|
|
||||||
if err := l.Init(); err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
type secret struct {
|
|
||||||
Name string
|
|
||||||
Passw string `logger:"omit"`
|
|
||||||
}
|
|
||||||
s := &secret{Name: "name", Passw: "secret"}
|
|
||||||
l.Errorf(ctx, "test %#+v", s)
|
|
||||||
if !bytes.Contains(buf.Bytes(), []byte(`logger.secret{Name:\"name\", Passw:\"\"}"`)) {
|
|
||||||
t.Fatalf("omit not works, struct: %v, output: %s", s, buf.Bytes())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
@@ -19,8 +19,6 @@ type Options struct {
|
|||||||
Fields []interface{}
|
Fields []interface{}
|
||||||
// Name holds the logger name
|
// Name holds the logger name
|
||||||
Name string
|
Name string
|
||||||
// Wrappers logger wrapper that called before actual Log/Logf function
|
|
||||||
Wrappers []Wrapper
|
|
||||||
// The logging level the logger should log
|
// The logging level the logger should log
|
||||||
Level Level
|
Level Level
|
||||||
// CallerSkipCount number of frmaes to skip
|
// CallerSkipCount number of frmaes to skip
|
||||||
@@ -83,10 +81,3 @@ func WithName(n string) Option {
|
|||||||
o.Name = n
|
o.Name = n
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// WrapLogger adds a logger Wrapper to a list of options passed into the logger
|
|
||||||
func WrapLogger(w Wrapper) Option {
|
|
||||||
return func(o *Options) {
|
|
||||||
o.Wrappers = append(o.Wrappers, w)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
681
logger/unwrap/unwrap.go
Normal file
681
logger/unwrap/unwrap.go
Normal file
@@ -0,0 +1,681 @@
|
|||||||
|
package unwrap
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"reflect"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"go.unistack.org/micro/v3/codec"
|
||||||
|
)
|
||||||
|
|
||||||
|
const sf = "0-+# "
|
||||||
|
|
||||||
|
var hexDigits = "0123456789abcdef"
|
||||||
|
|
||||||
|
var (
|
||||||
|
panicBytes = []byte("(PANIC=")
|
||||||
|
plusBytes = []byte("+")
|
||||||
|
iBytes = []byte("i")
|
||||||
|
trueBytes = []byte("true")
|
||||||
|
falseBytes = []byte("false")
|
||||||
|
interfaceBytes = []byte("(interface {})")
|
||||||
|
openBraceBytes = []byte("{")
|
||||||
|
closeBraceBytes = []byte("}")
|
||||||
|
asteriskBytes = []byte("*")
|
||||||
|
ampBytes = []byte("&")
|
||||||
|
colonBytes = []byte(":")
|
||||||
|
openParenBytes = []byte("(")
|
||||||
|
closeParenBytes = []byte(")")
|
||||||
|
spaceBytes = []byte(" ")
|
||||||
|
commaBytes = []byte(",")
|
||||||
|
pointerChainBytes = []byte("->")
|
||||||
|
nilAngleBytes = []byte("<nil>")
|
||||||
|
circularShortBytes = []byte("<shown>")
|
||||||
|
invalidAngleBytes = []byte("<invalid>")
|
||||||
|
filteredBytes = []byte("<filtered>")
|
||||||
|
openBracketBytes = []byte("[")
|
||||||
|
closeBracketBytes = []byte("]")
|
||||||
|
percentBytes = []byte("%")
|
||||||
|
precisionBytes = []byte(".")
|
||||||
|
openAngleBytes = []byte("<")
|
||||||
|
closeAngleBytes = []byte(">")
|
||||||
|
openMapBytes = []byte("{")
|
||||||
|
closeMapBytes = []byte("}")
|
||||||
|
)
|
||||||
|
|
||||||
|
type protoMessage interface {
|
||||||
|
Reset()
|
||||||
|
ProtoMessage()
|
||||||
|
}
|
||||||
|
|
||||||
|
type Wrapper struct {
|
||||||
|
val interface{}
|
||||||
|
s fmt.State
|
||||||
|
pointers map[uintptr]int
|
||||||
|
opts *Options
|
||||||
|
depth int
|
||||||
|
ignoreNextType bool
|
||||||
|
takeMap map[int]bool
|
||||||
|
protoWrapperType bool
|
||||||
|
sqlWrapperType bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// Options struct
|
||||||
|
type Options struct {
|
||||||
|
Codec codec.Codec
|
||||||
|
Indent string
|
||||||
|
Methods bool
|
||||||
|
Tagged bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewOptions creates new Options struct via provided args
|
||||||
|
func NewOptions(opts ...Option) Options {
|
||||||
|
options := Options{
|
||||||
|
Indent: " ",
|
||||||
|
Methods: false,
|
||||||
|
}
|
||||||
|
for _, o := range opts {
|
||||||
|
o(&options)
|
||||||
|
}
|
||||||
|
return options
|
||||||
|
}
|
||||||
|
|
||||||
|
// Option func signature
|
||||||
|
type Option func(*Options)
|
||||||
|
|
||||||
|
// Indent option specify indent level
|
||||||
|
func Indent(f string) Option {
|
||||||
|
return func(o *Options) {
|
||||||
|
o.Indent = f
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Methods option toggles fmt.Stringer methods
|
||||||
|
func Methods(b bool) Option {
|
||||||
|
return func(o *Options) {
|
||||||
|
o.Methods = b
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Codec option automatic marshal arg via specified codec and write it to log
|
||||||
|
func Codec(c codec.Codec) Option {
|
||||||
|
return func(o *Options) {
|
||||||
|
o.Codec = c
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Tagged option toggles output only logger:"take" fields
|
||||||
|
func Tagged(b bool) Option {
|
||||||
|
return func(o *Options) {
|
||||||
|
o.Tagged = b
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func Unwrap(val interface{}, opts ...Option) *Wrapper {
|
||||||
|
options := NewOptions(opts...)
|
||||||
|
return &Wrapper{val: val, opts: &options, pointers: make(map[uintptr]int), takeMap: make(map[int]bool)}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *Wrapper) unpackValue(v reflect.Value) reflect.Value {
|
||||||
|
if v.Kind() == reflect.Interface {
|
||||||
|
w.ignoreNextType = false
|
||||||
|
if !v.IsNil() {
|
||||||
|
v = v.Elem()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
|
||||||
|
// formatPtr handles formatting of pointers by indirecting them as necessary.
|
||||||
|
func (w *Wrapper) formatPtr(v reflect.Value) {
|
||||||
|
// Display nil if top level pointer is nil.
|
||||||
|
showTypes := w.s.Flag('#')
|
||||||
|
if v.IsNil() && (!showTypes || w.ignoreNextType) {
|
||||||
|
_, _ = w.s.Write(nilAngleBytes)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Remove pointers at or below the current depth from map used to detect
|
||||||
|
// circular refs.
|
||||||
|
for k, depth := range w.pointers {
|
||||||
|
if depth >= w.depth {
|
||||||
|
delete(w.pointers, k)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Keep list of all dereferenced pointers to possibly show later.
|
||||||
|
pointerChain := make([]uintptr, 0)
|
||||||
|
|
||||||
|
// Figure out how many levels of indirection there are by derferencing
|
||||||
|
// pointers and unpacking interfaces down the chain while detecting circular
|
||||||
|
// references.
|
||||||
|
nilFound := false
|
||||||
|
cycleFound := false
|
||||||
|
indirects := 0
|
||||||
|
ve := v
|
||||||
|
for ve.Kind() == reflect.Ptr {
|
||||||
|
if ve.IsNil() {
|
||||||
|
nilFound = true
|
||||||
|
break
|
||||||
|
}
|
||||||
|
indirects++
|
||||||
|
addr := ve.Pointer()
|
||||||
|
pointerChain = append(pointerChain, addr)
|
||||||
|
if pd, ok := w.pointers[addr]; ok && pd < w.depth {
|
||||||
|
cycleFound = true
|
||||||
|
indirects--
|
||||||
|
break
|
||||||
|
}
|
||||||
|
w.pointers[addr] = w.depth
|
||||||
|
|
||||||
|
ve = ve.Elem()
|
||||||
|
if ve.Kind() == reflect.Interface {
|
||||||
|
if ve.IsNil() {
|
||||||
|
nilFound = true
|
||||||
|
break
|
||||||
|
}
|
||||||
|
ve = ve.Elem()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Display type or indirection level depending on flags.
|
||||||
|
if showTypes && !w.ignoreNextType {
|
||||||
|
if w.depth > 0 {
|
||||||
|
_, _ = w.s.Write(openParenBytes)
|
||||||
|
}
|
||||||
|
if w.depth > 0 {
|
||||||
|
_, _ = w.s.Write(bytes.Repeat(asteriskBytes, indirects))
|
||||||
|
} else {
|
||||||
|
_, _ = w.s.Write(bytes.Repeat(ampBytes, indirects))
|
||||||
|
}
|
||||||
|
_, _ = w.s.Write([]byte(ve.Type().String()))
|
||||||
|
if w.depth > 0 {
|
||||||
|
_, _ = w.s.Write(closeParenBytes)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
if nilFound || cycleFound {
|
||||||
|
indirects += strings.Count(ve.Type().String(), "*")
|
||||||
|
}
|
||||||
|
_, _ = w.s.Write(openAngleBytes)
|
||||||
|
_, _ = w.s.Write([]byte(strings.Repeat("*", indirects)))
|
||||||
|
_, _ = w.s.Write(closeAngleBytes)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Display pointer information depending on flags.
|
||||||
|
if w.s.Flag('+') && (len(pointerChain) > 0) {
|
||||||
|
_, _ = w.s.Write(openParenBytes)
|
||||||
|
for i, addr := range pointerChain {
|
||||||
|
if i > 0 {
|
||||||
|
_, _ = w.s.Write(pointerChainBytes)
|
||||||
|
}
|
||||||
|
getHexPtr(w.s, addr)
|
||||||
|
}
|
||||||
|
_, _ = w.s.Write(closeParenBytes)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Display dereferenced value.
|
||||||
|
switch {
|
||||||
|
case nilFound:
|
||||||
|
_, _ = w.s.Write(nilAngleBytes)
|
||||||
|
case cycleFound:
|
||||||
|
_, _ = w.s.Write(circularShortBytes)
|
||||||
|
default:
|
||||||
|
w.ignoreNextType = true
|
||||||
|
w.format(ve)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// format is the main workhorse for providing the Formatter interface. It
|
||||||
|
// uses the passed reflect value to figure out what kind of object we are
|
||||||
|
// dealing with and formats it appropriately. It is a recursive function,
|
||||||
|
// however circular data structures are detected and handled properly.
|
||||||
|
func (w *Wrapper) format(v reflect.Value) {
|
||||||
|
if w.opts.Codec != nil {
|
||||||
|
buf, err := w.opts.Codec.Marshal(v.Interface())
|
||||||
|
if err != nil {
|
||||||
|
_, _ = w.s.Write(invalidAngleBytes)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
_, _ = w.s.Write(buf)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Handle invalid reflect values immediately.
|
||||||
|
kind := v.Kind()
|
||||||
|
if kind == reflect.Invalid {
|
||||||
|
_, _ = w.s.Write(invalidAngleBytes)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Handle pointers specially.
|
||||||
|
switch kind {
|
||||||
|
case reflect.Ptr:
|
||||||
|
if !v.IsZero() {
|
||||||
|
if strings.HasPrefix(reflect.Indirect(v).Type().String(), "wrapperspb.") {
|
||||||
|
w.protoWrapperType = true
|
||||||
|
} else if strings.HasPrefix(reflect.Indirect(v).Type().String(), "sql.Null") {
|
||||||
|
w.sqlWrapperType = true
|
||||||
|
} else if v.CanInterface() {
|
||||||
|
if _, ok := v.Interface().(protoMessage); ok {
|
||||||
|
w.protoWrapperType = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
w.formatPtr(v)
|
||||||
|
return
|
||||||
|
case reflect.Struct:
|
||||||
|
if !v.IsZero() {
|
||||||
|
if strings.HasPrefix(reflect.Indirect(v).Type().String(), "sql.Null") {
|
||||||
|
w.sqlWrapperType = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// get type information unless already handled elsewhere.
|
||||||
|
if !w.ignoreNextType && w.s.Flag('#') {
|
||||||
|
if v.Type().Kind() != reflect.Map &&
|
||||||
|
v.Type().Kind() != reflect.String &&
|
||||||
|
v.Type().Kind() != reflect.Array &&
|
||||||
|
v.Type().Kind() != reflect.Slice {
|
||||||
|
_, _ = w.s.Write(openParenBytes)
|
||||||
|
}
|
||||||
|
if v.Kind() != reflect.String {
|
||||||
|
_, _ = w.s.Write([]byte(v.Type().String()))
|
||||||
|
}
|
||||||
|
if v.Type().Kind() != reflect.Map &&
|
||||||
|
v.Type().Kind() != reflect.String &&
|
||||||
|
v.Type().Kind() != reflect.Array &&
|
||||||
|
v.Type().Kind() != reflect.Slice {
|
||||||
|
_, _ = w.s.Write(closeParenBytes)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
w.ignoreNextType = false
|
||||||
|
|
||||||
|
// Call Stringer/error interfaces if they exist and the handle methods
|
||||||
|
// flag is enabled.
|
||||||
|
if w.opts.Methods {
|
||||||
|
if (kind != reflect.Invalid) && (kind != reflect.Interface) {
|
||||||
|
if handled := handleMethods(w.opts, w.s, v); handled {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
switch kind {
|
||||||
|
case reflect.Invalid:
|
||||||
|
_, _ = w.s.Write(invalidAngleBytes)
|
||||||
|
case reflect.Bool:
|
||||||
|
getBool(w.s, v.Bool())
|
||||||
|
case reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, reflect.Int:
|
||||||
|
getInt(w.s, v.Int(), 10)
|
||||||
|
case reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uint:
|
||||||
|
getUint(w.s, v.Uint(), 10)
|
||||||
|
case reflect.Float32:
|
||||||
|
getFloat(w.s, v.Float(), 32)
|
||||||
|
case reflect.Float64:
|
||||||
|
getFloat(w.s, v.Float(), 64)
|
||||||
|
case reflect.Complex64:
|
||||||
|
getComplex(w.s, v.Complex(), 32)
|
||||||
|
case reflect.Complex128:
|
||||||
|
getComplex(w.s, v.Complex(), 64)
|
||||||
|
case reflect.Slice:
|
||||||
|
if v.IsNil() {
|
||||||
|
_, _ = w.s.Write(nilAngleBytes)
|
||||||
|
break
|
||||||
|
}
|
||||||
|
fallthrough
|
||||||
|
case reflect.Array:
|
||||||
|
_, _ = w.s.Write(openBraceBytes)
|
||||||
|
w.depth++
|
||||||
|
numEntries := v.Len()
|
||||||
|
for i := 0; i < numEntries; i++ {
|
||||||
|
if i > 0 {
|
||||||
|
_, _ = w.s.Write(commaBytes)
|
||||||
|
_, _ = w.s.Write(spaceBytes)
|
||||||
|
}
|
||||||
|
w.ignoreNextType = true
|
||||||
|
w.format(w.unpackValue(v.Index(i)))
|
||||||
|
}
|
||||||
|
w.depth--
|
||||||
|
_, _ = w.s.Write(closeBraceBytes)
|
||||||
|
case reflect.String:
|
||||||
|
_, _ = w.s.Write([]byte(`"` + v.String() + `"`))
|
||||||
|
case reflect.Interface:
|
||||||
|
// The only time we should get here is for nil interfaces due to
|
||||||
|
// unpackValue calls.
|
||||||
|
if v.IsNil() {
|
||||||
|
_, _ = w.s.Write(nilAngleBytes)
|
||||||
|
}
|
||||||
|
case reflect.Ptr:
|
||||||
|
// Do nothing. We should never get here since pointers have already
|
||||||
|
// been handled above.
|
||||||
|
case reflect.Map:
|
||||||
|
// nil maps should be indicated as different than empty maps
|
||||||
|
if v.IsNil() {
|
||||||
|
_, _ = w.s.Write(nilAngleBytes)
|
||||||
|
break
|
||||||
|
}
|
||||||
|
_, _ = w.s.Write(openMapBytes)
|
||||||
|
w.depth++
|
||||||
|
keys := v.MapKeys()
|
||||||
|
for i, key := range keys {
|
||||||
|
if i > 0 {
|
||||||
|
_, _ = w.s.Write(spaceBytes)
|
||||||
|
}
|
||||||
|
w.ignoreNextType = true
|
||||||
|
w.format(w.unpackValue(key))
|
||||||
|
_, _ = w.s.Write(colonBytes)
|
||||||
|
w.ignoreNextType = true
|
||||||
|
w.format(w.unpackValue(v.MapIndex(key)))
|
||||||
|
}
|
||||||
|
w.depth--
|
||||||
|
_, _ = w.s.Write(closeMapBytes)
|
||||||
|
case reflect.Struct:
|
||||||
|
|
||||||
|
numFields := v.NumField()
|
||||||
|
numWritten := 0
|
||||||
|
_, _ = w.s.Write(openBraceBytes)
|
||||||
|
w.depth++
|
||||||
|
|
||||||
|
vt := v.Type()
|
||||||
|
prevSkip := false
|
||||||
|
|
||||||
|
for i := 0; i < numFields; i++ {
|
||||||
|
switch vt.Field(i).Type.PkgPath() {
|
||||||
|
case "google.golang.org/protobuf/internal/impl", "google.golang.org/protobuf/internal/pragma":
|
||||||
|
w.protoWrapperType = true
|
||||||
|
prevSkip = true
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if w.protoWrapperType && !vt.Field(i).IsExported() {
|
||||||
|
prevSkip = true
|
||||||
|
continue
|
||||||
|
} else if w.sqlWrapperType && vt.Field(i).Name == "Valid" {
|
||||||
|
prevSkip = true
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if _, ok := vt.Field(i).Tag.Lookup("protobuf"); ok && !w.protoWrapperType {
|
||||||
|
w.protoWrapperType = true
|
||||||
|
}
|
||||||
|
sv, ok := vt.Field(i).Tag.Lookup("logger")
|
||||||
|
switch {
|
||||||
|
case ok:
|
||||||
|
switch sv {
|
||||||
|
case "omit":
|
||||||
|
prevSkip = true
|
||||||
|
continue
|
||||||
|
case "take":
|
||||||
|
break
|
||||||
|
}
|
||||||
|
case !ok && w.opts.Tagged:
|
||||||
|
// skip top level untagged
|
||||||
|
if w.depth == 1 {
|
||||||
|
prevSkip = true
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if tv, ok := w.takeMap[w.depth]; ok && !tv {
|
||||||
|
prevSkip = true
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if prevSkip {
|
||||||
|
prevSkip = false
|
||||||
|
}
|
||||||
|
|
||||||
|
if numWritten > 0 {
|
||||||
|
_, _ = w.s.Write(commaBytes)
|
||||||
|
_, _ = w.s.Write(spaceBytes)
|
||||||
|
}
|
||||||
|
|
||||||
|
vt := vt.Field(i)
|
||||||
|
if w.s.Flag('+') || w.s.Flag('#') {
|
||||||
|
_, _ = w.s.Write([]byte(vt.Name))
|
||||||
|
_, _ = w.s.Write(colonBytes)
|
||||||
|
}
|
||||||
|
w.format(w.unpackValue(v.Field(i)))
|
||||||
|
numWritten++
|
||||||
|
}
|
||||||
|
w.depth--
|
||||||
|
|
||||||
|
if numWritten == 0 && w.depth < 0 {
|
||||||
|
_, _ = w.s.Write(filteredBytes)
|
||||||
|
}
|
||||||
|
_, _ = w.s.Write(closeBraceBytes)
|
||||||
|
case reflect.Uintptr:
|
||||||
|
getHexPtr(w.s, uintptr(v.Uint()))
|
||||||
|
case reflect.UnsafePointer, reflect.Chan, reflect.Func:
|
||||||
|
getHexPtr(w.s, v.Pointer())
|
||||||
|
// There were not any other types at the time this code was written, but
|
||||||
|
// fall back to letting the default fmt package handle it if any get added.
|
||||||
|
default:
|
||||||
|
format := w.buildDefaultFormat()
|
||||||
|
if v.CanInterface() {
|
||||||
|
_, _ = fmt.Fprintf(w.s, format, v.Interface())
|
||||||
|
} else {
|
||||||
|
_, _ = fmt.Fprintf(w.s, format, v.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *Wrapper) Format(s fmt.State, verb rune) {
|
||||||
|
w.s = s
|
||||||
|
|
||||||
|
// Use standard formatting for verbs that are not v.
|
||||||
|
if verb != 'v' {
|
||||||
|
format := w.constructOrigFormat(verb)
|
||||||
|
_, _ = fmt.Fprintf(s, format, w.val)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if w.val == nil {
|
||||||
|
if s.Flag('#') {
|
||||||
|
_, _ = s.Write(interfaceBytes)
|
||||||
|
}
|
||||||
|
_, _ = s.Write(nilAngleBytes)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if w.opts.Tagged {
|
||||||
|
w.buildTakeMap(reflect.ValueOf(w.val), 1)
|
||||||
|
}
|
||||||
|
|
||||||
|
w.format(reflect.ValueOf(w.val))
|
||||||
|
}
|
||||||
|
|
||||||
|
// handle special methods like error.Error() or fmt.Stringer interface
|
||||||
|
func handleMethods(_ *Options, w io.Writer, v reflect.Value) (handled bool) {
|
||||||
|
if !v.CanInterface() {
|
||||||
|
// not our case
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
if !v.CanAddr() {
|
||||||
|
// not our case
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
if v.CanAddr() {
|
||||||
|
v = v.Addr()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Is it an error or Stringer?
|
||||||
|
switch iface := v.Interface().(type) {
|
||||||
|
case error:
|
||||||
|
defer catchPanic(w, v)
|
||||||
|
_, _ = w.Write([]byte(iface.Error()))
|
||||||
|
return true
|
||||||
|
case fmt.Stringer:
|
||||||
|
defer catchPanic(w, v)
|
||||||
|
_, _ = w.Write([]byte(iface.String()))
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// getBool outputs a boolean value as true or false to Writer w.
|
||||||
|
func getBool(w io.Writer, val bool) {
|
||||||
|
if val {
|
||||||
|
_, _ = w.Write(trueBytes)
|
||||||
|
} else {
|
||||||
|
_, _ = w.Write(falseBytes)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// getInt outputs a signed integer value to Writer w.
|
||||||
|
func getInt(w io.Writer, val int64, base int) {
|
||||||
|
_, _ = w.Write([]byte(strconv.FormatInt(val, base)))
|
||||||
|
}
|
||||||
|
|
||||||
|
// getUint outputs an unsigned integer value to Writer w.
|
||||||
|
func getUint(w io.Writer, val uint64, base int) {
|
||||||
|
_, _ = w.Write([]byte(strconv.FormatUint(val, base)))
|
||||||
|
}
|
||||||
|
|
||||||
|
// getFloat outputs a floating point value using the specified precision,
|
||||||
|
// which is expected to be 32 or 64bit, to Writer w.
|
||||||
|
func getFloat(w io.Writer, val float64, precision int) {
|
||||||
|
_, _ = w.Write([]byte(strconv.FormatFloat(val, 'g', -1, precision)))
|
||||||
|
}
|
||||||
|
|
||||||
|
// getComplex outputs a complex value using the specified float precision
|
||||||
|
// for the real and imaginary parts to Writer w.
|
||||||
|
func getComplex(w io.Writer, c complex128, floatPrecision int) {
|
||||||
|
r := real(c)
|
||||||
|
_, _ = w.Write(openParenBytes)
|
||||||
|
_, _ = w.Write([]byte(strconv.FormatFloat(r, 'g', -1, floatPrecision)))
|
||||||
|
i := imag(c)
|
||||||
|
if i >= 0 {
|
||||||
|
_, _ = w.Write(plusBytes)
|
||||||
|
}
|
||||||
|
_, _ = w.Write([]byte(strconv.FormatFloat(i, 'g', -1, floatPrecision)))
|
||||||
|
_, _ = w.Write(iBytes)
|
||||||
|
_, _ = w.Write(closeParenBytes)
|
||||||
|
}
|
||||||
|
|
||||||
|
// getHexPtr outputs a uintptr formatted as hexadecimal with a leading '0x'
|
||||||
|
// prefix to Writer w.
|
||||||
|
func getHexPtr(w io.Writer, p uintptr) {
|
||||||
|
// Null pointer.
|
||||||
|
num := uint64(p)
|
||||||
|
if num == 0 {
|
||||||
|
_, _ = w.Write(nilAngleBytes)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Max uint64 is 16 bytes in hex + 2 bytes for '0x' prefix
|
||||||
|
buf := make([]byte, 18)
|
||||||
|
|
||||||
|
// It's simpler to construct the hex string right to left.
|
||||||
|
base := uint64(16)
|
||||||
|
i := len(buf) - 1
|
||||||
|
for num >= base {
|
||||||
|
buf[i] = hexDigits[num%base]
|
||||||
|
num /= base
|
||||||
|
i--
|
||||||
|
}
|
||||||
|
buf[i] = hexDigits[num]
|
||||||
|
|
||||||
|
// Add '0x' prefix.
|
||||||
|
i--
|
||||||
|
buf[i] = 'x'
|
||||||
|
i--
|
||||||
|
buf[i] = '0'
|
||||||
|
|
||||||
|
// Strip unused leading bytes.
|
||||||
|
buf = buf[i:]
|
||||||
|
_, _ = w.Write(buf)
|
||||||
|
}
|
||||||
|
|
||||||
|
func catchPanic(w io.Writer, _ reflect.Value) {
|
||||||
|
if err := recover(); err != nil {
|
||||||
|
_, _ = w.Write(panicBytes)
|
||||||
|
_, _ = fmt.Fprintf(w, "%v", err)
|
||||||
|
_, _ = w.Write(closeParenBytes)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *Wrapper) buildDefaultFormat() (format string) {
|
||||||
|
buf := bytes.NewBuffer(percentBytes)
|
||||||
|
|
||||||
|
for _, flag := range sf {
|
||||||
|
if w.s.Flag(int(flag)) {
|
||||||
|
_, _ = buf.WriteRune(flag)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
_, _ = buf.WriteRune('v')
|
||||||
|
|
||||||
|
format = buf.String()
|
||||||
|
return format
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *Wrapper) constructOrigFormat(verb rune) string {
|
||||||
|
buf := bytes.NewBuffer(percentBytes)
|
||||||
|
|
||||||
|
for _, flag := range sf {
|
||||||
|
if w.s.Flag(int(flag)) {
|
||||||
|
_, _ = buf.WriteRune(flag)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if width, ok := w.s.Width(); ok {
|
||||||
|
_, _ = buf.WriteString(strconv.Itoa(width))
|
||||||
|
}
|
||||||
|
|
||||||
|
if precision, ok := w.s.Precision(); ok {
|
||||||
|
_, _ = buf.Write(precisionBytes)
|
||||||
|
_, _ = buf.WriteString(strconv.Itoa(precision))
|
||||||
|
}
|
||||||
|
|
||||||
|
_, _ = buf.WriteRune(verb)
|
||||||
|
|
||||||
|
return buf.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *Wrapper) buildTakeMap(v reflect.Value, depth int) {
|
||||||
|
if !v.IsValid() || v.IsZero() {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
switch v.Kind() {
|
||||||
|
case reflect.Slice, reflect.Array:
|
||||||
|
for i := 0; i < v.Len(); i++ {
|
||||||
|
w.buildTakeMap(v.Index(i), depth+1)
|
||||||
|
}
|
||||||
|
w.takeMap[depth] = true
|
||||||
|
return
|
||||||
|
case reflect.Struct:
|
||||||
|
break
|
||||||
|
case reflect.Ptr:
|
||||||
|
v = v.Elem()
|
||||||
|
if v.Kind() != reflect.Struct {
|
||||||
|
w.takeMap[depth] = true
|
||||||
|
return
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
w.takeMap[depth] = true
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
vt := v.Type()
|
||||||
|
|
||||||
|
for i := 0; i < v.NumField(); i++ {
|
||||||
|
sv, ok := vt.Field(i).Tag.Lookup("logger")
|
||||||
|
if ok && sv == "take" {
|
||||||
|
w.takeMap[depth] = false
|
||||||
|
}
|
||||||
|
if v.Kind() == reflect.Struct ||
|
||||||
|
(v.Kind() == reflect.Ptr && v.Elem().Kind() == reflect.Struct) {
|
||||||
|
w.buildTakeMap(v.Field(i), depth+1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, ok := w.takeMap[depth]; !ok {
|
||||||
|
w.takeMap[depth] = true
|
||||||
|
}
|
||||||
|
}
|
100
logger/unwrap/unwrap_test.go
Normal file
100
logger/unwrap/unwrap_test.go
Normal file
@@ -0,0 +1,100 @@
|
|||||||
|
package unwrap
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"go.unistack.org/micro/v3/codec"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestUnwrap(t *testing.T) {
|
||||||
|
string1 := "string1"
|
||||||
|
string2 := "string2"
|
||||||
|
|
||||||
|
type val1 struct {
|
||||||
|
mp map[string]string
|
||||||
|
val *val1
|
||||||
|
str *string
|
||||||
|
ar []*string
|
||||||
|
}
|
||||||
|
|
||||||
|
v1 := &val1{ar: []*string{&string1, &string2}, str: &string1, val: &val1{str: &string2}, mp: map[string]string{"key": "val"}}
|
||||||
|
|
||||||
|
buf := fmt.Sprintf("%#v", Unwrap(v1))
|
||||||
|
if strings.Compare(buf, `&unwrap.val1{mp:map[string]string{"key":"val"}, val:(*unwrap.val1){mp:map[string]string<nil>, val:(*unwrap.val1)<nil>, str:(*string)"string2", ar:[]*string<nil>}, str:(*string)"string1", ar:[]*string{<*><shown>, <*>"string2"}}`) != 0 {
|
||||||
|
t.Fatalf("not proper written %s", buf)
|
||||||
|
}
|
||||||
|
|
||||||
|
type val2 struct {
|
||||||
|
mp map[string]string
|
||||||
|
val *val2
|
||||||
|
str string
|
||||||
|
ar []string
|
||||||
|
}
|
||||||
|
|
||||||
|
v2 := &val2{ar: []string{string1, string2}, str: string1, val: &val2{str: string2}, mp: map[string]string{"key": "val"}}
|
||||||
|
_ = v2
|
||||||
|
// t.Logf("output: %#v", v2)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCodec(t *testing.T) {
|
||||||
|
type val struct {
|
||||||
|
MP map[string]string `json:"mp"`
|
||||||
|
STR string `json:"str"`
|
||||||
|
AR []string `json:"ar"`
|
||||||
|
}
|
||||||
|
|
||||||
|
v1 := &val{AR: []string{"string1", "string2"}, STR: "string", MP: map[string]string{"key": "val"}}
|
||||||
|
|
||||||
|
buf := fmt.Sprintf("%#v", Unwrap(v1, Codec(codec.NewCodec())))
|
||||||
|
if strings.Compare(buf, `{"mp":{"key":"val"},"str":"string","ar":["string1","string2"]}`) != 0 {
|
||||||
|
t.Fatalf("not proper written %s", buf)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestOmit(t *testing.T) {
|
||||||
|
type val struct {
|
||||||
|
Key1 string `logger:"omit"`
|
||||||
|
Key2 string `logger:"take"`
|
||||||
|
Key3 string
|
||||||
|
}
|
||||||
|
v1 := &val{Key1: "val1", Key2: "val2", Key3: "val3"}
|
||||||
|
buf := fmt.Sprintf("%#v", Unwrap(v1))
|
||||||
|
if strings.Compare(buf, `&unwrap.val{Key2:"val2", Key3:"val3"}`) != 0 {
|
||||||
|
t.Fatalf("not proper written %s", buf)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTagged(t *testing.T) {
|
||||||
|
type val struct {
|
||||||
|
Key1 string `logger:"take"`
|
||||||
|
Key2 string
|
||||||
|
}
|
||||||
|
|
||||||
|
v1 := &val{Key1: "val1", Key2: "val2"}
|
||||||
|
buf := fmt.Sprintf("%#v", Unwrap(v1, Tagged(true)))
|
||||||
|
if strings.Compare(buf, `&unwrap.val{Key1:"val1"}`) != 0 {
|
||||||
|
t.Fatalf("not proper written %s", buf)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTaggedNested(t *testing.T) {
|
||||||
|
type val struct {
|
||||||
|
key string `logger:"take"`
|
||||||
|
val string `logger:"omit"`
|
||||||
|
unk string
|
||||||
|
}
|
||||||
|
type str struct {
|
||||||
|
key string `logger:"omit"`
|
||||||
|
val *val `logger:"take"`
|
||||||
|
}
|
||||||
|
|
||||||
|
var iface interface{}
|
||||||
|
v := &str{val: &val{key: "test", unk: "unk"}}
|
||||||
|
iface = v
|
||||||
|
buf := fmt.Sprintf("%#v", Unwrap(iface, Tagged(true)))
|
||||||
|
if strings.Compare(buf, `&unwrap.str{val:(*unwrap.val){key:"test"}}`) != 0 {
|
||||||
|
t.Fatalf("not proper written %s", buf)
|
||||||
|
}
|
||||||
|
}
|
@@ -1,166 +0,0 @@
|
|||||||
package logger // import "go.unistack.org/micro/v3/logger/wrapper"
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"reflect"
|
|
||||||
|
|
||||||
rutil "go.unistack.org/micro/v3/util/reflect"
|
|
||||||
)
|
|
||||||
|
|
||||||
// LogFunc function used for Log method
|
|
||||||
type LogFunc func(ctx context.Context, level Level, args ...interface{})
|
|
||||||
|
|
||||||
// LogfFunc function used for Logf method
|
|
||||||
type LogfFunc func(ctx context.Context, level Level, msg string, args ...interface{})
|
|
||||||
|
|
||||||
type Wrapper interface {
|
|
||||||
// Log logs message with needed level
|
|
||||||
Log(LogFunc) LogFunc
|
|
||||||
// Logf logs message with needed level
|
|
||||||
Logf(LogfFunc) LogfFunc
|
|
||||||
}
|
|
||||||
|
|
||||||
var _ Logger = &omitLogger{}
|
|
||||||
|
|
||||||
type omitLogger struct {
|
|
||||||
l Logger
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewOmitLogger(l Logger) Logger {
|
|
||||||
return &omitLogger{l: l}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *omitLogger) Init(opts ...Option) error {
|
|
||||||
return w.l.Init(append(opts, WrapLogger(NewOmitWrapper()))...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *omitLogger) V(level Level) bool {
|
|
||||||
return w.l.V(level)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *omitLogger) Level(level Level) {
|
|
||||||
w.l.Level(level)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *omitLogger) Clone(opts ...Option) Logger {
|
|
||||||
return w.l.Clone(opts...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *omitLogger) Options() Options {
|
|
||||||
return w.l.Options()
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *omitLogger) Fields(fields ...interface{}) Logger {
|
|
||||||
return w.l.Fields(fields...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *omitLogger) Info(ctx context.Context, args ...interface{}) {
|
|
||||||
w.l.Info(ctx, args...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *omitLogger) Trace(ctx context.Context, args ...interface{}) {
|
|
||||||
w.l.Trace(ctx, args...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *omitLogger) Debug(ctx context.Context, args ...interface{}) {
|
|
||||||
w.l.Debug(ctx, args...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *omitLogger) Warn(ctx context.Context, args ...interface{}) {
|
|
||||||
w.l.Warn(ctx, args...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *omitLogger) Error(ctx context.Context, args ...interface{}) {
|
|
||||||
w.l.Error(ctx, args...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *omitLogger) Fatal(ctx context.Context, args ...interface{}) {
|
|
||||||
w.l.Fatal(ctx, args...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *omitLogger) Infof(ctx context.Context, msg string, args ...interface{}) {
|
|
||||||
w.l.Infof(ctx, msg, args...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *omitLogger) Tracef(ctx context.Context, msg string, args ...interface{}) {
|
|
||||||
w.l.Tracef(ctx, msg, args...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *omitLogger) Debugf(ctx context.Context, msg string, args ...interface{}) {
|
|
||||||
w.l.Debugf(ctx, msg, args...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *omitLogger) Warnf(ctx context.Context, msg string, args ...interface{}) {
|
|
||||||
w.l.Warnf(ctx, msg, args...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *omitLogger) Errorf(ctx context.Context, msg string, args ...interface{}) {
|
|
||||||
w.l.Errorf(ctx, msg, args...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *omitLogger) Fatalf(ctx context.Context, msg string, args ...interface{}) {
|
|
||||||
w.l.Fatalf(ctx, msg, args...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *omitLogger) Log(ctx context.Context, level Level, args ...interface{}) {
|
|
||||||
w.l.Log(ctx, level, args...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *omitLogger) Logf(ctx context.Context, level Level, msg string, args ...interface{}) {
|
|
||||||
w.l.Logf(ctx, level, msg, args...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *omitLogger) String() string {
|
|
||||||
return w.l.String()
|
|
||||||
}
|
|
||||||
|
|
||||||
type omitWrapper struct{}
|
|
||||||
|
|
||||||
func NewOmitWrapper() Wrapper {
|
|
||||||
return &omitWrapper{}
|
|
||||||
}
|
|
||||||
|
|
||||||
func getArgs(args []interface{}) []interface{} {
|
|
||||||
nargs := make([]interface{}, 0, len(args))
|
|
||||||
var err error
|
|
||||||
for _, arg := range args {
|
|
||||||
val := reflect.ValueOf(arg)
|
|
||||||
if val.Kind() == reflect.Ptr {
|
|
||||||
val = val.Elem()
|
|
||||||
}
|
|
||||||
narg := arg
|
|
||||||
if val.Kind() != reflect.Struct {
|
|
||||||
nargs = append(nargs, narg)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
if narg, err = rutil.Zero(arg); err != nil {
|
|
||||||
nargs = append(nargs, narg)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
rutil.CopyDefaults(narg, arg)
|
|
||||||
if flds, ferr := rutil.StructFields(narg); ferr == nil {
|
|
||||||
for _, fld := range flds {
|
|
||||||
if tv, ok := fld.Field.Tag.Lookup("logger"); ok && tv == "omit" {
|
|
||||||
fld.Value.Set(reflect.Zero(fld.Value.Type()))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
nargs = append(nargs, narg)
|
|
||||||
}
|
|
||||||
return nargs
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *omitWrapper) Log(fn LogFunc) LogFunc {
|
|
||||||
return func(ctx context.Context, level Level, args ...interface{}) {
|
|
||||||
fn(ctx, level, getArgs(args)...)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *omitWrapper) Logf(fn LogfFunc) LogfFunc {
|
|
||||||
return func(ctx context.Context, level Level, msg string, args ...interface{}) {
|
|
||||||
fn(ctx, level, msg, getArgs(args)...)
|
|
||||||
}
|
|
||||||
}
|
|
@@ -11,6 +11,7 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
|
// DefaultClientCallObserver called by wrapper in client Call
|
||||||
DefaultClientCallObserver = func(ctx context.Context, req client.Request, rsp interface{}, opts []client.CallOption, err error) []string {
|
DefaultClientCallObserver = func(ctx context.Context, req client.Request, rsp interface{}, opts []client.CallOption, err error) []string {
|
||||||
labels := []string{"service", req.Service(), "endpoint", req.Endpoint()}
|
labels := []string{"service", req.Service(), "endpoint", req.Endpoint()}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -19,6 +20,7 @@ var (
|
|||||||
return labels
|
return labels
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// DefaultClientStreamObserver called by wrapper in client Stream
|
||||||
DefaultClientStreamObserver = func(ctx context.Context, req client.Request, opts []client.CallOption, stream client.Stream, err error) []string {
|
DefaultClientStreamObserver = func(ctx context.Context, req client.Request, opts []client.CallOption, stream client.Stream, err error) []string {
|
||||||
labels := []string{"service", req.Service(), "endpoint", req.Endpoint()}
|
labels := []string{"service", req.Service(), "endpoint", req.Endpoint()}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -27,6 +29,7 @@ var (
|
|||||||
return labels
|
return labels
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// DefaultClientPublishObserver called by wrapper in client Publish
|
||||||
DefaultClientPublishObserver = func(ctx context.Context, msg client.Message, opts []client.PublishOption, err error) []string {
|
DefaultClientPublishObserver = func(ctx context.Context, msg client.Message, opts []client.PublishOption, err error) []string {
|
||||||
labels := []string{"endpoint", msg.Topic()}
|
labels := []string{"endpoint", msg.Topic()}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -35,6 +38,7 @@ var (
|
|||||||
return labels
|
return labels
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// DefaultServerHandlerObserver called by wrapper in server Handler
|
||||||
DefaultServerHandlerObserver = func(ctx context.Context, req server.Request, rsp interface{}, err error) []string {
|
DefaultServerHandlerObserver = func(ctx context.Context, req server.Request, rsp interface{}, err error) []string {
|
||||||
labels := []string{"service", req.Service(), "endpoint", req.Endpoint()}
|
labels := []string{"service", req.Service(), "endpoint", req.Endpoint()}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -43,6 +47,7 @@ var (
|
|||||||
return labels
|
return labels
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// DefaultServerSubscriberObserver called by wrapper in server Subscriber
|
||||||
DefaultServerSubscriberObserver = func(ctx context.Context, msg server.Message, err error) []string {
|
DefaultServerSubscriberObserver = func(ctx context.Context, msg server.Message, err error) []string {
|
||||||
labels := []string{"endpoint", msg.Topic()}
|
labels := []string{"endpoint", msg.Topic()}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -51,6 +56,7 @@ var (
|
|||||||
return labels
|
return labels
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// DefaultClientCallFuncObserver called by wrapper in client CallFunc
|
||||||
DefaultClientCallFuncObserver = func(ctx context.Context, addr string, req client.Request, rsp interface{}, opts client.CallOptions, err error) []string {
|
DefaultClientCallFuncObserver = func(ctx context.Context, addr string, req client.Request, rsp interface{}, opts client.CallOptions, err error) []string {
|
||||||
labels := []string{"service", req.Service(), "endpoint", req.Endpoint()}
|
labels := []string{"service", req.Service(), "endpoint", req.Endpoint()}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -59,7 +65,8 @@ var (
|
|||||||
return labels
|
return labels
|
||||||
}
|
}
|
||||||
|
|
||||||
DefaultSkipEndpoints = []string{"Meter.Metrics"}
|
// DefaultSkipEndpoints wrapper not called for this endpoints
|
||||||
|
DefaultSkipEndpoints = []string{"Meter.Metrics", "Health.Live", "Health.Ready", "Health.Version"}
|
||||||
)
|
)
|
||||||
|
|
||||||
type lWrapper struct {
|
type lWrapper struct {
|
||||||
@@ -71,11 +78,17 @@ type lWrapper struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
type (
|
type (
|
||||||
ClientCallObserver func(context.Context, client.Request, interface{}, []client.CallOption, error) []string
|
// ClientCallObserver func signature
|
||||||
ClientStreamObserver func(context.Context, client.Request, []client.CallOption, client.Stream, error) []string
|
ClientCallObserver func(context.Context, client.Request, interface{}, []client.CallOption, error) []string
|
||||||
ClientPublishObserver func(context.Context, client.Message, []client.PublishOption, error) []string
|
// ClientStreamObserver func signature
|
||||||
ClientCallFuncObserver func(context.Context, string, client.Request, interface{}, client.CallOptions, error) []string
|
ClientStreamObserver func(context.Context, client.Request, []client.CallOption, client.Stream, error) []string
|
||||||
ServerHandlerObserver func(context.Context, server.Request, interface{}, error) []string
|
// ClientPublishObserver func signature
|
||||||
|
ClientPublishObserver func(context.Context, client.Message, []client.PublishOption, error) []string
|
||||||
|
// ClientCallFuncObserver func signature
|
||||||
|
ClientCallFuncObserver func(context.Context, string, client.Request, interface{}, client.CallOptions, error) []string
|
||||||
|
// ServerHandlerObserver func signature
|
||||||
|
ServerHandlerObserver func(context.Context, server.Request, interface{}, error) []string
|
||||||
|
// ServerSubscriberObserver func signature
|
||||||
ServerSubscriberObserver func(context.Context, server.Message, error) []string
|
ServerSubscriberObserver func(context.Context, server.Message, error) []string
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -215,11 +228,7 @@ func (l *lWrapper) Call(ctx context.Context, req client.Request, rsp interface{}
|
|||||||
for _, o := range l.opts.ClientCallObservers {
|
for _, o := range l.opts.ClientCallObservers {
|
||||||
labels = append(labels, o(ctx, req, rsp, opts, err)...)
|
labels = append(labels, o(ctx, req, rsp, opts, err)...)
|
||||||
}
|
}
|
||||||
fields := make(map[string]interface{}, len(labels)/2)
|
l.opts.Logger.Fields(labels).Log(ctx, l.opts.Level)
|
||||||
for i := 0; i < len(labels); i += 2 {
|
|
||||||
fields[labels[i]] = labels[i+1]
|
|
||||||
}
|
|
||||||
l.opts.Logger.Fields(fields).Log(ctx, l.opts.Level)
|
|
||||||
|
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -242,11 +251,7 @@ func (l *lWrapper) Stream(ctx context.Context, req client.Request, opts ...clien
|
|||||||
for _, o := range l.opts.ClientStreamObservers {
|
for _, o := range l.opts.ClientStreamObservers {
|
||||||
labels = append(labels, o(ctx, req, opts, stream, err)...)
|
labels = append(labels, o(ctx, req, opts, stream, err)...)
|
||||||
}
|
}
|
||||||
fields := make(map[string]interface{}, len(labels)/2)
|
l.opts.Logger.Fields(labels).Log(ctx, l.opts.Level)
|
||||||
for i := 0; i < len(labels); i += 2 {
|
|
||||||
fields[labels[i]] = labels[i+1]
|
|
||||||
}
|
|
||||||
l.opts.Logger.Fields(fields).Log(ctx, l.opts.Level)
|
|
||||||
|
|
||||||
return stream, err
|
return stream, err
|
||||||
}
|
}
|
||||||
@@ -269,11 +274,7 @@ func (l *lWrapper) Publish(ctx context.Context, msg client.Message, opts ...clie
|
|||||||
for _, o := range l.opts.ClientPublishObservers {
|
for _, o := range l.opts.ClientPublishObservers {
|
||||||
labels = append(labels, o(ctx, msg, opts, err)...)
|
labels = append(labels, o(ctx, msg, opts, err)...)
|
||||||
}
|
}
|
||||||
fields := make(map[string]interface{}, len(labels)/2)
|
l.opts.Logger.Fields(labels).Log(ctx, l.opts.Level)
|
||||||
for i := 0; i < len(labels); i += 2 {
|
|
||||||
fields[labels[i]] = labels[i+1]
|
|
||||||
}
|
|
||||||
l.opts.Logger.Fields(fields).Log(ctx, l.opts.Level)
|
|
||||||
|
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -296,11 +297,7 @@ func (l *lWrapper) ServerHandler(ctx context.Context, req server.Request, rsp in
|
|||||||
for _, o := range l.opts.ServerHandlerObservers {
|
for _, o := range l.opts.ServerHandlerObservers {
|
||||||
labels = append(labels, o(ctx, req, rsp, err)...)
|
labels = append(labels, o(ctx, req, rsp, err)...)
|
||||||
}
|
}
|
||||||
fields := make(map[string]interface{}, len(labels)/2)
|
l.opts.Logger.Fields(labels).Log(ctx, l.opts.Level)
|
||||||
for i := 0; i < len(labels); i += 2 {
|
|
||||||
fields[labels[i]] = labels[i+1]
|
|
||||||
}
|
|
||||||
l.opts.Logger.Fields(fields).Log(ctx, l.opts.Level)
|
|
||||||
|
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -323,11 +320,7 @@ func (l *lWrapper) ServerSubscriber(ctx context.Context, msg server.Message) err
|
|||||||
for _, o := range l.opts.ServerSubscriberObservers {
|
for _, o := range l.opts.ServerSubscriberObservers {
|
||||||
labels = append(labels, o(ctx, msg, err)...)
|
labels = append(labels, o(ctx, msg, err)...)
|
||||||
}
|
}
|
||||||
fields := make(map[string]interface{}, len(labels)/2)
|
l.opts.Logger.Fields(labels).Log(ctx, l.opts.Level)
|
||||||
for i := 0; i < len(labels); i += 2 {
|
|
||||||
fields[labels[i]] = labels[i+1]
|
|
||||||
}
|
|
||||||
l.opts.Logger.Fields(fields).Log(ctx, l.opts.Level)
|
|
||||||
|
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -374,11 +367,7 @@ func (l *lWrapper) ClientCallFunc(ctx context.Context, addr string, req client.R
|
|||||||
for _, o := range l.opts.ClientCallFuncObservers {
|
for _, o := range l.opts.ClientCallFuncObservers {
|
||||||
labels = append(labels, o(ctx, addr, req, rsp, opts, err)...)
|
labels = append(labels, o(ctx, addr, req, rsp, opts, err)...)
|
||||||
}
|
}
|
||||||
fields := make(map[string]interface{}, len(labels)/2)
|
l.opts.Logger.Fields(labels).Log(ctx, l.opts.Level)
|
||||||
for i := 0; i < len(labels); i += 2 {
|
|
||||||
fields[labels[i]] = labels[i+1]
|
|
||||||
}
|
|
||||||
l.opts.Logger.Fields(fields).Log(ctx, l.opts.Level)
|
|
||||||
|
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
@@ -39,8 +39,6 @@ func FromOutgoingContext(ctx context.Context) (Metadata, bool) {
|
|||||||
|
|
||||||
// FromContext returns metadata from the given context
|
// FromContext returns metadata from the given context
|
||||||
// returned metadata shoud not be modified or race condition happens
|
// returned metadata shoud not be modified or race condition happens
|
||||||
//
|
|
||||||
// Deprecated: use FromIncomingContext or FromOutgoingContext
|
|
||||||
func FromContext(ctx context.Context) (Metadata, bool) {
|
func FromContext(ctx context.Context) (Metadata, bool) {
|
||||||
if ctx == nil {
|
if ctx == nil {
|
||||||
return nil, false
|
return nil, false
|
||||||
@@ -53,8 +51,6 @@ func FromContext(ctx context.Context) (Metadata, bool) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// NewContext creates a new context with the given metadata
|
// NewContext creates a new context with the given metadata
|
||||||
//
|
|
||||||
// Deprecated: use NewIncomingContext or NewOutgoingContext
|
|
||||||
func NewContext(ctx context.Context, md Metadata) context.Context {
|
func NewContext(ctx context.Context, md Metadata) context.Context {
|
||||||
if ctx == nil {
|
if ctx == nil {
|
||||||
ctx = context.Background()
|
ctx = context.Background()
|
||||||
|
140
metadata/context_test.go
Normal file
140
metadata/context_test.go
Normal file
@@ -0,0 +1,140 @@
|
|||||||
|
package metadata
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestFromNilContext(t *testing.T) {
|
||||||
|
// nolint: staticcheck
|
||||||
|
c, ok := FromContext(nil)
|
||||||
|
if ok || c != nil {
|
||||||
|
t.Fatal("FromContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewNilContext(t *testing.T) {
|
||||||
|
// nolint: staticcheck
|
||||||
|
ctx := NewContext(nil, New(0))
|
||||||
|
|
||||||
|
c, ok := FromContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("NewContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFromContext(t *testing.T) {
|
||||||
|
ctx := context.WithValue(context.TODO(), mdKey{}, &rawMetadata{New(0)})
|
||||||
|
|
||||||
|
c, ok := FromContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("FromContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewContext(t *testing.T) {
|
||||||
|
ctx := NewContext(context.TODO(), New(0))
|
||||||
|
|
||||||
|
c, ok := FromContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("NewContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFromIncomingContext(t *testing.T) {
|
||||||
|
ctx := context.WithValue(context.TODO(), mdIncomingKey{}, &rawMetadata{New(0)})
|
||||||
|
|
||||||
|
c, ok := FromIncomingContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("FromIncomingContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFromOutgoingContext(t *testing.T) {
|
||||||
|
ctx := context.WithValue(context.TODO(), mdOutgoingKey{}, &rawMetadata{New(0)})
|
||||||
|
|
||||||
|
c, ok := FromOutgoingContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("FromOutgoingContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetIncomingContext(t *testing.T) {
|
||||||
|
md := New(1)
|
||||||
|
md.Set("key", "val")
|
||||||
|
ctx := context.WithValue(context.TODO(), mdIncomingKey{}, &rawMetadata{})
|
||||||
|
if !SetIncomingContext(ctx, md) {
|
||||||
|
t.Fatal("SetIncomingContext not works")
|
||||||
|
}
|
||||||
|
md, ok := FromIncomingContext(ctx)
|
||||||
|
if md == nil || !ok {
|
||||||
|
t.Fatal("SetIncomingContext not works")
|
||||||
|
} else if v, ok := md.Get("key"); !ok || v != "val" {
|
||||||
|
t.Fatal("SetIncomingContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetOutgoingContext(t *testing.T) {
|
||||||
|
md := New(1)
|
||||||
|
md.Set("key", "val")
|
||||||
|
ctx := context.WithValue(context.TODO(), mdOutgoingKey{}, &rawMetadata{})
|
||||||
|
if !SetOutgoingContext(ctx, md) {
|
||||||
|
t.Fatal("SetOutgoingContext not works")
|
||||||
|
}
|
||||||
|
md, ok := FromOutgoingContext(ctx)
|
||||||
|
if md == nil || !ok {
|
||||||
|
t.Fatal("SetOutgoingContext not works")
|
||||||
|
} else if v, ok := md.Get("key"); !ok || v != "val" {
|
||||||
|
t.Fatal("SetOutgoingContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewIncomingContext(t *testing.T) {
|
||||||
|
md := New(1)
|
||||||
|
md.Set("key", "val")
|
||||||
|
ctx := NewIncomingContext(context.TODO(), md)
|
||||||
|
|
||||||
|
c, ok := FromIncomingContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("NewIncomingContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewOutgoingContext(t *testing.T) {
|
||||||
|
md := New(1)
|
||||||
|
md.Set("key", "val")
|
||||||
|
ctx := NewOutgoingContext(context.TODO(), md)
|
||||||
|
|
||||||
|
c, ok := FromOutgoingContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("NewOutgoingContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAppendIncomingContext(t *testing.T) {
|
||||||
|
md := New(1)
|
||||||
|
md.Set("key1", "val1")
|
||||||
|
ctx := AppendIncomingContext(context.TODO(), "key2", "val2")
|
||||||
|
|
||||||
|
nmd, ok := FromIncomingContext(ctx)
|
||||||
|
if nmd == nil || !ok {
|
||||||
|
t.Fatal("AppendIncomingContext not works")
|
||||||
|
}
|
||||||
|
if v, ok := nmd.Get("key2"); !ok || v != "val2" {
|
||||||
|
t.Fatal("AppendIncomingContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAppendOutgoingContext(t *testing.T) {
|
||||||
|
md := New(1)
|
||||||
|
md.Set("key1", "val1")
|
||||||
|
ctx := AppendOutgoingContext(context.TODO(), "key2", "val2")
|
||||||
|
|
||||||
|
nmd, ok := FromOutgoingContext(ctx)
|
||||||
|
if nmd == nil || !ok {
|
||||||
|
t.Fatal("AppendOutgoingContext not works")
|
||||||
|
}
|
||||||
|
if v, ok := nmd.Get("key2"); !ok || v != "val2" {
|
||||||
|
t.Fatal("AppendOutgoingContext not works")
|
||||||
|
}
|
||||||
|
}
|
@@ -76,16 +76,23 @@ func (md Metadata) Get(key string) (string, bool) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Set is used to store value in metadata
|
// Set is used to store value in metadata
|
||||||
func (md Metadata) Set(key, val string) {
|
func (md Metadata) Set(kv ...string) {
|
||||||
md[textproto.CanonicalMIMEHeaderKey(key)] = val
|
if len(kv)%2 == 1 {
|
||||||
|
kv = kv[:len(kv)-1]
|
||||||
|
}
|
||||||
|
for idx := 0; idx < len(kv); idx += 2 {
|
||||||
|
md[textproto.CanonicalMIMEHeaderKey(kv[idx])] = kv[idx+1]
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Del is used to remove value from metadata
|
// Del is used to remove value from metadata
|
||||||
func (md Metadata) Del(key string) {
|
func (md Metadata) Del(keys ...string) {
|
||||||
// fast path
|
for _, key := range keys {
|
||||||
delete(md, key)
|
// fast path
|
||||||
// slow path
|
delete(md, key)
|
||||||
delete(md, textproto.CanonicalMIMEHeaderKey(key))
|
// slow path
|
||||||
|
delete(md, textproto.CanonicalMIMEHeaderKey(key))
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Copy makes a copy of the metadata
|
// Copy makes a copy of the metadata
|
||||||
@@ -129,13 +136,6 @@ func Pairs(kv ...string) (Metadata, bool) {
|
|||||||
return nil, false
|
return nil, false
|
||||||
}
|
}
|
||||||
md := New(len(kv) / 2)
|
md := New(len(kv) / 2)
|
||||||
var k string
|
md.Set(kv...)
|
||||||
for i, v := range kv {
|
|
||||||
if i%2 == 0 {
|
|
||||||
k = v
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
md.Set(k, v)
|
|
||||||
}
|
|
||||||
return md, true
|
return md, true
|
||||||
}
|
}
|
||||||
|
@@ -5,6 +5,21 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
func TestMetadataSetMultiple(t *testing.T) {
|
||||||
|
md := New(4)
|
||||||
|
md.Set("key1", "val1", "key2", "val2", "key3")
|
||||||
|
|
||||||
|
if v, ok := md.Get("key1"); !ok || v != "val1" {
|
||||||
|
t.Fatalf("invalid kv %#+v", md)
|
||||||
|
}
|
||||||
|
if v, ok := md.Get("key2"); !ok || v != "val2" {
|
||||||
|
t.Fatalf("invalid kv %#+v", md)
|
||||||
|
}
|
||||||
|
if _, ok := md.Get("key3"); ok {
|
||||||
|
t.Fatalf("invalid kv %#+v", md)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestAppend(t *testing.T) {
|
func TestAppend(t *testing.T) {
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
ctx = AppendIncomingContext(ctx, "key1", "val1", "key2", "val2")
|
ctx = AppendIncomingContext(ctx, "key1", "val1", "key2", "val2")
|
||||||
|
53
meter/context_test.go
Normal file
53
meter/context_test.go
Normal file
@@ -0,0 +1,53 @@
|
|||||||
|
package meter
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestFromNilContext(t *testing.T) {
|
||||||
|
// nolint: staticcheck
|
||||||
|
c, ok := FromContext(nil)
|
||||||
|
if ok || c != nil {
|
||||||
|
t.Fatal("FromContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewNilContext(t *testing.T) {
|
||||||
|
// nolint: staticcheck
|
||||||
|
ctx := NewContext(nil, NewMeter())
|
||||||
|
|
||||||
|
c, ok := FromContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("NewContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFromContext(t *testing.T) {
|
||||||
|
ctx := context.WithValue(context.TODO(), meterKey{}, NewMeter())
|
||||||
|
|
||||||
|
c, ok := FromContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("FromContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewContext(t *testing.T) {
|
||||||
|
ctx := NewContext(context.TODO(), NewMeter())
|
||||||
|
|
||||||
|
c, ok := FromContext(ctx)
|
||||||
|
if c == nil || !ok {
|
||||||
|
t.Fatal("NewContext not works")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetOption(t *testing.T) {
|
||||||
|
type key struct{}
|
||||||
|
o := SetOption(key{}, "test")
|
||||||
|
opts := &Options{}
|
||||||
|
o(opts)
|
||||||
|
|
||||||
|
if v, ok := opts.Context.Value(key{}).(string); !ok || v == "" {
|
||||||
|
t.Fatal("SetOption not works")
|
||||||
|
}
|
||||||
|
}
|
@@ -1,12 +0,0 @@
|
|||||||
package meter
|
|
||||||
|
|
||||||
//go:generate sh -c "protoc -I./handler -I../ -I$(go list -f '{{ .Dir }}' -m go.unistack.org/micro-proto/v3) --go-micro_out='components=micro|http|server',standalone=false,debug=true,paths=source_relative:./handler handler/handler.proto"
|
|
||||||
|
|
||||||
import (
|
|
||||||
|
|
||||||
// import required packages
|
|
||||||
_ "go.unistack.org/micro-proto/v3/api"
|
|
||||||
|
|
||||||
// import required packages
|
|
||||||
_ "go.unistack.org/micro-proto/v3/openapiv3"
|
|
||||||
)
|
|
@@ -1,67 +0,0 @@
|
|||||||
package handler // import "go.unistack.org/micro/v3/meter/handler"
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
|
|
||||||
"go.unistack.org/micro/v3/codec"
|
|
||||||
"go.unistack.org/micro/v3/errors"
|
|
||||||
"go.unistack.org/micro/v3/meter"
|
|
||||||
)
|
|
||||||
|
|
||||||
// guard to fail early
|
|
||||||
var _ MeterServer = &Handler{}
|
|
||||||
|
|
||||||
type Handler struct {
|
|
||||||
opts Options
|
|
||||||
}
|
|
||||||
|
|
||||||
type Option func(*Options)
|
|
||||||
|
|
||||||
type Options struct {
|
|
||||||
Meter meter.Meter
|
|
||||||
Name string
|
|
||||||
MeterOptions []meter.Option
|
|
||||||
}
|
|
||||||
|
|
||||||
func Meter(m meter.Meter) Option {
|
|
||||||
return func(o *Options) {
|
|
||||||
o.Meter = m
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func Name(name string) Option {
|
|
||||||
return func(o *Options) {
|
|
||||||
o.Name = name
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func MeterOptions(opts ...meter.Option) Option {
|
|
||||||
return func(o *Options) {
|
|
||||||
o.MeterOptions = append(o.MeterOptions, opts...)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewOptions(opts ...Option) Options {
|
|
||||||
options := Options{Meter: meter.DefaultMeter}
|
|
||||||
for _, o := range opts {
|
|
||||||
o(&options)
|
|
||||||
}
|
|
||||||
return options
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewHandler(opts ...Option) *Handler {
|
|
||||||
options := NewOptions(opts...)
|
|
||||||
return &Handler{opts: options}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (h *Handler) Metrics(ctx context.Context, req *codec.Frame, rsp *codec.Frame) error {
|
|
||||||
buf := bytes.NewBuffer(nil)
|
|
||||||
if err := h.opts.Meter.Write(buf, h.opts.MeterOptions...); err != nil {
|
|
||||||
return errors.InternalServerError(h.opts.Name, "%v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
rsp.Data = buf.Bytes()
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
@@ -1,24 +0,0 @@
|
|||||||
syntax = "proto3";
|
|
||||||
|
|
||||||
package micro.meter.handler;
|
|
||||||
option go_package = "go.unistack.org/micro/v3/meter/handler;handler";
|
|
||||||
|
|
||||||
import "api/annotations.proto";
|
|
||||||
import "openapiv3/annotations.proto";
|
|
||||||
import "codec/frame.proto";
|
|
||||||
|
|
||||||
service Meter {
|
|
||||||
rpc Metrics(micro.codec.Frame) returns (micro.codec.Frame) {
|
|
||||||
option (micro.openapiv3.openapiv3_operation) = {
|
|
||||||
operation_id: "Metrics";
|
|
||||||
responses: {
|
|
||||||
default: {
|
|
||||||
reference: {
|
|
||||||
_ref: "micro.codec.Frame";
|
|
||||||
};
|
|
||||||
};
|
|
||||||
};
|
|
||||||
};
|
|
||||||
option (micro.api.http) = { get: "/metrics"; };
|
|
||||||
};
|
|
||||||
};
|
|
@@ -1,32 +0,0 @@
|
|||||||
// Code generated by protoc-gen-go-micro. DO NOT EDIT.
|
|
||||||
// protoc-gen-go-micro version: v3.5.3
|
|
||||||
// source: handler.proto
|
|
||||||
|
|
||||||
package handler
|
|
||||||
|
|
||||||
import (
|
|
||||||
context "context"
|
|
||||||
api "go.unistack.org/micro/v3/api"
|
|
||||||
codec "go.unistack.org/micro/v3/codec"
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
MeterName = "Meter"
|
|
||||||
|
|
||||||
MeterEndpoints = []api.Endpoint{
|
|
||||||
{
|
|
||||||
Name: "Meter.Metrics",
|
|
||||||
Path: []string{"/metrics"},
|
|
||||||
Method: []string{"GET"},
|
|
||||||
Handler: "rpc",
|
|
||||||
},
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|
||||||
func NewMeterEndpoints() []api.Endpoint {
|
|
||||||
return MeterEndpoints
|
|
||||||
}
|
|
||||||
|
|
||||||
type MeterServer interface {
|
|
||||||
Metrics(ctx context.Context, req *codec.Frame, rsp *codec.Frame) error
|
|
||||||
}
|
|
@@ -1,35 +0,0 @@
|
|||||||
// Code generated by protoc-gen-go-micro. DO NOT EDIT.
|
|
||||||
// protoc-gen-go-micro version: v3.5.3
|
|
||||||
// source: handler.proto
|
|
||||||
|
|
||||||
package handler
|
|
||||||
|
|
||||||
import (
|
|
||||||
context "context"
|
|
||||||
api "go.unistack.org/micro/v3/api"
|
|
||||||
codec "go.unistack.org/micro/v3/codec"
|
|
||||||
server "go.unistack.org/micro/v3/server"
|
|
||||||
)
|
|
||||||
|
|
||||||
type meterServer struct {
|
|
||||||
MeterServer
|
|
||||||
}
|
|
||||||
|
|
||||||
func (h *meterServer) Metrics(ctx context.Context, req *codec.Frame, rsp *codec.Frame) error {
|
|
||||||
return h.MeterServer.Metrics(ctx, req, rsp)
|
|
||||||
}
|
|
||||||
|
|
||||||
func RegisterMeterServer(s server.Server, sh MeterServer, opts ...server.HandlerOption) error {
|
|
||||||
type meter interface {
|
|
||||||
Metrics(ctx context.Context, req *codec.Frame, rsp *codec.Frame) error
|
|
||||||
}
|
|
||||||
type Meter struct {
|
|
||||||
meter
|
|
||||||
}
|
|
||||||
h := &meterServer{sh}
|
|
||||||
var nopts []server.HandlerOption
|
|
||||||
for _, endpoint := range MeterEndpoints {
|
|
||||||
nopts = append(nopts, api.WithEndpoint(&endpoint))
|
|
||||||
}
|
|
||||||
return s.Handle(s.NewHandler(&Meter{h}, append(nopts, opts...)...))
|
|
||||||
}
|
|
@@ -11,7 +11,7 @@ import (
|
|||||||
|
|
||||||
var (
|
var (
|
||||||
// DefaultMeter is the default meter
|
// DefaultMeter is the default meter
|
||||||
DefaultMeter Meter = NewMeter()
|
DefaultMeter = NewMeter()
|
||||||
// DefaultAddress data will be made available on this host:port
|
// DefaultAddress data will be made available on this host:port
|
||||||
DefaultAddress = ":9090"
|
DefaultAddress = ":9090"
|
||||||
// DefaultPath the meter endpoint where the Meter data will be made available
|
// DefaultPath the meter endpoint where the Meter data will be made available
|
||||||
@@ -102,7 +102,7 @@ func (k byKey) Swap(i, j int) {
|
|||||||
k[i*2+1], k[j*2+1] = k[j*2+1], k[i*2+1]
|
k[i*2+1], k[j*2+1] = k[j*2+1], k[i*2+1]
|
||||||
}
|
}
|
||||||
|
|
||||||
// BuildLables used to sort labels and delete duplicates.
|
// BuildLabels used to sort labels and delete duplicates.
|
||||||
// Last value wins in case of duplicate label keys.
|
// Last value wins in case of duplicate label keys.
|
||||||
func BuildLabels(labels ...string) []string {
|
func BuildLabels(labels ...string) []string {
|
||||||
if len(labels)%2 == 1 {
|
if len(labels)%2 == 1 {
|
||||||
|
@@ -50,7 +50,7 @@ var (
|
|||||||
labelEndpoint = "endpoint"
|
labelEndpoint = "endpoint"
|
||||||
|
|
||||||
// DefaultSkipEndpoints contains list of endpoints that not evaluted by wrapper
|
// DefaultSkipEndpoints contains list of endpoints that not evaluted by wrapper
|
||||||
DefaultSkipEndpoints = []string{"Meter.Metrics"}
|
DefaultSkipEndpoints = []string{"Meter.Metrics", "Health.Live", "Health.Ready", "Health.Version"}
|
||||||
)
|
)
|
||||||
|
|
||||||
// Options struct
|
// Options struct
|
||||||
@@ -104,7 +104,7 @@ func Meter(m meter.Meter) Option {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// SkipEndpoint add endpoint to skip
|
// SkipEndoints add endpoint to skip
|
||||||
func SkipEndoints(eps ...string) Option {
|
func SkipEndoints(eps ...string) Option {
|
||||||
return func(o *Options) {
|
return func(o *Options) {
|
||||||
o.SkipEndpoints = append(o.SkipEndpoints, eps...)
|
o.SkipEndpoints = append(o.SkipEndpoints, eps...)
|
||||||
@@ -255,6 +255,7 @@ func (w *wrapper) Publish(ctx context.Context, p client.Message, opts ...client.
|
|||||||
}
|
}
|
||||||
|
|
||||||
// NewHandlerWrapper create new server handler wrapper
|
// NewHandlerWrapper create new server handler wrapper
|
||||||
|
// deprecated
|
||||||
func NewHandlerWrapper(opts ...Option) server.HandlerWrapper {
|
func NewHandlerWrapper(opts ...Option) server.HandlerWrapper {
|
||||||
handler := &wrapper{
|
handler := &wrapper{
|
||||||
opts: NewOptions(opts...),
|
opts: NewOptions(opts...),
|
||||||
@@ -262,6 +263,14 @@ func NewHandlerWrapper(opts ...Option) server.HandlerWrapper {
|
|||||||
return handler.HandlerFunc
|
return handler.HandlerFunc
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// NewServerHandlerWrapper create new server handler wrapper
|
||||||
|
func NewServerHandlerWrapper(opts ...Option) server.HandlerWrapper {
|
||||||
|
handler := &wrapper{
|
||||||
|
opts: NewOptions(opts...),
|
||||||
|
}
|
||||||
|
return handler.HandlerFunc
|
||||||
|
}
|
||||||
|
|
||||||
func (w *wrapper) HandlerFunc(fn server.HandlerFunc) server.HandlerFunc {
|
func (w *wrapper) HandlerFunc(fn server.HandlerFunc) server.HandlerFunc {
|
||||||
return func(ctx context.Context, req server.Request, rsp interface{}) error {
|
return func(ctx context.Context, req server.Request, rsp interface{}) error {
|
||||||
endpoint := req.Service() + "." + req.Endpoint()
|
endpoint := req.Service() + "." + req.Endpoint()
|
||||||
@@ -294,7 +303,8 @@ func (w *wrapper) HandlerFunc(fn server.HandlerFunc) server.HandlerFunc {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewSubscribeWrapper create server subscribe wrapper
|
// NewSubscriberWrapper create server subscribe wrapper
|
||||||
|
// deprecated
|
||||||
func NewSubscriberWrapper(opts ...Option) server.SubscriberWrapper {
|
func NewSubscriberWrapper(opts ...Option) server.SubscriberWrapper {
|
||||||
handler := &wrapper{
|
handler := &wrapper{
|
||||||
opts: NewOptions(opts...),
|
opts: NewOptions(opts...),
|
||||||
@@ -302,6 +312,13 @@ func NewSubscriberWrapper(opts ...Option) server.SubscriberWrapper {
|
|||||||
return handler.SubscriberFunc
|
return handler.SubscriberFunc
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func NewServerSubscriberWrapper(opts ...Option) server.SubscriberWrapper {
|
||||||
|
handler := &wrapper{
|
||||||
|
opts: NewOptions(opts...),
|
||||||
|
}
|
||||||
|
return handler.SubscriberFunc
|
||||||
|
}
|
||||||
|
|
||||||
func (w *wrapper) SubscriberFunc(fn server.SubscriberFunc) server.SubscriberFunc {
|
func (w *wrapper) SubscriberFunc(fn server.SubscriberFunc) server.SubscriberFunc {
|
||||||
return func(ctx context.Context, msg server.Message) error {
|
return func(ctx context.Context, msg server.Message) error {
|
||||||
endpoint := msg.Topic()
|
endpoint := msg.Topic()
|
||||||
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user