Compare commits

...

19 Commits

Author SHA1 Message Date
a63ea1ec4d fix import paths
Signed-off-by: Vasiliy Tolstov <v.tolstov@unistack.org>
2021-10-23 23:34:05 +03:00
74fecbec12 cleanup deps
Signed-off-by: Vasiliy Tolstov <v.tolstov@unistack.org>
2021-10-23 23:30:16 +03:00
506f19310f some fixes
Signed-off-by: Vasiliy Tolstov <v.tolstov@unistack.org>
2021-10-23 23:21:10 +03:00
59ee7bc1de update to never micro-proto, generate openapi
Signed-off-by: Vasiliy Tolstov <v.tolstov@unistack.org>
2021-10-23 02:55:43 +03:00
github-actions[bot]
763ca7ff90 Merge pull request #23 from unistack-org/dependabot/github_actions/actions/github-script-5
Bump actions/github-script from 4 to 5
2021-09-27 15:27:45 +00:00
dependabot[bot]
af4f014e20 Bump actions/github-script from 4 to 5
Bumps [actions/github-script](https://github.com/actions/github-script) from 4 to 5.
- [Release notes](https://github.com/actions/github-script/releases)
- [Commits](https://github.com/actions/github-script/compare/v4...v5)

---
updated-dependencies:
- dependency-name: actions/github-script
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2021-09-27 15:26:58 +00:00
4329841a0b update workflow
Signed-off-by: Vasiliy Tolstov <v.tolstov@unistack.org>
2021-09-21 21:48:24 +03:00
452b8de530 update workflows
Signed-off-by: Vasiliy Tolstov <v.tolstov@unistack.org>
2021-09-17 07:49:57 +03:00
db8b8dbdd2 enable automerge
Signed-off-by: Vasiliy Tolstov <v.tolstov@unistack.org>
2021-09-16 11:08:29 +03:00
dependabot[bot]
c69b0656a4 Bump github.com/unistack-org/micro-proto from 0.0.8 to 0.0.9 (#22) 2021-09-06 14:51:43 +00:00
3512d60b3a add github stuff
Signed-off-by: Vasiliy Tolstov <v.tolstov@unistack.org>
2021-09-06 15:28:24 +03:00
2112172891 add github stuff
Signed-off-by: Vasiliy Tolstov <v.tolstov@unistack.org>
2021-09-06 10:37:30 +03:00
5d13b84c7a add micro.codec.Frame special type handling
Signed-off-by: Vasiliy Tolstov <v.tolstov@unistack.org>
2021-08-31 20:39:56 +03:00
ee4d83458f fix tag for nested messages
Signed-off-by: Vasiliy Tolstov <v.tolstov@unistack.org>
2021-08-31 19:40:20 +03:00
dd62c380f2 lint fixes
Signed-off-by: Vasiliy Tolstov <v.tolstov@unistack.org>
2021-08-20 23:03:11 +03:00
e4f2867419 update
Signed-off-by: Vasiliy Tolstov <v.tolstov@unistack.org>
2021-08-17 00:58:23 +03:00
c5f68efd4c update with never micro-proto
Signed-off-by: Vasiliy Tolstov <v.tolstov@unistack.org>
2021-08-17 00:10:01 +03:00
140c5fb90a update to latest micro-protoc
Signed-off-by: Vasiliy Tolstov <v.tolstov@unistack.org>
2021-08-16 23:34:32 +03:00
b4231422b3 add ServiceName variable
Signed-off-by: Vasiliy Tolstov <v.tolstov@unistack.org>
2021-07-14 13:49:37 +03:00
14 changed files with 957 additions and 163 deletions

19
.github/dependabot.yml vendored Normal file
View File

@@ -0,0 +1,19 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
version: 2
updates:
# Maintain dependencies for GitHub Actions
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
# Maintain dependencies for Golang
- package-ecosystem: "gomod"
directory: "/"
schedule:
interval: "daily"

20
.github/renovate.json vendored
View File

@@ -1,20 +0,0 @@
{
"extends": [
"config:base"
],
"postUpdateOptions": ["gomodTidy"],
"packageRules": [
{
"matchUpdateTypes": ["minor", "patch", "pin", "digest"],
"automerge": true
},
{
"groupName": "all deps",
"separateMajorMinor": true,
"groupSlug": "all",
"packagePatterns": [
"*"
]
}
]
}

75
.github/workflows/codeql-analysis.yml vendored Normal file
View File

@@ -0,0 +1,75 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
#
# ******** NOTE ********
# We have attempted to detect the languages in your repository. Please check
# the `language` matrix defined below to confirm you have the correct set of
# supported CodeQL languages.
#
name: "CodeQL"
on:
workflow_run:
workflows: ["prbuild"]
types:
- completed
push:
branches: [ master ]
pull_request:
# The branches below must be a subset of the branches above
branches: [ master ]
schedule:
- cron: '34 1 * * 0'
jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest
permissions:
actions: read
contents: read
security-events: write
strategy:
fail-fast: false
matrix:
language: [ 'go' ]
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
# Learn more:
# https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
steps:
- name: Checkout repository
uses: actions/checkout@v2
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# queries: ./path/to/local/query, your-org/your-repo/queries@main
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v1
# Command-line programs to run using the OS shell.
# 📚 https://git.io/JvXDl
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
# and modify them (or add more) to build your code if your project
# uses a compiled language
#- run: |
# make bootstrap
# make release
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1

View File

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

2
.gitignore vendored
View File

@@ -34,5 +34,5 @@ _cgo_export.*
*~
*.swp
*.swo
/protoc-gen-micro
/protoc-gen-go-micro

75
ast.go
View File

@@ -10,52 +10,63 @@ import (
"strings"
"github.com/fatih/structtag"
tag_options "github.com/unistack-org/micro-proto/tag"
tag_options "go.unistack.org/micro-proto/v3/tag"
"google.golang.org/protobuf/compiler/protogen"
"google.golang.org/protobuf/proto"
)
var (
astFields = make(map[string]map[string]map[string]*structtag.Tags) // map proto file with proto message ast struct
)
var astFields = make(map[string]map[string]map[string]*structtag.Tags) // map proto file with proto message ast struct
func (g *Generator) astFill(file *protogen.File, message *protogen.Message) error {
for _, field := range message.Fields {
if field.Desc.Options() == nil {
continue
}
if !proto.HasExtension(field.Desc.Options(), tag_options.E_Tags) {
continue
}
opts := proto.GetExtension(field.Desc.Options(), tag_options.E_Tags)
if opts != nil {
fpath := filepath.Join(g.tagPath, file.GeneratedFilenamePrefix+".pb.go")
mp, ok := astFields[fpath]
if !ok {
mp = make(map[string]map[string]*structtag.Tags)
}
nmp, ok := mp[message.GoIdent.GoName]
if !ok {
nmp = make(map[string]*structtag.Tags)
}
tags, err := structtag.Parse(opts.(string))
if err != nil {
return err
}
nmp[field.GoName] = tags
mp[message.GoIdent.GoName] = nmp
astFields[fpath] = mp
}
}
for _, nmessage := range message.Messages {
if err := g.astFill(file, nmessage); err != nil {
return err
}
}
return nil
}
func (g *Generator) astGenerate(plugin *protogen.Plugin) error {
if g.tagPath == "" {
return nil
}
for _, file := range plugin.Files {
if !file.Generate {
continue
}
for _, message := range file.Messages {
for _, field := range message.Fields {
if field.Desc.Options() == nil {
continue
}
if !proto.HasExtension(field.Desc.Options(), tag_options.E_Tags) {
continue
}
opts := proto.GetExtension(field.Desc.Options(), tag_options.E_Tags)
if opts != nil {
fpath := filepath.Join(g.tagPath, file.GeneratedFilenamePrefix+".pb.go")
mp, ok := astFields[fpath]
if !ok {
mp = make(map[string]map[string]*structtag.Tags)
}
nmp, ok := mp[message.GoIdent.GoName]
if !ok {
nmp = make(map[string]*structtag.Tags)
}
tags, err := structtag.Parse(opts.(string))
if err != nil {
return err
}
nmp[field.GoName] = tags
mp[message.GoIdent.GoName] = nmp
astFields[fpath] = mp
}
if err := g.astFill(file, message); err != nil {
return err
}
}
}

View File

@@ -11,7 +11,7 @@ import "google/protobuf/wrappers.proto";
service Example {
rpc Call(CallReq) returns (CallRsp) {
option (micro.openapiv2.openapiv2_operation) = {
option (micro.openapiv3.openapiv3_operation) = {
operation_id: "Call";
responses: {
key: "default";

9
go.mod
View File

@@ -1,12 +1,13 @@
module github.com/unistack-org/protoc-gen-go-micro/v3
module go.unistack.org/protoc-gen-go-micro/v3
go 1.16
require (
github.com/fatih/structtag v1.2.0
github.com/unistack-org/micro-proto v0.0.2
go.unistack.org/micro-proto/v3 v3.1.0
golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
google.golang.org/protobuf v1.26.0
google.golang.org/protobuf v1.27.1
)
//replace github.com/unistack-org/micro-proto => ../micro-proto
//replace go.unistack.org/micro/v3 => ../micro
//replace go.unistack.org/micro-proto => ../micro-proto

70
go.sum
View File

@@ -1,75 +1,13 @@
cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw=
github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU=
github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw=
github.com/envoyproxy/go-control-plane v0.9.1-0.20191026205805-5f8ba28d4473/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4=
github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c=
github.com/fatih/structtag v1.2.0 h1:/OdNE99OxoI/PqaW/SuSK9uxxT3f/tcSZgon/ssNSx4=
github.com/fatih/structtag v1.2.0/go.mod h1:mBJUNpUnHmRKrKlQQlmCrh5PuhftFbNv8Ys4/aAZl94=
github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q=
github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A=
github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
github.com/golang/protobuf v1.3.2/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
github.com/golang/protobuf v1.4.0-rc.1/go.mod h1:ceaxUfeHdC40wWswd/P6IGgMaK3YpKi5j83Wpe3EHw8=
github.com/golang/protobuf v1.4.0-rc.1.0.20200221234624-67d41d38c208/go.mod h1:xKAWHe0F5eneWXFV3EuXVDTCmh+JuBKY0li0aMyXATA=
github.com/golang/protobuf v1.4.0-rc.2/go.mod h1:LlEzMj4AhA7rCAGe4KMBDvJI+AwstrUpVNzEA03Pprs=
github.com/golang/protobuf v1.4.0-rc.4.0.20200313231945-b860323f09d0/go.mod h1:WU3c8KckQ9AFe+yFwt9sWVRKCVIyN9cPHBJSNnbL67w=
github.com/golang/protobuf v1.4.0/go.mod h1:jodUvKwWbYaEsadDk5Fwe5c77LiNKVO9IDvqG2KuDX0=
github.com/golang/protobuf v1.4.1/go.mod h1:U8fpvMrcmy5pZrNK1lt4xCsGvpyWQ/VVv6QDs8UjoX8=
github.com/golang/protobuf v1.4.3/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw735rRwI=
github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=
github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M=
github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
github.com/google/go-cmp v0.3.1/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
github.com/google/go-cmp v0.4.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
github.com/google/go-cmp v0.5.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
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/prometheus/client_model v0.0.0-20190812154241-14fe0d1b01d4/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA=
github.com/unistack-org/micro-proto v0.0.2 h1:mL1ZPRGPCWJOiMBiJrkk8Y513rPrJmhJWxyLceckAXU=
github.com/unistack-org/micro-proto v0.0.2/go.mod h1:GYO53DWmeldRIo90cAdQx8bLr/WJMxW62W4ja74p1Ac=
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE=
golang.org/x/lint v0.0.0-20190227174305-5b3e6a55c961/go.mod h1:wehouNa3lNwaWXcvxsM5YxQ5yQlVC4a0KAMCusXpPoU=
golang.org/x/lint v0.0.0-20190313153728-d0100b6bd8b3/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc=
golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
golang.org/x/net v0.0.0-20190213061140-3a22650c66bd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
golang.org/x/tools v0.0.0-20190226205152-f727befe758c/go.mod h1:9Yl7xja0Znq3iFh3HoIrodX9oNMXvdceNzlUR8zjMvY=
golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
golang.org/x/tools v0.0.0-20190524140312-2c0ae7006135/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q=
go.unistack.org/micro-proto/v3 v3.1.0 h1:q39FwjFiRZn+Ux/tt+d3bJTmDtsQQWa+3SLYVo1vLfA=
go.unistack.org/micro-proto/v3 v3.1.0/go.mod h1:DpRhYCBXlmSJ/AAXTmntvlh7kQkYU6eFvlmYAx4BQS8=
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/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM=
google.golang.org/appengine v1.4.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4=
google.golang.org/genproto v0.0.0-20180817151627-c66870c02cf8/go.mod h1:JiN7NxoALGmiZfu7CAH4rXhgtRTLTxftemlI0sWmxmc=
google.golang.org/genproto v0.0.0-20190819201941-24fa4b261c55/go.mod h1:DMBHOl98Agz4BDEuKkezgsaosCRResVns1a3J2ZsMNc=
google.golang.org/genproto v0.0.0-20200526211855-cb27e3aa2013/go.mod h1:NbSheEEYHJ7i3ixzK3sjbqSGDJWnxyFXZblF3eUsNvo=
google.golang.org/grpc v1.19.0/go.mod h1:mqu4LbDTu4XGKhr4mRzUsmM4RtVoemTSY81AxZiDr8c=
google.golang.org/grpc v1.23.0/go.mod h1:Y5yQAOtifL1yxbo5wqy6BxZv8vAUGQwXBOALyacEbxg=
google.golang.org/grpc v1.27.0/go.mod h1:qbnxyOmOxrQa7FizSgH+ReBfzJrCY1pSN7KXBS8abTk=
google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8=
google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0=
google.golang.org/protobuf v0.0.0-20200228230310-ab0ca4ff8a60/go.mod h1:cfTl7dwQJ+fmap5saPgwCLgHXTUD7jkjRqWcaiX5VyM=
google.golang.org/protobuf v1.20.1-0.20200309200217-e05f789c0967/go.mod h1:A+miEFZTKqfCUM6K7xSMQL9OKL/b6hQv+e19PK+JZNE=
google.golang.org/protobuf v1.21.0/go.mod h1:47Nbq4nVaFHyn7ilMalzfO3qCViNmqZ2kzikPIcrTAo=
google.golang.org/protobuf v1.22.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU=
google.golang.org/protobuf v1.23.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU=
google.golang.org/protobuf v1.23.1-0.20200526195155-81db48ad09cc/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU=
google.golang.org/protobuf v1.25.0/go.mod h1:9JNX74DMeImyA3h4bdi1ymwjUzf21/xIlbajtzgsN7c=
google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
google.golang.org/protobuf v1.26.0 h1:bxAC2xTBsZGibn2RTntX0oH50xLsqy1OxA9tTL3p/lk=
google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
honnef.co/go/tools v0.0.0-20190523083050-ea95bdfd59fc/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
google.golang.org/protobuf v1.27.1 h1:SnqbnDw1V7RiZcXPx5MEeqPv2s79L9i7BJUlG/+RurQ=
google.golang.org/protobuf v1.27.1/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=

View File

@@ -29,6 +29,7 @@ func (g *Generator) httpGenerate(component string, plugin *protogen.Plugin, genC
gfile.Import(contextPackage)
gfile.Import(microApiPackage)
if genClient {
gfile.Import(microClientPackage)
gfile.Import(microClientHttpPackage)

29
main.go
View File

@@ -10,10 +10,12 @@ import (
)
var (
flagDebug = flag.Bool("debug", false, "")
flagStandalone = flag.Bool("standalone", false, "")
flagComponents = flag.String("components", "micro|rpc|http|client|server", "")
flagTagPath = flag.String("tag_path", "", "")
flagDebug = flag.Bool("debug", false, "debug output")
flagStandalone = flag.Bool("standalone", false, "generate file to standalone dir")
flagComponents = flag.String("components", "micro|rpc|http|client|server|openapiv3", "specify components to generate")
flagTagPath = flag.String("tag_path", "", "tag rewriting dir")
flagOpenapiFile = flag.String("openapi_file", "apidocs.swagger.json", "openapi file name")
flagHelp = flag.Bool("help", false, "display help message")
)
func main() {
@@ -21,16 +23,24 @@ func main() {
ParamFunc: flag.CommandLine.Set,
}
flag.Parse()
if *flagHelp {
flag.PrintDefaults()
return
}
g := &Generator{}
opts.Run(g.Generate)
}
type Generator struct {
components string
standalone bool
debug bool
tagPath string
components string
standalone bool
debug bool
tagPath string
openapiFile string
}
func (g *Generator) Generate(plugin *protogen.Plugin) error {
@@ -40,6 +50,7 @@ func (g *Generator) Generate(plugin *protogen.Plugin) error {
g.debug = *flagDebug
g.components = *flagComponents
g.tagPath = *flagTagPath
g.openapiFile = *flagOpenapiFile
plugin.SupportedFeatures = uint64(pluginpb.CodeGeneratorResponse_FEATURE_PROTO3_OPTIONAL)
var genClient bool
@@ -73,6 +84,8 @@ func (g *Generator) Generate(plugin *protogen.Plugin) error {
err = g.gorillaGenerate(component, plugin)
case "chi":
err = g.chiGenerate(component, plugin)
case "openapiv3":
err = g.openapiv3Generate(component, plugin)
default:
err = fmt.Errorf("unknown component: %s", component)
}

673
openapiv3.go Normal file
View File

@@ -0,0 +1,673 @@
// Copyright 2020 Google LLC. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
package main
import (
"fmt"
"log"
"net/http"
"regexp"
"sort"
"strings"
annotations "go.unistack.org/micro-proto/v3/api"
v3 "go.unistack.org/micro-proto/v3/openapiv3"
"google.golang.org/protobuf/compiler/protogen"
jsonpb "google.golang.org/protobuf/encoding/protojson"
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/reflect/protoreflect"
)
type openapiv3Generator struct {
plugin *protogen.Plugin
requiredSchemas []string // Names of schemas that need to be generated.
generatedSchemas []string // Names of schemas that have already been generated.
linterRulePattern *regexp.Regexp
namePattern *regexp.Regexp
}
func (g *Generator) openapiv3Generate(component string, plugin *protogen.Plugin) error {
og := &openapiv3Generator{
plugin: plugin,
requiredSchemas: make([]string, 0),
generatedSchemas: make([]string, 0),
linterRulePattern: regexp.MustCompile(`\(-- .* --\)`),
namePattern: regexp.MustCompile("{(.*)=(.*)}"),
}
d := og.buildDocumentV3(plugin)
bytes, err := (jsonpb.MarshalOptions{Indent: " "}).Marshal(d)
if err != nil {
return fmt.Errorf("failed to marshal: %s", err.Error())
}
outputFile := og.plugin.NewGeneratedFile(g.openapiFile, "")
if _, err := outputFile.Write(bytes); err != nil {
return fmt.Errorf("failed to write: %s", err.Error())
}
return nil
}
// buildDocumentV3 builds an OpenAPIv3 document for a plugin request.
func (g *openapiv3Generator) buildDocumentV3(plugin *protogen.Plugin) *v3.Document {
d := &v3.Document{}
d.Openapi = "3.0.3"
d.Info = &v3.Info{
Title: "",
Version: "0.0.1",
Description: "",
}
for _, file := range plugin.Files {
if !proto.HasExtension(file.Desc.Options(), v3.E_Openapiv3Swagger) {
continue
}
ext := proto.GetExtension(file.Desc.Options(), v3.E_Openapiv3Swagger)
if ext == nil {
continue
}
if doc, ok := ext.(*v3.Document); ok && doc != nil {
if doc.Openapi != "" {
d.Openapi = doc.Openapi
}
d.Info = proto.Clone(doc.Info).(*v3.Info)
d.Servers = append(d.Servers, doc.Servers...)
}
}
d.Paths = &v3.Paths{}
d.Components = &v3.Components{
Schemas: &v3.SchemasOrReferences{
AdditionalProperties: []*v3.NamedSchemaOrReference{},
},
}
for _, file := range g.plugin.Files {
g.addPathsToDocumentV3(d, file)
}
for len(g.requiredSchemas) > 0 {
count := len(g.requiredSchemas)
for _, file := range g.plugin.Files {
g.addSchemasToDocumentV3(d, file)
}
g.requiredSchemas = g.requiredSchemas[count:len(g.requiredSchemas)]
}
// Sort the paths.
{
pairs := d.Paths.Path
sort.Slice(pairs, func(i, j int) bool {
return pairs[i].Name < pairs[j].Name
})
d.Paths.Path = pairs
}
// Sort the schemas.
{
pairs := d.Components.Schemas.AdditionalProperties
sort.Slice(pairs, func(i, j int) bool {
return pairs[i].Name < pairs[j].Name
})
d.Components.Schemas.AdditionalProperties = pairs
}
return d
}
// filterCommentString removes line breaks and linter rules from comments.
func (g *openapiv3Generator) filterCommentString(c protogen.Comments) string {
comment := string(c)
comment = strings.Replace(comment, "\n", "", -1)
comment = g.linterRulePattern.ReplaceAllString(comment, "")
return strings.TrimSpace(comment)
}
// addPathsToDocumentV3 adds paths from a specified file descriptor.
func (g *openapiv3Generator) addPathsToDocumentV3(d *v3.Document, file *protogen.File) {
for _, service := range file.Services {
comment := g.filterCommentString(service.Comments.Leading)
if d.Info.Title == "" {
d.Info.Title = service.GoName
}
if d.Info.Description == "" {
d.Info.Description = comment
}
for _, method := range service.Methods {
comment := g.filterCommentString(method.Comments.Leading)
inputMessage := method.Input
outputMessage := method.Output
operationID := service.GoName + "_" + method.GoName
eopt := proto.GetExtension(method.Desc.Options(), v3.E_Openapiv3Operation)
if eopt != nil && eopt != v3.E_Openapiv3Operation.InterfaceOf(v3.E_Openapiv3Operation.Zero()) {
opt := eopt.(*v3.Operation)
if opt.OperationId != "" {
operationID = opt.OperationId
}
}
xt := annotations.E_Http
extension := proto.GetExtension(method.Desc.Options(), xt)
var path string
var methodName string
var body string
if extension != nil && extension != xt.InterfaceOf(xt.Zero()) {
rule := extension.(*annotations.HttpRule)
body = rule.Body
switch pattern := rule.Pattern.(type) {
case *annotations.HttpRule_Get:
path = pattern.Get
methodName = "GET"
case *annotations.HttpRule_Post:
path = pattern.Post
methodName = "POST"
case *annotations.HttpRule_Put:
path = pattern.Put
methodName = "PUT"
case *annotations.HttpRule_Delete:
path = pattern.Delete
methodName = "DELETE"
case *annotations.HttpRule_Patch:
path = pattern.Patch
methodName = "PATCH"
case *annotations.HttpRule_Custom:
path = "custom-unsupported"
default:
path = "unknown-unsupported"
}
}
if methodName != "" {
op, path2 := g.buildOperationV3(
file, method, operationID, comment, path, body, inputMessage, outputMessage)
g.addOperationV3(d, op, path2, methodName)
}
}
}
}
// buildOperationV3 constructs an operation for a set of values.
func (g *openapiv3Generator) buildOperationV3(
file *protogen.File,
method *protogen.Method,
operationID string,
description string,
path string,
bodyField string,
inputMessage *protogen.Message,
outputMessage *protogen.Message,
) (*v3.Operation, string) {
// coveredParameters tracks the parameters that have been used in the body or path.
coveredParameters := make([]string, 0)
if bodyField != "" {
coveredParameters = append(coveredParameters, bodyField)
}
// Initialize the list of operation parameters.
parameters := []*v3.ParameterOrReference{}
// Build a list of header parameters.
eopt := proto.GetExtension(method.Desc.Options(), v3.E_Openapiv3Operation)
if eopt != nil && eopt != v3.E_Openapiv3Operation.InterfaceOf(v3.E_Openapiv3Operation.Zero()) {
opt := eopt.(*v3.Operation)
parameters = append(parameters, opt.Parameters...)
}
// Build a list of path parameters.
pathParameters := make([]string, 0)
if matches := g.namePattern.FindStringSubmatch(path); matches != nil {
// Add the "name=" "name" value to the list of covered parameters.
coveredParameters = append(coveredParameters, matches[1])
// Convert the path from the starred form to use named path parameters.
starredPath := matches[2]
parts := strings.Split(starredPath, "/")
// The starred path is assumed to be in the form "things/*/otherthings/*".
// We want to convert it to "things/{thing}/otherthings/{otherthing}".
for i := 0; i < len(parts)-1; i += 2 {
section := parts[i]
parameter := singular(section)
parts[i+1] = "{" + parameter + "}"
pathParameters = append(pathParameters, parameter)
}
// Rewrite the path to use the path parameters.
newPath := strings.Join(parts, "/")
path = strings.Replace(path, matches[0], newPath, 1)
}
// Add the path parameters to the operation parameters.
for _, pathParameter := range pathParameters {
parameters = append(parameters,
&v3.ParameterOrReference{
Oneof: &v3.ParameterOrReference_Parameter{
Parameter: &v3.Parameter{
Name: pathParameter,
In: "path",
Required: true,
Description: "The " + pathParameter + " id.",
Schema: &v3.SchemaOrReference{
Oneof: &v3.SchemaOrReference_Schema{
Schema: &v3.Schema{
Type: "string",
},
},
},
},
},
})
}
// Add any unhandled fields in the request message as query parameters.
if bodyField != "*" {
for _, field := range inputMessage.Fields {
fieldName := string(field.Desc.Name())
if !contains(coveredParameters, fieldName) {
// Get the field description from the comments.
fieldDescription := g.filterCommentString(field.Comments.Leading)
parameters = append(parameters,
&v3.ParameterOrReference{
Oneof: &v3.ParameterOrReference_Parameter{
Parameter: &v3.Parameter{
Name: fieldName,
In: "query",
Description: fieldDescription,
Required: false,
Schema: &v3.SchemaOrReference{
Oneof: &v3.SchemaOrReference_Schema{
Schema: &v3.Schema{
Type: "string",
},
},
},
},
},
})
}
}
}
// Create the response.
responses := &v3.Responses{
ResponseOrReference: []*v3.NamedResponseOrReference{
&v3.NamedResponseOrReference{
Name: "200",
Value: &v3.ResponseOrReference{
Oneof: &v3.ResponseOrReference_Response{
Response: &v3.Response{
Description: "OK",
Content: g.responseContentForMessage(outputMessage),
},
},
},
},
},
}
// Create the operation.
op := &v3.Operation{
Summary: description,
OperationId: operationID,
Parameters: parameters,
Responses: responses,
}
// If a body field is specified, we need to pass a message as the request body.
if bodyField != "" {
var bodyFieldScalarTypeName string
var bodyFieldMessageTypeName string
if bodyField == "*" {
// Pass the entire request message as the request body.
bodyFieldMessageTypeName = g.fullMessageTypeName(inputMessage)
} else {
// If body refers to a message field, use that type.
for _, field := range inputMessage.Fields {
if string(field.Desc.Name()) == bodyField {
switch field.Desc.Kind() {
case protoreflect.StringKind:
bodyFieldScalarTypeName = "string"
case protoreflect.MessageKind:
bodyFieldMessageTypeName = g.fullMessageTypeName(field.Message)
default:
log.Printf("unsupported field type %+v", field.Desc)
}
break
}
}
}
var requestSchema *v3.SchemaOrReference
if bodyFieldScalarTypeName != "" {
requestSchema = &v3.SchemaOrReference{
Oneof: &v3.SchemaOrReference_Schema{
Schema: &v3.Schema{
Type: bodyFieldScalarTypeName,
},
},
}
} else if bodyFieldMessageTypeName != "" {
requestSchema = &v3.SchemaOrReference{
Oneof: &v3.SchemaOrReference_Reference{
Reference: &v3.Reference{
XRef: g.schemaReferenceForTypeName(bodyFieldMessageTypeName),
},
},
}
}
op.RequestBody = &v3.RequestBodyOrReference{
Oneof: &v3.RequestBodyOrReference_RequestBody{
RequestBody: &v3.RequestBody{
Required: true,
Content: &v3.MediaTypes{
AdditionalProperties: []*v3.NamedMediaType{
&v3.NamedMediaType{
Name: "application/json",
Value: &v3.MediaType{
Schema: requestSchema,
},
},
},
},
},
},
}
}
return op, path
}
// addOperationV3 adds an operation to the specified path/method.
func (g *openapiv3Generator) addOperationV3(d *v3.Document, op *v3.Operation, path string, methodName string) {
var selectedPathItem *v3.NamedPathItem
for _, namedPathItem := range d.Paths.Path {
if namedPathItem.Name == path {
selectedPathItem = namedPathItem
break
}
}
// If we get here, we need to create a path item.
if selectedPathItem == nil {
selectedPathItem = &v3.NamedPathItem{Name: path, Value: &v3.PathItem{}}
d.Paths.Path = append(d.Paths.Path, selectedPathItem)
}
// Set the operation on the specified method.
switch methodName {
case http.MethodGet:
selectedPathItem.Value.Get = op
case http.MethodPost:
selectedPathItem.Value.Post = op
case http.MethodPut:
selectedPathItem.Value.Put = op
case http.MethodDelete:
selectedPathItem.Value.Delete = op
case http.MethodPatch:
selectedPathItem.Value.Patch = op
}
}
// schemaReferenceForTypeName returns an OpenAPI JSON Reference to the schema that represents a type.
func (g *openapiv3Generator) schemaReferenceForTypeName(typeName string) string {
if !contains(g.requiredSchemas, typeName) {
g.requiredSchemas = append(g.requiredSchemas, typeName)
}
parts := strings.Split(typeName, ".")
lastPart := parts[len(parts)-1]
return "#/components/schemas/" + lastPart
}
// itemsItemForTypeName is a helper constructor.
func (g *openapiv3Generator) itemsItemForTypeName(typeName string) *v3.ItemsItem {
return &v3.ItemsItem{SchemaOrReference: []*v3.SchemaOrReference{&v3.SchemaOrReference{
Oneof: &v3.SchemaOrReference_Schema{
Schema: &v3.Schema{
Type: typeName,
},
},
}}}
}
// itemsItemForReference is a helper constructor.
func (g *openapiv3Generator) itemsItemForReference(xref string) *v3.ItemsItem {
return &v3.ItemsItem{SchemaOrReference: []*v3.SchemaOrReference{&v3.SchemaOrReference{
Oneof: &v3.SchemaOrReference_Reference{
Reference: &v3.Reference{
XRef: xref,
},
},
}}}
}
// fullMessageTypeName builds the full type name of a message.
func (g *openapiv3Generator) fullMessageTypeName(message *protogen.Message) string {
return "." + string(message.Desc.ParentFile().Package()) + "." + string(message.Desc.Name())
}
func (g *openapiv3Generator) responseContentForMessage(outputMessage *protogen.Message) *v3.MediaTypes {
typeName := g.fullMessageTypeName(outputMessage)
if typeName == ".google.protobuf.Empty" {
return &v3.MediaTypes{}
}
if typeName == ".google.api.HttpBody" || typeName == ".micro.codec.Frame" {
return &v3.MediaTypes{
AdditionalProperties: []*v3.NamedMediaType{
&v3.NamedMediaType{
Name: "application/octet-stream",
Value: &v3.MediaType{},
},
},
}
}
return &v3.MediaTypes{
AdditionalProperties: []*v3.NamedMediaType{
&v3.NamedMediaType{
Name: "application/json",
Value: &v3.MediaType{
Schema: &v3.SchemaOrReference{
Oneof: &v3.SchemaOrReference_Reference{
Reference: &v3.Reference{
XRef: g.schemaReferenceForTypeName(g.fullMessageTypeName(outputMessage)),
},
},
},
},
},
},
}
}
// addSchemasToDocumentV3 adds info from one file descriptor.
func (g *openapiv3Generator) addSchemasToDocumentV3(d *v3.Document, file *protogen.File) {
// For each message, generate a definition.
for _, message := range file.Messages {
typeName := g.fullMessageTypeName(message)
// Only generate this if we need it and haven't already generated it.
if !contains(g.requiredSchemas, typeName) ||
contains(g.generatedSchemas, typeName) {
continue
}
g.generatedSchemas = append(g.generatedSchemas, typeName)
// Get the message description from the comments.
messageDescription := g.filterCommentString(message.Comments.Leading)
// Build an array holding the fields of the message.
definitionProperties := &v3.Properties{
AdditionalProperties: make([]*v3.NamedSchemaOrReference, 0),
}
for _, field := range message.Fields {
// Check the field annotations to see if this is a readonly field.
outputOnly := false
extension := proto.GetExtension(field.Desc.Options(), annotations.E_FieldBehavior)
if extension != nil {
switch v := extension.(type) {
case []annotations.FieldBehavior:
for _, vv := range v {
if vv == annotations.FieldBehavior_OUTPUT_ONLY {
outputOnly = true
}
}
default:
log.Printf("unsupported extension type %T", extension)
}
}
// Get the field description from the comments.
fieldDescription := g.filterCommentString(field.Comments.Leading)
// The field is either described by a reference or a schema.
XRef := ""
fieldSchema := &v3.Schema{
Description: fieldDescription,
}
if outputOnly {
fieldSchema.ReadOnly = true
}
if field.Desc.IsList() {
fieldSchema.Type = "array"
switch field.Desc.Kind() {
case protoreflect.MessageKind:
fieldSchema.Items = g.itemsItemForReference(
g.schemaReferenceForTypeName(
g.fullMessageTypeName(field.Message)))
case protoreflect.StringKind:
fieldSchema.Items = g.itemsItemForTypeName("string")
case protoreflect.Int32Kind,
protoreflect.Sint32Kind,
protoreflect.Uint32Kind,
protoreflect.Int64Kind,
protoreflect.Sint64Kind,
protoreflect.Uint64Kind,
protoreflect.Sfixed32Kind,
protoreflect.Fixed32Kind,
protoreflect.Sfixed64Kind,
protoreflect.Fixed64Kind:
fieldSchema.Items = g.itemsItemForTypeName("integer")
case protoreflect.EnumKind:
fieldSchema.Items = g.itemsItemForTypeName("integer")
case protoreflect.BoolKind:
fieldSchema.Items = g.itemsItemForTypeName("boolean")
case protoreflect.FloatKind, protoreflect.DoubleKind:
fieldSchema.Items = g.itemsItemForTypeName("number")
case protoreflect.BytesKind:
fieldSchema.Items = g.itemsItemForTypeName("string")
default:
log.Printf("(TODO) Unsupported array type: %+v", g.fullMessageTypeName(field.Message))
}
} else if field.Desc.IsMap() &&
field.Desc.MapKey().Kind() == protoreflect.StringKind &&
field.Desc.MapValue().Kind() == protoreflect.StringKind {
fieldSchema.Type = "object"
} else {
k := field.Desc.Kind()
switch k {
case protoreflect.MessageKind:
typeName := g.fullMessageTypeName(field.Message)
switch typeName {
case ".google.protobuf.Timestamp":
// Timestamps are serialized as strings
fieldSchema.Type = "string"
fieldSchema.Format = "RFC3339"
case ".google.type.Date":
// Dates are serialized as strings
fieldSchema.Type = "string"
fieldSchema.Format = "date"
case ".google.type.DateTime":
// DateTimes are serialized as strings
fieldSchema.Type = "string"
fieldSchema.Format = "date-time"
default:
// The field is described by a reference.
XRef = g.schemaReferenceForTypeName(typeName)
}
case protoreflect.StringKind:
fieldSchema.Type = "string"
case protoreflect.Int32Kind,
protoreflect.Sint32Kind,
protoreflect.Uint32Kind,
protoreflect.Int64Kind,
protoreflect.Sint64Kind,
protoreflect.Uint64Kind,
protoreflect.Sfixed32Kind,
protoreflect.Fixed32Kind,
protoreflect.Sfixed64Kind,
protoreflect.Fixed64Kind:
fieldSchema.Type = "integer"
fieldSchema.Format = k.String()
case protoreflect.EnumKind:
fieldSchema.Type = "integer"
fieldSchema.Format = "enum"
case protoreflect.BoolKind:
fieldSchema.Type = "boolean"
case protoreflect.FloatKind, protoreflect.DoubleKind:
fieldSchema.Type = "number"
fieldSchema.Format = k.String()
case protoreflect.BytesKind:
fieldSchema.Type = "string"
fieldSchema.Format = "bytes"
default:
log.Printf("(TODO) Unsupported field type: %+v", g.fullMessageTypeName(field.Message))
}
}
var value *v3.SchemaOrReference
if XRef != "" {
value = &v3.SchemaOrReference{
Oneof: &v3.SchemaOrReference_Reference{
Reference: &v3.Reference{
XRef: XRef,
},
},
}
} else {
value = &v3.SchemaOrReference{
Oneof: &v3.SchemaOrReference_Schema{
Schema: fieldSchema,
},
}
}
definitionProperties.AdditionalProperties = append(
definitionProperties.AdditionalProperties,
&v3.NamedSchemaOrReference{
Name: string(field.Desc.Name()),
Value: value,
},
)
}
// Add the schema to the components.schema list.
d.Components.Schemas.AdditionalProperties = append(d.Components.Schemas.AdditionalProperties,
&v3.NamedSchemaOrReference{
Name: string(message.Desc.Name()),
Value: &v3.SchemaOrReference{
Oneof: &v3.SchemaOrReference_Schema{
Schema: &v3.Schema{
Description: messageDescription,
Properties: definitionProperties,
},
},
},
},
)
}
}
// contains returns true if an array contains a specified string.
func contains(s []string, e string) bool {
for _, a := range s {
if a == e {
return true
}
}
return false
}
// singular produces the singular form of a collection name.
func singular(plural string) string {
if strings.HasSuffix(plural, "ves") {
return strings.TrimSuffix(plural, "ves") + "f"
}
if strings.HasSuffix(plural, "ies") {
return strings.TrimSuffix(plural, "ies") + "y"
}
if strings.HasSuffix(plural, "s") {
return strings.TrimSuffix(plural, "s")
}
return plural
}

68
util.go
View File

@@ -2,27 +2,28 @@ package main
import (
"fmt"
"log"
"net/http"
"strings"
api_options "github.com/unistack-org/micro-proto/api"
openapiv2_options "github.com/unistack-org/micro-proto/openapiv2"
api_options "go.unistack.org/micro-proto/v3/api"
v2 "go.unistack.org/micro-proto/v3/openapiv2"
v3 "go.unistack.org/micro-proto/v3/openapiv3"
"google.golang.org/protobuf/compiler/protogen"
"google.golang.org/protobuf/proto"
)
var (
httpMethodMap = map[string]string{
"GET": "MethodGet",
"HEAD": "MethodHead",
"POST": "MethodPost",
"PUT": "MethodPut",
"PATCH": "MethodPatch",
"DELETE": "MethodDelete",
"CONNECT": "MethodConnect",
"OPTIONS": "MethodOptions",
"TRACE": "MethodTrace",
}
)
var httpMethodMap = map[string]string{
http.MethodGet: "MethodGet",
http.MethodHead: "MethodHead",
http.MethodPost: "MethodPost",
http.MethodPut: "MethodPut",
http.MethodPatch: "MethodPatch",
http.MethodDelete: "MethodDelete",
http.MethodConnect: "MethodConnect",
http.MethodOptions: "MethodOptions",
http.MethodTrace: "MethodTrace",
}
func unexport(s string) string {
return strings.ToLower(s[:1]) + s[1:]
@@ -30,7 +31,7 @@ func unexport(s string) string {
func generateServiceClient(gfile *protogen.GeneratedFile, service *protogen.Service) {
serviceName := service.GoName
//if rule, ok := getMicroApiService(service); ok {
// if rule, ok := getMicroApiService(service); ok {
// gfile.P("// client wrappers ", strings.Join(rule.ClientWrappers, ", "))
// }
gfile.P("type ", unexport(serviceName), "Client struct {")
@@ -51,26 +52,30 @@ func generateServiceClientMethods(gfile *protogen.GeneratedFile, service *protog
generateClientFuncSignature(gfile, serviceName, method)
if http && method.Desc.Options() != nil {
if proto.HasExtension(method.Desc.Options(), openapiv2_options.E_Openapiv2Operation) {
opts := proto.GetExtension(method.Desc.Options(), openapiv2_options.E_Openapiv2Operation)
if proto.HasExtension(method.Desc.Options(), v2.E_Openapiv2Operation) {
opts := proto.GetExtension(method.Desc.Options(), v2.E_Openapiv2Operation)
if opts != nil {
r := opts.(*openapiv2_options.Operation)
gfile.P("errmap := make(map[string]interface{}, ", len(r.Responses), ")")
for code, response := range r.Responses {
if response.Schema != nil && response.Schema.JsonSchema != nil {
ref := response.Schema.JsonSchema.Ref
r := opts.(*v2.Operation)
gfile.P("errmap := make(map[string]interface{}, ", len(r.Responses.ResponseCode), ")")
for _, rsp := range r.Responses.ResponseCode {
if schema := rsp.Value.GetJsonReference(); schema != nil {
ref := schema.XRef
if strings.HasPrefix(ref, "."+string(service.Desc.ParentFile().Package())+".") {
ref = strings.TrimPrefix(ref, "."+string(service.Desc.ParentFile().Package())+".")
}
gfile.P(`errmap["`, code, `"] = &`, ref, "{}")
if ref == "micro.codec.Frame" || ref == ".micro.codec.Frame" {
gfile.P(`errmap["`, rsp.Name, `"] = &`, microCodecPackage.Ident("Frame"), "{}")
} else {
gfile.P(`errmap["`, rsp.Name, `"] = &`, ref, "{}")
}
}
}
}
gfile.P("opts = append(opts,")
gfile.P(microClientHttpPackage.Ident("ErrorMap"), "(errmap),")
gfile.P(")")
}
if proto.HasExtension(method.Desc.Options(), api_options.E_Http) {
gfile.P("opts = append(opts,")
endpoints, _ := generateEndpoints(method)
@@ -86,7 +91,16 @@ func generateServiceClientMethods(gfile *protogen.GeneratedFile, service *protog
}
gfile.P(")")
}
// Build a list of header parameters.
eopt := proto.GetExtension(method.Desc.Options(), v3.E_Openapiv3Operation)
if eopt != nil && eopt != v3.E_Openapiv3Operation.InterfaceOf(v3.E_Openapiv3Operation.Zero()) {
opt := eopt.(*v3.Operation)
log.Printf("xxx %#+v\n", opt)
}
}
if rule, ok := getMicroApiMethod(method); ok {
if rule.Timeout > 0 {
gfile.P("opts = append(opts, ", microClientPackage.Ident("WithRequestTimeout"), "(", timePackage.Ident("Second"), "*", rule.Timeout, "))")
@@ -449,6 +463,8 @@ func generateServiceServerStreamInterface(gfile *protogen.GeneratedFile, service
func generateServiceEndpoints(gfile *protogen.GeneratedFile, service *protogen.Service) {
serviceName := service.GoName
gfile.P("var (")
gfile.P(serviceName, "Name", "=", `"`, serviceName, `"`)
gfile.P()
gfile.P(serviceName, "Endpoints", "=", "[]", microApiPackage.Ident("Endpoint"), "{")
for _, method := range service.Methods {
if method.Desc.Options() == nil {
@@ -457,7 +473,7 @@ func generateServiceEndpoints(gfile *protogen.GeneratedFile, service *protogen.S
if proto.HasExtension(method.Desc.Options(), api_options.E_Http) {
endpoints, streaming := generateEndpoints(method)
for _, endpoint := range endpoints {
gfile.P(microApiPackage.Ident("Endpoint"), "{")
gfile.P("{")
generateEndpoint(gfile, serviceName, method.GoName, endpoint, streaming)
gfile.P("},")
}

View File

@@ -11,11 +11,12 @@ var (
gorillaMuxPackage = protogen.GoImportPath("github.com/gorilla/mux")
chiPackage = protogen.GoImportPath("github.com/go-chi/chi/v5")
chiMiddlewarePackage = protogen.GoImportPath("github.com/go-chi/chi/v5/middleware")
microApiPackage = protogen.GoImportPath("github.com/unistack-org/micro/v3/api")
microClientPackage = protogen.GoImportPath("github.com/unistack-org/micro/v3/client")
microServerPackage = protogen.GoImportPath("github.com/unistack-org/micro/v3/server")
microClientHttpPackage = protogen.GoImportPath("github.com/unistack-org/micro-client-http/v3")
microApiPackage = protogen.GoImportPath("go.unistack.org/micro/v3/api")
microClientPackage = protogen.GoImportPath("go.unistack.org/micro/v3/client")
microServerPackage = protogen.GoImportPath("go.unistack.org/micro/v3/server")
microClientHttpPackage = protogen.GoImportPath("go.unistack.org/micro-client-http/v3")
microCodecPackage = protogen.GoImportPath("go.unistack.org/micro/v3/codec")
timePackage = protogen.GoImportPath("time")
deprecationComment = "// Deprecated: Do not use."
versionComment = "v3.4.1"
versionComment = "v3.5.2"
)