Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Wrangler v4 migration guide #18726

Draft
wants to merge 5 commits into
base: production
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Migrate from Wrangler v2 to v3
pcx_content_type: how-to
sidebar:
order: 1
order: 2

---

Expand Down
61 changes: 61 additions & 0 deletions src/content/docs/workers/wrangler/migration/update-v3-to-v4.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: Migrate from Wrangler v3 to v4
pcx_content_type: how-to
sidebar:
order: 1

---
Wrangler v4 is a major release focused on updates to underlying systems and dependencies, along with improvements to keep Wrangler commands consistent and clear. While many users should expect a no-op upgrade, the following sections outline significant changes and steps for migrating where necessary.

### Summary of changes
* **Updated Node.js Support Policy:**
Node.js v16, which reached End-of-Life in 2022, is no longer supported in Wrangler v4. Wrangler now follows Node.js's [official support lifecycle](https://nodejs.org/en/about/previous-releases).
Comment on lines +11 to +12
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could this be slightly reworded to make it clear it refers to the versions of Node you can run Wrangler in rather than the version of Node that Wrangler supports (which to me potentially implies that it'd work in a Worker)?


* **esbuild Version Upgrade**: Wrangler v4 uses [esbuild](https://esbuild.github.io/) to bundle Worker code before deploying it, and was previously pinned to esbuild v0.17.19. Wrangler v4 uses esbuild v0.24, which could impact dynamic wildcard imports.

* **Commands default to local mode**: All commands now run in local mode by default, requiring a `--remote` flag for API queries,

* **Changes to KV command output formats**: `wrangler kv list` now outputs data in a format compatible with `wrangler kv bulk delete.`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can remove this


* **Deprecated commands and configurations removed:** Legacy commands, flags, and configurations have been removed.

## Detailed Changes

### Updated Node.js Support Policy

Wrangler now supports only Node.js versions that align with [Node.js's official lifecycle](https://nodejs.org/en/about/previous-releases):
* **Supported**: Current, Active LTS, Maintenance LTS
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it worth calling out that this currently means 18, 20, 22, but we'll be dropping 18 relatively soon?

* **No longer supported:** Node.js v16 (EOL in 2022)

Wrangler tests no longer run on v16, and users still on this version may encounter unsupported behavior. Users still using Node.js v16 must upgrade to a supported version (v18 or higher) to continue receiving support and compatibility with Wrangler.
korinne marked this conversation as resolved.
Show resolved Hide resolved

### esbuild Version Upgrade

Wrangler upgraded esbuild from **v0.17.19** to **v0.24**, bringing improvements (such as the ability to use the `using` keyword with RPC) and changes to bundling behavior:
korinne marked this conversation as resolved.
Show resolved Hide resolved
* **Dynamic imports:** Wildcard imports (e.g., `import('./data/' + kind + '.json')`) now automatically include all matching files in the bundle.
korinne marked this conversation as resolved.
Show resolved Hide resolved


Users relying on wildcard dynamic imports may see unwanted files bundled. Prior to esbuild v0.19, `import` statements with dynamic paths ( like `import('./data/' + kind + '.json')`) did not bundle all files matches the glob pattern (`*.json`) . Only files explicitly referenced or included using `find_additional_modules` were bundled. With esbuild v0.19, wildcard imports now automatically bundle all files matching the glob pattern. This could result in unwanted files being bundled, so users might want to avoid wildcard dynamic imports and use explicit imports instead.

### Commands default to local mode


All commands now run in **local mode by default.** Wrangler has many commands for accessing resources like KV and R2, but the commands were previously inconsistent in whether they run in a local or remote environment. For example, D1 defaults to querying a local datastore, and requires the `--remote` flag to query via the API. KV, on the other hand, previously defaulted to querying via the API (implicitly using the `--remote` flag) and required a `--local` flag to query a local datastore. In order to make the behavior consistent across Wrangler, each command now uses the `--local` flag by default, and will require an explicit `--remote` flag to query via the API.

For example:

* **Previous Behavior (Wrangler v3):** `wrangler kv list` queried remotely by default.
* **New Behavior (Wrangler v4):** `wrangler kv list` queries locally unless `--remote` is specified.


Those using `wrangler kv` and/or `wrangler r2` commands to query or write to their data store will need to add the `--remote` flag in order to replicate previous behavior.

### Changes to KV command output formats

The output format of `wrangler kv list` has been updateed to align with the input format for `wrangler kv bulk delete.`

Scripts or tools relying on the old `wrangler kv list` output format will need to be updated to handle the new format.

### Deprecated Commands and Configurations Removed

TBD
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Migrate from Wrangler v1 to v2
pcx_content_type: how-to
sidebar:
order: 1
order: 3
group:
hideIndex: true
---
Expand Down
Loading