C3-workers-assets-experimental-templates #6678

petebacondarwin · 2024-09-11T15:05:55Z

To try this out:

npx create-cloudflare@latest --experimental

What this PR solves / how to test

Adds experimental support to C3 for generating Workers with Assets projects.

Author has addressed the following

Tests
- TODO (before merge)
- Included
- Not necessary because:
E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
- I don't know
- Required / Maybe required
- Not required because:
Changeset (Changeset guidelines)
- TODO (before merge)
- Included
- Not necessary because:
Public documentation
- TODO (before merge)
- Cloudflare docs PR(s): [Workers] (WIP) Assets cloudflare-docs#16610
- Not necessary because: experimental stuff which will be referenced in a blog post

changeset-bot · 2024-09-11T15:05:59Z

🦋 Changeset detected

Latest commit: 1ab2c79

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
create-cloudflare	Minor

Not sure what this means? Click here to learn what changesets are.

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

github-actions · 2024-09-11T15:18:29Z

A wrangler prerelease is available for testing. You can install this latest build in your project with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10834033820/npm-package-wrangler-6678

You can reference the automatically updated head of this PR with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/prs/6678/npm-package-wrangler-6678

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10834033820/npm-package-wrangler-6678 dev path/to/script.js

Additional artifacts:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10834033820/npm-package-create-cloudflare-6678 --no-auto-update

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10834033820/npm-package-cloudflare-kv-asset-handler-6678

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10834033820/npm-package-miniflare-6678

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10834033820/npm-package-cloudflare-pages-shared-6678

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10834033820/npm-package-cloudflare-vitest-pool-workers-6678

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10834033820/npm-package-cloudflare-workers-editor-shared-6678

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/10834033820/npm-package-cloudflare-workers-shared-6678

Note that these links will no longer work once the GitHub Actions artifact expires.

wrangler@3.76.0 includes the following runtime dependencies:

Package	Constraint	Resolved
`miniflare`	workspace:*	3.20240821.2
`workerd`	1.20240909.0	1.20240909.0
`workerd --version`	1.20240909.0	2024-09-09

Please ensure constraints are pinned, and miniflare/workerd minor versions match.

petebacondarwin · 2024-09-12T08:38:06Z

packages/create-cloudflare/src/__tests__/deploy.test.ts

+			vi.mocked(readFile).mockReturnValue(`
+				experimental_assets = { directory = "./dist", binding = "ASSETS" }
+
+				[[durable_objects.bindings]]


Arguably Durable Objects can be deployed if they have migrations setup.
But the previous state of affairs didn't support that, so it is out of scope for this PR to change that.

petebacondarwin · 2024-09-12T08:38:48Z

packages/create-cloudflare/src/deploy.ts

@@ -67,12 +68,11 @@ const isDeployable = async (ctx: C3Context) => {
 		return true;
 	}

-	const wranglerToml = readWranglerToml(ctx);
-	if (wranglerToml.match(/(?<!#\s*)bindings?\s*=.*/m)) {


This approach was too simplistic because it also blocked Workers that have assets bindings, which can be deployed straight up.

petebacondarwin · 2024-09-12T08:41:06Z

packages/create-cloudflare/src/frameworks/index.ts

-	] as keyof typeof clisPackageJson.dependencies;
-	const version = clisPackageJson.dependencies[frameworkCli];
+	const frameworkCli = ctx.template
+		.frameworkCli as keyof typeof frameworksPackageJson.dependencies;


The source of truth for mapping between frameworks and their CLI has moved to the c3.ts template so that is all kept in one place, allowing us to remove that map from the frameworks/package.json

petebacondarwin · 2024-09-12T08:42:43Z

packages/create-cloudflare/src/frameworks/tsconfig.json

@@ -0,0 +1,3 @@
+{
+	"extends": "../../tsconfig.json"


This file is needed so that VS Code (eslint) knows that the TS files in this folder are configured by TypeScript. The package.json in this directory makes eslint think this is a separate TS project.

petebacondarwin · 2024-09-12T08:43:17Z

packages/create-cloudflare/src/git.ts

@@ -98,9 +98,9 @@ export const gitCommit = async (ctx: C3Context) => {
 };

 const createCommitMessage = async (ctx: C3Context) => {
-	const isPages = ctx.template.platform === "pages";
+	const framework = ctx.template.frameworkCli;


It's not only Pages projects that can run Frameworks!

petebacondarwin · 2024-09-12T08:44:01Z

packages/create-cloudflare/src/help.ts

+	if (args?.experimental) {
+		logRaw(
+			blue(
+				"You have selected experimental mode - the options below are filtered to those that support experimental mode.\n",


@tanushree-sharma - you might have a view on the copy here, but I wanted to call out to people that they would see a different list of frameworks/templates when the are running --experimental mode.

penalosa

I haven't reviewed the templates-experimental folder, but this looks good!

…atform This avoids C3 from trying to create a Pages project for them. Needed a bit of refactoring to ensure that these new templates still work even if not marked as "pages".

petebacondarwin force-pushed the c3-workers-assets-experimental-templates branch 2 times, most recently from 67c4973 to 3021d43 Compare September 12, 2024 08:34

petebacondarwin commented Sep 12, 2024

View reviewed changes

petebacondarwin force-pushed the c3-workers-assets-experimental-templates branch from 3021d43 to 3df7947 Compare September 12, 2024 08:53

petebacondarwin added the e2e Run e2e tests on a PR label Sep 12, 2024

petebacondarwin marked this pull request as ready for review September 12, 2024 09:01

petebacondarwin requested review from a team as code owners September 12, 2024 09:01

petebacondarwin force-pushed the c3-workers-assets-experimental-templates branch from f511ded to 06258bf Compare September 12, 2024 09:05

penalosa approved these changes Sep 12, 2024

View reviewed changes

petebacondarwin added 13 commits September 12, 2024 16:30

feat: add --experimental flag to allow access to experimental templates

15af87d

fix: do not crash if the chosen framework does not exist

115adbb

fix: offer to deploy workers with assets and no bindings

27dc0a0

feat: add experimental qwik workers + assets template

cb2626a

feat: add experimental svelte workers + assets template

7dab93d

feat: add experimental remix workers + assets template

da5aa7b

feat: add experimental astro workers + assets template

68cfb80

feat: add hello world with assets template

907cdac

feat: add experimental solid workers + assets template

210ada4

feat: add experimental nuxt workers + assets template

59a59ca

feat: filter the C3 help info when in experimental mode

343416f

fix: mark new Workers + Assets experimental templates as "workers" pl…

bf1267f

…atform This avoids C3 from trying to create a Pages project for them. Needed a bit of refactoring to ensure that these new templates still work even if not marked as "pages".

feat: add experimental angular workers + assets template

e08ec14

petebacondarwin added 4 commits September 12, 2024 16:32

refactor: use mapped paths to import templates

47fe082

feat: add experimental docusaurus workers + assets template

ce46e04

feat: add experimental gatsby workers + assets template

7ac13a6

add changesets

1ab2c79

petebacondarwin force-pushed the c3-workers-assets-experimental-templates branch from 06258bf to 1ab2c79 Compare September 12, 2024 15:32

penalosa merged commit 40ecf47 into main Sep 12, 2024
29 checks passed

penalosa deleted the c3-workers-assets-experimental-templates branch September 12, 2024 18:14

workers-devprod mentioned this pull request Sep 12, 2024

Version Packages #6669

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

C3-workers-assets-experimental-templates #6678

C3-workers-assets-experimental-templates #6678

petebacondarwin commented Sep 11, 2024 •

edited

Loading

changeset-bot bot commented Sep 11, 2024 •

edited

Loading

github-actions bot commented Sep 11, 2024 •

edited

Loading

petebacondarwin Sep 12, 2024

petebacondarwin Sep 12, 2024

petebacondarwin Sep 12, 2024

petebacondarwin Sep 12, 2024

petebacondarwin Sep 12, 2024

petebacondarwin Sep 12, 2024

penalosa left a comment

C3-workers-assets-experimental-templates #6678

C3-workers-assets-experimental-templates #6678

Conversation

petebacondarwin commented Sep 11, 2024 • edited Loading

What this PR solves / how to test

Author has addressed the following

changeset-bot bot commented Sep 11, 2024 • edited Loading

🦋 Changeset detected

github-actions bot commented Sep 11, 2024 • edited Loading

petebacondarwin Sep 12, 2024

Choose a reason for hiding this comment

petebacondarwin Sep 12, 2024

Choose a reason for hiding this comment

petebacondarwin Sep 12, 2024

Choose a reason for hiding this comment

petebacondarwin Sep 12, 2024

Choose a reason for hiding this comment

petebacondarwin Sep 12, 2024

Choose a reason for hiding this comment

petebacondarwin Sep 12, 2024

Choose a reason for hiding this comment

penalosa left a comment

Choose a reason for hiding this comment

petebacondarwin commented Sep 11, 2024 •

edited

Loading

changeset-bot bot commented Sep 11, 2024 •

edited

Loading

github-actions bot commented Sep 11, 2024 •

edited

Loading