fix(type-utils): prevent stack overflow in `isTypeReadonly` #5860

sviat9440 · 2022-10-23T19:20:09Z

PR Checklist

Addresses an existing open issue: fixes Bug: [prefer-readonly-parameter-types] isTypeReadonly stack overflow #4476
That issue was marked as accepting prs
Steps in CONTRIBUTING.md were taken

nx-cloud · 2022-10-23T19:20:11Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 2d24a1b. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

✅ Successfully ran 46 targets

Sent with 💌 from NxCloud.

typescript-eslint · 2022-10-23T19:20:12Z

Thanks for the PR, @sviat9440!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

netlify · 2022-10-23T19:20:13Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`2d24a1b`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/6356c99068bf100008e28f34
😎 Deploy Preview	https://deploy-preview-5860--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

codecov · 2022-10-23T19:37:15Z

Codecov Report

Merging #5860 (9d10030) into main (e70a10a) will increase coverage by 0.02%.
The diff coverage is 100.00%.

❗ Current head 9d10030 differs from pull request most recent head 2d24a1b. Consider uploading reports for the commit 2d24a1b to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5860      +/-   ##
==========================================
+ Coverage   91.32%   91.35%   +0.02%     
==========================================
  Files         361      361              
  Lines       12028    12026       -2     
  Branches     3502     3500       -2     
==========================================
+ Hits        10985    10986       +1     
+ Misses        747      743       -4     
- Partials      296      297       +1

Flag	Coverage Δ
unittest	`91.35% <100.00%> (+0.02%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
packages/type-utils/src/isTypeReadonly.ts	`86.00% <100.00%> (+0.28%)`	⬆️
...lint-plugin/src/rules/prefer-nullish-coalescing.ts	`100.00% <0.00%> (ø)`
...-plugin/src/rules/no-unsafe-declaration-merging.ts	`92.85% <0.00%> (+15.07%)`	⬆️

…4476)

sviat9440 · 2022-10-24T15:22:28Z

Another fail test case:

interface Test {
   readonly [key: string]: Test1;
}

interface Test1 {
  readonly [key: string]: Test;
}

JoshuaKGoldberg

LGTM - confirmed that undoing the fix to isTypeReadonly.ts makes one of the added unit tests crash with RangeError: Maximum call stack size exceeded. Thanks!

JoshuaKGoldberg · 2022-10-24T17:21:35Z

Pardon my intrusiveness @sviat9440, this looks perfect as-is and I want to get it in before our next release later today. Marking as ready for review 😄

JoshuaKGoldberg · 2022-10-24T17:48:06Z

https://github.com/typescript-eslint/typescript-eslint/releases/tag/v5.41.0

sviat9440 · 2022-10-24T20:26:26Z

ok, I will fix the other case in the next pr

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.40.1` -> `5.41.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/5.40.1/5.41.0) | | [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.40.1` -> `5.41.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/5.40.1/5.41.0) | --- ### Release Notes <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/eslint-plugin)</summary> ### [`v5.41.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#5410-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5401v5410-2022-10-24) [Compare Source](typescript-eslint/typescript-eslint@v5.40.1...v5.41.0) ##### Bug Fixes - **eslint-plugin:** \[no-base-to-string] ignore Error, URL, and URLSearchParams by default ([#5839](typescript-eslint/typescript-eslint#5839)) ([96e1c6c](typescript-eslint/typescript-eslint@96e1c6c)) - **type-utils:** prevent stack overflow in `isTypeReadonly` ([#5860](typescript-eslint/typescript-eslint#5860)) ([a6d8f7e](typescript-eslint/typescript-eslint@a6d8f7e)), closes [#4476](typescript-eslint/typescript-eslint#4476) ##### Features - **eslint-plugin:** \[no-unsafe-declaration-merging] switch to use scope analysis instead of type information ([#5865](typescript-eslint/typescript-eslint#5865)) ([e70a10a](typescript-eslint/typescript-eslint@e70a10a)) - **eslint-plugin:** add no-unsafe-declaration-merging ([#5840](typescript-eslint/typescript-eslint#5840)) ([3728031](typescript-eslint/typescript-eslint@3728031)) #### [5.40.1](typescript-eslint/typescript-eslint@v5.40.0...v5.40.1) (2022-10-17) ##### Bug Fixes - **eslint-plugin:** Skip missing 'rest' tuple type arguments in no-misused-promises ([#5809](typescript-eslint/typescript-eslint#5809)) ([c5beaa2](typescript-eslint/typescript-eslint@c5beaa2)), closes [#5807](typescript-eslint/typescript-eslint#5807) </details> <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/parser)</summary> ### [`v5.41.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#5410-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5401v5410-2022-10-24) [Compare Source](typescript-eslint/typescript-eslint@v5.40.1...v5.41.0) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) #### [5.40.1](typescript-eslint/typescript-eslint@v5.40.0...v5.40.1) (2022-10-17) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) </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 these updates again. --- - [ ] If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1604 Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

sviat9440 force-pushed the fix/4476 branch 2 times, most recently from 3c73b21 to 67eba41 Compare October 23, 2022 19:28

fix(eslint-plugin): isTypeReadonly stack overflow (typescript-eslint#…

9d10030

…4476)

sviat9440 force-pushed the fix/4476 branch from 67eba41 to 9d10030 Compare October 23, 2022 21:00

bradzacher changed the title ~~fix(eslint-plugin): isTypeReadonly stack overflow (#4476)~~ fix(type-utils): prevent stack overflow in isTypeReadonly Oct 24, 2022

bradzacher added the bug Something isn't working label Oct 24, 2022

sviat9440 marked this pull request as draft October 24, 2022 15:22

JoshuaKGoldberg approved these changes Oct 24, 2022

View reviewed changes

Merge branch 'main' into fix/4476

2d24a1b

JoshuaKGoldberg marked this pull request as ready for review October 24, 2022 17:21

JoshuaKGoldberg enabled auto-merge (squash) October 24, 2022 17:21

JoshuaKGoldberg merged commit a6d8f7e into typescript-eslint:main Oct 24, 2022

sync-by-unito bot mentioned this pull request Oct 25, 2022

build(deps-dev): bump @typescript-eslint/eslint-plugin from 5.36.1 to 5.41.0 numbersprotocol/capture-lite#2211

Closed

sync-by-unito bot mentioned this pull request Nov 1, 2022

build(deps-dev): bump @typescript-eslint/eslint-plugin from 5.36.1 to 5.42.0 numbersprotocol/capture-lite#2265

Closed

github-actions bot locked as resolved and limited conversation to collaborators Nov 17, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(type-utils): prevent stack overflow in `isTypeReadonly` #5860

fix(type-utils): prevent stack overflow in `isTypeReadonly` #5860

sviat9440 commented Oct 23, 2022

nx-cloud bot commented Oct 23, 2022 •

edited

Loading

typescript-eslint bot commented Oct 23, 2022

netlify bot commented Oct 23, 2022 •

edited

Loading

codecov bot commented Oct 23, 2022 •

edited

Loading

sviat9440 commented Oct 24, 2022

JoshuaKGoldberg left a comment

JoshuaKGoldberg commented Oct 24, 2022

JoshuaKGoldberg commented Oct 24, 2022

sviat9440 commented Oct 24, 2022

fix(type-utils): prevent stack overflow in isTypeReadonly #5860

fix(type-utils): prevent stack overflow in isTypeReadonly #5860

Conversation

sviat9440 commented Oct 23, 2022

PR Checklist

nx-cloud bot commented Oct 23, 2022 • edited Loading

☁️ Nx Cloud Report

typescript-eslint bot commented Oct 23, 2022

netlify bot commented Oct 23, 2022 • edited Loading

✅ Deploy Preview for typescript-eslint ready!

codecov bot commented Oct 23, 2022 • edited Loading

Codecov Report

sviat9440 commented Oct 24, 2022

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

JoshuaKGoldberg commented Oct 24, 2022

JoshuaKGoldberg commented Oct 24, 2022

sviat9440 commented Oct 24, 2022

fix(type-utils): prevent stack overflow in `isTypeReadonly` #5860

fix(type-utils): prevent stack overflow in `isTypeReadonly` #5860

nx-cloud bot commented Oct 23, 2022 •

edited

Loading

netlify bot commented Oct 23, 2022 •

edited

Loading

codecov bot commented Oct 23, 2022 •

edited

Loading