Itty-AWS: 34KB AWS SDK for Effect

3 months ago 2

A lightweight (34KB) AWS SDK implementation for Effect implemented with a single Proxy and types generated from the AWS API specifications.

itty-aws captures the entire AWS API surface area, including each API's exact error codes, in 34KB of JavaScript:

Lightweight: Much smaller than AWS SDK v3 (fixed size, single NPM package)
Effect: Type-safe error handling, built-in retries, composable operations
Simple API: client.apiName(..) instead of client.send(Command)
Fast cold starts: No impact on Lambda startup times

import { AWS } from "itty-aws"; import { Effect, Schedule } from "effect"; const ddb = new AWS.DynamoDB({ region: "us-east-1" }); // Type-safe operations with built-in error handling const program = Effect.gen(function* () { const user = yield* ddb.getItem({ TableName: "users", Key: { id: { S: "123" } } }).pipe( Effect.catchTag("ResourceNotFoundException", () => Effect.succeed({ Item: undefined }) ), Effect.retry({ times: 3, schedule: Schedule.exponential("1 second") }) ); return user.Item; });

Caution

Only works with AWS APIs that accept JSON payloads. S3 (based on XML) is currently not supported, but will be in the future using Bun's built-in S3 client and a lightweight XML parser + aws4fetch for node.js.

The official AWS SDK v3 is a massive 200+ NPM package monorepo with an awkward client.send(new Command()) syntax that is a heavy dependency in your bundle. The @effect-aws/* project adapts the AWS SDK v3 to Effect, but at the cost of an additional 200+ NPM packages.

itty-aws implements a standlone AWS SDK with a single 34KB NPM package containing a Proxy and types generated from the Smithy spec. It has a fixed-cost bundle size, meaning that no matter how many services you use, the bundle size will never grow:

Core bundle size: 34.0 KB (minified, excluding Effect.js)
Full bundle size: 228.1 KB (minified, with Effect.js)

itty-aws also brings back the good ol' days of aws-sdk (v2) where you have a single AWS object from which you can instantiate any client for any AWS service. Instead of the clunky client.send(new Command()) syntax, itty-aws supports client.apiName(..) syntax:

const client = new AWS.DynamoDB({ region: "us-east-1" }); // instead of just simply calling a method yield* client.getItem({ TableName: "users", Key: { id: { S: "123" } } })

Compare this to the official AWS SDK v3, which requires you to construct a Command:

import { DynamoDBClient, GetItemCommand } from "@aws-sdk/client-dynamodb"; const client = new DynamoDBClient({ region: "us-east-1" }); // instead of just simply calling a method await client.send(new GetItemCommand({ TableName: "users", Key: { id: { S: "123" } } }))

Import the AWS proxy and create a client for the service you want to use. The service will expose each API as a method that returns an Effect value with the correct response and error types.

import { AWS } from "itty-aws"; import { Effect, Console, Schedule } from "effect"; const ddb = new AWS.DynamoDB({ region: "us-east-1" }); const program = Effect.gen(function* () { // All operations return Effect values with typed errors const response = yield* ddb.getItem({ TableName: "my-table", Key: { pk: { S: "user#123" } } }).pipe( // Handle specific AWS errors Effect.catchTag("ResourceNotFoundException", () => Effect.succeed({ Item: undefined }) ), // Built-in retry with exponential backoff Effect.retry({ times: 3, schedule: Schedule.exponential("1 second"), while: (error) => error._tag === "ThrottlingException" }), Effect.timeout("30 seconds") ); yield* Console.log("Item:", response.Item); }); // Execute the program Effect.runPromise(program);

Each operation's Effect.Effect type specifies exactly which errors can occur:

We scrape all of the @aws-sdk/client-* packages from NPM and then scrape each Service's Smithy Spec from the aws-sdk-js-v3 Github repo.

The spec is then used to generate TypeScript types (types only, no runtime code) for each service in src/services.

The src/client.ts file contains the AWS proxy that is used to dynamically construct:

the Client for a service.
TaggedError types for each error code.

The Service's Client is yet anothe Proxy that intercepts method calls to infer the API name and then submit the request to AWS via aws4fetch which signs the request.

All of the Service's errors are modeled with TaggedErrors, except purely as declare class to avoid the code size cost of a physical class. The AWS proxy detects references ending with Exception and dynamically constructs the correct TaggedError type on the fly.

This dynamic construction is possible because the AWS API has strict naming conventions and a RPC API implemented over REST with a compitable POST request.

Read Entire Article

Itty-AWS: 34KB AWS SDK for Effect

Related

First post on HN – Want to tell about my SaaS to get early u...

Israel begins pumping desalinated water into depleted Sea of...

Real-time market insights, advanced analytics, intuitive wat...