1 | "use strict";
|
2 | var __extends = (this && this.__extends) || (function () {
|
3 | var extendStatics = function (d, b) {
|
4 | extendStatics = Object.setPrototypeOf ||
|
5 | ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
6 | function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
|
7 | return extendStatics(d, b);
|
8 | }
|
9 | return function (d, b) {
|
10 | extendStatics(d, b);
|
11 | function __() { this.constructor = d; }
|
12 | d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
13 | };
|
14 | })();
|
15 | Object.defineProperty(exports, "__esModule", { value: true });
|
16 | var ts = require("typescript");
|
17 | var Lint = require("tslint");
|
18 | var AstUtils_1 = require("./utils/AstUtils");
|
19 | var Utils_1 = require("./utils/Utils");
|
20 | var Rule = (function (_super) {
|
21 | __extends(Rule, _super);
|
22 | function Rule() {
|
23 | return _super !== null && _super.apply(this, arguments) || this;
|
24 | }
|
25 | Rule.prototype.apply = function (sourceFile) {
|
26 | return this.applyWithWalker(new JQueryDeferredAnalyzer(sourceFile, this.getOptions()));
|
27 | };
|
28 | Rule.metadata = {
|
29 | ruleName: 'jquery-deferred-must-complete',
|
30 | type: 'maintainability',
|
31 | description: 'When a JQuery Deferred instance is created, then either reject() or resolve() must be called on it within all code branches in the scope.',
|
32 | options: null,
|
33 | optionsDescription: '',
|
34 | typescriptOnly: true,
|
35 | issueClass: 'Non-SDL',
|
36 | issueType: 'Error',
|
37 | severity: 'Critical',
|
38 | level: 'Opportunity for Excellence',
|
39 | group: 'Correctness'
|
40 | };
|
41 | Rule.FAILURE_STRING = 'A JQuery deferred was found that appears to not have resolve or reject invoked on all code paths: ';
|
42 | return Rule;
|
43 | }(Lint.Rules.AbstractRule));
|
44 | exports.Rule = Rule;
|
45 | function isPromiseInstantiation(expression) {
|
46 | if (expression !== undefined && expression.kind === ts.SyntaxKind.CallExpression) {
|
47 | var functionName = AstUtils_1.AstUtils.getFunctionName(expression);
|
48 | var functionTarget = AstUtils_1.AstUtils.getFunctionTarget(expression);
|
49 | if (functionName === 'Deferred' && functionTarget !== undefined && AstUtils_1.AstUtils.isJQuery(functionTarget)) {
|
50 | return true;
|
51 | }
|
52 | }
|
53 | return false;
|
54 | }
|
55 | function isCompletionFunction(functionName) {
|
56 | return /^(resolve|reject)$/.test(functionName);
|
57 | }
|
58 | var JQueryDeferredAnalyzer = (function (_super) {
|
59 | __extends(JQueryDeferredAnalyzer, _super);
|
60 | function JQueryDeferredAnalyzer() {
|
61 | return _super !== null && _super.apply(this, arguments) || this;
|
62 | }
|
63 | JQueryDeferredAnalyzer.prototype.visitBinaryExpression = function (node) {
|
64 | if (node.operatorToken.getText() === '=' && isPromiseInstantiation(node.right)) {
|
65 | if (node.left.kind === ts.SyntaxKind.Identifier) {
|
66 | if (node.left.text !== undefined) {
|
67 | var name_1 = node.left;
|
68 | this.validateDeferredUsage(node, name_1);
|
69 | }
|
70 | }
|
71 | }
|
72 | _super.prototype.visitBinaryExpression.call(this, node);
|
73 | };
|
74 | JQueryDeferredAnalyzer.prototype.visitVariableDeclaration = function (node) {
|
75 | if (node.initializer !== undefined && isPromiseInstantiation(node.initializer)) {
|
76 | if (node.name.text !== undefined) {
|
77 | var name_2 = node.name;
|
78 | this.validateDeferredUsage(node, name_2);
|
79 | }
|
80 | }
|
81 | _super.prototype.visitVariableDeclaration.call(this, node);
|
82 | };
|
83 | JQueryDeferredAnalyzer.prototype.validateDeferredUsage = function (rootNode, deferredIdentifier) {
|
84 | var parent = AstUtils_1.AstUtils.findParentBlock(rootNode);
|
85 | var blockAnalyzer = new DeferredCompletionWalker(this.getSourceFile(), this.getOptions(), deferredIdentifier);
|
86 | blockAnalyzer.visitNode(parent);
|
87 | if (!blockAnalyzer.isAlwaysCompleted()) {
|
88 | var failureString = Rule.FAILURE_STRING + "'" + rootNode.getText() + "'";
|
89 | this.addFailureAt(rootNode.getStart(), rootNode.getWidth(), failureString);
|
90 | }
|
91 | };
|
92 | return JQueryDeferredAnalyzer;
|
93 | }(Lint.RuleWalker));
|
94 | var DeferredCompletionWalker = (function (_super) {
|
95 | __extends(DeferredCompletionWalker, _super);
|
96 | function DeferredCompletionWalker(sourceFile, options, deferredIdentifier) {
|
97 | var _this = _super.call(this, sourceFile, options) || this;
|
98 | _this.wasCompleted = false;
|
99 | _this.allBranchesCompleted = true;
|
100 | _this.hasBranches = false;
|
101 | _this.walkerOptions = options;
|
102 | _this.deferredIdentifier = deferredIdentifier;
|
103 | return _this;
|
104 | }
|
105 | DeferredCompletionWalker.prototype.visitNode = function (node) {
|
106 | _super.prototype.visitNode.call(this, node);
|
107 | };
|
108 | DeferredCompletionWalker.prototype.isAlwaysCompleted = function () {
|
109 | if (this.wasCompleted) {
|
110 | return true;
|
111 | }
|
112 | if (!this.hasBranches) {
|
113 | return false;
|
114 | }
|
115 | return this.allBranchesCompleted;
|
116 | };
|
117 | DeferredCompletionWalker.prototype.visitIfStatement = function (node) {
|
118 | this.hasBranches = true;
|
119 | var ifAnalyzer = new DeferredCompletionWalker(this.getSourceFile(), this.walkerOptions, this.deferredIdentifier);
|
120 | var elseAnalyzer = new DeferredCompletionWalker(this.getSourceFile(), this.walkerOptions, this.deferredIdentifier);
|
121 | ifAnalyzer.visitNode(node.thenStatement);
|
122 | if (!ifAnalyzer.isAlwaysCompleted()) {
|
123 | this.allBranchesCompleted = false;
|
124 | }
|
125 | else if (node.elseStatement !== undefined) {
|
126 | elseAnalyzer.visitNode(node.elseStatement);
|
127 | if (!elseAnalyzer.isAlwaysCompleted()) {
|
128 | this.allBranchesCompleted = false;
|
129 | }
|
130 | }
|
131 | };
|
132 | DeferredCompletionWalker.prototype.visitCallExpression = function (node) {
|
133 | var _this = this;
|
134 | if (node.expression.kind === ts.SyntaxKind.PropertyAccessExpression) {
|
135 | var prop = node.expression;
|
136 | if (AstUtils_1.AstUtils.isSameIdentifer(this.deferredIdentifier, prop.expression)) {
|
137 | var functionName = prop.name.getText();
|
138 | if (isCompletionFunction(functionName)) {
|
139 | this.wasCompleted = true;
|
140 | return;
|
141 | }
|
142 | }
|
143 | }
|
144 | var referenceEscaped = Utils_1.Utils.exists(node.arguments, function (argument) {
|
145 | return AstUtils_1.AstUtils.isSameIdentifer(_this.deferredIdentifier, argument);
|
146 | });
|
147 | if (referenceEscaped) {
|
148 | this.wasCompleted = true;
|
149 | return;
|
150 | }
|
151 | _super.prototype.visitCallExpression.call(this, node);
|
152 | };
|
153 | DeferredCompletionWalker.prototype.visitArrowFunction = function (node) {
|
154 | var _this = this;
|
155 | var isDeferredShadowed = Utils_1.Utils.exists(node.parameters, function (param) {
|
156 | return AstUtils_1.AstUtils.isSameIdentifer(_this.deferredIdentifier, param.name);
|
157 | });
|
158 | if (isDeferredShadowed) {
|
159 | this.hasBranches = true;
|
160 | this.allBranchesCompleted = false;
|
161 | return;
|
162 | }
|
163 | _super.prototype.visitArrowFunction.call(this, node);
|
164 | };
|
165 | DeferredCompletionWalker.prototype.visitFunctionExpression = function (node) {
|
166 | var _this = this;
|
167 | var isDeferredShadowed = Utils_1.Utils.exists(node.parameters, function (param) {
|
168 | return AstUtils_1.AstUtils.isSameIdentifer(_this.deferredIdentifier, param.name);
|
169 | });
|
170 | if (isDeferredShadowed) {
|
171 | this.hasBranches = true;
|
172 | this.allBranchesCompleted = false;
|
173 | return;
|
174 | }
|
175 | _super.prototype.visitFunctionExpression.call(this, node);
|
176 | };
|
177 | return DeferredCompletionWalker;
|
178 | }(Lint.RuleWalker));
|
179 |
|
\ | No newline at end of file |