algod: Add a sourcemap flag for compile endpoint #3938
Conversation
algochoi
changed the title
| if !v2.Node.Config().EnableDeveloperAPI { | ||
| return ctx.String(http.StatusNotFound, "/teal/compile was not enabled in the configuration file by setting the EnableDeveloperAPI to true") | ||
| } | ||
| // Check if we should return the source map. | ||
| sourcemapFlag := false | ||
| var sourcemap logic.SourceMap |
There was a problem hiding this comment.
nitty but i prefer grouping multiple var declarations
var (
sourcemapFlag bool
sourcemap logic.SourcceMap
)There was a problem hiding this comment.
Refactored the whole section to remove some ugly code
Co-authored-by: Ben Guidarelli <[email protected]>
| data := rec.Body.Bytes() | ||
| err = protocol.DecodeJSON(data, &response) | ||
| require.NoError(t, err, string(data)) | ||
| if params.Sourcemap != nil && *params.Sourcemap { |
There was a problem hiding this comment.
nit: I would make the condition expectedSourcemap != nil, that way you aren't replicating the same logic that determines when a sourcemap should be returned or not
Also, require.Equal(t, expectedSourcemap, response.Sourcemap) compares *logic.SourceMap, does this pointer comparison compare the actual values?
There was a problem hiding this comment.
Good catch thanks!
Codecov Report
@@ Coverage Diff @@
## master #3938 +/- ##
=======================================
Coverage 49.79% 49.79%
=======================================
Files 409 409
Lines 69145 69155 +10
=======================================
+ Hits 34429 34437 +8
- Misses 30997 31002 +5
+ Partials 3719 3716 -3
Continue to review full report at Codecov.
|
Summary
Related to #3725:
This PR adds an optional query parameter to optionally output source maps as a JSON in the
CompileResponse. This changes the API request and response structure to include these optional fields.Test Plan
Added test cases in the handler for optional query parameter and optional source map returned.
Tested on sandbox with following query:
curl "localhost:4001/v2/teal/compile?sourcemap=include" -H "X-Algo-API-Token:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" --data-binary @simple.tealResponse: