-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
ConvertToTypedInterface.java
458 lines (423 loc) · 15.7 KB
/
ConvertToTypedInterface.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
/*
* Copyright 2016 The Closure Compiler Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.javascript.jscomp;
import com.google.common.base.Preconditions;
import com.google.javascript.jscomp.NodeTraversal.AbstractShallowStatementCallback;
import com.google.javascript.jscomp.NodeTraversal.Callback;
import com.google.javascript.rhino.IR;
import com.google.javascript.rhino.JSDocInfo;
import com.google.javascript.rhino.JSDocInfoBuilder;
import com.google.javascript.rhino.JSTypeExpression;
import com.google.javascript.rhino.Node;
import com.google.javascript.rhino.Token;
import com.google.javascript.rhino.jstype.JSType;
import java.util.HashSet;
import java.util.Set;
/**
* The goal of this pass is to shrink the AST, preserving only typing, not behavior.
*
* <p>To do this, it does things like removing function/method bodies, rvalues that are not needed,
* expressions that are not declarations, etc.
*
* <p>This is conceptually similar to the ijar tool[1] that bazel uses to shrink jars into minimal
* versions that can be used equivalently for compilation of downstream dependencies.
* [1] https://github.com/bazelbuild/bazel/blob/master/third_party/ijar/README.txt
*
* @author blickly@google.com (Ben Lickly)
*/
class ConvertToTypedInterface implements CompilerPass {
static final DiagnosticType CONSTANT_WITHOUT_EXPLICIT_TYPE =
DiagnosticType.error(
"JSC_CONSTANT_WITHOUT_EXPLICIT_TYPE",
"/** @const */-annotated values in library API should have types explicitly specified.");
private final AbstractCompiler compiler;
ConvertToTypedInterface(AbstractCompiler compiler) {
this.compiler = compiler;
}
@Override
public void process(Node externs, Node root) {
NodeTraversal.traverseEs6(compiler, root, new PropagateConstJsdoc(compiler));
NodeTraversal.traverseRootsEs6(compiler, new RemoveCode(compiler), externs, root);
}
private static class PropagateConstJsdoc extends NodeTraversal.AbstractPostOrderCallback {
private final AbstractCompiler compiler;
PropagateConstJsdoc(AbstractCompiler compiler) {
this.compiler = compiler;
}
@Override
public void visit(NodeTraversal t, Node n, Node parent) {
switch (n.getType()) {
case EXPR_RESULT:
if (NodeUtil.isExprAssign(n)) {
Node expr = n.getFirstChild();
processName(t, expr.getFirstChild());
}
break;
case VAR:
case CONST:
case LET:
if (n.getChildCount() == 1) {
processName(t, n.getFirstChild());
}
break;
default:
break;
}
}
private void processName(NodeTraversal t, Node nameNode) {
Node jsdocNode = NodeUtil.getBestJSDocInfoNode(nameNode);
JSDocInfo jsdoc = jsdocNode.getJSDocInfo();
if (!isInferrableConst(jsdoc, nameNode)) {
return;
}
Node rhs = NodeUtil.getRValueOfLValue(nameNode);
if (rhs == null) {
return;
}
JSDocInfo newJsdoc = getJSDocForRhs(t, rhs, jsdoc);
if (newJsdoc != null) {
jsdocNode.setJSDocInfo(newJsdoc);
compiler.reportCodeChange();
}
}
private static JSDocInfo getJSDocForRhs(NodeTraversal t, Node rhs, JSDocInfo oldJSDoc) {
switch (NodeUtil.getKnownValueType(rhs)) {
case BOOLEAN:
return getTypeJSDoc(oldJSDoc, "boolean");
case NUMBER:
return getTypeJSDoc(oldJSDoc, "number");
case STRING:
return getTypeJSDoc(oldJSDoc, "string");
case NULL:
return getTypeJSDoc(oldJSDoc, "null");
case VOID:
return getTypeJSDoc(oldJSDoc, "void");
case OBJECT:
break;
case UNDETERMINED:
if (rhs.isName()) {
Var decl = t.getScope().getVar(rhs.getString());
return getJSDocForName(decl, oldJSDoc);
}
break;
}
return null;
}
private static JSDocInfo getJSDocForName(Var decl, JSDocInfo oldJSDoc) {
if (decl == null) {
return null;
}
JSTypeExpression expr = NodeUtil.getDeclaredTypeExpression(decl.getNameNode());
if (expr == null) {
return null;
}
return getTypeJSDoc(oldJSDoc, expr);
}
}
private static class RemoveCode implements Callback {
private final AbstractCompiler compiler;
private final Set<String> seenNames = new HashSet<>();
RemoveCode(AbstractCompiler compiler) {
this.compiler = compiler;
}
@Override
public boolean shouldTraverse(NodeTraversal t, Node n, Node parent) {
switch (n.getType()) {
case FUNCTION: {
if (parent.isCall()) {
Preconditions.checkState(!parent.getFirstChild().matchesQualifiedName("goog.scope"),
parent);
}
Node body = n.getLastChild();
if (body.isBlock() && body.hasChildren()) {
if (isConstructor(n)) {
processConstructor(n);
}
n.getLastChild().removeChildren();
compiler.reportCodeChange();
}
break;
}
case EXPR_RESULT:
Node expr = n.getFirstChild();
switch (expr.getType()) {
case NUMBER:
case STRING:
n.detachFromParent();
compiler.reportCodeChange();
break;
case CALL:
Node callee = expr.getFirstChild();
Preconditions.checkState(!callee.matchesQualifiedName("goog.scope"), n);
Preconditions.checkState(!callee.matchesQualifiedName("goog.forwardDeclare"), n);
if (callee.matchesQualifiedName("goog.provide")) {
Node childBefore;
while (null != (childBefore = n.getPrevious())
&& childBefore.getBooleanProp(Node.IS_NAMESPACE)) {
parent.removeChild(childBefore);
compiler.reportCodeChange();
}
} else if (!callee.matchesQualifiedName("goog.require")) {
n.detachFromParent();
compiler.reportCodeChange();
}
break;
case ASSIGN:
processName(expr.getFirstChild(), n);
break;
case GETPROP:
processName(expr, n);
break;
default:
if (expr.getJSDocInfo() == null) {
n.detachFromParent();
compiler.reportCodeChange();
}
break;
}
break;
case VAR:
case CONST:
case LET:
if (n.getChildCount() == 1) {
processName(n.getFirstChild(), n);
}
break;
case THROW:
case RETURN:
case BREAK:
case CONTINUE:
case DEBUGGER:
n.detachFromParent();
compiler.reportCodeChange();
break;
case FOR_OF:
case DO:
case WHILE:
case FOR: {
Node body = NodeUtil.getLoopCodeBlock(n);
parent.replaceChild(n, body.detachFromParent());
Node initializer = n.isFor() ? n.getFirstChild() : IR.empty();
if (NodeUtil.isNameDeclaration(initializer)) {
parent.addChildBefore(initializer.detachFromParent(), body);
processName(initializer.getFirstChild(), initializer);
}
compiler.reportCodeChange();
break;
}
case LABEL:
parent.replaceChild(n, n.getSecondChild().detachFromParent());
compiler.reportCodeChange();
break;
default:
break;
}
return true;
}
@Override
public void visit(NodeTraversal t, Node n, Node parent) {
switch (n.getType()) {
case TRY:
case DEFAULT_CASE:
parent.replaceChild(n, n.getFirstChild().detachFromParent());
compiler.reportCodeChange();
break;
case IF:
case SWITCH:
case CASE:
parent.addChildrenAfter(n.removeChildren().getNext(), n);
n.detachFromParent();
compiler.reportCodeChange();
break;
default:
break;
}
}
private void processConstructor(final Node function) {
final String className = getClassName(function);
if (className == null) {
return;
}
final Node insertionPoint = NodeUtil.getEnclosingStatement(function);
NodeTraversal.traverseEs6(
compiler, function.getLastChild(), new AbstractShallowStatementCallback() {
@Override
public void visit(NodeTraversal t, Node n, Node parent) {
if (n.isExprResult()) {
Node expr = n.getFirstChild();
Node name = expr.isAssign() ? expr.getFirstChild() : expr;
if (!name.isGetProp() || !name.getFirstChild().isThis()) {
return;
}
JSType type = name.getJSType();
String pname = name.getLastChild().getString();
JSDocInfo jsdoc = NodeUtil.getBestJSDocInfo(name);
// Don't use an initializer unless we need it for the non-typechecked case.
Node initializer = null;
if (type == null) {
initializer = NodeUtil.getRValueOfLValue(name).detachFromParent();
} else if (isInferrableConst(jsdoc, name)) {
jsdoc = maybeUpdateJSDocInfoWithType(jsdoc, name);
}
Node newProtoAssignStmt = NodeUtil.newQNameDeclaration(
compiler, className + ".prototype." + pname, initializer, jsdoc);
newProtoAssignStmt.useSourceInfoIfMissingFromForTree(expr);
// TODO(blickly): Preserve the declaration order of the this properties.
insertionPoint.getParent().addChildAfter(newProtoAssignStmt, insertionPoint);
compiler.reportCodeChange();
}
}
});
}
enum RemovalType {
PRESERVE_ALL,
REMOVE_RHS,
REMOVE_ALL,
}
private RemovalType shouldRemove(Node nameNode) {
Node jsdocNode = NodeUtil.getBestJSDocInfoNode(nameNode);
JSDocInfo jsdoc = jsdocNode.getJSDocInfo();
if (jsdoc != null && jsdoc.isConstructorOrInterface()) {
return RemovalType.PRESERVE_ALL;
}
Node rhs = NodeUtil.getRValueOfLValue(nameNode);
// System.err.println("RHS of " + nameNode + " is " + rhs);
if (rhs == null
|| rhs.isFunction()
|| rhs.isQualifiedName() && rhs.matchesQualifiedName("goog.abstractMethod")
|| rhs.isQualifiedName() && rhs.matchesQualifiedName("goog.nullFunction")
// || rhs.isQualifiedName() && NodeUtil.isPrototypeProperty(rhs)
|| rhs.isObjectLit() && !rhs.hasChildren()
&& (jsdoc == null || jsdoc.getTypeNodes().isEmpty())
) {
return RemovalType.PRESERVE_ALL;
}
if (jsdoc == null
|| !jsdoc.containsDeclaration()) {
if (seenNames.contains(nameNode.getQualifiedName())) {
return RemovalType.REMOVE_ALL;
}
jsdocNode.setJSDocInfo(getAllTypeJSDoc());
return RemovalType.REMOVE_RHS;
}
if (isInferrableConst(jsdoc, nameNode)) {
if (nameNode.getJSType() == null) {
compiler.report(JSError.make(nameNode, CONSTANT_WITHOUT_EXPLICIT_TYPE));
return RemovalType.PRESERVE_ALL;
}
jsdocNode.setJSDocInfo(maybeUpdateJSDocInfoWithType(jsdoc, nameNode));
}
return RemovalType.REMOVE_RHS;
}
private void processName(Node nameNode, Node statement) {
Preconditions.checkState(NodeUtil.isStatement(statement), statement);
if (!nameNode.isQualifiedName()) {
// We don't track these. We can just remove them.
removeNode(statement);
return;
}
Node jsdocNode = NodeUtil.getBestJSDocInfoNode(nameNode);
switch (shouldRemove(nameNode)) {
case REMOVE_ALL:
removeNode(statement);
break;
case PRESERVE_ALL:
break;
case REMOVE_RHS:
maybeRemoveRhs(nameNode, statement, jsdocNode.getJSDocInfo());
break;
}
seenNames.add(nameNode.getQualifiedName());
}
private void removeNode(Node n) {
if (NodeUtil.isStatement(n)) {
n.detachFromParent();
} else {
n.getParent().replaceChild(n, IR.empty().srcref(n));
}
compiler.reportCodeChange();
}
private void maybeRemoveRhs(Node nameNode, Node statement, JSDocInfo jsdoc) {
if (jsdoc != null && jsdoc.hasEnumParameterType()) {
removeEnumValues(NodeUtil.getRValueOfLValue(nameNode));
return;
}
Node newStatement =
NodeUtil.newQNameDeclaration(compiler, nameNode.getQualifiedName(), null, jsdoc);
newStatement.useSourceInfoIfMissingFromForTree(nameNode);
statement.getParent().replaceChild(statement, newStatement);
compiler.reportCodeChange();
}
private void removeEnumValues(Node objLit) {
if (objLit.isObjectLit() && objLit.hasChildren()) {
for (Node key : objLit.children()) {
Node value = key.getFirstChild();
Node replacementValue = IR.number(0).srcrefTree(value);
key.replaceChild(value, replacementValue);
}
compiler.reportCodeChange();
}
}
}
private static boolean isInferrableConst(JSDocInfo jsdoc, Node nameNode) {
return jsdoc != null
&& jsdoc.hasConstAnnotation()
&& !jsdoc.hasType()
&& !jsdoc.isConstructorOrInterface()
&& !NodeUtil.isNamespaceDecl(nameNode);
}
private static boolean isClassMemberFunction(Node functionNode) {
Preconditions.checkArgument(functionNode.isFunction());
return functionNode.getParent().isMemberFunctionDef()
&& functionNode.getGrandparent().isClassMembers();
}
private static String getClassName(Node functionNode) {
if (isClassMemberFunction(functionNode)) {
Node classNode = functionNode.getGrandparent().getParent();
Preconditions.checkState(classNode.isClass());
return NodeUtil.getName(classNode);
}
return NodeUtil.getName(functionNode);
}
private static boolean isConstructor(Node functionNode) {
if (isClassMemberFunction(functionNode)) {
return "constructor".equals(functionNode.getParent().getString());
}
JSDocInfo jsdoc = NodeUtil.getBestJSDocInfo(functionNode);
return jsdoc != null && jsdoc.isConstructor();
}
private static JSDocInfo getAllTypeJSDoc() {
JSDocInfoBuilder builder = new JSDocInfoBuilder(false);
builder.recordType(new JSTypeExpression(new Node(Token.STAR), ""));
return builder.build();
}
private static JSDocInfo maybeUpdateJSDocInfoWithType(JSDocInfo oldJSDoc, Node nameNode) {
Preconditions.checkArgument(nameNode.isQualifiedName());
JSType type = nameNode.getJSType();
if (type == null) {
return oldJSDoc;
}
return getTypeJSDoc(oldJSDoc, type.toNonNullAnnotationString());
}
private static JSDocInfo getTypeJSDoc(JSDocInfo oldJSDoc, JSTypeExpression newType) {
JSDocInfoBuilder builder = JSDocInfoBuilder.copyFrom(oldJSDoc);
builder.recordType(newType);
return builder.build();
}
private static JSDocInfo getTypeJSDoc(JSDocInfo oldJSDoc, String contents) {
return getTypeJSDoc(oldJSDoc, new JSTypeExpression(Node.newString(contents), ""));
}
}