Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(cloudflare:test): improve runInDurableObject type #5975

Merged

Conversation

thiskevinwang
Copy link
Contributor

@thiskevinwang thiskevinwang commented Jun 4, 2024

What this PR solves / how to test

This improves the runInDurableObject type, from cloudflare:test

This insures the callback's instance parameter infers the stub's type, which will include any typed RPC methods if they exist. This is for when no additional type arguments are used:

// defined elsewhere
export class MyDo extends DurableObject {
  async foo() {}
  async bar() {}
}

// file.test.ts
import { env, runInDurableObject } from "cloudflare:test";

const ns = env.NAMESPACE; // type: DurableObjectNamespace<MyDo>
const doId = ns.newUniqueId();
const stub = ns.get(doId); // type: DurableObjectStub<MyDo>

await runInDurableObject(stub, async (instance, state) => {
  // ℹ️`stub`'s type shows the rpc methods, `foo` and `bar`
  // ❌ Before this PR - `instance` has no visibility into rpc methods
  // ✅ After this PR - `instance` should automatically infer `foo` and `bar` methods
})

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):
    • Not necessary because:

- this insures the callback's `instance` parameter infers the stub's type, which will include any typed RPC methods if they exist
@thiskevinwang thiskevinwang requested a review from a team as a code owner June 4, 2024 23:03
Copy link

changeset-bot bot commented Jun 4, 2024

⚠️ No Changeset found

Latest commit: f0dad9e

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

Copy link
Contributor

github-actions bot commented Jun 5, 2024

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/9409267539/npm-package-wrangler-5975

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

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

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9409267539/npm-package-wrangler-5975 dev path/to/script.js
Additional artifacts:
npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9409267539/npm-package-create-cloudflare-5975 --no-auto-update
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9409267539/npm-package-cloudflare-kv-asset-handler-5975
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9409267539/npm-package-miniflare-5975
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9409267539/npm-package-cloudflare-pages-shared-5975
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9409267539/npm-package-cloudflare-vitest-pool-workers-5975

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


wrangler@3.59.0 includes the following runtime dependencies:

Package Constraint Resolved
miniflare workspace:* 3.20240524.2
workerd 1.20240605.0 1.20240605.0
workerd --version 1.20240605.0 2024-06-05

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

@RamIdeas RamIdeas added the awaiting reporter response Needs clarification or followup from OP label Jun 5, 2024
Co-authored-by: Rahul Sethi <5822355+RamIdeas@users.noreply.github.com>
@Skye-31 Skye-31 added awaiting Cloudflare response Awaiting response from workers-sdk maintainer team and removed awaiting reporter response Needs clarification or followup from OP labels Jun 7, 2024
@RamIdeas RamIdeas removed the awaiting Cloudflare response Awaiting response from workers-sdk maintainer team label Jun 7, 2024
@RamIdeas RamIdeas merged commit cbebb04 into cloudflare:main Jun 7, 2024
28 checks passed
Skye-31 added a commit that referenced this pull request Jun 11, 2024
[#5975](#5975) updated the type for `runInDurableObject` to infer the stub's type correctly for RPC methods, however it used the wrong `DurableObjects` type. This PR fixes the type used to properly support RPC methods.
@Skye-31 Skye-31 mentioned this pull request Jun 11, 2024
12 tasks
Skye-31 added a commit that referenced this pull request Jun 11, 2024
[#5975](#5975) updated the type for `runInDurableObject` to infer the stub's type correctly for RPC methods, however it used the wrong `DurableObjects` type. This PR fixes the type used to properly support RPC methods.
Skye-31 added a commit that referenced this pull request Jun 12, 2024
* Improve `runInDurableObject` type

[#5975](#5975) updated the type for `runInDurableObject` to infer the stub's type correctly for RPC methods, however it used the wrong `DurableObjects` type. This PR fixes the type used to properly support RPC methods.

* Update .changeset/hot-jokes-watch.md

Co-authored-by: Rahul Sethi <5822355+RamIdeas@users.noreply.github.com>

---------

Co-authored-by: Rahul Sethi <5822355+RamIdeas@users.noreply.github.com>
@thiskevinwang thiskevinwang deleted the improve-runInDurableObject-signature branch June 14, 2024 11:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants