sourceverity 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +188 -0
- package/bin/sourceverity.js +12 -0
- package/dist/analysis/controlFlow.d.ts +10 -0
- package/dist/analysis/controlFlow.d.ts.map +1 -0
- package/dist/analysis/controlFlow.js +278 -0
- package/dist/analysis/controlFlow.js.map +1 -0
- package/dist/analysis/frameworks.d.ts +11 -0
- package/dist/analysis/frameworks.d.ts.map +1 -0
- package/dist/analysis/frameworks.js +189 -0
- package/dist/analysis/frameworks.js.map +1 -0
- package/dist/analysis/functions.d.ts +27 -0
- package/dist/analysis/functions.d.ts.map +1 -0
- package/dist/analysis/functions.js +628 -0
- package/dist/analysis/functions.js.map +1 -0
- package/dist/analysis/promiseFlow.d.ts +44 -0
- package/dist/analysis/promiseFlow.d.ts.map +1 -0
- package/dist/analysis/promiseFlow.js +261 -0
- package/dist/analysis/promiseFlow.js.map +1 -0
- package/dist/analysis/values.d.ts +24 -0
- package/dist/analysis/values.d.ts.map +1 -0
- package/dist/analysis/values.js +189 -0
- package/dist/analysis/values.js.map +1 -0
- package/dist/baseline/manager.d.ts +20 -0
- package/dist/baseline/manager.d.ts.map +1 -0
- package/dist/baseline/manager.js +77 -0
- package/dist/baseline/manager.js.map +1 -0
- package/dist/baseline/types.d.ts +20 -0
- package/dist/baseline/types.d.ts.map +1 -0
- package/dist/baseline/types.js +2 -0
- package/dist/baseline/types.js.map +1 -0
- package/dist/cli/args.d.ts +26 -0
- package/dist/cli/args.d.ts.map +1 -0
- package/dist/cli/args.js +126 -0
- package/dist/cli/args.js.map +1 -0
- package/dist/cli/exitCodes.d.ts +8 -0
- package/dist/cli/exitCodes.d.ts.map +1 -0
- package/dist/cli/exitCodes.js +7 -0
- package/dist/cli/exitCodes.js.map +1 -0
- package/dist/cli/help.d.ts +5 -0
- package/dist/cli/help.d.ts.map +1 -0
- package/dist/cli/help.js +46 -0
- package/dist/cli/help.js.map +1 -0
- package/dist/cli/main.d.ts +7 -0
- package/dist/cli/main.d.ts.map +1 -0
- package/dist/cli/main.js +156 -0
- package/dist/cli/main.js.map +1 -0
- package/dist/core/fingerprint.d.ts +18 -0
- package/dist/core/fingerprint.d.ts.map +1 -0
- package/dist/core/fingerprint.js +26 -0
- package/dist/core/fingerprint.js.map +1 -0
- package/dist/core/paths.d.ts +10 -0
- package/dist/core/paths.d.ts.map +1 -0
- package/dist/core/paths.js +30 -0
- package/dist/core/paths.js.map +1 -0
- package/dist/core/suppressions.d.ts +24 -0
- package/dist/core/suppressions.d.ts.map +1 -0
- package/dist/core/suppressions.js +100 -0
- package/dist/core/suppressions.js.map +1 -0
- package/dist/core/terminal.d.ts +18 -0
- package/dist/core/terminal.d.ts.map +1 -0
- package/dist/core/terminal.js +39 -0
- package/dist/core/terminal.js.map +1 -0
- package/dist/core/types.d.ts +119 -0
- package/dist/core/types.d.ts.map +1 -0
- package/dist/core/types.js +2 -0
- package/dist/core/types.js.map +1 -0
- package/dist/engine/context.d.ts +16 -0
- package/dist/engine/context.d.ts.map +1 -0
- package/dist/engine/context.js +57 -0
- package/dist/engine/context.js.map +1 -0
- package/dist/engine/registry.d.ts +26 -0
- package/dist/engine/registry.d.ts.map +1 -0
- package/dist/engine/registry.js +38 -0
- package/dist/engine/registry.js.map +1 -0
- package/dist/engine/runner.d.ts +14 -0
- package/dist/engine/runner.d.ts.map +1 -0
- package/dist/engine/runner.js +166 -0
- package/dist/engine/runner.js.map +1 -0
- package/dist/engine/symbols.d.ts +46 -0
- package/dist/engine/symbols.d.ts.map +1 -0
- package/dist/engine/symbols.js +278 -0
- package/dist/engine/symbols.js.map +1 -0
- package/dist/index.d.ts +20 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +32 -0
- package/dist/index.js.map +1 -0
- package/dist/reporters/agent.d.ts +45 -0
- package/dist/reporters/agent.d.ts.map +1 -0
- package/dist/reporters/agent.js +40 -0
- package/dist/reporters/agent.js.map +1 -0
- package/dist/reporters/json.d.ts +6 -0
- package/dist/reporters/json.d.ts.map +1 -0
- package/dist/reporters/json.js +7 -0
- package/dist/reporters/json.js.map +1 -0
- package/dist/reporters/sarif.d.ts +6 -0
- package/dist/reporters/sarif.d.ts.map +1 -0
- package/dist/reporters/sarif.js +60 -0
- package/dist/reporters/sarif.js.map +1 -0
- package/dist/reporters/terminal.d.ts +10 -0
- package/dist/reporters/terminal.d.ts.map +1 -0
- package/dist/reporters/terminal.js +105 -0
- package/dist/reporters/terminal.js.map +1 -0
- package/dist/repository/detector.d.ts +6 -0
- package/dist/repository/detector.d.ts.map +1 -0
- package/dist/repository/detector.js +231 -0
- package/dist/repository/detector.js.map +1 -0
- package/dist/repository/fileFilter.d.ts +10 -0
- package/dist/repository/fileFilter.d.ts.map +1 -0
- package/dist/repository/fileFilter.js +78 -0
- package/dist/repository/fileFilter.js.map +1 -0
- package/dist/repository/git.d.ts +7 -0
- package/dist/repository/git.d.ts.map +1 -0
- package/dist/repository/git.js +53 -0
- package/dist/repository/git.js.map +1 -0
- package/dist/repository/tsLoader.d.ts +15 -0
- package/dist/repository/tsLoader.d.ts.map +1 -0
- package/dist/repository/tsLoader.js +27 -0
- package/dist/repository/tsLoader.js.map +1 -0
- package/dist/repository/types.d.ts +38 -0
- package/dist/repository/types.d.ts.map +1 -0
- package/dist/repository/types.js +2 -0
- package/dist/repository/types.js.map +1 -0
- package/dist/rules/async/asyncForeach.d.ts +3 -0
- package/dist/rules/async/asyncForeach.d.ts.map +1 -0
- package/dist/rules/async/asyncForeach.js +76 -0
- package/dist/rules/async/asyncForeach.js.map +1 -0
- package/dist/rules/async/floatingPromise.d.ts +3 -0
- package/dist/rules/async/floatingPromise.d.ts.map +1 -0
- package/dist/rules/async/floatingPromise.js +359 -0
- package/dist/rules/async/floatingPromise.js.map +1 -0
- package/dist/rules/browser/eventListenerCleanup.d.ts +3 -0
- package/dist/rules/browser/eventListenerCleanup.d.ts.map +1 -0
- package/dist/rules/browser/eventListenerCleanup.js +378 -0
- package/dist/rules/browser/eventListenerCleanup.js.map +1 -0
- package/dist/rules/browser/observerCleanup.d.ts +3 -0
- package/dist/rules/browser/observerCleanup.d.ts.map +1 -0
- package/dist/rules/browser/observerCleanup.js +184 -0
- package/dist/rules/browser/observerCleanup.js.map +1 -0
- package/dist/rules/browser/timerCleanup.d.ts +3 -0
- package/dist/rules/browser/timerCleanup.d.ts.map +1 -0
- package/dist/rules/browser/timerCleanup.js +115 -0
- package/dist/rules/browser/timerCleanup.js.map +1 -0
- package/dist/rules/index.d.ts +19 -0
- package/dist/rules/index.d.ts.map +1 -0
- package/dist/rules/index.js +41 -0
- package/dist/rules/index.js.map +1 -0
- package/dist/rules/network/fetchStatusUnchecked.d.ts +3 -0
- package/dist/rules/network/fetchStatusUnchecked.d.ts.map +1 -0
- package/dist/rules/network/fetchStatusUnchecked.js +96 -0
- package/dist/rules/network/fetchStatusUnchecked.js.map +1 -0
- package/dist/rules/react/asyncEffectCallback.d.ts +3 -0
- package/dist/rules/react/asyncEffectCallback.d.ts.map +1 -0
- package/dist/rules/react/asyncEffectCallback.js +62 -0
- package/dist/rules/react/asyncEffectCallback.js.map +1 -0
- package/dist/rules/react/derivedStateEffect.d.ts +3 -0
- package/dist/rules/react/derivedStateEffect.d.ts.map +1 -0
- package/dist/rules/react/derivedStateEffect.js +172 -0
- package/dist/rules/react/derivedStateEffect.js.map +1 -0
- package/dist/rules/react/missingEffectCleanup.d.ts +3 -0
- package/dist/rules/react/missingEffectCleanup.d.ts.map +1 -0
- package/dist/rules/react/missingEffectCleanup.js +86 -0
- package/dist/rules/react/missingEffectCleanup.js.map +1 -0
- package/dist/rules/typescript/nonNullAssertionRisk.d.ts +3 -0
- package/dist/rules/typescript/nonNullAssertionRisk.d.ts.map +1 -0
- package/dist/rules/typescript/nonNullAssertionRisk.js +65 -0
- package/dist/rules/typescript/nonNullAssertionRisk.js.map +1 -0
- package/dist/rules/typescript/uncheckedIndexAccess.d.ts +3 -0
- package/dist/rules/typescript/uncheckedIndexAccess.d.ts.map +1 -0
- package/dist/rules/typescript/uncheckedIndexAccess.js +79 -0
- package/dist/rules/typescript/uncheckedIndexAccess.js.map +1 -0
- package/dist/rules/typescript/unsafeUnvalidatedAssertion.d.ts +3 -0
- package/dist/rules/typescript/unsafeUnvalidatedAssertion.d.ts.map +1 -0
- package/dist/rules/typescript/unsafeUnvalidatedAssertion.js +94 -0
- package/dist/rules/typescript/unsafeUnvalidatedAssertion.js.map +1 -0
- package/dist/strictness/evaluator.d.ts +28 -0
- package/dist/strictness/evaluator.d.ts.map +1 -0
- package/dist/strictness/evaluator.js +141 -0
- package/dist/strictness/evaluator.js.map +1 -0
- package/dist/strictness/matrix.d.ts +8 -0
- package/dist/strictness/matrix.d.ts.map +1 -0
- package/dist/strictness/matrix.js +63 -0
- package/dist/strictness/matrix.js.map +1 -0
- package/dist/typescript/programManager.d.ts +18 -0
- package/dist/typescript/programManager.d.ts.map +1 -0
- package/dist/typescript/programManager.js +46 -0
- package/dist/typescript/programManager.js.map +1 -0
- package/dist/typescript/projectResolver.d.ts +17 -0
- package/dist/typescript/projectResolver.d.ts.map +1 -0
- package/dist/typescript/projectResolver.js +75 -0
- package/dist/typescript/projectResolver.js.map +1 -0
- package/package.json +56 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"eventListenerCleanup.d.ts","sourceRoot":"","sources":["../../../src/rules/browser/eventListenerCleanup.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAe,MAAM,qBAAqB,CAAC;AAE7D,eAAO,MAAM,wBAAwB,EAAE,IA0dtC,CAAC"}
|
|
@@ -0,0 +1,378 @@
|
|
|
1
|
+
import { getNodeSourceRange, resolveReactHook, isDOMEventTarget, isDOMAbortController } from "../../engine/symbols.js";
|
|
2
|
+
export const eventListenerCleanupRule = {
|
|
3
|
+
meta: {
|
|
4
|
+
id: "browser/event-listener-cleanup",
|
|
5
|
+
category: "browser",
|
|
6
|
+
defaultSeverity: "error",
|
|
7
|
+
defaultConfidence: "high",
|
|
8
|
+
description: "Detects addEventListener registered in lifecycle hooks without matching removeEventListener cleanup.",
|
|
9
|
+
requiresTypeInformation: false,
|
|
10
|
+
},
|
|
11
|
+
analyze(context) {
|
|
12
|
+
const { sourceFile, checker, ts } = context;
|
|
13
|
+
if (!ts)
|
|
14
|
+
return;
|
|
15
|
+
context.visitNodes((node) => {
|
|
16
|
+
// Find useEffect or useLayoutEffect calls
|
|
17
|
+
if (!ts.isCallExpression(node))
|
|
18
|
+
return;
|
|
19
|
+
let isLifecycleHook = false;
|
|
20
|
+
if (checker && (resolveReactHook(node, checker, "useEffect") || resolveReactHook(node, checker, "useLayoutEffect"))) {
|
|
21
|
+
isLifecycleHook = true;
|
|
22
|
+
}
|
|
23
|
+
else if (ts.isIdentifier(node.expression) && (node.expression.text === "useEffect" || node.expression.text === "useLayoutEffect")) {
|
|
24
|
+
isLifecycleHook = true;
|
|
25
|
+
}
|
|
26
|
+
if (!isLifecycleHook)
|
|
27
|
+
return;
|
|
28
|
+
const effectCallback = node.arguments[0];
|
|
29
|
+
if (!effectCallback || (!ts.isArrowFunction(effectCallback) && !ts.isFunctionExpression(effectCallback))) {
|
|
30
|
+
return;
|
|
31
|
+
}
|
|
32
|
+
function resolveEventExpression(expr, chk, t) {
|
|
33
|
+
let current = expr;
|
|
34
|
+
while (t.isParenthesizedExpression(current)) {
|
|
35
|
+
current = current.expression;
|
|
36
|
+
}
|
|
37
|
+
if (t.isStringLiteral(current) || t.isNoSubstitutionTemplateLiteral(current)) {
|
|
38
|
+
return {
|
|
39
|
+
rawText: current.text,
|
|
40
|
+
literalValue: current.text,
|
|
41
|
+
};
|
|
42
|
+
}
|
|
43
|
+
if (t.isIdentifier(current)) {
|
|
44
|
+
const rawText = current.text;
|
|
45
|
+
if (!chk) {
|
|
46
|
+
return { rawText };
|
|
47
|
+
}
|
|
48
|
+
const sym = chk.getSymbolAtLocation(current);
|
|
49
|
+
let rootSym = sym;
|
|
50
|
+
if (rootSym && (rootSym.flags & t.SymbolFlags.Alias) !== 0) {
|
|
51
|
+
try {
|
|
52
|
+
rootSym = chk.getAliasedSymbol(rootSym);
|
|
53
|
+
}
|
|
54
|
+
catch {
|
|
55
|
+
// ignore
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
let literalValue;
|
|
59
|
+
let targetSym = sym;
|
|
60
|
+
const visitedSyms = new Set();
|
|
61
|
+
while (targetSym && !visitedSyms.has(targetSym)) {
|
|
62
|
+
visitedSyms.add(targetSym);
|
|
63
|
+
const decl = targetSym.valueDeclaration ?? targetSym.declarations?.[0];
|
|
64
|
+
if (decl && t.isVariableDeclaration(decl) && decl.initializer) {
|
|
65
|
+
let init = decl.initializer;
|
|
66
|
+
while (t.isParenthesizedExpression(init)) {
|
|
67
|
+
init = init.expression;
|
|
68
|
+
}
|
|
69
|
+
if (t.isStringLiteral(init) || t.isNoSubstitutionTemplateLiteral(init)) {
|
|
70
|
+
literalValue = init.text;
|
|
71
|
+
break;
|
|
72
|
+
}
|
|
73
|
+
else if (t.isIdentifier(init)) {
|
|
74
|
+
const nextSym = chk.getSymbolAtLocation(init);
|
|
75
|
+
if (nextSym) {
|
|
76
|
+
targetSym = nextSym;
|
|
77
|
+
if (!rootSym)
|
|
78
|
+
rootSym = nextSym;
|
|
79
|
+
continue;
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
break;
|
|
84
|
+
}
|
|
85
|
+
if (literalValue === undefined) {
|
|
86
|
+
try {
|
|
87
|
+
const type = chk.getTypeAtLocation(current);
|
|
88
|
+
if (type.isStringLiteral()) {
|
|
89
|
+
literalValue = type.value;
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
catch {
|
|
93
|
+
// ignore
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
return {
|
|
97
|
+
rawText,
|
|
98
|
+
literalValue,
|
|
99
|
+
symbol: sym,
|
|
100
|
+
rootSymbol: rootSym,
|
|
101
|
+
};
|
|
102
|
+
}
|
|
103
|
+
if (t.isPropertyAccessExpression(current)) {
|
|
104
|
+
const rawText = current.getText();
|
|
105
|
+
let literalValue;
|
|
106
|
+
let sym;
|
|
107
|
+
let rootSym;
|
|
108
|
+
if (chk) {
|
|
109
|
+
sym = chk.getSymbolAtLocation(current);
|
|
110
|
+
rootSym = sym;
|
|
111
|
+
try {
|
|
112
|
+
const type = chk.getTypeAtLocation(current);
|
|
113
|
+
if (type.isStringLiteral()) {
|
|
114
|
+
literalValue = type.value;
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
catch {
|
|
118
|
+
// ignore
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
return {
|
|
122
|
+
rawText,
|
|
123
|
+
literalValue,
|
|
124
|
+
symbol: sym,
|
|
125
|
+
rootSymbol: rootSym,
|
|
126
|
+
};
|
|
127
|
+
}
|
|
128
|
+
return {
|
|
129
|
+
rawText: current.getText(),
|
|
130
|
+
};
|
|
131
|
+
}
|
|
132
|
+
function areEventExpressionsIdentical(addInfo, remInfo) {
|
|
133
|
+
if (addInfo.literalValue !== undefined && remInfo.literalValue !== undefined) {
|
|
134
|
+
return addInfo.literalValue === remInfo.literalValue;
|
|
135
|
+
}
|
|
136
|
+
if (addInfo.rootSymbol && remInfo.rootSymbol && addInfo.rootSymbol === remInfo.rootSymbol) {
|
|
137
|
+
return true;
|
|
138
|
+
}
|
|
139
|
+
if (addInfo.symbol && remInfo.symbol && addInfo.symbol === remInfo.symbol) {
|
|
140
|
+
return true;
|
|
141
|
+
}
|
|
142
|
+
if (addInfo.rawText && remInfo.rawText && addInfo.rawText === remInfo.rawText) {
|
|
143
|
+
return true;
|
|
144
|
+
}
|
|
145
|
+
return false;
|
|
146
|
+
}
|
|
147
|
+
function resolveHandlerExpression(expr, chk, t) {
|
|
148
|
+
let current = expr;
|
|
149
|
+
while (t.isParenthesizedExpression(current)) {
|
|
150
|
+
current = current.expression;
|
|
151
|
+
}
|
|
152
|
+
if (t.isArrowFunction(current) || t.isFunctionExpression(current)) {
|
|
153
|
+
return { isInlineHandler: true };
|
|
154
|
+
}
|
|
155
|
+
if (t.isIdentifier(current)) {
|
|
156
|
+
const sym = chk ? chk.getSymbolAtLocation(current) : undefined;
|
|
157
|
+
return {
|
|
158
|
+
isInlineHandler: false,
|
|
159
|
+
handlerName: current.text,
|
|
160
|
+
symbol: sym,
|
|
161
|
+
};
|
|
162
|
+
}
|
|
163
|
+
return {
|
|
164
|
+
isInlineHandler: false,
|
|
165
|
+
handlerName: current.getText(),
|
|
166
|
+
symbol: chk ? chk.getSymbolAtLocation(current) : undefined,
|
|
167
|
+
};
|
|
168
|
+
}
|
|
169
|
+
function areHandlersIdentical(addHandler, remHandler) {
|
|
170
|
+
if (addHandler.isInlineHandler || remHandler.isInlineHandler) {
|
|
171
|
+
return false;
|
|
172
|
+
}
|
|
173
|
+
if (addHandler.symbol && remHandler.symbol && addHandler.symbol === remHandler.symbol) {
|
|
174
|
+
return true;
|
|
175
|
+
}
|
|
176
|
+
if (addHandler.handlerName && remHandler.handlerName && addHandler.handlerName === remHandler.handlerName) {
|
|
177
|
+
return true;
|
|
178
|
+
}
|
|
179
|
+
return false;
|
|
180
|
+
}
|
|
181
|
+
function resolveTargetExpression(expr, chk, t) {
|
|
182
|
+
let current = expr;
|
|
183
|
+
while (t.isParenthesizedExpression(current)) {
|
|
184
|
+
current = current.expression;
|
|
185
|
+
}
|
|
186
|
+
const text = current.getText();
|
|
187
|
+
const symbol = chk ? chk.getSymbolAtLocation(current) : undefined;
|
|
188
|
+
return { text, symbol };
|
|
189
|
+
}
|
|
190
|
+
function areTargetsIdentical(addTarget, remTarget) {
|
|
191
|
+
if (addTarget.symbol && remTarget.symbol && addTarget.symbol === remTarget.symbol) {
|
|
192
|
+
return true;
|
|
193
|
+
}
|
|
194
|
+
return addTarget.text === remTarget.text;
|
|
195
|
+
}
|
|
196
|
+
const addListeners = [];
|
|
197
|
+
const removeListeners = [];
|
|
198
|
+
const abortedControllerNames = new Set();
|
|
199
|
+
const abortedControllerSymbols = new Set();
|
|
200
|
+
let hasCleanupReturn = false;
|
|
201
|
+
function extractControllerNode(signalExpr, chk, t) {
|
|
202
|
+
if (t.isPropertyAccessExpression(signalExpr) && signalExpr.name.text === "signal") {
|
|
203
|
+
const target = signalExpr.expression;
|
|
204
|
+
if (isDOMAbortController(target, chk, t)) {
|
|
205
|
+
return target;
|
|
206
|
+
}
|
|
207
|
+
}
|
|
208
|
+
if (t.isIdentifier(signalExpr) && chk) {
|
|
209
|
+
const sym = chk.getSymbolAtLocation(signalExpr);
|
|
210
|
+
if (sym?.valueDeclaration && t.isVariableDeclaration(sym.valueDeclaration) && sym.valueDeclaration.initializer) {
|
|
211
|
+
return extractControllerNode(sym.valueDeclaration.initializer, chk, t);
|
|
212
|
+
}
|
|
213
|
+
}
|
|
214
|
+
return undefined;
|
|
215
|
+
}
|
|
216
|
+
function inspectEffectBody(n) {
|
|
217
|
+
// Look for target.addEventListener('event', handler, options)
|
|
218
|
+
if (ts && ts.isCallExpression(n) && ts.isPropertyAccessExpression(n.expression) && n.expression.name.text === "addEventListener") {
|
|
219
|
+
const target = n.expression.expression;
|
|
220
|
+
// Only audit authentic DOM EventTargets (window, document, HTMLElement, etc.)
|
|
221
|
+
if (!isDOMEventTarget(target, checker, ts)) {
|
|
222
|
+
return;
|
|
223
|
+
}
|
|
224
|
+
const args = n.arguments;
|
|
225
|
+
const eventTypeArg = args[0];
|
|
226
|
+
const handlerArg = args[1];
|
|
227
|
+
if (eventTypeArg && handlerArg) {
|
|
228
|
+
const targetInfo = resolveTargetExpression(target, checker, ts);
|
|
229
|
+
const eventInfo = resolveEventExpression(eventTypeArg, checker, ts);
|
|
230
|
+
const handlerInfo = resolveHandlerExpression(handlerArg, checker, ts);
|
|
231
|
+
let controllerName;
|
|
232
|
+
let controllerSymbol;
|
|
233
|
+
// Check options argument (3rd arg) for { signal: controller.signal } or { signal }
|
|
234
|
+
const optionsArg = args[2];
|
|
235
|
+
if (optionsArg && ts.isObjectLiteralExpression(optionsArg)) {
|
|
236
|
+
for (const prop of optionsArg.properties) {
|
|
237
|
+
if (ts.isPropertyAssignment(prop) && prop.name && "text" in prop.name && prop.name.text === "signal") {
|
|
238
|
+
const ctrlNode = extractControllerNode(prop.initializer, checker, ts);
|
|
239
|
+
if (ctrlNode && ts.isIdentifier(ctrlNode)) {
|
|
240
|
+
controllerName = ctrlNode.text;
|
|
241
|
+
if (checker) {
|
|
242
|
+
controllerSymbol = checker.getSymbolAtLocation(ctrlNode);
|
|
243
|
+
}
|
|
244
|
+
}
|
|
245
|
+
}
|
|
246
|
+
else if (ts.isShorthandPropertyAssignment(prop) && prop.name.text === "signal") {
|
|
247
|
+
if (checker) {
|
|
248
|
+
const valSym = checker.getShorthandAssignmentValueSymbol(prop) ?? checker.getSymbolAtLocation(prop.name);
|
|
249
|
+
if (valSym?.valueDeclaration && ts.isVariableDeclaration(valSym.valueDeclaration) && valSym.valueDeclaration.initializer) {
|
|
250
|
+
const ctrlNode = extractControllerNode(valSym.valueDeclaration.initializer, checker, ts);
|
|
251
|
+
if (ctrlNode && ts.isIdentifier(ctrlNode)) {
|
|
252
|
+
controllerName = ctrlNode.text;
|
|
253
|
+
controllerSymbol = checker.getSymbolAtLocation(ctrlNode);
|
|
254
|
+
}
|
|
255
|
+
}
|
|
256
|
+
}
|
|
257
|
+
}
|
|
258
|
+
}
|
|
259
|
+
}
|
|
260
|
+
addListeners.push({
|
|
261
|
+
node: n,
|
|
262
|
+
targetInfo,
|
|
263
|
+
eventInfo,
|
|
264
|
+
handlerInfo,
|
|
265
|
+
controllerName,
|
|
266
|
+
controllerSymbol,
|
|
267
|
+
});
|
|
268
|
+
}
|
|
269
|
+
}
|
|
270
|
+
// Look for return statement with cleanup function: return () => { ... }
|
|
271
|
+
if (ts && ts.isReturnStatement(n) && n.expression) {
|
|
272
|
+
const retExpr = n.expression;
|
|
273
|
+
if (ts.isArrowFunction(retExpr) || ts.isFunctionExpression(retExpr)) {
|
|
274
|
+
hasCleanupReturn = true;
|
|
275
|
+
inspectCleanupBody(retExpr);
|
|
276
|
+
}
|
|
277
|
+
}
|
|
278
|
+
// Don't recurse into nested function declarations (their returns aren't effect cleanups)
|
|
279
|
+
if (ts && n !== effectCallback && (ts.isFunctionDeclaration(n) || ts.isArrowFunction(n) || ts.isFunctionExpression(n))) {
|
|
280
|
+
return;
|
|
281
|
+
}
|
|
282
|
+
n.forEachChild(inspectEffectBody);
|
|
283
|
+
}
|
|
284
|
+
function inspectCleanupBody(cleanupFn) {
|
|
285
|
+
function walkCleanup(cn) {
|
|
286
|
+
// 1. removeEventListener calls
|
|
287
|
+
if (ts && ts.isCallExpression(cn) && ts.isPropertyAccessExpression(cn.expression) && cn.expression.name.text === "removeEventListener") {
|
|
288
|
+
const target = cn.expression.expression;
|
|
289
|
+
const args = cn.arguments;
|
|
290
|
+
const eventTypeArg = args[0];
|
|
291
|
+
const handlerArg = args[1];
|
|
292
|
+
if (eventTypeArg && handlerArg) {
|
|
293
|
+
const targetInfo = resolveTargetExpression(target, checker, ts);
|
|
294
|
+
const eventInfo = resolveEventExpression(eventTypeArg, checker, ts);
|
|
295
|
+
const handlerInfo = resolveHandlerExpression(handlerArg, checker, ts);
|
|
296
|
+
removeListeners.push({
|
|
297
|
+
targetInfo,
|
|
298
|
+
eventInfo,
|
|
299
|
+
handlerInfo,
|
|
300
|
+
});
|
|
301
|
+
}
|
|
302
|
+
}
|
|
303
|
+
// 2. controller.abort() calls
|
|
304
|
+
if (ts && ts.isCallExpression(cn) && ts.isPropertyAccessExpression(cn.expression) && cn.expression.name.text === "abort") {
|
|
305
|
+
const abortReceiver = cn.expression.expression;
|
|
306
|
+
if (isDOMAbortController(abortReceiver, checker, ts) && ts.isIdentifier(abortReceiver)) {
|
|
307
|
+
abortedControllerNames.add(abortReceiver.text);
|
|
308
|
+
if (checker) {
|
|
309
|
+
const sym = checker.getSymbolAtLocation(abortReceiver);
|
|
310
|
+
if (sym) {
|
|
311
|
+
abortedControllerSymbols.add(sym);
|
|
312
|
+
}
|
|
313
|
+
}
|
|
314
|
+
}
|
|
315
|
+
}
|
|
316
|
+
cn.forEachChild(walkCleanup);
|
|
317
|
+
}
|
|
318
|
+
cleanupFn.forEachChild(walkCleanup);
|
|
319
|
+
}
|
|
320
|
+
inspectEffectBody(effectCallback.body);
|
|
321
|
+
// Check each addListener against removeListeners and aborted controllers
|
|
322
|
+
for (const listener of addListeners) {
|
|
323
|
+
let isCleanedUp = false;
|
|
324
|
+
if (hasCleanupReturn) {
|
|
325
|
+
// 1. Check AbortController abort() cleanup
|
|
326
|
+
if (listener.controllerSymbol && abortedControllerSymbols.has(listener.controllerSymbol)) {
|
|
327
|
+
isCleanedUp = true;
|
|
328
|
+
}
|
|
329
|
+
else if (listener.controllerName && abortedControllerNames.has(listener.controllerName)) {
|
|
330
|
+
isCleanedUp = true;
|
|
331
|
+
}
|
|
332
|
+
// 2. Check removeEventListener cleanup
|
|
333
|
+
if (!isCleanedUp) {
|
|
334
|
+
for (const rem of removeListeners) {
|
|
335
|
+
if (areTargetsIdentical(listener.targetInfo, rem.targetInfo) &&
|
|
336
|
+
areEventExpressionsIdentical(listener.eventInfo, rem.eventInfo)) {
|
|
337
|
+
if (listener.handlerInfo.isInlineHandler || rem.handlerInfo.isInlineHandler) {
|
|
338
|
+
isCleanedUp = false;
|
|
339
|
+
}
|
|
340
|
+
else if (areHandlersIdentical(listener.handlerInfo, rem.handlerInfo)) {
|
|
341
|
+
isCleanedUp = true;
|
|
342
|
+
break;
|
|
343
|
+
}
|
|
344
|
+
}
|
|
345
|
+
}
|
|
346
|
+
}
|
|
347
|
+
}
|
|
348
|
+
if (!isCleanedUp) {
|
|
349
|
+
const range = getNodeSourceRange(listener.node, sourceFile);
|
|
350
|
+
const detailMsg = listener.handlerInfo.isInlineHandler && !listener.controllerName
|
|
351
|
+
? "Inline callback function in addEventListener cannot be removed because a new function reference is created."
|
|
352
|
+
: hasCleanupReturn
|
|
353
|
+
? `Neither matching removeEventListener nor controller.abort() was found in the cleanup function.`
|
|
354
|
+
: "No cleanup function was returned from the lifecycle hook.";
|
|
355
|
+
const eventDisplay = listener.eventInfo.literalValue ?? listener.eventInfo.rawText ?? "event";
|
|
356
|
+
context.report({
|
|
357
|
+
ruleId: "browser/event-listener-cleanup",
|
|
358
|
+
category: "browser",
|
|
359
|
+
severity: "error",
|
|
360
|
+
confidence: "high",
|
|
361
|
+
message: `addEventListener for '${eventDisplay}' in lifecycle hook is missing matching cleanup.`,
|
|
362
|
+
file: sourceFile.fileName,
|
|
363
|
+
range,
|
|
364
|
+
evidence: [
|
|
365
|
+
{
|
|
366
|
+
message: detailMsg,
|
|
367
|
+
range,
|
|
368
|
+
},
|
|
369
|
+
],
|
|
370
|
+
suggestedAction: "Remove the event listener in cleanup (removeEventListener) or abort the associated AbortController (controller.abort()).",
|
|
371
|
+
safeAutomaticFix: false,
|
|
372
|
+
});
|
|
373
|
+
}
|
|
374
|
+
}
|
|
375
|
+
});
|
|
376
|
+
},
|
|
377
|
+
};
|
|
378
|
+
//# sourceMappingURL=eventListenerCleanup.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"eventListenerCleanup.js","sourceRoot":"","sources":["../../../src/rules/browser/eventListenerCleanup.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAGvH,MAAM,CAAC,MAAM,wBAAwB,GAAS;IAC5C,IAAI,EAAE;QACJ,EAAE,EAAE,gCAAgC;QACpC,QAAQ,EAAE,SAAS;QACnB,eAAe,EAAE,OAAO;QACxB,iBAAiB,EAAE,MAAM;QACzB,WAAW,EAAE,sGAAsG;QACnH,uBAAuB,EAAE,KAAK;KAC/B;IAED,OAAO,CAAC,OAAoB;QAC1B,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC;QAC5C,IAAI,CAAC,EAAE;YAAE,OAAO;QAEhB,OAAO,CAAC,UAAU,CAAC,CAAC,IAAiB,EAAE,EAAE;YACvC,0CAA0C;YAC1C,IAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC;gBAAE,OAAO;YAEvC,IAAI,eAAe,GAAG,KAAK,CAAC;YAC5B,IAAI,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,CAAC,IAAI,gBAAgB,CAAC,IAAI,EAAE,OAAO,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC;gBACpH,eAAe,GAAG,IAAI,CAAC;YACzB,CAAC;iBAAM,IAAI,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,KAAK,WAAW,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,KAAK,iBAAiB,CAAC,EAAE,CAAC;gBACpI,eAAe,GAAG,IAAI,CAAC;YACzB,CAAC;YAED,IAAI,CAAC,eAAe;gBAAE,OAAO;YAE7B,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACzC,IAAI,CAAC,cAAc,IAAI,CAAC,CAAC,EAAE,CAAC,eAAe,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC;gBACzG,OAAO;YACT,CAAC;YAoBD,SAAS,sBAAsB,CAC7B,IAAuB,EACvB,GAAmC,EACnC,CAAgB;gBAEhB,IAAI,OAAO,GAAsB,IAAI,CAAC;gBACtC,OAAO,CAAC,CAAC,yBAAyB,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC5C,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC;gBAC/B,CAAC;gBAED,IAAI,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,+BAA+B,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC7E,OAAO;wBACL,OAAO,EAAE,OAAO,CAAC,IAAI;wBACrB,YAAY,EAAE,OAAO,CAAC,IAAI;qBAC3B,CAAC;gBACJ,CAAC;gBAED,IAAI,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC5B,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;oBAC7B,IAAI,CAAC,GAAG,EAAE,CAAC;wBACT,OAAO,EAAE,OAAO,EAAE,CAAC;oBACrB,CAAC;oBAED,MAAM,GAAG,GAAG,GAAG,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;oBAC7C,IAAI,OAAO,GAAG,GAAG,CAAC;oBAClB,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;wBAC3D,IAAI,CAAC;4BACH,OAAO,GAAG,GAAG,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;wBAC1C,CAAC;wBAAC,MAAM,CAAC;4BACP,SAAS;wBACX,CAAC;oBACH,CAAC;oBAED,IAAI,YAAgC,CAAC;oBACrC,IAAI,SAAS,GAAG,GAAG,CAAC;oBACpB,MAAM,WAAW,GAAG,IAAI,GAAG,EAAiB,CAAC;oBAC7C,OAAO,SAAS,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;wBAChD,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;wBAC3B,MAAM,IAAI,GAAG,SAAS,CAAC,gBAAgB,IAAI,SAAS,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,CAAC;wBACvE,IAAI,IAAI,IAAI,CAAC,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;4BAC9D,IAAI,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC;4BAC5B,OAAO,CAAC,CAAC,yBAAyB,CAAC,IAAI,CAAC,EAAE,CAAC;gCACzC,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC;4BACzB,CAAC;4BACD,IAAI,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,+BAA+B,CAAC,IAAI,CAAC,EAAE,CAAC;gCACvE,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC;gCACzB,MAAM;4BACR,CAAC;iCAAM,IAAI,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;gCAChC,MAAM,OAAO,GAAG,GAAG,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;gCAC9C,IAAI,OAAO,EAAE,CAAC;oCACZ,SAAS,GAAG,OAAO,CAAC;oCACpB,IAAI,CAAC,OAAO;wCAAE,OAAO,GAAG,OAAO,CAAC;oCAChC,SAAS;gCACX,CAAC;4BACH,CAAC;wBACH,CAAC;wBACD,MAAM;oBACR,CAAC;oBAED,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;wBAC/B,IAAI,CAAC;4BACH,MAAM,IAAI,GAAG,GAAG,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;4BAC5C,IAAI,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC;gCAC3B,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC;4BAC5B,CAAC;wBACH,CAAC;wBAAC,MAAM,CAAC;4BACP,SAAS;wBACX,CAAC;oBACH,CAAC;oBAED,OAAO;wBACL,OAAO;wBACP,YAAY;wBACZ,MAAM,EAAE,GAAG;wBACX,UAAU,EAAE,OAAO;qBACpB,CAAC;gBACJ,CAAC;gBAED,IAAI,CAAC,CAAC,0BAA0B,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC1C,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;oBAClC,IAAI,YAAgC,CAAC;oBACrC,IAAI,GAA8B,CAAC;oBACnC,IAAI,OAAkC,CAAC;oBAEvC,IAAI,GAAG,EAAE,CAAC;wBACR,GAAG,GAAG,GAAG,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;wBACvC,OAAO,GAAG,GAAG,CAAC;wBACd,IAAI,CAAC;4BACH,MAAM,IAAI,GAAG,GAAG,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;4BAC5C,IAAI,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC;gCAC3B,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC;4BAC5B,CAAC;wBACH,CAAC;wBAAC,MAAM,CAAC;4BACP,SAAS;wBACX,CAAC;oBACH,CAAC;oBAED,OAAO;wBACL,OAAO;wBACP,YAAY;wBACZ,MAAM,EAAE,GAAG;wBACX,UAAU,EAAE,OAAO;qBACpB,CAAC;gBACJ,CAAC;gBAED,OAAO;oBACL,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE;iBAC3B,CAAC;YACJ,CAAC;YAED,SAAS,4BAA4B,CACnC,OAA4B,EAC5B,OAA4B;gBAE5B,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;oBAC7E,OAAO,OAAO,CAAC,YAAY,KAAK,OAAO,CAAC,YAAY,CAAC;gBACvD,CAAC;gBACD,IAAI,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,UAAU,KAAK,OAAO,CAAC,UAAU,EAAE,CAAC;oBAC1F,OAAO,IAAI,CAAC;gBACd,CAAC;gBACD,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC;oBAC1E,OAAO,IAAI,CAAC;gBACd,CAAC;gBACD,IAAI,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC;oBAC9E,OAAO,IAAI,CAAC;gBACd,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;YAED,SAAS,wBAAwB,CAC/B,IAAuB,EACvB,GAAmC,EACnC,CAAgB;gBAEhB,IAAI,OAAO,GAAsB,IAAI,CAAC;gBACtC,OAAO,CAAC,CAAC,yBAAyB,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC5C,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC;gBAC/B,CAAC;gBAED,IAAI,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAAC,OAAO,CAAC,EAAE,CAAC;oBAClE,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC;gBACnC,CAAC;gBAED,IAAI,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC5B,MAAM,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/D,OAAO;wBACL,eAAe,EAAE,KAAK;wBACtB,WAAW,EAAE,OAAO,CAAC,IAAI;wBACzB,MAAM,EAAE,GAAG;qBACZ,CAAC;gBACJ,CAAC;gBAED,OAAO;oBACL,eAAe,EAAE,KAAK;oBACtB,WAAW,EAAE,OAAO,CAAC,OAAO,EAAE;oBAC9B,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;iBAC3D,CAAC;YACJ,CAAC;YAED,SAAS,oBAAoB,CAC3B,UAAiC,EACjC,UAAiC;gBAEjC,IAAI,UAAU,CAAC,eAAe,IAAI,UAAU,CAAC,eAAe,EAAE,CAAC;oBAC7D,OAAO,KAAK,CAAC;gBACf,CAAC;gBACD,IAAI,UAAU,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,KAAK,UAAU,CAAC,MAAM,EAAE,CAAC;oBACtF,OAAO,IAAI,CAAC;gBACd,CAAC;gBACD,IAAI,UAAU,CAAC,WAAW,IAAI,UAAU,CAAC,WAAW,IAAI,UAAU,CAAC,WAAW,KAAK,UAAU,CAAC,WAAW,EAAE,CAAC;oBAC1G,OAAO,IAAI,CAAC;gBACd,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;YAED,SAAS,uBAAuB,CAC9B,IAAuB,EACvB,GAAmC,EACnC,CAAgB;gBAEhB,IAAI,OAAO,GAAsB,IAAI,CAAC;gBACtC,OAAO,CAAC,CAAC,yBAAyB,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC5C,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC;gBAC/B,CAAC;gBACD,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;gBAC/B,MAAM,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;gBAClE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;YAC1B,CAAC;YAED,SAAS,mBAAmB,CAC1B,SAA+B,EAC/B,SAA+B;gBAE/B,IAAI,SAAS,CAAC,MAAM,IAAI,SAAS,CAAC,MAAM,IAAI,SAAS,CAAC,MAAM,KAAK,SAAS,CAAC,MAAM,EAAE,CAAC;oBAClF,OAAO,IAAI,CAAC;gBACd,CAAC;gBACD,OAAO,SAAS,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC;YAC3C,CAAC;YAYD,MAAM,YAAY,GAAsB,EAAE,CAAC;YAS3C,MAAM,eAAe,GAAyB,EAAE,CAAC;YACjD,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAU,CAAC;YACjD,MAAM,wBAAwB,GAAG,IAAI,GAAG,EAAiB,CAAC;YAC1D,IAAI,gBAAgB,GAAG,KAAK,CAAC;YAE7B,SAAS,qBAAqB,CAC5B,UAA6B,EAC7B,GAAmC,EACnC,CAAgB;gBAEhB,IAAI,CAAC,CAAC,0BAA0B,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAClF,MAAM,MAAM,GAAG,UAAU,CAAC,UAAU,CAAC;oBACrC,IAAI,oBAAoB,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;wBACzC,OAAO,MAAM,CAAC;oBAChB,CAAC;gBACH,CAAC;gBAED,IAAI,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,GAAG,EAAE,CAAC;oBACtC,MAAM,GAAG,GAAG,GAAG,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;oBAChD,IAAI,GAAG,EAAE,gBAAgB,IAAI,CAAC,CAAC,qBAAqB,CAAC,GAAG,CAAC,gBAAgB,CAAC,IAAI,GAAG,CAAC,gBAAgB,CAAC,WAAW,EAAE,CAAC;wBAC/G,OAAO,qBAAqB,CAAC,GAAG,CAAC,gBAAgB,CAAC,WAAW,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;oBACzE,CAAC;gBACH,CAAC;gBAED,OAAO,SAAS,CAAC;YACnB,CAAC;YAED,SAAS,iBAAiB,CAAC,CAAc;gBACvC,8DAA8D;gBAC9D,IAAI,EAAE,IAAI,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,0BAA0B,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,KAAK,kBAAkB,EAAE,CAAC;oBACjI,MAAM,MAAM,GAAG,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC;oBACvC,8EAA8E;oBAC9E,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,EAAE,CAAC;wBAC3C,OAAO;oBACT,CAAC;oBAED,MAAM,IAAI,GAAG,CAAC,CAAC,SAAS,CAAC;oBACzB,MAAM,YAAY,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;oBAC7B,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;oBAC3B,IAAI,YAAY,IAAI,UAAU,EAAE,CAAC;wBAC/B,MAAM,UAAU,GAAG,uBAAuB,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;wBAChE,MAAM,SAAS,GAAG,sBAAsB,CAAC,YAAY,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;wBACpE,MAAM,WAAW,GAAG,wBAAwB,CAAC,UAAU,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;wBAEtE,IAAI,cAAkC,CAAC;wBACvC,IAAI,gBAA2C,CAAC;wBAEhD,mFAAmF;wBACnF,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;wBAC3B,IAAI,UAAU,IAAI,EAAE,CAAC,yBAAyB,CAAC,UAAU,CAAC,EAAE,CAAC;4BAC3D,KAAK,MAAM,IAAI,IAAI,UAAU,CAAC,UAAU,EAAE,CAAC;gCACzC,IAAI,EAAE,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,IAAI,MAAM,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oCACrG,MAAM,QAAQ,GAAG,qBAAqB,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;oCACtE,IAAI,QAAQ,IAAI,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC;wCAC1C,cAAc,GAAG,QAAQ,CAAC,IAAI,CAAC;wCAC/B,IAAI,OAAO,EAAE,CAAC;4CACZ,gBAAgB,GAAG,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;wCAC3D,CAAC;oCACH,CAAC;gCACH,CAAC;qCAAM,IAAI,EAAE,CAAC,6BAA6B,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oCACjF,IAAI,OAAO,EAAE,CAAC;wCACZ,MAAM,MAAM,GAAG,OAAO,CAAC,iCAAiC,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;wCACzG,IAAI,MAAM,EAAE,gBAAgB,IAAI,EAAE,CAAC,qBAAqB,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,MAAM,CAAC,gBAAgB,CAAC,WAAW,EAAE,CAAC;4CACzH,MAAM,QAAQ,GAAG,qBAAqB,CAAC,MAAM,CAAC,gBAAgB,CAAC,WAAW,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;4CACzF,IAAI,QAAQ,IAAI,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC;gDAC1C,cAAc,GAAG,QAAQ,CAAC,IAAI,CAAC;gDAC/B,gBAAgB,GAAG,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;4CAC3D,CAAC;wCACH,CAAC;oCACH,CAAC;gCACH,CAAC;4BACH,CAAC;wBACH,CAAC;wBAED,YAAY,CAAC,IAAI,CAAC;4BAChB,IAAI,EAAE,CAAC;4BACP,UAAU;4BACV,SAAS;4BACT,WAAW;4BACX,cAAc;4BACd,gBAAgB;yBACjB,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;gBAED,wEAAwE;gBACxE,IAAI,EAAE,IAAI,EAAE,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,CAAC;oBAClD,MAAM,OAAO,GAAG,CAAC,CAAC,UAAU,CAAC;oBAC7B,IAAI,EAAE,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,oBAAoB,CAAC,OAAO,CAAC,EAAE,CAAC;wBACpE,gBAAgB,GAAG,IAAI,CAAC;wBACxB,kBAAkB,CAAC,OAAO,CAAC,CAAC;oBAC9B,CAAC;gBACH,CAAC;gBAED,yFAAyF;gBACzF,IAAI,EAAE,IAAI,CAAC,KAAK,cAAc,IAAI,CAAC,EAAE,CAAC,qBAAqB,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBACvH,OAAO;gBACT,CAAC;gBAED,CAAC,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC;YACpC,CAAC;YAED,SAAS,kBAAkB,CAAC,SAAsB;gBAChD,SAAS,WAAW,CAAC,EAAe;oBAClC,+BAA+B;oBAC/B,IAAI,EAAE,IAAI,EAAE,CAAC,gBAAgB,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,0BAA0B,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,KAAK,qBAAqB,EAAE,CAAC;wBACvI,MAAM,MAAM,GAAG,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC;wBACxC,MAAM,IAAI,GAAG,EAAE,CAAC,SAAS,CAAC;wBAC1B,MAAM,YAAY,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;wBAC7B,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;wBAC3B,IAAI,YAAY,IAAI,UAAU,EAAE,CAAC;4BAC/B,MAAM,UAAU,GAAG,uBAAuB,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;4BAChE,MAAM,SAAS,GAAG,sBAAsB,CAAC,YAAY,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;4BACpE,MAAM,WAAW,GAAG,wBAAwB,CAAC,UAAU,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;4BAEtE,eAAe,CAAC,IAAI,CAAC;gCACnB,UAAU;gCACV,SAAS;gCACT,WAAW;6BACZ,CAAC,CAAC;wBACL,CAAC;oBACH,CAAC;oBAED,8BAA8B;oBAC9B,IAAI,EAAE,IAAI,EAAE,CAAC,gBAAgB,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,0BAA0B,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;wBACzH,MAAM,aAAa,GAAG,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC;wBAC/C,IAAI,oBAAoB,CAAC,aAAa,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC,YAAY,CAAC,aAAa,CAAC,EAAE,CAAC;4BACvF,sBAAsB,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;4BAC/C,IAAI,OAAO,EAAE,CAAC;gCACZ,MAAM,GAAG,GAAG,OAAO,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;gCACvD,IAAI,GAAG,EAAE,CAAC;oCACR,wBAAwB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gCACpC,CAAC;4BACH,CAAC;wBACH,CAAC;oBACH,CAAC;oBAED,EAAE,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;gBAC/B,CAAC;gBACD,SAAS,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;YACtC,CAAC;YAED,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;YAEvC,yEAAyE;YACzE,KAAK,MAAM,QAAQ,IAAI,YAAY,EAAE,CAAC;gBACpC,IAAI,WAAW,GAAG,KAAK,CAAC;gBAExB,IAAI,gBAAgB,EAAE,CAAC;oBACrB,2CAA2C;oBAC3C,IAAI,QAAQ,CAAC,gBAAgB,IAAI,wBAAwB,CAAC,GAAG,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;wBACzF,WAAW,GAAG,IAAI,CAAC;oBACrB,CAAC;yBAAM,IAAI,QAAQ,CAAC,cAAc,IAAI,sBAAsB,CAAC,GAAG,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;wBAC1F,WAAW,GAAG,IAAI,CAAC;oBACrB,CAAC;oBAED,uCAAuC;oBACvC,IAAI,CAAC,WAAW,EAAE,CAAC;wBACjB,KAAK,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;4BAClC,IACE,mBAAmB,CAAC,QAAQ,CAAC,UAAU,EAAE,GAAG,CAAC,UAAU,CAAC;gCACxD,4BAA4B,CAAC,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC,SAAS,CAAC,EAC/D,CAAC;gCACD,IAAI,QAAQ,CAAC,WAAW,CAAC,eAAe,IAAI,GAAG,CAAC,WAAW,CAAC,eAAe,EAAE,CAAC;oCAC5E,WAAW,GAAG,KAAK,CAAC;gCACtB,CAAC;qCAAM,IAAI,oBAAoB,CAAC,QAAQ,CAAC,WAAW,EAAE,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;oCACvE,WAAW,GAAG,IAAI,CAAC;oCACnB,MAAM;gCACR,CAAC;4BACH,CAAC;wBACH,CAAC;oBACH,CAAC;gBACH,CAAC;gBAED,IAAI,CAAC,WAAW,EAAE,CAAC;oBACjB,MAAM,KAAK,GAAG,kBAAkB,CAAC,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;oBAC5D,MAAM,SAAS,GAAG,QAAQ,CAAC,WAAW,CAAC,eAAe,IAAI,CAAC,QAAQ,CAAC,cAAc;wBAChF,CAAC,CAAC,6GAA6G;wBAC/G,CAAC,CAAC,gBAAgB;4BAClB,CAAC,CAAC,gGAAgG;4BAClG,CAAC,CAAC,2DAA2D,CAAC;oBAEhE,MAAM,YAAY,GAAG,QAAQ,CAAC,SAAS,CAAC,YAAY,IAAI,QAAQ,CAAC,SAAS,CAAC,OAAO,IAAI,OAAO,CAAC;oBAE9F,OAAO,CAAC,MAAM,CAAC;wBACb,MAAM,EAAE,gCAAgC;wBACxC,QAAQ,EAAE,SAAS;wBACnB,QAAQ,EAAE,OAAO;wBACjB,UAAU,EAAE,MAAM;wBAClB,OAAO,EAAE,yBAAyB,YAAY,kDAAkD;wBAChG,IAAI,EAAE,UAAU,CAAC,QAAQ;wBACzB,KAAK;wBACL,QAAQ,EAAE;4BACR;gCACE,OAAO,EAAE,SAAS;gCAClB,KAAK;6BACN;yBACF;wBACD,eAAe,EACb,0HAA0H;wBAC5H,gBAAgB,EAAE,KAAK;qBACxB,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"observerCleanup.d.ts","sourceRoot":"","sources":["../../../src/rules/browser/observerCleanup.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAe,MAAM,qBAAqB,CAAC;AA6B7D,eAAO,MAAM,mBAAmB,EAAE,IAsLjC,CAAC"}
|
|
@@ -0,0 +1,184 @@
|
|
|
1
|
+
import { getNodeSourceRange, resolveReactHook, isDOMGlobal } from "../../engine/symbols.js";
|
|
2
|
+
const DOM_OBSERVER_NAMES = new Set(["ResizeObserver", "IntersectionObserver", "MutationObserver"]);
|
|
3
|
+
function isDOMObserverClass(node, checker, ts) {
|
|
4
|
+
if (ts.isIdentifier(node)) {
|
|
5
|
+
const name = node.text;
|
|
6
|
+
if (DOM_OBSERVER_NAMES.has(name)) {
|
|
7
|
+
if (checker) {
|
|
8
|
+
return isDOMGlobal(node, checker, name) ? name : null;
|
|
9
|
+
}
|
|
10
|
+
return name;
|
|
11
|
+
}
|
|
12
|
+
}
|
|
13
|
+
if (ts.isPropertyAccessExpression(node) &&
|
|
14
|
+
ts.isIdentifier(node.expression) &&
|
|
15
|
+
(node.expression.text === "window" || node.expression.text === "globalThis")) {
|
|
16
|
+
const name = node.name.text;
|
|
17
|
+
if (DOM_OBSERVER_NAMES.has(name)) {
|
|
18
|
+
return name;
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
return null;
|
|
22
|
+
}
|
|
23
|
+
export const observerCleanupRule = {
|
|
24
|
+
meta: {
|
|
25
|
+
id: "browser/observer-cleanup",
|
|
26
|
+
category: "browser",
|
|
27
|
+
defaultSeverity: "error",
|
|
28
|
+
defaultConfidence: "high",
|
|
29
|
+
description: "Detects DOM Observers instantiated in lifecycle hooks without .disconnect() cleanup.",
|
|
30
|
+
requiresTypeInformation: false,
|
|
31
|
+
},
|
|
32
|
+
analyze(context) {
|
|
33
|
+
const { sourceFile, checker, ts } = context;
|
|
34
|
+
if (!ts)
|
|
35
|
+
return;
|
|
36
|
+
context.visitNodes((node) => {
|
|
37
|
+
if (!ts.isCallExpression(node))
|
|
38
|
+
return;
|
|
39
|
+
let isLifecycleHook = false;
|
|
40
|
+
if (checker && (resolveReactHook(node, checker, "useEffect") || resolveReactHook(node, checker, "useLayoutEffect"))) {
|
|
41
|
+
isLifecycleHook = true;
|
|
42
|
+
}
|
|
43
|
+
else if (ts.isIdentifier(node.expression) && (node.expression.text === "useEffect" || node.expression.text === "useLayoutEffect")) {
|
|
44
|
+
isLifecycleHook = true;
|
|
45
|
+
}
|
|
46
|
+
if (!isLifecycleHook)
|
|
47
|
+
return;
|
|
48
|
+
const effectCallback = node.arguments[0];
|
|
49
|
+
if (!effectCallback || (!ts.isArrowFunction(effectCallback) && !ts.isFunctionExpression(effectCallback))) {
|
|
50
|
+
return;
|
|
51
|
+
}
|
|
52
|
+
const observers = [];
|
|
53
|
+
const disconnectedSymbols = new Set();
|
|
54
|
+
const disconnectedNames = new Set();
|
|
55
|
+
let hasCleanupReturn = false;
|
|
56
|
+
function inspectEffectBody(n) {
|
|
57
|
+
if (ts && ts.isNewExpression(n)) {
|
|
58
|
+
const className = isDOMObserverClass(n.expression, checker, ts);
|
|
59
|
+
if (className) {
|
|
60
|
+
let varName;
|
|
61
|
+
let symbol;
|
|
62
|
+
const parent = n.parent;
|
|
63
|
+
if (parent && ts.isVariableDeclaration(parent) && ts.isIdentifier(parent.name)) {
|
|
64
|
+
varName = parent.name.text;
|
|
65
|
+
if (checker) {
|
|
66
|
+
symbol = checker.getSymbolAtLocation(parent.name);
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
else if (parent &&
|
|
70
|
+
ts.isBinaryExpression(parent) &&
|
|
71
|
+
parent.operatorToken.kind === ts.SyntaxKind.EqualsToken &&
|
|
72
|
+
ts.isIdentifier(parent.left)) {
|
|
73
|
+
varName = parent.left.text;
|
|
74
|
+
if (checker) {
|
|
75
|
+
symbol = checker.getSymbolAtLocation(parent.left);
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
observers.push({
|
|
79
|
+
node: n,
|
|
80
|
+
observerName: className,
|
|
81
|
+
varName,
|
|
82
|
+
symbol,
|
|
83
|
+
});
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
// Check for cleanup return
|
|
87
|
+
if (ts && ts.isReturnStatement(n) && n.expression) {
|
|
88
|
+
const retExpr = n.expression;
|
|
89
|
+
if (ts.isArrowFunction(retExpr) || ts.isFunctionExpression(retExpr)) {
|
|
90
|
+
hasCleanupReturn = true;
|
|
91
|
+
inspectCleanupBody(retExpr);
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
if (ts && n !== effectCallback && (ts.isFunctionDeclaration(n) || ts.isArrowFunction(n) || ts.isFunctionExpression(n))) {
|
|
95
|
+
return;
|
|
96
|
+
}
|
|
97
|
+
n.forEachChild(inspectEffectBody);
|
|
98
|
+
}
|
|
99
|
+
function inspectCleanupBody(cleanupFn) {
|
|
100
|
+
function walkCleanup(cn) {
|
|
101
|
+
if (ts &&
|
|
102
|
+
ts.isCallExpression(cn) &&
|
|
103
|
+
ts.isPropertyAccessExpression(cn.expression) &&
|
|
104
|
+
cn.expression.name.text === "disconnect") {
|
|
105
|
+
const receiver = cn.expression.expression;
|
|
106
|
+
if (ts.isIdentifier(receiver)) {
|
|
107
|
+
disconnectedNames.add(receiver.text);
|
|
108
|
+
if (checker) {
|
|
109
|
+
const sym = checker.getSymbolAtLocation(receiver);
|
|
110
|
+
if (sym) {
|
|
111
|
+
disconnectedSymbols.add(sym);
|
|
112
|
+
// Resolve local variable aliases (e.g. const cleanupRef = ro)
|
|
113
|
+
let currentDecl = sym.valueDeclaration;
|
|
114
|
+
while (currentDecl &&
|
|
115
|
+
ts.isVariableDeclaration(currentDecl) &&
|
|
116
|
+
currentDecl.initializer &&
|
|
117
|
+
ts.isIdentifier(currentDecl.initializer)) {
|
|
118
|
+
disconnectedNames.add(currentDecl.initializer.text);
|
|
119
|
+
const originSym = checker.getSymbolAtLocation(currentDecl.initializer);
|
|
120
|
+
if (originSym) {
|
|
121
|
+
disconnectedSymbols.add(originSym);
|
|
122
|
+
currentDecl = originSym.valueDeclaration;
|
|
123
|
+
}
|
|
124
|
+
else {
|
|
125
|
+
break;
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
try {
|
|
129
|
+
const aliased = checker.getAliasedSymbol(sym);
|
|
130
|
+
if (aliased)
|
|
131
|
+
disconnectedSymbols.add(aliased);
|
|
132
|
+
}
|
|
133
|
+
catch {
|
|
134
|
+
// Not an aliased symbol
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
cn.forEachChild(walkCleanup);
|
|
141
|
+
}
|
|
142
|
+
cleanupFn.forEachChild(walkCleanup);
|
|
143
|
+
}
|
|
144
|
+
inspectEffectBody(effectCallback.body);
|
|
145
|
+
for (const obs of observers) {
|
|
146
|
+
let isDisconnected = false;
|
|
147
|
+
if (hasCleanupReturn) {
|
|
148
|
+
if (obs.symbol && disconnectedSymbols.has(obs.symbol)) {
|
|
149
|
+
isDisconnected = true;
|
|
150
|
+
}
|
|
151
|
+
else if (obs.varName && disconnectedNames.has(obs.varName)) {
|
|
152
|
+
isDisconnected = true;
|
|
153
|
+
}
|
|
154
|
+
}
|
|
155
|
+
if (!isDisconnected) {
|
|
156
|
+
const range = getNodeSourceRange(obs.node, sourceFile);
|
|
157
|
+
const detailMsg = !obs.varName
|
|
158
|
+
? `Anonymous ${obs.observerName} instance cannot be disconnected in cleanup.`
|
|
159
|
+
: hasCleanupReturn
|
|
160
|
+
? `${obs.observerName} instance '${obs.varName}' is missing matching '${obs.varName}.disconnect()' in cleanup return.`
|
|
161
|
+
: "No cleanup function was returned from the lifecycle hook.";
|
|
162
|
+
context.report({
|
|
163
|
+
ruleId: "browser/observer-cleanup",
|
|
164
|
+
category: "browser",
|
|
165
|
+
severity: "error",
|
|
166
|
+
confidence: "high",
|
|
167
|
+
message: `${obs.observerName} instantiated in lifecycle hook without calling .disconnect() in cleanup.`,
|
|
168
|
+
file: sourceFile.fileName,
|
|
169
|
+
range,
|
|
170
|
+
evidence: [
|
|
171
|
+
{
|
|
172
|
+
message: detailMsg,
|
|
173
|
+
range,
|
|
174
|
+
},
|
|
175
|
+
],
|
|
176
|
+
suggestedAction: `Disconnect the observer in the returned cleanup function: return () => ${obs.varName ?? "observer"}.disconnect();`,
|
|
177
|
+
safeAutomaticFix: false,
|
|
178
|
+
});
|
|
179
|
+
}
|
|
180
|
+
}
|
|
181
|
+
});
|
|
182
|
+
},
|
|
183
|
+
};
|
|
184
|
+
//# sourceMappingURL=observerCleanup.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"observerCleanup.js","sourceRoot":"","sources":["../../../src/rules/browser/observerCleanup.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAG5F,MAAM,kBAAkB,GAAG,IAAI,GAAG,CAAC,CAAC,gBAAgB,EAAE,sBAAsB,EAAE,kBAAkB,CAAC,CAAC,CAAC;AAEnG,SAAS,kBAAkB,CAAC,IAAiB,EAAE,OAAuC,EAAE,EAAiB;IACvG,IAAI,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACvB,IAAI,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACjC,IAAI,OAAO,EAAE,CAAC;gBACZ,OAAO,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;YACxD,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,IACE,EAAE,CAAC,0BAA0B,CAAC,IAAI,CAAC;QACnC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC;QAChC,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,KAAK,YAAY,CAAC,EAC5E,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;QAC5B,IAAI,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACjC,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,CAAC,MAAM,mBAAmB,GAAS;IACvC,IAAI,EAAE;QACJ,EAAE,EAAE,0BAA0B;QAC9B,QAAQ,EAAE,SAAS;QACnB,eAAe,EAAE,OAAO;QACxB,iBAAiB,EAAE,MAAM;QACzB,WAAW,EAAE,sFAAsF;QACnG,uBAAuB,EAAE,KAAK;KAC/B;IAED,OAAO,CAAC,OAAoB;QAC1B,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC;QAC5C,IAAI,CAAC,EAAE;YAAE,OAAO;QAEhB,OAAO,CAAC,UAAU,CAAC,CAAC,IAAiB,EAAE,EAAE;YACvC,IAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC;gBAAE,OAAO;YAEvC,IAAI,eAAe,GAAG,KAAK,CAAC;YAC5B,IAAI,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,CAAC,IAAI,gBAAgB,CAAC,IAAI,EAAE,OAAO,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC;gBACpH,eAAe,GAAG,IAAI,CAAC;YACzB,CAAC;iBAAM,IAAI,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,KAAK,WAAW,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,KAAK,iBAAiB,CAAC,EAAE,CAAC;gBACpI,eAAe,GAAG,IAAI,CAAC;YACzB,CAAC;YAED,IAAI,CAAC,eAAe;gBAAE,OAAO;YAE7B,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACzC,IAAI,CAAC,cAAc,IAAI,CAAC,CAAC,EAAE,CAAC,eAAe,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC;gBACzG,OAAO;YACT,CAAC;YASD,MAAM,SAAS,GAAuB,EAAE,CAAC;YACzC,MAAM,mBAAmB,GAAG,IAAI,GAAG,EAAiB,CAAC;YACrD,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAAU,CAAC;YAC5C,IAAI,gBAAgB,GAAG,KAAK,CAAC;YAE7B,SAAS,iBAAiB,CAAC,CAAc;gBACvC,IAAI,EAAE,IAAI,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC;oBAChC,MAAM,SAAS,GAAG,kBAAkB,CAAC,CAAC,CAAC,UAAU,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;oBAChE,IAAI,SAAS,EAAE,CAAC;wBACd,IAAI,OAA2B,CAAC;wBAChC,IAAI,MAAiC,CAAC;wBAEtC,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;wBACxB,IAAI,MAAM,IAAI,EAAE,CAAC,qBAAqB,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;4BAC/E,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;4BAC3B,IAAI,OAAO,EAAE,CAAC;gCACZ,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;4BACpD,CAAC;wBACH,CAAC;6BAAM,IACL,MAAM;4BACN,EAAE,CAAC,kBAAkB,CAAC,MAAM,CAAC;4BAC7B,MAAM,CAAC,aAAa,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,WAAW;4BACvD,EAAE,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,EAC5B,CAAC;4BACD,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;4BAC3B,IAAI,OAAO,EAAE,CAAC;gCACZ,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;4BACpD,CAAC;wBACH,CAAC;wBAED,SAAS,CAAC,IAAI,CAAC;4BACb,IAAI,EAAE,CAAC;4BACP,YAAY,EAAE,SAAS;4BACvB,OAAO;4BACP,MAAM;yBACP,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;gBAED,2BAA2B;gBAC3B,IAAI,EAAE,IAAI,EAAE,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,CAAC;oBAClD,MAAM,OAAO,GAAG,CAAC,CAAC,UAAU,CAAC;oBAC7B,IAAI,EAAE,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,oBAAoB,CAAC,OAAO,CAAC,EAAE,CAAC;wBACpE,gBAAgB,GAAG,IAAI,CAAC;wBACxB,kBAAkB,CAAC,OAAO,CAAC,CAAC;oBAC9B,CAAC;gBACH,CAAC;gBAED,IAAI,EAAE,IAAI,CAAC,KAAK,cAAc,IAAI,CAAC,EAAE,CAAC,qBAAqB,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBACvH,OAAO;gBACT,CAAC;gBAED,CAAC,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC;YACpC,CAAC;YAED,SAAS,kBAAkB,CAAC,SAAsB;gBAChD,SAAS,WAAW,CAAC,EAAe;oBAClC,IACE,EAAE;wBACF,EAAE,CAAC,gBAAgB,CAAC,EAAE,CAAC;wBACvB,EAAE,CAAC,0BAA0B,CAAC,EAAE,CAAC,UAAU,CAAC;wBAC5C,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,KAAK,YAAY,EACxC,CAAC;wBACD,MAAM,QAAQ,GAAG,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC;wBAC1C,IAAI,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC;4BAC9B,iBAAiB,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;4BACrC,IAAI,OAAO,EAAE,CAAC;gCACZ,MAAM,GAAG,GAAG,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;gCAClD,IAAI,GAAG,EAAE,CAAC;oCACR,mBAAmB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;oCAC7B,8DAA8D;oCAC9D,IAAI,WAAW,GAAmC,GAAG,CAAC,gBAAgB,CAAC;oCACvE,OACE,WAAW;wCACX,EAAE,CAAC,qBAAqB,CAAC,WAAW,CAAC;wCACrC,WAAW,CAAC,WAAW;wCACvB,EAAE,CAAC,YAAY,CAAC,WAAW,CAAC,WAAW,CAAC,EACxC,CAAC;wCACD,iBAAiB,CAAC,GAAG,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;wCACpD,MAAM,SAAS,GAAG,OAAO,CAAC,mBAAmB,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;wCACvE,IAAI,SAAS,EAAE,CAAC;4CACd,mBAAmB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;4CACnC,WAAW,GAAG,SAAS,CAAC,gBAAgB,CAAC;wCAC3C,CAAC;6CAAM,CAAC;4CACN,MAAM;wCACR,CAAC;oCACH,CAAC;oCACD,IAAI,CAAC;wCACH,MAAM,OAAO,GAAG,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;wCAC9C,IAAI,OAAO;4CAAE,mBAAmB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;oCAChD,CAAC;oCAAC,MAAM,CAAC;wCACP,wBAAwB;oCAC1B,CAAC;gCACH,CAAC;4BACH,CAAC;wBACH,CAAC;oBACH,CAAC;oBACD,EAAE,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;gBAC/B,CAAC;gBACD,SAAS,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;YACtC,CAAC;YAED,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;YAEvC,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;gBAC5B,IAAI,cAAc,GAAG,KAAK,CAAC;gBAE3B,IAAI,gBAAgB,EAAE,CAAC;oBACrB,IAAI,GAAG,CAAC,MAAM,IAAI,mBAAmB,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;wBACtD,cAAc,GAAG,IAAI,CAAC;oBACxB,CAAC;yBAAM,IAAI,GAAG,CAAC,OAAO,IAAI,iBAAiB,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;wBAC7D,cAAc,GAAG,IAAI,CAAC;oBACxB,CAAC;gBACH,CAAC;gBAED,IAAI,CAAC,cAAc,EAAE,CAAC;oBACpB,MAAM,KAAK,GAAG,kBAAkB,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;oBACvD,MAAM,SAAS,GAAG,CAAC,GAAG,CAAC,OAAO;wBAC5B,CAAC,CAAC,aAAa,GAAG,CAAC,YAAY,8CAA8C;wBAC7E,CAAC,CAAC,gBAAgB;4BAClB,CAAC,CAAC,GAAG,GAAG,CAAC,YAAY,cAAc,GAAG,CAAC,OAAO,0BAA0B,GAAG,CAAC,OAAO,mCAAmC;4BACtH,CAAC,CAAC,2DAA2D,CAAC;oBAEhE,OAAO,CAAC,MAAM,CAAC;wBACb,MAAM,EAAE,0BAA0B;wBAClC,QAAQ,EAAE,SAAS;wBACnB,QAAQ,EAAE,OAAO;wBACjB,UAAU,EAAE,MAAM;wBAClB,OAAO,EAAE,GAAG,GAAG,CAAC,YAAY,2EAA2E;wBACvG,IAAI,EAAE,UAAU,CAAC,QAAQ;wBACzB,KAAK;wBACL,QAAQ,EAAE;4BACR;gCACE,OAAO,EAAE,SAAS;gCAClB,KAAK;6BACN;yBACF;wBACD,eAAe,EAAE,0EAA0E,GAAG,CAAC,OAAO,IAAI,UAAU,gBAAgB;wBACpI,gBAAgB,EAAE,KAAK;qBACxB,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"timerCleanup.d.ts","sourceRoot":"","sources":["../../../src/rules/browser/timerCleanup.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAe,MAAM,qBAAqB,CAAC;AAE7D,eAAO,MAAM,gBAAgB,EAAE,IAgI9B,CAAC"}
|