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

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

Merged
merged 2 commits into from Oct 24, 2022

Conversation

sviat9440
Copy link
Contributor

PR Checklist

@nx-cloud
Copy link

nx-cloud bot commented Oct 23, 2022

☁️ 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
Copy link
Contributor

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
Copy link

netlify bot commented Oct 23, 2022

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...

QR Code

Use your smartphone camera to open QR code link.

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

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

codecov bot commented Oct 23, 2022

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%) ⬆️

@bradzacher bradzacher changed the title fix(eslint-plugin): isTypeReadonly stack overflow (#4476) fix(type-utils): prevent stack overflow in isTypeReadonly Oct 24, 2022
@bradzacher bradzacher added the bug Something isn't working label Oct 24, 2022
@sviat9440
Copy link
Contributor Author

Another fail test case:

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

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

@sviat9440 sviat9440 marked this pull request as draft October 24, 2022 15:22
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member

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 JoshuaKGoldberg marked this pull request as ready for review October 24, 2022 17:21
@JoshuaKGoldberg JoshuaKGoldberg enabled auto-merge (squash) October 24, 2022 17:21
@JoshuaKGoldberg JoshuaKGoldberg merged commit a6d8f7e into typescript-eslint:main Oct 24, 2022
@JoshuaKGoldberg
Copy link
Member

@sviat9440
Copy link
Contributor Author

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

crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull request Oct 25, 2022
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 (@&#8203;typescript-eslint/eslint-plugin)</summary>

### [`v5.41.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#&#8203;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 ([#&#8203;5839](typescript-eslint/typescript-eslint#5839)) ([96e1c6c](typescript-eslint/typescript-eslint@96e1c6c))
-   **type-utils:** prevent stack overflow in `isTypeReadonly` ([#&#8203;5860](typescript-eslint/typescript-eslint#5860)) ([a6d8f7e](typescript-eslint/typescript-eslint@a6d8f7e)), closes [#&#8203;4476](typescript-eslint/typescript-eslint#4476)

##### Features

-   **eslint-plugin:** \[no-unsafe-declaration-merging] switch to use scope analysis instead of type information ([#&#8203;5865](typescript-eslint/typescript-eslint#5865)) ([e70a10a](typescript-eslint/typescript-eslint@e70a10a))
-   **eslint-plugin:** add no-unsafe-declaration-merging ([#&#8203;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 ([#&#8203;5809](typescript-eslint/typescript-eslint#5809)) ([c5beaa2](typescript-eslint/typescript-eslint@c5beaa2)), closes [#&#8203;5807](typescript-eslint/typescript-eslint#5807)

</details>

<details>
<summary>typescript-eslint/typescript-eslint (@&#8203;typescript-eslint/parser)</summary>

### [`v5.41.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#&#8203;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 [@&#8203;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 [@&#8203;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.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox.

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzMy4xLjAiLCJ1cGRhdGVkSW5WZXIiOiIzMy4xLjAifQ==-->

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>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 17, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: [prefer-readonly-parameter-types] isTypeReadonly stack overflow
3 participants