Skip to content

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

UX: Add a "Continue on error" toggle to workflow node settings

Régis Hanol1fce86408621
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 a8ce63c94c9..4a3376b2ea6 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
@@ -15,7 +15,11 @@ import DModal from "discourse/ui-kit/d-modal";
import dConcatClass from "discourse/ui-kit/helpers/d-concat-class";
import dIcon from "discourse/ui-kit/helpers/d-icon";
import { i18n } from "discourse-i18n";
-import { NODE_DIRECT_SETTING_KEYS } from "../../../lib/workflows/node-data-shape";
+import {
+ continuesOnError,
+ NODE_DIRECT_SETTING_KEYS,
+ withContinueOnError,
+} from "../../../lib/workflows/node-data-shape";
import {
nodeTypeDescription,
nodeTypeIcon,
@@ -81,6 +85,7 @@ export default class NodeConfigurator extends Component {
notesInFlow: this.args.model.node.configuration?.notesInFlow === true,
alwaysOutputData:
this.args.model.node.configuration?.alwaysOutputData === true,
+ continueOnError: continuesOnError(this.args.model.node.configuration),
};
@tracked credentialConfig = structuredClone(
@@ -153,6 +158,10 @@ export default class NodeConfigurator extends Component {
);
}
+ get canContinueOnError() {
+ return !this.args.model.node.type?.startsWith("trigger:");
+ }
+
get showsOutputContext() {
return nodeTypeProducesData(this.resolvedNodeType);
}
@@ -247,6 +256,7 @@ export default class NodeConfigurator extends Component {
notes: this.settingsApi.get("notes") || "",
notesInFlow: this.settingsApi.get("notesInFlow") === true,
alwaysOutputData: this.settingsApi.get("alwaysOutputData") === true,
+ continueOnError: this.settingsApi.get("continueOnError") === true,
};
}
@@ -273,6 +283,7 @@ export default class NodeConfigurator extends Component {
notes: this.configuration.notes || "",
notesInFlow: this.configuration.notesInFlow === true,
alwaysOutputData: this.configuration.alwaysOutputData === true,
+ continueOnError: continuesOnError(this.configuration),
};
}
this.activeTab = tab;
@@ -295,11 +306,6 @@ export default class NodeConfigurator extends Component {
await set("notesInFlow", notes.trim().length > 0);
}
- @action
- async handleAlwaysOutputDataSet(value, { set, name }) {
- await set(name, value);
- }
-
@action
handleCredentialSet(slotName, value) {
const credentials = { ...this.credentialConfig };
@@ -361,6 +367,10 @@ export default class NodeConfigurator extends Component {
notes: this.settingsConfiguration.notes,
notesInFlow: this.settingsConfiguration.notesInFlow,
alwaysOutputData: this.settingsConfiguration.alwaysOutputData,
+ ...withContinueOnError(
+ config,
+ this.settingsConfiguration.continueOnError
+ ),
credentials: this.credentialConfig,
};
}
@@ -731,7 +741,6 @@ export default class NodeConfigurator extends Component {
}}
@format="full"
@name="alwaysOutputData"
- @onSet={{this.handleAlwaysOutputDataSet}}
@title={{i18n
"discourse_workflows.configurator.always_output_data"
}}
@@ -740,6 +749,23 @@ export default class NodeConfigurator extends Component {
>
<field.Control />
</form.Field>
+ {{#if this.canContinueOnError}}
+ <form.Field
+ class="workflows-configurator-form__setting-toggle"
+ @description={{i18n
+ "discourse_workflows.configurator.continue_on_error_help"
+ }}
+ @format="full"
+ @name="continueOnError"
+ @title={{i18n
+ "discourse_workflows.configurator.continue_on_error"
+ }}
+ @type="toggle"
+ as |field|
+ >
+ <field.Control />
+ </form.Field>
+ {{/if}}
</Form>
{{#if this.nodeDescription}}
<div class="workflows-configurator-modal__node">
diff --git a/plugins/discourse-workflows/admin/assets/javascripts/admin/lib/workflows/node-data-shape.js b/plugins/discourse-workflows/admin/assets/javascripts/admin/lib/workflows/node-data-shape.js
index aac1859caef..38deb4c1048 100644
--- a/plugins/discourse-workflows/admin/assets/javascripts/admin/lib/workflows/node-data-shape.js
+++ b/plugins/discourse-workflows/admin/assets/javascripts/admin/lib/workflows/node-data-shape.js
@@ -8,6 +8,30 @@ export const NODE_DIRECT_SETTING_KEY_ATTRIBUTES = Object.freeze({
export const NODE_DIRECT_SETTING_KEYS = Object.freeze(
Object.keys(NODE_DIRECT_SETTING_KEY_ATTRIBUTES)
);
+const CONTINUE_ON_ERROR_MODES = [
+ "continueRegularOutput",
+ "continueErrorOutput",
+];
+
+export function continuesOnError(configuration) {
+ if (configuration?.onError) {
+ return CONTINUE_ON_ERROR_MODES.includes(configuration.onError);
+ }
+ return configuration?.continueOnFail === true;
+}
+
+// Leaves an unchanged mode alone so an error output configured outside the editor survives.
+export function withContinueOnError(configuration, enabled) {
+ if (enabled === continuesOnError(configuration)) {
+ return {};
+ }
+
+ return {
+ onError: enabled ? "continueRegularOutput" : undefined,
+ continueOnFail: undefined,
+ };
+}
+
export const FORM_TRIGGER_TYPE = "trigger:form";
export const FORM_TRIGGER_WEBHOOK_ID_KEY = "webhookId";
diff --git a/plugins/discourse-workflows/config/locales/client.en.yml b/plugins/discourse-workflows/config/locales/client.en.yml
index 33e06837987..a65f50815c2 100644
--- a/plugins/discourse-workflows/config/locales/client.en.yml
+++ b/plugins/discourse-workflows/config/locales/client.en.yml
@@ -201,6 +201,8 @@ en:
description_placeholder: "Add a note about this step..."
always_output_data: "Always output data"
always_output_data_help: "If on, this node emits an empty item when it would otherwise produce no items, so the next node still runs."
+ continue_on_error: "Continue on error"
+ continue_on_error_help: "If on, the workflow keeps going when this node fails instead of stopping. The execution shows what went wrong."
tabs:
parameters: "Parameters"
settings: "Settings"
diff --git a/plugins/discourse-workflows/test/javascripts/unit/lib/workflows-node-data-shape-test.js b/plugins/discourse-workflows/test/javascripts/unit/lib/workflows-node-data-shape-test.js
new file mode 100644
index 00000000000..e2d1eac62f1
--- /dev/null
+++ b/plugins/discourse-workflows/test/javascripts/unit/lib/workflows-node-data-shape-test.js
@@ -0,0 +1,33 @@
+import { module, test } from "qunit";
+import {
+ continuesOnError,
+ withContinueOnError,
+} from "discourse/plugins/discourse-workflows/admin/lib/workflows/node-data-shape";
+
+module("Unit | lib | discourse-workflows | node-data-shape", function () {
+ test("continuesOnError", function (assert) {
+ assert.true(continuesOnError({ onError: "continueRegularOutput" }));
+ assert.true(continuesOnError({ continueOnFail: true }), "legacy flag");
+ assert.false(
+ continuesOnError({ onError: "stopWorkflow", continueOnFail: true }),
+ "onError wins over the legacy flag"
+ );
+ assert.false(continuesOnError(undefined));
+ });
+
+ test("withContinueOnError", function (assert) {
+ assert.deepEqual(
+ withContinueOnError({ onError: "continueErrorOutput" }, true),
+ {},
+ "keeps an unchanged mode"
+ );
+ assert.deepEqual(withContinueOnError({}, true), {
+ onError: "continueRegularOutput",
+ continueOnFail: undefined,
+ });
+ assert.deepEqual(withContinueOnError({ continueOnFail: true }, false), {
+ onError: undefined,
+ continueOnFail: undefined,
+ });
+ });
+});