Bug 1742437 - Move module loader files into a central folder; r=jonco
Differential Revision: https://phabricator.services.mozilla.com/D137532
This commit is contained in:
Yulia Startsev
192
js/loader/ModuleLoaderBase.h
Normal file
192
js/loader/ModuleLoaderBase.h
Normal file
@@ -0,0 +1,192 @@
|
||||
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
||||
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
||||
|
||||
#ifndef mozilla_dom_ModuleLoaderBase_h
|
||||
#define mozilla_dom_ModuleLoaderBase_h
|
||||
|
||||
#include "js/TypeDecls.h" // JS::MutableHandle, JS::Handle, JS::Root
|
||||
#include "nsRefPtrHashtable.h"
|
||||
#include "nsCOMArray.h"
|
||||
#include "nsCOMPtr.h"
|
||||
#include "nsILoadInfo.h" // nsSecurityFlags
|
||||
#include "nsINode.h" // nsIURI
|
||||
#include "nsURIHashKey.h"
|
||||
#include "mozilla/CORSMode.h"
|
||||
#include "mozilla/dom/LoadedScript.h"
|
||||
#include "mozilla/dom/JSExecutionContext.h"
|
||||
#include "mozilla/dom/ScriptLoadRequest.h"
|
||||
#include "mozilla/MaybeOneOf.h"
|
||||
#include "mozilla/MozPromise.h"
|
||||
#include "ModuleMapKey.h"
|
||||
|
||||
class nsIURI;
|
||||
|
||||
namespace JS {
|
||||
|
||||
class CompileOptions;
|
||||
|
||||
template <typename UnitT>
|
||||
class SourceText;
|
||||
|
||||
} // namespace JS
|
||||
|
||||
namespace mozilla {
|
||||
|
||||
class LazyLogModule;
|
||||
union Utf8Unit;
|
||||
|
||||
namespace dom {
|
||||
|
||||
class ModuleLoaderBase;
|
||||
class ModuleLoadRequest;
|
||||
class ModuleScript;
|
||||
|
||||
class ScriptLoaderInterface : public nsISupports {
|
||||
public:
|
||||
// In some environments, we will need to default to a base URI
|
||||
virtual nsIURI* GetBaseURI() const = 0;
|
||||
|
||||
// Get the global for the associated request.
|
||||
virtual already_AddRefed<nsIGlobalObject> GetGlobalForRequest(
|
||||
ScriptLoadRequest* aRequest) = 0;
|
||||
|
||||
virtual void ReportErrorToConsole(ScriptLoadRequest* aRequest,
|
||||
nsresult aResult) const = 0;
|
||||
|
||||
// Fill in CompileOptions, as well as produce the introducer script for
|
||||
// subsequent calls to UpdateDebuggerMetadata
|
||||
virtual nsresult FillCompileOptionsForRequest(
|
||||
JSContext* cx, ScriptLoadRequest* aRequest,
|
||||
JS::Handle<JSObject*> aScopeChain, JS::CompileOptions* aOptions,
|
||||
JS::MutableHandle<JSScript*> aIntroductionScript) = 0;
|
||||
};
|
||||
|
||||
class ModuleLoaderBase : public nsISupports {
|
||||
private:
|
||||
// Module map
|
||||
nsRefPtrHashtable<ModuleMapKey, mozilla::GenericNonExclusivePromise::Private>
|
||||
mFetchingModules;
|
||||
nsRefPtrHashtable<ModuleMapKey, ModuleScript> mFetchedModules;
|
||||
|
||||
protected:
|
||||
virtual ~ModuleLoaderBase();
|
||||
RefPtr<ScriptLoaderInterface> mLoader;
|
||||
|
||||
public:
|
||||
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
|
||||
NS_DECL_CYCLE_COLLECTION_CLASS(ModuleLoaderBase)
|
||||
explicit ModuleLoaderBase(ScriptLoaderInterface* aLoader);
|
||||
|
||||
ScriptLoadRequestList mDynamicImportRequests;
|
||||
|
||||
using MaybeSourceText =
|
||||
mozilla::MaybeOneOf<JS::SourceText<char16_t>, JS::SourceText<Utf8Unit>>;
|
||||
|
||||
// Methods that must be overwritten by an extending class
|
||||
virtual void EnsureModuleHooksInitialized() {
|
||||
MOZ_ASSERT(false, "You must override EnsureModuleHooksInitialized");
|
||||
}
|
||||
virtual nsresult StartModuleLoad(ScriptLoadRequest* aRequest) = 0;
|
||||
virtual void ProcessLoadedModuleTree(ModuleLoadRequest* aRequest) = 0;
|
||||
virtual nsresult CompileOrFinishModuleScript(
|
||||
JSContext* aCx, JS::Handle<JSObject*> aGlobal,
|
||||
JS::CompileOptions& aOptions, ModuleLoadRequest* aRequest,
|
||||
JS::MutableHandle<JSObject*> aModuleScript) = 0;
|
||||
|
||||
// Create a module load request for a static module import.
|
||||
virtual already_AddRefed<ModuleLoadRequest> CreateStaticImport(
|
||||
nsIURI* aURI, ModuleLoadRequest* aParent) = 0;
|
||||
|
||||
// Helper function to set up the global correctly for dynamic imports.
|
||||
nsresult EvaluateModule(ScriptLoadRequest* aRequest);
|
||||
|
||||
// Implements https://html.spec.whatwg.org/#run-a-module-script
|
||||
nsresult EvaluateModule(nsIGlobalObject* aGlobalObject,
|
||||
ScriptLoadRequest* aRequest);
|
||||
|
||||
void SetModuleFetchStarted(ModuleLoadRequest* aRequest);
|
||||
void SetModuleFetchFinishedAndResumeWaitingRequests(
|
||||
ModuleLoadRequest* aRequest, nsresult aResult);
|
||||
|
||||
bool ModuleMapContainsURL(nsIURI* aURL, nsIGlobalObject* aGlobal) const;
|
||||
RefPtr<mozilla::GenericNonExclusivePromise> WaitForModuleFetch(
|
||||
nsIURI* aURL, nsIGlobalObject* aGlobal);
|
||||
ModuleScript* GetFetchedModule(nsIURI* aURL, nsIGlobalObject* aGlobal) const;
|
||||
|
||||
JS::Value FindFirstParseError(ModuleLoadRequest* aRequest);
|
||||
bool InstantiateModuleTree(ModuleLoadRequest* aRequest);
|
||||
static nsresult InitDebuggerDataForModuleTree(JSContext* aCx,
|
||||
ModuleLoadRequest* aRequest);
|
||||
static nsresult ResolveRequestedModules(ModuleLoadRequest* aRequest,
|
||||
nsCOMArray<nsIURI>* aUrlsOut);
|
||||
static nsresult HandleResolveFailure(JSContext* aCx, LoadedScript* aScript,
|
||||
const nsAString& aSpecifier,
|
||||
uint32_t aLineNumber,
|
||||
uint32_t aColumnNumber,
|
||||
JS::MutableHandle<JS::Value> errorOut);
|
||||
|
||||
static already_AddRefed<nsIURI> ResolveModuleSpecifier(
|
||||
ScriptLoaderInterface* loader, LoadedScript* aScript,
|
||||
const nsAString& aSpecifier);
|
||||
|
||||
void StartFetchingModuleDependencies(ModuleLoadRequest* aRequest);
|
||||
|
||||
RefPtr<mozilla::GenericPromise> StartFetchingModuleAndDependencies(
|
||||
ModuleLoadRequest* aParent, nsIURI* aURI);
|
||||
|
||||
void StartDynamicImport(ModuleLoadRequest* aRequest);
|
||||
|
||||
/**
|
||||
* Shorthand Wrapper for JSAPI FinishDynamicImport function for the reject
|
||||
* case where we do not have `aEvaluationPromise`. As there is no evaluation
|
||||
* Promise, JS::FinishDynamicImport will always reject.
|
||||
*
|
||||
* @param aRequest
|
||||
* The module load request for the dynamic module.
|
||||
* @param aResult
|
||||
* The result of running ModuleEvaluate -- If this is successful, then
|
||||
* we can await the associated EvaluationPromise.
|
||||
*/
|
||||
static void FinishDynamicImportAndReject(ModuleLoadRequest* aRequest,
|
||||
nsresult aResult);
|
||||
|
||||
/**
|
||||
* Wrapper for JSAPI FinishDynamicImport function. Takes an optional argument
|
||||
* `aEvaluationPromise` which, if null, exits early.
|
||||
*
|
||||
* This is the Top Level Await version, which works with modules which return
|
||||
* promises.
|
||||
*
|
||||
* @param aCX
|
||||
* The JSContext for the module.
|
||||
* @param aRequest
|
||||
* The module load request for the dynamic module.
|
||||
* @param aResult
|
||||
* The result of running ModuleEvaluate -- If this is successful, then
|
||||
* we can await the associated EvaluationPromise.
|
||||
* @param aEvaluationPromise
|
||||
* The evaluation promise returned from evaluating the module. If this
|
||||
* is null, JS::FinishDynamicImport will reject the dynamic import
|
||||
* module promise.
|
||||
*/
|
||||
static void FinishDynamicImport(JSContext* aCx, ModuleLoadRequest* aRequest,
|
||||
nsresult aResult,
|
||||
JS::Handle<JSObject*> aEvaluationPromise);
|
||||
|
||||
nsresult CreateModuleScript(ModuleLoadRequest* aRequest);
|
||||
nsresult ProcessFetchedModuleSource(ModuleLoadRequest* aRequest);
|
||||
void ProcessDynamicImport(ModuleLoadRequest* aRequest);
|
||||
void CancelAndClearDynamicImports();
|
||||
|
||||
public:
|
||||
static LazyLogModule gCspPRLog;
|
||||
static LazyLogModule gModuleLoaderBaseLog;
|
||||
};
|
||||
|
||||
} // namespace dom
|
||||
} // namespace mozilla
|
||||
|
||||
#endif // mozilla_dom_ModuleLoaderBase_h
|
||||
Reference in New Issue
Block a user