Add wasm spec factory #14458
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
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
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,33 @@ | ||
| //go:build wasip1 | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "log" | ||
|
|
||
| "github.com/smartcontractkit/chainlink-common/pkg/workflows/wasm" | ||
|
|
||
| "github.com/smartcontractkit/chainlink-common/pkg/capabilities/cli/cmd/testdata/fixtures/capabilities/basictrigger" | ||
| "github.com/smartcontractkit/chainlink-common/pkg/workflows/sdk" | ||
| ) | ||
|
|
||
| func BuildWorkflow(config []byte) *sdk.WorkflowSpecFactory { | ||
| params := sdk.NewWorkflowParams{} | ||
| if err := json.Unmarshal(config, ¶ms); err != nil { | ||
| log.Fatal(err) | ||
| } | ||
|
|
||
| workflow := sdk.NewWorkflowSpecFactory(params) | ||
|
|
||
| triggerCfg := basictrigger.TriggerConfig{Name: "trigger", Number: 100} | ||
| _ = triggerCfg.New(workflow) | ||
|
|
||
| return workflow | ||
| } | ||
|
|
||
| func main() { | ||
| runner := wasm.NewRunner() | ||
| workflow := BuildWorkflow(runner.Config()) | ||
| runner.Run(workflow) | ||
| } |
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,32 @@ | ||
| package job | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "os" | ||
|
|
||
| "github.com/smartcontractkit/chainlink-common/pkg/workflows/sdk" | ||
| "github.com/smartcontractkit/chainlink-common/pkg/workflows/wasm/host" | ||
|
|
||
| "github.com/smartcontractkit/chainlink/v2/core/logger" | ||
| ) | ||
|
|
||
| type WasmFileSpecFactory struct{} | ||
|
There was a problem hiding this comment. For visibility to reviewers: In a side-channel discussion with Cedric, he mentioned that he thinks this should support URLs as well. I commented that I thought by the time the workflow runs, it would have already ensured that the file is on the box locally. I was thinking that if it needs to use HTTP to fetch the file, that could be done just once. The HTTP invoker could have a deterministic location to save the workflow file. It could then check if the file exists and download it if it doesn’t. Once the file is on disk, it would invoke the WASM file spec. I’m open to hearing what others think as well. There was a problem hiding this comment. One other potential use case, if we end up having any pre-build WASMs that users can run by providing their own config, we could leave them in fixed locations |
||
|
|
||
| func (w WasmFileSpecFactory) Spec(ctx context.Context, lggr logger.Logger, rawSpec, config []byte) (sdk.WorkflowSpec, error) { | ||
| moduleConfig := &host.ModuleConfig{Logger: lggr} | ||
| spec, err := host.GetWorkflowSpec(moduleConfig, rawSpec, config) | ||
| if err != nil { | ||
| return sdk.WorkflowSpec{}, err | ||
| } else if spec == nil { | ||
| return sdk.WorkflowSpec{}, errors.New("workflow spec not found when running wasm") | ||
| } | ||
|
|
||
| return *spec, nil | ||
| } | ||
|
|
||
| func (w WasmFileSpecFactory) RawSpec(_ context.Context, wf string) ([]byte, error) { | ||
| return os.ReadFile(wf) | ||
| } | ||
|
|
||
| var _ SDKWorkflowSpecFactory = (*WasmFileSpecFactory)(nil) | ||
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,52 @@ | ||
| package job_test | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "os" | ||
| "os/exec" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
|
|
||
| "github.com/smartcontractkit/chainlink-common/pkg/workflows/sdk" | ||
|
|
||
| "github.com/smartcontractkit/chainlink-common/pkg/workflows/wasm/host" | ||
|
|
||
| "github.com/smartcontractkit/chainlink/v2/core/internal/testutils" | ||
| "github.com/smartcontractkit/chainlink/v2/core/logger" | ||
| "github.com/smartcontractkit/chainlink/v2/core/services/job" | ||
| ) | ||
|
|
||
| func TestWasmFileSpecFactory(t *testing.T) { | ||
| binaryLocation := createTestBinary(t) | ||
| config, err := json.Marshal(sdk.NewWorkflowParams{ | ||
| Owner: "owner", | ||
| Name: "name", | ||
| }) | ||
| require.NoError(t, err) | ||
|
|
||
| factory := job.WasmFileSpecFactory{} | ||
| rawSpec, err := factory.RawSpec(testutils.Context(t), binaryLocation) | ||
| require.NoError(t, err) | ||
| actual, err := factory.Spec(testutils.Context(t), logger.NullLogger, rawSpec, config) | ||
| require.NoError(t, err) | ||
|
|
||
| rawBinary, err := os.ReadFile(binaryLocation) | ||
| require.NoError(t, err) | ||
| expected, err := host.GetWorkflowSpec(&host.ModuleConfig{Logger: logger.NullLogger}, rawBinary, config) | ||
| require.NoError(t, err) | ||
|
|
||
| require.Equal(t, *expected, actual) | ||
| } | ||
|
|
||
| func createTestBinary(t *testing.T) string { | ||
| const testBinaryLocation = "testdata/wasm/testmodule.wasm" | ||
|
|
||
| cmd := exec.Command("go", "build", "-o", testBinaryLocation, "github.com/smartcontractkit/chainlink/v2/core/services/job/testdata/wasm") | ||
| cmd.Env = append(os.Environ(), "GOOS=wasip1", "GOARCH=wasm") | ||
|
|
||
| output, err := cmd.CombinedOutput() | ||
| require.NoError(t, err, string(output)) | ||
|
|
||
| return testBinaryLocation | ||
| } |
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do we need a logger for validation? Typically we want to either log something, (x)or return an error to be logged - not both.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I needed it to call into the WASM creation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would rather change the WASM runner to not need it if we're not going to use it.