compute-sdk-go

module
v1.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 21, 2024 License: Apache-2.0, BSD-3-Clause

README

compute-sdk-go

Go SDK for building Fastly Compute applications with Go (1.21+) and TinyGo (0.28.1+).

Quick Start

The Fastly Developer Hub has a great Quick Start guide for Go.

Alternatively, you can take a look at the Go Starter Kit.

If you're using TinyGo, you'll also want to take a look at our TinyGo Recommended Packages section, as this can help with the sharp edges of the SDK, like JSON support.

Supported Toolchains

Compute builds on top of WebAssembly and the WebAssembly System Interface.

TinyGo supports WASI as a target, and Go does as of its 1.21 release.

Each toolchain has its own tradeoffs. Generally speaking, TinyGo produces smaller compiled artifacts and takes less RAM at runtime. Build times are generally longer, sometimes considerably. TinyGo does not support all of the Go standard library, and in particular support for the reflect package is incomplete. This means that some third-party packages may not work with TinyGo.

Runtime performance is mixed, with TinyGo faster on some applications and Go faster on others. If you have a performance-critical application, we recommend benchmarking both toolchains to see which works best for you.

To switch between TinyGo and Go, set the build command in the [scripts] section of your fastly.toml as follows:

[scripts]
build = "tinygo build -target=wasi -o bin/main.wasm ."

or

[scripts]
build = "GOARCH=wasm GOOS=wasip1 go build -o bin/main.wasm ."

You might need to adjust the actual build command depending on your project.

Installation

If you're using Go, download the latest Go release. For TinyGo, follow the TinyGo Quick install guide.

Then, you can install compute-sdk-go in your project by running:

go get github.com/fastly/compute-sdk-go

Examples

Examples can be found in the examples directory.

The Fastly Developer Hub has a collection of common use cases in VCL ported to Go which also acts as a great set of introductory examples of using Go on Compute.

API Reference

The API reference documentation can be found on pkg.go.dev/github.com/fastly/compute-sdk-go.

Testing

Tests that rely on a Compute runtime can utilize Viceroy, our local development tool.

Install Viceroy and ensure the viceroy command is available in your path.

Write your tests as ordinary Go tests. Viceroy provides the Compute APIs locally, although be aware that not all platform functionality is available. You can look at the integration_tests directory for examples.

TinyGo

The fastly-compute.json file provides a TinyGo target to run Viceroy. (In the future, we will include this in the Go starter kits.)

To run your tests:

tinygo test -target=fastly-compute.json ./...

You can try it out and make sure your local Viceroy environment is set up correctly by running the integration tests in this repository:

tinygo test -target=fastly-compute.json ./integration_tests/...
Go

To run tests with Viceroy and Go

GOARCH=wasm GOOS=wasip1 go test -exec "viceroy run -C fastly.toml" -v ./...

You can try it out and make sure your local Viceroy environment is set up correctly by running the integration tests in this repository:

GOARCH=wasm GOOS=wasip1 go test -exec "viceroy run -C fastly.toml" -v ./integration_tests/...

Logging

Logging can be done using a Fastly Compute Log Endpoint (example), or by using normal stdout like:

fmt.Printf("request received: %s\n", r.URL.String())

TinyGo is still a new project, which has yet to get a version 1.0.0. Therefore, the project is incomplete, but in its current state can still handle a lot of tasks on Compute. However, some languages features of Go are still missing.

To help with your adoption of compute-sdk-go, here are some recommended packages to help with some of the current missing language features:

JSON Parsing

TinyGo's reflect support (which is needed by encoding/json among other things) is still new. While most use cases should work, for performance or other compatibility reasons you might need to consider a third-party JSON package if the standard library doesn't meet your needs.

Changelog

The changelog can be found here.

Security

If you find any security issues, see the Fastly Security Reporting Page or send an email to: security@fastly.com

Note that communications related to security issues in Fastly-maintained OSS as described here are distinct from Fastly security advisories.

License

Apache-2.0 WITH LLVM-exception

Directories

Path Synopsis
_examples
cache
core
Package core provides the Fastly Core Cache API.
Package core provides the Fastly Core Cache API.
simple
Package simple provides the Simple Cache API, a simplified interface to inserting and retrieving entries from Fastly's cache.
Package simple provides the Simple Cache API, a simplified interface to inserting and retrieving entries from Fastly's cache.
Package configstore provides a read-only interface to config stores.
Package configstore provides a read-only interface to config stores.
Package device provides device dection based on the User-Agent header.
Package device provides device dection based on the User-Agent header.
Package edgedict provides a read-only interface to edge dictionaries.
Package edgedict provides a read-only interface to edge dictionaries.
Package erl provides Edge Rate Limiting functionality.
Package erl provides Edge Rate Limiting functionality.
Package fsthttp provides HTTP functionality for Fastly's Compute environment.
Package fsthttp provides HTTP functionality for Fastly's Compute environment.
Package geo provides access to the geographic data for IP addresses.
Package geo provides access to the geographic data for IP addresses.
internal
abi/fastly
Package fastly provides access to the Fastly Compute hostcall ABI.
Package fastly provides access to the Fastly Compute hostcall ABI.
abi/prim
Package prim contains primitive types used in Wasm ABI functions.
Package prim contains primitive types used in Wasm ABI functions.
abi/wasi
Package wasi provides access to Wasi features independent of Fastly Compute.
Package wasi provides access to Wasi features independent of Fastly Compute.
Package kvstore provides access to Fastly KV stores.
Package kvstore provides access to Fastly KV stores.
Deprecated: Use the kvstore package instead.
Deprecated: Use the kvstore package instead.
Package purge provides cache purging operations for Fastly Compute.
Package purge provides cache purging operations for Fastly Compute.
Package rtlog provides an interface to real-time logging endpoints.
Package rtlog provides an interface to real-time logging endpoints.
Package secretstore provides a read-only interface to Fastly Compute Secret Stores.
Package secretstore provides a read-only interface to Fastly Compute Secret Stores.
x
Package x contains temporary and/or experimental sub-packages.
Package x contains temporary and/or experimental sub-packages.
fstctx
Package fstctx provides alternatives to context.WithTimeout and context.WithDeadline.
Package fstctx provides alternatives to context.WithTimeout and context.WithDeadline.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL