From aa759317c1313c38cd00dbbbb77406da78b1f29b Mon Sep 17 00:00:00 2001 From: Brennan Benson <79079362+brennanb2025@users.noreply.github.com> Date: Sun, 8 Nov 2026 12:14:08 -0800 Subject: [PATCH] chore(ratchets): charge shorthand timer escapes; skip writes, typeof and JSX tags Review: `{ setInterval }` of the global counted 0, while assignments to it, parenthesized typeof probes and a tag counted 1. --- .../check-recurring-timer-ratchet.mjs | 58 ++++++++++++++----- .../check-recurring-timer-ratchet.test.mjs | 4 +- 2 files changed, 48 insertions(+), 14 deletions(-) diff --git a/config/scripts/static-analysis/ratchets/runtime-lifecycle/check-recurring-timer-ratchet.mjs b/config/scripts/static-analysis/ratchets/runtime-lifecycle/check-recurring-timer-ratchet.mjs index 221efd28f9b..88b1104cc53 100644 --- a/config/scripts/static-analysis/ratchets/runtime-lifecycle/check-recurring-timer-ratchet.mjs +++ b/config/scripts/static-analysis/ratchets/runtime-lifecycle/check-recurring-timer-ratchet.mjs @@ -39,19 +39,47 @@ function isHostInterval(node) { ) } -// A value reference to the identifier, not a declaration, member name, key or `typeof` probe. +// Skips transparent wrappers so `typeof (setInterval)` and `(setInterval) = x` read like the bare forms. +function outerExpression(node) { + let current = node + while (ts.isParenthesizedExpression(current.parent)) { + current = current.parent + } + return current +} + +// Reads the timer value: not a write target, a `typeof` probe or a JSX tag name. +function isRuntimeRead(node) { + const outer = outerExpression(node) + const parent = outer.parent + return !( + ts.isTypeOfExpression(parent) || + (ts.isBinaryExpression(parent) && + parent.left === outer && + parent.operatorToken.kind >= ts.SyntaxKind.FirstAssignment && + parent.operatorToken.kind <= ts.SyntaxKind.LastAssignment) || + ((ts.isJsxOpeningElement(parent) || + ts.isJsxSelfClosingElement(parent) || + ts.isJsxClosingElement(parent)) && + parent.tagName === node) + ) +} + +// A value reference to the identifier, not a declaration, member name or key. function isBareValueReference(node) { const parent = node.parent - return !( - (ts.isPropertyAccessExpression(parent) && parent.name === node) || - (ts.isPropertyAssignment(parent) && parent.name === node) || - ts.isTypeOfExpression(parent) || - ts.isImportSpecifier(parent) || - ts.isExportSpecifier(parent) || - (ts.isBindingElement(parent) && (parent.name === node || parent.propertyName === node)) || - (ts.isVariableDeclaration(parent) && parent.name === node) || - (ts.isParameter(parent) && parent.name === node) || - ((ts.isFunctionDeclaration(parent) || ts.isMethodDeclaration(parent)) && parent.name === node) + return ( + isRuntimeRead(node) && + !( + (ts.isPropertyAccessExpression(parent) && parent.name === node) || + (ts.isPropertyAssignment(parent) && parent.name === node) || + ts.isImportSpecifier(parent) || + ts.isExportSpecifier(parent) || + (ts.isBindingElement(parent) && (parent.name === node || parent.propertyName === node)) || + (ts.isVariableDeclaration(parent) && parent.name === node) || + (ts.isParameter(parent) && parent.name === node) || + ((ts.isFunctionDeclaration(parent) || ts.isMethodDeclaration(parent)) && parent.name === node) + ) ) } @@ -72,11 +100,15 @@ function countGlobalTimerReferences(source) { if ( (ts.isPropertyAccessExpression(node) || ts.isElementAccessExpression(node)) && isHostInterval(node) && - !ts.isTypeOfExpression(node.parent) + isRuntimeRead(node) ) { count += 1 } else if (ts.isIdentifier(node) && node.text === 'setInterval' && isBareValueReference(node)) { - const declarations = checker.getSymbolAtLocation(node)?.declarations ?? [] + // A shorthand `{ setInterval }` names the property; its value is the binding being read. + const symbol = ts.isShorthandPropertyAssignment(node.parent) + ? checker.getShorthandAssignmentValueSymbol(node.parent) + : checker.getSymbolAtLocation(node) + const declarations = symbol?.declarations ?? [] if (!declarations.some((declaration) => declaration.getSourceFile() === source)) { count += 1 } diff --git a/config/scripts/static-analysis/ratchets/runtime-lifecycle/check-recurring-timer-ratchet.test.mjs b/config/scripts/static-analysis/ratchets/runtime-lifecycle/check-recurring-timer-ratchet.test.mjs index f1f77480160..03d94fa10d2 100644 --- a/config/scripts/static-analysis/ratchets/runtime-lifecycle/check-recurring-timer-ratchet.test.mjs +++ b/config/scripts/static-analysis/ratchets/runtime-lifecycle/check-recurring-timer-ratchet.test.mjs @@ -30,7 +30,9 @@ describe('recurring-timer ratchet', () => { ['const schedule = setInterval\nschedule(poll, 1000)', 1], ["window['setInterval'](poll, 1000)", 1], ['const every = window.setInterval\nevery(poll, 1)', 1], - ["if (typeof setInterval === 'function') {}\ntype T = typeof setInterval", 0] + ["if (typeof setInterval === 'function') {}\ntype T = typeof setInterval", 0], + ['const deps = { setInterval, clearInterval }\ndeps.setInterval(poll, 1)', 1], + ["setInterval = replacement\nwindow['setInterval'] = replacement\ntypeof (setInterval)", 0] ])('counts %s', (source, count) => { expect(countRecurringTimers('src/main/example.ts', source)).toBe(count) })