Skip to content

A platform for community discussion. Free, open, simple.

FIX: Keep workflow node names unique when renaming and importing (#42629)

Régis Hanola3a4992aef29
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.js
index ddb933b6b38..57010336e43 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
@@ -7,6 +7,7 @@ import {
import WorkflowNode, {
NODE_DIRECT_SETTING_KEYS,
} from "../../../models/workflow-node";
+import { defaultNodeName } from "../editor/node-factory";
function sanitizeImportedObject(value) {
if (!value || typeof value !== "object" || Array.isArray(value)) {
@@ -51,6 +52,13 @@ function directSettingsFromImportedNode(node) {
return settings;
}
+// an imported file is arbitrary user input, so a node can arrive with a missing
+// or non-string name that the server would then reject on every later save
+function importedNodeName(node) {
+ const name = typeof node.name === "string" ? node.name.trim() : "";
+ return name || defaultNodeName(node.type);
+}
+
function hasUnsupportedNodeKey(node) {
if (!node || typeof node !== "object") {
return false;
@@ -147,7 +155,7 @@ export function parseWorkflowImport(text) {
clientId: crypto.randomUUID(),
type: n.type,
typeVersion: n.typeVersion,
- name: n.name,
+ name: importedNodeName(n),
parameters: sanitizeImportedObject(n.parameters),
credentials: {},
webhookId: n.webhookId || 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.gjs
index 51c6b558f7b..0f623df5ed0 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
@@ -1117,6 +1117,14 @@ export default class WorkflowsEditor extends Component {
this.#captureUndo();
const existingConnections = this.formApi.get("connections");
+ // imported connections are already resolved to client ids, so renaming a
+ // node here cannot orphan them
+ const takenNames = takenNodeNames(existingNodes);
+ for (const node of newNodes) {
+ node.name = uniqueNodeName(node.name, takenNames);
+ takenNames.add(node.name);
+ }
+
this.formApi.set("nodes", [...existingNodes, ...newNodes]);
this.formApi.set("connections", [
...existingConnections,
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.gjs
index 929fdccf640..555a5bf9691 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
@@ -40,6 +40,7 @@ import CredentialControl from "../configurators/credential";
import PropertyEngineConfigurator from "../configurators/property-engine";
import InputContext from "../context/input";
import OutputContext from "../context/output";
+import { takenNodeNames } from "../editor/node-factory";
import LivePreview from "./live-preview";
function credentialSlotLabel(slot) {
@@ -214,8 +215,22 @@ export default class NodeConfigurator extends Component {
return this.nodeName.trim();
}
+ get nodeNameError() {
+ if (this.trimmedNodeName.length === 0) {
+ return null;
+ }
+
+ const otherNodes = this.args.model.nodes.filter(
+ (node) => node.clientId !== this.args.model.node.clientId
+ );
+
+ return takenNodeNames(otherNodes).has(this.trimmedNodeName)
+ ? i18n("discourse_workflows.node_name_taken")
+ : null;
+ }
+
get canSaveNodeName() {
- return this.trimmedNodeName.length > 0;
+ return this.trimmedNodeName.length > 0 && !this.nodeNameError;
}
@action
@@ -520,6 +535,12 @@ export default class NodeConfigurator extends Component {
class="btn-flat workflows-configurator-modal__cancel-name"
/>
</div>
+ {{#if this.nodeNameError}}
+ <div
+ class="workflows-configurator-modal__name-error"
+ role="alert"
+ >{{this.nodeNameError}}</div>
+ {{/if}}
{{else}}
{{! eslint-disable ember/template-no-invalid-interactive }}
<div
diff --git a/plugins/discourse-workflows/assets/stylesheets/common/configurator/configurator-modal.scss b/plugins/discourse-workflows/assets/stylesheets/common/configurator/configurator-modal.scss
index 2b5c6e2556e..e85b3c1b136 100644
--- a/plugins/discourse-workflows/assets/stylesheets/common/configurator/configurator-modal.scss
+++ b/plugins/discourse-workflows/assets/stylesheets/common/configurator/configurator-modal.scss
@@ -59,6 +59,11 @@
gap: var(--space-1);
}
+ &__name-error {
+ color: var(--danger);
+ font-size: var(--font-down-1);
+ }
+
&__edit-name,
&__save-name,
&__cancel-name {
diff --git a/plugins/discourse-workflows/config/locales/client.en.yml b/plugins/discourse-workflows/config/locales/client.en.yml
index e1f0de7e0fd..ac6da1cd589 100644
--- a/plugins/discourse-workflows/config/locales/client.en.yml
+++ b/plugins/discourse-workflows/config/locales/client.en.yml
@@ -105,6 +105,7 @@ en:
edit: "Edit"
save: "Save"
cancel: "Cancel"
+ node_name_taken: "Another node already uses this name"
more_options: "More options"
publish: "Publish"
discard_changes: "Discard changes"
diff --git a/plugins/discourse-workflows/spec/system/node_names_spec.rb b/plugins/discourse-workflows/spec/system/node_names_spec.rb
new file mode 100644
index 00000000000..3b7491182f4
--- /dev/null
+++ b/plugins/discourse-workflows/spec/system/node_names_spec.rb
@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+RSpec.describe "Discourse Workflows | node names" do
+ fab!(:admin)
+
+ let(:editor_page) { PageObjects::Pages::DiscourseWorkflows::WorkflowEditor.new }
+
+ before { sign_in(admin) }
+
+ def build_two_node_workflow
+ editor_page.visit_new
+ editor_page.click_empty_state_add_node
+ editor_page.select_node_type("trigger:topic_created")
+ editor_page.click_add_node
+ editor_page.select_node_type("action:post", operation: "create")
+ end
+
+ def import_nodes(nodes)
+ file = Tempfile.new(%w[workflow .json])
+ file.write({ nodes: nodes, connections: {} }.to_json)
+ file.flush
+ page.find("input[type='file'][accept='.json']", visible: :all).set(file.path)
+ file
+ end
+
+ it "blocks renaming a node to a name another node already uses" do
+ build_two_node_workflow
+
+ editor_page.double_click_node(1)
+ find(".workflows-configurator-modal__name").click
+ find(".workflows-configurator-modal__name-input").fill_in(with: "Topic created")
+
+ expect(page).to have_css(".workflows-configurator-modal__name-error")
+ expect(find(".workflows-configurator-modal__save-name")).to be_disabled
+ expect(page).to have_no_css(".dialog-body")
+ end
+
+ it "renames imported nodes that collide with existing ones" do
+ build_two_node_workflow
+
+ import_nodes(
+ [{ type: "action:post", typeVersion: "1.0", name: "Topic created", parameters: {} }],
+ )
+
+ expect(editor_page).to have_node_count(3)
+ expect(editor_page).to have_node("Topic created 1")
+ expect(page).to have_no_css(".dialog-body")
+ end
+
+ it "names imported nodes that arrive without one" do
+ build_two_node_workflow
+
+ import_nodes([{ type: "action:http_request", typeVersion: "1.0", parameters: {} }])
+
+ expect(editor_page).to have_node_count(3)
+ expect(page).to have_no_css(".dialog-body")
+ end
+end
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.js
index 61ad33c4ad5..db53a6f49c9 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
@@ -1,4 +1,5 @@
import { module, test } from "qunit";
+import { i18n } from "discourse-i18n";
import {
buildWorkflowExportPayload,
parseWorkflowImport,
@@ -136,6 +137,36 @@ module("Unit | lib | discourse-workflows | canvas-file-io", function () {
assert.true(result.nodes[0].alwaysOutputData);
});
+ test("parseWorkflowImport falls back to the type label when a node has no usable name", function (assert) {
+ const result = parseWorkflowImport(
+ JSON.stringify({
+ nodes: [
+ { type: "action:http_request", typeVersion: "1.0", parameters: {} },
+ {
+ type: "action:http_request",
+ typeVersion: "1.0",
+ name: " ",
+ parameters: {},
+ },
+ {
+ type: "action:http_request",
+ typeVersion: "1.0",
+ name: { not: "a string" },
+ parameters: {},
+ },
+ ],
+ connections: {},
+ })
+ );
+
+ const expected = i18n("discourse_workflows.nodes.action:http_request");
+ assert.deepEqual(
+ result.nodes.map((node) => node.name),
+ [expected, expected, expected],
+ "a missing, blank, or non-string name never reaches the server"
+ );
+ });
+
test("parseWorkflowImport preserves imported static data", function (assert) {
const result = parseWorkflowImport(
JSON.stringify({