-
Notifications
You must be signed in to change notification settings - Fork 140
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into bastian/improve-state-decoding-tool
- Loading branch information
Showing
143 changed files
with
10,641 additions
and
2,632 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| name: Benchmark | ||
| on: | ||
| pull_request: | ||
| branches: | ||
| - master | ||
| - 'feature/**' | ||
| - 'v**' | ||
|
|
||
| jobs: | ||
| benchmark: | ||
| name: Performance regression check | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Set benchmark repetitions | ||
| # reducing repetition will speed up execution, | ||
| # but will be more inaccurate at detecting change | ||
| run: echo "::set-output name=benchmark_repetitions::7" | ||
| id: settings | ||
|
|
||
| - name: Install dependencies | ||
| run: sudo apt-get update && sudo apt-get install wabt | ||
|
|
||
| - name: Checkout | ||
| uses: actions/checkout@v2 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - uses: actions/setup-go@v2 | ||
| with: | ||
| go-version: '1.17.x' | ||
|
|
||
| - uses: actions/setup-node@v2 | ||
| with: | ||
| node-version: '15' | ||
|
|
||
| - uses: actions/cache@v1 | ||
| with: | ||
| path: ~/go/pkg/mod | ||
| key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }} | ||
| restore-keys: | | ||
| ${{ runner.os }}-go- | ||
| - name: Build | ||
| run: make build | ||
|
|
||
| - name: Run benchmark on current branch | ||
| run: | | ||
| ( for i in {1..${{ steps.settings.outputs.benchmark_repetitions }}}; do go test ./... -run=XXX -bench=. -shuffle=on; done | sed 's/pkg:.*/pkg: github.com\/onflow\/cadence\/runtime/' ) | tee new.txt | ||
| # the package replace line above is to make the results table more readable, since it is not fragmented by package | ||
|
|
||
|
|
||
| - name: Checkout base branch | ||
| run: git checkout ${{ github.event.pull_request.base.sha }} | ||
|
|
||
| - name: Run benchmark on base branch | ||
| run: | | ||
| ( for i in {1..${{ steps.settings.outputs.benchmark_repetitions }}}; do go test ./... -run=XXX -bench=. -shuffle=on; done | sed 's/pkg:.*/pkg: github.com\/onflow\/cadence\/runtime/' ) | tee old.txt | ||
| # see https://trstringer.com/github-actions-multiline-strings/ to see why this part is complex | ||
| - name: Use benchstat for comparison | ||
| run: | | ||
| export PATH=$PATH:$(go env GOPATH)/bin | ||
| GO111MODULE=off go get golang.org/x/perf/cmd/benchstat | ||
| echo "BENCHSTAT<<EOF" >> $GITHUB_ENV | ||
| echo "$(benchstat -html -sort delta old.txt new.txt | sed '/<title/,/<\/style>/d' | sed 's/<!doctype html>//g')" >> $GITHUB_ENV | ||
| echo "EOF" >> $GITHUB_ENV | ||
| - name: Find existing comment on PR | ||
| uses: peter-evans/find-comment@v1 | ||
| id: fc | ||
| with: | ||
| issue-number: ${{ github.event.pull_request.number }} | ||
| comment-author: "github-actions[bot]" | ||
| body-includes: "## Cadence [Benchstat](https://pkg.go.dev/golang.org/x/perf/cmd/benchstat) comparison" | ||
|
|
||
| - name: Create or update comment | ||
| uses: peter-evans/create-or-update-comment@v1 | ||
| with: | ||
| comment-id: ${{ steps.fc.outputs.comment-id }} | ||
| issue-number: ${{ github.event.pull_request.number }} | ||
| body: | | ||
| ## Cadence [Benchstat](https://pkg.go.dev/golang.org/x/perf/cmd/benchstat) comparison | ||
| This branch with compared with the base branch ${{ github.event.pull_request.base.label }} commit ${{ github.event.pull_request.base.sha }} | ||
| The command `for i in {1..N}; do go test ./... -run=XXX -bench=. -shuffle=on; done` was used. | ||
| Bench tests were run a total of ${{ steps.settings.outputs.benchmark_repetitions }} times on each branch. | ||
| ## Results | ||
| ${{ env.BENCHSTAT }} | ||
| edit-mode: replace |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| --- | ||
| title: Type Inference | ||
| --- | ||
|
|
||
| If a variable or constant declaration is not annotated explicitly with a type, | ||
| the declaration's type is inferred from the initial value. | ||
|
|
||
| ### Basic Literals | ||
| Decimal integer literals and hex literals are inferred to type `Int`. | ||
|
|
||
| ```cadence | ||
| let a = 1 | ||
| // `a` has type `Int` | ||
| let b = -45 | ||
| // `b` has type `Int` | ||
| let c = 0x02 | ||
| // `c` has type `Int` | ||
| ``` | ||
|
|
||
| Unsigned fixed-point literals are inferred to type `UFix64`. | ||
| Signed fixed-point literals are inferred to type `Fix64`. | ||
|
|
||
| ```cadence | ||
| let a = 1.2 | ||
| // `a` has type `UFix64` | ||
| let b = -1.2 | ||
| // `b` has type `Fix64` | ||
| ``` | ||
|
|
||
| Similarly, for other basic literals, the types are inferred in the following manner: | ||
|
|
||
| | Literal Kind | Example | Inferred Type (x) | | ||
| |:-----------------:|:-----------------:|:-----------------:| | ||
| | String literal | `let x = "hello"` | String | | ||
| | Boolean literal | `let x = true` | Bool | | ||
| | Nil literal | `let x = nil` | Never? | | ||
|
|
||
|
|
||
| ### Array Literals | ||
| Array literals are inferred based on the elements of the literal, and to be variable-size. | ||
| The inferred element type is the _least common super-type_ of all elements. | ||
|
|
||
| ```cadence | ||
| let integers = [1, 2] | ||
| // `integers` has type `[Int]` | ||
| let int8Array = [Int8(1), Int8(2)] | ||
| // `int8Array` has type `[Int8]` | ||
| let mixedIntegers = [UInt(65), 6, 275, Int128(13423)] | ||
| // `mixedIntegers` has type `[Integer]` | ||
| let nilableIntegers = [1, nil, 2, 3, nil] | ||
| // `nilableIntegers` has type `[Int?]` | ||
| let mixed = [1, true, 2, false] | ||
| // `mixed` has type `[AnyStruct]` | ||
| ``` | ||
|
|
||
| ### Dictionary Literals | ||
| Dictionary literals are inferred based on the keys and values of the literal. | ||
| The inferred type of keys and values is the _least common super-type_ of all keys and values, respectively. | ||
|
|
||
| ```cadence | ||
| let booleans = { | ||
| 1: true, | ||
| 2: false | ||
| } | ||
| // `booleans` has type `{Int: Bool}` | ||
| let mixed = { | ||
| Int8(1): true, | ||
| Int64(2): "hello" | ||
| } | ||
| // `mixed` has type `{Integer: AnyStruct}` | ||
| // Invalid: mixed keys | ||
| // | ||
| let invalidMixed = { | ||
| 1: true, | ||
| false: 2 | ||
| } | ||
| // The least common super-type of the keys is `AnyStruct`. | ||
| // But it is not a valid type for dictionary keys. | ||
| ``` | ||
|
|
||
| ### Ternary Expression | ||
| Ternary expression type is inferred to be the least common super-type of the second and third operands. | ||
| ```cadence | ||
| let a = true ? 1 : 2 | ||
| // `a` has type `Int` | ||
| let b = true ? 1 : nil | ||
| // `b` has type `Int?` | ||
| let c = true ? 5 : (false ? "hello" : nil) | ||
| // `c` has type `AnyStruct` | ||
| ``` | ||
|
|
||
| ### Functions | ||
| Functions are inferred based on the parameter types and the return type. | ||
|
|
||
| ```cadence | ||
| let add = (a: Int8, b: Int8): Int { | ||
| return a + b | ||
| } | ||
| // `add` has type `((Int8, Int8): Int)` | ||
| ``` | ||
|
|
||
| Type inference is performed for each expression / statement, and not across statements. | ||
|
|
||
| ## Ambiguities | ||
| There are cases where types cannot be inferred. | ||
| In these cases explicit type annotations are required. | ||
|
|
||
| ```cadence | ||
| // Invalid: not possible to infer type based on array literal's elements. | ||
| // | ||
| let array = [] | ||
| // Instead, specify the array type and the concrete element type, e.g. `Int`. | ||
| // | ||
| let array: [Int] = [] | ||
| // Or, use a simple-cast to annotate the expression with a type. | ||
| let array = [] as [Int] | ||
| ``` | ||
|
|
||
| ```cadence | ||
| // Invalid: not possible to infer type based on dictionary literal's keys and values. | ||
| // | ||
| let dictionary = {} | ||
| // Instead, specify the dictionary type and the concrete key | ||
| // and value types, e.g. `String` and `Int`. | ||
| // | ||
| let dictionary: {String: Int} = {} | ||
| // Or, use a simple-cast to annotate the expression with a type. | ||
| let dictionary = {} as {String: Int} | ||
| ``` |
Oops, something went wrong.