Typescript: Excessive stack depth comparing types with 2.7.1

[adrianhara]

I found this issue in the archives as already solved in 2.5. However it seems to appear again: https://github.com/typeorm/typeorm/issues/1544

Any suggestions?

[mhegazy]

here is what i am seeing locally:

c:\test\21671\typeorm>git remote -v
origin  https://github.com/typeorm/typeorm.git (fetch)
origin  https://github.com/typeorm/typeorm.git (push)

c:\test\21671\typeorm>git status
On branch master
Your branch is up-to-date with 'origin/master'.

nothing to commit, working tree clean

c:\test\21671\typeorm>tsc --v
Version 2.7.1

c:\test\21671\typeorm>tsc --diagnostics
Files:          1332
Lines:        117889
Nodes:        572747
Identifiers:  170270
Symbols:      844659
Types:         78716
Memory used: 379295K
I/O read:      0.21s
I/O write:     3.10s
Parse time:    2.87s
Bind time:     0.85s
Check time:   25.98s
Emit time:    10.41s
Total time:   40.11s

[daniel-lang]

TypeORM users get the error:

Excessive stack depth comparing types 'Entity' and 'DeepPartial<Entity>'

where DeepPartial is defined as

export type DeepPartial<T> = {
    [P in keyof T]?: DeepPartial<T[P]>;
};

In TypeORM this is used to check if a given variable is part of the complete entity. At least that's how I understand it. Don't know if that's of any help to you @mhegazy

[mhegazy]

do you have a sample i can look at?

[daniel-lang]

typeorm/typescript-example should give the error if you update it to [email protected]
src/index.ts should show the error when using TypeORM's save() method.

[jmlopez-rod]

Glad I found this issue because I am able to reproduce something similar and I have no idea how some simple types provided by @types/colors is messing with my code. Here is how to I get the errors:

In a brand new project do

npm install [email protected]

Here is some code that works fine:

// test.ts
type DeepPartial<T> = { [P in keyof T]?: DeepPartial<T[P]> };
type PayLoad<T> = DeepPartial<T> | DeepPartial<T>[];

interface ISimpleUser {
  id: number;
  firstName: string;
  lastName: string;
}

const payLoadObject:Partial<ISimpleUser> = { id: 0, firstName: 'Leo' };
const payLoadArray: Partial<ISimpleUser>[] = [
  { id: 0, firstName: 'Leo' },
  { id: 1, lastName: 'Austen' },
];

class Endpoint<C> {
  post<I = C, O = I>(customPath: string | number, body: PayLoad<I>): void;
  post(...args: any[]): void {
    console.log(args);
  }
}

const endpoint = new Endpoint();
endpoint.post('path', payLoadObject);
endpoint.post('path', payLoadArray);
endpoint.post('path', { id: 0, room: { id: 1, color: 'red' } });

Things work fine:

jmlopez in ~/typescript-debug$ tsc test.ts

That should give you no errors.

But as soon as we bring in some types:

jmlopez in ~/typescript-debug$ npm install @types/colors
npm notice created a lockfile as package-lock.json. You should commit this file.
npm WARN [email protected] No description
npm WARN [email protected] No repository field.

+ @types/[email protected]
added 1 package in 0.982s
jmlopez in ~/typescript-debug$ tsc test.ts
test.ts(24,23): error TS2345: Argument of type 'Partial<ISimpleUser>' is not assignable to parameter of type 'PayLoad<{ id: { toString: any; toFixed: any; toExponential: any; toPrecision: any; valueOf: any; ...'.
  Type 'Partial<ISimpleUser>' is not assignable to type 'DeepPartial<{ id: { toString: any; toFixed: any; toExponential: any; toPrecision: any; valueOf: a...'.
    Property 'length' is missing in type 'Partial<ISimpleUser>'.
test.ts(26,23): error TS2345: Argument of type '{ id: number; room: { id: number; color: string; }; }' is not assignable to parameter of type 'PayLoad<{ id: { toString: any; toFixed: any; toExponential: any; toPrecision: any; valueOf: any; ...'.
  Type '{ id: number; room: { id: number; color: string; }; }' is not assignable to type 'DeepPartial<{ id: { toString: any; toFixed: any; toExponential: any; toPrecision: any; valueOf: a...'.
    Property 'length' is missing in type '{ id: number; room: { id: number; color: string; }; }'.

If we look into the color types we can see that there are two files. The culprit is index.d.ts which has this definition:

declare global {
    interface String {
        strip: string;
        stripColors: string;

        black: string;
        red: string;
        green: string;
        yellow: string;
        blue: string;
        magenta: string;
        cyan: string;
        white: string;
        gray: string;
        grey: string;

        bgBlack: string;
        bgRed: string;
        bgGreen: string;
        bgYellow: string;
        bgBlue: string;
        bgMagenta: string;
        bgCyan: string;
        bgWhite: string;

        reset: string;
        bold: string;
        dim: string;
        italic: string;
        underline: string;
        inverse: string;
        hidden: string;
        strikethrough: string;

        rainbow: string;
        zebra: string;
        america: string;
        trap: string;
        random: string;
        zalgo: string;
    }
}

If we remove this extension everything works. Any idea why typescript sent me in a wild hunt to see what is wrong with my code? For now I'll have to remove the colors type and hope that no other library interferes.

By the way, my IDE is the one that tells me about the excessive stack error. I am not able to see it by using the tsc command alone.

[typescript-bot]

Automatically closing this issue for housekeeping purposes. The issue labels indicate that it is unactionable at the moment or has already been addressed.

[jmlopez-rod]

Whoa there buddy... I have submitted a reproducible example and a temporary solution I'm using. There is a still an issue here. Any library that messes with the global object will mess typescript. I'm lucky I found out that the colors types was messing up but I don't think I'll find it that easy to find another culprit in the future (or if it would be easy to not depend on it). Can this be looked at please?

[Conaclos]

Is this related to https://github.com/Microsoft/TypeScript/issues/21592?

[sandersn]

@Conaclos yes this is a duplicate of #21592. I'll track the bug there since it has a very small repro.