feat(templates): update Cloudflare templates to use `wrangler` v2 #3160

aiji42 · 2022-05-11T13:01:39Z

Update template for cloudflare workers. (#3158)

wrangler.toml: Changed to wrangler v2 style.
package.json: Added wrangler to dependecncies. Updated @cloudflare/workers-types latest. (also pages template)
remix.env.d.ts: Fixed dead link. (also pages template)
README: Removed the sentence about installation of wrangler.

I have confirmed that it is deployable. (https://github.com/aiji42/remix-cf-wrangler-2)

uejima.aiji$ yarn deploy                                                                                             [~/git/remix-cf-wrangler-2]
yarn run v1.22.18
$ npm run build && wrangler publish

> build
> remix build

Building Remix app in production mode...
Built in 385ms
 ⛅️ wrangler 2.0.2
-------------------
Running custom build: npm run build

> build
> remix build

Building Remix app in production mode...
Built in 368ms
Reading public/build/_shared/chunk-LHODYXPX.js...
Skipping - already uploaded.
Reading public/build/_shared/chunk-OGYP3M3B.js...
Skipping - already uploaded.
Reading public/build/entry.client-GY23DEVV.js...
Skipping - already uploaded.
Reading public/build/manifest-289EFF28.js...
Skipping - already uploaded.
Reading public/build/root-NVPFOTJV.js...
Skipping - already uploaded.
Reading public/build/routes/index-UD6EN4U7.js...
Skipping - already uploaded.
Reading public/favicon.ico...
Skipping - already uploaded.
↗️  Done syncing assets
Uploaded remix-cf-wrangler-2 (2.18 sec)
Published remix-cf-wrangler-2 (0.31 sec)
  remix-cf-wrangler-2.aiji422990.workers.dev
✨  Done in 7.46s.

templates/cloudflare-pages/package.json

templates/cloudflare-workers/wrangler.toml

MichaelDeBoey · 2022-05-11T14:19:45Z

@jacob-ebey Is there a reason why cloudflare-pages template doesn't have a wrangler.toml file? 🤔
It seems odd that we have one in cloudflare-workers but not in cloudflare-pages, even though we have wranglerindevDependencies`

himorishige · 2022-05-17T04:42:57Z

Thank you for providing a useful template.

One suggestion would be.

The kv-asset-handler installed from the template seemed to be v0.1.3.
Since v0.2.0, some definitions have changed, such as getAssetFromKV, etc.
I would like to see kv-asset-handler also bundled with v0.2.0 or higher.

https://github.com/cloudflare/kv-asset-handler/releases/tag/v0.2.0

MichaelDeBoey · 2022-05-17T08:04:42Z

@aiji42 Could you please rebase this PR onto latest main & resolve conflicts?

aiji42 · 2022-05-17T13:58:22Z

@MichaelDeBoey I have resolved the conflicts! 👍

aiji42 · 2022-05-17T14:38:37Z

@himorishige
I am not familiar with @cloudflare/kv-asset-handler, please give me more details. If you don't update it, will you run into trouble?
This PR is some changes to templates and will not involve a release since the merge target is the main branch. If the update is mandatory, then this PR is not sufficient. However, if it is not mandatory, then it should be fixed in another (release-oriented) one.

acusti · 2022-05-17T18:19:00Z

@aiji42 thanks for putting this together! i just applied your changes manually (updating wrangler.toml and adding wrangler v2.0.5 as a dev dependency) and it works perfectly.

for anyone else running into issues and searching for answers, i originally tried to create a new remix project using cloudflare-workers as the build target, and when i installed wrangler using the instructions in the doc that the remix template’s README links to and ran npm run deploy, i got the following output:

 ⛅️ wrangler 2.0.5
-------------------
▲ [WARNING] Processing wrangler.toml configuration:

    - 😶 Ignored: "type":
      Most common features now work out of the box with wrangler, including modules, jsx,
  typescript, etc. If you need anything more, use a custom build.
    - Deprecation: "zone_id":
      This is unnecessary since we can deduce this from routes directly.
    - Deprecation: "build.upload.format":
      The format is inferred automatically from the code.
    - Deprecation: "site.entry-point":
      Delete the `site.entry-point` field, then add the top level `main` field to your configuration
  file:
      ```
      main = "index.js"
      ```


✘ [ERROR] Processing wrangler.toml configuration:

    - Expected "route" to be either a string, or an object with shape { pattern, zone_id | zone_name
  }, but got "".

replacing the contents of wrangler.toml with this will make it work:

name = "remix-cloudflare-workers"

compatibility_date = "2022-05-11"

account_id = ""
workers_dev = true
main = "./build/index.js"

[site]
bucket = "./public"

[build]
command = "npm run build"

himorishige · 2022-05-18T07:13:12Z

@aiji42

Thanks for your feedback. As you indicated, it may not necessarily need to be updated as a template. We will withdraw this proposal.
@cloudflare/kv-asset-handler is used to create a Worker environment that is an adapter instead of server.js when using DO. But I don't think that is necessary for the template.

zwily · 2022-05-19T21:15:25Z

Wrangler 2 also includes miniflare, so should this change also remove the explicit miniflare dependency from cloudflare-workers and change the start and dev:miniflare scripts to call wrangler dev --local?

zwily · 2022-05-20T15:39:59Z

Wrangler 2 also includes miniflare, so should this change also remove the explicit miniflare dependency from cloudflare-workers and change the start and dev:miniflare scripts to call wrangler dev --local?

Except, I just found this in the Cloudflare Discord:

Workers Sites projects will still deploy with wrangler2, however, you can no longer create them. We recommend using Cloudflare Pages instead.

Given that Remix on Workers relies on being a worker site, shouldn't we stick with wrangler 1?

zwily · 2022-05-26T02:40:19Z

Workers Sites projects will still deploy with wrangler2, however, you can no longer create them. We recommend using Cloudflare Pages instead.

Given that Remix on Workers relies on being a worker site, shouldn't we stick with wrangler 1?

I just tested this - I created a new Workers app with npx create-remix, and then applied the changes in this patchset to it to get it on wrangler 2, and it created and deployed the site just fine. So I'm not sure what that note in the Cloudflare Discord could be referring to.

terribleplan · 2022-05-31T14:23:34Z

I arrived at these changes independently of seeing this PR since the CF docs now say to use wrangler2 from NPM. Most things seem to be working except for static asset serving.

I can see the assets get uploaded, stored in a KV namespace, and be requested by a client, but something either in @cloudflare/kv-asset-handler or how it is called is not working correctly, and I am getting a 404 for files under /build.

I tried messing with publicPath in remix.config.js (as the assets in KV are prefixed with public/build and I am unsure how mapping from a request path to KV key works) with no change.

I wonder if this might be related to the "you can no longer create them" mentioned above, as this is a new worker/site, and as far as I can tell everything should be working. Using pages is also sadly a non-starter at the moment as pages does not support R2 bindings yet and the (CF) docs poorly explain the new manual upload deployment method (as this project isn't in github/gitlab).

ETA: It looks like serving favicon works, so it may be some deeper issue.

It is also worth noting that I had to manually resolve miniflare (when using yarn at least) as different versions were being installed to satisfy the direct dev dependency vs the dependency through wrangler, which was causing weird issues in dev (failing to parse incoming requests).

  "resolutions": {
    "miniflare": "^2.5.0"
  }

pyrossh · 2022-06-09T11:11:34Z

I got it working with the above instructions on wrangler 2. The images are working fine for me as I import them in code though not served statically.

n3oney · 2022-06-28T12:39:05Z

Just a question. Does the deploy script in the package.json actually need the npm run build before wrangler publish, if we already have a npm run build in the build section of the wrangler.toml? It seems like it's going to build it twice.

john-griffin · 2022-07-23T13:05:25Z

What is left to do here? Need a hand with anything? Wrangler 2 is the official way forward and I'm seeing a lot of people in the community confused when generating a new app.

MichaelDeBoey · 2022-07-24T00:55:45Z

@aiji42 Could you please rebase your branch on latest dev & resolve conflicts?

aiji42 · 2022-07-24T01:16:56Z

@MichaelDeBoey
Is it latest dev, not latest main? I have main as the target branch since it is a template change.
Also, the version of wrangler has been upgraded, so I will update to use the latest.

changeset-bot · 2022-07-24T02:23:18Z

⚠️ No Changeset found

Latest commit: 9be7d88

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

aiji42 · 2022-07-24T02:25:17Z

templates/cloudflare-workers/wrangler.toml

@@ -1,6 +1,5 @@
 name = "remix-cloudflare-workers"

-account_id = ""


Removed account_id due to the following warning during deployment.

$ wrangler publish ⛅️ wrangler 2.0.22 -------------------- ▲ [WARNING] Processing wrangler.toml configuration: - The "account_id" field in your configuration is an empty string and will be ignored. Please remove the "account_id" field from your configuration.

aiji42 · 2022-07-24T02:29:30Z

I rebased to the latest main and then resolved the conflicts. I updated to the latest wrangler.

MichaelDeBoey

Still wondering if we also need a wrangler.toml for cloudflare-pages 🤔

CC/ @jacob-ebey

aiji42 · 2022-07-24T12:28:08Z

@MichaelDeBoey
No need for a wrangler.toml in cloudflare-pages application.
This is because the repositories are linked from the Cloudflare Pages dashboard to build and deploy.
https://developers.cloudflare.com/pages/framework-guides/remix/

kentcdodds

Looks good. Thank you!

remix-cla-bot bot added the CLA Signed label May 11, 2022

machour added template:cloudflare-pages template:cloudflare-workers labels May 11, 2022

MichaelDeBoey requested changes May 11, 2022

View reviewed changes

templates/cloudflare-pages/package.json Outdated Show resolved Hide resolved

templates/cloudflare-workers/wrangler.toml Outdated Show resolved Hide resolved

MichaelDeBoey changed the title ~~fix(templates): update cloudflare templates (use wrangler v2)~~ feat(templates): update Cloudflare templates to use wrangler v2 May 11, 2022

MichaelDeBoey requested a review from jacob-ebey May 11, 2022 14:19

aiji42 force-pushed the main branch from e23b475 to d00945f Compare May 11, 2022 14:28

MichaelDeBoey approved these changes May 11, 2022

View reviewed changes

MichaelDeBoey force-pushed the main branch from d00945f to d3079b7 Compare May 12, 2022 09:10

remix-run deleted a comment from changeset-bot bot May 12, 2022

himorishige mentioned this pull request May 16, 2022

Unable to deploy remix app to CF Workers with Wrangler 2 #3199

Closed

MichaelDeBoey added the needs-response We need a response from the original author about this issue/PR label May 17, 2022

aiji42 force-pushed the main branch from 104b983 to e9af2a1 Compare May 17, 2022 13:56

github-actions bot removed the needs-response We need a response from the original author about this issue/PR label May 17, 2022

MichaelDeBoey force-pushed the main branch from e9af2a1 to 45781f9 Compare May 26, 2022 12:32

MichaelDeBoey mentioned this pull request May 29, 2022

feat(templates/cloudflare-pages): updates the wrangler cli to use the latest one #3324

Closed

MichaelDeBoey force-pushed the main branch from 45781f9 to 6f6eb97 Compare May 29, 2022 12:52

nksaraf mentioned this pull request Jun 28, 2022

Fix cloudflare templates & adapter to use wrangler 2 solidjs/solid-start#160

Closed

MichaelDeBoey force-pushed the main branch from 6f6eb97 to 04e69bf Compare June 28, 2022 13:22

MichaelDeBoey assigned jacob-ebey Jun 28, 2022

MichaelDeBoey requested review from mcansh and kentcdodds July 24, 2022 00:54

MichaelDeBoey added the needs-response We need a response from the original author about this issue/PR label Jul 24, 2022

feat(templates): update Cloudflare templates to use wrangler v2

9be7d88

aiji42 force-pushed the main branch from 04e69bf to 9be7d88 Compare July 24, 2022 02:23

aiji42 commented Jul 24, 2022

View reviewed changes

MichaelDeBoey approved these changes Jul 24, 2022

View reviewed changes

MichaelDeBoey removed the needs-response We need a response from the original author about this issue/PR label Jul 24, 2022

MichaelDeBoey assigned kentcdodds Jul 24, 2022

kentcdodds approved these changes Jul 26, 2022

View reviewed changes

kentcdodds merged commit 97999d0 into remix-run:main Jul 26, 2022

MichaelDeBoey mentioned this pull request Aug 24, 2022

fix(templates/cloudflare-pages,cloudflare-workers): update required node version #2457

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(templates): update Cloudflare templates to use `wrangler` v2 #3160

feat(templates): update Cloudflare templates to use `wrangler` v2 #3160

aiji42 commented May 11, 2022

MichaelDeBoey commented May 11, 2022

himorishige commented May 17, 2022

MichaelDeBoey commented May 17, 2022

aiji42 commented May 17, 2022

aiji42 commented May 17, 2022 •

edited

Loading

acusti commented May 17, 2022

himorishige commented May 18, 2022

zwily commented May 19, 2022 •

edited

Loading

zwily commented May 20, 2022

zwily commented May 26, 2022

terribleplan commented May 31, 2022 •

edited

Loading

pyrossh commented Jun 9, 2022

n3oney commented Jun 28, 2022

john-griffin commented Jul 23, 2022

MichaelDeBoey commented Jul 24, 2022

aiji42 commented Jul 24, 2022

changeset-bot bot commented Jul 24, 2022

aiji42 Jul 24, 2022

aiji42 commented Jul 24, 2022

MichaelDeBoey left a comment

aiji42 commented Jul 24, 2022

kentcdodds left a comment

		@@ -1,6 +1,5 @@
		name = "remix-cloudflare-workers"

		account_id = ""

feat(templates): update Cloudflare templates to use wrangler v2 #3160

feat(templates): update Cloudflare templates to use wrangler v2 #3160

Conversation

aiji42 commented May 11, 2022

MichaelDeBoey commented May 11, 2022

himorishige commented May 17, 2022

MichaelDeBoey commented May 17, 2022

aiji42 commented May 17, 2022

aiji42 commented May 17, 2022 • edited Loading

acusti commented May 17, 2022

himorishige commented May 18, 2022

zwily commented May 19, 2022 • edited Loading

zwily commented May 20, 2022

zwily commented May 26, 2022

terribleplan commented May 31, 2022 • edited Loading

pyrossh commented Jun 9, 2022

n3oney commented Jun 28, 2022

john-griffin commented Jul 23, 2022

MichaelDeBoey commented Jul 24, 2022

aiji42 commented Jul 24, 2022

changeset-bot bot commented Jul 24, 2022

⚠️ No Changeset found

aiji42 Jul 24, 2022

Choose a reason for hiding this comment

aiji42 commented Jul 24, 2022

MichaelDeBoey left a comment

Choose a reason for hiding this comment

aiji42 commented Jul 24, 2022

kentcdodds left a comment

Choose a reason for hiding this comment

feat(templates): update Cloudflare templates to use `wrangler` v2 #3160

feat(templates): update Cloudflare templates to use `wrangler` v2 #3160

aiji42 commented May 17, 2022 •

edited

Loading

zwily commented May 19, 2022 •

edited

Loading

terribleplan commented May 31, 2022 •

edited

Loading