A platform for community discussion. Free, open, simple.
FIX: Keep stored workflow node parameters in sync with runtime defaults (#44421)
Régis Hanol8bd04ddfadc4
diff --git a/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/canvas/canvas-file-io.js b/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/canvas/canvas-file-io.jsindex 57010336e43..3eb6fa77371 100644--- a/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/canvas/canvas-file-io.js+++ b/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/canvas/canvas-file-io.js@@ -83,7 +83,6 @@ export function buildWorkflowExportPayload(const allNodes = [...exportedNodes, ...exportedStickyNotes];return {- id: workflowMetadata.id?.toString() || null,name: workflowMetadata.name || null,nodes: allNodes,connections: serializeConnections(connections || [], [@@ -92,10 +91,6 @@ export function buildWorkflowExportPayload(]),settings: cloneObject(workflowMetadata.settings),staticData: cloneObject(workflowMetadata.staticData),- pinData: cloneObject(workflowMetadata.pinData),- versionId: workflowMetadata.versionId || null,- activeVersionId: workflowMetadata.activeVersionId || null,- versionCounter: workflowMetadata.versionCounter || null,};}diff --git a/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/editor/index.gjs b/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/editor/index.gjsindex 4cb1488399f..428dba0c7bc 100644--- a/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/editor/index.gjs+++ b/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/editor/index.gjs@@ -680,6 +680,7 @@ export default class WorkflowsEditor extends Component {position,{typeVersion: nodeTypeVersion(nodeType),+ nodeTypes: this.workflowsNodeTypes.nodeTypes,configOverrides,});@@ -790,6 +791,7 @@ export default class WorkflowsEditor extends Component {null,{typeVersion: nodeTypeVersion(nodeType),+ nodeTypes: this.workflowsNodeTypes.nodeTypes,});@@ -1372,6 +1374,7 @@ export default class WorkflowsEditor extends Component {position,{typeVersion: nodeTypeVersion(nodeType),+ nodeTypes: this.workflowsNodeTypes.nodeTypes,configOverrides,});diff --git a/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/editor/node-factory.js b/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/editor/node-factory.jsindex 22026f1efd5..d2ecf244fc9 100644--- a/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/editor/node-factory.js+++ b/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/editor/node-factory.js@@ -1,5 +1,9 @@import { applyValueTransformer } from "discourse/lib/transformer";import { i18n } from "discourse-i18n";+import {+ applySchemaDefaults,+ getPropertySchema,+} from "../../../lib/workflows/property-engine";import { STICKY_NOTE_NAME } from "../../../models/sticky-note";import WorkflowNode from "../../../models/workflow-node";@@ -39,13 +43,24 @@ export function createNode(identifier,existingNodes,position = null,- { typeVersion = null, configOverrides = null } = {}+ { typeVersion = null, configOverrides = null, nodeTypes = null } = {}) {const allDefaults = applyValueTransformer("workflow-node-defaults",NODE_DEFAULTS);const defaultsFn = allDefaults[identifier];+ const configuration = {+ ...(defaultsFn ? defaultsFn() : {}),+ ...(configOverrides || {}),+ };++ if (nodeTypes) {+ applySchemaDefaults(+ getPropertySchema(nodeTypes, identifier, typeVersion),+ configuration+ );+ }return WorkflowNode.create({type: identifier,@@ -54,10 +69,7 @@ export function createNode(defaultNodeName(identifier),takenNodeNames(existingNodes)),- configuration: {- ...(defaultsFn ? defaultsFn() : {}),- ...(configOverrides || {}),- },+ configuration,position,});}diff --git a/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/node/configurator.gjs b/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/node/configurator.gjsindex 4a3376b2ea6..236172cb59d 100644--- a/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/node/configurator.gjs+++ b/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/node/configurator.gjs@@ -31,12 +31,13 @@ import {typeVersionForNode,} from "../../../lib/workflows/node-types";import {+ applySchemaDefaults,credentialSlotAnchorField,credentialSlotVisible,credentialTypesForSlot,- fieldType,findNodeType,getPropertySchema,+ pruneModeHiddenFields,} from "../../../lib/workflows/property-engine";import { runExecuteStep } from "../canvas/canvas-execute-step";import { shouldShowExecuteStep } from "../canvas/workflow-node";@@ -263,11 +264,17 @@ export default class NodeConfigurator extends Component {get isDirty() {const nameDirty = this.nodeName !== this.initialNodeName;const configurationDirty =- JSON.stringify(this.configuration) !==- JSON.stringify(this.initialConfiguration);+ JSON.stringify(this.persistedConfiguration) !==+ JSON.stringify(+ pruneModeHiddenFields(this.propertySchema, this.initialConfiguration)+ );return nameDirty || configurationDirty;}+ get persistedConfiguration() {+ return pruneModeHiddenFields(this.propertySchema, this.configuration);+ }+get showSaveStatus() {return this.saveStatus === "saving" || this.saveStatus === "saved";}@@ -397,7 +404,7 @@ export default class NodeConfigurator extends Component {if (this.isDirty) {cancel(this.autosaveTimer);this.args.model.onSave(- this.configuration,+ this.persistedConfiguration,this.trimmedNodeName || this.initialNodeName);}@@ -422,32 +429,10 @@ export default class NodeConfigurator extends Component {async #loadTypes() {this.nodeTypes = await this.workflowsNodeTypes.load();- this.#applyDefaults();+ applySchemaDefaults(this.propertySchema, this.initialConfiguration);this.#setSavedBaseline(this.configuration, this.initialNodeName);}- #applyDefaults() {- const config = this.initialConfiguration;-- for (const [key, fs] of Object.entries(this.propertySchema)) {- if (config[key] != null) {- continue;- }- if (fs.default !== undefined) {- config[key] = fs.default;- } else if (- fieldType(fs) === "collection" ||- fieldType(fs) === "fixed_collection"- ) {- config[key] = {};- } else if (fieldType(fs) === "assignment_collection") {- config[key] = { assignments: [] };- } else if (fieldType(fs) === "array") {- config[key] = [];- }- }- }-#cancelTimers() {cancel(this.autosaveTimer);cancel(this.savedFadeTimer);@@ -492,7 +477,7 @@ export default class NodeConfigurator extends Component {return;}- const configuration = structuredClone(this.configuration);+ const configuration = structuredClone(this.persistedConfiguration);const nodeName = this.trimmedNodeName || this.initialNodeName;this.#setSavingStatus();diff --git a/plugins/discourse-workflows/admin/assets/javascripts/admin/lib/workflows/property-engine.js b/plugins/discourse-workflows/admin/assets/javascripts/admin/lib/workflows/property-engine.jsindex 5276cc50392..37480f393d0 100644--- a/plugins/discourse-workflows/admin/assets/javascripts/admin/lib/workflows/property-engine.js+++ b/plugins/discourse-workflows/admin/assets/javascripts/admin/lib/workflows/property-engine.js@@ -304,6 +304,30 @@ export function fixedCollectionRows(value, groupName = "values") {return [];}+const MATERIALIZED_CONTAINER_TYPES = [+ "collection",+ "fixed_collection",+ "assignment_collection",+ "array",+];++export function applySchemaDefaults(schema = {}, config = {}) {+ for (const [key, fieldSchema] of Object.entries(schema)) {+ if (config[key] != null) {+ continue;+ }++ const type = fieldType(fieldSchema);+ if (fieldSchema.default !== undefined) {+ config[key] = cloneValue(fieldSchema.default);+ } else if (MATERIALIZED_CONTAINER_TYPES.includes(type)) {+ config[key] = fallbackValueForType(type);+ }+ }++ return config;+}+export function fieldType(schema = {}) {return schema.type || "string";}@@ -466,6 +490,21 @@ export function fieldDefinitelyVisible(schema = {}, configuration = {}) {return fieldDisplayState(schema, configuration) === "visible";}+export function pruneModeHiddenFields(schema = {}, configuration = {}) {+ const pruned = { ...configuration };++ for (const [name, field] of Object.entries(schema)) {+ if (fieldUi(field).hidden) {+ continue;+ }+ if (fieldDisplayState(field, configuration) === "hidden") {+ delete pruned[name];+ }+ }++ return pruned;+}+function rulesOutcome(rules, configuration) {let unknown = false;diff --git a/plugins/discourse-workflows/test/javascripts/unit/lib/workflows-canvas-file-io-test.js b/plugins/discourse-workflows/test/javascripts/unit/lib/workflows-canvas-file-io-test.jsindex db53a6f49c9..8a4b9b13efc 100644--- a/plugins/discourse-workflows/test/javascripts/unit/lib/workflows-canvas-file-io-test.js+++ b/plugins/discourse-workflows/test/javascripts/unit/lib/workflows-canvas-file-io-test.js@@ -39,15 +39,13 @@ module("Unit | lib | discourse-workflows | canvas-file-io", function () {versionCounter: 3,});- assert.strictEqual(payload.id, "42");- assert.strictEqual(payload.name, "Imported workflow");- assert.deepEqual(payload.settings, { executionOrder: "v1" });- assert.deepEqual(payload.staticData, { "node:Send request": { count: 1 } });- assert.deepEqual(payload.pinData, { "node-1": [{ json: { ok: true } }] });- assert.strictEqual(payload.versionId, "version-1");- assert.strictEqual(payload.activeVersionId, "version-1");- assert.strictEqual(payload.versionCounter, 3);- assert.deepEqual(payload.connections, {});+ assert.deepEqual(payload, {+ name: "Imported workflow",+ nodes: payload.nodes,+ connections: {},+ settings: { executionOrder: "v1" },+ staticData: { "node:Send request": { count: 1 } },+ });assert.deepEqual(payload.nodes[0].credentials, {auth: {id: "42",diff --git a/plugins/discourse-workflows/test/javascripts/unit/lib/workflows-node-factory-test.js b/plugins/discourse-workflows/test/javascripts/unit/lib/workflows-node-factory-test.jsindex 74e8b074a28..8176f64451a 100644--- a/plugins/discourse-workflows/test/javascripts/unit/lib/workflows-node-factory-test.js+++ b/plugins/discourse-workflows/test/javascripts/unit/lib/workflows-node-factory-test.js@@ -45,6 +45,29 @@ module("Unit | lib | discourse-workflows | node-factory", function (hooks) {);});+ test("createNode materializes schema defaults when node types are known", function (assert) {+ const nodeTypes = [+ {+ identifier: "flow:wait",+ properties: {+ wait_amount: { type: "integer", default: 1 },+ wait_unit: { type: "options", default: "hours" },+ webhook_suffix: { type: "string" },+ },+ },+ ];++ const node = createNode("flow:wait", [], null, {+ nodeTypes,+ configOverrides: { wait_amount: 2 },+ });++ assert.deepEqual(node.configuration, {+ wait_amount: 2,+ wait_unit: "hours",+ });+ });+test("createNode returns a node with correct type and default version", function (assert) {const node = createNode("trigger:webhook", []);assert.strictEqual(node.type, "trigger:webhook");diff --git a/plugins/discourse-workflows/test/javascripts/unit/lib/workflows-property-engine-test.js b/plugins/discourse-workflows/test/javascripts/unit/lib/workflows-property-engine-test.jsindex 6a46d893ae8..dcb0cb8f651 100644--- a/plugins/discourse-workflows/test/javascripts/unit/lib/workflows-property-engine-test.js+++ b/plugins/discourse-workflows/test/javascripts/unit/lib/workflows-property-engine-test.js@@ -20,6 +20,7 @@ import {propertyOptionLabel,propertyPlaceholder,propertySelectNoneKey,+ pruneModeHiddenFields,} from "discourse/plugins/discourse-workflows/admin/lib/workflows/property-engine";module("Unit | Utility | workflows property engine", function () {@@ -32,6 +33,39 @@ module("Unit | Utility | workflows property engine", function () {ui: { i18n_scope: "data_table_node" },};+ test("pruneModeHiddenFields drops fields hidden by the current mode only", function (assert) {+ const schema = {+ resume: { type: "options" },+ wait_amount: { display_options: { show: { resume: ["time_interval"] } } },+ webhook_suffix: { display_options: { show: { resume: ["webhook"] } } },+ channel_name: { ui: { hidden: true } },+ notes: {},+ };+ const configuration = {+ resume: "time_interval",+ wait_amount: 2,+ webhook_suffix: "abc",+ channel_name: "Staff",+ notes: "",+ alwaysOutputData: false,+ };++ assert.deepEqual(pruneModeHiddenFields(schema, configuration), {+ resume: "time_interval",+ wait_amount: 2,+ channel_name: "Staff",+ notes: "",+ alwaysOutputData: false,+ });+ assert.deepEqual(+ pruneModeHiddenFields(schema, {+ ...configuration,+ resume: "={{ $json.mode }}",+ }),+ { ...configuration, resume: "={{ $json.mode }}" }+ );+ });+test("derives the translation scope from the node identifier", function (assert) {assert.strictEqual(i18nScope("action:topic"), "topic");assert.strictEqual(i18nScope(dataTableNodeType), "data_table_node");