Skip to content

CHANGELOG_GO_JS.md

Latest commit

 

History

History
454 lines (351 loc) · 28.9 KB

CHANGELOG_GO_JS.md

File metadata and controls

454 lines (351 loc) · 28.9 KB
Raw

Changelog

Both client libraries are pre-1.0, and they have separate versioning.

Unreleased

  • (JS) Reference documentation now lives on modal.com/docs, replacing the TypeDoc site previously published to GitHub Pages.
  • (Go, JS) Experimental options for Sandboxes (ExperimentalOptions in SandboxCreateParams in Go, experimentalOptions in Sandbox.create in JS) now accept string values in addition to booleans.
  • (Go, JS) Added a ConflictError error type, returned when the current state of a resource conflicts with the requested operation.
  • Breaking: (Go) Unexported AuthTokenManager, NewAuthTokenManager, TokenAndExpiry, and ValidateExecArgs which were not meant to be part of the public API.
  • (Go, JS) Sandbox.Filesystem.CopyFromLocal / WriteBytes / WriteText (Go) and sandbox.filesystem.copyFromLocal / writeBytes / writeText (JS) now stream data to the Sandbox instead of issuing a request per chunk, making large writes ~2.5× faster.
  • Breaking: (Go) FunctionUpdateAutoscalerParams.ScaledownWindow now is typed as a *time.Duration instead of as a *uint32.
  • (Go, JS) Function.UpdateAutoscaler now returns a struct containing the current autoscaler settings immediately after applying the change.
  • (Go) RefreshWindow is deprecated and has no effect. Auth tokens are now refreshed a jittered fraction of the way through their lifetime instead of a fixed five minutes before expiry.
  • (Go) Added a logs attribute for Function and FunctionCall objects for fetching current and historical logs generated by that object. The logs propery exposes a fetch method for time-based queries, tail for fetching the most recent entries, and stream for fetching entries as they arrive.

js/v0.9.0, go/v0.9.0

  • (Go, JS) Functions.FromName / Cls.FromName (Go) and client.functions.fromName / client.cls.fromName (JS) now accept an optional Version (Go) / version (JS) parameter to look up a version-pinned Function or Cls.
  • (Go, JS) Secrets.FromMap (Go) / client.secrets.fromObject (JS) is now lazy, so the returned Secret has an empty SecretID (Go) / secretId (JS) until it is first used. Latency for Sandbox.ExperimentalCreate / Sandbox.experimentalCreate and Sandbox.Exec / Sandbox.exec is improved by sending the secrets directly to the Sandbox and avoiding the secret creation limits.
  • (Go, JS) Function.WithOptions / Cls.WithOptions (Go) and Function_.withOptions / Cls.withOptions (JS) now accept a RoutingRegion / routingRegion option to override the region the Function's or Cls's inputs and outputs are routed through.
  • (Go, JS) Added Sandbox.Filesystem.Watch (Go) / Sandbox.filesystem.watch (JS) to watch a path in the Sandbox for filesystem changes. It yields FileWatchEvent objects and supports Recursive / recursive, an event-type Filter / filter, and a Timeout / timeoutMs bound.
  • Breaking: (Go, JS) Sandbox.ReloadVolumes (Go) / Sandbox.reloadVolumes (JS) now blocks until the Volumes have been reloaded, bounded by a new timeout (55 seconds by default) that is configurable via SandboxReloadVolumesParams.Timeout (Go) / SandboxReloadVolumesParams.timeoutMs (JS). If the reload does not complete within that window, a TimeoutError is raised.
  • Breaking: (Go, JS) Renamed the VolumeMountOptions type to VolumeMountOptionsParams. In Go, update WithMountOptions(&VolumeMountOptions{...}) / withMountOptions type annotations accordingly.
  • Breaking: (Go) Changed OutboundCIDRAllowlist and OutboundDomainAllowlist in SandboxCreateParams from []string to *Allowlist. A non-nil *Allowlist enables allowlist mode (even with empty Entries, which blocks all traffic of that type); nil means open access. Migrate OutboundCIDRAllowlist: []string{"10.0.0.0/8"} to OutboundCIDRAllowlist: &Allowlist{Entries: []string{"10.0.0.0/8"}}.

js/v0.8.2, go/v0.8.2

  • Added Sandbox.updateNetworkPolicy (JS) and Sandbox.UpdateNetworkPolicy (Go) to update the outbound network policy of a running Sandbox. Both outboundCidrAllowlist and outboundDomainAllowlist must be provided.

js/v0.8.1, go/v0.8.1

  • (Go, JS) Sandbox.CreateConnectToken (Go) / Sandbox.createConnectToken (JS) now accept an optional Port / port parameter on their params struct, controlling which container port requests are routed to when using the token. Defaults to 8080.

js/v0.8.0, go/v0.8.0

This release primarily contains a number of breaking changes as we continue working towards 1.0 in the JS and Go SDKs.

  • Added support for named Images, akin to a Modal-native Image registry, decoupling Image builds from App deployment or Sandbox creation:
    • (Go) Image.Publish and Image.FromName
    • (JS) Image.publish and Image.fromName
  • Added support for restricting the domains that processes inside of a Sandbox can connect to:
    • (Go) OutboundDomainAllowlist in SandboxCreateParams
    • (JS) outboundDomainAllowlist in Sandbox.create
  • Added support for dynamic configuration of Functions:
    • (Go) Function.WithOptions, Function.WithConcurrency, Function.WithBatching, Function.Instance
    • (JS) Function_.withOptions, Function_.withConcurrency, Function_.withBatching, Function_.instance
  • Improved reliability when uploading or downloading large data payloads for Function calls.
  • Fixed a bug where adding Dockerfile commands to an Image loaded with Image.FromID (Go) / Image.fromId (JS) could fail to use the resolved Image as the base.
  • Sandbox.exec (JS) / Sandbox.Exec (Go) now reject a relative Workdir client-side with InvalidError. In JS, an empty-string workdir is also rejected (pass undefined to use the image default).
  • (Go) Sandbox.Create and Sandbox.Exec now return an InvalidError if any Secrets entry is nil.
  • Breaking: The Go and JS SDKs now read the Image Builder Version from your Modal workspace settings, like the Python SDK. Previously, the Go and JS SDKs were hardcoded to use version 2024.10. If your workspace configuration uses a different version, your Images will rebuild once (then be cached as usual), so beware that the first run after upgrading may take longer than usual. Note that version 2025.06 has a number of improvements that are specifically oriented towards Sandbox workflows. Accordingly, the fixed ModalClient.imageBuilderVersion (JS) attribute has been removed in favor of ModalClient.getImageBuilderVersion.
  • Breaking: Sandbox.SnapshotFilesystem (Go) / Sandbox.snapshotFilesystem (JS) no longer take a positional timeout / timeoutMs argument. The timeout now lives on the params structs as Timeout time.Duration (Go) / timeoutMs?: number (JS), bringing the methods to parity with Sandbox.SnapshotDirectory. Migrate sb.SnapshotFilesystem(ctx, 30*time.Second, params) to sb.SnapshotFilesystem(ctx, &SandboxSnapshotFilesystemParams{Timeout: 30*time.Second, ...}), and sb.snapshotFilesystem(30000, params) to sb.snapshotFilesystem({ timeoutMs: 30000, ...params }).
  • Breaking: Sandbox.SnapshotFilesystem (Go) / Sandbox.snapshotFilesystem (JS) and Sandbox.SnapshotDirectory (Go) / Sandbox.snapshotDirectory (JS) now accept an explicit TTL (Go, a time.Duration) / ttlMs (JS, in milliseconds) field on their params struct, controlling how long the resulting Image is retained. Both methods default to 30 days. This is a change of default for snapshotFilesystem which previously kept Images indefinitely. Pass TTL: modal.NoExpiryTTL (Go) or ttlMs: null (JS) to opt out of expiry.
  • Breaking: Sandbox.SnapshotDirectory (Go) / Sandbox.snapshotDirectory (JS) now also have a Timeout (Go) / timeoutMs (JS) field on their params structs with a default of 55s, which brings them to parity with filesystem snapshots. If the snapshot does not return within that window, a TimeoutError is raised. The timeout can be set arbitrarily high to preserve the old behavior of not timing out.
  • Breaking: (Go) Sandbox.Filesystem is now a field rather than a method. Migrate sb.Filesystem().ReadText(...) to sb.Filesystem.ReadText(...).
  • Breaking: Sandbox.FromID (Go) / Sandbox.fromId (JS) no longer checks if the sandbox ID exists. You can run Poll (Go) or poll (JS) to get the status of your sandbox.
  • Breaking: Removed the deprecated low-level file-handle API: Sandbox.Open / SandboxFile (Go), and sandbox.open / SandboxFile (JS). Use the Sandbox Filesystem API instead: sandbox.Filesystem() (Go) / sandbox.filesystem (JS).
  • Breaking: Removed the deprecated Volume.ReadOnly / Volume.IsReadOnly (Go) and volume.readOnly / volume.isReadOnly (JS). Use WithMountOptions(&VolumeMountOptions{ReadOnly: &t}) / withMountOptions({ readOnly: true }) instead.
  • Breaking: (JS) Removed the deprecated cidrAllowlist parameter from sandboxes.create. Use outboundCidrAllowlist instead.
  • Breaking: (JS) Removed the entire deprecated v0.5.0 backwards-compatibility surface: the global initializeClient() / close() functions and the ClientOptions type; the deprecated static factories App.lookup, Function_.lookup, Cls.lookup, Queue.lookup / Queue.ephemeral / Queue.delete, Volume.fromName / Volume.ephemeral, Secret.fromName / Secret.fromObject, Sandbox.fromId / Sandbox.fromName / Sandbox.list, Image.fromId / Image.fromRegistry / Image.fromAwsEcr / Image.fromGcpArtifactRegistry / Image.delete, Proxy.fromName, and FunctionCall.fromId. the instance shims app.createSandbox, app.imageFromRegistry / imageFromAwsEcr / imageFromGcpArtifactRegistry, the public CloudBucketMount constructor, and the deprecated LookupOptions / DeleteOptions / EphemeralOptions type aliases. See MIGRATION-GUIDE.md.
  • Breaking: (Go) All public methods now end with a *XxxParams pointer argument, enabling forward-compatibility for future options without additional signature churn. Pass nil to accept defaults. Affected methods:
    • FunctionCall.FromID → FromID(ctx, id, *FunctionCallFromIDParams)
    • Image.FromID → FromID(ctx, id, *ImageFromIDParams)
    • Image.FromRegistry → FromRegistry(tag, *ImageFromRegistryParams), the *Secret field remains inside ImageFromRegistryParams (signature unchanged)
    • Image.FromAwsEcr → FromAwsEcr(tag, secret, *ImageFromAwsEcrParams) — the *Secret argument is now a positional parameter preceding the params struct
    • Image.FromGcpArtifactRegistry → FromGcpArtifactRegistry(tag, secret, *ImageFromGcpArtifactRegistryParams) — the *Secret argument is now a positional parameter preceding the params struct
    • Image.Build → Build(ctx, app, *ImageBuildParams)
    • Function.GetCurrentStats → GetCurrentStats(ctx, *FunctionGetCurrentStatsParams)
    • ContainerProcess.Wait → Wait(ctx, *ContainerProcessWaitParams)
    • Sandbox.FromID → FromID(ctx, id, *SandboxFromIDParams)
    • Sandbox.Wait → Wait(ctx, *SandboxWaitParams)
    • Sandbox.WaitUntilReady → WaitUntilReady(ctx, timeout, *SandboxWaitUntilReadyParams)
    • Sandbox.Tunnels → Tunnels(ctx, timeout, *SandboxTunnelsParams)
    • Sandbox.MountImage → MountImage(ctx, path, image, *SandboxMountImageParams)
    • Sandbox.UnmountImage → UnmountImage(ctx, path, *SandboxUnmountImageParams)
    • Sandbox.SnapshotDirectory → SnapshotDirectory(ctx, path, *SandboxSnapshotDirectoryParams)
    • Sandbox.SnapshotFilesystem → SnapshotFilesystem(ctx, *SandboxSnapshotFilesystemParams)
    • Sandbox.Poll → Poll(ctx, *SandboxPollParams)
    • Sandbox.SetTags → SetTags(ctx, tags, *SandboxSetTagsParams)
    • Sandbox.GetTags → GetTags(ctx, *SandboxGetTagsParams)

js/v0.7.6, go/v0.7.6

  • Added Sandbox Filesystem API in the Go SDK with sandbox.Filesystem() and in the JS SDK with sandbox.filesystem. The filesystem API contains methods:
    • fs.WriteText (Go) / fs.writeText (JS): Write UTF-8 to a file in the Sandbox.
    • fs.WriteBytes (Go) / fs.writeBytes (JS): Write binary content to a file in the Sandbox.
    • fs.ReadText (Go) / fs.readText (JS): Read a file from the Sandbox and return its contents as a UTF-8 string.
    • fs.ReadBytes (Go) / fs.readBytes (JS): Read a file from the Sandbox and return its contents as bytes.
    • fs.MakeDirectory (Go) / fs.makeDirectory (JS): Create a new directory in the Sandbox.
    • fs.ListFiles (Go) / fs.listFiles (JS): List files and directories in a Sandbox directory.
    • fs.Stat (Go) / fs.stat (JS): Return metadata for a single file, directory, or symlink in the Sandbox.
    • fs.CopyFromLocal (Go) / fs.copyFromLocal (JS): Copy a local file into the Sandbox.
    • fs.CopyToLocal (Go) / fs.copyToLocal (JS): Copy a file from the Sandbox to a local path.
    • fs.Remove (Go) / fs.remove (JS): Remove a file or directory in the Sandbox.
  • Added Volume.WithMountOptions (Go) and volume.withMountOptions (JS) to configure mount-time options (ReadOnly / readOnly and SubPath / subPath) when attaching a Volume to a Function or Sandbox. The SubPath / subPath option mounts a subdirectory of the Volume instead of its root. Calling withMountOptions multiple times on the same Volume stacks: fields left unset preserve their previous value.
  • Deprecated Volume.ReadOnly (Go) and Volume.readOnly (JS) in favor of WithMountOptions({ReadOnly: &t}) / withMountOptions({readOnly: true}). The old methods still work but will be removed in a future release.
  • Deprecated Volume.IsReadOnly (Go) and Volume.isReadOnly (JS); track configured mount options at the call site that configured them instead.

js/v0.7.5, go/v0.7.5

  • We've improved the reliability of the Sandbox.SnapshotFilesystem (Go) and Sandbox.snapshotFilesystem (JS) operation, especially for large snapshots, and we now support setting a timeout (Go) or timeoutMs (JS) longer than 55s when necessary.
  • Added Sandbox.UnmountImage (Go) and sandbox.unmountImage (JS) to remove an image mount from a path in the Sandbox filesystem and reveal the underlying directory again.
  • Sandboxes.Create (Go) and sandboxes.create (JS) now accept a Tags / tags parameter to attach key-value tags to the Sandbox at creation time.
  • Sandboxes.Create (Go) and sandboxes.create (JS) now accept an InboundCIDRAllowlist / inboundCidrAllowlist parameter to restrict which source IPs can connect inbound to a sandbox's tunnels and connection tokens.
  • Renamed cidrAllowlist to outboundCidrAllowlist (JS) and CIDRAllowlist to OutboundCIDRAllowlist (Go) to distinguish from the corresponding inbound allowlists.
  • The Go and JS SDKs can now respond more gracefully to server throttling (e.g., rate limiting) by backing off and automatically retrying.

js/v0.7.4, go/v0.7.4

  • Sandboxes.Create (Go) and sandboxes.create (JS) now accept an IncludeOidcIdentityToken / includeOidcIdentityToken parameter. When enabled, a MODAL_IDENTITY_TOKEN environment variable is injected into the sandbox, enabling OIDC-based authentication (e.g., for AWS federation).
  • We're introducing a concept of "readiness probes" for Sandbox. This feature lets you configure a readiness check on a TCP port, NewTCPProbe (Go) or Probe.withTcp (JS) or by executing a process NewExecProbe (Go) or Probe.withExec (JS). Calling sb.WaitUntilReady() (Go) or sb.waitUntilReady() (JS) will block until the Probe succeeds.

js/v0.7.3, go/v0.7.3

  • Migrated SDKs from github.com/modal-labs/libmodal to github.com/modal-labs/modal-client.

modal-js/v0.7.2, modal-go/v0.7.2

  • Updated Sandbox methods to wait for newly created sandboxes to be ready and not error immediately when it's not avaliable yet.
  • Fixed a bug in modal-js so that canceling sandbox.stdout or sandbox.stderr cleans up background resources.
  • Updated Sandbox (JS) to raise a better error when the sandbox was terminated.

modal-js/v0.7.1, modal-go/v0.7.1

  • Fixed regression in Sandbox.exec (JS) where it threw a ChannelCredentials type error.

modal-js/v0.7.0, modal-go/v0.7.0

  • Added Sandbox.MountImage (Go) and Sandbox.mountImage (JS) that mounts an Image to a path in the Sandbox's filesystem.
  • Added Sandbox.SnapshotDirectory (Go) and Sandbox.snapshotDirectory (JS) snapshots and creates a new image from a directory in the running sandbox.
  • Upgraded Sandbox.Exec (Go) and Sandbox.exec (JS) bringing improved performance and reliability.
  • Added a Sandbox.Detach (Go) or sandbox.detach (JS) to disconnect your client from the sandbox and cleans up any resources associated with the connection. We strongly recommend calling Detach after you are done interacting with the sandbox. Detach does not close streams from Sandbox.Stdout (Go), or Sandbox.stdout (JS). These streams should be closed using their Close (Go) or close (JS) methods.
  • Sandbox.Terminate (Go) and Sandbox.terminate (JS) detaches by default. To interact with a running sandbox, use Sandboxes.FromID (Go) or sandboxes.fromId (JS) to create a new Sandbox object.
  • Sandbox.Terminate (Go) and Sandbox.terminate (JS) now accepts a wait parameter to wait for the sandbox to terminate and return the exit code.

Breaking changes:

  • Changed Sandbox.Terminate in Go which now returns (int, error). The int is the return code when &SandboxTerminateParams{Wait: true} is passed in.
  • Added a Sandbox.Detach (Go) or sandbox.detach (JS) to disconnect your client from the sandbox and cleans up any resources associated with the connection. We strongly recommend calling Detach after you are done interacting with the sandbox.

modal-js/v0.6.3, modal-go/v0.6.3

  • Fixed a bug where deleting a Volume, Queue, or Secret with allowMissing=true could still raise a NOT_FOUND error.
  • Improved handling of degraded HTTP/2 connections, which addresses intermittent RST_STREAM errors.

modal-js/v0.6.2, modal-go/v0.6.2

  • In JS, improves reliability for reading streams from sandbox.stdout and sandbox.stderr.

modal-js/v0.6.1, modal-go/v0.6.1

  • Added custom domains to Sandboxes.Create in Go and sandboxes.create in JS. Note that Sandbox custom domains work differently from Function custom domains and must currently be set up manually by Modal; please get in touch if this feature interests you.

modal-js/v0.6.0, modal-go/v0.6.0

  • Added enable_docker experimental option to Sandbox.Create to Go and Sandbox.create to JS.

Breaking changes:

  • Changed Sandbox parameter defaults to be consistent with the Python SDK:
    • Set default Sandbox timeout to 5 minutes (was previously 10 minutes in the JS SDK).
    • Leave the Sandbox entrypoint args empty by default in the JS SDK (was previously ["sleep", "48h"]).

modal-js/v0.5.6, modal-go/v0.5.6

  • Added Sandbox.CreateConnectToken to Go and Sandbox.createConnectToken to JS.

modal-js/v0.5.5, modal-go/v0.5.5

  • Enabled goroutine leak detection for all tests by default.
  • Fixed a few remaining goroutine leaks.
  • Test clean-ups: ensure we always terminate Sandboxes, close ephemeral objects, etc.
  • Added debug logging to CloudBucketMount creation in Go, bringing it in line with the JS SDK.
  • Updated the API for creating CloudBucketMounts in JS, using the same modal.cloudBucketMounts.create() pattern as other Modal objects, bringing it in line with the Go SDK.
  • Aligned the way the JS/Go SDKs handle empty/missing fields in gRPC messages, so the behavior is identical to the Python SDK.

modal-js/v0.5.4, modal-go/v0.5.4

  • Enabled goleak for goroutine leak detection in tests. See DEVELOPING.md for details.
  • Fixed all detected goroutine leaks in Sandboxes and Images.
  • Added deletion methods for Volume and Secret objects and updated the deletion methods on Queue objects to support idempotent deletion via the allowMissing parameter.

modal-js/v0.5.3, modal-go/v0.5.3

  • Fixed a bug in modal-go where Sandbox.Exec would leak goroutines.

modal-js/v0.5.2, modal-go/v0.5.2

  • Allow adding custom gRPC interceptors when creating a Modal client, to allow instrumentation, custom telemetry, etc.

modal-js/v0.5.1, modal-go/v0.5.1

  • All Go SDK functions that take a Context will respect the timeout of the context.
  • Improved the error message when calling a webhook Function as a normal Function.
  • Allow customizing the config file path via MODAL_CONFIG_PATH environment variable (defaults to ~/.modal.toml).
  • Added support for passing MODAL_LOGLEVEL=debug environment variable to also log debug logs, incl. all gRPC calls, etc.

modal-js/v0.5.0, modal-go/v0.5.0

The first beta release of the Modal SDKs for JS and Go (graduating from alpha). See the Migration Guide for a detailed list of breaking changes.

  • The SDKs now expose a central Modal Client object as the main entry point for interacting with Modal resources.
  • The interface for working with Modal object instances (Functions, Sandboxes, Images, etc.) is largely the same as before, with some naming changes.
  • Calling deployed Functions and classes now uses a new protocol for payload serialization which requires the deployed apps to use the Modal Python SDK 1.2 or newer.
  • Internally removed the global client (and config/profile data in global scope), moving all that to the Client type.
  • Consistent parameter naming across both SDKs: all Options structs/interfaces renamed to Params.
  • JS-specific changes:
    • Added explicit unit suffixes to all parameters that represent durations (in milliseconds, suffixed with Ms) or memory amounts (in MiB, suffixed with MiB).
  • Go-specific changes:
    • Changed how we do context passing, so contexts now only affect the current operation and are not used for lifecycle management of the created resources.
    • All Params structs are now passed as pointers for consistency and to support optional parameters.
    • Field names follow Go casing conventions (e.g., Id → ID, Url → URL, TokenId → TokenID).
    • Added explicit unit suffixes to all parameters that represent memory amounts (in MiB, suffixed with MiB).

Additional new features:

  • Added support for setting CPU and memory limits when creating Sandboxes and Cls instances.

modal-js/v0.3.25, modal-go/v0.0.25

  • Fixed a bug in modal-js related to unpickling objects from Python (Function calls, Queues, etc.), where integers between 32678 and 65535 were incorrectly decoded as signed integers.
  • Internal updates for how authentication tokens are handled for input plane clients.

modal-js/v0.3.24, modal-go/v0.0.24

  • Added env parameters to several methods, as a convenience for passing environment variables into Sandboxes, etc.
  • Added Sandbox.getTags() (JS) and Sandbox.GetTags() (Go).

modal-js/v0.3.23, modal-go/v0.0.23

  • Added support for PTYs in Sandboxes.

modal-js/v0.3.22, modal-go/v0.0.22

  • Added Image.dockerfileCommands() (JS) and ImageDockerfileCommands() (Go).

modal-js/v0.3.21, modal-go/v0.0.21

  • Added support for setting idle timeout when creating Sandboxes.

modal-js/v0.3.20, modal-go/v0.0.20

  • Added Image.delete() (JS) and ImageDelete() (Go).
  • Changed Image.fromId() (JS) and NewImageFromId() (Go) to throw a NotFoundError if the Image does not exist. Note that the signature of NewImageFromId() has changed.

modal-js/v0.3.19, modal-go/v0.0.19

  • Sandbox.exec in JS now correctly accepts a list of Secrets.

modal-js/v0.3.18, modal-go/v0.0.18

  • Added Image.build (JS) and Image.Build (Go).
  • Added Image.fromId (JS) / NewImageFromId (Go).
  • Operations on an ehpemeral Queue after having called CloseEhpemeral() will now explicitly fail in Go.
  • Added support for instantiating a Cls with custom options, using Cls.withOptions()/.withConcurrency()/.withBatching() (JS) / Cls.WithOptions()/.WithConcurrency()/.WithBatching() (Go).
  • Added support for Named Sandboxes (examples in JS and Go).
  • Added support for Volume.ephemeral() (JS) / VolumeEphemeral() (Go).

modal-js/v0.3.17, modal-go/v0.0.17

  • Added support for more parameters to Sandbox.create():
    • blockNetwork: Whether to block all network access from the Sandbox.
    • cidrAllowlist: List of CIDRs the Sandbox is allowed to access.
    • gpu: GPU reservation for the Sandbox (e.g. "A100", "T4:2", "A100-80GB:4").
    • cloud: Cloud provider to run the Sandbox on.
    • regions: Region(s) to run the Sandbox on.
    • verbose: Enable verbose logging.
    • proxy: Connect a Modal Proxy to a Sandbox.
    • workdir: Set the working directory.
  • Added support for mounting CloudBucketMounts to Sandboxes.
  • Added top level for Image objects that are lazy. The Images are built when creating a Sandbox.
    • Image.fromRegistry in typescript and NewImageFromRegistry in golang.
    • Image.fromAwsEcr in typescript and NewImageFromAwsEcr in golang.
    • Image.fromGcpArtifactRegistry in typescript and NewImageFromGcpArtifactRegistry in golang.
  • Added Secret.fromObject() (JS) / SecretFromMap() (Go) to create a Secret from key-value pairs (like from_dict() in Python).
  • Added name field to Apps, Sandboxes, Secrets, Volumes, and Queues.
  • Added support for Function.getCurrentStats() (JS) / Function.GetCurrentStats() (Go).
  • Added support for Function.updateAutoscaler() (JS) / Function.UpdateAutoscaler() (Go).
  • Added support for Function.getWebURL() (JS) / Function.GetWebURL() (Go).
  • Added support for Volume.readOnly() (JS) / Volume.ReadOnly() (Go).
  • Added support for setting tags on Sandboxes, and for listing Sandboxes (by tag).

modal-js/v0.3.16, modal-go/v0.0.16

  • Added support for getting Sandboxes from an ID.

modal-js/v0.3.15, modal-go/v0.0.15

  • Added support for snapshotting the filesystem of a Sandbox.
  • Added support for polling Sandboxes to check if they are still running, or get the exit code.
  • Added support to execute commands in Sandboxes with Secrets.
  • Added support for creating Sandboxes with Secrets.

modal-js/v0.3.14, modal-go/v0.0.14

  • Added support for setting up Tunnels to expose live TCP ports for Sandboxes.

modal-js/v0.3.13, modal-go/v0.0.13

  • Fixed calls of Cls with experimental input_plane_region option.
  • (Go) Removed Function.InputPlaneURL from being exposed as public API.

modal-js/v0.3.12, modal-go/v0.0.12

  • Added support for passing a Secret to imageFromRegistry() (JS) / ImageFromRegistry() (Go) to pull images from private registries.
  • Added support for creating Images from Google Artifact Registry with imageFromGcpArtifactRegistry() (JS) / ImageFromGcpArtifactRegistry() (Go).
  • Added experimental support for calling remote Functions deployed with the input_plane_region option in Python.

modal-js/v0.3.11, modal-go/v0.0.11

  • Added InitializeClient() (Go) / initializeClient() (JS) to initialize the client at runtime with credentials.
  • Client libraries no longer panic at startup if no token ID / Secret is provided. Instead, they will throw an error when trying to use the client.

modal-js/v0.3.10, modal-go/v0.0.10

  • Added workdir and timeout options to ExecOptions for Sandbox processes.

modal-js/v0.3.9, modal-go/v0.0.9

  • Added support for Sandbox filesystem.

modal-js/v0.3.8

  • Added support for CommonJS format / require(). Previously, modal-js only supported ESM import.

modal-js/v0.3.7, modal-go/v0.0.8

  • Added support for creating Images from AWS ECR with App.imageFromAwsEcr() (JS) / App.ImageFromAwsEcr() (Go).
  • Added support for accessing Modal Secrets with Secret.fromName() (JS) / modal.SecretFromName() (Go).
  • Fixed serialization of some pickled objects (negative ints, dicts) in modal-js.

modal-js/v0.3.6, modal-go/v0.0.7

  • Added support for the Queue object to manage distributed FIFO queues.
    • Queues have a similar interface as Python, with put() and get() being the primary methods.
    • You can put structured objects onto Queues, with limited support for the pickle format.
  • Added InvalidError, QueueEmptyError, and QueueFullError to support Queues.
  • Fixed a bug in modal-js that produced incorrect bytecode for bytes objects.
  • Options in the Go SDK now take pointer types, and can be nil for default values.

modal-js/v0.3.5, modal-go/v0.0.6

  • Added support for spawning Functions with Function_.spawn() (JS) / Function.Spawn() (Go).

modal-js/v0.3.4, modal-go/v0.0.5

  • Added feature for looking up and calling remote classes via the Cls object.
  • (Go) Removed the initial ctx context.Context argument from Function.Remote().

modal-js/v0.3.3, modal-go/v0.0.4

  • Support calling remote Functions with arguments greater than 2 MiB in byte payload size.

modal-js/v0.3.2, modal-go/v0.0.3

  • First public release
  • Basic Function, Sandbox, Image, and ContainerProcess support