Type instantiation is excessively deep and possibly infinite

[dargmuesli]

What happened?

Updated from v4.14.1 to v4.14.2: maevsi/maevsi#1215
Now there seems to be a loop in the typescript types:

Version

4.14.2

Runtime

Node.js

Runtime Details

typescript 5.0.4

Code to reproduce

https://github.com/maevsi/maevsi/actions/runs/4817158729/jobs/8577533577?pr=1215#step:7:1785

Required

• I have searched the issues tracker and discussions for similar topics and couldn't find anything related.
• I agree to follow this project's Code of Conduct

[panva]

Please provide a minimal reproduction example, a simple TS project that exhibits this issue with clear npm-based install and build steps.

You should narrow the types of the payload properties you access or at the very least type assert them.

[panva]

I'll revert for now but please do come back with the reproduction.

[dargmuesli]

Sure, am just currently busy and wanted to get that possible regression reported as quick as possible :) will setup a minimal repro in the coming days if still necessary by then 🤞

[panva]

It is necessary because I want to re-introduce the PR eventually.

[panva]

Feel free to come back with a repro on your own time. I'll close this for now.

[dargmuesli]

I always expected me to do this on my own time. Leaving that part out of the invitation to come back with a reproduction would keep the message and sound less harsh 😄

[panva]

Didn't mean to sound harsh, and even re-reading it still doesn't sound like so to me. What I meant is, feel free to come back with a repro anytime not being pressured by an open issue that's waiting on you, that's all :)

[dargmuesli]

The issue is in the following section:

jose/src/types.d.ts

Lines 94 to 97 in f079ca3

	type JsonObject = { [Key in string]?: JsonValue }
	type JsonArray = JsonValue[]
	type JsonPrimitive = string | number | boolean | null
	type JsonValue = JsonPrimitive | JsonObject | JsonArray

There is a loop between JsonValue and JsonObject.

[dargmuesli]

Based on https://stackoverflow.com/a/50516408/4682621 it might be a solution to define JsonObject like this:

type JsonObject<T> = {
  [K in keyof T]?: T[K] extends object ? JsonObject<T[K]> :
    T[K] extends JsonPrimitive | JsonArray ? T[K] : never
}

But I'm not that kind of typescript pro, so please validate that suggestion thoroughly!

[panva]

Curcular referencing is not an issue and I've had this code in other projects for a long time with no issues. That's why I need a minimal reproduction, to be able to rule out that this isn't a problem caused by something else in your stack. From the looks of it in your screenshot it is.