Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/main' into dev/keyi_string_json
Browse files Browse the repository at this point in the history
  • Loading branch information
xiekeyi98 committed Nov 29, 2023
2 parents b5a7eff + f8e4f29 commit 276afde
Show file tree
Hide file tree
Showing 55 changed files with 3,608 additions and 214 deletions.
34 changes: 31 additions & 3 deletions .github/workflows/push-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,40 @@ jobs:
go install mvdan.cc/[email protected]
echo "install done!"
set -e
if [[ -n "$(gofumpt -l -extra .)" ]]; then
if [[ -n "$(gofumpt -l .)" ]]; then
echo "gofumpt found formatting issues."
gofumpt -l -extra .
gofumpt -l .
exit 1
fi
test -z "$(gofumpt -l -extra .)"
test -z "$(gofumpt -l .)"
echo "test done!"
go vet -stdmethods=false $(go list ./...)
echo "go vet done!"
codegen-test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Go
uses: actions/setup-go@v3
with:
go-version: '1.17'
- name: Prepare
run: |
go install
go install github.com/cloudwego/kitex/tool/cmd/kitex@develop
LOCAL_REPO=$(pwd)
cd ..
git clone https://github.com/cloudwego/kitex-tests.git
cd kitex-tests/codegen
go mod init codegen-test
go mod edit -replace=github.com/apache/thrift=github.com/apache/[email protected]
go mod edit -replace github.com/cloudwego/thriftgo=${LOCAL_REPO}
go mod tidy
bash -version
bash ./codegen_install_check.sh
- name: CodeGen
run: |
cd ../kitex-tests/codegen
tree
bash ./codegen_run.sh
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ gen-*
.vscode
.idea
tool/trimmer/trimmer_test
output
14 changes: 14 additions & 0 deletions CREDITS
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
// Copyright 2023 ByteDance Inc.
//
// 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.

50 changes: 50 additions & 0 deletions fieldmask/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<!--
Copyright 2023 CloudWeGo Authors
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.
-->

# ThriftPath RFC

## What is thrift path?
A path string represents a arbitrary endpoint of thrift object. It is used for locating data from thrift root message, and defined from-top-to-bottom.
For exapmle, a thrift message defined as below:
```thrift
struct Example {
1: string Foo,
2: i64 Bar
3: Example Self
}
```
A thrift path `$.Foo` represents the string value of Example.Foo, and `$.Self.Bar` represents the secondary layer i64 value of Example.Self.Bar
Since thrift has four nesting types (LIST/SET/MAP/STRUCT), thrift path should also support locating elements in all these types' object, not only STRUCT.

## Syntax
Here are basic hypothesis:
- `fieldname` is the field name of a field in a struct, it **MUST ONLY** contain '[a-zA-Z]' alphabet letters, integer numbers and char '_'.
- `index` is the index of a element in a list or set, it **MUST ONLY** contain integer numbers.
- `key` is the string-typed key of a element in a map, it can contain any letters, but it **MUST** be a quoted string.
- `id` is the integer-typed key of a element in a map, it **MUST ONLY** contain integer numbers.

Here is detailed syntax:
<!--StartFragment--><byte-sheet-html-origin data-id="1700208276535" data-version="4" data-is-embed="true" data-grid-line-hidden="false" data-copy-type="col">
ThriftPath | Description
-- | --
$ | the root object,every path must start with it.
.`fieldname` | get the child field of a struct corepsonding to fieldname. For example, `$.FieldA.ChildrenB`
[`index`,index...] | get any number of elements in an List/Set corepsonding to indices. Indices must be integer.For example: `$.FieldList[1,3,4]` .Notice: a index beyond actual list size can written but is useless.
{"key","key"...} | get any number of values corepsonding to key in a string-typed-key map. For example: `$.StrMap{"abcd","1234"}`
{id,id...} | get the child field with specific id in a integer-typed-key map. For example, `$.IntMap{1,2}`
\* | get **ALL** fields/elements, that is: `$.StrMap{*}.FieldX` menas gets all the elements' FieldX in a map Root.StrMap; `$.List[*].FieldX` means get all the elements' FieldX in a list Root.List
</byte-sheet-html-origin><!--EndFragment-->

Loading

0 comments on commit 276afde

Please sign in to comment.