filter-processor: move reflection into generated code #1463
Conversation
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
* Don't add entries for tags in the middle. * Add type casting. * Add manual ignores for things like signatures.
winder
commented
Feb 13, 2023
Comment on lines
+20
to
+133
| "txn.votekey": true, | ||
| "txn.selkey": true, | ||
| "txn.sprfkey": true, | ||
| // no point in filtering on state proof things? | ||
| "txn.sp.c": true, | ||
| "txn.sp.S.pth": true, | ||
| "txn.sp.S.hsh": true, | ||
| "txn.sp.S.hsh.t": true, | ||
| "txn.sp.P.pth": true, | ||
| "txn.sp.P.hsh": true, | ||
| "txn.sp.P.hsh.t": true, | ||
| "txn.sp.r": true, | ||
| "txn.sp.pr": true, | ||
| "txn.spmsg.b": true, | ||
| "txn.spmsg.v": true, | ||
| // inner transactions are handled differently | ||
| "dt.itx": true, | ||
| // TODO: this can be removed if the sub fields are supported | ||
| "dt": true, | ||
| // TODO: support map types? | ||
| "dt.gd": true, | ||
| "dt.ld": true, | ||
| // TODO: support array types? | ||
| "txn.apaa": true, | ||
| "txn.apat": true, | ||
| "txn.apfa": true, | ||
| "txn.apbx": true, | ||
| "txn.apas": true, | ||
| "txn.apap": true, | ||
| "txn.apsu": true, | ||
| "dt.lg": true, | ||
| } | ||
|
|
||
| func noCast(t reflect.StructField) bool { | ||
| switch reflect.New(t.Type).Elem().Interface().(type) { | ||
| case uint64: | ||
| return true | ||
| case int64: | ||
| return true | ||
| case string: | ||
| return true | ||
| } | ||
| return false | ||
| } | ||
|
|
||
| func simpleCast(t reflect.StructField) string { | ||
| switch reflect.New(t.Type).Elem().Interface().(type) { | ||
| // unsigned | ||
| case uint: | ||
| return "uint64" | ||
| case uint8: | ||
| return "uint64" | ||
| case uint16: | ||
| return "uint64" | ||
| case uint32: | ||
| return "uint64" | ||
| // signed | ||
| case int: | ||
| return "int64" | ||
| case int8: | ||
| return "int64" | ||
| case int16: | ||
| return "int64" | ||
| case int32: | ||
| return "int64" // | ||
| // alias | ||
| // SDK types | ||
| case types.MicroAlgos: | ||
| // SDK microalgo does not need ".Raw" | ||
| return "uint64" | ||
| case types.AssetIndex: | ||
| return "uint64" | ||
| case types.AppIndex: | ||
| return "uint64" | ||
| case types.Round: | ||
| return "uint64" | ||
| case types.OnCompletion: | ||
| return "uint64" | ||
| case types.StateProofType: | ||
| return "uint64" | ||
| case types.TxType: | ||
| return "string" | ||
| // go-algorand types | ||
| case basics.AssetIndex: | ||
| return "uint64" | ||
| case basics.AppIndex: | ||
| return "uint64" | ||
| case basics.Round: | ||
| return "uint64" | ||
| case transactions.OnCompletion: | ||
| return "uint64" | ||
| case protocol.StateProofType: | ||
| return "uint64" | ||
| case protocol.TxType: | ||
| return "string" | ||
|
|
||
| } | ||
| return "" | ||
|
|
||
| } |
There was a problem hiding this comment.
This looks like a lot, but it really isn't. The code is setup so that you re-run the generator and address un-handled types until everything is handled.
winder
commented
Feb 13, 2023
Comment on lines
+247
to
+269
| const templateStr = `// Code generated via go generate. DO NOT EDIT. | ||
|
|
||
| package {{ .PackageName }} | ||
|
|
||
| import ( | ||
| "encoding/base64" | ||
| "fmt" | ||
|
|
||
| "github.com/algorand/go-algorand/data/transactions" | ||
| ) | ||
|
|
||
| // LookupFieldByTag takes a tag and associated SignedTxnInBlock and returns the value | ||
| // referenced by the tag. An error is returned if the tag does not exist | ||
| func LookupFieldByTag(tag string, input *transactions.SignedTxnInBlock) (interface{}, error) { | ||
| switch tag { | ||
| {{ range .StructFields }} case "{{ .TagPath }}": | ||
| value := {{ ReturnValue . "input" }} | ||
| return &value, nil | ||
| {{ end }} default: | ||
| return nil, fmt.Errorf("unknown tag: %s", tag) | ||
| } | ||
| } | ||
| ` |
There was a problem hiding this comment.
Now using the text/template package instead of string building.
Codecov Report
@@ Coverage Diff @@
## develop #1463 +/- ##
===========================================
- Coverage 65.37% 64.82% -0.56%
===========================================
Files 83 84 +1
Lines 11414 11462 +48
===========================================
- Hits 7462 7430 -32
- Misses 3381 3464 +83
+ Partials 571 568 -3
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Eric-Warehime
approved these changes
Feb 14, 2023
| @@ -0,0 +1 @@ | |||
| package main | |||
There was a problem hiding this comment.
Does this do anything?
There was a problem hiding this comment.
No. I was thinking about adding tests, I'll do that in the next PR.
shiqizng
reviewed
Feb 14, 2023
conduit/plugins/processors/filterprocessor/fields/generated_signed_txn_map.go
Show resolved
Hide resolved
shiqizng
approved these changes
Feb 15, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
These changes focus on updating the generated
SignedTxnFuncfunction.LookupFieldByTag.uint64,int64andstring.txnwas a valid tag, now only leaves are allowed such astxn.fee.String()function can no longer be called, because it happens inside the generated code).Followup:
Test Plan
There are extensive unit tests to cover regressions.