@tsplc/build 0.2.5 → 0.2.7

package/src/controller-session.ts

@@ -1,5 +1,5 @@
 import { createHash, randomUUID } from "node:crypto";
-import { copyFile, cp, mkdir, readdir, readFile, rm, writeFile } from "node:fs/promises";
+import { cp, mkdir, readdir, readFile, rm, writeFile } from "node:fs/promises";
 import { resolve } from "node:path";
 import { z } from "zod";
 import type { ResolvedConfig } from "./config";
@@ -123,12 +123,11 @@ export const runControllerSession = async (
   const candidate = resolve(root, "generations", generation);
   const project = resolve(candidate, "project", "Application.project");
   await mkdir(resolve(candidate, "project"), { recursive: true });
+  // A download saves the template here, with its controller and device tree.
   if (previous) {
     await cp(previous.project, resolve(candidate, "project"), {
       recursive: true,
     });
-  } else {
-    await copyFile(config.template, project);
   }
   const jobConfig = {
     ...config,
@@ -140,11 +139,16 @@ export const runControllerSession = async (
   const request = {
     libraryReferences: config.libraryReferences,
     // A download starts from the template; an online change keeps the downloaded project's tree.
-    ...(config.deviceTree &&
-      operation === "download" && {
+    ...(operation === "download" && {
+      template: await toWindowsPath(config.template, config.codesys.wine),
+      templateHash,
+      // Kept across jobs: generating a device tree takes minutes, and the same inputs make the same one.
+      caches: await toWindowsPath(root, config.codesys.wine),
+      ...(config.deviceTree && {
         deviceTree: await writeDeviceTree(config.deviceTree, requestDirectory),
         devices: await toWindowsPath(requestDirectory, config.codesys.wine),
       }),
+    }),
     libraries: await Promise.all(
       (config.libraries ?? []).map(async (library) => ({
         ...library,

package/src/docker-build.ts

@@ -13,6 +13,31 @@ import { packageDirectory } from "./package-path.ts";
 
 const execute = promisify(execFile);
 
+/** Each tsPLC version's images, published so that setup pulls them instead of installing CODESYS. */
+export const publishedImage = async (image: string) => {
+  const { version } = JSON.parse(
+    await readFile(resolve(packageDirectory, "package.json"), "utf8"),
+  ) as { version: string };
+  return `ghcr.io/livingforjesus/${image.split(":")[0]}:${version}`;
+};
+
+/** Pulls this version's published `image`; false when it isn't available, so the caller builds it. */
+const pullPublished = async (image: string) => {
+  const published = await publishedImage(image);
+  console.log(`Pulling ${published}`);
+  try {
+    await runDocker(
+      ["pull", "--platform", "linux/amd64", published],
+      (status) => `Docker pull failed (${status})`,
+    );
+  } catch {
+    console.log(`${published} is not available; building ${image} locally instead.`);
+    return false;
+  }
+  await runDocker(["tag", published, image], (status) => `Docker tag failed (${status})`);
+  return true;
+};
+
 /** Install the IDE and its prerequisites in the Docker builder image. */
 export const configureDocker = async () => {
   const image = dockerImage;
@@ -30,6 +55,7 @@ export const configureDocker = async () => {
   if (!arm && architecture !== "linux/x86_64" && architecture !== "linux/amd64") {
     throw new Error("The builder requires a Linux Docker server on ARM64 or AMD64");
   }
+  if (await pullPublished(image)) return image;
   const context = await mkdtemp(resolve(tmpdir(), "codesys-installer-"));
   let buildContext: string | undefined;
   try {
@@ -94,6 +120,7 @@ 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 () => {
+  if (await pullPublished(gatewayImage)) return gatewayImage;
   const context = resolve(packageDirectory, "docker/edge-gateway");
   console.log(`Preparing the CODESYS gateway (${gatewayImage}).`);
   await runDocker(

package/src/host/codesys-worker.ts

@@ -218,6 +218,7 @@ export const createCodesysWorker = (config: ResolvedConfig) => {
       .update(
         JSON.stringify({
           builder: await readFile(resolve(pythonDirectory, "build.py"), "utf8"),
+          hardware: await readFile(resolve(pythonDirectory, "hardware.py"), "utf8"),
           online: await readFile(resolve(pythonDirectory, "codesys_online.py"), "utf8"),
           login: await readFile(resolve(pythonDirectory, "codesys_login.py"), "utf8"),
           command: codesysCommand,
@@ -244,9 +245,13 @@ export const createCodesysWorker = (config: ResolvedConfig) => {
     const directory = resolve(config.outDir, ".codesys/worker");
     await rm(directory, { recursive: true, force: true });
     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"));
-    for (const script of ["codesys_online.py", "codesys_login.py"]) {
+    for (const script of [
+      "build.py",
+      "hardware.py",
+      "worker.py",
+      "codesys_online.py",
+      "codesys_login.py",
+    ]) {
       await copyFile(resolve(pythonDirectory, script), resolve(directory, script));
     }
     console.log(`Starting CODESYS. Log: ${directory}/codesys.log`);