bitburner-src/src/NetscriptJSEvaluator.js

import {registerEnv, unregisterEnv, makeEnvHeader} from "./NetscriptJSPreamble.js";
import {makeRuntimeRejectMsg} from "./NetscriptEvaluator.js";

// Makes a blob that contains the code of a given script.
export function makeScriptBlob(code) {
    return new Blob([code], {type: "text/javascript"});
}

// Begin executing a user JS script, and return a promise that resolves
// or rejects when the script finishes.
// - script is a script to execute (see Script.js). We depend only on .filename and .code.
// scripts is an array of other scripts on the server.
// env is the global environment that should be visible to all the scripts
// (i.e. hack, grow, etc.).
// When the promise returned by this resolves, we'll have finished
// running the main function of the script.
export async function executeJSScript(script, scripts = [], env = {}) {
    const envUuid = registerEnv(env);
    const envHeader = makeEnvHeader(envUuid);
    const urlStack = _getScriptUrls(script, scripts, envHeader, []);

    // 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.
    try {
        // TODO: putting await in a non-async function yields unhelpful
        // "SyntaxError: unexpected reserved word" with no line number information.
        const loadedModule  = await eval('import(urlStack[urlStack.length - 1])');
        if (!loadedModule.main) {
            throw makeRuntimeRejectMsg(script.filename +
                                       " did not have a main function, cannot run it.");
        }
        return await loadedModule.main();
    } finally {
        // Revoke the generated URLs and unregister the environment.
        for (const url in urlStack) URL.revokeObjectURL(url);
        unregisterEnv(envUuid);
    };
}

// 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
// - envHeader -- the preamble that goes at the start of every NSJS script.
// - seen -- The modules above this one -- to prevent mutual dependency.
//
// TODO We don't make any effort to cache a given module when it is imported at
// different parts of the tree. That hasn't presented any problem with during
// testing, but it might be an idea for the future. Would require a topo-sort
// then url-izing from leaf-most to root-most.
function _getScriptUrls(script, scripts, envHeader, seen) {
    // Inspired by: https://stackoverflow.com/a/43834063/91401
    const urlStack = [];
    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.
        const transformedCode = script.code.replace(/((?:from|import)\s+(?:'|"))([^'"]+)('|";)/g,
            (unmodified, prefix, filename, suffix) => {
                const isAllowedImport = scripts.some(s => s.filename == filename);
                if (!isAllowedImport) return unmodified;

                // Find the corresponding script.
                const [importedScript] = scripts.filter(s => s.filename == filename);

                // Try to get a URL for the requested script and its dependencies.
                const urls = _getScriptUrls(importedScript, scripts, envHeader, seen);

                // The top url in the stack is the replacement import file for this script.
                urlStack.push(...urls);
                return [prefix, urls[urls.length - 1], suffix].join('');
            });

        // Inject the NSJS preamble at the top of the code.
        const transformedCodeWithHeader = [envHeader, transformedCode].join("\n");

        // If we successfully transformed the code, create a blob url for it and
        // push that URL onto the top of the stack.
        urlStack.push(URL.createObjectURL(makeScriptBlob(transformedCodeWithHeader)));
        return urlStack;
    } catch (err) {
        // If there is an error, we need to clean up the URLs.
        for (const url in urlStack) URL.revokeObjectURL(url);
        throw err;
    } finally {
        seen.pop();
    }
}