@tsplc/build 0.1.0 → 0.2.0

package/src/controller-session.ts

@@ -3,7 +3,7 @@ import { copyFile, cp, mkdir, readdir, readFile, rm, writeFile } from "node:fs/p
 import { resolve } from "node:path";
 import { z } from "zod";
 import type { ResolvedConfig } from "./config";
-import { controllerResultSchema } from "./controller-online";
+import { controllerResultSchema, explicitDownload, loginCommandSchema } from "./controller-online";
 import {
   createCodesysWorker,
   withWorkerLock,
@@ -74,12 +74,12 @@ const readBaseline = async (
     JSON.stringify(baseline.target) !== JSON.stringify(expected.target)
   ) {
     throw new Error(
-      "Downloaded baseline uses a different image, template or controller; use an explicit download",
+      `Downloaded baseline uses a different image, template or controller; ${explicitDownload}`,
     );
   }
   const project = resolve(previous, "project");
   if (JSON.stringify(await projectFiles(project)) !== JSON.stringify(baseline.files)) {
-    throw new Error("Saved online project/reference files changed; use an explicit download");
+    throw new Error(`Saved online project/reference files changed; ${explicitDownload}`);
   }
   return { baseline, project };
 };
@@ -227,3 +227,72 @@ export const runControllerSession = async (
     }
   });
 };
+
+/**
+ * Called inside the builder container: holds one login to the running application, made
+ * from the committed baseline, and serves its commands on `port` until a DELETE closes it.
+ */
+export const serveControllerLogin = async (
+  config: ResolvedConfig,
+  options: { imageId: string; port: number },
+) => {
+  if (!config.online) {
+    throw new Error("Controller logins require online settings");
+  }
+  const root = resolve(config.outDir, ".codesys/controller");
+  const { network, gateway, device } = config.online;
+  const { baseline, project } = await readBaseline(root, {
+    imageId: options.imageId,
+    templateHash: sha256(await readFile(config.template)),
+    target: { network, gateway, device, controller: config.controller },
+  });
+  const jobConfig = { ...config, outDir: resolve(root, "login") };
+  await rm(jobConfig.outDir, { recursive: true, force: true });
+  // CODESYS writes into an open project, and the committed baseline must not change.
+  await cp(project, resolve(jobConfig.outDir, "project"), { recursive: true });
+  const worker = createCodesysWorker(jobConfig);
+  await withWorkerShutdown(jobConfig, worker, () =>
+    withWorkerLock(jobConfig, async () => {
+      const session = await worker.launch();
+      const send = (command: Record<string, unknown>) =>
+        worker.request(session, { action: "login", arguments: command }, config.timeouts.build);
+      await send({
+        command: "open",
+        project: await toWindowsPath(
+          resolve(jobConfig.outDir, "project", "Application.project"),
+          config.codesys.wine,
+        ),
+        online: config.online,
+        baseline,
+      });
+      const closed = Promise.withResolvers<void>();
+      // The worker has one mailbox, so commands run one at a time.
+      let previous: Promise<unknown> = Promise.resolve();
+      const server = Bun.serve({
+        port: options.port,
+        idleTimeout: 0,
+        fetch: async (request) => {
+          if (request.method === "GET") return Response.json({ ok: true });
+          const close = request.method === "DELETE";
+          const command = close
+            ? { command: "close" }
+            : loginCommandSchema.parse(await request.json());
+          const result = previous.then(() => send(command));
+          previous = result.catch(() => undefined);
+          try {
+            return Response.json({ ok: true, result: await result });
+          } catch (error) {
+            // The worker reports a Python traceback; its last line names the failure.
+            const message = error instanceof Error ? error.message : String(error);
+            const reason = message.trim().split("\n").at(-1) ?? message;
+            return Response.json({ ok: false, error: reason.replace(/^\w+: /, "") });
+          } finally {
+            if (close) closed.resolve();
+          }
+        },
+      });
+      await closed.promise;
+      await server.stop();
+    }),
+  );
+};

package/src/diagnostics.ts

@@ -41,6 +41,8 @@ export class CodesysCompilerError extends Error {
 
 // A failed container job publishes diagnostics separately from its successful build receipt.
 export const buildFailureFile = ".codesys/docker/failure.json";
+/** Why the last download, online change or inspection failed, for the host to report. */
+export const controllerFailureFile = ".codesys/controller/failure.txt";
 export const buildFailureSchema = z.strictObject({
   operationId: z.uuid(),
   message: z.string(),

package/src/docker-build.ts

@@ -90,6 +90,19 @@ export const configureRuntime = async () => {
   return runtimeImage;
 };
 
+export const gatewayImage = "tsplc-edge-gateway:4.22.0.0";
+
+/** Build the CODESYS Edge Gateway that builder containers reach a plant controller through. */
+export const configureGateway = async () => {
+  const context = resolve(packageDirectory, "docker/edge-gateway");
+  console.log(`Preparing the CODESYS gateway (${gatewayImage}).`);
+  await runDocker(
+    ["build", "--platform", "linux/amd64", "--progress", "plain", "-t", gatewayImage, context],
+    (status) => `Gateway image build failed (${status}). Review the image-build output`,
+  );
+  return gatewayImage;
+};
+
 export const buildInDocker = async (config: ResolvedConfig, image: string) => {
   const requestDirectory = await mkdtemp(resolve(tmpdir(), "codesys-docker-"));
   try {
@@ -98,6 +111,8 @@ export const buildInDocker = async (config: ResolvedConfig, image: string) => {
     const failurePath = resolve(config.outDir, buildFailureFile);
     await rm(failurePath, { force: true });
     const args = [
+      "run",
+      "--rm",
       ...(await prepareContainerRun(config, requestDirectory, { network: "none", sources: true })),
       image,
       "--request",

package/src/docker-run.ts

@@ -56,8 +56,9 @@ async function mountLibraries(libraries: ResolvedConfig["libraries"], directory:
 
 /**
  * Write the builder container's request and return the `docker run` options that precede
- * the image. The request names only container paths; host paths enter through these mounts,
- * and host-only Docker, CODESYS and runtime settings stay outside.
+ * the image; the caller chooses `--rm` or `--detach`. The request names only container paths;
+ * host paths enter through these mounts, and host-only Docker, CODESYS and runtime settings
+ * stay outside.
  */
 export const prepareContainerRun = async (
   config: ResolvedConfig,
@@ -83,8 +84,6 @@ export const prepareContainerRun = async (
     }),
   );
   return [
-    "run",
-    "--rm",
     "--init",
     ...(config.docker?.cpuSet ? ["--cpuset-cpus", config.docker.cpuSet] : []),
     "--network",

package/src/host/codesys-worker.ts

@@ -30,7 +30,9 @@ const sessionSchema = z.object({
 
 type Session = z.infer<typeof sessionSchema>;
 
-type WorkerCommand = { action: "build" | "online" | "ping" | "stop" };
+type WorkerCommand =
+  | { action: "build" | "online" | "ping" | "stop" }
+  | { action: "login"; arguments: Record<string, unknown> };
 
 const hasCode = (error: unknown, code: string) =>
   error instanceof Error && "code" in error && error.code === code;
@@ -170,6 +172,7 @@ export const createCodesysWorker = (config: ResolvedConfig) => {
             diagnostics: z.array(compilerDiagnosticSchema).optional(),
             id: z.literal(id),
             ok: z.boolean(),
+            result: z.unknown(),
           })
           .safeParse(result);
         if (!response.success) {
@@ -185,7 +188,7 @@ export const createCodesysWorker = (config: ResolvedConfig) => {
           }
           throw new Error(message);
         }
-        return;
+        return response.data.result;
       }
       if (!isProcessAlive(session.pid)) {
         throw new Error(
@@ -216,6 +219,7 @@ export const createCodesysWorker = (config: ResolvedConfig) => {
         JSON.stringify({
           builder: await readFile(resolve(pythonDirectory, "build.py"), "utf8"),
           online: await readFile(resolve(pythonDirectory, "codesys_online.py"), "utf8"),
+          login: await readFile(resolve(pythonDirectory, "codesys_login.py"), "utf8"),
           command: codesysCommand,
           codesys: config.codesys,
           launcher: getHostCommand(config.codesys),
@@ -242,10 +246,9 @@ export const createCodesysWorker = (config: ResolvedConfig) => {
     await mkdir(directory, { recursive: true });
     await copyFile(resolve(pythonDirectory, "build.py"), resolve(directory, "build.py"));
     await copyFile(resolve(pythonDirectory, "worker.py"), resolve(directory, "worker.py"));
-    await copyFile(
-      resolve(pythonDirectory, "codesys_online.py"),
-      resolve(directory, "codesys_online.py"),
-    );
+    for (const script of ["codesys_online.py", "codesys_login.py"]) {
+      await copyFile(resolve(pythonDirectory, script), resolve(directory, script));
+    }
     console.log(`Starting CODESYS. Log: ${directory}/codesys.log`);
     const pid = await host.startWorker(directory);
     const session = { directory, fingerprint, pid };

package/src/index.ts

@@ -8,7 +8,19 @@ export {
   type ResolvedConfig,
   resolveConfig,
 } from "./config";
-export { type ControllerResult, inspectController, updateController } from "./controller-online";
+export {
+  type ControllerLogin,
+  type ControllerResult,
+  explicitDownload,
+  findControllerLogin,
+  inspectController,
+  type LoginCommand,
+  loginCommandSchema,
+  type LoginResult,
+  loginResultSchema,
+  openControllerLogin,
+  updateController,
+} from "./controller-online";
 export { type CodesysCompilerDiagnostic, CodesysCompilerError } from "./diagnostics";
 export { runProject } from "./run";
 export { loadSources, type SourceObject } from "./sources";
@@ -22,5 +34,10 @@ export {
   type InstalledLibrary,
 } from "./libraries.ts";
 
-export { configureDocker, configureRuntime } from "./docker-build.ts";
+export {
+  configureDocker,
+  configureGateway,
+  configureRuntime,
+  gatewayImage,
+} from "./docker-build.ts";
 export { readBuild } from "./artifacts.ts";