@platforma-sdk/block-tools 2.12.2 → 2.12.4

package/dist/structure/rules/root-turbo-json.d.ts

@@ -0,0 +1,2 @@
+export declare function rootTurboJsonInitial(): Record<string, unknown>;
+export declare function rootTurboJsonRules(): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platforma-sdk/block-tools",
-  "version": "2.12.2",
+  "version": "2.12.4",
   "description": "Utility to manipulate Platforma Blocks and Block Registry",
   "license": "UNLICENSED",
   "bin": {
@@ -35,13 +35,13 @@
     "yaml": "^2.8.0",
     "zod": "~3.25.76",
     "@milaboratories/pl-http": "1.2.4",
-    "@milaboratories/pl-model-middle-layer": "1.30.11",
+    "@milaboratories/pl-model-backend": "1.4.14",
     "@milaboratories/pl-model-common": "1.46.4",
+    "@milaboratories/pl-model-middle-layer": "1.30.11",
     "@milaboratories/resolve-helper": "1.1.3",
-    "@platforma-sdk/blocks-deps-updater": "2.2.0",
-    "@milaboratories/pl-model-backend": "1.4.13",
+    "@milaboratories/ts-helpers": "1.8.4",
     "@platforma-sdk/package-builder-lib": "1.2.0",
-    "@milaboratories/ts-helpers": "1.8.4"
+    "@platforma-sdk/blocks-deps-updater": "2.2.0"
   },
   "devDependencies": {
     "@rollup/plugin-node-resolve": "^16.0.1",
@@ -56,9 +56,9 @@
     "vite": "^8.0.6",
     "vite-plugin-dts": "^4.5.3",
     "vitest": "^4.1.3",
-    "@milaboratories/ts-builder": "1.6.0",
     "@milaboratories/build-configs": "2.0.0",
-    "@milaboratories/ts-configs": "1.3.0"
+    "@milaboratories/ts-configs": "1.3.0",
+    "@milaboratories/ts-builder": "1.6.0"
   },
   "scripts": {
     "build": "vite build",

package/src/cmd/software/env.test.ts

@@ -1,14 +1,10 @@
 import { describe, it, expect } from "vitest";
-import { readFileSync } from "node:fs";
-import { fileURLToPath } from "node:url";
 import { softwareBuildCacheEnv } from "./env";
+import { rootTurboJsonInitial } from "../../structure/rules/root-turbo-json";
 
 // The block's turbo build task must cache-key on every software-build env var, declared once in the
-// structurer template. This guards against the template drifting from softwareBuildCacheEnv.
-const turboPath = fileURLToPath(
-  new URL("../../structure/templates/static/root/turbo.json", import.meta.url),
-);
-const buildEnv: string[] = JSON.parse(readFileSync(turboPath, "utf8")).tasks.build.env;
+// structurer's turbo.json rule. This guards against the rule drifting from softwareBuildCacheEnv.
+const buildEnv = (rootTurboJsonInitial().tasks as { build: { env: string[] } }).build.env;
 
 describe("block turbo build cache env", () => {
   it("declares every software-build cache var", () => {

package/src/structure/__tests__/root-turbo-json.test.ts

@@ -0,0 +1,41 @@
+// turbo.json is `managed`, not `fixed`: the engine re-asserts its own tasks
+// but must leave author-added tasks (notably `software:reqs`, which a
+// Python-block `requirements-sync` CI job runs via `turbo run software:reqs`)
+// untouched. These guard that contract.
+
+import { describe, test, expect } from "vitest";
+import { runRulesAgainst } from "../engine/testing";
+import { rootTurboJsonInitial, rootTurboJsonRules } from "../rules/root-turbo-json";
+
+describe("root turbo.json rules", () => {
+  test("corrects a drifted engine task and preserves an author task", () => {
+    const drifted = {
+      $schema: "https://turbo.build/schema.json",
+      tasks: {
+        build: { env: ["ONLY_ONE"] }, // engine task, drifted
+        "build:dev": { dependsOn: ["build"], outputs: ["./dist/**"] }, // legacy, must go
+        "software:reqs": { cache: false, outputs: ["./src/requirements.txt"] }, // author task
+      },
+    };
+
+    const out = runRulesAgainst(drifted, () => rootTurboJsonRules());
+    const tasks = out.tasks as Record<string, { env?: string[]; outputs?: string[] }>;
+
+    // Engine task re-asserted to canonical.
+    expect(tasks.build.env).toContain("PL_BUILD_CHANNEL");
+    expect(tasks.build.outputs).toEqual(["./dist/**", "./block-pack/**", "./pkg-*.tgz"]);
+    // Legacy task pruned.
+    expect(tasks["build:dev"]).toBeUndefined();
+    // Author task left exactly as it was.
+    expect(tasks["software:reqs"]).toEqual({ cache: false, outputs: ["./src/requirements.txt"] });
+    expect(out.globalDependencies).toEqual(["tsconfig.json"]);
+  });
+
+  test("initial owns the engine tasks but not software:reqs or legacy build:dev", () => {
+    const keys = Object.keys(rootTurboJsonInitial().tasks as Record<string, unknown>);
+    expect(keys).toContain("build");
+    expect(keys).toContain("test");
+    expect(keys).not.toContain("software:reqs");
+    expect(keys).not.toContain("build:dev");
+  });
+});

package/src/structure/rules/root-turbo-json.ts

@@ -0,0 +1,71 @@
+// Root `turbo.json`: the initial generator and the drift-correcting body
+// rules, co-located. Managed (not fixed) so the engine OWNS its own task
+// graph but LEAVES author-added tasks alone — `ensureFieldEntries("tasks", …)`
+// merges the canonical engine tasks over whatever is there, preserving any
+// other key under `tasks`.
+//
+// Why this matters: blocks with a Python software package carry a
+// `software:reqs` task (a `requirements-sync` CI job runs `turbo run
+// software:reqs`). When turbo.json was `fixed`, every `upgrade-sdk` wiped that
+// task and CI failed with "Could not find task software:reqs". `software:reqs`
+// is deliberately NOT in the engine-owned set below — it (and any custom task)
+// is author-owned and survives refresh via the merge.
+
+import { ensureField, ensureFieldEntries, removeField, enforceFieldOrder } from "../engine/api";
+
+const SCHEMA = "https://turbo.build/schema.json";
+const GLOBAL_DEPENDENCIES = ["tsconfig.json"];
+
+// The tasks the engine owns. Re-asserted on every refresh; author tasks
+// (e.g. `software:reqs`) are merged around these, never clobbered.
+const ENGINE_TASKS: Record<string, unknown> = {
+  fmt: { cache: false },
+  check: { dependsOn: ["^build"], outputs: [] },
+  build: {
+    dependsOn: ["^build", "check"],
+    inputs: ["$TURBO_DEFAULT$"],
+    env: [
+      "PL_DOCKER_REGISTRY_PUSH_TO",
+      "PL_BUILD_CHANNEL",
+      "PL_BUILD_VARIANT",
+      "PL_BUILD_LOCATION",
+      "PL_BUILD_USE_PUBLISHED",
+      "PL_DEV_DOCKER_PUSH_URL",
+      "PL_DEV_DOCKER_PULL_URL",
+      "PL_DEV_BINARY_UPLOAD_URL",
+      "PL_RELEASE_DOCKER_PUSH_URL",
+      "PL_RELEASE_DOCKER_PULL_URL",
+      "PL_RELEASE_BINARY_UPLOAD_URL",
+      "PL_REGISTRY_PLATFORMA_OPEN_UPLOAD_URL",
+    ],
+    passThroughEnv: ["AWS_*", "PL_AWS_*"],
+    outputs: ["./dist/**", "./block-pack/**", "./pkg-*.tgz"],
+  },
+  "do-pack": { dependsOn: ["build"], outputs: ["package.tgz"] },
+  test: {
+    dependsOn: ["build", "check"],
+    passThroughEnv: ["PL_ADDRESS", "PL_TEST_PASSWORD", "PL_TEST_USER", "PL_TEST_PROXY", "DEBUG"],
+  },
+  "mark-stable": { passThroughEnv: ["PL_REGISTRY", "AWS_*"], cache: false },
+};
+
+export function rootTurboJsonInitial(): Record<string, unknown> {
+  return {
+    $schema: SCHEMA,
+    globalDependencies: GLOBAL_DEPENDENCIES,
+    tasks: { ...ENGINE_TASKS },
+  };
+}
+
+export function rootTurboJsonRules(): void {
+  ensureField("$schema", SCHEMA);
+  ensureField("globalDependencies", GLOBAL_DEPENDENCIES);
+  // Merge the engine tasks, preserving any author task (software:reqs, …).
+  ensureFieldEntries("tasks", ENGINE_TASKS);
+  // Legacy single-dev-build task, superseded by the env-parameterised `build`
+  // task + `build:dev-*` package scripts (software-build spec). The
+  // root package.json rule likewise drops the `build:dev` script; drop the
+  // matching turbo task so migrated blocks converge.
+  removeField("tasks.build:dev");
+  enforceFieldOrder(["$schema", "globalDependencies", "tasks"]);
+}

package/src/structure/rules/root.ts

@@ -5,6 +5,7 @@
 
 import { scope, when, fixed, managed, file, generate } from "../engine/api";
 import { rootPackageJsonInitial, rootPackageJsonRules } from "./root-package-json";
+import { rootTurboJsonInitial, rootTurboJsonRules } from "./root-turbo-json";
 import { rootPnpmWorkspaceInitial, rootPnpmWorkspaceRules } from "./root-pnpm-workspace";
 import { rootGitignoreRules } from "./root-gitignore";
 
@@ -13,7 +14,13 @@ export function rootRules(): void {
     when(
       ({ ctx }) => !ctx.isSdkInternal,
       () => {
-        fixed("turbo.json", file("root/turbo.json"));
+        managed(
+          "turbo.json",
+          generate(() => rootTurboJsonInitial()),
+          () => {
+            rootTurboJsonRules();
+          },
+        );
         fixed(".vscode/settings.json", file("root/.vscode/settings.json"));
 
         managed(

package/src/structure/templates/static/test/.oxfmtrc.json

@@ -1,4 +1,4 @@
 {
   "extends": ["node_modules/@milaboratories/ts-builder/configs/oxfmt.json"],
-  "ignorePatterns": ["dist", "coverage", "CHANGELOG.md"]
+  "ignorePatterns": ["dist", "coverage", "CHANGELOG.md", ".test_auth.json"]
 }

package/src/structure/templates/static/root/turbo.json

@@ -1,49 +0,0 @@
-{
-  "$schema": "https://turbo.build/schema.json",
-  "globalDependencies": ["tsconfig.json"],
-  "tasks": {
-    "fmt": {
-      "cache": false
-    },
-    "check": {
-      "dependsOn": ["^build"],
-      "outputs": []
-    },
-    "build": {
-      "dependsOn": ["^build", "check"],
-      "inputs": ["$TURBO_DEFAULT$"],
-      "env": [
-        "PL_DOCKER_REGISTRY_PUSH_TO",
-        "PL_BUILD_CHANNEL",
-        "PL_BUILD_VARIANT",
-        "PL_BUILD_LOCATION",
-        "PL_BUILD_USE_PUBLISHED",
-        "PL_DEV_DOCKER_PUSH_URL",
-        "PL_DEV_DOCKER_PULL_URL",
-        "PL_DEV_BINARY_UPLOAD_URL",
-        "PL_RELEASE_DOCKER_PUSH_URL",
-        "PL_RELEASE_DOCKER_PULL_URL",
-        "PL_RELEASE_BINARY_UPLOAD_URL",
-        "PL_REGISTRY_PLATFORMA_OPEN_UPLOAD_URL"
-      ],
-      "passThroughEnv": ["AWS_*", "PL_AWS_*"],
-      "outputs": ["./dist/**", "./block-pack/**", "./pkg-*.tgz"]
-    },
-    "build:dev": {
-      "dependsOn": ["build"],
-      "outputs": ["./dist/**"]
-    },
-    "do-pack": {
-      "dependsOn": ["build"],
-      "outputs": ["package.tgz"]
-    },
-    "test": {
-      "dependsOn": ["build", "check"],
-      "passThroughEnv": ["PL_ADDRESS", "PL_TEST_PASSWORD", "PL_TEST_USER", "PL_TEST_PROXY", "DEBUG"]
-    },
-    "mark-stable": {
-      "passThroughEnv": ["PL_REGISTRY", "AWS_*"],
-      "cache": false
-    }
-  }
-}