Bug: [@typescript-eslint/prefer-readonly-parameter-types] gives error "Cannot read properties of undefined (reading 'checkFlags')"

[stephen-carter-at-sf]

Before You File a Bug Report Please Confirm You Have Done The Following...

• I have tried restarting my IDE and the issue persists.
• I have updated to the latest version of the packages.
• I have searched for related issues and found none that matched my issue.
• I have read the FAQ and my problem is not listed.

Issue Description

When I have a dependency on
"@types/jest": "^29.5.14",
then I get the following error:

TypeError: Cannot read properties of undefined (reading 'checkFlags')
Occurred while linting /Users/stephen.carter/temp/typescript_eslint_bug/test/dummy.test.ts:5
Rule: "@typescript-eslint/prefer-readonly-parameter-types"
    at isTransientSymbolLinksFlagSet (/Users/stephen.carter/temp/typescript_eslint_bug/node_modules/ts-api-utils/lib/index.cjs:143:26)
    at isInConstContext (/Users/stephen.carter/temp/typescript_eslint_bug/node_modules/ts-api-utils/lib/index.cjs:994:16)
    at /Users/stephen.carter/temp/typescript_eslint_bug/node_modules/ts-api-utils/lib/index.cjs:1088:464
    at Array.some (<anonymous>)
    at symbolHasReadonlyDeclaration (/Users/stephen.carter/temp/typescript_eslint_bug/node_modules/ts-api-utils/lib/index.cjs:1087:145)
    at /Users/stephen.carter/temp/typescript_eslint_bug/node_modules/ts-api-utils/lib/index.cjs:1172:5
    at Array.some (<anonymous>)
    at isReadonlyPropertyIntersection (/Users/stephen.carter/temp/typescript_eslint_bug/node_modules/ts-api-utils/lib/index.cjs:1154:23)
    at Object.isPropertyReadonlyInType (/Users/stephen.carter/temp/typescript_eslint_bug/node_modules/ts-api-utils/lib/index.cjs:1059:41)
    at isTypeReadonlyObject (/Users/stephen.carter/temp/typescript_eslint_bug/node_modules/@typescript-eslint/type-utils/dist/isTypeReadonly.js:138:25)

If I remove this dependency then I don't get the error.

Specifically in my jest test file it doesn't seem to like parameters in my describe calls.

I'm not sure if the @typescript-eslint/prefer-readonly-parameter-types rule has a bug or there is a conflict or what. But it took me forever to reduce my project down to this super small reproduction steps.

Reproduction Repository Link

https://github.com/stephen-carter-at-sf/typescript_eslint_bug

Repro Steps

1. clone the repo
2. npm install
3. npx eslint test/dummy.test.ts

Versions

"@types/jest": "^29.5.14",
"jest": "^29.7.0",
"@eslint/js": "^9.28.0",
"eslint": "^9.28.0",
"typescript": "^5.8.3",
"typescript-eslint": "^8.33.1"

[kirkwaiblinger]

Hi @stephen-carter-at-sf!

I've cloned this down and I can repro it... Not quite sure what the issue is, but I'm wondering whether this is possibly a bug in ts-api-utils. @JoshuaKGoldberg.

This was a tricky one but I was able to get a playground repro:

• Error with TS >= 5.5.4
• Working as expected with TS <= 5.4.5

Code

declare const fooFactory: <T>(x: readonly T[]) => (f: (x: T) => void) => void;

fooFactory([{ abc: 42 }])((x) => { });
//                         ^ inspecting this parameter causes the crash

Eslint config

{
  "rules": {
    "@typescript-eslint/prefer-readonly-parameter-types": "warn"
  }
}

TypeScript config

{
  "compilerOptions": {
    "strictNullChecks": true
  }
}

package	version
@typescript-eslint/eslint-plugin	8.34.0
@typescript-eslint/parser	8.34.0
TypeScript	5.4.5
ESLint	9.26.0
node	web

[JoshuaKGoldberg]

Lovely. Here's the crash from adding a rule test case:

Caused by: TypeError: Cannot read properties of undefined (reading 'checkFlags')
Occurred while linting /Users/josh/repos/typescript-eslint/packages/eslint-plugin/tests/fixtures/file.ts:4
Rule: "@rule-tester/prefer-readonly-parameter-types"
 ❯ isTransientSymbolLinksFlagSet ../../node_modules/ts-api-utils/lib/index.cjs:143:26
 ❯ isInConstContext ../../node_modules/ts-api-utils/lib/index.cjs:994:16
 ❯ ../../node_modules/ts-api-utils/lib/index.cjs:1088:464
 ❯ symbolHasReadonlyDeclaration ../../node_modules/ts-api-utils/lib/index.cjs:1087:145
 ❯ ../../node_modules/ts-api-utils/lib/index.cjs:1172:5
 ❯ isReadonlyPropertyIntersection ../../node_modules/ts-api-utils/lib/index.cjs:1154:23
 ❯ Object.isPropertyReadonlyInType ../../node_modules/ts-api-utils/lib/index.cjs:1059:41
 ❯ isTypeReadonlyObject ../type-utils/dist/isTypeReadonly.js:138:25

Filed: JoshuaKGoldberg/ts-api-utils#754