Merge pull request #72 from WalshyDev/walshy/pages-996-support-wrangler2

Support wrangler2 - v2

.github/workflows/deploy.yml

@@ -0,0 +1,91 @@
+on: push
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    name: Lint
+    steps:
+    - uses: actions/checkout@v2
+    - name: Lint shell script
+      uses: azohra/shell-linter@v0.3.0
+      with:
+        path: "entrypoint.sh"
+  build-only:
+    runs-on: ubuntu-latest
+    name: Only build the app
+    steps:
+      - uses: actions/checkout@v2
+      - name: Build app
+        uses: ./
+        with:
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          workingDirectory: "test"
+          publish: false
+          secrets: |
+            SECRET1
+            SECRET2
+          preCommands: echo "*** pre commands ***"
+          postCommands: |
+            echo "*** post commands ***"
+            wrangler build
+            echo "******"
+        env:
+          SECRET1: ${{ secrets.SECRET1 }}
+          SECRET2: ${{ secrets.SECRET2 }}
+  publish:
+    runs-on: ubuntu-latest
+    name: Publish app
+    steps:
+    - uses: actions/checkout@v2
+    - name: Publish app
+      uses: ./
+      with:
+        apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+        environment: "production"
+        workingDirectory: 'test'
+  publish_legacy_credentials:
+    runs-on: ubuntu-latest
+    name: Publish app with legacy credentials
+    steps:
+    - uses: actions/checkout@v2
+    - name: Publish app
+      uses: ./
+      with:
+        apiKey: ${{ secrets.CLOUDFLARE_API_KEY }}
+        email: ${{ secrets.CLOUDFLARE_EMAIL }}
+        environment: "production"
+        workingDirectory: 'test'
+  publish_hardcoded_wrangler_version:
+    runs-on: ubuntu-latest
+    name: Publish app with hardcoded Wrangler version
+    steps:
+    - uses: actions/checkout@v2
+    - name: Publish app
+      uses: ./
+      with:
+        apiKey: ${{ secrets.CLOUDFLARE_API_KEY }}
+        email: ${{ secrets.CLOUDFLARE_EMAIL }}
+        environment: "production"
+        wranglerVersion: '1.5.0'
+        workingDirectory: 'test'
+  publish_secrets:
+    runs-on: ubuntu-latest
+    name: Publish app with secrets
+    steps:
+      - uses: actions/checkout@v2
+      - name: Publish app
+        uses: ./
+        with:
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          environment: "production"
+          workingDirectory: "test"
+          secrets: |
+            SECRET1
+            SECRET2
+          preCommands: echo "*** pre command ***"
+          postCommands: |
+            echo "*** post commands ***"
+            echo "******"
+        env:
+          SECRET1: ${{ secrets.SECRET1 }}
+          SECRET2: ${{ secrets.SECRET2 }}

CHANGELOG.md

@@ -0,0 +1,23 @@
+# 2.0.0 (Breaking update)
+
+## Additions
+
+* New `command` input
+    * This allows you to specify the Wrangler command you would like to run.
+    For example, if you want to publish the production version of your Worker you may run `publish --env=production`.
+    * This opens up other possibilities too like publishing a Pages project: `pages publish <directory> --project-name=<name>`.
+* New `accountId` input
+  * This allows you to specify your account ID.
+
+## Removals
+
+* Removed `publish` input (refer to [Breaking changes](#breaking-changes)).
+
+## Changes
+
+-- no changes --
+
+## __Breaking changes__
+
+* `publish` has been removed.
+  * You should instead do `command: publish`.

Dockerfile

@@ -1,5 +1,7 @@
-FROM node:12
+FROM node:16
 ENV XDG_CONFIG_HOME /github/workspace
 ENV WRANGLER_HOME /github/workspace
+
 COPY entrypoint.sh /entrypoint.sh
+
 ENTRYPOINT ["/entrypoint.sh"]

README.md

@@ -1,86 +1,252 @@
 # Wrangler GitHub Action
 
-✨ Zero-config [Cloudflare Workers](https://workers.cloudflare.com) deployment using [Wrangler](https://github.com/cloudflare/wrangler) and [GitHub Actions](https://github.com/actions)
+Easy-to-use GitHub Action to use [Wrangler](https://developers.cloudflare.com/workers/cli-wrangler/). Makes deploying Workers, Pages or modifying R2 easy to do.
+
+[Refer to Changelog for more information](CHANGELOG.md).
 
 ## Usage
 
-Add `wrangler-action` to the workflow for your Workers application. The below example will publish your application on pushes to the `master` branch:
+Add `wrangler-action` to the workflow for your Workers/Pages application. The below example will publish a Worker on a `git push` to the `main` branch:
+
+```yaml
+name: Deploy
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - uses: actions/checkout@v2
+      - name: Publish
+        uses: cloudflare/wrangler-action@2.0.0
+        with:
+          apiToken: ${{ secrets.CF_API_TOKEN }}
+```
+
+## Authentication
+
+You'll need to configure Wrangler using GitHub's Secrets feature - go to "Settings -> Secrets" and add your Cloudflare API token (for help finding this, see the [Workers documentation](https://developers.cloudflare.com/workers/quickstart/#api-token)). Your API token is encrypted by GitHub, and the action won't print it into logs, so it should be safe!
+
+With your API token set as a secret for your repository, pass it to the action in the `with` block of your workflow. Below, I've set the secret name to `CF_API_TOKEN`:
+
+```yaml
+jobs:
+  deploy:
+    name: Deploy
+    steps:
+      uses: cloudflare/wrangler-action@2.0.0
+      with:
+        apiToken: ${{ secrets.CF_API_TOKEN }}
+```
+
+`wrangler-action` also supports using your [global API key and email](https://developers.cloudflare.com/workers/quickstart/#global-api-key) as an authentication method, although API tokens are preferred. Pass in `apiKey` and `email` to the GitHub Action to use this method:
+
+```yaml
+jobs:
+  deploy:
+    name: Deploy
+    steps:
+      uses: cloudflare/wrangler-action@2.0.0
+      with:
+        apiKey: ${{ secrets.CF_API_KEY }}
+        email: ${{ secrets.CF_EMAIL }}
+```
+
+## Configuration
+
+If you need to install a specific version of Wrangler to use for deployment, you can also pass the input `wranglerVersion` to install a specific version of Wrangler from NPM. This should be a [SemVer](https://semver.org/)-style version number, such as `1.6.0`:
+
+```yaml
+jobs:
+  deploy:
+    steps:
+      uses: cloudflare/wrangler-action@2.0.0
+      with:
+        apiToken: ${{ secrets.CF_API_TOKEN }}
+        wranglerVersion: '1.6.0'
+```
+
+Optionally, you can also pass a `workingDirectory` key to the action. This will allow you to specify a subdirectory of the repo to run the Wrangler command from.
+
+```yaml
+jobs:
+  deploy:
+    steps:
+      uses: cloudflare/wrangler-action@2.0.0
+      with:
+        apiToken: ${{ secrets.CF_API_TOKEN }}
+        workingDirectory: 'subfoldername'
+```
+
+[Worker secrets](https://developers.cloudflare.com/workers/tooling/wrangler/secrets/) can be optionally passed as a new line deliminated string of names in `secrets`.  Each secret name must match an environment variable name specified in the `env` attribute.  Creates or replaces the value for the Worker secret using the `wrangler secret put` command.
+
+```yaml
+jobs:
+  deploy:
+    steps:
+      uses: cloudflare/wrangler-action@2.0.0
+      with:
+        apiToken: ${{ secrets.CF_API_TOKEN }}
+        secrets: |
+            SECRET1
+            SECRET2
+      env:
+        SECRET1: ${{ secrets.SECRET1 }}
+        SECRET2: ${{ secrets.SECRET2 }}
+```
+
+If you need to run additional shell commands before or after your command, you can specify them as input to `preCommands` (before `publish`) or `postCommands` (after `publish`). These can include additional `wrangler` commands (that is, `whoami`, `kv:key put`) or any other commands available inside the `wrangler-action` context.
+
+```yaml
+jobs:
+  deploy:
+    steps:
+      uses: cloudflare/wrangler-action@2.0.0
+      with:
+        apiToken: ${{ secrets.CF_API_TOKEN }}
+        preCommands: echo "*** pre command ***"
+        postCommands: |
+          echo "*** post commands ***"
+          wrangler kv:key put --binding=MY_KV key2 value2
+          echo "******"
+```
+
+You can use the `command` option to do specific actions such as running `wrangler whoami` against your project:
+
+```yaml
+jobs:
+  deploy:
+    steps:
+      uses: cloudflare/wrangler-action@2.0.0
+      with:
+        apiToken: ${{ secrets.CF_API_TOKEN }}
+        command: whoami
+```
+
+## Use cases
+
+### Deploy when commits are merged to main
+
+The above workflow examples have already shown how to run `wrangler-action` when new commits are merged to the main branch. For most developers, this workflow will easily replace manual deploys and be a great first integration step with `wrangler-action`:
 
 ```yaml
 on:
   push:
     branches:
-      - master
+      - main
 
 jobs:
   deploy:
     runs-on: ubuntu-latest
     name: Deploy
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v3
       - name: Publish
-        uses: signalnerve/wrangler-action@0.1.4
+        uses: cloudflare/wrangler-action@2.0.0
         with:
-          apiKey: ${{ secrets.apiKey }}
-          email: ${{ secrets.email }}
+          apiToken: ${{ secrets.CF_API_TOKEN }}
 ```
 
-## Configuration
+Note that there are a number of possible events, like `push`, that can be used to trigger a workflow. For more details on the events available, refer to the [GitHub Actions documentation](https://help.github.com/en/articles/workflow-syntax-for-github-actions#on).
 
-You'll need to configure Wrangler using GitHub's Secrets feature - go to "Settings -> Secrets" and add your Cloudflare API key and email (for help finding these, see the [Workers documentation](https://developers.cloudflare.com/workers/quickstart/#finding-your-cloudflare-api-keys)). Your API key and email are encrypted by GitHub, and the action won't print them into logs, so they should be safe!
+### Deploy your Pages site (production & preview)
 
-With your API key and email set as secrets for your repository, pass them to the action in the `with` block of your workflow. Below, I've set the secret names to `apiKey` and `email`:
+If you want to deploy your Pages project with GitHub Actions rather than the built-in continous integration (CI), then this is a great way to do it. Wrangler 2 will populate the commit message and branch for you. You only need to pass the project name. If a push to a non-production branch is done, it will publish as a preview deployment:
 
 ```yaml
+on: [push]
+
 jobs:
   deploy:
+    runs-on: ubuntu-latest
     name: Deploy
     steps:
-      uses: signalnerve/wrangler-action@0.1.4
-      with:
-        apiKey: ${{ secrets.apiKey }}
-        email: ${{ secrets.email }}
+      - uses: actions/checkout@v3
+      - name: Publish
+        uses: cloudflare/wrangler-action@2.0.0
+        with:
+          apiToken: ${{ secrets.CF_API_TOKEN }}
+          accountId: ${{ secrets.CF_ACCOUNT_ID }}
+          command: pages publish --project-name=example
 ```
 
-Optionally, you can also pass an `environment` key to the action. If you're using Wrangler's [environments](https://github.com/cloudflare/wrangler/blob/master/docs/content/environments.md) feature, you can customize _where_ the action deploys to by passing the matching environment in the `with` block of your workflow:
+### Deploying on a schedule
+
+If you would like to deploy your Workers application on a recurring basis – for example, every hour, or daily – the `schedule` trigger allows you to use cron syntax to define a workflow schedule. The below example will deploy at the beginning of every hour:
 
 ```yaml
+on:
+  schedule:
+    - cron: '0 * * * *'
+
 jobs:
   deploy:
-    # ... previous configuration ...
+    runs-on: ubuntu-latest
+    name: Deploy
     steps:
-      uses: signalnerve/wrangler-action@0.1.4
-      with:
-        # ... api key and email ...
-        environment: 'production'
+      - uses: actions/checkout@v3
+      - name: Publish app
+        uses: cloudflare/wrangler-action@2.0.0
+        with:
+          apiToken: ${{ secrets.CF_API_TOKEN }}
 ```
 
+If you need help defining the correct cron syntax, check out [crontab.guru](https://crontab.guru/), which provides a friendly user interface for validating your cron schedule.
+
+### Manually triggering a deployment
+
+If you need to trigger a workflow at-will, you can use GitHub's `workflow_dispatch` [event](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_dispatch) in your workflow file. By setting your workflow to trigger on that event, you will be able to deploy your application via the GitHub UI. The UI also accepts inputs that can be used to configure the action:
+
+```yaml
+on:
+  workflow_dispatch:
+    inputs:
+      environment:
+        description: 'Choose an environment to deploy to: <dev|staging|prod>'
+        required: true
+        default: 'dev'
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - uses: actions/checkout@v3
+      - name: Publish app
+        uses: cloudflare/wrangler-action@2.0.0
+        with:
+          apiToken: ${{ secrets.CF_API_TOKEN }}
+          command: publish --env ${{ github.event.inputs.environment }}
+```
+
+For more advanced usage or to programmatically trigger the workflow from scripts, refer to [the GitHub documentation](https://docs.github.com/en/rest/reference/actions#create-a-workflow-dispatch-event) for making API calls.
+
 ## Troubleshooting
 
-This action is in beta, and I'm looking for folks to use it! If something goes wrong, please file an issue! That being said, there's a couple things you should know:
-
 ### "I just started using Workers/Wrangler and I don't know what this is!"
 
-No problem! Check out the [Quick Start guide](https://developers.cloudflare.com/workers/quickstart) in our docs to get started. Once you have a Workers application, you may want to set it up to automatically deploy from GitHub whenever you change your project. That's where this action comes in - nice!
+Refer to the [Quick Start guide](https://developers.cloudflare.com/workers/quickstart) to get started. Once you have a Workers application, you may want to set it up to automatically deploy from GitHub whenever you change your project.
 
-### "I'm trying to deploy my static site but it isn't working!"
+### "[ERROR] No account id found, quitting.."
 
-To deploy static sites and frontend applications to Workers, check out the documentation for [Workers Sites](https://developers.cloudflare.com/workers/sites).
-
-Note that this action makes no assumptions about _how_ your project is built! **If you need to run a pre-publish step, like building your application, you need to specify a build step in your Workflow.** For instance, if I have an NPM command called `build`, my workflow TOML might resemble the following:
+You will need to add `account_id = ""` in your `wrangler.toml` file or set `accountId` in this GitHub Action.
 
 ```yaml
+on: [push]
+
 jobs:
   deploy:
     runs-on: ubuntu-latest
     name: Deploy
     steps:
-      - uses: actions/checkout@master
-      - name: Build site
-        run: 'npm run build'
-      - name: Publish
-        uses: signalnerve/wrangler-action@0.1.4
+      - uses: actions/checkout@v3
+      - name: Publish app
+        uses: cloudflare/wrangler-action@2.0.0
         with:
-          apiKey: ${{ secrets.apiKey }}
-          email: ${{ secrets.email }}
-```
+          apiToken: ${{ secrets.CF_API_TOKEN }}
+          accountId: ${{ secrets.CF_ACCOUNT_ID }}
+```

action.yml

@@ -1,17 +1,42 @@
-name: 'Deploy to Cloudflare Workers with Wrangler'
+name: "Deploy to Cloudflare Workers with Wrangler"
 branding:
-  icon: 'upload-cloud'
-  color: 'orange'
-description: 'Deploy your Cloudflare Workers applications and sites directly from GitHub, using Wrangler'
+  icon: "upload-cloud"
+  color: "orange"
+description: "Deploy your Cloudflare Workers and Pages projects from GitHub using Wrangler"
 runs:
-  using: 'docker'
-  image: 'Dockerfile'
+  using: "docker"
+  image: "Dockerfile"
 inputs:
   apiKey:
-    description: "Your Cloudflare API Key"
-    required: true
+    description: "(Legacy) Your Cloudflare API Key"
+    required: false
   email:
-    description: "Your Cloudflare Email"
-    required: true
+    description: "(Legacy) Your Cloudflare Email"
+    required: false
+  apiToken:
+    description: "Your Cloudflare API Token"
+    required: false
+  accountId:
+    description: "Your Cloudflare Account ID"
+    required: false
+
   environment:
     description: "The environment you'd like to publish your Workers project to - must be defined in wrangler.toml"
+  workingDirectory:
+    description: "The relative path which Wrangler commands should be run from"
+    required: false
+  wranglerVersion:
+    description: "The version of Wrangler you'd like to use to publish your Workers project"
+    required: false
+  secrets:
+    description: "A new line deliminated string of environment variable names that should be configured as Worker secrets"
+    required: false
+  preCommands:
+    description: "Commands to execute before publishing the Workers project"
+    required: false
+  postCommands:
+    description: "Commands to execute after publishing the Workers project"
+    required: false
+  command:
+    description: "The Wrangler command you wish to run. For example: \"publish\" - this will publish your Worker"
+    required: false

entrypoint.sh

@@ -1,39 +1,161 @@
-#!/bin/sh
+#!/bin/bash
 
 set -e
 
 export HOME="/github/workspace"
-export NVM_DIR="/github/workspace/nvm"
 export WRANGLER_HOME="/github/workspace"
 
-# h/t https://github.com/elgohr/Publish-Docker-Github-Action
-sanitize() {
-  if [ -z "${1}" ]
-  then
-    >&2 echo "Unable to find ${2}. Did you add a GitHub secret called key ${2}, and pass in secrets.${2} in your workflow?"
-    exit 1
-  fi
-}
-
-curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.0/install.sh | bash
-[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
-[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion"
-
 mkdir -p "$HOME/.wrangler"
 chmod -R 770 "$HOME/.wrangler"
 
-sanitize "${INPUT_EMAIL}" "email"
-sanitize "${INPUT_APIKEY}" "apiKey"
+export API_CREDENTIALS=""
 
-export CF_EMAIL="$INPUT_EMAIL"
-export CF_API_KEY="$INPUT_APIKEY"
+# Used to execute any specified pre and post commands
+execute_commands() {
+  echo "$ Running: $1"
+  COMMANDS=$1
+  while IFS= read -r COMMAND; do
+    CHUNKS=()
 
-npm i @cloudflare/wrangler -g
+    for CHUNK in $COMMAND; do
+      CHUNKS+=("$CHUNK")
+    done
 
-if [ -z "$INPUT_ENVIRONMENT" ]
-then
-  wrangler publish
+    eval "${CHUNKS[@]}"
+
+    CHUNKS=()
+  done <<< "$COMMANDS"
+}
+
+secret_not_found() {
+  echo "::error::Specified secret \"$1\" not found in environment variables."
+  exit 1
+}
+
+WRANGLER_VERSION=2
+
+# If no Wrangler version is specified install v2.
+if [ -z "$INPUT_WRANGLERVERSION" ]; then
+  npm i -g wrangler
+
+# If Wrangler version starts with 1 then install wrangler v1
+elif [[ "$INPUT_WRANGLERVERSION" == 1* ]]; then
+  npm i -g "@cloudflare/wrangler@$INPUT_WRANGLERVERSION"
+  WRANGLER_VERSION=1
+
+# Else install Wrangler 2
 else
-  wrangler publish -e "$INPUT_ENVIRONMENT"
+  npm i -g "wrangler@$INPUT_WRANGLERVERSION"
+  WRANGLER_VERSION=2
 fi
 
+# If an API token is detected as input
+if [ -n "$INPUT_APITOKEN" ]; then
+
+  # Wrangler v1 uses CF_API_TOKEN but v2 uses CLOUDFLARE_API_TOKEN
+  if [ $WRANGLER_VERSION == 1 ]; then
+    export CF_API_TOKEN="$INPUT_APITOKEN"
+  else
+    export CLOUDFLARE_API_TOKEN="$INPUT_APITOKEN"
+  fi
+
+  export API_CREDENTIALS="API Token"
+fi
+
+# If an API key and email are detected as input
+if [ -n "$INPUT_APIKEY" ] && [ -n "$INPUT_EMAIL" ]; then
+
+  # Wrangler v1 uses CF_ but v2 uses CLOUDFLARE_
+  if [ $WRANGLER_VERSION == 1 ]; then
+    export CF_EMAIL="$INPUT_EMAIL"
+    export CF_API_KEY="$INPUT_APIKEY"
+  else
+    echo "::error::Wrangler v2 does not support using the API Key. You should instead use an API token."
+    exit 1
+  fi
+  
+  export API_CREDENTIALS="Email and API Key"
+fi
+
+if [ -n "$INPUT_ACCOUNTID" ]; then
+
+  if [ $WRANGLER_VERSION == 1 ]; then
+    export CF_ACCOUNT_ID="$INPUT_ACCOUNTID"
+  else
+    export CLOUDFLARE_ACCOUNT_ID="$INPUT_ACCOUNTID"
+  fi
+  
+fi
+
+if [ -n "$INPUT_APIKEY" ] && [ -z "$INPUT_EMAIL" ]
+then
+  echo "Provided an API key without an email for authentication. Please pass in 'apiKey' and 'email' to the action."
+fi
+
+if [ -z "$INPUT_APIKEY" ] && [ -n "$INPUT_EMAIL" ]
+then
+  echo "Provided an email without an API key for authentication. Please pass in 'apiKey' and 'email' to the action."
+  exit 1
+fi
+
+if [ -z "$API_CREDENTIALS" ]
+then
+  >&2 echo "Unable to find authentication details. Please pass in an 'apiToken' as an input to the action, or a legacy 'apiKey' and 'email'."
+  exit 1
+else
+  echo "Using $API_CREDENTIALS authentication"
+fi
+
+# If a working directory is detected as input
+if [ -n "$INPUT_WORKINGDIRECTORY" ]
+then
+  cd "$INPUT_WORKINGDIRECTORY"
+fi
+
+# If precommands is detected as input
+if [ -n "$INPUT_PRECOMMANDS" ]
+then
+  execute_commands "$INPUT_PRECOMMANDS"
+fi
+
+# If we have secrets, set them
+for SECRET in $INPUT_SECRETS; do
+  VALUE=$(printenv "$SECRET") || secret_not_found "$SECRET"
+
+  if [ -z "$INPUT_ENVIRONMENT" ]; then
+    echo "$VALUE" | wrangler secret put "$SECRET"
+  else
+    echo "$VALUE" | wrangler secret put "$SECRET" --env "$INPUT_ENVIRONMENT"
+  fi
+done
+
+# If there's no input command then default to publish otherwise run it
+if [ -z "$INPUT_COMMAND" ]; then
+  echo "::notice:: No command was provided, defaulting to 'publish'"
+
+ if [ -z "$INPUT_ENVIRONMENT" ]; then
+    wrangler publish
+  else
+    wrangler publish --env "$INPUT_ENVIRONMENT"
+  fi
+
+else
+  if [ -n "$INPUT_ENVIRONMENT" ]; then
+    echo "::notice::Since you have specified an environment you need to make sure to pass in '--env $INPUT_ENVIRONMENT' to your command."
+  fi
+
+  execute_commands "wrangler $INPUT_COMMAND"
+fi
+
+# If postcommands is detected as input
+if [ -n "$INPUT_POSTCOMMANDS" ]
+then
+  execute_commands "$INPUT_POSTCOMMANDS"
+fi
+
+# If a working directory is detected as input, revert to the
+# original directory before continuing with the workflow
+if [ -n "$INPUT_WORKINGDIRECTORY" ]
+then
+  cd $HOME
+fi

test/.gitignore

@@ -0,0 +1 @@
+dist

test/public/index.html

@@ -0,0 +1,6 @@
+<h1>My Static Site Test</h1>
+<p>This is the content of my site</p>
+
+<footer>
+  And this is my footer
+</footer>

test/workers-site/index.js

@@ -0,0 +1,88 @@
+import { getAssetFromKV, mapRequestToAsset } from '@cloudflare/kv-asset-handler'
+
+/**
+ * The DEBUG flag will do two things that help during development:
+ * 1. we will skip caching on the edge, which makes it easier to
+ *    debug.
+ * 2. we will return an error message on exception in your response rather
+ *    than the default 404.html page.
+ */
+const DEBUG = false
+
+addEventListener('fetch', event => {
+  try {
+    event.respondWith(handleEvent(event))
+  } catch (e) {
+    if (DEBUG) {
+      return event.respondWith(
+        new Response(e.message || e.toString(), {
+          status: 500,
+        }),
+      )
+    }
+    event.respondWith(new Response('Internal Error', { status: 500 }))
+  }
+})
+
+async function handleEvent(event) {
+  const url = new URL(event.request.url)
+  let options = {}
+
+  /**
+   * You can add custom logic to how we fetch your assets
+   * by configuring the function `mapRequestToAsset`
+   */
+  // options.mapRequestToAsset = handlePrefix(/^\/docs/)
+
+  // Path to test secrets passed through Wrangler Action.  Create SECRET1 and SECRET2 secrets
+  // in the Action repo to something innocuous like "Hello" and "World!".
+  if (url.pathname === "/secret") {
+    let sec1 = (typeof SECRET1 !== 'undefined') ? SECRET1 : ""
+    let sec2 = (typeof SECRET2 !== 'undefined') ? SECRET2 : ""
+    return new Response(`${sec1} ${sec2}`)
+  }
+  
+  try {
+    if (DEBUG) {
+      // customize caching
+      options.cacheControl = {
+        bypassCache: true,
+      }
+    }
+    return await getAssetFromKV(event, options)
+  } catch (e) {
+    // if an error is thrown try to serve the asset at 404.html
+    if (!DEBUG) {
+      try {
+        let notFoundResponse = await getAssetFromKV(event, {
+          mapRequestToAsset: req => new Request(`${new URL(req.url).origin}/404.html`, req),
+        })
+
+        return new Response(notFoundResponse.body, { ...notFoundResponse, status: 404 })
+      } catch (e) {}
+    }
+
+    return new Response(e.message || e.toString(), { status: 500 })
+  }
+}
+
+/**
+ * Here's one example of how to modify a request to
+ * remove a specific prefix, in this case `/docs` from
+ * the url. This can be useful if you are deploying to a
+ * route on a zone, or if you only want your static content
+ * to exist at a specific path.
+ */
+function handlePrefix(prefix) {
+  return request => {
+    // compute the default (e.g. / -> index.html)
+    let defaultAssetKey = mapRequestToAsset(request)
+    let url = new URL(defaultAssetKey.url)
+
+    // strip the prefix from the path for lookup
+    url.pathname = url.pathname.replace(prefix, '/')
+
+    // inherit all other props from the default request
+    return new Request(url.toString(), defaultAssetKey)
+  }
+}

test/workers-site/package-lock.json

@@ -0,0 +1,21 @@
+{
+  "name": "worker",
+  "version": "1.0.0",
+  "lockfileVersion": 1,
+  "requires": true,
+  "dependencies": {
+    "@cloudflare/kv-asset-handler": {
+      "version": "0.0.5",
+      "resolved": "https://registry.npmjs.org/@cloudflare/kv-asset-handler/-/kv-asset-handler-0.0.5.tgz",
+      "integrity": "sha512-7yLMAUZD1XQNKzmktYCcUUPB+wXmQENv1MMi8QEMs0rzL01e0XEyCUUDauRXHzxi7dBbSUGA5RS23h890ncKog==",
+      "requires": {
+        "mime": "^2.4.4"
+      }
+    },
+    "mime": {
+      "version": "2.4.4",
+      "resolved": "https://registry.npmjs.org/mime/-/mime-2.4.4.tgz",
+      "integrity": "sha512-LRxmNwziLPT828z+4YkNzloCFC2YM4wrB99k+AV5ZbEyfGNWfG8SO1FUXLmLDBSo89NrJZ4DIWeLjy1CHGhMGA=="
+    }
+  }
+}

test/workers-site/package.json

@@ -0,0 +1,12 @@
+{
+  "private": true,
+  "name": "worker",
+  "version": "1.0.0",
+  "description": "A template for kick starting a Cloudflare Workers project",
+  "main": "index.js",
+  "author": "Ashley Lewis <ashleymichal@gmail.com>",
+  "license": "MIT",
+  "dependencies": {
+    "@cloudflare/kv-asset-handler": "^0.0.5"
+  }
+}

test/wrangler.toml

@@ -0,0 +1,11 @@
+name = "static-test"
+type = "webpack"
+workers_dev = true
+account_id = "dc56444c4c955a1653106ccf997c1067"
+
+[env.production]
+name = "static-test-prod"
+
+[site]
+bucket = "./public"
+entry-point = "workers-site"