@sdeverywhere/plugin-worker 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Climate Interactive / New Venture Fund
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,13 @@
+# @sdeverywhere/plugin-worker
+
+This package provides a plugin that generates a `worker.js` file that can run
+an SDEverywhere-generated system dynamics model asynchronously in a Web Worker
+or Node.js worker thread.
+
+## Documentation
+
+TODO
+
+## License
+
+SDEverywhere is distributed under the MIT license. See `LICENSE` for more details.

package/dist/index.cjs

@@ -0,0 +1,156 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  workerPlugin: () => workerPlugin
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/plugin.ts
+var import_path2 = require("path");
+var import_vite = require("vite");
+
+// src/vite-config.ts
+var import_path = require("path");
+var import_url = require("url");
+var import_plugin_node_resolve = require("@rollup/plugin-node-resolve");
+
+// src/var-names.ts
+function sdeNameForVensimName(name) {
+  return "_" + name.trim().replace(/"/g, "_").replace(/\s+!$/g, "!").replace(/\s/g, "_").replace(/,/g, "_").replace(/-/g, "_").replace(/\./g, "_").replace(/\$/g, "_").replace(/'/g, "_").replace(/&/g, "_").replace(/%/g, "_").replace(/\//g, "_").replace(/\|/g, "_").toLowerCase();
+}
+function sdeNameForVensimVarName(varName) {
+  const m = varName.match(/([^[]+)(?:\[([^\]]+)\])?/);
+  if (!m) {
+    throw new Error(`Invalid Vensim name: ${varName}`);
+  }
+  let id = sdeNameForVensimName(m[1]);
+  if (m[2]) {
+    const subscripts = m[2].split(",").map((x) => sdeNameForVensimName(x));
+    id += `[${subscripts.join("][")}]`;
+  }
+  return id;
+}
+
+// src/vite-config.ts
+var import_meta = {};
+var __filename = (0, import_url.fileURLToPath)(import_meta.url);
+var __dirname = (0, import_path.dirname)(__filename);
+function injectModelSpec(modelSpec) {
+  const outputVarIds = modelSpec.outputs.map((o) => sdeNameForVensimVarName(o.varName));
+  const moduleSrc = `
+export const startTime = ${modelSpec.startTime};
+export const endTime = ${modelSpec.endTime};
+export const numInputs = ${modelSpec.inputs.length};
+export const outputVarIds = ${JSON.stringify(outputVarIds)};
+`;
+  const virtualModuleId = "virtual:model-spec";
+  const resolvedVirtualModuleId = "\0" + virtualModuleId;
+  return {
+    name: "vite-plugin-virtual-custom",
+    resolveId(id) {
+      if (id === virtualModuleId) {
+        return resolvedVirtualModuleId;
+      }
+    },
+    load(id) {
+      if (id === resolvedVirtualModuleId) {
+        return moduleSrc;
+      }
+    }
+  };
+}
+function createViteConfig(stagedModelDir, modelJsFile, modelSpec, outputFile) {
+  const root = stagedModelDir;
+  const entry = (0, import_path.resolve)(__dirname, "..", "template-worker", "worker.js");
+  return {
+    configFile: false,
+    root,
+    clearScreen: false,
+    logLevel: "silent",
+    resolve: {
+      alias: [
+        {
+          find: "@_wasm_",
+          replacement: (0, import_path.resolve)(stagedModelDir, modelJsFile)
+        },
+        {
+          find: "threads",
+          replacement: "threads",
+          customResolver: (0, import_plugin_node_resolve.nodeResolve)({ browser: false })
+        }
+      ]
+    },
+    plugins: [
+      injectModelSpec(modelSpec)
+    ],
+    build: {
+      outDir: ".",
+      emptyOutDir: false,
+      lib: {
+        entry,
+        name: "worker",
+        formats: ["iife"],
+        fileName: () => outputFile
+      },
+      rollupOptions: {
+        onwarn: (warning, warn) => {
+          if (warning.code !== "EVAL") {
+            warn(warning);
+          }
+        }
+      }
+    }
+  };
+}
+
+// src/plugin.ts
+function workerPlugin(options) {
+  return new WorkerPlugin(options);
+}
+var WorkerPlugin = class {
+  constructor(options) {
+    this.options = options;
+  }
+  async postGenerate(context, modelSpec) {
+    var _a;
+    const log = context.log;
+    log("info", "Building worker");
+    const prepDir = context.config.prepDir;
+    const srcDir = "model";
+    const stagedModelDir = (0, import_path2.join)(prepDir, "staged", srcDir);
+    const inModelJsFile = "wasm-model.js";
+    const outWorkerJsFile = "worker.js";
+    const outputPaths = ((_a = this.options) == null ? void 0 : _a.outputPaths) || [(0, import_path2.join)(prepDir, outWorkerJsFile)];
+    for (const outputPath of outputPaths) {
+      const dstDir = (0, import_path2.dirname)(outputPath);
+      const dstFile = (0, import_path2.basename)(outputPath);
+      context.prepareStagedFile(srcDir, outWorkerJsFile, dstDir, dstFile);
+    }
+    const viteConfig = createViteConfig(stagedModelDir, inModelJsFile, modelSpec, outWorkerJsFile);
+    await (0, import_vite.build)(viteConfig);
+    return true;
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  workerPlugin
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/plugin.ts","../src/vite-config.ts","../src/var-names.ts"],"sourcesContent":["// Copyright (c) 2022 Climate Interactive / New Venture Fund\n\nexport type { WorkerPluginOptions } from './options'\nexport { workerPlugin } from './plugin'\n","// Copyright (c) 2022 Climate Interactive / New Venture Fund\n\nimport { basename, dirname, join as joinPath } from 'path'\n\nimport { build } from 'vite'\n\nimport type { BuildContext, ModelSpec, Plugin } from '@sdeverywhere/build'\n\nimport type { WorkerPluginOptions } from './options'\nimport { createViteConfig } from './vite-config'\n\nexport function workerPlugin(options?: WorkerPluginOptions): Plugin {\n  return new WorkerPlugin(options)\n}\n\nclass WorkerPlugin implements Plugin {\n  constructor(private readonly options?: WorkerPluginOptions) {}\n\n  async postGenerate(context: BuildContext, modelSpec: ModelSpec): Promise<boolean> {\n    const log = context.log\n    log('info', 'Building worker')\n\n    // Locate the input (model JS/Wasm) file in the staged directory.  Note\n    // that this relies on the `plugin-wasm` package writing a file called\n    // `wasm-model.js` to the `staged/model` directory.\n    const prepDir = context.config.prepDir\n    const srcDir = 'model'\n    const stagedModelDir = joinPath(prepDir, 'staged', srcDir)\n    const inModelJsFile = 'wasm-model.js'\n    const outWorkerJsFile = 'worker.js'\n\n    // If `outputPaths` is undefined, write the `worker.js` to the prep dir\n    const outputPaths = this.options?.outputPaths || [joinPath(prepDir, outWorkerJsFile)]\n\n    // Add staged file entries; this will cause the generated worker to be copied\n    // to the configured output paths during the \"copy staged files\" step\n    // TODO: This assumes that other plugins that use the generated worker files\n    // will run after the \"copy staged files\" step.  There might be use cases\n    // where a plugin needs access to these in `postGenerate`, in which case the\n    // files will not have been copied already.  Need to reconsider the ordering\n    // of plugins and the \"copy staged files\" step(s).\n    for (const outputPath of outputPaths) {\n      const dstDir = dirname(outputPath)\n      const dstFile = basename(outputPath)\n      context.prepareStagedFile(srcDir, outWorkerJsFile, dstDir, dstFile)\n    }\n\n    // Build the worker and write generated file to the `staged/model` directory\n    const viteConfig = createViteConfig(stagedModelDir, inModelJsFile, modelSpec, outWorkerJsFile)\n    await build(viteConfig)\n\n    // log('info', 'Done!')\n\n    return true\n  }\n}\n","// Copyright (c) 2022 Climate Interactive / New Venture Fund\n\nimport { dirname, resolve as resolvePath } from 'path'\nimport { fileURLToPath } from 'url'\n\nimport type { InlineConfig, Plugin as VitePlugin, ResolverObject } from 'vite'\nimport { nodeResolve } from '@rollup/plugin-node-resolve'\n\nimport type { ModelSpec } from '@sdeverywhere/build'\n\nimport { sdeNameForVensimVarName } from './var-names'\n\nconst __filename = fileURLToPath(import.meta.url)\nconst __dirname = dirname(__filename)\n\n/**\n * This is a virtual module plugin used to inject model-specific configuration\n * values into the generated worker bundle.\n *\n * This follows the \"Virtual Modules Convention\" described here:\n *   https://vitejs.dev/guide/api-plugin.html#virtual-modules-convention\n *\n * TODO: This could be simplified by using `vite-plugin-virtual` but that\n * doesn't seem to be working correctly in an ESM setting\n */\nfunction injectModelSpec(modelSpec: ModelSpec): VitePlugin {\n  const outputVarIds = modelSpec.outputs.map(o => sdeNameForVensimVarName(o.varName))\n\n  const moduleSrc = `\nexport const startTime = ${modelSpec.startTime};\nexport const endTime = ${modelSpec.endTime};\nexport const numInputs = ${modelSpec.inputs.length};\nexport const outputVarIds = ${JSON.stringify(outputVarIds)};\n`\n\n  const virtualModuleId = 'virtual:model-spec'\n  const resolvedVirtualModuleId = '\\0' + virtualModuleId\n\n  return {\n    name: 'vite-plugin-virtual-custom',\n    resolveId(id: string) {\n      if (id === virtualModuleId) {\n        return resolvedVirtualModuleId\n      }\n    },\n    load(id: string) {\n      if (id === resolvedVirtualModuleId) {\n        return moduleSrc\n      }\n    }\n  }\n}\n\n/**\n * Create a Vite `InlineConfig` that can be used to build a complete\n * worker bundle that can run the generated Wasm model in a separate\n * Web Worker or Node worker thread.\n *\n * @param stagedModelDir The `staged` directory under the `sde-prep` directory.\n * @param modelJsFile The name of the JS file containing the embedded Wasm.\n * @param modelSpec The model spec generated earlier in the build process.\n * @param outputFile The name of the generated worker JS file.\n * @return An `InlineConfig` instance that can be passed to Vite's `build` function.\n */\nexport function createViteConfig(\n  stagedModelDir: string,\n  modelJsFile: string,\n  modelSpec: ModelSpec,\n  outputFile: string\n): InlineConfig {\n  // Use `staged/model` as the root directory for the worker build\n  const root = stagedModelDir\n\n  // Use `template-worker/worker.js` from this package as the entry file\n  const entry = resolvePath(__dirname, '..', 'template-worker', 'worker.js')\n\n  return {\n    // Don't use an external config file\n    configFile: false,\n\n    // Use the root directory configured above\n    root,\n\n    // Don't clear the screen in dev mode so that we can see builder output\n    clearScreen: false,\n\n    // Disable vite output by default\n    // TODO: Re-enable logging if `--verbose` option is used?\n    logLevel: 'silent',\n\n    // Configure path aliases\n    resolve: {\n      alias: [\n        // In the template, we use `@_wasm_` as an alias for the JS-wrapped Wasm\n        // file generated by Emscripten\n        {\n          find: '@_wasm_',\n          replacement: resolvePath(stagedModelDir, modelJsFile)\n        },\n\n        // XXX: Prevent Vite from using the `browser` section of `threads/package.json`\n        // since we want to force the use of the general module (under dist) that chooses\n        // the correct implementation (Web Worker vs worker_threads) at runtime.  Currently\n        // Vite's library mode is browser focused, so using a `customResolver` seems to be\n        // the easiest way to prevent Vite from picking up the `browser` exports.\n        {\n          find: 'threads',\n          replacement: 'threads',\n          customResolver: nodeResolve({ browser: false }) as ResolverObject\n        }\n      ]\n    },\n\n    plugins: [\n      // Use a virtual module plugin to inject the model spec values\n      injectModelSpec(modelSpec)\n    ],\n\n    build: {\n      // Write output file to the `staged/model` directory; note that this path is\n      // relative to the bundle `root` directory\n      outDir: '.',\n      emptyOutDir: false,\n\n      lib: {\n        entry,\n        name: 'worker',\n        formats: ['iife'],\n        fileName: () => outputFile\n      },\n\n      rollupOptions: {\n        onwarn: (warning, warn) => {\n          // XXX: Suppress \"Use of eval is strongly discouraged\" warnings that are\n          // triggered by use of the following pattern in threads.js:\n          //   eval(\"require\")(\"worker_threads\")\n          // It would be nice to avoid use of `eval` there, but it's not critical for\n          // our use case so we will suppress the warnings for now\n          if (warning.code !== 'EVAL') {\n            warn(warning)\n          }\n        }\n      }\n    }\n  }\n}\n","// Copyright (c) 2022 Climate Interactive / New Venture Fund\n\n/**\n * Helper function that converts a Vensim variable or subscript name\n * into a valid C identifier as used by SDE.\n * TODO: Import helper function from `compile` package instead\n */\nfunction sdeNameForVensimName(name: string): string {\n  return (\n    '_' +\n    name\n      .trim()\n      .replace(/\"/g, '_')\n      .replace(/\\s+!$/g, '!')\n      .replace(/\\s/g, '_')\n      .replace(/,/g, '_')\n      .replace(/-/g, '_')\n      .replace(/\\./g, '_')\n      .replace(/\\$/g, '_')\n      .replace(/'/g, '_')\n      .replace(/&/g, '_')\n      .replace(/%/g, '_')\n      .replace(/\\//g, '_')\n      .replace(/\\|/g, '_')\n      .toLowerCase()\n  )\n}\n\n/**\n * Helper function that converts a Vensim variable name (possibly containing\n * subscripts) into a valid C identifier as used by SDE.\n * TODO: Import helper function from `compile` package instead\n */\nexport function sdeNameForVensimVarName(varName: string): string {\n  const m = varName.match(/([^[]+)(?:\\[([^\\]]+)\\])?/)\n  if (!m) {\n    throw new Error(`Invalid Vensim name: ${varName}`)\n  }\n  let id = sdeNameForVensimName(m[1])\n  if (m[2]) {\n    const subscripts = m[2].split(',').map(x => sdeNameForVensimName(x))\n    id += `[${subscripts.join('][')}]`\n  }\n\n  return id\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACEA,mBAAoD;AAEpD,kBAAsB;;;ACFtB,kBAAgD;AAChD,iBAA8B;AAG9B,iCAA4B;;;ACC5B,8BAA8B,MAAsB;AAClD,SACE,MACA,KACG,KAAK,EACL,QAAQ,MAAM,GAAG,EACjB,QAAQ,UAAU,GAAG,EACrB,QAAQ,OAAO,GAAG,EAClB,QAAQ,MAAM,GAAG,EACjB,QAAQ,MAAM,GAAG,EACjB,QAAQ,OAAO,GAAG,EAClB,QAAQ,OAAO,GAAG,EAClB,QAAQ,MAAM,GAAG,EACjB,QAAQ,MAAM,GAAG,EACjB,QAAQ,MAAM,GAAG,EACjB,QAAQ,OAAO,GAAG,EAClB,QAAQ,OAAO,GAAG,EAClB,YAAY;AAEnB;AAOO,iCAAiC,SAAyB;AAC/D,QAAM,IAAI,QAAQ,MAAM,0BAA0B;AAClD,MAAI,CAAC,GAAG;AACN,UAAM,IAAI,MAAM,wBAAwB,SAAS;AAAA,EACnD;AACA,MAAI,KAAK,qBAAqB,EAAE,EAAE;AAClC,MAAI,EAAE,IAAI;AACR,UAAM,aAAa,EAAE,GAAG,MAAM,GAAG,EAAE,IAAI,OAAK,qBAAqB,CAAC,CAAC;AACnE,UAAM,IAAI,WAAW,KAAK,IAAI;AAAA,EAChC;AAEA,SAAO;AACT;;;AD7CA;AAYA,IAAM,aAAa,8BAAc,YAAY,GAAG;AAChD,IAAM,YAAY,yBAAQ,UAAU;AAYpC,yBAAyB,WAAkC;AACzD,QAAM,eAAe,UAAU,QAAQ,IAAI,OAAK,wBAAwB,EAAE,OAAO,CAAC;AAElF,QAAM,YAAY;AAAA,2BACO,UAAU;AAAA,yBACZ,UAAU;AAAA,2BACR,UAAU,OAAO;AAAA,8BACd,KAAK,UAAU,YAAY;AAAA;AAGvD,QAAM,kBAAkB;AACxB,QAAM,0BAA0B,OAAO;AAEvC,SAAO;AAAA,IACL,MAAM;AAAA,IACN,UAAU,IAAY;AACpB,UAAI,OAAO,iBAAiB;AAC1B,eAAO;AAAA,MACT;AAAA,IACF;AAAA,IACA,KAAK,IAAY;AACf,UAAI,OAAO,yBAAyB;AAClC,eAAO;AAAA,MACT;AAAA,IACF;AAAA,EACF;AACF;AAaO,0BACL,gBACA,aACA,WACA,YACc;AAEd,QAAM,OAAO;AAGb,QAAM,QAAQ,yBAAY,WAAW,MAAM,mBAAmB,WAAW;AAEzE,SAAO;AAAA,IAEL,YAAY;AAAA,IAGZ;AAAA,IAGA,aAAa;AAAA,IAIb,UAAU;AAAA,IAGV,SAAS;AAAA,MACP,OAAO;AAAA,QAGL;AAAA,UACE,MAAM;AAAA,UACN,aAAa,yBAAY,gBAAgB,WAAW;AAAA,QACtD;AAAA,QAOA;AAAA,UACE,MAAM;AAAA,UACN,aAAa;AAAA,UACb,gBAAgB,4CAAY,EAAE,SAAS,MAAM,CAAC;AAAA,QAChD;AAAA,MACF;AAAA,IACF;AAAA,IAEA,SAAS;AAAA,MAEP,gBAAgB,SAAS;AAAA,IAC3B;AAAA,IAEA,OAAO;AAAA,MAGL,QAAQ;AAAA,MACR,aAAa;AAAA,MAEb,KAAK;AAAA,QACH;AAAA,QACA,MAAM;AAAA,QACN,SAAS,CAAC,MAAM;AAAA,QAChB,UAAU,MAAM;AAAA,MAClB;AAAA,MAEA,eAAe;AAAA,QACb,QAAQ,CAAC,SAAS,SAAS;AAMzB,cAAI,QAAQ,SAAS,QAAQ;AAC3B,iBAAK,OAAO;AAAA,UACd;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;;;ADtIO,sBAAsB,SAAuC;AAClE,SAAO,IAAI,aAAa,OAAO;AACjC;AAEA,IAAM,eAAN,MAAqC;AAAA,EACnC,YAA6B,SAA+B;AAA/B;AAAA,EAAgC;AAAA,EAE7D,MAAM,aAAa,SAAuB,WAAwC;AAlBpF;AAmBI,UAAM,MAAM,QAAQ;AACpB,QAAI,QAAQ,iBAAiB;AAK7B,UAAM,UAAU,QAAQ,OAAO;AAC/B,UAAM,SAAS;AACf,UAAM,iBAAiB,uBAAS,SAAS,UAAU,MAAM;AACzD,UAAM,gBAAgB;AACtB,UAAM,kBAAkB;AAGxB,UAAM,cAAc,YAAK,YAAL,mBAAc,gBAAe,CAAC,uBAAS,SAAS,eAAe,CAAC;AASpF,eAAW,cAAc,aAAa;AACpC,YAAM,SAAS,0BAAQ,UAAU;AACjC,YAAM,UAAU,2BAAS,UAAU;AACnC,cAAQ,kBAAkB,QAAQ,iBAAiB,QAAQ,OAAO;AAAA,IACpE;AAGA,UAAM,aAAa,iBAAiB,gBAAgB,eAAe,WAAW,eAAe;AAC7F,UAAM,uBAAM,UAAU;AAItB,WAAO;AAAA,EACT;AACF;","names":[]}

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+import { Plugin } from '@sdeverywhere/build';
+
+interface WorkerPluginOptions {
+    /**
+     * The destination paths for the generated worker JS files.  If undefined,
+     * a `worker.js` file will be written to the configured `prepDir`.
+     */
+    outputPaths?: string[];
+}
+
+declare function workerPlugin(options?: WorkerPluginOptions): Plugin;
+
+export { WorkerPluginOptions, workerPlugin };

package/dist/index.js

@@ -0,0 +1,129 @@
+// src/plugin.ts
+import { basename, dirname as dirname2, join as joinPath } from "path";
+import { build } from "vite";
+
+// src/vite-config.ts
+import { dirname, resolve as resolvePath } from "path";
+import { fileURLToPath } from "url";
+import { nodeResolve } from "@rollup/plugin-node-resolve";
+
+// src/var-names.ts
+function sdeNameForVensimName(name) {
+  return "_" + name.trim().replace(/"/g, "_").replace(/\s+!$/g, "!").replace(/\s/g, "_").replace(/,/g, "_").replace(/-/g, "_").replace(/\./g, "_").replace(/\$/g, "_").replace(/'/g, "_").replace(/&/g, "_").replace(/%/g, "_").replace(/\//g, "_").replace(/\|/g, "_").toLowerCase();
+}
+function sdeNameForVensimVarName(varName) {
+  const m = varName.match(/([^[]+)(?:\[([^\]]+)\])?/);
+  if (!m) {
+    throw new Error(`Invalid Vensim name: ${varName}`);
+  }
+  let id = sdeNameForVensimName(m[1]);
+  if (m[2]) {
+    const subscripts = m[2].split(",").map((x) => sdeNameForVensimName(x));
+    id += `[${subscripts.join("][")}]`;
+  }
+  return id;
+}
+
+// src/vite-config.ts
+var __filename = fileURLToPath(import.meta.url);
+var __dirname = dirname(__filename);
+function injectModelSpec(modelSpec) {
+  const outputVarIds = modelSpec.outputs.map((o) => sdeNameForVensimVarName(o.varName));
+  const moduleSrc = `
+export const startTime = ${modelSpec.startTime};
+export const endTime = ${modelSpec.endTime};
+export const numInputs = ${modelSpec.inputs.length};
+export const outputVarIds = ${JSON.stringify(outputVarIds)};
+`;
+  const virtualModuleId = "virtual:model-spec";
+  const resolvedVirtualModuleId = "\0" + virtualModuleId;
+  return {
+    name: "vite-plugin-virtual-custom",
+    resolveId(id) {
+      if (id === virtualModuleId) {
+        return resolvedVirtualModuleId;
+      }
+    },
+    load(id) {
+      if (id === resolvedVirtualModuleId) {
+        return moduleSrc;
+      }
+    }
+  };
+}
+function createViteConfig(stagedModelDir, modelJsFile, modelSpec, outputFile) {
+  const root = stagedModelDir;
+  const entry = resolvePath(__dirname, "..", "template-worker", "worker.js");
+  return {
+    configFile: false,
+    root,
+    clearScreen: false,
+    logLevel: "silent",
+    resolve: {
+      alias: [
+        {
+          find: "@_wasm_",
+          replacement: resolvePath(stagedModelDir, modelJsFile)
+        },
+        {
+          find: "threads",
+          replacement: "threads",
+          customResolver: nodeResolve({ browser: false })
+        }
+      ]
+    },
+    plugins: [
+      injectModelSpec(modelSpec)
+    ],
+    build: {
+      outDir: ".",
+      emptyOutDir: false,
+      lib: {
+        entry,
+        name: "worker",
+        formats: ["iife"],
+        fileName: () => outputFile
+      },
+      rollupOptions: {
+        onwarn: (warning, warn) => {
+          if (warning.code !== "EVAL") {
+            warn(warning);
+          }
+        }
+      }
+    }
+  };
+}
+
+// src/plugin.ts
+function workerPlugin(options) {
+  return new WorkerPlugin(options);
+}
+var WorkerPlugin = class {
+  constructor(options) {
+    this.options = options;
+  }
+  async postGenerate(context, modelSpec) {
+    var _a;
+    const log = context.log;
+    log("info", "Building worker");
+    const prepDir = context.config.prepDir;
+    const srcDir = "model";
+    const stagedModelDir = joinPath(prepDir, "staged", srcDir);
+    const inModelJsFile = "wasm-model.js";
+    const outWorkerJsFile = "worker.js";
+    const outputPaths = ((_a = this.options) == null ? void 0 : _a.outputPaths) || [joinPath(prepDir, outWorkerJsFile)];
+    for (const outputPath of outputPaths) {
+      const dstDir = dirname2(outputPath);
+      const dstFile = basename(outputPath);
+      context.prepareStagedFile(srcDir, outWorkerJsFile, dstDir, dstFile);
+    }
+    const viteConfig = createViteConfig(stagedModelDir, inModelJsFile, modelSpec, outWorkerJsFile);
+    await build(viteConfig);
+    return true;
+  }
+};
+export {
+  workerPlugin
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/plugin.ts","../src/vite-config.ts","../src/var-names.ts"],"sourcesContent":["// Copyright (c) 2022 Climate Interactive / New Venture Fund\n\nimport { basename, dirname, join as joinPath } from 'path'\n\nimport { build } from 'vite'\n\nimport type { BuildContext, ModelSpec, Plugin } from '@sdeverywhere/build'\n\nimport type { WorkerPluginOptions } from './options'\nimport { createViteConfig } from './vite-config'\n\nexport function workerPlugin(options?: WorkerPluginOptions): Plugin {\n  return new WorkerPlugin(options)\n}\n\nclass WorkerPlugin implements Plugin {\n  constructor(private readonly options?: WorkerPluginOptions) {}\n\n  async postGenerate(context: BuildContext, modelSpec: ModelSpec): Promise<boolean> {\n    const log = context.log\n    log('info', 'Building worker')\n\n    // Locate the input (model JS/Wasm) file in the staged directory.  Note\n    // that this relies on the `plugin-wasm` package writing a file called\n    // `wasm-model.js` to the `staged/model` directory.\n    const prepDir = context.config.prepDir\n    const srcDir = 'model'\n    const stagedModelDir = joinPath(prepDir, 'staged', srcDir)\n    const inModelJsFile = 'wasm-model.js'\n    const outWorkerJsFile = 'worker.js'\n\n    // If `outputPaths` is undefined, write the `worker.js` to the prep dir\n    const outputPaths = this.options?.outputPaths || [joinPath(prepDir, outWorkerJsFile)]\n\n    // Add staged file entries; this will cause the generated worker to be copied\n    // to the configured output paths during the \"copy staged files\" step\n    // TODO: This assumes that other plugins that use the generated worker files\n    // will run after the \"copy staged files\" step.  There might be use cases\n    // where a plugin needs access to these in `postGenerate`, in which case the\n    // files will not have been copied already.  Need to reconsider the ordering\n    // of plugins and the \"copy staged files\" step(s).\n    for (const outputPath of outputPaths) {\n      const dstDir = dirname(outputPath)\n      const dstFile = basename(outputPath)\n      context.prepareStagedFile(srcDir, outWorkerJsFile, dstDir, dstFile)\n    }\n\n    // Build the worker and write generated file to the `staged/model` directory\n    const viteConfig = createViteConfig(stagedModelDir, inModelJsFile, modelSpec, outWorkerJsFile)\n    await build(viteConfig)\n\n    // log('info', 'Done!')\n\n    return true\n  }\n}\n","// Copyright (c) 2022 Climate Interactive / New Venture Fund\n\nimport { dirname, resolve as resolvePath } from 'path'\nimport { fileURLToPath } from 'url'\n\nimport type { InlineConfig, Plugin as VitePlugin, ResolverObject } from 'vite'\nimport { nodeResolve } from '@rollup/plugin-node-resolve'\n\nimport type { ModelSpec } from '@sdeverywhere/build'\n\nimport { sdeNameForVensimVarName } from './var-names'\n\nconst __filename = fileURLToPath(import.meta.url)\nconst __dirname = dirname(__filename)\n\n/**\n * This is a virtual module plugin used to inject model-specific configuration\n * values into the generated worker bundle.\n *\n * This follows the \"Virtual Modules Convention\" described here:\n *   https://vitejs.dev/guide/api-plugin.html#virtual-modules-convention\n *\n * TODO: This could be simplified by using `vite-plugin-virtual` but that\n * doesn't seem to be working correctly in an ESM setting\n */\nfunction injectModelSpec(modelSpec: ModelSpec): VitePlugin {\n  const outputVarIds = modelSpec.outputs.map(o => sdeNameForVensimVarName(o.varName))\n\n  const moduleSrc = `\nexport const startTime = ${modelSpec.startTime};\nexport const endTime = ${modelSpec.endTime};\nexport const numInputs = ${modelSpec.inputs.length};\nexport const outputVarIds = ${JSON.stringify(outputVarIds)};\n`\n\n  const virtualModuleId = 'virtual:model-spec'\n  const resolvedVirtualModuleId = '\\0' + virtualModuleId\n\n  return {\n    name: 'vite-plugin-virtual-custom',\n    resolveId(id: string) {\n      if (id === virtualModuleId) {\n        return resolvedVirtualModuleId\n      }\n    },\n    load(id: string) {\n      if (id === resolvedVirtualModuleId) {\n        return moduleSrc\n      }\n    }\n  }\n}\n\n/**\n * Create a Vite `InlineConfig` that can be used to build a complete\n * worker bundle that can run the generated Wasm model in a separate\n * Web Worker or Node worker thread.\n *\n * @param stagedModelDir The `staged` directory under the `sde-prep` directory.\n * @param modelJsFile The name of the JS file containing the embedded Wasm.\n * @param modelSpec The model spec generated earlier in the build process.\n * @param outputFile The name of the generated worker JS file.\n * @return An `InlineConfig` instance that can be passed to Vite's `build` function.\n */\nexport function createViteConfig(\n  stagedModelDir: string,\n  modelJsFile: string,\n  modelSpec: ModelSpec,\n  outputFile: string\n): InlineConfig {\n  // Use `staged/model` as the root directory for the worker build\n  const root = stagedModelDir\n\n  // Use `template-worker/worker.js` from this package as the entry file\n  const entry = resolvePath(__dirname, '..', 'template-worker', 'worker.js')\n\n  return {\n    // Don't use an external config file\n    configFile: false,\n\n    // Use the root directory configured above\n    root,\n\n    // Don't clear the screen in dev mode so that we can see builder output\n    clearScreen: false,\n\n    // Disable vite output by default\n    // TODO: Re-enable logging if `--verbose` option is used?\n    logLevel: 'silent',\n\n    // Configure path aliases\n    resolve: {\n      alias: [\n        // In the template, we use `@_wasm_` as an alias for the JS-wrapped Wasm\n        // file generated by Emscripten\n        {\n          find: '@_wasm_',\n          replacement: resolvePath(stagedModelDir, modelJsFile)\n        },\n\n        // XXX: Prevent Vite from using the `browser` section of `threads/package.json`\n        // since we want to force the use of the general module (under dist) that chooses\n        // the correct implementation (Web Worker vs worker_threads) at runtime.  Currently\n        // Vite's library mode is browser focused, so using a `customResolver` seems to be\n        // the easiest way to prevent Vite from picking up the `browser` exports.\n        {\n          find: 'threads',\n          replacement: 'threads',\n          customResolver: nodeResolve({ browser: false }) as ResolverObject\n        }\n      ]\n    },\n\n    plugins: [\n      // Use a virtual module plugin to inject the model spec values\n      injectModelSpec(modelSpec)\n    ],\n\n    build: {\n      // Write output file to the `staged/model` directory; note that this path is\n      // relative to the bundle `root` directory\n      outDir: '.',\n      emptyOutDir: false,\n\n      lib: {\n        entry,\n        name: 'worker',\n        formats: ['iife'],\n        fileName: () => outputFile\n      },\n\n      rollupOptions: {\n        onwarn: (warning, warn) => {\n          // XXX: Suppress \"Use of eval is strongly discouraged\" warnings that are\n          // triggered by use of the following pattern in threads.js:\n          //   eval(\"require\")(\"worker_threads\")\n          // It would be nice to avoid use of `eval` there, but it's not critical for\n          // our use case so we will suppress the warnings for now\n          if (warning.code !== 'EVAL') {\n            warn(warning)\n          }\n        }\n      }\n    }\n  }\n}\n","// Copyright (c) 2022 Climate Interactive / New Venture Fund\n\n/**\n * Helper function that converts a Vensim variable or subscript name\n * into a valid C identifier as used by SDE.\n * TODO: Import helper function from `compile` package instead\n */\nfunction sdeNameForVensimName(name: string): string {\n  return (\n    '_' +\n    name\n      .trim()\n      .replace(/\"/g, '_')\n      .replace(/\\s+!$/g, '!')\n      .replace(/\\s/g, '_')\n      .replace(/,/g, '_')\n      .replace(/-/g, '_')\n      .replace(/\\./g, '_')\n      .replace(/\\$/g, '_')\n      .replace(/'/g, '_')\n      .replace(/&/g, '_')\n      .replace(/%/g, '_')\n      .replace(/\\//g, '_')\n      .replace(/\\|/g, '_')\n      .toLowerCase()\n  )\n}\n\n/**\n * Helper function that converts a Vensim variable name (possibly containing\n * subscripts) into a valid C identifier as used by SDE.\n * TODO: Import helper function from `compile` package instead\n */\nexport function sdeNameForVensimVarName(varName: string): string {\n  const m = varName.match(/([^[]+)(?:\\[([^\\]]+)\\])?/)\n  if (!m) {\n    throw new Error(`Invalid Vensim name: ${varName}`)\n  }\n  let id = sdeNameForVensimName(m[1])\n  if (m[2]) {\n    const subscripts = m[2].split(',').map(x => sdeNameForVensimName(x))\n    id += `[${subscripts.join('][')}]`\n  }\n\n  return id\n}\n"],"mappings":";AAEA;AAEA;;;ACFA;AACA;AAGA;;;ACCA,8BAA8B,MAAsB;AAClD,SACE,MACA,KACG,KAAK,EACL,QAAQ,MAAM,GAAG,EACjB,QAAQ,UAAU,GAAG,EACrB,QAAQ,OAAO,GAAG,EAClB,QAAQ,MAAM,GAAG,EACjB,QAAQ,MAAM,GAAG,EACjB,QAAQ,OAAO,GAAG,EAClB,QAAQ,OAAO,GAAG,EAClB,QAAQ,MAAM,GAAG,EACjB,QAAQ,MAAM,GAAG,EACjB,QAAQ,MAAM,GAAG,EACjB,QAAQ,OAAO,GAAG,EAClB,QAAQ,OAAO,GAAG,EAClB,YAAY;AAEnB;AAOO,iCAAiC,SAAyB;AAC/D,QAAM,IAAI,QAAQ,MAAM,0BAA0B;AAClD,MAAI,CAAC,GAAG;AACN,UAAM,IAAI,MAAM,wBAAwB,SAAS;AAAA,EACnD;AACA,MAAI,KAAK,qBAAqB,EAAE,EAAE;AAClC,MAAI,EAAE,IAAI;AACR,UAAM,aAAa,EAAE,GAAG,MAAM,GAAG,EAAE,IAAI,OAAK,qBAAqB,CAAC,CAAC;AACnE,UAAM,IAAI,WAAW,KAAK,IAAI;AAAA,EAChC;AAEA,SAAO;AACT;;;ADjCA,IAAM,aAAa,cAAc,YAAY,GAAG;AAChD,IAAM,YAAY,QAAQ,UAAU;AAYpC,yBAAyB,WAAkC;AACzD,QAAM,eAAe,UAAU,QAAQ,IAAI,OAAK,wBAAwB,EAAE,OAAO,CAAC;AAElF,QAAM,YAAY;AAAA,2BACO,UAAU;AAAA,yBACZ,UAAU;AAAA,2BACR,UAAU,OAAO;AAAA,8BACd,KAAK,UAAU,YAAY;AAAA;AAGvD,QAAM,kBAAkB;AACxB,QAAM,0BAA0B,OAAO;AAEvC,SAAO;AAAA,IACL,MAAM;AAAA,IACN,UAAU,IAAY;AACpB,UAAI,OAAO,iBAAiB;AAC1B,eAAO;AAAA,MACT;AAAA,IACF;AAAA,IACA,KAAK,IAAY;AACf,UAAI,OAAO,yBAAyB;AAClC,eAAO;AAAA,MACT;AAAA,IACF;AAAA,EACF;AACF;AAaO,0BACL,gBACA,aACA,WACA,YACc;AAEd,QAAM,OAAO;AAGb,QAAM,QAAQ,YAAY,WAAW,MAAM,mBAAmB,WAAW;AAEzE,SAAO;AAAA,IAEL,YAAY;AAAA,IAGZ;AAAA,IAGA,aAAa;AAAA,IAIb,UAAU;AAAA,IAGV,SAAS;AAAA,MACP,OAAO;AAAA,QAGL;AAAA,UACE,MAAM;AAAA,UACN,aAAa,YAAY,gBAAgB,WAAW;AAAA,QACtD;AAAA,QAOA;AAAA,UACE,MAAM;AAAA,UACN,aAAa;AAAA,UACb,gBAAgB,YAAY,EAAE,SAAS,MAAM,CAAC;AAAA,QAChD;AAAA,MACF;AAAA,IACF;AAAA,IAEA,SAAS;AAAA,MAEP,gBAAgB,SAAS;AAAA,IAC3B;AAAA,IAEA,OAAO;AAAA,MAGL,QAAQ;AAAA,MACR,aAAa;AAAA,MAEb,KAAK;AAAA,QACH;AAAA,QACA,MAAM;AAAA,QACN,SAAS,CAAC,MAAM;AAAA,QAChB,UAAU,MAAM;AAAA,MAClB;AAAA,MAEA,eAAe;AAAA,QACb,QAAQ,CAAC,SAAS,SAAS;AAMzB,cAAI,QAAQ,SAAS,QAAQ;AAC3B,iBAAK,OAAO;AAAA,UACd;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;;;ADtIO,sBAAsB,SAAuC;AAClE,SAAO,IAAI,aAAa,OAAO;AACjC;AAEA,IAAM,eAAN,MAAqC;AAAA,EACnC,YAA6B,SAA+B;AAA/B;AAAA,EAAgC;AAAA,EAE7D,MAAM,aAAa,SAAuB,WAAwC;AAlBpF;AAmBI,UAAM,MAAM,QAAQ;AACpB,QAAI,QAAQ,iBAAiB;AAK7B,UAAM,UAAU,QAAQ,OAAO;AAC/B,UAAM,SAAS;AACf,UAAM,iBAAiB,SAAS,SAAS,UAAU,MAAM;AACzD,UAAM,gBAAgB;AACtB,UAAM,kBAAkB;AAGxB,UAAM,cAAc,YAAK,YAAL,mBAAc,gBAAe,CAAC,SAAS,SAAS,eAAe,CAAC;AASpF,eAAW,cAAc,aAAa;AACpC,YAAM,SAAS,SAAQ,UAAU;AACjC,YAAM,UAAU,SAAS,UAAU;AACnC,cAAQ,kBAAkB,QAAQ,iBAAiB,QAAQ,OAAO;AAAA,IACpE;AAGA,UAAM,aAAa,iBAAiB,gBAAgB,eAAe,WAAW,eAAe;AAC7F,UAAM,MAAM,UAAU;AAItB,WAAO;AAAA,EACT;AACF;","names":[]}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@sdeverywhere/plugin-worker",
+  "version": "0.1.0",
+  "files": [
+    "dist/**",
+    "template-worker/**"
+  ],
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "dependencies": {
+    "@rollup/plugin-node-resolve": "^13.3.0",
+    "@sdeverywhere/build": "^0.1.0",
+    "@sdeverywhere/runtime": "^0.1.0",
+    "@sdeverywhere/runtime-async": "^0.1.0",
+    "vite": "2.9.6"
+  },
+  "devDependencies": {
+    "@types/node": "^16.11.7"
+  },
+  "author": "Climate Interactive",
+  "license": "MIT",
+  "homepage": "https://sdeverywhere.org",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/climateinteractive/SDEverywhere.git",
+    "directory": "packages/plugin-worker"
+  },
+  "bugs": {
+    "url": "https://github.com/climateinteractive/SDEverywhere/issues"
+  },
+  "scripts": {
+    "clean": "rm -rf dist",
+    "lint": "eslint src --ext .ts --max-warnings 0",
+    "prettier:check": "prettier --check .",
+    "prettier:fix": "prettier --write .",
+    "precommit": "../../scripts/precommit",
+    "test": "echo No tests yet",
+    "test:watch": "echo No tests yet",
+    "test:ci": "echo No tests yet",
+    "type-check": "tsc --noEmit -p tsconfig-build.json",
+    "build": "tsup",
+    "ci:build": "run-s clean lint prettier:check test:ci type-check build"
+  }
+}

package/template-worker/worker.js

@@ -0,0 +1,21 @@
+// Copyright (c) 2022 Climate Interactive / New Venture Fund
+
+import { initWasmModelAndBuffers } from '@sdeverywhere/runtime'
+
+// NOTE: This import *must* specify "worker" at the end (instead of the general
+// "index" import), otherwise Vite will pull in more code than necessary and it will
+// generate a worker that won't run correctly in Node or the browser.
+import { exposeModelWorker } from '@sdeverywhere/runtime-async/worker'
+
+import { startTime, endTime, numInputs, outputVarIds } from 'virtual:model-spec'
+import loadWasmModule from '@_wasm_'
+
+async function initWasmModel() {
+  // Load the wasm module asynchronously
+  const wasmModule = await loadWasmModule()
+
+  // Initialize the wasm model and its associated buffers
+  return initWasmModelAndBuffers(wasmModule, numInputs, outputVarIds, startTime, endTime)
+}
+
+exposeModelWorker(initWasmModel)