Files
wazero/context_done_example_test.go
2023-02-10 09:39:04 +09:00

131 lines
4.2 KiB
Go

package wazero_test
import (
"context"
_ "embed"
"fmt"
"log"
"time"
"github.com/tetratelabs/wazero"
)
// infiniteLoopWasm exports a function named "infinite_loop" that never exits.
//
//go:embed internal/integration_test/engine/testdata/infinite_loop.wasm
var infiniteLoopWasm []byte
// ExampleRuntimeConfig_WithCloseOnContextDone_context_timeout demonstrates how to ensure the termination
// of infinite loop function with context.Context created by context.WithTimeout powered by
// RuntimeConfig.WithEnsureTermination configuration.
func ExampleRuntimeConfig_WithCloseOnContextDone_context_timeout() {
r := wazero.NewRuntimeWithConfig(context.Background(),
// Enables the WithCloseOnContextDone option.
wazero.NewRuntimeConfig().WithCloseOnContextDone(true))
compiledModule, err := r.CompileModule(context.Background(), infiniteLoopWasm)
if err != nil {
log.Panicln(err)
}
moduleInstance, err := r.InstantiateModule(context.Background(), compiledModule,
wazero.NewModuleConfig().WithName("malicious_wasm"))
if err != nil {
log.Panicln(err)
}
infiniteLoop := moduleInstance.ExportedFunction("infinite_loop")
// Create the context.Context to be passed to the invocation of infinite_loop.
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
defer cancel()
// Invoke the infinite loop with the timeout context.
_, err = infiniteLoop.Call(ctx)
// Timeout is correctly handled and triggers the termination of infinite loop.
fmt.Println(err)
// Output:
// module "malicious_wasm" closed with context deadline exceeded
}
// ExampleRuntimeConfig_WithCloseOnContextDone_context_cancel demonstrates how to ensure the termination
// of infinite loop function with context.Context created by context.WithCancel powered by
// RuntimeConfig.WithEnsureTermination configuration.
func ExampleRuntimeConfig_WithCloseOnContextDone_context_cancel() {
r := wazero.NewRuntimeWithConfig(context.Background(),
// Enables the WithCloseOnContextDone option.
wazero.NewRuntimeConfig().WithCloseOnContextDone(true))
compiledModule, err := r.CompileModule(context.Background(), infiniteLoopWasm)
if err != nil {
log.Panicln(err)
}
moduleInstance, err := r.InstantiateModule(context.Background(), compiledModule,
wazero.NewModuleConfig().WithName("malicious_wasm"))
if err != nil {
log.Panicln(err)
}
infiniteLoop := moduleInstance.ExportedFunction("infinite_loop")
// Create the context.Context to be passed to the invocation of infinite_loop.
ctx, cancel := context.WithCancel(context.Background())
go func() {
// After 2 seconds, cancel the invocation of infinite loop.
time.Sleep(2 * time.Second)
cancel()
}()
// Invoke the infinite loop with the timeout context.
_, err = infiniteLoop.Call(ctx)
// context Cancellation is correctly handled and triggers the termination of infinite loop.
fmt.Println(err)
// Output:
// module "malicious_wasm" closed with context canceled
}
// ExampleRuntimeConfig_WithCloseOnContextDone_moduleClose demonstrates how to ensure the termination
// of infinite loop function with api.Module's CloseWithExitCode method powered by
// RuntimeConfig.WithEnsureTermination configuration.
func ExampleRuntimeConfig_WithCloseOnContextDone_moduleClose() {
r := wazero.NewRuntimeWithConfig(context.Background(),
// Enables the WithCloseOnContextDone option.
wazero.NewRuntimeConfig().WithCloseOnContextDone(true))
compiledModule, err := r.CompileModule(context.Background(), infiniteLoopWasm)
if err != nil {
log.Panicln(err)
}
moduleInstance, err := r.InstantiateModule(context.Background(), compiledModule,
wazero.NewModuleConfig().WithName("malicious_wasm"))
if err != nil {
log.Panicln(err)
}
infiniteLoop := moduleInstance.ExportedFunction("infinite_loop")
go func() {
// After 2 seconds, close the module instance with CloseWithExitCode, which triggers the termination
// of infinite loop.
time.Sleep(2 * time.Second)
if err := moduleInstance.CloseWithExitCode(context.Background(), 1); err != nil {
log.Panicln(err)
}
}()
// Invoke the infinite loop with the timeout context.
_, err = infiniteLoop.Call(context.Background())
// The exit code is correctly handled and triggers the termination of infinite loop.
fmt.Println(err)
// Output:
// module "malicious_wasm" closed with exit_code(1)
}