@milaboratories/pl-deployments 2.17.18 → 2.18.0

package/dist/local/pl.cjs

@@ -10,6 +10,8 @@ let upath = require("upath");
 upath = require_runtime.__toESM(upath);
 let node_os = require("node:os");
 node_os = require_runtime.__toESM(node_os);
+let node_net = require("node:net");
+node_net = require_runtime.__toESM(node_net);
 let _milaboratories_pl_http = require("@milaboratories/pl-http");
 let _milaboratories_pl_model_common = require("@milaboratories/pl-model-common");
 //#region src/local/pl.ts
@@ -25,11 +27,12 @@ var LocalPl = class {
 	nRuns = 0;
 	lastRunHistory = {};
 	wasStopped = false;
-	constructor(logger, workingDir, startOptions, initialStartHistory, onClose, onError, onCloseAndError, onCloseAndErrorNoStop) {
+	constructor(logger, workingDir, startOptions, initialStartHistory, grpcPort, onClose, onError, onCloseAndError, onCloseAndErrorNoStop) {
 		this.logger = logger;
 		this.workingDir = workingDir;
 		this.startOptions = startOptions;
 		this.initialStartHistory = initialStartHistory;
+		this.grpcPort = grpcPort;
 		this.onClose = onClose;
 		this.onError = onError;
 		this.onCloseAndError = onCloseAndError;
@@ -72,7 +75,9 @@ var LocalPl = class {
 		return this.wasStopped;
 	}
 	async isAlive() {
-		return await require_process.isProcessAlive((0, _milaboratories_ts_helpers.notEmpty)(this.pid));
+		if (!await require_process.isProcessAlive((0, _milaboratories_ts_helpers.notEmpty)(this.pid))) return false;
+		if (this.grpcPort === void 0) return true;
+		return await tcpProbe("127.0.0.1", this.grpcPort);
 	}
 	debugInfo() {
 		return {
@@ -127,7 +132,7 @@ Only Basic auth is supported by the backend.`);
 			args: processOpts.args,
 			cwd: processOpts.opts.cwd
 		});
-		const pl = new LocalPl(logger, ops.workingDir, processOpts, t, ops.onClose, ops.onError, ops.onCloseAndError, ops.onCloseAndErrorNoStop);
+		const pl = new LocalPl(logger, ops.workingDir, processOpts, t, ops.grpcPort, ops.onClose, ops.onError, ops.onCloseAndError, ops.onCloseAndErrorNoStop);
 		await pl.start();
 		return pl;
 	});
@@ -177,6 +182,30 @@ function mergeDefaultOps(ops, numCpu) {
 		...withoutSpawnOps
 	};
 }
+/** Resolves true if a TCP connect to host:port succeeds within timeoutMs. Used by
+* {@link LocalPl.isAlive} to verify the gRPC listener has actually bound — the backend
+* process can be alive long before its server sockets are accepting connections. */
+async function tcpProbe(host, port, timeoutMs = 500) {
+	return await new Promise((resolve) => {
+		const socket = node_net.default.connect({
+			host,
+			port
+		});
+		const finalize = (ok) => {
+			socket.destroy();
+			resolve(ok);
+		};
+		const timer = setTimeout(() => finalize(false), timeoutMs);
+		socket.once("connect", () => {
+			clearTimeout(timer);
+			finalize(true);
+		});
+		socket.once("error", () => {
+			clearTimeout(timer);
+			finalize(false);
+		});
+	});
+}
 /** Gets default options for a platforma local binary
 * and overrides them with the provided options. */
 function plProcessOps(binaryPath, configPath, ops, workDir, defaultEnv) {

package/dist/local/pl.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"pl.cjs","names":["withTrace","processRun","filePid","writePid","processWaitStopped","isProcessAlive","os","fsp","resolveLocalPlBinaryPath","readPid","processStop","newDefaultPlBinarySource"],"sources":["../../src/local/pl.ts"],"sourcesContent":["import type { ProcessOptions } from \"./process\";\nimport { isProcessAlive, processStop, processWaitStopped, processRun } from \"./process\";\nimport type { PlBinarySource } from \"../common/pl_binary\";\nimport { newDefaultPlBinarySource, resolveLocalPlBinaryPath } from \"../common/pl_binary\";\nimport type { MiLogger } from \"@milaboratories/ts-helpers\";\nimport { notEmpty } from \"@milaboratories/ts-helpers\";\nimport type { ChildProcess, SpawnOptions } from \"node:child_process\";\nimport { filePid, readPid, writePid } from \"./pid\";\nimport type { Trace } from \"./trace\";\nimport { withTrace } from \"./trace\";\nimport upath from \"upath\";\nimport fsp from \"node:fs/promises\";\nimport type { Required } from \"utility-types\";\nimport * as os from \"node:os\";\nimport type { ProxySettings } from \"@milaboratories/pl-http\";\nimport { defaultHttpDispatcher } from \"@milaboratories/pl-http\";\nimport { parseHttpAuth } from \"@milaboratories/pl-model-common\";\n\nexport const LocalConfigYaml = \"config-local.yaml\";\n\n/**\n * Represents a local running pl-core,\n * and has methods to start, check if it's running, stop and wait for stopping it.\n * Also, a hook on pl-core closed can be provided.\n */\nexport class LocalPl {\n  private instance?: ChildProcess;\n  public pid?: number;\n  private nRuns: number = 0;\n  private lastRunHistory: Trace = {};\n  private wasStopped = false;\n\n  constructor(\n    private readonly logger: MiLogger,\n    private readonly workingDir: string,\n    private readonly startOptions: ProcessOptions,\n    private readonly initialStartHistory: Trace,\n    private readonly onClose?: (pl: LocalPl) => Promise<void>,\n    private readonly onError?: (pl: LocalPl) => Promise<void>,\n    private readonly onCloseAndError?: (pl: LocalPl) => Promise<void>,\n    private readonly onCloseAndErrorNoStop?: (pl: LocalPl) => Promise<void>,\n  ) {}\n\n  async start() {\n    await withTrace(this.logger, async (trace, t) => {\n      this.wasStopped = false;\n      const instance = processRun(this.logger, this.startOptions);\n      instance.on(\"error\", (e: any) => {\n        this.logger.error(\n          `error '${e}', while running platforma, started opts: ${JSON.stringify(this.debugInfo())}`,\n        );\n\n        // keep in mind there are no awaits here, it will be asynchronous\n        if (this.onError !== undefined) void this.onError(this);\n        if (this.onCloseAndError !== undefined) void this.onCloseAndError(this);\n        if (this.onCloseAndErrorNoStop !== undefined && !this.wasStopped)\n          void this.onCloseAndErrorNoStop(this);\n      });\n      instance.on(\"close\", () => {\n        this.logger.warn(`platforma was closed, started opts: ${JSON.stringify(this.debugInfo())}`);\n\n        // keep in mind there are no awaits here, it will be asynchronous\n        if (this.onClose !== undefined) void this.onClose(this);\n        if (this.onCloseAndError !== undefined) void this.onCloseAndError(this);\n        if (this.onCloseAndErrorNoStop !== undefined && !this.wasStopped)\n          void this.onCloseAndErrorNoStop(this);\n      });\n\n      trace(\"started\", true);\n\n      const pidFile = trace(\"pidFile\", filePid(this.workingDir));\n      trace(\"pid\", notEmpty(instance.pid));\n      trace(\"pidWritten\", await writePid(pidFile, notEmpty(instance.pid)));\n\n      this.nRuns++;\n      this.instance = instance;\n      this.pid = instance.pid;\n      this.lastRunHistory = t;\n    });\n  }\n\n  stop() {\n    // TODO use this.instance to stop the process\n    this.wasStopped = true;\n    processStop(notEmpty(this.pid));\n  }\n\n  async waitStopped() {\n    await processWaitStopped(notEmpty(this.pid), 15000);\n  }\n\n  stopped() {\n    return this.wasStopped;\n  }\n\n  async isAlive(): Promise<boolean> {\n    return await isProcessAlive(notEmpty(this.pid));\n  }\n\n  debugInfo() {\n    return {\n      lastRunHistory: this.lastRunHistory,\n      nRuns: this.nRuns,\n      pid: this.pid,\n      workingDir: this.workingDir,\n      initialStartHistory: this.initialStartHistory,\n      wasStopped: this.wasStopped,\n    };\n  }\n}\n\n/** Options to start a local pl-core. */\nexport type LocalPlOptions = {\n  /** From what directory start a process. */\n  readonly workingDir: string;\n  /** A string representation of yaml config. */\n  readonly config: string;\n  /** How to get a binary, download it or get an existing one (default: download latest version) */\n  readonly plBinary?: PlBinarySource;\n  /** Additional options for a process, environments, stdout, stderr etc. */\n  readonly spawnOptions?: SpawnOptions;\n  /**\n   * If the previous pl-core was started from the same directory,\n   * we can check if it's still running and then stop it before starting a new one.\n   * (default: true)\n   */\n  readonly closeOld?: boolean;\n  /**\n   * Proxy settings to use to fetch the binary and pass it down\n   * as a HTTPS_PROXY/HTTP_PROXY environment variable;\n   * Backend only supports Basic auth.\n   */\n  readonly proxy?: ProxySettings;\n\n  readonly onClose?: (pl: LocalPl) => Promise<void>;\n  readonly onError?: (pl: LocalPl) => Promise<void>;\n  readonly onCloseAndError?: (pl: LocalPl) => Promise<void>;\n  readonly onCloseAndErrorNoStop?: (pl: LocalPl) => Promise<void>;\n};\n\nexport type LocalPlOptionsFull = Required<LocalPlOptions, \"plBinary\" | \"spawnOptions\" | \"closeOld\">;\n\n/**\n * Starts pl-core, if the option was provided downloads a binary, reads license environments etc.\n */\nexport async function localPlatformaInit(logger: MiLogger, _ops: LocalPlOptions): Promise<LocalPl> {\n  // filling-in default values\n\n  // Backend could consume a lot of CPU power,\n  // we want to keep at least a couple for UI and other apps to work.\n  const numCpu = Math.max(os.cpus().length - 2, 1);\n  const ops = mergeDefaultOps(_ops, numCpu);\n\n  return await withTrace(logger, async (trace, t) => {\n    trace(\"startOptions\", { ...ops, config: \"too wordy\" });\n\n    const workDir = upath.resolve(ops.workingDir);\n\n    if (ops.closeOld) {\n      trace(\"closeOld\", await localPlatformaReadPidAndStop(logger, workDir));\n    }\n\n    const configPath = upath.join(workDir, LocalConfigYaml);\n\n    logger.info(`writing configuration '${configPath}'...`);\n    await fsp.writeFile(configPath, ops.config);\n\n    const plBinPath = upath.join(workDir, \"binaries\");\n    const baseBinaryPath = await resolveLocalPlBinaryPath({\n      logger,\n      downloadDir: plBinPath,\n      src: ops.plBinary,\n      dispatcher: defaultHttpDispatcher(ops.proxy),\n    });\n    const binaryPath = trace(\"binaryPath\", upath.join(\"binaries\", baseBinaryPath));\n\n    const env = { ...process.env };\n\n    if (ops.proxy?.url) {\n      const url = new URL(ops.proxy.url);\n      if (ops.proxy.auth) {\n        const parsed = parseHttpAuth(ops.proxy.auth);\n        if (parsed.scheme !== \"Basic\") {\n          throw new Error(`\\\nUnsupported auth scheme: ${parsed.scheme}. \\\nOnly Basic auth is supported by the backend.`);\n        }\n        url.username = parsed.username;\n        url.password = parsed.password;\n      }\n      env.http_proxy = url.toString();\n      env.https_proxy = url.toString();\n    }\n\n    const processOpts = plProcessOps(binaryPath, configPath, ops, workDir, env);\n    trace(\"processOpts\", {\n      cmd: processOpts.cmd,\n      args: processOpts.args,\n      cwd: processOpts.opts.cwd,\n    });\n\n    const pl = new LocalPl(\n      logger,\n      ops.workingDir,\n      processOpts,\n      t,\n      ops.onClose,\n      ops.onError,\n      ops.onCloseAndError,\n      ops.onCloseAndErrorNoStop,\n    );\n    await pl.start();\n\n    return pl;\n  });\n}\n\n/** Reads a pid of the old pl-core if it was started in the same working directory,\n * and closes it. */\nasync function localPlatformaReadPidAndStop(\n  logger: MiLogger,\n  workingDir: string,\n): Promise<Record<string, any>> {\n  return await withTrace(logger, async (trace, t) => {\n    const file = trace(\"pidFilePath\", filePid(workingDir));\n\n    const oldPid = trace(\"pid\", await readPid(file));\n    const alive = trace(\"wasAlive\", await isProcessAlive(oldPid));\n\n    if (oldPid !== undefined && alive) {\n      trace(\"stopped\", processStop(oldPid));\n      try {\n        trace(\"waitStopped\", await processWaitStopped(oldPid, 15_000)); // larger, that 10s we provide to backend in config.\n      } catch {\n        trace(\"forceStopped\", processStop(oldPid, true));\n        trace(\"waitForceStopped\", await processWaitStopped(oldPid, 5_000));\n      }\n    }\n\n    return t;\n  });\n}\n\n/** Gets default options for the whole init process\n * and overrides them with the provided options. */\nexport function mergeDefaultOps(ops: LocalPlOptions, numCpu: number): LocalPlOptionsFull {\n  const result: {\n    plBinary: PlBinarySource;\n    spawnOptions: SpawnOptions;\n    closeOld: boolean;\n  } = {\n    plBinary: newDefaultPlBinarySource(),\n    spawnOptions: {\n      env: {\n        GOMAXPROCS: String(numCpu),\n      },\n    },\n    closeOld: true,\n  };\n\n  if (ops.spawnOptions?.env) {\n    result.spawnOptions.env = { ...result.spawnOptions.env, ...ops.spawnOptions.env };\n  }\n\n  if (ops.spawnOptions) {\n    const withoutEnv = { ...ops.spawnOptions };\n    delete withoutEnv[\"env\"];\n    result.spawnOptions = { ...result.spawnOptions, ...withoutEnv };\n  }\n\n  const withoutSpawnOps = { ...ops };\n  delete withoutSpawnOps[\"spawnOptions\"];\n\n  return { ...result, ...withoutSpawnOps };\n}\n\n/** Gets default options for a platforma local binary\n * and overrides them with the provided options. */\nexport function plProcessOps(\n  binaryPath: any,\n  configPath: string,\n  ops: LocalPlOptionsFull,\n  workDir: string,\n  defaultEnv: Record<string, string | undefined>,\n): ProcessOptions {\n  const result: ProcessOptions = {\n    cmd: binaryPath,\n    args: [\"--config\", configPath],\n    opts: {\n      env: { ...defaultEnv },\n      cwd: workDir,\n      stdio: [\"pipe\", \"ignore\", \"inherit\"],\n      windowsHide: true, // hide a terminal on Windows\n    },\n  };\n\n  if (ops.spawnOptions?.env) {\n    result.opts.env = { ...result.opts.env, ...ops.spawnOptions.env };\n  }\n\n  const withoutEnv = { ...ops.spawnOptions };\n  delete withoutEnv[\"env\"];\n  result.opts = { ...result.opts, ...withoutEnv };\n\n  return result;\n}\n"],"mappings":";;;;;;;;;;;;;;;AAkBA,MAAa,kBAAkB;;;;;;AAO/B,IAAa,UAAb,MAAqB;CACnB;CACA;CACA,QAAwB;CACxB,iBAAgC,EAAE;CAClC,aAAqB;CAErB,YACE,QACA,YACA,cACA,qBACA,SACA,SACA,iBACA,uBACA;AARiB,OAAA,SAAA;AACA,OAAA,aAAA;AACA,OAAA,eAAA;AACA,OAAA,sBAAA;AACA,OAAA,UAAA;AACA,OAAA,UAAA;AACA,OAAA,kBAAA;AACA,OAAA,wBAAA;;CAGnB,MAAM,QAAQ;AACZ,QAAMA,cAAAA,UAAU,KAAK,QAAQ,OAAO,OAAO,MAAM;AAC/C,QAAK,aAAa;GAClB,MAAM,WAAWC,gBAAAA,WAAW,KAAK,QAAQ,KAAK,aAAa;AAC3D,YAAS,GAAG,UAAU,MAAW;AAC/B,SAAK,OAAO,MACV,UAAU,EAAE,4CAA4C,KAAK,UAAU,KAAK,WAAW,CAAC,GACzF;AAGD,QAAI,KAAK,YAAY,KAAA,EAAgB,MAAK,QAAQ,KAAK;AACvD,QAAI,KAAK,oBAAoB,KAAA,EAAgB,MAAK,gBAAgB,KAAK;AACvE,QAAI,KAAK,0BAA0B,KAAA,KAAa,CAAC,KAAK,WAC/C,MAAK,sBAAsB,KAAK;KACvC;AACF,YAAS,GAAG,eAAe;AACzB,SAAK,OAAO,KAAK,uCAAuC,KAAK,UAAU,KAAK,WAAW,CAAC,GAAG;AAG3F,QAAI,KAAK,YAAY,KAAA,EAAgB,MAAK,QAAQ,KAAK;AACvD,QAAI,KAAK,oBAAoB,KAAA,EAAgB,MAAK,gBAAgB,KAAK;AACvE,QAAI,KAAK,0BAA0B,KAAA,KAAa,CAAC,KAAK,WAC/C,MAAK,sBAAsB,KAAK;KACvC;AAEF,SAAM,WAAW,KAAK;GAEtB,MAAM,UAAU,MAAM,WAAWC,YAAAA,QAAQ,KAAK,WAAW,CAAC;AAC1D,SAAM,QAAA,GAAA,2BAAA,UAAgB,SAAS,IAAI,CAAC;AACpC,SAAM,cAAc,MAAMC,YAAAA,SAAS,UAAA,GAAA,2BAAA,UAAkB,SAAS,IAAI,CAAC,CAAC;AAEpE,QAAK;AACL,QAAK,WAAW;AAChB,QAAK,MAAM,SAAS;AACpB,QAAK,iBAAiB;IACtB;;CAGJ,OAAO;AAEL,OAAK,aAAa;AAClB,kBAAA,aAAA,GAAA,2BAAA,UAAqB,KAAK,IAAI,CAAC;;CAGjC,MAAM,cAAc;AAClB,QAAMC,gBAAAA,oBAAAA,GAAAA,2BAAAA,UAA4B,KAAK,IAAI,EAAE,KAAM;;CAGrD,UAAU;AACR,SAAO,KAAK;;CAGd,MAAM,UAA4B;AAChC,SAAO,MAAMC,gBAAAA,gBAAAA,GAAAA,2BAAAA,UAAwB,KAAK,IAAI,CAAC;;CAGjD,YAAY;AACV,SAAO;GACL,gBAAgB,KAAK;GACrB,OAAO,KAAK;GACZ,KAAK,KAAK;GACV,YAAY,KAAK;GACjB,qBAAqB,KAAK;GAC1B,YAAY,KAAK;GAClB;;;;;;AAsCL,eAAsB,mBAAmB,QAAkB,MAAwC;CAMjG,MAAM,MAAM,gBAAgB,MADb,KAAK,IAAIC,QAAG,MAAM,CAAC,SAAS,GAAG,EAAE,CACP;AAEzC,QAAO,MAAMN,cAAAA,UAAU,QAAQ,OAAO,OAAO,MAAM;AACjD,QAAM,gBAAgB;GAAE,GAAG;GAAK,QAAQ;GAAa,CAAC;EAEtD,MAAM,UAAU,MAAA,QAAM,QAAQ,IAAI,WAAW;AAE7C,MAAI,IAAI,SACN,OAAM,YAAY,MAAM,6BAA6B,QAAQ,QAAQ,CAAC;EAGxE,MAAM,aAAa,MAAA,QAAM,KAAK,SAAS,gBAAgB;AAEvD,SAAO,KAAK,0BAA0B,WAAW,MAAM;AACvD,QAAMO,iBAAAA,QAAI,UAAU,YAAY,IAAI,OAAO;EAG3C,MAAM,iBAAiB,MAAMC,kBAAAA,yBAAyB;GACpD;GACA,aAHgB,MAAA,QAAM,KAAK,SAAS,WAAW;GAI/C,KAAK,IAAI;GACT,aAAA,GAAA,wBAAA,uBAAkC,IAAI,MAAM;GAC7C,CAAC;EACF,MAAM,aAAa,MAAM,cAAc,MAAA,QAAM,KAAK,YAAY,eAAe,CAAC;EAE9E,MAAM,MAAM,EAAE,GAAG,QAAQ,KAAK;AAE9B,MAAI,IAAI,OAAO,KAAK;GAClB,MAAM,MAAM,IAAI,IAAI,IAAI,MAAM,IAAI;AAClC,OAAI,IAAI,MAAM,MAAM;IAClB,MAAM,UAAA,GAAA,gCAAA,eAAuB,IAAI,MAAM,KAAK;AAC5C,QAAI,OAAO,WAAW,QACpB,OAAM,IAAI,MAAM;2BACC,OAAO,OAAO;8CACK;AAEtC,QAAI,WAAW,OAAO;AACtB,QAAI,WAAW,OAAO;;AAExB,OAAI,aAAa,IAAI,UAAU;AAC/B,OAAI,cAAc,IAAI,UAAU;;EAGlC,MAAM,cAAc,aAAa,YAAY,YAAY,KAAK,SAAS,IAAI;AAC3E,QAAM,eAAe;GACnB,KAAK,YAAY;GACjB,MAAM,YAAY;GAClB,KAAK,YAAY,KAAK;GACvB,CAAC;EAEF,MAAM,KAAK,IAAI,QACb,QACA,IAAI,YACJ,aACA,GACA,IAAI,SACJ,IAAI,SACJ,IAAI,iBACJ,IAAI,sBACL;AACD,QAAM,GAAG,OAAO;AAEhB,SAAO;GACP;;;;AAKJ,eAAe,6BACb,QACA,YAC8B;AAC9B,QAAO,MAAMR,cAAAA,UAAU,QAAQ,OAAO,OAAO,MAAM;EAGjD,MAAM,SAAS,MAAM,OAAO,MAAMS,YAAAA,QAFrB,MAAM,eAAeP,YAAAA,QAAQ,WAAW,CAAC,CAEP,CAAC;EAChD,MAAM,QAAQ,MAAM,YAAY,MAAMG,gBAAAA,eAAe,OAAO,CAAC;AAE7D,MAAI,WAAW,KAAA,KAAa,OAAO;AACjC,SAAM,WAAWK,gBAAAA,YAAY,OAAO,CAAC;AACrC,OAAI;AACF,UAAM,eAAe,MAAMN,gBAAAA,mBAAmB,QAAQ,KAAO,CAAC;WACxD;AACN,UAAM,gBAAgBM,gBAAAA,YAAY,QAAQ,KAAK,CAAC;AAChD,UAAM,oBAAoB,MAAMN,gBAAAA,mBAAmB,QAAQ,IAAM,CAAC;;;AAItE,SAAO;GACP;;;;AAKJ,SAAgB,gBAAgB,KAAqB,QAAoC;CACvF,MAAM,SAIF;EACF,UAAUO,kBAAAA,0BAA0B;EACpC,cAAc,EACZ,KAAK,EACH,YAAY,OAAO,OAAO,EAC3B,EACF;EACD,UAAU;EACX;AAED,KAAI,IAAI,cAAc,IACpB,QAAO,aAAa,MAAM;EAAE,GAAG,OAAO,aAAa;EAAK,GAAG,IAAI,aAAa;EAAK;AAGnF,KAAI,IAAI,cAAc;EACpB,MAAM,aAAa,EAAE,GAAG,IAAI,cAAc;AAC1C,SAAO,WAAW;AAClB,SAAO,eAAe;GAAE,GAAG,OAAO;GAAc,GAAG;GAAY;;CAGjE,MAAM,kBAAkB,EAAE,GAAG,KAAK;AAClC,QAAO,gBAAgB;AAEvB,QAAO;EAAE,GAAG;EAAQ,GAAG;EAAiB;;;;AAK1C,SAAgB,aACd,YACA,YACA,KACA,SACA,YACgB;CAChB,MAAM,SAAyB;EAC7B,KAAK;EACL,MAAM,CAAC,YAAY,WAAW;EAC9B,MAAM;GACJ,KAAK,EAAE,GAAG,YAAY;GACtB,KAAK;GACL,OAAO;IAAC;IAAQ;IAAU;IAAU;GACpC,aAAa;GACd;EACF;AAED,KAAI,IAAI,cAAc,IACpB,QAAO,KAAK,MAAM;EAAE,GAAG,OAAO,KAAK;EAAK,GAAG,IAAI,aAAa;EAAK;CAGnE,MAAM,aAAa,EAAE,GAAG,IAAI,cAAc;AAC1C,QAAO,WAAW;AAClB,QAAO,OAAO;EAAE,GAAG,OAAO;EAAM,GAAG;EAAY;AAE/C,QAAO"}
+{"version":3,"file":"pl.cjs","names":["withTrace","processRun","filePid","writePid","processWaitStopped","isProcessAlive","os","fsp","resolveLocalPlBinaryPath","readPid","processStop","newDefaultPlBinarySource","net"],"sources":["../../src/local/pl.ts"],"sourcesContent":["import type { ProcessOptions } from \"./process\";\nimport { isProcessAlive, processStop, processWaitStopped, processRun } from \"./process\";\nimport type { PlBinarySource } from \"../common/pl_binary\";\nimport { newDefaultPlBinarySource, resolveLocalPlBinaryPath } from \"../common/pl_binary\";\nimport type { MiLogger } from \"@milaboratories/ts-helpers\";\nimport { notEmpty } from \"@milaboratories/ts-helpers\";\nimport type { ChildProcess, SpawnOptions } from \"node:child_process\";\nimport { filePid, readPid, writePid } from \"./pid\";\nimport type { Trace } from \"./trace\";\nimport { withTrace } from \"./trace\";\nimport upath from \"upath\";\nimport fsp from \"node:fs/promises\";\nimport net from \"node:net\";\nimport type { Required } from \"utility-types\";\nimport * as os from \"node:os\";\nimport type { ProxySettings } from \"@milaboratories/pl-http\";\nimport { defaultHttpDispatcher } from \"@milaboratories/pl-http\";\nimport { parseHttpAuth } from \"@milaboratories/pl-model-common\";\n\nexport const LocalConfigYaml = \"config-local.yaml\";\n\n/**\n * Represents a local running pl-core,\n * and has methods to start, check if it's running, stop and wait for stopping it.\n * Also, a hook on pl-core closed can be provided.\n */\nexport class LocalPl {\n  private instance?: ChildProcess;\n  public pid?: number;\n  private nRuns: number = 0;\n  private lastRunHistory: Trace = {};\n  private wasStopped = false;\n\n  constructor(\n    private readonly logger: MiLogger,\n    private readonly workingDir: string,\n    private readonly startOptions: ProcessOptions,\n    private readonly initialStartHistory: Trace,\n    private readonly grpcPort?: number,\n    private readonly onClose?: (pl: LocalPl) => Promise<void>,\n    private readonly onError?: (pl: LocalPl) => Promise<void>,\n    private readonly onCloseAndError?: (pl: LocalPl) => Promise<void>,\n    private readonly onCloseAndErrorNoStop?: (pl: LocalPl) => Promise<void>,\n  ) {}\n\n  async start() {\n    await withTrace(this.logger, async (trace, t) => {\n      this.wasStopped = false;\n      const instance = processRun(this.logger, this.startOptions);\n      instance.on(\"error\", (e: any) => {\n        this.logger.error(\n          `error '${e}', while running platforma, started opts: ${JSON.stringify(this.debugInfo())}`,\n        );\n\n        // keep in mind there are no awaits here, it will be asynchronous\n        if (this.onError !== undefined) void this.onError(this);\n        if (this.onCloseAndError !== undefined) void this.onCloseAndError(this);\n        if (this.onCloseAndErrorNoStop !== undefined && !this.wasStopped)\n          void this.onCloseAndErrorNoStop(this);\n      });\n      instance.on(\"close\", () => {\n        this.logger.warn(`platforma was closed, started opts: ${JSON.stringify(this.debugInfo())}`);\n\n        // keep in mind there are no awaits here, it will be asynchronous\n        if (this.onClose !== undefined) void this.onClose(this);\n        if (this.onCloseAndError !== undefined) void this.onCloseAndError(this);\n        if (this.onCloseAndErrorNoStop !== undefined && !this.wasStopped)\n          void this.onCloseAndErrorNoStop(this);\n      });\n\n      trace(\"started\", true);\n\n      const pidFile = trace(\"pidFile\", filePid(this.workingDir));\n      trace(\"pid\", notEmpty(instance.pid));\n      trace(\"pidWritten\", await writePid(pidFile, notEmpty(instance.pid)));\n\n      this.nRuns++;\n      this.instance = instance;\n      this.pid = instance.pid;\n      this.lastRunHistory = t;\n    });\n  }\n\n  stop() {\n    // TODO use this.instance to stop the process\n    this.wasStopped = true;\n    processStop(notEmpty(this.pid));\n  }\n\n  async waitStopped() {\n    await processWaitStopped(notEmpty(this.pid), 15000);\n  }\n\n  stopped() {\n    return this.wasStopped;\n  }\n\n  async isAlive(): Promise<boolean> {\n    if (!(await isProcessAlive(notEmpty(this.pid)))) return false;\n    if (this.grpcPort === undefined) return true;\n    return await tcpProbe(\"127.0.0.1\", this.grpcPort);\n  }\n\n  debugInfo() {\n    return {\n      lastRunHistory: this.lastRunHistory,\n      nRuns: this.nRuns,\n      pid: this.pid,\n      workingDir: this.workingDir,\n      initialStartHistory: this.initialStartHistory,\n      wasStopped: this.wasStopped,\n    };\n  }\n}\n\n/** Options to start a local pl-core. */\nexport type LocalPlOptions = {\n  /** From what directory start a process. */\n  readonly workingDir: string;\n  /** A string representation of yaml config. */\n  readonly config: string;\n  /** How to get a binary, download it or get an existing one (default: download latest version) */\n  readonly plBinary?: PlBinarySource;\n  /** Additional options for a process, environments, stdout, stderr etc. */\n  readonly spawnOptions?: SpawnOptions;\n  /**\n   * If the previous pl-core was started from the same directory,\n   * we can check if it's still running and then stop it before starting a new one.\n   * (default: true)\n   */\n  readonly closeOld?: boolean;\n  /**\n   * Proxy settings to use to fetch the binary and pass it down\n   * as a HTTPS_PROXY/HTTP_PROXY environment variable;\n   * Backend only supports Basic auth.\n   */\n  readonly proxy?: ProxySettings;\n\n  /**\n   * gRPC port the backend listens on (always on 127.0.0.1 for local).\n   * When set, {@link LocalPl.isAlive} additionally probes this TCP port so callers\n   * can distinguish a process that is alive but still binding from a process that is\n   * actually accepting gRPC connections.\n   */\n  readonly grpcPort?: number;\n\n  readonly onClose?: (pl: LocalPl) => Promise<void>;\n  readonly onError?: (pl: LocalPl) => Promise<void>;\n  readonly onCloseAndError?: (pl: LocalPl) => Promise<void>;\n  readonly onCloseAndErrorNoStop?: (pl: LocalPl) => Promise<void>;\n};\n\nexport type LocalPlOptionsFull = Required<LocalPlOptions, \"plBinary\" | \"spawnOptions\" | \"closeOld\">;\n\n/**\n * Starts pl-core, if the option was provided downloads a binary, reads license environments etc.\n */\nexport async function localPlatformaInit(logger: MiLogger, _ops: LocalPlOptions): Promise<LocalPl> {\n  // filling-in default values\n\n  // Backend could consume a lot of CPU power,\n  // we want to keep at least a couple for UI and other apps to work.\n  const numCpu = Math.max(os.cpus().length - 2, 1);\n  const ops = mergeDefaultOps(_ops, numCpu);\n\n  return await withTrace(logger, async (trace, t) => {\n    trace(\"startOptions\", { ...ops, config: \"too wordy\" });\n\n    const workDir = upath.resolve(ops.workingDir);\n\n    if (ops.closeOld) {\n      trace(\"closeOld\", await localPlatformaReadPidAndStop(logger, workDir));\n    }\n\n    const configPath = upath.join(workDir, LocalConfigYaml);\n\n    logger.info(`writing configuration '${configPath}'...`);\n    await fsp.writeFile(configPath, ops.config);\n\n    const plBinPath = upath.join(workDir, \"binaries\");\n    const baseBinaryPath = await resolveLocalPlBinaryPath({\n      logger,\n      downloadDir: plBinPath,\n      src: ops.plBinary,\n      dispatcher: defaultHttpDispatcher(ops.proxy),\n    });\n    const binaryPath = trace(\"binaryPath\", upath.join(\"binaries\", baseBinaryPath));\n\n    const env = { ...process.env };\n\n    if (ops.proxy?.url) {\n      const url = new URL(ops.proxy.url);\n      if (ops.proxy.auth) {\n        const parsed = parseHttpAuth(ops.proxy.auth);\n        if (parsed.scheme !== \"Basic\") {\n          throw new Error(`\\\nUnsupported auth scheme: ${parsed.scheme}. \\\nOnly Basic auth is supported by the backend.`);\n        }\n        url.username = parsed.username;\n        url.password = parsed.password;\n      }\n      env.http_proxy = url.toString();\n      env.https_proxy = url.toString();\n    }\n\n    const processOpts = plProcessOps(binaryPath, configPath, ops, workDir, env);\n    trace(\"processOpts\", {\n      cmd: processOpts.cmd,\n      args: processOpts.args,\n      cwd: processOpts.opts.cwd,\n    });\n\n    const pl = new LocalPl(\n      logger,\n      ops.workingDir,\n      processOpts,\n      t,\n      ops.grpcPort,\n      ops.onClose,\n      ops.onError,\n      ops.onCloseAndError,\n      ops.onCloseAndErrorNoStop,\n    );\n    await pl.start();\n\n    return pl;\n  });\n}\n\n/** Reads a pid of the old pl-core if it was started in the same working directory,\n * and closes it. */\nasync function localPlatformaReadPidAndStop(\n  logger: MiLogger,\n  workingDir: string,\n): Promise<Record<string, any>> {\n  return await withTrace(logger, async (trace, t) => {\n    const file = trace(\"pidFilePath\", filePid(workingDir));\n\n    const oldPid = trace(\"pid\", await readPid(file));\n    const alive = trace(\"wasAlive\", await isProcessAlive(oldPid));\n\n    if (oldPid !== undefined && alive) {\n      trace(\"stopped\", processStop(oldPid));\n      try {\n        trace(\"waitStopped\", await processWaitStopped(oldPid, 15_000)); // larger, that 10s we provide to backend in config.\n      } catch {\n        trace(\"forceStopped\", processStop(oldPid, true));\n        trace(\"waitForceStopped\", await processWaitStopped(oldPid, 5_000));\n      }\n    }\n\n    return t;\n  });\n}\n\n/** Gets default options for the whole init process\n * and overrides them with the provided options. */\nexport function mergeDefaultOps(ops: LocalPlOptions, numCpu: number): LocalPlOptionsFull {\n  const result: {\n    plBinary: PlBinarySource;\n    spawnOptions: SpawnOptions;\n    closeOld: boolean;\n  } = {\n    plBinary: newDefaultPlBinarySource(),\n    spawnOptions: {\n      env: {\n        GOMAXPROCS: String(numCpu),\n      },\n    },\n    closeOld: true,\n  };\n\n  if (ops.spawnOptions?.env) {\n    result.spawnOptions.env = { ...result.spawnOptions.env, ...ops.spawnOptions.env };\n  }\n\n  if (ops.spawnOptions) {\n    const withoutEnv = { ...ops.spawnOptions };\n    delete withoutEnv[\"env\"];\n    result.spawnOptions = { ...result.spawnOptions, ...withoutEnv };\n  }\n\n  const withoutSpawnOps = { ...ops };\n  delete withoutSpawnOps[\"spawnOptions\"];\n\n  return { ...result, ...withoutSpawnOps };\n}\n\n/** Resolves true if a TCP connect to host:port succeeds within timeoutMs. Used by\n * {@link LocalPl.isAlive} to verify the gRPC listener has actually bound — the backend\n * process can be alive long before its server sockets are accepting connections. */\nasync function tcpProbe(host: string, port: number, timeoutMs = 500): Promise<boolean> {\n  return await new Promise<boolean>((resolve) => {\n    const socket = net.connect({ host, port });\n    const finalize = (ok: boolean) => {\n      socket.destroy();\n      resolve(ok);\n    };\n    const timer = setTimeout(() => finalize(false), timeoutMs);\n    socket.once(\"connect\", () => {\n      clearTimeout(timer);\n      finalize(true);\n    });\n    socket.once(\"error\", () => {\n      clearTimeout(timer);\n      finalize(false);\n    });\n  });\n}\n\n/** Gets default options for a platforma local binary\n * and overrides them with the provided options. */\nexport function plProcessOps(\n  binaryPath: any,\n  configPath: string,\n  ops: LocalPlOptionsFull,\n  workDir: string,\n  defaultEnv: Record<string, string | undefined>,\n): ProcessOptions {\n  const result: ProcessOptions = {\n    cmd: binaryPath,\n    args: [\"--config\", configPath],\n    opts: {\n      env: { ...defaultEnv },\n      cwd: workDir,\n      stdio: [\"pipe\", \"ignore\", \"inherit\"],\n      windowsHide: true, // hide a terminal on Windows\n    },\n  };\n\n  if (ops.spawnOptions?.env) {\n    result.opts.env = { ...result.opts.env, ...ops.spawnOptions.env };\n  }\n\n  const withoutEnv = { ...ops.spawnOptions };\n  delete withoutEnv[\"env\"];\n  result.opts = { ...result.opts, ...withoutEnv };\n\n  return result;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AAmBA,MAAa,kBAAkB;;;;;;AAO/B,IAAa,UAAb,MAAqB;CACnB;CACA;CACA,QAAwB;CACxB,iBAAgC,EAAE;CAClC,aAAqB;CAErB,YACE,QACA,YACA,cACA,qBACA,UACA,SACA,SACA,iBACA,uBACA;AATiB,OAAA,SAAA;AACA,OAAA,aAAA;AACA,OAAA,eAAA;AACA,OAAA,sBAAA;AACA,OAAA,WAAA;AACA,OAAA,UAAA;AACA,OAAA,UAAA;AACA,OAAA,kBAAA;AACA,OAAA,wBAAA;;CAGnB,MAAM,QAAQ;AACZ,QAAMA,cAAAA,UAAU,KAAK,QAAQ,OAAO,OAAO,MAAM;AAC/C,QAAK,aAAa;GAClB,MAAM,WAAWC,gBAAAA,WAAW,KAAK,QAAQ,KAAK,aAAa;AAC3D,YAAS,GAAG,UAAU,MAAW;AAC/B,SAAK,OAAO,MACV,UAAU,EAAE,4CAA4C,KAAK,UAAU,KAAK,WAAW,CAAC,GACzF;AAGD,QAAI,KAAK,YAAY,KAAA,EAAgB,MAAK,QAAQ,KAAK;AACvD,QAAI,KAAK,oBAAoB,KAAA,EAAgB,MAAK,gBAAgB,KAAK;AACvE,QAAI,KAAK,0BAA0B,KAAA,KAAa,CAAC,KAAK,WAC/C,MAAK,sBAAsB,KAAK;KACvC;AACF,YAAS,GAAG,eAAe;AACzB,SAAK,OAAO,KAAK,uCAAuC,KAAK,UAAU,KAAK,WAAW,CAAC,GAAG;AAG3F,QAAI,KAAK,YAAY,KAAA,EAAgB,MAAK,QAAQ,KAAK;AACvD,QAAI,KAAK,oBAAoB,KAAA,EAAgB,MAAK,gBAAgB,KAAK;AACvE,QAAI,KAAK,0BAA0B,KAAA,KAAa,CAAC,KAAK,WAC/C,MAAK,sBAAsB,KAAK;KACvC;AAEF,SAAM,WAAW,KAAK;GAEtB,MAAM,UAAU,MAAM,WAAWC,YAAAA,QAAQ,KAAK,WAAW,CAAC;AAC1D,SAAM,QAAA,GAAA,2BAAA,UAAgB,SAAS,IAAI,CAAC;AACpC,SAAM,cAAc,MAAMC,YAAAA,SAAS,UAAA,GAAA,2BAAA,UAAkB,SAAS,IAAI,CAAC,CAAC;AAEpE,QAAK;AACL,QAAK,WAAW;AAChB,QAAK,MAAM,SAAS;AACpB,QAAK,iBAAiB;IACtB;;CAGJ,OAAO;AAEL,OAAK,aAAa;AAClB,kBAAA,aAAA,GAAA,2BAAA,UAAqB,KAAK,IAAI,CAAC;;CAGjC,MAAM,cAAc;AAClB,QAAMC,gBAAAA,oBAAAA,GAAAA,2BAAAA,UAA4B,KAAK,IAAI,EAAE,KAAM;;CAGrD,UAAU;AACR,SAAO,KAAK;;CAGd,MAAM,UAA4B;AAChC,MAAI,CAAE,MAAMC,gBAAAA,gBAAAA,GAAAA,2BAAAA,UAAwB,KAAK,IAAI,CAAC,CAAG,QAAO;AACxD,MAAI,KAAK,aAAa,KAAA,EAAW,QAAO;AACxC,SAAO,MAAM,SAAS,aAAa,KAAK,SAAS;;CAGnD,YAAY;AACV,SAAO;GACL,gBAAgB,KAAK;GACrB,OAAO,KAAK;GACZ,KAAK,KAAK;GACV,YAAY,KAAK;GACjB,qBAAqB,KAAK;GAC1B,YAAY,KAAK;GAClB;;;;;;AA8CL,eAAsB,mBAAmB,QAAkB,MAAwC;CAMjG,MAAM,MAAM,gBAAgB,MADb,KAAK,IAAIC,QAAG,MAAM,CAAC,SAAS,GAAG,EAAE,CACP;AAEzC,QAAO,MAAMN,cAAAA,UAAU,QAAQ,OAAO,OAAO,MAAM;AACjD,QAAM,gBAAgB;GAAE,GAAG;GAAK,QAAQ;GAAa,CAAC;EAEtD,MAAM,UAAU,MAAA,QAAM,QAAQ,IAAI,WAAW;AAE7C,MAAI,IAAI,SACN,OAAM,YAAY,MAAM,6BAA6B,QAAQ,QAAQ,CAAC;EAGxE,MAAM,aAAa,MAAA,QAAM,KAAK,SAAS,gBAAgB;AAEvD,SAAO,KAAK,0BAA0B,WAAW,MAAM;AACvD,QAAMO,iBAAAA,QAAI,UAAU,YAAY,IAAI,OAAO;EAG3C,MAAM,iBAAiB,MAAMC,kBAAAA,yBAAyB;GACpD;GACA,aAHgB,MAAA,QAAM,KAAK,SAAS,WAAW;GAI/C,KAAK,IAAI;GACT,aAAA,GAAA,wBAAA,uBAAkC,IAAI,MAAM;GAC7C,CAAC;EACF,MAAM,aAAa,MAAM,cAAc,MAAA,QAAM,KAAK,YAAY,eAAe,CAAC;EAE9E,MAAM,MAAM,EAAE,GAAG,QAAQ,KAAK;AAE9B,MAAI,IAAI,OAAO,KAAK;GAClB,MAAM,MAAM,IAAI,IAAI,IAAI,MAAM,IAAI;AAClC,OAAI,IAAI,MAAM,MAAM;IAClB,MAAM,UAAA,GAAA,gCAAA,eAAuB,IAAI,MAAM,KAAK;AAC5C,QAAI,OAAO,WAAW,QACpB,OAAM,IAAI,MAAM;2BACC,OAAO,OAAO;8CACK;AAEtC,QAAI,WAAW,OAAO;AACtB,QAAI,WAAW,OAAO;;AAExB,OAAI,aAAa,IAAI,UAAU;AAC/B,OAAI,cAAc,IAAI,UAAU;;EAGlC,MAAM,cAAc,aAAa,YAAY,YAAY,KAAK,SAAS,IAAI;AAC3E,QAAM,eAAe;GACnB,KAAK,YAAY;GACjB,MAAM,YAAY;GAClB,KAAK,YAAY,KAAK;GACvB,CAAC;EAEF,MAAM,KAAK,IAAI,QACb,QACA,IAAI,YACJ,aACA,GACA,IAAI,UACJ,IAAI,SACJ,IAAI,SACJ,IAAI,iBACJ,IAAI,sBACL;AACD,QAAM,GAAG,OAAO;AAEhB,SAAO;GACP;;;;AAKJ,eAAe,6BACb,QACA,YAC8B;AAC9B,QAAO,MAAMR,cAAAA,UAAU,QAAQ,OAAO,OAAO,MAAM;EAGjD,MAAM,SAAS,MAAM,OAAO,MAAMS,YAAAA,QAFrB,MAAM,eAAeP,YAAAA,QAAQ,WAAW,CAAC,CAEP,CAAC;EAChD,MAAM,QAAQ,MAAM,YAAY,MAAMG,gBAAAA,eAAe,OAAO,CAAC;AAE7D,MAAI,WAAW,KAAA,KAAa,OAAO;AACjC,SAAM,WAAWK,gBAAAA,YAAY,OAAO,CAAC;AACrC,OAAI;AACF,UAAM,eAAe,MAAMN,gBAAAA,mBAAmB,QAAQ,KAAO,CAAC;WACxD;AACN,UAAM,gBAAgBM,gBAAAA,YAAY,QAAQ,KAAK,CAAC;AAChD,UAAM,oBAAoB,MAAMN,gBAAAA,mBAAmB,QAAQ,IAAM,CAAC;;;AAItE,SAAO;GACP;;;;AAKJ,SAAgB,gBAAgB,KAAqB,QAAoC;CACvF,MAAM,SAIF;EACF,UAAUO,kBAAAA,0BAA0B;EACpC,cAAc,EACZ,KAAK,EACH,YAAY,OAAO,OAAO,EAC3B,EACF;EACD,UAAU;EACX;AAED,KAAI,IAAI,cAAc,IACpB,QAAO,aAAa,MAAM;EAAE,GAAG,OAAO,aAAa;EAAK,GAAG,IAAI,aAAa;EAAK;AAGnF,KAAI,IAAI,cAAc;EACpB,MAAM,aAAa,EAAE,GAAG,IAAI,cAAc;AAC1C,SAAO,WAAW;AAClB,SAAO,eAAe;GAAE,GAAG,OAAO;GAAc,GAAG;GAAY;;CAGjE,MAAM,kBAAkB,EAAE,GAAG,KAAK;AAClC,QAAO,gBAAgB;AAEvB,QAAO;EAAE,GAAG;EAAQ,GAAG;EAAiB;;;;;AAM1C,eAAe,SAAS,MAAc,MAAc,YAAY,KAAuB;AACrF,QAAO,MAAM,IAAI,SAAkB,YAAY;EAC7C,MAAM,SAASC,SAAAA,QAAI,QAAQ;GAAE;GAAM;GAAM,CAAC;EAC1C,MAAM,YAAY,OAAgB;AAChC,UAAO,SAAS;AAChB,WAAQ,GAAG;;EAEb,MAAM,QAAQ,iBAAiB,SAAS,MAAM,EAAE,UAAU;AAC1D,SAAO,KAAK,iBAAiB;AAC3B,gBAAa,MAAM;AACnB,YAAS,KAAK;IACd;AACF,SAAO,KAAK,eAAe;AACzB,gBAAa,MAAM;AACnB,YAAS,MAAM;IACf;GACF;;;;AAKJ,SAAgB,aACd,YACA,YACA,KACA,SACA,YACgB;CAChB,MAAM,SAAyB;EAC7B,KAAK;EACL,MAAM,CAAC,YAAY,WAAW;EAC9B,MAAM;GACJ,KAAK,EAAE,GAAG,YAAY;GACtB,KAAK;GACL,OAAO;IAAC;IAAQ;IAAU;IAAU;GACpC,aAAa;GACd;EACF;AAED,KAAI,IAAI,cAAc,IACpB,QAAO,KAAK,MAAM;EAAE,GAAG,OAAO,KAAK;EAAK,GAAG,IAAI,aAAa;EAAK;CAGnE,MAAM,aAAa,EAAE,GAAG,IAAI,cAAc;AAC1C,QAAO,WAAW;AAClB,QAAO,OAAO;EAAE,GAAG,OAAO;EAAM,GAAG;EAAY;AAE/C,QAAO"}

package/dist/local/pl.d.ts

@@ -18,6 +18,7 @@ declare class LocalPl {
   private readonly workingDir;
   private readonly startOptions;
   private readonly initialStartHistory;
+  private readonly grpcPort?;
   private readonly onClose?;
   private readonly onError?;
   private readonly onCloseAndError?;
@@ -27,7 +28,7 @@ declare class LocalPl {
   private nRuns;
   private lastRunHistory;
   private wasStopped;
-  constructor(logger: MiLogger, workingDir: string, startOptions: ProcessOptions, initialStartHistory: Trace, onClose?: ((pl: LocalPl) => Promise<void>) | undefined, onError?: ((pl: LocalPl) => Promise<void>) | undefined, onCloseAndError?: ((pl: LocalPl) => Promise<void>) | undefined, onCloseAndErrorNoStop?: ((pl: LocalPl) => Promise<void>) | undefined);
+  constructor(logger: MiLogger, workingDir: string, startOptions: ProcessOptions, initialStartHistory: Trace, grpcPort?: number | undefined, onClose?: ((pl: LocalPl) => Promise<void>) | undefined, onError?: ((pl: LocalPl) => Promise<void>) | undefined, onCloseAndError?: ((pl: LocalPl) => Promise<void>) | undefined, onCloseAndErrorNoStop?: ((pl: LocalPl) => Promise<void>) | undefined);
   start(): Promise<void>;
   stop(): void;
   waitStopped(): Promise<void>;
@@ -60,6 +61,13 @@ type LocalPlOptions = {
    * Backend only supports Basic auth.
    */
   readonly proxy?: ProxySettings;
+  /**
+   * gRPC port the backend listens on (always on 127.0.0.1 for local).
+   * When set, {@link LocalPl.isAlive} additionally probes this TCP port so callers
+   * can distinguish a process that is alive but still binding from a process that is
+   * actually accepting gRPC connections.
+   */
+  readonly grpcPort?: number;
   readonly onClose?: (pl: LocalPl) => Promise<void>;
   readonly onError?: (pl: LocalPl) => Promise<void>;
   readonly onCloseAndError?: (pl: LocalPl) => Promise<void>;

package/dist/local/pl.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pl.d.ts","names":[],"sources":["../../src/local/pl.ts"],"mappings":";;;;;;;;;cAkBa,eAAA;;AAAb;;;;cAOa,OAAA;EAAA,iBAQQ,MAAA;EAAA,iBACA,UAAA;EAAA,iBACA,YAAA;EAAA,iBACA,mBAAA;EAAA,iBACA,OAAA;EAAA,iBACA,OAAA;EAAA,iBACA,eAAA;EAAA,iBACA,qBAAA;EAAA,QAdX,QAAA;EACD,GAAA;EAAA,QACC,KAAA;EAAA,QACA,cAAA;EAAA,QACA,UAAA;cAGW,MAAA,EAAQ,QAAA,EACR,UAAA,UACA,YAAA,EAAc,cAAA,EACd,mBAAA,EAAqB,KAAA,EACrB,OAAA,KAAW,EAAA,EAAI,OAAA,KAAY,OAAA,qBAC3B,OAAA,KAAW,EAAA,EAAI,OAAA,KAAY,OAAA,qBAC3B,eAAA,KAAmB,EAAA,EAAI,OAAA,KAAY,OAAA,qBACnC,qBAAA,KAAyB,EAAA,EAAI,OAAA,KAAY,OAAA;EAGtD,KAAA,CAAA,GAAK,OAAA;EAsCX,IAAA,CAAA;EAMM,WAAA,CAAA,GAAW,OAAA;EAIjB,OAAA,CAAA;EAIM,OAAA,CAAA,GAAW,OAAA;EAIjB,SAAA,CAAA;;;;;;;;;;KAaU,cAAA;EArFH,oDAuFE,UAAA,UArFD;EAAA,SAuFC,MAAA;WAEA,QAAA,GAAW,cAAA,EArFD;EAAA,SAuFV,YAAA,GAAe,YAAA;EArFS;;;;;EAAA,SA2FxB,QAAA;EAzFqC;;;;;EAAA,SA+FrC,KAAA,GAAQ,aAAA;EAAA,SAER,OAAA,IAAW,EAAA,EAAI,OAAA,KAAY,OAAA;EAAA,SAC3B,OAAA,IAAW,EAAA,EAAI,OAAA,KAAY,OAAA;EAAA,SAC3B,eAAA,IAAmB,EAAA,EAAI,OAAA,KAAY,OAAA;EAAA,SACnC,qBAAA,IAAyB,EAAA,EAAI,OAAA,KAAY,OAAA;AAAA;AAAA,KAGxC,kBAAA,GAAqB,QAAA,CAAS,cAAA;;;;iBAKpB,kBAAA,CAAmB,MAAA,EAAQ,QAAA,EAAU,IAAA,EAAM,cAAA,GAAiB,OAAA,CAAQ,OAAA;;;iBAoG1E,eAAA,CAAgB,GAAA,EAAK,cAAA,EAAgB,MAAA,WAAiB,kBAAA;;;iBAiCtD,YAAA,CACd,UAAA,OACA,UAAA,UACA,GAAA,EAAK,kBAAA,EACL,OAAA,UACA,UAAA,EAAY,MAAA,+BACX,cAAA"}
+{"version":3,"file":"pl.d.ts","names":[],"sources":["../../src/local/pl.ts"],"mappings":";;;;;;;;;cAmBa,eAAA;;AAAb;;;;cAOa,OAAA;EAAA,iBAQQ,MAAA;EAAA,iBACA,UAAA;EAAA,iBACA,YAAA;EAAA,iBACA,mBAAA;EAAA,iBACA,QAAA;EAAA,iBACA,OAAA;EAAA,iBACA,OAAA;EAAA,iBACA,eAAA;EAAA,iBACA,qBAAA;EAAA,QAfX,QAAA;EACD,GAAA;EAAA,QACC,KAAA;EAAA,QACA,cAAA;EAAA,QACA,UAAA;cAGW,MAAA,EAAQ,QAAA,EACR,UAAA,UACA,YAAA,EAAc,cAAA,EACd,mBAAA,EAAqB,KAAA,EACrB,QAAA,uBACA,OAAA,KAAW,EAAA,EAAI,OAAA,KAAY,OAAA,qBAC3B,OAAA,KAAW,EAAA,EAAI,OAAA,KAAY,OAAA,qBAC3B,eAAA,KAAmB,EAAA,EAAI,OAAA,KAAY,OAAA,qBACnC,qBAAA,KAAyB,EAAA,EAAI,OAAA,KAAY,OAAA;EAGtD,KAAA,CAAA,GAAK,OAAA;EAsCX,IAAA,CAAA;EAMM,WAAA,CAAA,GAAW,OAAA;EAIjB,OAAA,CAAA;EAIM,OAAA,CAAA,GAAW,OAAA;EAMjB,SAAA,CAAA;;;;;;;;;;KAaU,cAAA;EAxFH,oDA0FE,UAAA,UAxFD;EAAA,SA0FC,MAAA;WAEA,QAAA,GAAW,cAAA,EAxFD;EAAA,SA0FV,YAAA,GAAe,YAAA;EAxFS;;;;;EAAA,SA8FxB,QAAA;EA3FqB;;;;;EAAA,SAiGrB,KAAA,GAAQ,aAAA;EAhGE;;;;;;EAAA,SAwGV,QAAA;EAAA,SAEA,OAAA,IAAW,EAAA,EAAI,OAAA,KAAY,OAAA;EAAA,SAC3B,OAAA,IAAW,EAAA,EAAI,OAAA,KAAY,OAAA;EAAA,SAC3B,eAAA,IAAmB,EAAA,EAAI,OAAA,KAAY,OAAA;EAAA,SACnC,qBAAA,IAAyB,EAAA,EAAI,OAAA,KAAY,OAAA;AAAA;AAAA,KAGxC,kBAAA,GAAqB,QAAA,CAAS,cAAA;;;;iBAKpB,kBAAA,CAAmB,MAAA,EAAQ,QAAA,EAAU,IAAA,EAAM,cAAA,GAAiB,OAAA,CAAQ,OAAA;;;iBAqG1E,eAAA,CAAgB,GAAA,EAAK,cAAA,EAAgB,MAAA,WAAiB,kBAAA;;;iBAuDtD,YAAA,CACd,UAAA,OACA,UAAA,UACA,GAAA,EAAK,kBAAA,EACL,OAAA,UACA,UAAA,EAAY,MAAA,+BACX,cAAA"}

package/dist/local/pl.js

@@ -6,6 +6,7 @@ import { notEmpty } from "@milaboratories/ts-helpers";
 import fsp from "node:fs/promises";
 import upath from "upath";
 import * as os$1 from "node:os";
+import net from "node:net";
 import { defaultHttpDispatcher } from "@milaboratories/pl-http";
 import { parseHttpAuth } from "@milaboratories/pl-model-common";
 //#region src/local/pl.ts
@@ -21,11 +22,12 @@ var LocalPl = class {
 	nRuns = 0;
 	lastRunHistory = {};
 	wasStopped = false;
-	constructor(logger, workingDir, startOptions, initialStartHistory, onClose, onError, onCloseAndError, onCloseAndErrorNoStop) {
+	constructor(logger, workingDir, startOptions, initialStartHistory, grpcPort, onClose, onError, onCloseAndError, onCloseAndErrorNoStop) {
 		this.logger = logger;
 		this.workingDir = workingDir;
 		this.startOptions = startOptions;
 		this.initialStartHistory = initialStartHistory;
+		this.grpcPort = grpcPort;
 		this.onClose = onClose;
 		this.onError = onError;
 		this.onCloseAndError = onCloseAndError;
@@ -68,7 +70,9 @@ var LocalPl = class {
 		return this.wasStopped;
 	}
 	async isAlive() {
-		return await isProcessAlive(notEmpty(this.pid));
+		if (!await isProcessAlive(notEmpty(this.pid))) return false;
+		if (this.grpcPort === void 0) return true;
+		return await tcpProbe("127.0.0.1", this.grpcPort);
 	}
 	debugInfo() {
 		return {
@@ -123,7 +127,7 @@ Only Basic auth is supported by the backend.`);
 			args: processOpts.args,
 			cwd: processOpts.opts.cwd
 		});
-		const pl = new LocalPl(logger, ops.workingDir, processOpts, t, ops.onClose, ops.onError, ops.onCloseAndError, ops.onCloseAndErrorNoStop);
+		const pl = new LocalPl(logger, ops.workingDir, processOpts, t, ops.grpcPort, ops.onClose, ops.onError, ops.onCloseAndError, ops.onCloseAndErrorNoStop);
 		await pl.start();
 		return pl;
 	});
@@ -173,6 +177,30 @@ function mergeDefaultOps(ops, numCpu) {
 		...withoutSpawnOps
 	};
 }
+/** Resolves true if a TCP connect to host:port succeeds within timeoutMs. Used by
+* {@link LocalPl.isAlive} to verify the gRPC listener has actually bound — the backend
+* process can be alive long before its server sockets are accepting connections. */
+async function tcpProbe(host, port, timeoutMs = 500) {
+	return await new Promise((resolve) => {
+		const socket = net.connect({
+			host,
+			port
+		});
+		const finalize = (ok) => {
+			socket.destroy();
+			resolve(ok);
+		};
+		const timer = setTimeout(() => finalize(false), timeoutMs);
+		socket.once("connect", () => {
+			clearTimeout(timer);
+			finalize(true);
+		});
+		socket.once("error", () => {
+			clearTimeout(timer);
+			finalize(false);
+		});
+	});
+}
 /** Gets default options for a platforma local binary
 * and overrides them with the provided options. */
 function plProcessOps(binaryPath, configPath, ops, workDir, defaultEnv) {

package/dist/local/pl.js.map

@@ -1 +1 @@
-{"version":3,"file":"pl.js","names":["os"],"sources":["../../src/local/pl.ts"],"sourcesContent":["import type { ProcessOptions } from \"./process\";\nimport { isProcessAlive, processStop, processWaitStopped, processRun } from \"./process\";\nimport type { PlBinarySource } from \"../common/pl_binary\";\nimport { newDefaultPlBinarySource, resolveLocalPlBinaryPath } from \"../common/pl_binary\";\nimport type { MiLogger } from \"@milaboratories/ts-helpers\";\nimport { notEmpty } from \"@milaboratories/ts-helpers\";\nimport type { ChildProcess, SpawnOptions } from \"node:child_process\";\nimport { filePid, readPid, writePid } from \"./pid\";\nimport type { Trace } from \"./trace\";\nimport { withTrace } from \"./trace\";\nimport upath from \"upath\";\nimport fsp from \"node:fs/promises\";\nimport type { Required } from \"utility-types\";\nimport * as os from \"node:os\";\nimport type { ProxySettings } from \"@milaboratories/pl-http\";\nimport { defaultHttpDispatcher } from \"@milaboratories/pl-http\";\nimport { parseHttpAuth } from \"@milaboratories/pl-model-common\";\n\nexport const LocalConfigYaml = \"config-local.yaml\";\n\n/**\n * Represents a local running pl-core,\n * and has methods to start, check if it's running, stop and wait for stopping it.\n * Also, a hook on pl-core closed can be provided.\n */\nexport class LocalPl {\n  private instance?: ChildProcess;\n  public pid?: number;\n  private nRuns: number = 0;\n  private lastRunHistory: Trace = {};\n  private wasStopped = false;\n\n  constructor(\n    private readonly logger: MiLogger,\n    private readonly workingDir: string,\n    private readonly startOptions: ProcessOptions,\n    private readonly initialStartHistory: Trace,\n    private readonly onClose?: (pl: LocalPl) => Promise<void>,\n    private readonly onError?: (pl: LocalPl) => Promise<void>,\n    private readonly onCloseAndError?: (pl: LocalPl) => Promise<void>,\n    private readonly onCloseAndErrorNoStop?: (pl: LocalPl) => Promise<void>,\n  ) {}\n\n  async start() {\n    await withTrace(this.logger, async (trace, t) => {\n      this.wasStopped = false;\n      const instance = processRun(this.logger, this.startOptions);\n      instance.on(\"error\", (e: any) => {\n        this.logger.error(\n          `error '${e}', while running platforma, started opts: ${JSON.stringify(this.debugInfo())}`,\n        );\n\n        // keep in mind there are no awaits here, it will be asynchronous\n        if (this.onError !== undefined) void this.onError(this);\n        if (this.onCloseAndError !== undefined) void this.onCloseAndError(this);\n        if (this.onCloseAndErrorNoStop !== undefined && !this.wasStopped)\n          void this.onCloseAndErrorNoStop(this);\n      });\n      instance.on(\"close\", () => {\n        this.logger.warn(`platforma was closed, started opts: ${JSON.stringify(this.debugInfo())}`);\n\n        // keep in mind there are no awaits here, it will be asynchronous\n        if (this.onClose !== undefined) void this.onClose(this);\n        if (this.onCloseAndError !== undefined) void this.onCloseAndError(this);\n        if (this.onCloseAndErrorNoStop !== undefined && !this.wasStopped)\n          void this.onCloseAndErrorNoStop(this);\n      });\n\n      trace(\"started\", true);\n\n      const pidFile = trace(\"pidFile\", filePid(this.workingDir));\n      trace(\"pid\", notEmpty(instance.pid));\n      trace(\"pidWritten\", await writePid(pidFile, notEmpty(instance.pid)));\n\n      this.nRuns++;\n      this.instance = instance;\n      this.pid = instance.pid;\n      this.lastRunHistory = t;\n    });\n  }\n\n  stop() {\n    // TODO use this.instance to stop the process\n    this.wasStopped = true;\n    processStop(notEmpty(this.pid));\n  }\n\n  async waitStopped() {\n    await processWaitStopped(notEmpty(this.pid), 15000);\n  }\n\n  stopped() {\n    return this.wasStopped;\n  }\n\n  async isAlive(): Promise<boolean> {\n    return await isProcessAlive(notEmpty(this.pid));\n  }\n\n  debugInfo() {\n    return {\n      lastRunHistory: this.lastRunHistory,\n      nRuns: this.nRuns,\n      pid: this.pid,\n      workingDir: this.workingDir,\n      initialStartHistory: this.initialStartHistory,\n      wasStopped: this.wasStopped,\n    };\n  }\n}\n\n/** Options to start a local pl-core. */\nexport type LocalPlOptions = {\n  /** From what directory start a process. */\n  readonly workingDir: string;\n  /** A string representation of yaml config. */\n  readonly config: string;\n  /** How to get a binary, download it or get an existing one (default: download latest version) */\n  readonly plBinary?: PlBinarySource;\n  /** Additional options for a process, environments, stdout, stderr etc. */\n  readonly spawnOptions?: SpawnOptions;\n  /**\n   * If the previous pl-core was started from the same directory,\n   * we can check if it's still running and then stop it before starting a new one.\n   * (default: true)\n   */\n  readonly closeOld?: boolean;\n  /**\n   * Proxy settings to use to fetch the binary and pass it down\n   * as a HTTPS_PROXY/HTTP_PROXY environment variable;\n   * Backend only supports Basic auth.\n   */\n  readonly proxy?: ProxySettings;\n\n  readonly onClose?: (pl: LocalPl) => Promise<void>;\n  readonly onError?: (pl: LocalPl) => Promise<void>;\n  readonly onCloseAndError?: (pl: LocalPl) => Promise<void>;\n  readonly onCloseAndErrorNoStop?: (pl: LocalPl) => Promise<void>;\n};\n\nexport type LocalPlOptionsFull = Required<LocalPlOptions, \"plBinary\" | \"spawnOptions\" | \"closeOld\">;\n\n/**\n * Starts pl-core, if the option was provided downloads a binary, reads license environments etc.\n */\nexport async function localPlatformaInit(logger: MiLogger, _ops: LocalPlOptions): Promise<LocalPl> {\n  // filling-in default values\n\n  // Backend could consume a lot of CPU power,\n  // we want to keep at least a couple for UI and other apps to work.\n  const numCpu = Math.max(os.cpus().length - 2, 1);\n  const ops = mergeDefaultOps(_ops, numCpu);\n\n  return await withTrace(logger, async (trace, t) => {\n    trace(\"startOptions\", { ...ops, config: \"too wordy\" });\n\n    const workDir = upath.resolve(ops.workingDir);\n\n    if (ops.closeOld) {\n      trace(\"closeOld\", await localPlatformaReadPidAndStop(logger, workDir));\n    }\n\n    const configPath = upath.join(workDir, LocalConfigYaml);\n\n    logger.info(`writing configuration '${configPath}'...`);\n    await fsp.writeFile(configPath, ops.config);\n\n    const plBinPath = upath.join(workDir, \"binaries\");\n    const baseBinaryPath = await resolveLocalPlBinaryPath({\n      logger,\n      downloadDir: plBinPath,\n      src: ops.plBinary,\n      dispatcher: defaultHttpDispatcher(ops.proxy),\n    });\n    const binaryPath = trace(\"binaryPath\", upath.join(\"binaries\", baseBinaryPath));\n\n    const env = { ...process.env };\n\n    if (ops.proxy?.url) {\n      const url = new URL(ops.proxy.url);\n      if (ops.proxy.auth) {\n        const parsed = parseHttpAuth(ops.proxy.auth);\n        if (parsed.scheme !== \"Basic\") {\n          throw new Error(`\\\nUnsupported auth scheme: ${parsed.scheme}. \\\nOnly Basic auth is supported by the backend.`);\n        }\n        url.username = parsed.username;\n        url.password = parsed.password;\n      }\n      env.http_proxy = url.toString();\n      env.https_proxy = url.toString();\n    }\n\n    const processOpts = plProcessOps(binaryPath, configPath, ops, workDir, env);\n    trace(\"processOpts\", {\n      cmd: processOpts.cmd,\n      args: processOpts.args,\n      cwd: processOpts.opts.cwd,\n    });\n\n    const pl = new LocalPl(\n      logger,\n      ops.workingDir,\n      processOpts,\n      t,\n      ops.onClose,\n      ops.onError,\n      ops.onCloseAndError,\n      ops.onCloseAndErrorNoStop,\n    );\n    await pl.start();\n\n    return pl;\n  });\n}\n\n/** Reads a pid of the old pl-core if it was started in the same working directory,\n * and closes it. */\nasync function localPlatformaReadPidAndStop(\n  logger: MiLogger,\n  workingDir: string,\n): Promise<Record<string, any>> {\n  return await withTrace(logger, async (trace, t) => {\n    const file = trace(\"pidFilePath\", filePid(workingDir));\n\n    const oldPid = trace(\"pid\", await readPid(file));\n    const alive = trace(\"wasAlive\", await isProcessAlive(oldPid));\n\n    if (oldPid !== undefined && alive) {\n      trace(\"stopped\", processStop(oldPid));\n      try {\n        trace(\"waitStopped\", await processWaitStopped(oldPid, 15_000)); // larger, that 10s we provide to backend in config.\n      } catch {\n        trace(\"forceStopped\", processStop(oldPid, true));\n        trace(\"waitForceStopped\", await processWaitStopped(oldPid, 5_000));\n      }\n    }\n\n    return t;\n  });\n}\n\n/** Gets default options for the whole init process\n * and overrides them with the provided options. */\nexport function mergeDefaultOps(ops: LocalPlOptions, numCpu: number): LocalPlOptionsFull {\n  const result: {\n    plBinary: PlBinarySource;\n    spawnOptions: SpawnOptions;\n    closeOld: boolean;\n  } = {\n    plBinary: newDefaultPlBinarySource(),\n    spawnOptions: {\n      env: {\n        GOMAXPROCS: String(numCpu),\n      },\n    },\n    closeOld: true,\n  };\n\n  if (ops.spawnOptions?.env) {\n    result.spawnOptions.env = { ...result.spawnOptions.env, ...ops.spawnOptions.env };\n  }\n\n  if (ops.spawnOptions) {\n    const withoutEnv = { ...ops.spawnOptions };\n    delete withoutEnv[\"env\"];\n    result.spawnOptions = { ...result.spawnOptions, ...withoutEnv };\n  }\n\n  const withoutSpawnOps = { ...ops };\n  delete withoutSpawnOps[\"spawnOptions\"];\n\n  return { ...result, ...withoutSpawnOps };\n}\n\n/** Gets default options for a platforma local binary\n * and overrides them with the provided options. */\nexport function plProcessOps(\n  binaryPath: any,\n  configPath: string,\n  ops: LocalPlOptionsFull,\n  workDir: string,\n  defaultEnv: Record<string, string | undefined>,\n): ProcessOptions {\n  const result: ProcessOptions = {\n    cmd: binaryPath,\n    args: [\"--config\", configPath],\n    opts: {\n      env: { ...defaultEnv },\n      cwd: workDir,\n      stdio: [\"pipe\", \"ignore\", \"inherit\"],\n      windowsHide: true, // hide a terminal on Windows\n    },\n  };\n\n  if (ops.spawnOptions?.env) {\n    result.opts.env = { ...result.opts.env, ...ops.spawnOptions.env };\n  }\n\n  const withoutEnv = { ...ops.spawnOptions };\n  delete withoutEnv[\"env\"];\n  result.opts = { ...result.opts, ...withoutEnv };\n\n  return result;\n}\n"],"mappings":";;;;;;;;;;;AAkBA,MAAa,kBAAkB;;;;;;AAO/B,IAAa,UAAb,MAAqB;CACnB;CACA;CACA,QAAwB;CACxB,iBAAgC,EAAE;CAClC,aAAqB;CAErB,YACE,QACA,YACA,cACA,qBACA,SACA,SACA,iBACA,uBACA;AARiB,OAAA,SAAA;AACA,OAAA,aAAA;AACA,OAAA,eAAA;AACA,OAAA,sBAAA;AACA,OAAA,UAAA;AACA,OAAA,UAAA;AACA,OAAA,kBAAA;AACA,OAAA,wBAAA;;CAGnB,MAAM,QAAQ;AACZ,QAAM,UAAU,KAAK,QAAQ,OAAO,OAAO,MAAM;AAC/C,QAAK,aAAa;GAClB,MAAM,WAAW,WAAW,KAAK,QAAQ,KAAK,aAAa;AAC3D,YAAS,GAAG,UAAU,MAAW;AAC/B,SAAK,OAAO,MACV,UAAU,EAAE,4CAA4C,KAAK,UAAU,KAAK,WAAW,CAAC,GACzF;AAGD,QAAI,KAAK,YAAY,KAAA,EAAgB,MAAK,QAAQ,KAAK;AACvD,QAAI,KAAK,oBAAoB,KAAA,EAAgB,MAAK,gBAAgB,KAAK;AACvE,QAAI,KAAK,0BAA0B,KAAA,KAAa,CAAC,KAAK,WAC/C,MAAK,sBAAsB,KAAK;KACvC;AACF,YAAS,GAAG,eAAe;AACzB,SAAK,OAAO,KAAK,uCAAuC,KAAK,UAAU,KAAK,WAAW,CAAC,GAAG;AAG3F,QAAI,KAAK,YAAY,KAAA,EAAgB,MAAK,QAAQ,KAAK;AACvD,QAAI,KAAK,oBAAoB,KAAA,EAAgB,MAAK,gBAAgB,KAAK;AACvE,QAAI,KAAK,0BAA0B,KAAA,KAAa,CAAC,KAAK,WAC/C,MAAK,sBAAsB,KAAK;KACvC;AAEF,SAAM,WAAW,KAAK;GAEtB,MAAM,UAAU,MAAM,WAAW,QAAQ,KAAK,WAAW,CAAC;AAC1D,SAAM,OAAO,SAAS,SAAS,IAAI,CAAC;AACpC,SAAM,cAAc,MAAM,SAAS,SAAS,SAAS,SAAS,IAAI,CAAC,CAAC;AAEpE,QAAK;AACL,QAAK,WAAW;AAChB,QAAK,MAAM,SAAS;AACpB,QAAK,iBAAiB;IACtB;;CAGJ,OAAO;AAEL,OAAK,aAAa;AAClB,cAAY,SAAS,KAAK,IAAI,CAAC;;CAGjC,MAAM,cAAc;AAClB,QAAM,mBAAmB,SAAS,KAAK,IAAI,EAAE,KAAM;;CAGrD,UAAU;AACR,SAAO,KAAK;;CAGd,MAAM,UAA4B;AAChC,SAAO,MAAM,eAAe,SAAS,KAAK,IAAI,CAAC;;CAGjD,YAAY;AACV,SAAO;GACL,gBAAgB,KAAK;GACrB,OAAO,KAAK;GACZ,KAAK,KAAK;GACV,YAAY,KAAK;GACjB,qBAAqB,KAAK;GAC1B,YAAY,KAAK;GAClB;;;;;;AAsCL,eAAsB,mBAAmB,QAAkB,MAAwC;CAMjG,MAAM,MAAM,gBAAgB,MADb,KAAK,IAAIA,KAAG,MAAM,CAAC,SAAS,GAAG,EAAE,CACP;AAEzC,QAAO,MAAM,UAAU,QAAQ,OAAO,OAAO,MAAM;AACjD,QAAM,gBAAgB;GAAE,GAAG;GAAK,QAAQ;GAAa,CAAC;EAEtD,MAAM,UAAU,MAAM,QAAQ,IAAI,WAAW;AAE7C,MAAI,IAAI,SACN,OAAM,YAAY,MAAM,6BAA6B,QAAQ,QAAQ,CAAC;EAGxE,MAAM,aAAa,MAAM,KAAK,SAAS,gBAAgB;AAEvD,SAAO,KAAK,0BAA0B,WAAW,MAAM;AACvD,QAAM,IAAI,UAAU,YAAY,IAAI,OAAO;EAG3C,MAAM,iBAAiB,MAAM,yBAAyB;GACpD;GACA,aAHgB,MAAM,KAAK,SAAS,WAAW;GAI/C,KAAK,IAAI;GACT,YAAY,sBAAsB,IAAI,MAAM;GAC7C,CAAC;EACF,MAAM,aAAa,MAAM,cAAc,MAAM,KAAK,YAAY,eAAe,CAAC;EAE9E,MAAM,MAAM,EAAE,GAAG,QAAQ,KAAK;AAE9B,MAAI,IAAI,OAAO,KAAK;GAClB,MAAM,MAAM,IAAI,IAAI,IAAI,MAAM,IAAI;AAClC,OAAI,IAAI,MAAM,MAAM;IAClB,MAAM,SAAS,cAAc,IAAI,MAAM,KAAK;AAC5C,QAAI,OAAO,WAAW,QACpB,OAAM,IAAI,MAAM;2BACC,OAAO,OAAO;8CACK;AAEtC,QAAI,WAAW,OAAO;AACtB,QAAI,WAAW,OAAO;;AAExB,OAAI,aAAa,IAAI,UAAU;AAC/B,OAAI,cAAc,IAAI,UAAU;;EAGlC,MAAM,cAAc,aAAa,YAAY,YAAY,KAAK,SAAS,IAAI;AAC3E,QAAM,eAAe;GACnB,KAAK,YAAY;GACjB,MAAM,YAAY;GAClB,KAAK,YAAY,KAAK;GACvB,CAAC;EAEF,MAAM,KAAK,IAAI,QACb,QACA,IAAI,YACJ,aACA,GACA,IAAI,SACJ,IAAI,SACJ,IAAI,iBACJ,IAAI,sBACL;AACD,QAAM,GAAG,OAAO;AAEhB,SAAO;GACP;;;;AAKJ,eAAe,6BACb,QACA,YAC8B;AAC9B,QAAO,MAAM,UAAU,QAAQ,OAAO,OAAO,MAAM;EAGjD,MAAM,SAAS,MAAM,OAAO,MAAM,QAFrB,MAAM,eAAe,QAAQ,WAAW,CAAC,CAEP,CAAC;EAChD,MAAM,QAAQ,MAAM,YAAY,MAAM,eAAe,OAAO,CAAC;AAE7D,MAAI,WAAW,KAAA,KAAa,OAAO;AACjC,SAAM,WAAW,YAAY,OAAO,CAAC;AACrC,OAAI;AACF,UAAM,eAAe,MAAM,mBAAmB,QAAQ,KAAO,CAAC;WACxD;AACN,UAAM,gBAAgB,YAAY,QAAQ,KAAK,CAAC;AAChD,UAAM,oBAAoB,MAAM,mBAAmB,QAAQ,IAAM,CAAC;;;AAItE,SAAO;GACP;;;;AAKJ,SAAgB,gBAAgB,KAAqB,QAAoC;CACvF,MAAM,SAIF;EACF,UAAU,0BAA0B;EACpC,cAAc,EACZ,KAAK,EACH,YAAY,OAAO,OAAO,EAC3B,EACF;EACD,UAAU;EACX;AAED,KAAI,IAAI,cAAc,IACpB,QAAO,aAAa,MAAM;EAAE,GAAG,OAAO,aAAa;EAAK,GAAG,IAAI,aAAa;EAAK;AAGnF,KAAI,IAAI,cAAc;EACpB,MAAM,aAAa,EAAE,GAAG,IAAI,cAAc;AAC1C,SAAO,WAAW;AAClB,SAAO,eAAe;GAAE,GAAG,OAAO;GAAc,GAAG;GAAY;;CAGjE,MAAM,kBAAkB,EAAE,GAAG,KAAK;AAClC,QAAO,gBAAgB;AAEvB,QAAO;EAAE,GAAG;EAAQ,GAAG;EAAiB;;;;AAK1C,SAAgB,aACd,YACA,YACA,KACA,SACA,YACgB;CAChB,MAAM,SAAyB;EAC7B,KAAK;EACL,MAAM,CAAC,YAAY,WAAW;EAC9B,MAAM;GACJ,KAAK,EAAE,GAAG,YAAY;GACtB,KAAK;GACL,OAAO;IAAC;IAAQ;IAAU;IAAU;GACpC,aAAa;GACd;EACF;AAED,KAAI,IAAI,cAAc,IACpB,QAAO,KAAK,MAAM;EAAE,GAAG,OAAO,KAAK;EAAK,GAAG,IAAI,aAAa;EAAK;CAGnE,MAAM,aAAa,EAAE,GAAG,IAAI,cAAc;AAC1C,QAAO,WAAW;AAClB,QAAO,OAAO;EAAE,GAAG,OAAO;EAAM,GAAG;EAAY;AAE/C,QAAO"}
+{"version":3,"file":"pl.js","names":["os"],"sources":["../../src/local/pl.ts"],"sourcesContent":["import type { ProcessOptions } from \"./process\";\nimport { isProcessAlive, processStop, processWaitStopped, processRun } from \"./process\";\nimport type { PlBinarySource } from \"../common/pl_binary\";\nimport { newDefaultPlBinarySource, resolveLocalPlBinaryPath } from \"../common/pl_binary\";\nimport type { MiLogger } from \"@milaboratories/ts-helpers\";\nimport { notEmpty } from \"@milaboratories/ts-helpers\";\nimport type { ChildProcess, SpawnOptions } from \"node:child_process\";\nimport { filePid, readPid, writePid } from \"./pid\";\nimport type { Trace } from \"./trace\";\nimport { withTrace } from \"./trace\";\nimport upath from \"upath\";\nimport fsp from \"node:fs/promises\";\nimport net from \"node:net\";\nimport type { Required } from \"utility-types\";\nimport * as os from \"node:os\";\nimport type { ProxySettings } from \"@milaboratories/pl-http\";\nimport { defaultHttpDispatcher } from \"@milaboratories/pl-http\";\nimport { parseHttpAuth } from \"@milaboratories/pl-model-common\";\n\nexport const LocalConfigYaml = \"config-local.yaml\";\n\n/**\n * Represents a local running pl-core,\n * and has methods to start, check if it's running, stop and wait for stopping it.\n * Also, a hook on pl-core closed can be provided.\n */\nexport class LocalPl {\n  private instance?: ChildProcess;\n  public pid?: number;\n  private nRuns: number = 0;\n  private lastRunHistory: Trace = {};\n  private wasStopped = false;\n\n  constructor(\n    private readonly logger: MiLogger,\n    private readonly workingDir: string,\n    private readonly startOptions: ProcessOptions,\n    private readonly initialStartHistory: Trace,\n    private readonly grpcPort?: number,\n    private readonly onClose?: (pl: LocalPl) => Promise<void>,\n    private readonly onError?: (pl: LocalPl) => Promise<void>,\n    private readonly onCloseAndError?: (pl: LocalPl) => Promise<void>,\n    private readonly onCloseAndErrorNoStop?: (pl: LocalPl) => Promise<void>,\n  ) {}\n\n  async start() {\n    await withTrace(this.logger, async (trace, t) => {\n      this.wasStopped = false;\n      const instance = processRun(this.logger, this.startOptions);\n      instance.on(\"error\", (e: any) => {\n        this.logger.error(\n          `error '${e}', while running platforma, started opts: ${JSON.stringify(this.debugInfo())}`,\n        );\n\n        // keep in mind there are no awaits here, it will be asynchronous\n        if (this.onError !== undefined) void this.onError(this);\n        if (this.onCloseAndError !== undefined) void this.onCloseAndError(this);\n        if (this.onCloseAndErrorNoStop !== undefined && !this.wasStopped)\n          void this.onCloseAndErrorNoStop(this);\n      });\n      instance.on(\"close\", () => {\n        this.logger.warn(`platforma was closed, started opts: ${JSON.stringify(this.debugInfo())}`);\n\n        // keep in mind there are no awaits here, it will be asynchronous\n        if (this.onClose !== undefined) void this.onClose(this);\n        if (this.onCloseAndError !== undefined) void this.onCloseAndError(this);\n        if (this.onCloseAndErrorNoStop !== undefined && !this.wasStopped)\n          void this.onCloseAndErrorNoStop(this);\n      });\n\n      trace(\"started\", true);\n\n      const pidFile = trace(\"pidFile\", filePid(this.workingDir));\n      trace(\"pid\", notEmpty(instance.pid));\n      trace(\"pidWritten\", await writePid(pidFile, notEmpty(instance.pid)));\n\n      this.nRuns++;\n      this.instance = instance;\n      this.pid = instance.pid;\n      this.lastRunHistory = t;\n    });\n  }\n\n  stop() {\n    // TODO use this.instance to stop the process\n    this.wasStopped = true;\n    processStop(notEmpty(this.pid));\n  }\n\n  async waitStopped() {\n    await processWaitStopped(notEmpty(this.pid), 15000);\n  }\n\n  stopped() {\n    return this.wasStopped;\n  }\n\n  async isAlive(): Promise<boolean> {\n    if (!(await isProcessAlive(notEmpty(this.pid)))) return false;\n    if (this.grpcPort === undefined) return true;\n    return await tcpProbe(\"127.0.0.1\", this.grpcPort);\n  }\n\n  debugInfo() {\n    return {\n      lastRunHistory: this.lastRunHistory,\n      nRuns: this.nRuns,\n      pid: this.pid,\n      workingDir: this.workingDir,\n      initialStartHistory: this.initialStartHistory,\n      wasStopped: this.wasStopped,\n    };\n  }\n}\n\n/** Options to start a local pl-core. */\nexport type LocalPlOptions = {\n  /** From what directory start a process. */\n  readonly workingDir: string;\n  /** A string representation of yaml config. */\n  readonly config: string;\n  /** How to get a binary, download it or get an existing one (default: download latest version) */\n  readonly plBinary?: PlBinarySource;\n  /** Additional options for a process, environments, stdout, stderr etc. */\n  readonly spawnOptions?: SpawnOptions;\n  /**\n   * If the previous pl-core was started from the same directory,\n   * we can check if it's still running and then stop it before starting a new one.\n   * (default: true)\n   */\n  readonly closeOld?: boolean;\n  /**\n   * Proxy settings to use to fetch the binary and pass it down\n   * as a HTTPS_PROXY/HTTP_PROXY environment variable;\n   * Backend only supports Basic auth.\n   */\n  readonly proxy?: ProxySettings;\n\n  /**\n   * gRPC port the backend listens on (always on 127.0.0.1 for local).\n   * When set, {@link LocalPl.isAlive} additionally probes this TCP port so callers\n   * can distinguish a process that is alive but still binding from a process that is\n   * actually accepting gRPC connections.\n   */\n  readonly grpcPort?: number;\n\n  readonly onClose?: (pl: LocalPl) => Promise<void>;\n  readonly onError?: (pl: LocalPl) => Promise<void>;\n  readonly onCloseAndError?: (pl: LocalPl) => Promise<void>;\n  readonly onCloseAndErrorNoStop?: (pl: LocalPl) => Promise<void>;\n};\n\nexport type LocalPlOptionsFull = Required<LocalPlOptions, \"plBinary\" | \"spawnOptions\" | \"closeOld\">;\n\n/**\n * Starts pl-core, if the option was provided downloads a binary, reads license environments etc.\n */\nexport async function localPlatformaInit(logger: MiLogger, _ops: LocalPlOptions): Promise<LocalPl> {\n  // filling-in default values\n\n  // Backend could consume a lot of CPU power,\n  // we want to keep at least a couple for UI and other apps to work.\n  const numCpu = Math.max(os.cpus().length - 2, 1);\n  const ops = mergeDefaultOps(_ops, numCpu);\n\n  return await withTrace(logger, async (trace, t) => {\n    trace(\"startOptions\", { ...ops, config: \"too wordy\" });\n\n    const workDir = upath.resolve(ops.workingDir);\n\n    if (ops.closeOld) {\n      trace(\"closeOld\", await localPlatformaReadPidAndStop(logger, workDir));\n    }\n\n    const configPath = upath.join(workDir, LocalConfigYaml);\n\n    logger.info(`writing configuration '${configPath}'...`);\n    await fsp.writeFile(configPath, ops.config);\n\n    const plBinPath = upath.join(workDir, \"binaries\");\n    const baseBinaryPath = await resolveLocalPlBinaryPath({\n      logger,\n      downloadDir: plBinPath,\n      src: ops.plBinary,\n      dispatcher: defaultHttpDispatcher(ops.proxy),\n    });\n    const binaryPath = trace(\"binaryPath\", upath.join(\"binaries\", baseBinaryPath));\n\n    const env = { ...process.env };\n\n    if (ops.proxy?.url) {\n      const url = new URL(ops.proxy.url);\n      if (ops.proxy.auth) {\n        const parsed = parseHttpAuth(ops.proxy.auth);\n        if (parsed.scheme !== \"Basic\") {\n          throw new Error(`\\\nUnsupported auth scheme: ${parsed.scheme}. \\\nOnly Basic auth is supported by the backend.`);\n        }\n        url.username = parsed.username;\n        url.password = parsed.password;\n      }\n      env.http_proxy = url.toString();\n      env.https_proxy = url.toString();\n    }\n\n    const processOpts = plProcessOps(binaryPath, configPath, ops, workDir, env);\n    trace(\"processOpts\", {\n      cmd: processOpts.cmd,\n      args: processOpts.args,\n      cwd: processOpts.opts.cwd,\n    });\n\n    const pl = new LocalPl(\n      logger,\n      ops.workingDir,\n      processOpts,\n      t,\n      ops.grpcPort,\n      ops.onClose,\n      ops.onError,\n      ops.onCloseAndError,\n      ops.onCloseAndErrorNoStop,\n    );\n    await pl.start();\n\n    return pl;\n  });\n}\n\n/** Reads a pid of the old pl-core if it was started in the same working directory,\n * and closes it. */\nasync function localPlatformaReadPidAndStop(\n  logger: MiLogger,\n  workingDir: string,\n): Promise<Record<string, any>> {\n  return await withTrace(logger, async (trace, t) => {\n    const file = trace(\"pidFilePath\", filePid(workingDir));\n\n    const oldPid = trace(\"pid\", await readPid(file));\n    const alive = trace(\"wasAlive\", await isProcessAlive(oldPid));\n\n    if (oldPid !== undefined && alive) {\n      trace(\"stopped\", processStop(oldPid));\n      try {\n        trace(\"waitStopped\", await processWaitStopped(oldPid, 15_000)); // larger, that 10s we provide to backend in config.\n      } catch {\n        trace(\"forceStopped\", processStop(oldPid, true));\n        trace(\"waitForceStopped\", await processWaitStopped(oldPid, 5_000));\n      }\n    }\n\n    return t;\n  });\n}\n\n/** Gets default options for the whole init process\n * and overrides them with the provided options. */\nexport function mergeDefaultOps(ops: LocalPlOptions, numCpu: number): LocalPlOptionsFull {\n  const result: {\n    plBinary: PlBinarySource;\n    spawnOptions: SpawnOptions;\n    closeOld: boolean;\n  } = {\n    plBinary: newDefaultPlBinarySource(),\n    spawnOptions: {\n      env: {\n        GOMAXPROCS: String(numCpu),\n      },\n    },\n    closeOld: true,\n  };\n\n  if (ops.spawnOptions?.env) {\n    result.spawnOptions.env = { ...result.spawnOptions.env, ...ops.spawnOptions.env };\n  }\n\n  if (ops.spawnOptions) {\n    const withoutEnv = { ...ops.spawnOptions };\n    delete withoutEnv[\"env\"];\n    result.spawnOptions = { ...result.spawnOptions, ...withoutEnv };\n  }\n\n  const withoutSpawnOps = { ...ops };\n  delete withoutSpawnOps[\"spawnOptions\"];\n\n  return { ...result, ...withoutSpawnOps };\n}\n\n/** Resolves true if a TCP connect to host:port succeeds within timeoutMs. Used by\n * {@link LocalPl.isAlive} to verify the gRPC listener has actually bound — the backend\n * process can be alive long before its server sockets are accepting connections. */\nasync function tcpProbe(host: string, port: number, timeoutMs = 500): Promise<boolean> {\n  return await new Promise<boolean>((resolve) => {\n    const socket = net.connect({ host, port });\n    const finalize = (ok: boolean) => {\n      socket.destroy();\n      resolve(ok);\n    };\n    const timer = setTimeout(() => finalize(false), timeoutMs);\n    socket.once(\"connect\", () => {\n      clearTimeout(timer);\n      finalize(true);\n    });\n    socket.once(\"error\", () => {\n      clearTimeout(timer);\n      finalize(false);\n    });\n  });\n}\n\n/** Gets default options for a platforma local binary\n * and overrides them with the provided options. */\nexport function plProcessOps(\n  binaryPath: any,\n  configPath: string,\n  ops: LocalPlOptionsFull,\n  workDir: string,\n  defaultEnv: Record<string, string | undefined>,\n): ProcessOptions {\n  const result: ProcessOptions = {\n    cmd: binaryPath,\n    args: [\"--config\", configPath],\n    opts: {\n      env: { ...defaultEnv },\n      cwd: workDir,\n      stdio: [\"pipe\", \"ignore\", \"inherit\"],\n      windowsHide: true, // hide a terminal on Windows\n    },\n  };\n\n  if (ops.spawnOptions?.env) {\n    result.opts.env = { ...result.opts.env, ...ops.spawnOptions.env };\n  }\n\n  const withoutEnv = { ...ops.spawnOptions };\n  delete withoutEnv[\"env\"];\n  result.opts = { ...result.opts, ...withoutEnv };\n\n  return result;\n}\n"],"mappings":";;;;;;;;;;;;AAmBA,MAAa,kBAAkB;;;;;;AAO/B,IAAa,UAAb,MAAqB;CACnB;CACA;CACA,QAAwB;CACxB,iBAAgC,EAAE;CAClC,aAAqB;CAErB,YACE,QACA,YACA,cACA,qBACA,UACA,SACA,SACA,iBACA,uBACA;AATiB,OAAA,SAAA;AACA,OAAA,aAAA;AACA,OAAA,eAAA;AACA,OAAA,sBAAA;AACA,OAAA,WAAA;AACA,OAAA,UAAA;AACA,OAAA,UAAA;AACA,OAAA,kBAAA;AACA,OAAA,wBAAA;;CAGnB,MAAM,QAAQ;AACZ,QAAM,UAAU,KAAK,QAAQ,OAAO,OAAO,MAAM;AAC/C,QAAK,aAAa;GAClB,MAAM,WAAW,WAAW,KAAK,QAAQ,KAAK,aAAa;AAC3D,YAAS,GAAG,UAAU,MAAW;AAC/B,SAAK,OAAO,MACV,UAAU,EAAE,4CAA4C,KAAK,UAAU,KAAK,WAAW,CAAC,GACzF;AAGD,QAAI,KAAK,YAAY,KAAA,EAAgB,MAAK,QAAQ,KAAK;AACvD,QAAI,KAAK,oBAAoB,KAAA,EAAgB,MAAK,gBAAgB,KAAK;AACvE,QAAI,KAAK,0BAA0B,KAAA,KAAa,CAAC,KAAK,WAC/C,MAAK,sBAAsB,KAAK;KACvC;AACF,YAAS,GAAG,eAAe;AACzB,SAAK,OAAO,KAAK,uCAAuC,KAAK,UAAU,KAAK,WAAW,CAAC,GAAG;AAG3F,QAAI,KAAK,YAAY,KAAA,EAAgB,MAAK,QAAQ,KAAK;AACvD,QAAI,KAAK,oBAAoB,KAAA,EAAgB,MAAK,gBAAgB,KAAK;AACvE,QAAI,KAAK,0BAA0B,KAAA,KAAa,CAAC,KAAK,WAC/C,MAAK,sBAAsB,KAAK;KACvC;AAEF,SAAM,WAAW,KAAK;GAEtB,MAAM,UAAU,MAAM,WAAW,QAAQ,KAAK,WAAW,CAAC;AAC1D,SAAM,OAAO,SAAS,SAAS,IAAI,CAAC;AACpC,SAAM,cAAc,MAAM,SAAS,SAAS,SAAS,SAAS,IAAI,CAAC,CAAC;AAEpE,QAAK;AACL,QAAK,WAAW;AAChB,QAAK,MAAM,SAAS;AACpB,QAAK,iBAAiB;IACtB;;CAGJ,OAAO;AAEL,OAAK,aAAa;AAClB,cAAY,SAAS,KAAK,IAAI,CAAC;;CAGjC,MAAM,cAAc;AAClB,QAAM,mBAAmB,SAAS,KAAK,IAAI,EAAE,KAAM;;CAGrD,UAAU;AACR,SAAO,KAAK;;CAGd,MAAM,UAA4B;AAChC,MAAI,CAAE,MAAM,eAAe,SAAS,KAAK,IAAI,CAAC,CAAG,QAAO;AACxD,MAAI,KAAK,aAAa,KAAA,EAAW,QAAO;AACxC,SAAO,MAAM,SAAS,aAAa,KAAK,SAAS;;CAGnD,YAAY;AACV,SAAO;GACL,gBAAgB,KAAK;GACrB,OAAO,KAAK;GACZ,KAAK,KAAK;GACV,YAAY,KAAK;GACjB,qBAAqB,KAAK;GAC1B,YAAY,KAAK;GAClB;;;;;;AA8CL,eAAsB,mBAAmB,QAAkB,MAAwC;CAMjG,MAAM,MAAM,gBAAgB,MADb,KAAK,IAAIA,KAAG,MAAM,CAAC,SAAS,GAAG,EAAE,CACP;AAEzC,QAAO,MAAM,UAAU,QAAQ,OAAO,OAAO,MAAM;AACjD,QAAM,gBAAgB;GAAE,GAAG;GAAK,QAAQ;GAAa,CAAC;EAEtD,MAAM,UAAU,MAAM,QAAQ,IAAI,WAAW;AAE7C,MAAI,IAAI,SACN,OAAM,YAAY,MAAM,6BAA6B,QAAQ,QAAQ,CAAC;EAGxE,MAAM,aAAa,MAAM,KAAK,SAAS,gBAAgB;AAEvD,SAAO,KAAK,0BAA0B,WAAW,MAAM;AACvD,QAAM,IAAI,UAAU,YAAY,IAAI,OAAO;EAG3C,MAAM,iBAAiB,MAAM,yBAAyB;GACpD;GACA,aAHgB,MAAM,KAAK,SAAS,WAAW;GAI/C,KAAK,IAAI;GACT,YAAY,sBAAsB,IAAI,MAAM;GAC7C,CAAC;EACF,MAAM,aAAa,MAAM,cAAc,MAAM,KAAK,YAAY,eAAe,CAAC;EAE9E,MAAM,MAAM,EAAE,GAAG,QAAQ,KAAK;AAE9B,MAAI,IAAI,OAAO,KAAK;GAClB,MAAM,MAAM,IAAI,IAAI,IAAI,MAAM,IAAI;AAClC,OAAI,IAAI,MAAM,MAAM;IAClB,MAAM,SAAS,cAAc,IAAI,MAAM,KAAK;AAC5C,QAAI,OAAO,WAAW,QACpB,OAAM,IAAI,MAAM;2BACC,OAAO,OAAO;8CACK;AAEtC,QAAI,WAAW,OAAO;AACtB,QAAI,WAAW,OAAO;;AAExB,OAAI,aAAa,IAAI,UAAU;AAC/B,OAAI,cAAc,IAAI,UAAU;;EAGlC,MAAM,cAAc,aAAa,YAAY,YAAY,KAAK,SAAS,IAAI;AAC3E,QAAM,eAAe;GACnB,KAAK,YAAY;GACjB,MAAM,YAAY;GAClB,KAAK,YAAY,KAAK;GACvB,CAAC;EAEF,MAAM,KAAK,IAAI,QACb,QACA,IAAI,YACJ,aACA,GACA,IAAI,UACJ,IAAI,SACJ,IAAI,SACJ,IAAI,iBACJ,IAAI,sBACL;AACD,QAAM,GAAG,OAAO;AAEhB,SAAO;GACP;;;;AAKJ,eAAe,6BACb,QACA,YAC8B;AAC9B,QAAO,MAAM,UAAU,QAAQ,OAAO,OAAO,MAAM;EAGjD,MAAM,SAAS,MAAM,OAAO,MAAM,QAFrB,MAAM,eAAe,QAAQ,WAAW,CAAC,CAEP,CAAC;EAChD,MAAM,QAAQ,MAAM,YAAY,MAAM,eAAe,OAAO,CAAC;AAE7D,MAAI,WAAW,KAAA,KAAa,OAAO;AACjC,SAAM,WAAW,YAAY,OAAO,CAAC;AACrC,OAAI;AACF,UAAM,eAAe,MAAM,mBAAmB,QAAQ,KAAO,CAAC;WACxD;AACN,UAAM,gBAAgB,YAAY,QAAQ,KAAK,CAAC;AAChD,UAAM,oBAAoB,MAAM,mBAAmB,QAAQ,IAAM,CAAC;;;AAItE,SAAO;GACP;;;;AAKJ,SAAgB,gBAAgB,KAAqB,QAAoC;CACvF,MAAM,SAIF;EACF,UAAU,0BAA0B;EACpC,cAAc,EACZ,KAAK,EACH,YAAY,OAAO,OAAO,EAC3B,EACF;EACD,UAAU;EACX;AAED,KAAI,IAAI,cAAc,IACpB,QAAO,aAAa,MAAM;EAAE,GAAG,OAAO,aAAa;EAAK,GAAG,IAAI,aAAa;EAAK;AAGnF,KAAI,IAAI,cAAc;EACpB,MAAM,aAAa,EAAE,GAAG,IAAI,cAAc;AAC1C,SAAO,WAAW;AAClB,SAAO,eAAe;GAAE,GAAG,OAAO;GAAc,GAAG;GAAY;;CAGjE,MAAM,kBAAkB,EAAE,GAAG,KAAK;AAClC,QAAO,gBAAgB;AAEvB,QAAO;EAAE,GAAG;EAAQ,GAAG;EAAiB;;;;;AAM1C,eAAe,SAAS,MAAc,MAAc,YAAY,KAAuB;AACrF,QAAO,MAAM,IAAI,SAAkB,YAAY;EAC7C,MAAM,SAAS,IAAI,QAAQ;GAAE;GAAM;GAAM,CAAC;EAC1C,MAAM,YAAY,OAAgB;AAChC,UAAO,SAAS;AAChB,WAAQ,GAAG;;EAEb,MAAM,QAAQ,iBAAiB,SAAS,MAAM,EAAE,UAAU;AAC1D,SAAO,KAAK,iBAAiB;AAC3B,gBAAa,MAAM;AACnB,YAAS,KAAK;IACd;AACF,SAAO,KAAK,eAAe;AACzB,gBAAa,MAAM;AACnB,YAAS,MAAM;IACf;GACF;;;;AAKJ,SAAgB,aACd,YACA,YACA,KACA,SACA,YACgB;CAChB,MAAM,SAAyB;EAC7B,KAAK;EACL,MAAM,CAAC,YAAY,WAAW;EAC9B,MAAM;GACJ,KAAK,EAAE,GAAG,YAAY;GACtB,KAAK;GACL,OAAO;IAAC;IAAQ;IAAU;IAAU;GACpC,aAAa;GACd;EACF;AAED,KAAI,IAAI,cAAc,IACpB,QAAO,KAAK,MAAM;EAAE,GAAG,OAAO,KAAK;EAAK,GAAG,IAAI,aAAa;EAAK;CAGnE,MAAM,aAAa,EAAE,GAAG,IAAI,cAAc;AAC1C,QAAO,WAAW;AAClB,QAAO,OAAO;EAAE,GAAG,OAAO;EAAM,GAAG;EAAY;AAE/C,QAAO"}

package/dist/ssh/pl.cjs

@@ -8,9 +8,9 @@ const require_connection_info = require("./connection_info.cjs");
 let _milaboratories_ts_helpers = require("@milaboratories/ts-helpers");
 let upath = require("upath");
 upath = require_runtime.__toESM(upath);
-let _milaboratories_pl_http = require("@milaboratories/pl-http");
 let node_net = require("node:net");
 node_net = require_runtime.__toESM(node_net);
+let _milaboratories_pl_http = require("@milaboratories/pl-http");
 let _milaboratories_pl_config = require("@milaboratories/pl-config");
 //#region src/ssh/pl.ts
 const minRequiredGlibcVersion = 2.28;

package/dist/ssh/pl.js

@@ -6,8 +6,8 @@ import { generateSupervisordConfig, generateSupervisordConfigWithMinio, isAllAli
 import { newConnectionInfo, parseConnectionInfo, stringifyConnectionInfo } from "./connection_info.js";
 import { notEmpty, sleep } from "@milaboratories/ts-helpers";
 import upath from "upath";
-import { defaultHttpDispatcher } from "@milaboratories/pl-http";
 import net from "node:net";
+import { defaultHttpDispatcher } from "@milaboratories/pl-http";
 import { generateSshPlConfigs, getFreePort } from "@milaboratories/pl-config";
 //#region src/ssh/pl.ts
 const minRequiredGlibcVersion = 2.28;

package/dist/ssh/ssh.cjs

@@ -6,10 +6,10 @@ node_fs = require_runtime.__toESM(node_fs);
 let node_fs_promises = require("node:fs/promises");
 let upath = require("upath");
 upath = require_runtime.__toESM(upath);
-let ssh2 = require("ssh2");
-ssh2 = require_runtime.__toESM(ssh2);
 let node_net = require("node:net");
 node_net = require_runtime.__toESM(node_net);
+let ssh2 = require("ssh2");
+ssh2 = require_runtime.__toESM(ssh2);
 let node_dns = require("node:dns");
 node_dns = require_runtime.__toESM(node_dns);
 let node_crypto = require("node:crypto");

package/dist/ssh/ssh.d.ts

@@ -1,6 +1,6 @@
 import { MiLogger } from "@milaboratories/ts-helpers";
-import ssh, { Client, ConnectConfig, SFTPWrapper } from "ssh2";
 import net from "node:net";
+import ssh, { Client, ConnectConfig, SFTPWrapper } from "ssh2";
 
 //#region src/ssh/ssh.d.ts
 type SshAuthMethods = "publickey" | "password";

package/dist/ssh/ssh.js

@@ -3,8 +3,8 @@ import { Retry3TimesWithDelay, RetryablePromise, retry } from "@milaboratories/t
 import fs from "node:fs";
 import { readFile } from "node:fs/promises";
 import upath from "upath";
-import ssh, { Client } from "ssh2";
 import net from "node:net";
+import ssh, { Client } from "ssh2";
 import dns from "node:dns";
 import { randomBytes } from "node:crypto";
 //#region src/ssh/ssh.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@milaboratories/pl-deployments",
-  "version": "2.17.18",
+  "version": "2.18.0",
   "description": "MiLaboratories Platforma Backend code service run wrapper",
   "keywords": [],
   "license": "UNLICENSED",
@@ -33,8 +33,8 @@
     "yaml": "^2.8.0",
     "zod": "~3.25.76",
     "@milaboratories/pl-http": "1.2.4",
-    "@milaboratories/pl-model-common": "1.42.0",
     "@milaboratories/ts-helpers": "1.8.2",
+    "@milaboratories/pl-model-common": "1.42.0",
     "@milaboratories/pl-config": "1.8.1"
   },
   "devDependencies": {
@@ -46,9 +46,9 @@
     "typescript": "~5.9.3",
     "utility-types": "^3.11.0",
     "vitest": "^4.1.3",
-    "@milaboratories/ts-builder": "1.4.0",
+    "@milaboratories/build-configs": "2.0.0",
     "@milaboratories/ts-configs": "1.2.3",
-    "@milaboratories/build-configs": "2.0.0"
+    "@milaboratories/ts-builder": "1.5.0"
   },
   "engines": {
     "node": ">=22.19.0"

package/src/local/pl.ts

@@ -10,6 +10,7 @@ import type { Trace } from "./trace";
 import { withTrace } from "./trace";
 import upath from "upath";
 import fsp from "node:fs/promises";
+import net from "node:net";
 import type { Required } from "utility-types";
 import * as os from "node:os";
 import type { ProxySettings } from "@milaboratories/pl-http";
@@ -35,6 +36,7 @@ export class LocalPl {
     private readonly workingDir: string,
     private readonly startOptions: ProcessOptions,
     private readonly initialStartHistory: Trace,
+    private readonly grpcPort?: number,
     private readonly onClose?: (pl: LocalPl) => Promise<void>,
     private readonly onError?: (pl: LocalPl) => Promise<void>,
     private readonly onCloseAndError?: (pl: LocalPl) => Promise<void>,
@@ -94,7 +96,9 @@ export class LocalPl {
   }
 
   async isAlive(): Promise<boolean> {
-    return await isProcessAlive(notEmpty(this.pid));
+    if (!(await isProcessAlive(notEmpty(this.pid)))) return false;
+    if (this.grpcPort === undefined) return true;
+    return await tcpProbe("127.0.0.1", this.grpcPort);
   }
 
   debugInfo() {
@@ -132,6 +136,14 @@ export type LocalPlOptions = {
    */
   readonly proxy?: ProxySettings;
 
+  /**
+   * gRPC port the backend listens on (always on 127.0.0.1 for local).
+   * When set, {@link LocalPl.isAlive} additionally probes this TCP port so callers
+   * can distinguish a process that is alive but still binding from a process that is
+   * actually accepting gRPC connections.
+   */
+  readonly grpcPort?: number;
+
   readonly onClose?: (pl: LocalPl) => Promise<void>;
   readonly onError?: (pl: LocalPl) => Promise<void>;
   readonly onCloseAndError?: (pl: LocalPl) => Promise<void>;
@@ -204,6 +216,7 @@ Only Basic auth is supported by the backend.`);
       ops.workingDir,
       processOpts,
       t,
+      ops.grpcPort,
       ops.onClose,
       ops.onError,
       ops.onCloseAndError,
@@ -274,6 +287,28 @@ export function mergeDefaultOps(ops: LocalPlOptions, numCpu: number): LocalPlOpt
   return { ...result, ...withoutSpawnOps };
 }
 
+/** Resolves true if a TCP connect to host:port succeeds within timeoutMs. Used by
+ * {@link LocalPl.isAlive} to verify the gRPC listener has actually bound — the backend
+ * process can be alive long before its server sockets are accepting connections. */
+async function tcpProbe(host: string, port: number, timeoutMs = 500): Promise<boolean> {
+  return await new Promise<boolean>((resolve) => {
+    const socket = net.connect({ host, port });
+    const finalize = (ok: boolean) => {
+      socket.destroy();
+      resolve(ok);
+    };
+    const timer = setTimeout(() => finalize(false), timeoutMs);
+    socket.once("connect", () => {
+      clearTimeout(timer);
+      finalize(true);
+    });
+    socket.once("error", () => {
+      clearTimeout(timer);
+      finalize(false);
+    });
+  });
+}
+
 /** Gets default options for a platforma local binary
  * and overrides them with the provided options. */
 export function plProcessOps(