@storm-stack/core/dist/chunk-UG6GPHQZ.cjs.map

A build toolkit and runtime used by Storm Software in TypeScript applications

{"version":3,"sources":["../../src/lib/utilities/worker.ts"],"names":["RESTARTED","Symbol","cleanupWorkers","worker","curWorker","_workerPool","_workers","_child","kill","Worker","workerPath","options","timeout","onRestart","name","context","farmOptions","createLog","restartPromise","resolveRestartPromise","activeTasks","undefined","process","on","close","createWorker","__name","JestWorker","forkOptions","env","STORM_STACK_LOCAL","maxRetries","Promise","resolve","enableWorkerThreads","code","signal","LogLevelLabel","ERROR","exit","data","type","onActivity","aborted","onActivityAbort","abortActivityStreamOnLog","Transform","transform","_chunk","_encoding","callback","getStdout","pipe","getStderr","stdout","stderr","onHanging","WARN","end","then","hangingTimer","clearTimeout","setTimeout","method","exposedMethods","startsWith","args","attempts","params","defu","length","result","race","bind","Error","numWorkers","findFileName","withExtension"],"mappings":";;;;;;;;;;AAuCA,IAAMA,SAAAA,GAAYC,OAAO,WAAA,CAAA;AAEzB,IAAMC,cAAAA,6CAAkBC,MAAAA,KAAAA;AACtB,EAAA,KAAA,MAAWC,SAAAA,IAAeD,MAAAA,CAAeE,WAAAA,EAAaC,QAAAA,IAAY,EAAA,EAE7D;AACHF,IAAAA,SAAAA,CAAUG,MAAAA,EAAQC,KAAK,QAAA,CAAA;AACzB,EAAA;AACF,CAAA,EANuB,gBAAA,CAAA;AAQhB,IAAMC,SAAN,MAAMA;EAjDb;;;;;AAkDE,EAAA,OAAA;AAEA,EAAA,IAAA;AAEA,EAAA,WAAA,CACYC,YACAC,OAAAA,EACV;SAFUD,UAAAA,GAAAA,UAAAA;SACAC,OAAAA,GAAAA,OAAAA;AAEV,IAAA,MAAM,EAAEC,SAASC,SAAAA,EAAWC,IAAAA,EAAMC,SAAS,GAAGC,WAAAA,KAAgB,IAAA,CAAKL,OAAAA;AAEnE,IAAA,IAAA,CAAK,IAAA,GAAOM,2BAAAA,CAAUH,IAAAA,IAAQJ,UAAAA,CAAAA;AAE9B,IAAA,IAAIQ,cAAAA;AACJ,IAAA,IAAIC,qBAAAA;AACJ,IAAA,IAAIC,WAAAA,GAAc,CAAA;AAElB,IAAA,IAAA,CAAK,OAAA,GAAUC,MAAAA;AAGfC,IAAAA,OAAAA,CAAQC,EAAAA,CAAG,QAAQ,MAAA;AACjB,MAAA,IAAA,CAAKC,KAAAA,EAAK;IACZ,CAAA,CAAA;AAEA,IAAA,MAAMC,gCAAeC,wBAAA,CAAA,MAAA;AACnB,MAAA,IAAA,CAAK,OAAA,GAAU,IAAIC,iBAAAA,CAAWjB,UAAAA,EAAY;QACxC,GAAGM,WAAAA;QACHY,WAAAA,EAAa;AACX,UAAA,GAAGZ,WAAAA,CAAYY,WAAAA;UACfC,GAAAA,EAAK;YACH,GAAKb,WAAAA,CAAYY,WAAAA,EAAaC,GAAAA,IAAO,EAAC;AACtC,YAAA,GAAGP,OAAAA,CAAQO,GAAAA;YACXC,iBAAAA,EAAmBR,OAAAA,CAAQO,IAAIC,iBAAAA,IAAqB;AACtD;AACF,SAAA;QACAC,UAAAA,EAAY;OACd,CAAA;AACAb,MAAAA,cAAAA,GAAiB,IAAIc,OAAAA,CAAQC,CAAAA,OAAAA,KAAAA;AAC3Bd,QAAAA,qBAAAA,GAAwBc,OAAAA;MAC1B,CAAA,CAAA;AAWA,MAAA,IAAI,CAACjB,YAAYkB,mBAAAA,EAAqB;AACpC,QAAA,KAAA,MAAW/B,UAAY,IAAA,CAAK,OAAA,CAAgBE,WAAAA,EAAaC,QAAAA,IACvD,EAAA,EAEG;AACHH,UAAAA,MAAAA,CAAOI,MAAAA,EAAQgB,EAAAA,CAAG,MAAA,EAAQ,CAACY,MAAMC,MAAAA,KAAAA;AAC/B,YAAA,IAAA,CAAKD,IAAAA,IAASC,MAAAA,IAAUA,MAAAA,KAAW,QAAA,KAAc,KAAK,OAAA,EAAS;AAC7D,cAAA,IAAA,CAAK,IAAA,CACHC,mBAAAA,CAAcC,KAAAA,EACd,CAAA,EAAG,IAAA,CAAK3B,OAAAA,CAAQG,IAAI,CAAA,0BAAA,EAA6BqB,IAAAA,CAAAA,aAAAA,EAAoBC,MAAAA,CAAAA,CAAQ,CAAA;AAI/Ed,cAAAA,OAAAA,CAAQiB,IAAAA,CAAKJ,QAAQ,CAAA,CAAA;AACvB,YAAA;UACF,CAAA,CAAA;AAIAhC,UAAAA,MAAAA,CAAOI,QAAQgB,EAAAA,CAAG,SAAA,EAAW,CAAC,GAAGiB,IAAAA,CAAAA,KAAwB;AACvD,YAAA,IACEA,IAAAA,IACA,OAAOA,IAAAA,KAAS,QAAA,IAChB,UAAUA,IAAAA,IACVA,IAAAA,CAAKC,SAAS,UAAA,EACd;AAEAC,cAAAA,UAAAA,EAAAA;AACF,YAAA;UACF,CAAA,CAAA;AACF,QAAA;AACF,MAAA;AAEA,MAAA,IAAIC,OAAAA,GAAU,KAAA;AACd,MAAA,MAAMC,kCAAkBlB,wBAAA,CAAA,MAAA;AACtB,QAAA,IAAI,CAACiB,OAAAA,EAAS;AACZ,UAAA,IAAA,CAAKhC,QAAQiC,eAAAA,IAAe;AAC5BD,UAAAA,OAAAA,GAAU,IAAA;AACZ,QAAA;MACF,CAAA,EALwB,iBAAA,CAAA;AAQxB,MAAA,MAAME,wBAAAA,GAA2B,IAAIC,gBAAAA,CAAU;QAC7CC,SAAAA,CAAUC,MAAAA,EAAQC,WAAWC,QAAAA,EAAQ;AACnCN,UAAAA,eAAAA,EAAAA;AACAM,UAAAA,QAAAA,EAAAA;AACF,QAAA;OACF,CAAA;AAEA,MAAA,IAAA,CAAK,OAAA,CAAQC,SAAAA,EAAS,CAAGC,IAAAA,CAAKP,wBAAAA,CAAAA;AAC9B,MAAA,IAAA,CAAK,OAAA,CAAQQ,SAAAA,EAAS,CAAGD,IAAAA,CAAKP,wBAAAA,CAAAA;AAG9B,MAAA,IAAA,CAAK,OAAA,CAAQM,SAAAA,EAAS,CAAGC,IAAAA,CAAK9B,QAAQgC,MAAM,CAAA;AAC5C,MAAA,IAAA,CAAK,OAAA,CAAQD,SAAAA,EAAS,CAAGD,IAAAA,CAAK9B,QAAQiC,MAAM,CAAA;IAC9C,CAAA,EAjFqB,cAAA,CAAA;AAkFrB9B,IAAAA,aAAAA,EAAAA;AAEA,IAAA,MAAM+B,4BAAY9B,wBAAA,CAAA,MAAA;AAChB,MAAA,MAAMvB,SAAS,IAAA,CAAK,OAAA;AACpB,MAAA,IAAI,CAACA,MAAAA,EAAQ;AACX,QAAA;AACF,MAAA;AAEA,MAAA,MAAM8B,OAAAA,GAAUd,qBAAAA;AAChBM,MAAAA,aAAAA,EAAAA;AAEA,MAAA,IAAA,CAAK,IAAA,CACHY,mBAAAA,CAAcoB,IAAAA,EACd,CAAA,sDAAA,EACE7C,OAAAA,GAAU,OAAOA,OAAAA,GAAU,GAAA,CAAA,QAAA,CAAA,GAAiB,EAAA,CAAA,0DAAA,CACc,CAAA;AAG9D,MAAA,KAAKT,MAAAA,CAAOuD,GAAAA,EAAG,CAAGC,IAAAA,CAAK,MAAA;AACrB1B,QAAAA,OAAAA,CAAQjC,SAAAA,CAAAA;MACV,CAAA,CAAA;IACF,CAAA,EAnBkB,WAAA,CAAA;AAqBlB,IAAA,IAAI4D,YAAAA,GAAuC,KAAA;AAE3C,IAAA,MAAMlB,6BAAahB,wBAAA,CAAA,MAAA;AACjB,MAAA,IAAIkC,YAAAA,EAAc;AAChBC,QAAAA,YAAAA,CAAaD,YAAAA,CAAAA;AACf,MAAA;AACA,MAAA,IAAI,IAAA,CAAKjD,QAAQ+B,UAAAA,EAAY;AAC3B,QAAA,IAAA,CAAK/B,QAAQ+B,UAAAA,EAAU;AACzB,MAAA;AAEAkB,MAAAA,YAAAA,GAAexC,WAAAA,GAAc,CAAA,IAAK0C,UAAAA,CAAWN,SAAAA,EAAW5C,OAAAA,CAAAA;IAC1D,CAAA,EATmB,YAAA,CAAA;AAWnB,IAAA,KAAA,MAAWmD,MAAAA,IAAU/C,YAAYgD,cAAAA,EAAgB;AAC/C,MAAA,IAAID,MAAAA,CAAOE,UAAAA,CAAW,GAAA,CAAA,EAAM;AAC1B,QAAA;AACF,MAAA;AAEC,MAAA,IAAA,CAAaF,MAAAA,CAAAA,GAAUnD,OAAAA,GACpB,OAAA,GAAUsD,IAAAA,KAAAA;AACR9C,QAAAA,WAAAA,EAAAA;AACA,QAAA,IAAI;AACF,UAAA,IAAI+C,QAAAA,GAAW,CAAA;AACf,UAAA,WAAS;AACPzB,YAAAA,UAAAA,EAAAA;AAEA,YAAA,MAAM0B,MAAAA,GAASC,SAAAA,CACbH,IAAAA,CAAKI,MAAAA,GAAS,KAAKJ,IAAAA,CAAK,CAAA,CAAA,GAAKA,IAAAA,CAAK,CAAA,CAAA,GAAK,EAAC,EACxCnD,OAAAA,IAAW,EAAC,CAAA;AAGd,YAAA,MAAMwD,MAAAA,GAAS,MAAMvC,OAAAA,CAAQwC,IAAAA,CAAK;;AAE/B,cAAA,IAAA,CAAK,OAAA,CAAgBT,MAAAA,CAAAA,CAAO,GAAIK,MAAAA,CAAAA;AACjClD,cAAAA;AACD,aAAA,CAAA;AACD,YAAA,IAAIqD,WAAWvE,SAAAA,EAAW;AACxB,cAAA,OAAOuE,MAAAA;AACT,YAAA;AACA,YAAA,IAAI1D,SAAAA,EAAW;AACbA,cAAAA,SAAAA,CAAUkD,MAAAA,EAAQG,IAAAA,EAAM,EAAEC,QAAAA,CAAAA;AAC5B,YAAA;AACF,UAAA;QACF,CAAA,SAAA;AACE/C,UAAAA,WAAAA,EAAAA;AACAsB,UAAAA,UAAAA,EAAAA;AACF,QAAA;AACF,MAAA,CAAA,GAEC,KAAK,OAAA,CAAgBqB,MAAAA,CAAAA,CAAQU,IAAAA,CAAK,KAAK,OAAO,CAAA;AACrD,IAAA;AACF,EAAA;AAEA,EAAA,MAAaf,GAAAA,GAAqC;AAChD,IAAA,MAAMvD,SAAS,IAAA,CAAK,OAAA;AACpB,IAAA,IAAI,CAACA,MAAAA,EAAQ;AACX,MAAA,MAAM,IAAIuE,MAAM,gDAAA,CAAA;AAClB,IAAA;AAEAxE,IAAAA,cAAAA,CAAeC,MAAAA,CAAAA;AACf,IAAA,IAAA,CAAK,OAAA,GAAUkB,MAAAA;AACf,IAAA,OAAOlB,OAAOuD,GAAAA,EAAG;AACnB,EAAA;;;;EAKOlC,KAAAA,GAAc;AACnB,IAAA,IAAI,KAAK,OAAA,EAAS;AAChBtB,MAAAA,cAAAA,CAAe,KAAK,OAAO,CAAA;AAC3B,MAAA,KAAK,IAAA,CAAK,QAAQwD,GAAAA,EAAG;AACvB,IAAA;AACF,EAAA;AACF;AAEO,SAASjC,YAAAA,CAGdf,UAAAA,EACAsD,cAAAA,EACAW,UAAAA,GAAa,CAAA,EAAC;AAEd,EAAA,OAAO,IAAIlE,OAAOC,UAAAA,EAAY;AAC5BI,IAAAA,IAAAA,EAAM8D,yBAAalE,UAAAA,EAAY;MAC7BmE,aAAAA,EAAe;KACjB,CAAA;AACAb,IAAAA,cAAAA;AACAW,IAAAA;GACF,CAAA;AACF;AAdgBlD,wBAAAA,CAAAA,YAAAA,EAAAA,cAAAA,CAAAA","file":"chunk-UG6GPHQZ.cjs","sourcesContent":["/* -------------------------------------------------------------------\n\n                  ⚡ Storm Software - Storm Stack\n\n This code was released as part of the Storm Stack project. Storm Stack\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/storm-stack.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/storm-stack\n Documentation:            https://docs.stormsoftware.com/projects/storm-stack\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { LogLevelLabel } from \"@storm-software/config-tools/types\";\nimport { findFileName } from \"@stryke/path/file-path-fns\";\nimport { defu } from \"defu\";\nimport { Worker as JestWorker } from \"jest-worker\";\nimport type { ChildProcess } from \"node:child_process\";\nimport { Transform } from \"node:stream\";\nimport { LogFn } from \"../../types/config\";\nimport { WorkerProcess } from \"../../types/context\";\nimport { createLog } from \"../logger\";\n\nexport type WorkerOptions = ConstructorParameters<typeof JestWorker>[1] & {\n  name?: string;\n  timeout?: number;\n  onActivity?: () => void;\n  onActivityAbort?: () => void;\n  onRestart?: (method: string, args: any[], attempts: number) => void;\n  exposedMethods: ReadonlyArray<string>;\n  enableWorkerThreads?: boolean;\n  context?: Record<string, any>;\n};\n\nconst RESTARTED = Symbol(\"restarted\");\n\nconst cleanupWorkers = (worker: JestWorker) => {\n  for (const curWorker of ((worker as any)._workerPool?._workers || []) as {\n    _child?: ChildProcess;\n  }[]) {\n    curWorker._child?.kill(\"SIGINT\");\n  }\n};\n\nexport class Worker {\n  #worker: JestWorker | undefined;\n\n  #log: LogFn;\n\n  public constructor(\n    protected workerPath: string,\n    protected options: WorkerOptions\n  ) {\n    const { timeout, onRestart, name, context, ...farmOptions } = this.options;\n\n    this.#log = createLog(name || workerPath);\n\n    let restartPromise: Promise<typeof RESTARTED>;\n    let resolveRestartPromise: (arg: typeof RESTARTED) => void;\n    let activeTasks = 0;\n\n    this.#worker = undefined;\n\n    // ensure we end workers if they weren't before exit\n    process.on(\"exit\", () => {\n      this.close();\n    });\n\n    const createWorker = () => {\n      this.#worker = new JestWorker(workerPath, {\n        ...farmOptions,\n        forkOptions: {\n          ...farmOptions.forkOptions,\n          env: {\n            ...((farmOptions.forkOptions?.env ?? {}) as any),\n            ...process.env,\n            STORM_STACK_LOCAL: process.env.STORM_STACK_LOCAL || \"0\"\n          }\n        },\n        maxRetries: 0\n      });\n      restartPromise = new Promise(resolve => {\n        resolveRestartPromise = resolve;\n      });\n\n      /**\n       * Jest Worker has two worker types, ChildProcessWorker (uses child_process) and NodeThreadWorker (uses worker_threads)\n       * Storm Stack uses ChildProcessWorker by default, but it can be switched to NodeThreadWorker with an experimental flag\n       *\n       * We only want to handle ChildProcessWorker's orphan process issue, so we access the private property \"_child\":\n       * https://github.com/facebook/jest/blob/b38d7d345a81d97d1dc3b68b8458b1837fbf19be/packages/jest-worker/src/workers/ChildProcessWorker.ts\n       *\n       * But this property is not available in NodeThreadWorker, so we need to check if we are using ChildProcessWorker\n       */\n      if (!farmOptions.enableWorkerThreads) {\n        for (const worker of ((this.#worker as any)._workerPool?._workers ||\n          []) as {\n          _child?: ChildProcess;\n        }[]) {\n          worker._child?.on(\"exit\", (code, signal) => {\n            if ((code || (signal && signal !== \"SIGINT\")) && this.#worker) {\n              this.#log(\n                LogLevelLabel.ERROR,\n                `${this.options.name} worker exited with code: ${code} and signal: ${signal}`\n              );\n\n              // if a child process doesn't exit gracefully, we want to bubble up the exit code to the parent process\n              process.exit(code ?? 1);\n            }\n          });\n\n          // if a child process emits a particular message, we track that as activity\n          // so the parent process can keep track of progress\n          worker._child?.on(\"message\", ([, data]: [number, unknown]) => {\n            if (\n              data &&\n              typeof data === \"object\" &&\n              \"type\" in data &&\n              data.type === \"activity\"\n            ) {\n              // eslint-disable-next-line ts/no-use-before-define\n              onActivity();\n            }\n          });\n        }\n      }\n\n      let aborted = false;\n      const onActivityAbort = () => {\n        if (!aborted) {\n          this.options.onActivityAbort?.();\n          aborted = true;\n        }\n      };\n\n      // Listen to the worker's stdout and stderr, if there's any thing logged, abort the activity first\n      const abortActivityStreamOnLog = new Transform({\n        transform(_chunk, _encoding, callback) {\n          onActivityAbort();\n          callback();\n        }\n      });\n      // Stop the activity if there's any output from the worker\n      this.#worker.getStdout().pipe(abortActivityStreamOnLog);\n      this.#worker.getStderr().pipe(abortActivityStreamOnLog);\n\n      // Pipe the worker's stdout and stderr to the parent process\n      this.#worker.getStdout().pipe(process.stdout);\n      this.#worker.getStderr().pipe(process.stderr);\n    };\n    createWorker();\n\n    const onHanging = () => {\n      const worker = this.#worker;\n      if (!worker) {\n        return;\n      }\n\n      const resolve = resolveRestartPromise;\n      createWorker();\n\n      this.#log(\n        LogLevelLabel.WARN,\n        `Sending SIGTERM signal to static worker due to timeout${\n          timeout ? ` of ${timeout / 1000} seconds` : \"\"\n        }. Subsequent errors may be a result of the worker exiting.`\n      );\n\n      void worker.end().then(() => {\n        resolve(RESTARTED);\n      });\n    };\n\n    let hangingTimer: NodeJS.Timeout | false = false;\n\n    const onActivity = () => {\n      if (hangingTimer) {\n        clearTimeout(hangingTimer);\n      }\n      if (this.options.onActivity) {\n        this.options.onActivity();\n      }\n\n      hangingTimer = activeTasks > 0 && setTimeout(onHanging, timeout);\n    };\n\n    for (const method of farmOptions.exposedMethods) {\n      if (method.startsWith(\"_\")) {\n        continue;\n      }\n\n      (this as any)[method] = timeout\n        ? async (...args: any[]) => {\n            activeTasks++;\n            try {\n              let attempts = 0;\n              for (;;) {\n                onActivity();\n\n                const params = defu(\n                  args.length > 0 && args[0] ? args[0] : {},\n                  context ?? {}\n                );\n\n                const result = await Promise.race([\n                  // eslint-disable-next-line ts/no-unsafe-call\n                  (this.#worker as any)[method](...params),\n                  restartPromise\n                ]);\n                if (result !== RESTARTED) {\n                  return result;\n                }\n                if (onRestart) {\n                  onRestart(method, args, ++attempts);\n                }\n              }\n            } finally {\n              activeTasks--;\n              onActivity();\n            }\n          }\n        : // eslint-disable-next-line ts/no-unsafe-call\n          (this.#worker as any)[method].bind(this.#worker);\n    }\n  }\n\n  public async end(): ReturnType<JestWorker[\"end\"]> {\n    const worker = this.#worker;\n    if (!worker) {\n      throw new Error(\"Farm is ended, no more calls can be done to it\");\n    }\n\n    cleanupWorkers(worker);\n    this.#worker = undefined;\n    return worker.end();\n  }\n\n  /**\n   * Quietly end the worker if it exists\n   */\n  public close(): void {\n    if (this.#worker) {\n      cleanupWorkers(this.#worker);\n      void this.#worker.end();\n    }\n  }\n}\n\nexport function createWorker<\n  TExposedMethods extends ReadonlyArray<string> = ReadonlyArray<string>\n>(\n  workerPath: string,\n  exposedMethods: TExposedMethods,\n  numWorkers = 1\n): WorkerProcess<TExposedMethods> {\n  return new Worker(workerPath, {\n    name: findFileName(workerPath, {\n      withExtension: false\n    }),\n    exposedMethods,\n    numWorkers\n  }) as WorkerProcess<TExposedMethods>;\n}\n"]}