bitburner-src/src/Netscript/WorkerScript.ts

/**
 * The worker agent for running a script instance. Each running script instance
 * has its own underlying WorkerScript object.
 *
 * Note that these objects are not saved and re-loaded when the game is refreshed.
 * Instead, whenever the game is opened, WorkerScripts are re-created from
 * RunningScript objects
 */
import { Environment } from "./Environment";
import { RamCostConstants } from "./RamCostGenerator";

import { RunningScript } from "../Script/RunningScript";
import { Script } from "../Script/Script";
import { GetServer } from "../Server/AllServers";
import { BaseServer } from "../Server/BaseServer";
import { IMap } from "../types";

export class WorkerScript {
  /**
   * Script's arguments
   */
  args: any[];

  /**
   * Copy of the script's code
   */
  code = "";

  /**
   * Holds the timeoutID (numeric value) for whenever this script is blocked by a
   * timed Netscript function. i.e. Holds the return value of setTimeout()
   */
  delay: number | null = null;

  /**
   * Holds the Promise resolve() function for when the script is "blocked" by an async op
   */
  delayResolve?: () => void;

  /**
   * Stores names of all functions that have logging disabled
   */
  disableLogs: IMap<boolean> = {};

  /**
   * Used for dynamic RAM calculation. Stores names of all functions that have
   * already been checked by this script.
   * TODO: Could probably just combine this with loadedFns?
   */
  dynamicLoadedFns: IMap<boolean> = {};

  /**
   * Tracks dynamic RAM usage
   */
  dynamicRamUsage: number = RamCostConstants.ScriptBaseRamCost;

  /**
   * Netscript Environment for this script
   */
  env: Environment;

  /**
   * Status message in case of script error. Currently unused I think
   */
  errorMessage = "";

  /**
   * Used for static RAM calculation. Stores names of all functions that have
   * already been checked by this script
   */
  loadedFns: IMap<boolean> = {};

  /**
   * Filename of script
   */
  name: string;

  /**
   * Script's output/return value. Currently not used or implemented
   */
  output = "";

  /**
   * Process ID. Must be an integer. Used for efficient script
   * killing and removal.
   */
  pid: number;

  /**
   * Script's Static RAM usage. Equivalent to underlying script's RAM usage
   */
  ramUsage = 0;

  /**
   * Whether or not this workerScript is currently running
   */
  running = false;

  /**
   * Reference to underlying RunningScript object
   */
  scriptRef: RunningScript;

  /**
   * IP Address on which this script is running
   */
  hostname: string;

  /**
   * Function called when the script ends.
   */
  atExit: any;

  constructor(runningScriptObj: RunningScript, pid: number, nsFuncsGenerator?: (ws: WorkerScript) => any) {
    this.name = runningScriptObj.filename;
    this.hostname = runningScriptObj.server;

    const sanitizedPid = Math.round(pid);
    if (typeof sanitizedPid !== "number" || isNaN(sanitizedPid)) {
      throw new Error(`Invalid PID when constructing WorkerScript: ${pid}`);
    }
    this.pid = sanitizedPid;
    runningScriptObj.pid = sanitizedPid;

    // Get the underlying script's code
    const server = GetServer(this.hostname);
    if (server == null) {
      throw new Error(`WorkerScript constructed with invalid server ip: ${this.hostname}`);
    }
    let found = false;
    for (let i = 0; i < server.scripts.length; ++i) {
      if (server.scripts[i].filename === this.name) {
        found = true;
        this.code = server.scripts[i].code;
      }
    }
    if (!found) {
      throw new Error(`WorkerScript constructed with invalid script filename: ${this.name}`);
    }
    this.scriptRef = runningScriptObj;
    this.args = runningScriptObj.args.slice();
    this.env = new Environment(null);
    if (typeof nsFuncsGenerator === "function") {
      this.env.vars = nsFuncsGenerator(this);
    }
    this.env.set("args", runningScriptObj.args.slice());
  }

  /**
   * Returns the Server on which this script is running
   */
  getServer(): BaseServer {
    const server = GetServer(this.hostname);
    if (server == null) throw new Error(`Script ${this.name} pid ${this.pid} is running on non-existent server?`);
    return server;
  }

  /**
   * Returns the Script object for the underlying script.
   * Returns null if it cannot be found (which would be a bug)
   */
  getScript(): Script | null {
    const server = this.getServer();
    for (let i = 0; i < server.scripts.length; ++i) {
      if (server.scripts[i].filename === this.name) {
        return server.scripts[i];
      }
    }

    console.error(
      "Failed to find underlying Script object in WorkerScript.getScript(). This probably means somethings wrong",
    );
    return null;
  }

  /**
   * Returns the script with the specified filename on the specified server,
   * or null if it cannot be found
   */
  getScriptOnServer(fn: string, server: BaseServer): Script | null {
    if (server == null) {
      server = this.getServer();
    }

    for (let i = 0; i < server.scripts.length; ++i) {
      if (server.scripts[i].filename === fn) {
        return server.scripts[i];
      }
    }

    return null;
  }

  shouldLog(fn: string): boolean {
    return this.disableLogs[fn] == null;
  }

  log(func: string, txt: () => string): void {
    if (this.shouldLog(func)) {
      if (func && txt) {
        this.scriptRef.log(`${func}: ${txt()}`);
      } else if (func) {
        this.scriptRef.log(func);
      } else {
        this.scriptRef.log(txt());
      }
    }
  }

  print(txt: string): void {
    this.scriptRef.log(txt);
  }
}