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

"Type instantiation is excessively deep and possibly infinite", unidentified DO types, attempting to get a clean type from DO RPC Call #3063

Open
jesseditson opened this issue Nov 5, 2024 · 0 comments
Assignees
Labels
types Related to @cloudflare/workers-types

Comments

@jesseditson
Copy link

jesseditson commented Nov 5, 2024

In a worker, I commonly use a pattern of calling durable objects from an API worker - when the DOs respond, they either contain a response type (e.g. a serializable object) or a Response type. I use a utility method to split these types similar to a safe assignment operator. Ideally, my code looks like this:

const stub = ctx.DURABLE_OBJECT.get(ctx.DURABLE_OBJECT.idFromName("some-name"));
const [response, fooInfo] = await tryResponse(stub.method("foo"));
if (response) {
  return response;
}
// fooInfo is guaranteed and typed

Note that the DO in the above example would be something like:

type FooInfo = { something: string }
class MyDOClass extends DurableObject {
  async method(something: string): Response | FooInfo {
    const r = await fetch("...");
    if (!r.ok) {
      return r;
    }
    return { something };
  }
}

This has a number of issues. In order:

  1. ctx.STUB does not appear to return typed stubs when I use wrangler types in a project with non-local DOs, even if I provide a path to the DO definition directly via script_name. This feels like a pretty obvious shortcoming, or is the expectation that you'd only use RPC via a single worker that exposes its own DOs? I've worked around this by using a shim for the type, not the end of the world.
export const getStub = <T extends Rpc.DurableObjectBranded>(
  ns: DurableObjectNamespace,
  id: DurableObjectId
): DurableObjectStub<T> => {
  return ns.get(id) as DurableObjectStub<T>;
};
  1. tryResponse is typed similarly to this playground, and has a return type of (roughly) Awaited<[Response, undefined] | [undefined, T]> where T is Exclude<ReturnType<StubMethod>, Response>.

This should in theory allow me to pass a stub method result to it - and indeed, if I pass something typed as ReturnType<MyDOClass["method"]> to it, the types are correct. However, when I call with tryResponse(stub.method("foo")), I get a Type instantiation is excessively deep and possibly infinite error. I can workaround this as well by using this shim:

type Fn = (...a: any) => any;
export type StubCall<
  DOClass extends DurableObject,
  K extends keyof DOClass
> = DOClass[K] extends Fn ? ReturnType<DOClass[K]> : never;

However, this results in the following code, which is bailing out of a lot of the type system:

const repoStub = getStub<MyDOClass>(DURABLE_OBJECT, DURABLE_OBJECT.idFromName("some-name"));
const [response, fooInfo] = await tryResponse(stub.method("foo") as StubCall<MyDOClass, "method">);
if (response) {
  return response;
}
// fooInfo is guaranteed and typed

There is some help here, but it's quite repetitive and ideally the first block of code has enough info to generate the correct types without TS failing due to complexity.

I'll try consolidating to a single project to fix issue #1 (is that really the recommended approach?), but I suspect that I'll still have issue #2 regardless, due to the complex type inference. What are my options here?

@jesseditson jesseditson added the types Related to @cloudflare/workers-types label Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
types Related to @cloudflare/workers-types
Projects
Status: Untriaged
Development

No branches or pull requests

2 participants