perf(types): prevent immediate deep and circular resolution for deep mock #123

millsp · 2023-08-02T22:06:30Z

Hey @marchaos 👋, a user has opened this issue in Prisma, and after further investigation I pinned the performance issue to come from the MockDeep types provided here. We recently introduced meta types that are hidden under symbol. There's noting special about these types except that they can be very deep and recursive, but it's all objects/records in the end. I found that MockDeep caused/forced TypeScript to evaluate these types.

While this is not obvious, any intersection on a mapped type (eg. compute) itself will cause the mapped type to be resolved, otherwise TS would defer that for later (eg. when you access it). So MockDeep was forcing resolution on very huge and recursive types in the PrismaClient. This PR does not make things easier to read, but does make things more efficient, by forcing resolution within the mapped type itself. Also I had to re-intersect with the original type as well to preserve the full shape, including private props which mapped types remove.

With that, I was able to compile a huge PrismaClient like before we introduced this special type metadata on the symbol key.

…mock

millsp · 2023-08-03T01:46:30Z

src/Mock.ts

+// prevent immediate type resolution on a recursive type, this will
+// help to improve performance for deeply nested recursive mocking
+// at the same time, this intersection preserves private properties
+export type DeepMockProxy<T> = _DeepMockProxy<T> & T;


Suggested change

export type DeepMockProxy<T> = _DeepMockProxy<T> & T;

export type DeepMockProxy<T> = _DeepMockProxy<T> & T;

In theory re-intersecting should not be necessary because we did already in the mapped types. But because the original type can contain private fields, using a mapped type on it erases that information. So the solution is to re-intersect once only.

millsp · 2023-08-03T01:48:22Z

src/Mock.ts

    // This supports deep mocks in the else branch
-    [K in keyof T]: T[K] extends (...args: infer A) => infer B ? CalledWithMock<B, A> : DeepMockProxy<T[K]>;
-} &


This causes TypeScript to expand and immediately compute the type, potentially doing dangerous eager loading on deep and recursive or mutually self-referencing objects - potentially causing perf issues.

millsp · 2023-08-03T01:48:38Z

src/Mock.ts

+                    : DeepMockProxy<T[K]>;
+};
+
+export type DeepMockProxyWithFuncPropSupport<T> = _DeepMockProxyWithFuncPropSupport<T> & T;


I did all of them for consistency.

marchaos · 2023-08-03T06:57:11Z

Hey, @millsp - thanks for the PR, looks good! Just checking it locally and will merge if all good.

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [jest-mock-extended](https://togithub.com/marchaos/jest-mock-extended) | [`3.0.4` -> `3.0.5`](https://renovatebot.com/diffs/npm/jest-mock-extended/3.0.4/3.0.5) | [![age](https://developer.mend.io/api/mc/badges/age/npm/jest-mock-extended/3.0.5?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/jest-mock-extended/3.0.5?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/jest-mock-extended/3.0.4/3.0.5?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/jest-mock-extended/3.0.4/3.0.5?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>marchaos/jest-mock-extended (jest-mock-extended)</summary> ### [`v3.0.5`](https://togithub.com/marchaos/jest-mock-extended/releases/tag/3.0.5) [Compare Source](https://togithub.com/marchaos/jest-mock-extended/compare/3.0.4...3.0.5) Fixed Deep Mock perf issue with [marchaos/jest-mock-extended#123 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/STORIS/mvom).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

marchaos · 2023-08-03T14:40:58Z

released in 3.0.5

millsp · 2023-08-03T15:22:02Z

Thanks!

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [@types/node](https://togithub.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node) ([source](https://togithub.com/DefinitelyTyped/DefinitelyTyped)) | [`20.4.5` -> `20.4.8`](https://renovatebot.com/diffs/npm/@types%2fnode/20.4.5/20.4.8) | [![age](https://developer.mend.io/api/mc/badges/age/npm/@types%2fnode/20.4.8?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/@types%2fnode/20.4.8?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/@types%2fnode/20.4.5/20.4.8?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/@types%2fnode/20.4.5/20.4.8?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [jest-mock-extended](https://togithub.com/marchaos/jest-mock-extended) | [`3.0.4` -> `3.0.5`](https://renovatebot.com/diffs/npm/jest-mock-extended/3.0.4/3.0.5) | [![age](https://developer.mend.io/api/mc/badges/age/npm/jest-mock-extended/3.0.5?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/jest-mock-extended/3.0.5?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/jest-mock-extended/3.0.4/3.0.5?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/jest-mock-extended/3.0.4/3.0.5?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [prettier](https://prettier.io) ([source](https://togithub.com/prettier/prettier)) | [`3.0.0` -> `3.0.1`](https://renovatebot.com/diffs/npm/prettier/3.0.0/3.0.1) | [![age](https://developer.mend.io/api/mc/badges/age/npm/prettier/3.0.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/prettier/3.0.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/prettier/3.0.0/3.0.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/prettier/3.0.0/3.0.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [tsup](https://tsup.egoist.dev/) ([source](https://togithub.com/egoist/tsup)) | [`7.1.0` -> `7.2.0`](https://renovatebot.com/diffs/npm/tsup/7.1.0/7.2.0) | [![age](https://developer.mend.io/api/mc/badges/age/npm/tsup/7.2.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/tsup/7.2.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/tsup/7.1.0/7.2.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/tsup/7.1.0/7.2.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>marchaos/jest-mock-extended (jest-mock-extended)</summary> ### [`v3.0.5`](https://togithub.com/marchaos/jest-mock-extended/releases/tag/3.0.5) [Compare Source](https://togithub.com/marchaos/jest-mock-extended/compare/3.0.4...3.0.5) Fixed Deep Mock perf issue with [marchaos/jest-mock-extended#123 </details> <details> <summary>prettier/prettier (prettier)</summary> ### [`v3.0.1`](https://togithub.com/prettier/prettier/blob/HEAD/CHANGELOG.md#301) [Compare Source](https://togithub.com/prettier/prettier/compare/3.0.0...3.0.1) [diff](https://togithub.com/prettier/prettier/compare/3.0.0...3.0.1) ##### Fix cursor positioning for a special case ([#14812](https://togithub.com/prettier/prettier/pull/14812) by [@fisker](https://togithub.com/fisker))  ```js // <|> is the cursor position /* Input */ // All messages are represented in JSON. // So, the prettier.py controls a subprocess which spawns "node {this_file}". import {<|> } from "fs" /* Prettier 3.0.0 */ // All messages are represented in JSON. // So, the prettier.py <|>controls a subprocess which spawns "node {this_file}". import {} from "fs" /* Prettier 3.0.1 */ // All messages are represented in JSON. // So, the prettier.py controls a subprocess which spawns "node {this_file}". import {<|>} from "fs" ``` ##### Fix plugins/estree.d.ts to make it a module ([#15018](https://togithub.com/prettier/prettier/pull/15018) by [@kingyue737](https://togithub.com/kingyue737)) Add `export {}` in `plugins/estree.d.ts` to fix the "File is not a module" error ##### Add parenthesis around leading multiline comment in return statement ([#15037](https://togithub.com/prettier/prettier/pull/15037) by [@auvred](https://togithub.com/auvred))  ```jsx // Input function fn() { return ( /** * @type {...} */ expresssion ) } // Prettier 3.0.0 function fn() { return /** * @type {...} */ expresssion; } // Prettier 3.0.1 function fn() { return ( /** * @type {...} */ expresssion ); } ``` ##### Add support for Vue "Generic Components" ([#15066](https://togithub.com/prettier/prettier/pull/15066) by [@auvred](https://togithub.com/auvred)) https://blog.vuejs.org/posts/vue-3-3#generic-components  ```vue  <script setup lang="ts" generic="T extends Type1 & Type2 & (Type3 | Type4), U extends string | number | boolean"></script>  <script setup lang="ts" generic="T extends Type1 & Type2 & (Type3 | Type4), U extends string | number | boolean" ></script>  <script setup lang="ts" generic=" T extends Type1 & Type2 & (Type3 | Type4), U extends string | number | boolean " ></script> ``` ##### Fix comments print in `IfStatement` ([#15076](https://togithub.com/prettier/prettier/pull/15076) by [@fisker](https://togithub.com/fisker))  ```js function a(b) { if (b) return 1; // comment else return 2; } /* Prettier 3.0.0 */ Error: Comment "comment" was not printed. Please report this error! /* Prettier 3.0.1 */ function a(b) { if (b) return 1; // comment else return 2; } ``` ##### Add missing type definition for `printer.preprocess` ([#15123](https://togithub.com/prettier/prettier/pull/15123) by [@so1ve](https://togithub.com/so1ve)) ```diff export interface Printer<T = any> { // ... + preprocess?: + | ((ast: T, options: ParserOptions<T>) => T | Promise<T>) + | undefined; } ``` ##### Add missing `getVisitorKeys` method type definition for `Printer` ([#15125](https://togithub.com/prettier/prettier/pull/15125) by [@auvred](https://togithub.com/auvred)) ```tsx const printer: Printer = { print: () => [], getVisitorKeys(node, nonTraversableKeys) { return ["body"]; }, }; ``` ##### Add typing to support `readonly` array properties of AST Node ([#15127](https://togithub.com/prettier/prettier/pull/15127) by [@auvred](https://togithub.com/auvred))  ```tsx // Input interface TestNode { readonlyArray: readonly string[]; } declare const path: AstPath<TestNode>; path.map(() => "", "readonlyArray"); // Prettier 3.0.0 interface TestNode { readonlyArray: readonly string[]; } declare const path: AstPath<TestNode>; path.map(() => "", "readonlyArray"); // ^ Argument of type '"readonlyArray"' is not assignable to parameter of type '"regularArray"'. ts(2345) // Prettier 3.0.1 interface TestNode { readonlyArray: readonly string[]; } declare const path: AstPath<TestNode>; path.map(() => "", "readonlyArray"); ``` ##### Add space before unary minus followed by a function call ([#15129](https://togithub.com/prettier/prettier/pull/15129) by [@pamelalozano](https://togithub.com/pamelalozano))  ```less // Input div { margin: - func(); } // Prettier 3.0.0 div { margin: -func(); } // Prettier 3.0.1 div { margin: - func(); } ``` </details> <details> <summary>egoist/tsup (tsup)</summary> ### [`v7.2.0`](https://togithub.com/egoist/tsup/releases/tag/v7.2.0) [Compare Source](https://togithub.com/egoist/tsup/compare/v7.1.0...v7.2.0) ##### Bug Fixes - allow to kill onSuccess process using SIGKILL signal, closes [#936](https://togithub.com/egoist/tsup/issues/936) ([612cabf](https://togithub.com/egoist/tsup/commit/612cabf1c1b99709d5d16c6e861ec12dae3db455)) ##### Features - add option for interop default in cjs ([#947](https://togithub.com/egoist/tsup/issues/947)) ([d870f4e](https://togithub.com/egoist/tsup/commit/d870f4e76cf0ff89a83e90bdc4931aa30bddb536)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - "before 4am on Monday" (UTC). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://togithub.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/tnez/starter-npm-pkg).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [jest-mock-extended](https://github.com/marchaos/jest-mock-extended) | devDependencies | patch | [`3.0.4` -> `3.0.5`](https://renovatebot.com/diffs/npm/jest-mock-extended/3.0.4/3.0.5) | --- ### Release Notes <details> <summary>marchaos/jest-mock-extended (jest-mock-extended)</summary> ### [`v3.0.5`](https://github.com/marchaos/jest-mock-extended/releases/tag/3.0.5) [Compare Source](marchaos/jest-mock-extended@3.0.4...3.0.5) Fixed Deep Mock perf issue with marchaos/jest-mock-extended#123 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://gitea.vylpes.xyz/RabbitLabs/random-bunny/pulls/83 Co-authored-by: Renovate Bot <renovate@vylpes.com> Co-committed-by: Renovate Bot <renovate@vylpes.com>

perf(types): prevent immediate deep and circular resolution for deep …

f08bf16

…mock

millsp marked this pull request as draft August 2, 2023 22:09

make it work with private properties

7cb9815

millsp marked this pull request as ready for review August 2, 2023 22:47

millsp mentioned this pull request Aug 2, 2023

Upgrading from Prisma 5.0.0 -> 5.1.0 results in "TS2321: Excessive stack depth comparing types" error using mockDeep<PrismaClient>() prisma/prisma#20516

Closed

millsp commented Aug 3, 2023

View reviewed changes

marchaos merged commit 23279af into marchaos:master Aug 3, 2023

millsp mentioned this pull request Oct 3, 2023

perf(types): prevent immediate deep and circular resolution eratio08/vitest-mock-extended#282

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

perf(types): prevent immediate deep and circular resolution for deep mock #123

perf(types): prevent immediate deep and circular resolution for deep mock #123

millsp commented Aug 2, 2023 •

edited

millsp Aug 3, 2023 •

edited

millsp Aug 3, 2023

millsp Aug 3, 2023

marchaos commented Aug 3, 2023

marchaos commented Aug 3, 2023

millsp commented Aug 3, 2023

	export type DeepMockProxy<T> = _DeepMockProxy<T> & T;
	export type DeepMockProxy<T> = _DeepMockProxy<T> & T;

perf(types): prevent immediate deep and circular resolution for deep mock #123

perf(types): prevent immediate deep and circular resolution for deep mock #123

Conversation

millsp commented Aug 2, 2023 • edited

millsp Aug 3, 2023 • edited

Choose a reason for hiding this comment

millsp Aug 3, 2023

Choose a reason for hiding this comment

millsp Aug 3, 2023

Choose a reason for hiding this comment

marchaos commented Aug 3, 2023

marchaos commented Aug 3, 2023

millsp commented Aug 3, 2023

millsp commented Aug 2, 2023 •

edited

millsp Aug 3, 2023 •

edited