Add hello world example for Durable Objects

[joshthoward]

Fixes # [insert GH or internal issue number(s)].

What this PR solves / how to test:

This PR attempts to add a new create-cloudflare example for Durable Objects, which corresponds to the getting started docs on Durable Objects.

Author has addressed the following:

• Tests
  • Included
  • Not necessary because:
• Changeset (Changeset guidelines)
  • Included
  • Not necessary because:
• Associated docs
  • Issue(s)/PR(s):
  • Not necessary because:

Note for PR author:

We want to celebrate and highlight awesome PR review! If you think this PR received a particularly high-caliber review, please assign it the label highlight pr review so future reviewers can take inspiration and learn from it.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 7ffe646

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

[github-actions]

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/7585525527/npm-package-wrangler-4747

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

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

Or you can use npx with this latest build directly:

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

Additional artifacts:

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

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

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

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

---

wrangler@3.23.0 includes the following runtime dependencies:

Package	Constraint	Resolved
miniflare	workspace:*	3.20231218.2
workerd	1.20231218.0	1.20231218.0
workerd --version	1.20231218.0	2023-12-18

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (8d6b3ee) 75.63% compared to head (7ffe646) 71.81%.
Report is 25 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4747      +/-   ##
==========================================
- Coverage   75.63%   71.81%   -3.83%     
==========================================
  Files         243      285      +42     
  Lines       13210    14759    +1549     
  Branches     3393     3719     +326     
==========================================
+ Hits         9992    10599     +607     
- Misses       3218     4160     +942     

see 62 files with indirect coverage changes

[elithrar]

More in-line code comments explaining each method call.

Assume a user hasn't read the docs and is jumping in via the create Cloudflare flow for the first time.

[joshthoward]

@MellowYarker and @elithrar PTAL. I tested this locally and it works. Not sure what the test failures are here.

[petebacondarwin]

LGTM - the e2e failures are because you need secrets to run these, which are not available to PRs built in personal forks.

[penalosa]

It looks like there are a couple of issues with the JSDoc typings

[joshthoward]

It looks like there are a couple of issues with the JSDoc typings

@penalosa I've addressed these changes. I was unsure about Promise<Response> because I thought async might have implied the Promise? Either way thank you for the suggestions.

[petebacondarwin]

I pulled this down and tried it out. One last fix needed.

[joshthoward]

@petebacondarwin WDYM by "Can you do that with JSDoc comments?"

[petebacondarwin]

@petebacondarwin WDYM by "Can you do that with JSDoc comments?"

In his comment @penalosa suggested that we would need to define the Env type/interface in the file somewhere.
But since this is a JS file, not TS, I am not sure how easy it would be to define that type.

I note in the standard Workers Hello World starter, we don't both to define types (in jsdoc comments) at all.

[penalosa]

@petebacondarwin TypeScript supports typedefs in JSDoc files (https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html#typedef-callback-and-param)

[joshthoward]

@petebacondarwin WDYM by "Can you do that with JSDoc comments?"

In his comment @penalosa suggested that we would need to define the Env type/interface in the file somewhere. But since this is a JS file, not TS, I am not sure how easy it would be to define that type.

I note in the standard Workers Hello World starter, we don't both to define types (in jsdoc comments) at all.

Turns out that you can (though I'm not sure why someone would go through that much trouble to not use TypeScript lol). The type is annotated on line 12 in the same file.

Comments are addressed. Should be good to go now.

[petebacondarwin]

Created #4762 to run the e2e tests in CI.

[petebacondarwin]

  > prettier . --check --ignore-unknown
  
  Checking formatting...
  [warn] packages/create-cloudflare/templates/hello-world-durable-object/js/package.json
  [warn] packages/create-cloudflare/templates/hello-world-durable-object/js/src/index.js
  [warn] packages/create-cloudflare/templates/hello-world-durable-object/ts/package.json
  [warn] packages/create-cloudflare/templates/hello-world-durable-object/ts/src/index.ts
  [warn] packages/create-cloudflare/templates/hello-world-durable-object/ts/tsconfig.json
  [warn] Code style issues found in 5 files. Forgot to run Prettier?

[petebacondarwin]

And this test needs to change:

workers-sdk/packages/create-cloudflare/e2e-tests/cli.test.ts

Lines 108 to 112 in fbf4c7a

	{
	matcher: /What type of application do you want to create/,
	input: [keys.down, keys.down, keys.enter],
	},
	{

Right now it is trying to select the "Example router & proxy Worker" type but since this PR adds a new item above this one, it is getting the wrong project type.

[joshthoward]

@petebacondarwin I pushed some updates yesterday. I'm a little confused about what is supposed to run where, so please let me know if there are any other test failures I need to worry about. Otherwise, maybe we can hop on a call Monday and I can understand a bit more about how to develop on workers-sdk.

[petebacondarwin]

Pushed the new commits to the origin fork. If the tests are good we can merge this.

[petebacondarwin]

The other branch was green so let's land this!

[petebacondarwin]

Darn it! I just realised that we should have added a changeset for this. I'll add one in a new PR now.