Skip to content

fix(eslint-plugin): prefer-readonly-parameter-types] more isTypeReadonly stack overflow handling #5876

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Nov 2, 2022
Merged

fix(eslint-plugin): prefer-readonly-parameter-types] more isTypeReadonly stack overflow handling #5876

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e22ae8d
fix(eslint-plugin): isTypeReadonly stack overflow (#5875)
sviat9440 Oct 24, 2022
338b5b1
Merge branch 'main' into fix/5875
JoshuaKGoldberg Nov 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions packages/eslint-plugin/tests/rules/prefer-readonly-parameter-types.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -380,6 +380,27 @@ ruleTester.run('prefer-readonly-parameter-types', rule, {
},
],
},
{
name: 'circular readonly types (Bug: #5875)',
code: `
interface Obj1 {
readonly [K: string]: Obj2;
}

interface Obj2 {
readonly [K: string]: Obj1;
}

function foo(event: Obj1): void {}
`,
options: [
{
checkParameterProperties: true,
ignoreInferredTypes: false,
...readonlynessOptionsDefaults,
},
],
},
],
invalid: [
// arrays
Expand Down
2 changes: 1 addition & 1 deletion packages/type-utils/src/isTypeReadonly.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ function isTypeReadonlyObject(
return Readonlyness.Mutable;
}

if (indexInfo.type === type) {
if (indexInfo.type === type || seenTypes.has(indexInfo.type)) {
return Readonlyness.Readonly;
}

Expand Down
22 changes: 21 additions & 1 deletion packages/type-utils/tests/isTypeReadonly.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,11 @@ describe('isTypeReadonly', () => {

it('handles circular readonly PropertySignature inside a readonly IndexSignature', () =>
runTests('interface Test { readonly [key: string]: Test };'));

it('handles circular readonly PropertySignature inside interdependent objects', () =>
runTests(
'interface Test1 { readonly [key: string]: Test } interface Test { readonly [key: string]: Test1 }',
));
});

describe('is not readonly', () => {
Expand All @@ -156,8 +161,23 @@ describe('isTypeReadonly', () => {
describe('is not readonly circular', () => {
const runTests = runTestIsNotReadonly;

it('handles circular mutable PropertySignature inside a readonly IndexSignature', () =>
it('handles circular mutable PropertySignature', () =>
runTests('interface Test { [key: string]: Test };'));

it.each([
[
'interface Test1 { [key: string]: Test } interface Test { readonly [key: string]: Test1 }',
],
[
'interface Test1 { readonly [key: string]: Test } interface Test { [key: string]: Test1 }',
],
[
'interface Test1 { [key: string]: Test } interface Test { [key: string]: Test1 }',
],
])(
'handles circular mutable PropertySignature inside interdependent objects',
runTests,
);
});
});

Expand Down