mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-10-23 02:03:14 +02:00
fb1f95c26e
See PR #271 description
190 lines
7.6 KiB
TypeScript
190 lines
7.6 KiB
TypeScript
/**
|
|
* Uses the acorn.js library to parse a script's code into an AST and
|
|
* recursively walk through that AST to replace import urls with blobs
|
|
*/
|
|
import * as walk from "acorn-walk";
|
|
import { parse } from "acorn";
|
|
|
|
import { ScriptUrl } from "./Script/ScriptUrl";
|
|
import { Script } from "./Script/Script";
|
|
import { areImportsEquals } from "./Terminal/DirectoryHelpers";
|
|
import { ScriptModule } from "./Script/ScriptModule";
|
|
|
|
// Acorn type def is straight up incomplete so we have to fill with our own.
|
|
export type Node = any;
|
|
|
|
// Makes a blob that contains the code of a given script.
|
|
function makeScriptBlob(code: string): Blob {
|
|
return new Blob([code], { type: "text/javascript" });
|
|
}
|
|
|
|
export async function compile(script: Script, scripts: Script[]): Promise<ScriptModule> {
|
|
//!shouldCompile ensures that script.module is non-null, hence the "as".
|
|
if (!shouldCompile(script, scripts)) return script.module as Promise<ScriptModule>;
|
|
script.queueCompile = true;
|
|
//If we're already in the middle of compiling (script.module has not resolved yet), wait for the previous compilation to finish
|
|
//If script.module is null, this does nothing.
|
|
await script.module;
|
|
//If multiple compiles were called on the same script before a compilation could be completed this ensures only one compilation is actually performed.
|
|
if (!script.queueCompile) return script.module as Promise<ScriptModule>;
|
|
script.queueCompile = false;
|
|
script.updateRamUsage(scripts);
|
|
const uurls = _getScriptUrls(script, scripts, []);
|
|
const url = uurls[uurls.length - 1].url;
|
|
if (script.url && script.url !== url) URL.revokeObjectURL(script.url);
|
|
|
|
if (script.dependencies.length > 0) script.dependencies.forEach((dep) => URL.revokeObjectURL(dep.url));
|
|
script.url = uurls[uurls.length - 1].url;
|
|
// The URL at the top is the one we want to import. It will
|
|
// recursively import all the other modules in the urlStack.
|
|
//
|
|
// Webpack likes to turn the import into a require, which sort of
|
|
// but not really behaves like import. Particularly, it cannot
|
|
// load fully dynamic content. So we hide the import from webpack
|
|
// by placing it inside an eval call.
|
|
script.module = new Promise((resolve) => resolve(eval("import(uurls[uurls.length - 1].url)")));
|
|
script.dependencies = uurls;
|
|
return script.module;
|
|
}
|
|
|
|
function isDependencyOutOfDate(filename: string, scripts: Script[], scriptModuleSequenceNumber: number): boolean {
|
|
const depScript = scripts.find((s) => s.filename == filename);
|
|
|
|
// If the script is not present on the server, we should recompile, if only to get any necessary
|
|
// compilation errors.
|
|
if (!depScript) return true;
|
|
|
|
const depIsMoreRecent = depScript.moduleSequenceNumber > scriptModuleSequenceNumber;
|
|
return depIsMoreRecent;
|
|
}
|
|
/** Returns whether we should compile the script parameter.
|
|
*
|
|
* @param {Script} script
|
|
* @param {Script[]} scripts
|
|
*/
|
|
function shouldCompile(script: Script, scripts: Script[]): boolean {
|
|
if (!script.module) return true;
|
|
if (script.dependencies.some((dep) => isDependencyOutOfDate(dep.filename, scripts, script.moduleSequenceNumber))) {
|
|
script.module = null;
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
// Gets a stack of blob urls, the top/right-most element being
|
|
// the blob url for the named script on the named server.
|
|
//
|
|
// - script -- the script for whom we are getting a URL.
|
|
// - scripts -- all the scripts available on this server
|
|
// - seen -- The modules above this one -- to prevent mutual dependency.
|
|
//
|
|
// TODO 2.3 consider: Possibly reusing modules when imported in different locations. Per previous notes, this may
|
|
// require a topo-sort then url-izing from leaf-most to root-most.
|
|
/**
|
|
* @param {Script} script
|
|
* @param {Script[]} scripts
|
|
* @param {Script[]} seen
|
|
* @returns {ScriptUrl[]} All of the compiled scripts, with the final one
|
|
* in the list containing the blob corresponding to
|
|
* the script parameter.
|
|
*/
|
|
// BUG: apparently seen is never consulted. Oops.
|
|
function _getScriptUrls(script: Script, scripts: Script[], seen: Script[]): ScriptUrl[] {
|
|
// Inspired by: https://stackoverflow.com/a/43834063/91401
|
|
const urlStack: ScriptUrl[] = [];
|
|
// Seen contains the dependents of the current script. Make sure we include that in the script dependents.
|
|
for (const dependent of seen) {
|
|
if (!script.dependents.some((s) => s.server === dependent.server && s.filename == dependent.filename)) {
|
|
script.dependents.push({ server: dependent.server, filename: dependent.filename });
|
|
}
|
|
}
|
|
seen.push(script);
|
|
try {
|
|
// Replace every import statement with an import to a blob url containing
|
|
// the corresponding script. E.g.
|
|
//
|
|
// import {foo} from "bar.js";
|
|
//
|
|
// becomes
|
|
//
|
|
// import {foo} from "blob://<uuid>"
|
|
//
|
|
// Where the blob URL contains the script content.
|
|
|
|
// Parse the code into an ast tree
|
|
const ast = parse(script.code, { sourceType: "module", ecmaVersion: "latest", ranges: true });
|
|
interface importNode {
|
|
filename: string;
|
|
start: number;
|
|
end: number;
|
|
}
|
|
const importNodes: importNode[] = [];
|
|
// Walk the nodes of this tree and find any import declaration statements.
|
|
walk.simple(ast, {
|
|
ImportDeclaration(node: Node) {
|
|
// Push this import onto the stack to replace
|
|
if (!node.source) return;
|
|
importNodes.push({
|
|
filename: node.source.value,
|
|
start: node.source.range[0] + 1,
|
|
end: node.source.range[1] - 1,
|
|
});
|
|
},
|
|
ExportNamedDeclaration(node: Node) {
|
|
if (!node.source) return;
|
|
importNodes.push({
|
|
filename: node.source.value,
|
|
start: node.source.range[0] + 1,
|
|
end: node.source.range[1] - 1,
|
|
});
|
|
},
|
|
ExportAllDeclaration(node: Node) {
|
|
if (!node.source) return;
|
|
importNodes.push({
|
|
filename: node.source.value,
|
|
start: node.source.range[0] + 1,
|
|
end: node.source.range[1] - 1,
|
|
});
|
|
},
|
|
});
|
|
// Sort the nodes from last start index to first. This replaces the last import with a blob first,
|
|
// preventing the ranges for other imports from being shifted.
|
|
importNodes.sort((a, b) => b.start - a.start);
|
|
let transformedCode = script.code;
|
|
// Loop through each node and replace the script name with a blob url.
|
|
for (const node of importNodes) {
|
|
const filename = node.filename.startsWith("./") ? node.filename.substring(2) : node.filename;
|
|
|
|
// Find the corresponding script.
|
|
const matchingScripts = scripts.filter((s) => areImportsEquals(s.filename, filename));
|
|
if (matchingScripts.length === 0) continue;
|
|
|
|
const [importedScript] = matchingScripts;
|
|
|
|
const urls = _getScriptUrls(importedScript, scripts, seen);
|
|
|
|
// The top url in the stack is the replacement import file for this script.
|
|
urlStack.push(...urls);
|
|
const blob = urls[urls.length - 1].url;
|
|
|
|
// Replace the blob inside the import statement.
|
|
transformedCode = transformedCode.substring(0, node.start) + blob + transformedCode.substring(node.end);
|
|
}
|
|
|
|
// We automatically define a print function() in the NetscriptJS module so that
|
|
// accidental calls to window.print() do not bring up the "print screen" dialog
|
|
transformedCode += `\n//# sourceURL=${script.server}/${script.filename}`;
|
|
|
|
const blob = URL.createObjectURL(makeScriptBlob(transformedCode));
|
|
// Push the blob URL onto the top of the stack.
|
|
urlStack.push(new ScriptUrl(script.filename, blob, script.moduleSequenceNumber));
|
|
return urlStack;
|
|
} catch (err) {
|
|
// If there is an error, we need to clean up the URLs.
|
|
for (const url of urlStack) URL.revokeObjectURL(url.url);
|
|
throw err;
|
|
} finally {
|
|
seen.pop();
|
|
}
|
|
}
|