Unreviewed, rolling out r210537.
[WebKit-https.git] / Source / JavaScriptCore / runtime / ModuleLoaderPrototype.cpp
1 /*
2  * Copyright (C) 2015-2016 Apple Inc. All Rights Reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "ModuleLoaderPrototype.h"
28
29 #include "BuiltinNames.h"
30 #include "CodeProfiling.h"
31 #include "Error.h"
32 #include "Exception.h"
33 #include "JSCInlines.h"
34 #include "JSGlobalObjectFunctions.h"
35 #include "JSInternalPromise.h"
36 #include "JSInternalPromiseDeferred.h"
37 #include "JSMap.h"
38 #include "JSModuleEnvironment.h"
39 #include "JSModuleLoader.h"
40 #include "JSModuleNamespaceObject.h"
41 #include "JSModuleRecord.h"
42 #include "ModuleAnalyzer.h"
43 #include "Nodes.h"
44 #include "Parser.h"
45 #include "ParserError.h"
46
47 namespace JSC {
48
49 static EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeParseModule(ExecState*);
50 static EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeRequestedModules(ExecState*);
51 static EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeEvaluate(ExecState*);
52 static EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeModuleDeclarationInstantiation(ExecState*);
53 static EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeResolve(ExecState*);
54 static EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeFetch(ExecState*);
55 static EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeInstantiate(ExecState*);
56 static EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeGetModuleNamespaceObject(ExecState*);
57
58 }
59
60 #include "ModuleLoaderPrototype.lut.h"
61
62 namespace JSC {
63
64 STATIC_ASSERT_IS_TRIVIALLY_DESTRUCTIBLE(ModuleLoaderPrototype);
65
66 const ClassInfo ModuleLoaderPrototype::s_info = { "ModuleLoader", &Base::s_info, &moduleLoaderPrototypeTable, CREATE_METHOD_TABLE(ModuleLoaderPrototype) };
67
68 /* Source for ModuleLoaderPrototype.lut.h
69 @begin moduleLoaderPrototypeTable
70     ensureRegistered               JSBuiltin                                           DontEnum|Function 1
71     forceFulfillPromise            JSBuiltin                                           DontEnum|Function 2
72     fulfillFetch                   JSBuiltin                                           DontEnum|Function 2
73     fulfillInstantiate             JSBuiltin                                           DontEnum|Function 2
74     commitInstantiated             JSBuiltin                                           DontEnum|Function 3
75     instantiation                  JSBuiltin                                           DontEnum|Function 3
76     requestFetch                   JSBuiltin                                           DontEnum|Function 2
77     requestInstantiate             JSBuiltin                                           DontEnum|Function 2
78     requestSatisfy                 JSBuiltin                                           DontEnum|Function 2
79     requestInstantiateAll          JSBuiltin                                           DontEnum|Function 2
80     requestLink                    JSBuiltin                                           DontEnum|Function 2
81     requestReady                   JSBuiltin                                           DontEnum|Function 2
82     link                           JSBuiltin                                           DontEnum|Function 2
83     moduleDeclarationInstantiation moduleLoaderPrototypeModuleDeclarationInstantiation DontEnum|Function 2
84     moduleEvaluation               JSBuiltin                                           DontEnum|Function 2
85     evaluate                       moduleLoaderPrototypeEvaluate                       DontEnum|Function 3
86     provide                        JSBuiltin                                           DontEnum|Function 3
87     loadAndEvaluateModule          JSBuiltin                                           DontEnum|Function 3
88     loadModule                     JSBuiltin                                           DontEnum|Function 3
89     linkAndEvaluateModule          JSBuiltin                                           DontEnum|Function 2
90     importModule                   JSBuiltin                                           DontEnum|Function 3
91     getModuleNamespaceObject       moduleLoaderPrototypeGetModuleNamespaceObject       DontEnum|Function 1
92     parseModule                    moduleLoaderPrototypeParseModule                    DontEnum|Function 2
93     requestedModules               moduleLoaderPrototypeRequestedModules               DontEnum|Function 1
94     resolve                        moduleLoaderPrototypeResolve                        DontEnum|Function 2
95     fetch                          moduleLoaderPrototypeFetch                          DontEnum|Function 2
96     instantiate                    moduleLoaderPrototypeInstantiate                    DontEnum|Function 3
97 @end
98 */
99
100 ModuleLoaderPrototype::ModuleLoaderPrototype(VM& vm, Structure* structure)
101     : JSNonFinalObject(vm, structure)
102 {
103 }
104
105 // ------------------------------ Functions --------------------------------
106
107 EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeParseModule(ExecState* exec)
108 {
109     VM& vm = exec->vm();
110     auto scope = DECLARE_THROW_SCOPE(vm);
111
112     const Identifier moduleKey = exec->argument(0).toPropertyKey(exec);
113     RETURN_IF_EXCEPTION(scope, encodedJSValue());
114
115     String source = exec->argument(1).toWTFString(exec);
116     RETURN_IF_EXCEPTION(scope, encodedJSValue());
117
118     SourceCode sourceCode = makeSource(source, SourceOrigin { moduleKey.impl() }, moduleKey.impl(), TextPosition(), SourceProviderSourceType::Module);
119
120     CodeProfiling profile(sourceCode);
121
122     ParserError error;
123     std::unique_ptr<ModuleProgramNode> moduleProgramNode = parse<ModuleProgramNode>(
124         &vm, sourceCode, Identifier(), JSParserBuiltinMode::NotBuiltin,
125         JSParserStrictMode::Strict, JSParserScriptMode::Module, SourceParseMode::ModuleAnalyzeMode, SuperBinding::NotNeeded, error);
126
127     if (error.isValid()) {
128         throwVMError(exec, scope, error.toErrorObject(exec->lexicalGlobalObject(), sourceCode));
129         return JSValue::encode(jsUndefined());
130     }
131     ASSERT(moduleProgramNode);
132
133     ModuleAnalyzer moduleAnalyzer(exec, moduleKey, sourceCode, moduleProgramNode->varDeclarations(), moduleProgramNode->lexicalVariables());
134     RETURN_IF_EXCEPTION(scope, encodedJSValue());
135     JSModuleRecord* moduleRecord = moduleAnalyzer.analyze(*moduleProgramNode);
136
137     return JSValue::encode(moduleRecord);
138 }
139
140 EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeRequestedModules(ExecState* exec)
141 {
142     VM& vm = exec->vm();
143     auto scope = DECLARE_THROW_SCOPE(vm);
144     JSModuleRecord* moduleRecord = jsDynamicCast<JSModuleRecord*>(exec->argument(0));
145     if (!moduleRecord) {
146         scope.release();
147         return JSValue::encode(constructEmptyArray(exec, nullptr));
148     }
149
150     JSArray* result = constructEmptyArray(exec, nullptr, moduleRecord->requestedModules().size());
151     RETURN_IF_EXCEPTION(scope, encodedJSValue());
152     size_t i = 0;
153     for (auto& key : moduleRecord->requestedModules()) {
154         result->putDirectIndex(exec, i++, jsString(exec, key.get()));
155         RETURN_IF_EXCEPTION(scope, encodedJSValue());
156     }
157     return JSValue::encode(result);
158 }
159
160 EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeModuleDeclarationInstantiation(ExecState* exec)
161 {
162     VM& vm = exec->vm();
163     auto scope = DECLARE_THROW_SCOPE(vm);
164     JSModuleRecord* moduleRecord = jsDynamicCast<JSModuleRecord*>(exec->argument(0));
165     if (!moduleRecord)
166         return JSValue::encode(jsUndefined());
167
168     if (Options::dumpModuleLoadingState())
169         dataLog("Loader [link] ", moduleRecord->moduleKey(), "\n");
170
171     moduleRecord->link(exec);
172     RETURN_IF_EXCEPTION(scope, encodedJSValue());
173
174     return JSValue::encode(jsUndefined());
175 }
176
177 // ------------------------------ Hook Functions ---------------------------
178
179 EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeResolve(ExecState* exec)
180 {
181     // Hook point, Loader.resolve.
182     // https://whatwg.github.io/loader/#browser-resolve
183     // Take the name and resolve it to the unique identifier for the resource location.
184     // For example, take the "jquery" and return the URL for the resource.
185     JSModuleLoader* loader = jsDynamicCast<JSModuleLoader*>(exec->thisValue());
186     if (!loader)
187         return JSValue::encode(jsUndefined());
188     return JSValue::encode(loader->resolve(exec, exec->argument(0), exec->argument(1), exec->argument(2)));
189 }
190
191 EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeFetch(ExecState* exec)
192 {
193     // Hook point, Loader.fetch
194     // https://whatwg.github.io/loader/#browser-fetch
195     // Take the key and fetch the resource actually.
196     // For example, JavaScriptCore shell can provide the hook fetching the resource
197     // from the local file system.
198     JSModuleLoader* loader = jsDynamicCast<JSModuleLoader*>(exec->thisValue());
199     if (!loader)
200         return JSValue::encode(jsUndefined());
201     return JSValue::encode(loader->fetch(exec, exec->argument(0), exec->argument(1)));
202 }
203
204 EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeInstantiate(ExecState* exec)
205 {
206     // Hook point, Loader.instantiate
207     // https://whatwg.github.io/loader/#browser-instantiate
208     // Take the key and the fetched source code, and instantiate the module record
209     // by parsing the module source code.
210     // It has the chance to provide the optional module instance that is different from
211     // the ordinary one.
212     JSModuleLoader* loader = jsDynamicCast<JSModuleLoader*>(exec->thisValue());
213     if (!loader)
214         return JSValue::encode(jsUndefined());
215     return JSValue::encode(loader->instantiate(exec, exec->argument(0), exec->argument(1), exec->argument(2)));
216 }
217
218 EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeGetModuleNamespaceObject(ExecState* exec)
219 {
220     VM& vm = exec->vm();
221     auto scope = DECLARE_THROW_SCOPE(vm);
222
223     auto* loader = jsDynamicCast<JSModuleLoader*>(exec->thisValue());
224     if (!loader)
225         return JSValue::encode(jsUndefined());
226     auto* moduleNamespaceObject = loader->getModuleNamespaceObject(exec, exec->argument(0));
227     RETURN_IF_EXCEPTION(scope, encodedJSValue());
228     return JSValue::encode(moduleNamespaceObject);
229 }
230
231 // ------------------- Additional Hook Functions ---------------------------
232
233 EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeEvaluate(ExecState* exec)
234 {
235     // To instrument and retrieve the errors raised from the module execution,
236     // we inserted the hook point here.
237
238     JSModuleLoader* loader = jsDynamicCast<JSModuleLoader*>(exec->thisValue());
239     if (!loader)
240         return JSValue::encode(jsUndefined());
241     return JSValue::encode(loader->evaluate(exec, exec->argument(0), exec->argument(1), exec->argument(2)));
242 }
243
244 } // namespace JSC