fix(eslint-plugin): [no-base-to-string] don't crash for recursive array or tuple types #10633

ronami · 2025-01-07T22:57:46Z

PR Checklist

Addresses an existing open issue: fixes Bug: [no-base-to-string] stack overflow with recursive type #10632
That issue was marked as accepting prs
Steps in Contributing were taken

Overview

This PR addresses #10632 and fixes the rule so it does not fail on recursive array or tuple types. It looks like this regression has been introduced in #10437.

Not directly related: It seems not intentional, but since #10437, the rule reports invalid nested array types (which it didn't previously):

declare const s: { foo: 'bar' }[][];

// [object Object]
s.join();

Previously, the array check (which used to run only on array.join()) never checked for nested array types. This changed on #10437, and the recursive check also runs as part of array.join() (which means the crash reproduces on recursive array.join() too, playground link).

There's no test that checks this behavior (which I think is intended), so I've added a couple of tests for this. Please let me know if this isn't intended behavior or if this should be done on a separate PR.

typescript-eslint · 2025-01-07T22:57:49Z

Thanks for the PR, @ronami!

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.

netlify · 2025-01-07T22:58:10Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`75d2265`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/678d3a98bd72c4000823d20e
😎 Deploy Preview	https://deploy-preview-10633--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 91 (🔴 down 7 from production) Accessibility: 100 (no change from production) Best Practices: 92 (no change from production) SEO: 98 (no change from production) PWA: 80 (no change from production) View the detailed breakdown and full score reports

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

nx-cloud · 2025-01-07T22:58:37Z

View your CI Pipeline Execution ↗ for commit 75d2265.

Command	Status	Duration	Result
`nx run-many --target=build --exclude website --...`	✅ Succeeded	5s	View ↗
`nx run-many --target=clean`	✅ Succeeded	10s	View ↗

☁️ Nx Cloud last updated this comment at 2025-01-20 09:10:41 UTC

codecov · 2025-01-07T23:13:44Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.16%. Comparing base (b17c7f2) to head (75d2265).
Report is 31 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #10633      +/-   ##
==========================================
+ Coverage   86.94%   87.16%   +0.21%     
==========================================
  Files         446      448       +2     
  Lines       15508    15585      +77     
  Branches     4518     4552      +34     
==========================================
+ Hits        13484    13584     +100     
+ Misses       1669     1645      -24     
- Partials      355      356       +1

Flag	Coverage Δ
unittest	`87.16% <100.00%> (+0.21%)`	⬆️

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

Files with missing lines	Coverage Δ
...kages/eslint-plugin/src/rules/no-base-to-string.ts	`97.24% <100.00%> (+0.18%)`	⬆️

... and 96 files with indirect coverage changes

ronami · 2025-01-08T17:03:45Z

packages/eslint-plugin/tests/rules/no-base-to-string.test.ts

+type Value = Value[];
+declare const v: Value;
+
+String(v);


To my understanding, types like this are valid to stringify.

packages/eslint-plugin/src/rules/no-base-to-string.ts

kirkwaiblinger

JoshuaKGoldberg

@yeonjuan

##### [v8.21.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8210-2025-01-20) ##### 🩹 Fixes - **eslint-plugin:** \[no-duplicate-enum-values] handle template literal ([#10675](typescript-eslint/typescript-eslint#10675)) - **eslint-plugin:** \[no-base-to-string] don't crash for recursive array or tuple types ([#10633](typescript-eslint/typescript-eslint#10633)) - **eslint-plugin:** \[no-for-in-array] report on any type which may be an array or array-like ([#10535](typescript-eslint/typescript-eslint#10535)) - **eslint-plugin:** check JSX spread elements for misused spread usage ([#10653](typescript-eslint/typescript-eslint#10653)) - **eslint-plugin:** \[no-unnecessary-type-arguments] handle type args on jsx ([#10630](typescript-eslint/typescript-eslint#10630)) ##### ❤️ Thank You - Ronen Amiel - YeonJuan [@yeonjuan](https://github.com/yeonjuan) You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.

@yeonjuan

##### [v8.21.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8210-2025-01-20) ##### 🩹 Fixes - **eslint-plugin:** \[no-duplicate-enum-values] handle template literal ([#10675](typescript-eslint/typescript-eslint#10675)) - **eslint-plugin:** \[no-base-to-string] don't crash for recursive array or tuple types ([#10633](typescript-eslint/typescript-eslint#10633)) - **eslint-plugin:** \[no-for-in-array] report on any type which may be an array or array-like ([#10535](typescript-eslint/typescript-eslint#10535)) - **eslint-plugin:** check JSX spread elements for misused spread usage ([#10653](typescript-eslint/typescript-eslint#10653)) - **eslint-plugin:** \[no-unnecessary-type-arguments] handle type args on jsx ([#10630](typescript-eslint/typescript-eslint#10630)) ##### ❤️ Thank You - Ronen Amiel - YeonJuan [@yeonjuan](https://github.com/yeonjuan) You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.

@yeonjuan

| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.20.0 | 8.21.0 | | npm | @typescript-eslint/parser | 8.20.0 | 8.21.0 | ## [v8.21.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8210-2025-01-20) ##### 🩹 Fixes - **eslint-plugin:** \[no-duplicate-enum-values] handle template literal ([#10675](typescript-eslint/typescript-eslint#10675)) - **eslint-plugin:** \[no-base-to-string] don't crash for recursive array or tuple types ([#10633](typescript-eslint/typescript-eslint#10633)) - **eslint-plugin:** \[no-for-in-array] report on any type which may be an array or array-like ([#10535](typescript-eslint/typescript-eslint#10535)) - **eslint-plugin:** check JSX spread elements for misused spread usage ([#10653](typescript-eslint/typescript-eslint#10653)) - **eslint-plugin:** \[no-unnecessary-type-arguments] handle type args on jsx ([#10630](typescript-eslint/typescript-eslint#10630)) ##### ❤️ Thank You - Ronen Amiel - YeonJuan [@yeonjuan](https://github.com/yeonjuan) You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.

@yeonjuan

| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.20.0 | 8.21.0 | | npm | @typescript-eslint/parser | 8.20.0 | 8.21.0 | ## [v8.21.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8210-2025-01-20) ##### 🩹 Fixes - **eslint-plugin:** \[no-duplicate-enum-values] handle template literal ([#10675](typescript-eslint/typescript-eslint#10675)) - **eslint-plugin:** \[no-base-to-string] don't crash for recursive array or tuple types ([#10633](typescript-eslint/typescript-eslint#10633)) - **eslint-plugin:** \[no-for-in-array] report on any type which may be an array or array-like ([#10535](typescript-eslint/typescript-eslint#10535)) - **eslint-plugin:** check JSX spread elements for misused spread usage ([#10653](typescript-eslint/typescript-eslint#10653)) - **eslint-plugin:** \[no-unnecessary-type-arguments] handle type args on jsx ([#10630](typescript-eslint/typescript-eslint#10630)) ##### ❤️ Thank You - Ronen Amiel - YeonJuan [@yeonjuan](https://github.com/yeonjuan) You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.

don't crash for recursive array or tuple types

fbeb999

ronami marked this pull request as ready for review January 7, 2025 23:13

ronami marked this pull request as draft January 7, 2025 23:41

ronami added 2 commits January 8, 2025 18:54

testing adjustments

5b74c62

change test

ea7e77c

ronami commented Jan 8, 2025

View reviewed changes

change test

24da033

ronami marked this pull request as ready for review January 8, 2025 17:08

kirkwaiblinger reviewed Jan 19, 2025

View reviewed changes

packages/eslint-plugin/src/rules/no-base-to-string.ts Show resolved Hide resolved

packages/eslint-plugin/src/rules/no-base-to-string.ts Outdated Show resolved Hide resolved

simplify passing of 'visited' for array-join

75d2265

kirkwaiblinger approved these changes Jan 20, 2025

View reviewed changes

kirkwaiblinger added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Jan 20, 2025

JoshuaKGoldberg approved these changes Jan 20, 2025

View reviewed changes

JoshuaKGoldberg merged commit 1895948 into typescript-eslint:main Jan 20, 2025
63 of 64 checks passed

ronami deleted the no-base-to-string-call-stack branch January 20, 2025 15:15

github-actions bot locked as resolved and limited conversation to collaborators Jan 28, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(eslint-plugin): [no-base-to-string] don't crash for recursive array or tuple types #10633

fix(eslint-plugin): [no-base-to-string] don't crash for recursive array or tuple types #10633

Uh oh!

ronami commented Jan 7, 2025 •

edited

Loading

Uh oh!

typescript-eslint bot commented Jan 7, 2025

Uh oh!

netlify bot commented Jan 7, 2025 •

edited

Loading

Uh oh!

nx-cloud bot commented Jan 7, 2025 •

edited

Loading

Uh oh!

codecov bot commented Jan 7, 2025 •

edited

Loading

Uh oh!

ronami Jan 8, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

kirkwaiblinger left a comment

Uh oh!

JoshuaKGoldberg left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fix(eslint-plugin): [no-base-to-string] don't crash for recursive array or tuple types #10633

fix(eslint-plugin): [no-base-to-string] don't crash for recursive array or tuple types #10633

Uh oh!

Conversation

ronami commented Jan 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Checklist

Overview

Uh oh!

typescript-eslint bot commented Jan 7, 2025

Uh oh!

netlify bot commented Jan 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for typescript-eslint ready!

Uh oh!

nx-cloud bot commented Jan 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Jan 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ronami Jan 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

kirkwaiblinger left a comment

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ronami commented Jan 7, 2025 •

edited

Loading

netlify bot commented Jan 7, 2025 •

edited

Loading

nx-cloud bot commented Jan 7, 2025 •

edited

Loading

codecov bot commented Jan 7, 2025 •

edited

Loading

ronami Jan 8, 2025 •

edited

Loading