0d58afd1a082f368f4cb8bbe5679b5cdb9131759
[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 "JSSourceCode.h"
43 #include "ModuleAnalyzer.h"
44 #include "Nodes.h"
45 #include "Parser.h"
46 #include "ParserError.h"
47
48 namespace JSC {
49
50 static EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeParseModule(ExecState*);
51 static EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeRequestedModules(ExecState*);
52 static EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeEvaluate(ExecState*);
53 static EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeModuleDeclarationInstantiation(ExecState*);
54 static EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeResolve(ExecState*);
55 static EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeFetch(ExecState*);
56 static EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeInstantiate(ExecState*);
57 static EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeGetModuleNamespaceObject(ExecState*);
58
59 }
60
61 #include "ModuleLoaderPrototype.lut.h"
62
63 namespace JSC {
64
65 STATIC_ASSERT_IS_TRIVIALLY_DESTRUCTIBLE(ModuleLoaderPrototype);
66
67 const ClassInfo ModuleLoaderPrototype::s_info = { "ModuleLoader", &Base::s_info, &moduleLoaderPrototypeTable, CREATE_METHOD_TABLE(ModuleLoaderPrototype) };
68
69 /* Source for ModuleLoaderPrototype.lut.h
70 @begin moduleLoaderPrototypeTable
71     ensureRegistered               JSBuiltin                                           DontEnum|Function 1
72     forceFulfillPromise            JSBuiltin                                           DontEnum|Function 2
73     fulfillFetch                   JSBuiltin                                           DontEnum|Function 2
74     fulfillInstantiate             JSBuiltin                                           DontEnum|Function 2
75     commitInstantiated             JSBuiltin                                           DontEnum|Function 3
76     instantiation                  JSBuiltin                                           DontEnum|Function 3
77     requestFetch                   JSBuiltin                                           DontEnum|Function 2
78     requestInstantiate             JSBuiltin                                           DontEnum|Function 2
79     requestSatisfy                 JSBuiltin                                           DontEnum|Function 2
80     requestInstantiateAll          JSBuiltin                                           DontEnum|Function 2
81     requestLink                    JSBuiltin                                           DontEnum|Function 2
82     requestReady                   JSBuiltin                                           DontEnum|Function 2
83     link                           JSBuiltin                                           DontEnum|Function 2
84     moduleDeclarationInstantiation moduleLoaderPrototypeModuleDeclarationInstantiation DontEnum|Function 2
85     moduleEvaluation               JSBuiltin                                           DontEnum|Function 2
86     evaluate                       moduleLoaderPrototypeEvaluate                       DontEnum|Function 3
87     provide                        JSBuiltin                                           DontEnum|Function 3
88     loadAndEvaluateModule          JSBuiltin                                           DontEnum|Function 3
89     loadModule                     JSBuiltin                                           DontEnum|Function 3
90     linkAndEvaluateModule          JSBuiltin                                           DontEnum|Function 2
91     importModule                   JSBuiltin                                           DontEnum|Function 3
92     getModuleNamespaceObject       moduleLoaderPrototypeGetModuleNamespaceObject       DontEnum|Function 1
93     parseModule                    moduleLoaderPrototypeParseModule                    DontEnum|Function 2
94     requestedModules               moduleLoaderPrototypeRequestedModules               DontEnum|Function 1
95     resolve                        moduleLoaderPrototypeResolve                        DontEnum|Function 2
96     fetch                          moduleLoaderPrototypeFetch                          DontEnum|Function 2
97     instantiate                    moduleLoaderPrototypeInstantiate                    DontEnum|Function 3
98 @end
99 */
100
101 ModuleLoaderPrototype::ModuleLoaderPrototype(VM& vm, Structure* structure)
102     : JSNonFinalObject(vm, structure)
103 {
104 }
105
106 // ------------------------------ Functions --------------------------------
107
108 EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeParseModule(ExecState* exec)
109 {
110     VM& vm = exec->vm();
111     auto scope = DECLARE_THROW_SCOPE(vm);
112
113     const Identifier moduleKey = exec->argument(0).toPropertyKey(exec);
114     RETURN_IF_EXCEPTION(scope, encodedJSValue());
115
116     auto* jsSourceCode = jsDynamicCast<JSSourceCode*>(exec->argument(1));
117     if (!jsSourceCode)
118         return throwVMTypeError(exec, scope);
119     SourceCode sourceCode = jsSourceCode->sourceCode();
120
121     CodeProfiling profile(sourceCode);
122
123     ParserError error;
124     std::unique_ptr<ModuleProgramNode> moduleProgramNode = parse<ModuleProgramNode>(
125         &vm, sourceCode, Identifier(), JSParserBuiltinMode::NotBuiltin,
126         JSParserStrictMode::Strict, JSParserScriptMode::Module, SourceParseMode::ModuleAnalyzeMode, SuperBinding::NotNeeded, error);
127
128     if (error.isValid()) {
129         throwVMError(exec, scope, error.toErrorObject(exec->lexicalGlobalObject(), sourceCode));
130         return JSValue::encode(jsUndefined());
131     }
132     ASSERT(moduleProgramNode);
133
134     ModuleAnalyzer moduleAnalyzer(exec, moduleKey, sourceCode, moduleProgramNode->varDeclarations(), moduleProgramNode->lexicalVariables());
135     RETURN_IF_EXCEPTION(scope, encodedJSValue());
136     JSModuleRecord* moduleRecord = moduleAnalyzer.analyze(*moduleProgramNode);
137
138     return JSValue::encode(moduleRecord);
139 }
140
141 EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeRequestedModules(ExecState* exec)
142 {
143     VM& vm = exec->vm();
144     auto scope = DECLARE_THROW_SCOPE(vm);
145     JSModuleRecord* moduleRecord = jsDynamicCast<JSModuleRecord*>(exec->argument(0));
146     if (!moduleRecord) {
147         scope.release();
148         return JSValue::encode(constructEmptyArray(exec, nullptr));
149     }
150
151     JSArray* result = constructEmptyArray(exec, nullptr, moduleRecord->requestedModules().size());
152     RETURN_IF_EXCEPTION(scope, encodedJSValue());
153     size_t i = 0;
154     for (auto& key : moduleRecord->requestedModules()) {
155         result->putDirectIndex(exec, i++, jsString(exec, key.get()));
156         RETURN_IF_EXCEPTION(scope, encodedJSValue());
157     }
158     return JSValue::encode(result);
159 }
160
161 EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeModuleDeclarationInstantiation(ExecState* exec)
162 {
163     VM& vm = exec->vm();
164     auto scope = DECLARE_THROW_SCOPE(vm);
165     JSModuleRecord* moduleRecord = jsDynamicCast<JSModuleRecord*>(exec->argument(0));
166     if (!moduleRecord)
167         return JSValue::encode(jsUndefined());
168
169     if (Options::dumpModuleLoadingState())
170         dataLog("Loader [link] ", moduleRecord->moduleKey(), "\n");
171
172     moduleRecord->link(exec);
173     RETURN_IF_EXCEPTION(scope, encodedJSValue());
174
175     return JSValue::encode(jsUndefined());
176 }
177
178 // ------------------------------ Hook Functions ---------------------------
179
180 EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeResolve(ExecState* exec)
181 {
182     // Hook point, Loader.resolve.
183     // https://whatwg.github.io/loader/#browser-resolve
184     // Take the name and resolve it to the unique identifier for the resource location.
185     // For example, take the "jquery" and return the URL for the resource.
186     JSModuleLoader* loader = jsDynamicCast<JSModuleLoader*>(exec->thisValue());
187     if (!loader)
188         return JSValue::encode(jsUndefined());
189     return JSValue::encode(loader->resolve(exec, exec->argument(0), exec->argument(1), exec->argument(2)));
190 }
191
192 EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeFetch(ExecState* exec)
193 {
194     // Hook point, Loader.fetch
195     // https://whatwg.github.io/loader/#browser-fetch
196     // Take the key and fetch the resource actually.
197     // For example, JavaScriptCore shell can provide the hook fetching the resource
198     // from the local file system.
199     JSModuleLoader* loader = jsDynamicCast<JSModuleLoader*>(exec->thisValue());
200     if (!loader)
201         return JSValue::encode(jsUndefined());
202     return JSValue::encode(loader->fetch(exec, exec->argument(0), exec->argument(1)));
203 }
204
205 EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeInstantiate(ExecState* exec)
206 {
207     // Hook point, Loader.instantiate
208     // https://whatwg.github.io/loader/#browser-instantiate
209     // Take the key and the fetched source code, and instantiate the module record
210     // by parsing the module source code.
211     // It has the chance to provide the optional module instance that is different from
212     // the ordinary one.
213     JSModuleLoader* loader = jsDynamicCast<JSModuleLoader*>(exec->thisValue());
214     if (!loader)
215         return JSValue::encode(jsUndefined());
216     return JSValue::encode(loader->instantiate(exec, exec->argument(0), exec->argument(1), exec->argument(2)));
217 }
218
219 EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeGetModuleNamespaceObject(ExecState* exec)
220 {
221     VM& vm = exec->vm();
222     auto scope = DECLARE_THROW_SCOPE(vm);
223
224     auto* loader = jsDynamicCast<JSModuleLoader*>(exec->thisValue());
225     if (!loader)
226         return JSValue::encode(jsUndefined());
227     auto* moduleNamespaceObject = loader->getModuleNamespaceObject(exec, exec->argument(0));
228     RETURN_IF_EXCEPTION(scope, encodedJSValue());
229     return JSValue::encode(moduleNamespaceObject);
230 }
231
232 // ------------------- Additional Hook Functions ---------------------------
233
234 EncodedJSValue JSC_HOST_CALL moduleLoaderPrototypeEvaluate(ExecState* exec)
235 {
236     // To instrument and retrieve the errors raised from the module execution,
237     // we inserted the hook point here.
238
239     JSModuleLoader* loader = jsDynamicCast<JSModuleLoader*>(exec->thisValue());
240     if (!loader)
241         return JSValue::encode(jsUndefined());
242     return JSValue::encode(loader->evaluate(exec, exec->argument(0), exec->argument(1), exec->argument(2)));
243 }
244
245 } // namespace JSC