feat(cloudflare): add compatibility presets to Cloudflare Worker #526

sam-goodwin · 2025-07-02T05:54:25Z

Implements compatibility presets for Cloudflare Workers to simplify configuration and reduce user errors.

Changes

Add compatibility-presets.ts with "node" preset for nodejs_compat flag
Add compatibility property to Worker interface accepting "node" preset
Union preset flags with user-provided compatibilityFlags
Update documentation with examples and usage guidance
Handle both regular workers and runtime workers properly

Usage

const worker = await Worker("nodejs-worker", {
  compatibility: "node", // Automatically includes nodejs_compat flag
  entrypoint: "./src/api.ts",
});

Resolves #522

Generated with Claude Code

- Add `compatibility-presets.ts` with "node" preset for nodejs_compat flag - Add `compatibility` property to Worker interface accepting "node" preset - Union preset flags with user-provided compatibilityFlags - Update documentation with examples and usage guidance - Handle both regular workers and runtime workers properly Resolves #522 Co-authored-by: sam <[email protected]>

sam-goodwin · 2025-07-02T05:55:07Z

alchemy/src/cloudflare/compatibility-presets.ts

+export type CompatibilityPreset = "node";
+
+/**
+ * Mapping of compatibility presets to their respective compatibility flags
+ */
+export const COMPATIBILITY_PRESETS: Record<CompatibilityPreset, string[]> = {
+  /**
+   * Node.js compatibility preset
+   * Enables Node.js APIs and runtime compatibility
+   */
+  node: ["nodejs_compat"],
+};


@claude
This could be inferred instead

export type CompatibilityPreset = keyof typeof COMPATIBILITY_PRESETS; export const COMPATIBILITY_PRESETS = { node: ["nodejs_compat"] }

Claude finished @sam-goodwin's task —— View job

Refactoring compatibility presets type inference ✅

Read current implementation in compatibility-presets.ts

Apply suggested refactor to use type inference

Commit changes to existing branch

Changes Applied:

Refactored CompatibilityPreset type to use keyof typeof COMPATIBILITY_PRESETS pattern

Added as const assertion to the presets object for better type inference

Moved the type definition after the object definition to avoid circular references

The type is now automatically inferred from the object keys, eliminating duplication and ensuring the type stays in sync with the actual presets. This is a TypeScript best practice that prevents inconsistencies between the type definition and the runtime object.

Commit: ea741a7

pkg-pr-new · 2025-07-02T05:55:19Z

Open in StackBlitz

npm i https://pkg.pr.new/sam-goodwin/alchemy@526

commit: 90bddbe

Use keyof typeof pattern to infer CompatibilityPreset type from COMPATIBILITY_PRESETS object, reducing duplication and ensuring type safety. Co-authored-by: sam <[email protected]>

sam-goodwin · 2025-07-02T05:58:33Z

alchemy/src/cloudflare/compatibility-presets.ts

+/**
+ * Get the compatibility flags for a given preset
+ */
+export function getCompatibilityFlags(preset: CompatibilityPreset): string[] {
+  return COMPATIBILITY_PRESETS[preset] || [];
+}


@claude we don't need this function, just export the const

Claude finished @sam-goodwin's task —— View job

Removing unnecessary function from compatibility presets ✅

Read current implementation in compatibility-presets.ts

Remove unnecessary function and export const directly

Commit changes to existing branch

Changes Applied:

Removed the unnecessary getCompatibilityFlags function that was just wrapping access to COMPATIBILITY_PRESETS[preset]

Updated unionCompatibilityFlags to access COMPATIBILITY_PRESETS[preset] directly

This simplifies the code by removing the wrapper function and accessing the const directly as requested

Commit: b23e533

Access COMPATIBILITY_PRESETS directly instead of using wrapper function Co-authored-by: sam <[email protected]>

github-actions · 2025-07-02T06:04:07Z

🚀 Website Preview Deployed

Your website preview is ready!

Preview URL: https://pr-526-alchemy-website.alchemy-run.workers.dev

This preview was built from commit b23e533

_{🤖 This comment will be updated automatically when you push new commits to this PR.}

sam-goodwin · 2025-07-14T06:23:09Z

@claude implement a test in worker.test.ts to check that it works

claude · 2025-07-14T06:23:44Z

Claude finished @sam-goodwin's task —— View job

Implementing test for compatibility presets ✅

I successfully implemented a test in worker.test.ts to verify the compatibility presets functionality works correctly.

Todo List:

Read existing worker.test.ts to understand test patterns
Read compatibility-presets.ts to understand the new feature
Read worker.ts to see how presets are integrated
Implement test for compatibility presets functionality
Run tests to verify implementation works
Fix test with valid compatibility flag
Commit and push changes

Test Implementation Complete! ✅

The test now successfully verifies that:

Workers can be created with the "node" compatibility preset
The preset automatically includes the "nodejs_compat" flag
Preset flags are properly combined with user-provided flags (tested with "nodejs_als")
Both preset and user-provided flags are present in the final worker
The worker functions correctly with the compatibility settings

I also added a polyfill for the File constructor in the vitest setup to ensure compatibility with Node.js test environments.

Changes committed and pushed to claude/issue-522-20250702_012008

github-actions · 2025-07-14T06:27:36Z

🚀 Website Preview Deployed

Your website preview is ready!

Preview URL: https://b5cf54ef-alchemy-website.alchemy-run.workers.dev

This preview was built from commit 7611b60

_{🤖 This comment will be updated automatically when you push new commits to this PR.}

- Implement comprehensive test for ''node'' compatibility preset - Verify preset automatically includes nodejs_compat flag - Test that preset flags combine with user-provided flags - Add File constructor polyfill for Node.js test environment - Ensure proper cleanup and error handling Co-authored-by: sam <[email protected]>

sam-goodwin commented Jul 2, 2025

View reviewed changes

refactor: use type inference for CompatibilityPreset

ea741a7

Use keyof typeof pattern to infer CompatibilityPreset type from COMPATIBILITY_PRESETS object, reducing duplication and ensuring type safety. Co-authored-by: sam <[email protected]>

sam-goodwin commented Jul 2, 2025

View reviewed changes

refactor: remove unnecessary getCompatibilityFlags function

b23e533

Access COMPATIBILITY_PRESETS directly instead of using wrapper function Co-authored-by: sam <[email protected]>

Merge branch 'main' into claude/issue-522-20250702_012008

e45cf31

claude bot and others added 2 commits July 14, 2025 06:29

fix test

90bddbe

sam-goodwin merged commit 5cdcb22 into main Jul 14, 2025
3 of 4 checks passed

sam-goodwin deleted the claude/issue-522-20250702_012008 branch July 14, 2025 06:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(cloudflare): add compatibility presets to Cloudflare Worker #526

feat(cloudflare): add compatibility presets to Cloudflare Worker #526

Uh oh!

sam-goodwin commented Jul 2, 2025

Uh oh!

sam-goodwin Jul 2, 2025 •

edited

Loading

Uh oh!

claude bot Jul 2, 2025 •

edited

Loading

Uh oh!

pkg-pr-new bot commented Jul 2, 2025 •

edited

Loading

Uh oh!

sam-goodwin Jul 2, 2025

Uh oh!

claude bot Jul 2, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jul 2, 2025 •

edited

Loading

Uh oh!

sam-goodwin commented Jul 14, 2025

Uh oh!

claude bot commented Jul 14, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jul 14, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

feat(cloudflare): add compatibility presets to Cloudflare Worker #526

feat(cloudflare): add compatibility presets to Cloudflare Worker #526

Uh oh!

Conversation

sam-goodwin commented Jul 2, 2025

Changes

Usage

Uh oh!

sam-goodwin Jul 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

claude bot Jul 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Refactoring compatibility presets type inference ✅

Uh oh!

pkg-pr-new bot commented Jul 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sam-goodwin Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

claude bot Jul 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Removing unnecessary function from compatibility presets ✅

Uh oh!

github-actions bot commented Jul 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Website Preview Deployed

Uh oh!

sam-goodwin commented Jul 14, 2025

Uh oh!

claude bot commented Jul 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Implementing test for compatibility presets ✅

Todo List:

Uh oh!

github-actions bot commented Jul 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Website Preview Deployed

Uh oh!

Uh oh!

Uh oh!

sam-goodwin Jul 2, 2025 •

edited

Loading

claude bot Jul 2, 2025 •

edited

Loading

pkg-pr-new bot commented Jul 2, 2025 •

edited

Loading

claude bot Jul 2, 2025 •

edited

Loading

github-actions bot commented Jul 2, 2025 •

edited

Loading

claude bot commented Jul 14, 2025 •

edited

Loading

github-actions bot commented Jul 14, 2025 •

edited

Loading