Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
468 lines (303 loc) · 21.8 KB

CONTRIBUTING.md

File metadata and controls

468 lines (303 loc) · 21.8 KB

Contributing

Wrangler is an open-source project and we welcome contributions from you. Thank you!

Below you can find some guidance on how to be most effective when contributing to the project.

Before getting started

We really appreciate your interest in making a contribution, and we want to make sure that the process is as smooth and transparent as possible! To this end, we note that the Workers team is actively doing development in this repository, and while we consistently strive to communicate status and current thinking around all open issues, there may be times when context surrounding certain items is not up to date. Therefore, for non-trivial changes, please always engage on the issue or create a discussion or feature request issue first before writing your code. This will give us opportunity to flag any considerations you should be aware of before you spend time developing. Of course, for trivial changes, please feel free to go directly to filing a PR, with the understanding that the PR itself will serve as the place to discuss details of the change.

Thanks so much for helping us improve the workers-sdk, and we look forward to your contribution!

Getting started

Set up your environment

Wrangler is built and run on the Node.js JavaScript runtime.

  • Install the latest LTS version of Node.js - we recommend using a Node version manager like nvm.
  • Install a code editor - we recommend using VS Code.
  • Install the git version control tool.

Fork and clone this repository

For External Contributors

Any contributions you make will be via Pull Requests on GitHub developed in a local git repository and pushed to your own fork of the repository.

  • Ensure you have created an account on GitHub.

  • Create your own fork of this repository.

  • Clone your fork to your local machine

    git clone https://github.com/<your-github-username>/workers-sdk
cd workers-sdk

    You can see that your fork is setup as the origin remote repository. Any changes you wish to make should be in a local branch that is then pushed to this origin remote.

    git remote -v
origin	https://github.com/<your-github-username>/workers-sdk (fetch)
origin	https://github.com/<your-github-username>/workers-sdk (push)

  • Add cloudflare/workers-sdk as the upstream remote repository.

    git remote add upstream https://github.com/cloudflare/workers-sdk
git remote -v
origin	https://github.com/<your-github-username>/workers-sdk (fetch)
origin	https://github.com/<your-github-username>/workers-sdk (push)
upstream	https://github.com/cloudflare/workers-sdk (fetch)
upstream	https://github.com/cloudflare/workers-sdk (push)

  • You should regularly pull from the main branch of the upstream repository to keep up to date with the latest changes to the project.

    git switch main
git pull upstream main
From https://github.com/cloudflare/workers-sdk
* branch            main       -> FETCH_HEAD
Already up to date.

For Cloudflare Employees

If you are a Cloudflare employee, you do not need to fork the repository - instead, you can clone the main repository directly. This allows you to push branches directly to the upstream repository.

If you find that you don't have write access, please reach out to your manager or the Wrangler team internally.

Clone the main repository:

git clone https://github.com/cloudflare/workers-sdk.git
cd workers-sdk

Create new branches directly in the cloned repository and push them to the main repository:

git checkout -b <new-branch-name>
git push origin <new-branch-name>

Install dependencies

Warning When working on Wrangler, you'll need to satisfy workerd's libc++1 runtime dependencies:

  • On Linux:
    • libc++ (e.g. the package libc++1 on Debian Bullseye)
  • On macOS:
    • The XCode command line tools, which can be installed with xcode-select --install

The Node.js dependencies of the project are managed by the pnpm tool.

This repository is setup as a mono-repo of workspaces. The workspaces are stored in the packages directory.

While each workspace has its own dependencies, you install the dependencies using pnpm at the root of the project.

If you haven't used pnpm before, you can install it with npm install -g pnpm

  • Install all the dependencies

    cd workers-sdk
pnpm install

Building and running

Workspaces in this project are mostly written in TypeScript and compiled, by esbuild, into JavaScript bundles for distribution.

  • Run a distributable for a specific workspace (e.g. wrangler)

    pnpm run --filter wrangler start

  • Build a distributable for a specific workspace (e.g. wrangler)

    pnpm run build --filter wrangler

Checking the code

The code in the repository is checked for type checking, formatting, linting and testing errors.

  • Run all checks in all the workspaces

    pnpm run check

When doing normal development, you may want to run these checks individually.

Type Checking

The code is checked for type errors by TypeScript.

  • Type check all the code in the repository

    pnpm run check:type

  • VS Code will also run type-checking while editing source code, providing immediate feedback.

Changing TypeScript Version in VS Code's Command Palette

For TypeScript to work properly in the Monorepo the version used in VSCode must be the project's current TypeScript version, follow these steps:

  1. Open the project in VSCode.

  2. Press Ctrl + Shift + P (or Cmd + Shift + P on macOS) to open the command palette.

  3. In the command palette, type "Select TypeScript Version" and select the command with the same name that appears in the list.

  4. A submenu will appear with a list of available TypeScript versions. Choose the desired version you want to use for this project. If you have multiple versions installed, they will be listed here.

    • Selecting "Use Workspace Version" will use the version of TypeScript installed in the project's node_modules directory.

  5. After selecting the TypeScript version, VSCode will reload the workspace using the chosen version.

Now you have successfully switched the TypeScript version used within the project via the command palette in VSCode. Remember that this change is specific to the current project and will not affect other projects or the default TypeScript version used by VSCode.

Linting

The code is checked for linting errors by ESLint.

  • Run the linting checks

    pnpm run check:lint

  • The repository has a recommended VS Code plugin to run ESLint checks while editing source code, providing immediate feedback.

Formatting

The code is checked for formatting errors by Prettier.

  • Run the formatting checks

    pnpm run check:format

  • The repository has a recommended VS Code plugin to run Prettier checks, and to automatically format using Prettier, while editing source code, providing immediate feedback

  • Use the following command to run prettier on the codebase

    pnpm run prettify

Testing

Tests in a workspace are executed, by Vitest, which is configured to automatically compile and bundle the TypeScript before running the tests.

  • If you have recently rebased on main then make sure you have installed any new dependencies

    pnpm i

  • Run the tests for all the workspaces

    pnpm run test

    :::note Cloudflare employees may need to turn off WARP for the first time they run the Miniflare tests so that it can request and cache the CF properties without getting the following error.

    failed: TLS peer's certificate is not trusted; reason = self signed certificate in certificate chain

    After this request is cached you can run tests with WARP turned on, no problem. :::

  • Run the tests for a specific workspace (e.g. wrangler)

    pnpm run test --filter wrangler

  • Watch the files in a specific workspace (e.g. wrangler), and run the tests when anything changes

    pnpm run --filter wrangler test:watch

    This will also run all the tests in a single process (rather than in parallel shards) and will increase the test-timeout to 50 seconds, which is helpful when debugging.

Steps For Making Changes

Every change you make should be stored in a git commit. Changes should be committed to a new local branch, which then gets pushed to your fork of the repository on GitHub.

  • Ensure your main branch is up to date

    git switch main
git pull upstream main

  • Create a new branch, based off the main branch

    git checkout -b <new-branch-name> main

  • Stage files to include in a commit

    • Use VS Code
    • Or add and commit files via the command line
    git add <paths-to-changes-files>
git commit

  • Push changes to your fork

    git push -u origin <new-branch-name>

  • Once you are happy with your changes, create a Pull Request on GitHub

  • The format for Pull Request titles is [package name] description, where the package name should indicate which package of the workers-sdk monorepo your PR pertains to (e.g. wrangler/pages-shared/chrome-devtools-patches), and the description should be a succinct summary of the change you're making.

  • GitHub will insert a template for the body of your Pull Request—it's important to carefully fill out all the fields, giving as much detail as possible to reviewers.

Git Hygiene

Making sure your branch follows our recommendations for git will help ensure your PR is reviewed & released as quickly as possible:

  • When opening a PR (before the first review), try and make sure your git commit history is clean, and clearly describes the changes you want to make.
  • Once your PR has been reviewed, when addressing feedback try not to modify already reviewed commits with force pushes. This slows down the review process and makes it hard to keep track of what changes have been made. Instead, add additional commits to your PR to address any feedback (git commit --fixup is a helpful tool here).
  • When merging your PR into main, workers-sdk enforces squash merges. As such, please try and make sure that the commit message associated with the merge clearly describes the entire change your PR makes.

PR Review

PR review is a critical and required step in the process for landing changes. This is an opportunity to catch potential issues, improve the quality of the work, celebrate good design, and learn from each other. As a reviewer, it's important to be thoughtful about the proposed changes and communicate any feedback.

PR Previews

Every PR will have an associated pre-release build for all releasable packages within the repository, powered by pkg.pr.new. You can find links to prereleases for each package in a comment automatically posted by GitHub Actions on each opened PR (for example).

It's also possible to generate preview builds for the applications in the repository. These aren't generated automatically because they're pretty slow CI jobs, but you can trigger preview builds by adding one of the following labels to your PR:

Once built, you can find the preview link for these applications in the Deploy Pages Previews action output

PR Tests

Every PR should include tests for the functionality that's being added. Most changes will be to Wrangler (using Vitest), Miniflare (using Ava), or C3 (using Vitest), and should include unit tests within the testing harness of those packages. For documentation on how these testing frameworks work, see:

If your PR includes functionality that's difficult to unit test, you can add a fixture test by creating a new package in the fixtures/ folder. This allows for adding a test that requires a specific filesystem or worker setup (for instance, fixtures/no-bundle-import tests the interaction of Wrangler with a specific set of JS, WASM, text, and binary modules on the filesystem). When adding a fixture test, include a vitest.config.mts file within the new package, which will ensure it's run as part of the workers-sdk CI. You should merge your own configuration with the default config from the root of the repo.

A good default example is the following:

import { defineProject, mergeConfig } from "vitest/config";
import configShared from "../../vitest.shared";

export default mergeConfig(
  configShared,
  defineProject({
    test: {
      // config overrides
    }
  })
});

If you need to test the interaction of Wrangler with a real Cloudflare account, you can add an E2E test within the packages/wrangler/e2e folder. This lets you add a test for functionality that requires real credentials (i.e. testing whether a worker deployed from Wrangler can be accessed over the internet).

A summary of this repositories actions can be found in the .github/workflows folder

Running E2E tests locally

A large number of Wrangler, C3 & Vite's E2E tests don't require any authentication, and can be run with no Cloudflare account credentials. These can be run as follows, optionally providing CLOUDFLARE_ACCOUNT_ID and CLOUDFLARE_API_TOKEN environment variables.:

  • Vite: pnpm test:e2e -F @cloudflare/vite-plugin

    You may optionally want to append a filename pattern to limit which e2e tests are run. Also you may want to set --bail=n to limit the number of fails tests to show the error before the rest of the tests finish running and to limit the noise in that output:

    pnpm test:e2e -F @cloudflare/vite-plugin [file-pattern] --bail=1

  • C3: pnpm test:e2e -F create-cloudflare

    See C3 E2E tests README for more information.

  • Wrangler: pnpm test:e2e -F wrangler or pnpm test:e2e:wrangler

    See Wrangler E2E tests README for more information.

Creating an API Token

If you want to run the E2E tests that access the Cloudflare API (e.g. for testing Worker deployment and interaction with bindings), you can create an API token for running the tests:

  1. Go to "My Profile" > "User API Tokens"
  2. Click "Create Token"
  3. Use the "Edit Cloudflare Workers" template
  4. Set "Account Resources" to "Include" the account you want to use for running the test (for internal and CI use, this needs to be the "DevProd Testing" account)
  5. No "Zone Resources" are required for general use (for internal and CI use, this needs to be set to "All Zones")
  6. Click "Continue to summary"
  7. Verify your token works by running the curl command provided

Once you've created the token, you can use it when running E2E tests to test against the API:

# Vite
CLOUDFLARE_ACCOUNT_ID="<Account ID for the token you just created>" CLOUDFLARE_API_TOKEN="<Token you just created>" pnpm test:e2e -F @cloudflare/vite-plugin

# C3
CLOUDFLARE_ACCOUNT_ID="<Account ID for the token you just created>" CLOUDFLARE_API_TOKEN="<Token you just created>" pnpm test:e2e -F @create-cloudflare

# Wrangler
CLOUDFLARE_ACCOUNT_ID="<Account ID for the token you just created>" CLOUDFLARE_API_TOKEN="<Token you just created>" pnpm test:e2e:wrangler

Note

Workers and other resources created in the E2E tests might not always be cleaned up. Internal users with access to the "DevProd Testing" account can rely on an automated job to clean up the Workers and other resources, but if you use another account, please be aware you may want to manually delete the Workers and other resources yourself.

Changesets

Every non-trivial change to the project - those that should appear in the changelog - must be captured in a "changeset". We use the changesets tool for creating changesets, publishing versions and updating the changelog.

  • Create a changeset for the current change.

    pnpm changeset

  • Select which workspaces are affected by the change and whether the version requires a major, minor or patch release.

  • Update the generated changeset with a description of the change.

  • Include the generate changeset in the current commit.

    git add ./changeset/*.md

Changeset message format

Each changeset is a file that describes the change being merged. This file is used to generate the changelog when the changes are released.

To help maintain consistency in the changelog, changesets should have the following format:

<TITLE>

<BODY>
  • TITLE should be a single sentence containing an imperative description of the change.
  • BODY should be one or more paragraphs that go into more detail about the reason for the change and anything notable about the approach taken.

Changeset file example

The generated changeset file will contain the package name and type of change (eg. patch, minor, or major), followed by our changeset format described above.

Here's an example of a patch to the wrangler package:

---
"wrangler": patch
---

Replace the word "publish" with "deploy" everywhere.

We should be consistent with the word that describes how we get a worker to the edge. The command is `deploy`, so let's use that everywhere.

Types of changes

We use the following guidelines to determine the kind of change for a PR:

  • Bugfixes and experimental, beta, and pre-1.0-package features are considered to be 'patch' changes. Be sure to log warnings when experimental features are used.
  • New stable features and new deprecation warnings for future breaking changes are considered 'minor' changes. These changes shouldn't break existing code, but the deprecation warnings should suggest alternate solutions to not trigger the warning.
  • Breaking changes are considered to be 'major' changes. These are usually when deprecations take effect, or functional breaking behaviour is added with relevant logs (either as errors or warnings). Note: breaking changes for experimental, beta, or pre-1.0-package features are considered to be 'minor' changes.

Styleguide

When contributing to Wrangler, please refer to the STYLEGUIDE.md file file where possible to help maintain consistent patterns throughout Wrangler.

Releases

We generally cut Wrangler releases on Tuesday & Thursday each week. If you need a release cut outside of the regular cadence, please reach out to the @cloudflare/wrangler-admins team.

Hotfix releases

Only members of @cloudflare/wrangler can trigger a hotfix release. A hotfix release should be treated as a solution of last resort—before use, please first check whether the fix can be applied and released using the regular Version Packages release flow.

If a hotfix release of Wrangler, Miniflare, or C3 is required, you should:

  • Prepare a hotfix release PR:

    • Checkout the previous release of workers-sdk
    • Apply the changes that should be in the hotfix
    • Manually, increment the patch version of the packages that should be released as part of the hotfix
    • Manually, update the changelog for the package(s) being released.

  • Get approvals for that PR, and make sure CI checks are passing

  • Manually trigger a hotfix release from that PR using the "Release a hotfix" GitHub action.

    • Make sure you set the dist-tag to latest
    • Optionally, you can first publish it to the hotfix dist-tag on NPM in order to verify the release.

  • [CRUCIAL] Once the hotfix release is out and verified, merge the fixes into main before the next regular release of workers-sdk.

    • Make sure that the version number of the released package(s) on main are the same as the versions that were released to ensure that any subsequent changesets will bump the version correctly for the next release.