From f9cf596b3cee77e0070e2decda5cbab259b10471 Mon Sep 17 00:00:00 2001 From: Ruben Fiszel Date: Wed, 11 Nov 2026 10:52:22 +0000 Subject: [PATCH] fix: carry every compared field through fork deploy and diff (#12348) * fix: carry folder display names through fork deploy and diff Co-Authored-By: Claude Opus 5.5 * test: fold the folder display name check into the existing deploy test Co-Authored-By: Claude Opus 5.5 * fix: carry resource types' file settings and resources' type through fork deploy Co-Authored-By: Claude Opus 5.5 * chore: bump windmill-utils-internal to 1.8.6 Co-Authored-By: Claude Opus 5.5 * fix: document folder display_name in the api and pick up windmill-utils-internal 1.8.6 Co-Authored-By: Claude Opus 5.5 --------- Co-authored-by: Claude Opus 5.5 --- backend/windmill-api/openapi.yaml | 7 ++++ cli/test/deploy_labels_unit.test.ts | 39 +++++++++++++++++++ cli/windmill-utils-internal/package-lock.json | 4 +- cli/windmill-utils-internal/package.json | 4 +- cli/windmill-utils-internal/src/deploy.ts | 34 +++++++++++++--- frontend/package-lock.json | 8 ++-- frontend/package.json | 2 +- frontend/src/lib/utils_workspace_deploy.ts | 1 + 8 files changed, 85 insertions(+), 14 deletions(-) diff --git a/backend/windmill-api/openapi.yaml b/backend/windmill-api/openapi.yaml index 18c73376d8..73defc5d4a 100644 --- a/backend/windmill-api/openapi.yaml +++ b/backend/windmill-api/openapi.yaml @@ -24445,6 +24445,9 @@ paths: properties: name: type: string + display_name: + type: string + description: Defaults to the name. summary: type: string owners: @@ -24489,6 +24492,8 @@ paths: properties: summary: type: string + display_name: + type: string owners: type: array items: @@ -37645,6 +37650,8 @@ components: properties: name: type: string + display_name: + type: string owners: type: array items: diff --git a/cli/test/deploy_labels_unit.test.ts b/cli/test/deploy_labels_unit.test.ts index 2686eb8cc6..f630500a62 100644 --- a/cli/test/deploy_labels_unit.test.ts +++ b/cli/test/deploy_labels_unit.test.ts @@ -19,6 +19,7 @@ test("deployItem: carries labels for variables, resources and folders", async () }), getFolder: async () => ({ name: "x", + display_name: "X folder", owners: [], extra_perms: {}, labels, @@ -64,6 +65,44 @@ test("deployItem: carries labels for variables, resources and folders", async () "updateVariable", ]); for (const [, body] of writes) expect(body.labels).toEqual(labels); + // The compare page flags a folder whose display name differs, so dropping it leaves a + // conflict no deploy can clear. + for (const [fn, body] of writes) { + if (fn.endsWith("Folder")) expect(body.display_name).toEqual("X folder"); + if (fn.endsWith("Resource")) expect(body.resource_type).toEqual("postgresql"); + } +}); + +test("deployItem: carries a resource type's file settings and clears unset ones", async () => { + const bodies: Record = {}; + const deploy = (exists: boolean, rt: any) => + deployItem( + { + existsResourceType: async () => exists, + getResourceType: async () => rt, + createResourceType: async (p: any) => void (bodies.create = p.requestBody), + updateResourceType: async (p: any) => void (bodies.update = p.requestBody), + } as any, + "resource_type", + "csv_file", + "src", + "dst", + ); + for (const rt of [ + { name: "csv_file", schema: {}, format_extension: "csv" }, + { name: "csv_file", schema: {}, is_fileset: true }, + ]) { + await deploy(false, rt); + await deploy(true, rt); + for (const body of [bodies.create, bodies.update]) { + expect(body.format_extension ?? undefined).toEqual(rt.format_extension); + expect(body.is_fileset ?? false).toEqual(rt.is_fileset ?? false); + } + } + // A type that stopped being a file type reads back without the fields. + await deploy(true, { name: "csv_file", schema: {} }); + expect(bodies.update.format_extension).toBeNull(); + expect(bodies.update.is_fileset).toEqual(false); }); test("deployItem: clears a folder's labels when the source has none", async () => { diff --git a/cli/windmill-utils-internal/package-lock.json b/cli/windmill-utils-internal/package-lock.json index 3babfd3631..f28668938c 100644 --- a/cli/windmill-utils-internal/package-lock.json +++ b/cli/windmill-utils-internal/package-lock.json @@ -1,12 +1,12 @@ { "name": "windmill-utils-internal", - "version": "1.8.4", + "version": "1.8.6", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "windmill-utils-internal", - "version": "1.8.4", + "version": "1.8.6", "license": "Apache 2.0", "devDependencies": { "@types/node": "^24.2.0", diff --git a/cli/windmill-utils-internal/package.json b/cli/windmill-utils-internal/package.json index 4b3c96903d..2b80f84f81 100644 --- a/cli/windmill-utils-internal/package.json +++ b/cli/windmill-utils-internal/package.json @@ -1,6 +1,6 @@ { "name": "windmill-utils-internal", - "version": "1.8.4", + "version": "1.8.6", "description": "Internal utility functions for Windmill", "main": "dist/cjs/index.js", "module": "dist/esm/index.js", @@ -36,4 +36,4 @@ "files": [ "dist/**/*" ] -} \ No newline at end of file +} diff --git a/cli/windmill-utils-internal/src/deploy.ts b/cli/windmill-utils-internal/src/deploy.ts index 77d093f74f..babb2f8a90 100644 --- a/cli/windmill-utils-internal/src/deploy.ts +++ b/cli/windmill-utils-internal/src/deploy.ts @@ -665,6 +665,7 @@ export async function deployItem( requestBody: { path, value, + resource_type: resource.resource_type, description: resource.description ?? "", labels: resource.labels, ...agentPreserve, @@ -695,6 +696,11 @@ export async function deployItem( requestBody: { schema: rt.schema, description: rt.description ?? "", + is_fileset: rt.is_fileset ?? false, + // An omitted extension or name is left unchanged, so an unset one is sent as null + // to clear what the target has. + format_extension: rt.format_extension ?? null, + display_name: rt.display_name ?? null, }, }); } else { @@ -704,6 +710,9 @@ export async function deployItem( name: rt.name, schema: rt.schema, description: rt.description ?? "", + is_fileset: rt.is_fileset, + format_extension: rt.format_extension, + display_name: rt.display_name, }, }); } @@ -718,6 +727,7 @@ export async function deployItem( workspace: workspaceTo, name, requestBody: { + display_name: folder.display_name, owners: folder.owners, extra_perms: folder.extra_perms, summary: folder.summary ?? undefined, @@ -731,6 +741,7 @@ export async function deployItem( workspace: workspaceTo, requestBody: { name, + display_name: folder.display_name, owners: folder.owners, extra_perms: folder.extra_perms, summary: folder.summary ?? undefined, @@ -916,6 +927,7 @@ export async function getItemValue( return { summary: flow.summary, description: flow.description, + schema: flow.schema, value: flow.value, job_token_scopes: flow.job_token_scopes ?? null, }; @@ -926,6 +938,7 @@ export async function getItemValue( lock: script.lock, schema: script.schema, summary: script.summary, + description: script.description, language: script.language, job_token_scopes: script.job_token_scopes ?? null, }; @@ -945,15 +958,25 @@ export async function getItemValue( }; } else if (kind === "resource") { const resource = await provider.getResource({ workspace, path }); + let value = resource.value; // Each workspace resolves its own agent identity, which a deploy never copies. - if (resource.resource_type === "ai_agent" && resource.value) { - const { on_behalf_of: _, ...value } = resource.value; - return value; + if (resource.resource_type === "ai_agent" && value) { + const { on_behalf_of: _, ...rest } = value; + value = rest; } - return resource.value; + return { + value, + description: resource.description, + resource_type: resource.resource_type, + }; } else if (kind === "resource_type") { const rt = await provider.getResourceType({ workspace, path }); - return rt.schema; + return { + schema: rt.schema, + description: rt.description, + format_extension: rt.format_extension, + is_fileset: rt.is_fileset, + }; } else if (kind === "folder") { const folder = await provider.getFolder({ workspace, @@ -961,6 +984,7 @@ export async function getItemValue( }); return { name: folder.name, + display_name: folder.display_name, owners: folder.owners, extra_perms: folder.extra_perms, summary: folder.summary, diff --git a/frontend/package-lock.json b/frontend/package-lock.json index c865ebff73..ebd99794c8 100644 --- a/frontend/package-lock.json +++ b/frontend/package-lock.json @@ -110,7 +110,7 @@ "windmill-parser-wasm-wac": "1.830.0", "windmill-parser-wasm-yaml": "1.770.0", "windmill-sql-datatype-parser-wasm": "1.512.0", - "windmill-utils-internal": "1.8.4", + "windmill-utils-internal": "1.8.6", "xterm": "^5.3.0", "xterm-readline": "^1.1.2", "y-monaco": "^0.1.4", @@ -14719,9 +14719,9 @@ "integrity": "sha512-uHNL8F72/Tf96xF3hOHnPDjkEyqXw7fNjcPJiUhth9sTQkcwUIoJMOdwm8/cs+j9kKVRJ4tgNYMHEBLylazp6g==" }, "node_modules/windmill-utils-internal": { - "version": "1.8.4", - "resolved": "https://registry.npmjs.org/windmill-utils-internal/-/windmill-utils-internal-1.8.4.tgz", - "integrity": "sha512-s27Di5z/vonhMLd52P4i3iILQyty6ZIXYc89CCdkKZzseE6WiX/VMwdTF4nvNCjV3xN0WhAtXR+/PBhzarU2GQ==", + "version": "1.8.6", + "resolved": "https://registry.npmjs.org/windmill-utils-internal/-/windmill-utils-internal-1.8.6.tgz", + "integrity": "sha512-jzHhEZ3xSBf90zektXaAIhAu9wLo5RMtYshvjg5if8jjEJvWENd+WQzEbod8Sr+SzMUbmmF4ArefqN15f2XtHw==", "license": "Apache 2.0" }, "node_modules/word-wrap": { diff --git a/frontend/package.json b/frontend/package.json index b824b787f8..2801bb6c35 100644 --- a/frontend/package.json +++ b/frontend/package.json @@ -177,7 +177,7 @@ "windmill-parser-wasm-wac": "1.830.0", "windmill-parser-wasm-yaml": "1.770.0", "windmill-sql-datatype-parser-wasm": "1.512.0", - "windmill-utils-internal": "1.8.4", + "windmill-utils-internal": "1.8.6", "xterm": "^5.3.0", "xterm-readline": "^1.1.2", "y-monaco": "^0.1.4", diff --git a/frontend/src/lib/utils_workspace_deploy.ts b/frontend/src/lib/utils_workspace_deploy.ts index 272b2f1dad..868721e3cd 100644 --- a/frontend/src/lib/utils_workspace_deploy.ts +++ b/frontend/src/lib/utils_workspace_deploy.ts @@ -694,6 +694,7 @@ export async function createFolderIfAbsent( workspace: workspaceTo, requestBody: { name, + display_name: folder.display_name, owners: owners.map(translate).filter((p): p is string => !!p), extra_perms: Object.fromEntries( acl.flatMap(([p, write]) => {