-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
ModuleImportResolver.java
127 lines (116 loc) · 4.85 KB
/
ModuleImportResolver.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
/*
* Copyright 2019 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 static com.google.common.base.Preconditions.checkArgument;
import com.google.common.collect.ImmutableSet;
import com.google.javascript.jscomp.modules.Module;
import com.google.javascript.jscomp.modules.ModuleMap;
import com.google.javascript.rhino.Node;
import javax.annotation.Nullable;
/**
* Resolves module requires into {@link TypedVar}s.
*
* <p>Currently this only supports goog.modules, but can be extended for ES modules.
*/
final class ModuleImportResolver {
private final ModuleMap moduleMap;
private static final String GOOG = "goog";
private static final ImmutableSet<String> googDependencyCalls =
ImmutableSet.of("require", "requireType", "forwardDeclare");
ModuleImportResolver(ModuleMap moduleMap) {
this.moduleMap = moduleMap;
}
/** Returns whether this is a CALL node for goog.require(Type) or goog.forwardDeclare */
static boolean isGoogModuleDependencyCall(Node value) {
if (value == null || !value.isCall()) {
return false;
}
Node callee = value.getFirstChild();
if (!callee.isGetProp()) {
return false;
}
Node owner = callee.getFirstChild();
Node property = callee.getSecondChild();
return owner.isName()
&& owner.getString().equals(GOOG)
&& googDependencyCalls.contains(property.getString());
}
/**
* Attempts to look up the type of a Closure namespace from a require call
*
* <p>This returns null if the given {@link ModuleMap} is null, if the required module does not
* exist, or if support is missing for the type of required {@link Module}. Currently only
* requires of other goog.modules are supported.
*
* @param googRequire a CALL node representing some kind of Closure require.
*/
ScopedName getClosureNamespaceTypeFromCall(Node googRequire) {
if (moduleMap == null) {
// TODO(b/124919359): make sure all tests have generated a ModuleMap
return null;
}
String moduleId = googRequire.getSecondChild().getString();
Module module = moduleMap.getClosureModule(moduleId);
if (module == null) {
return null;
}
switch (module.metadata().moduleType()) {
case GOOG_PROVIDE:
// Expect this to be a global variable
Node provide = module.metadata().rootNode();
if (provide != null && provide.isScript()) {
return ScopedName.of(moduleId, provide.getGrandparent());
} else {
// Unknown module requires default to 'goog provides', but we don't want to type them.
return null;
}
case GOOG_MODULE:
case LEGACY_GOOG_MODULE:
// TODO(b/124919359): Fix getGoogModuleScopeRoot to never return null.
Node scopeRoot = getGoogModuleScopeRoot(module);
return scopeRoot != null ? ScopedName.of("exports", scopeRoot) : null;
case ES6_MODULE:
throw new IllegalStateException("Type checking ES modules not yet supported");
case COMMON_JS:
throw new IllegalStateException("Type checking CommonJs modules not yet supported");
case SCRIPT:
throw new IllegalStateException("Cannot import a name from a SCRIPT");
}
throw new AssertionError();
}
/** Returns the corresponding scope root Node from a goog.module. */
@Nullable
private Node getGoogModuleScopeRoot(@Nullable Module module) {
checkArgument(module.metadata().isGoogModule(), module.metadata());
Node scriptNode = module.metadata().rootNode();
if (scriptNode.isScript()
&& scriptNode.hasOneChild()
&& scriptNode.getOnlyChild().isModuleBody()) {
// The module root node should be a SCRIPT, whose first child is a MODULE_BODY.
// The map is keyed off a MODULE_BODY node for a goog.module,
// which is the only child of our SCRIPT node.
return scriptNode.getOnlyChild();
} else if (scriptNode.isCall()) {
// This is a goog.loadModule call, and the scope is keyed off the FUNCTION node's BLOCK in:
// goog.loadModule(function(exports)
Node functionLiteral = scriptNode.getSecondChild();
return NodeUtil.getFunctionBody(functionLiteral);
}
// TODO(b/124919359): this case should not happen, but is triggering on goog.require calls in
// rewritten modules with preserveClosurePrimitives enabled.
return null;
}
}