Skip to content

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

UX: Simplify workflow set fields configuration (#40570)

Joffrey JAFFEUXd60cc57b56be
diff --git a/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/configurators/assignment-collection.gjs b/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/configurators/assignment-collection.gjs
index 6a37b4793ca..ae81f5fa061 100644
--- a/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/configurators/assignment-collection.gjs
+++ b/plugins/discourse-workflows/admin/assets/javascripts/admin/components/workflows/configurators/assignment-collection.gjs
@@ -1,5 +1,4 @@
import Component from "@glimmer/component";
-import { tracked } from "@glimmer/tracking";
import { fn } from "@ember/helper";
import { action } from "@ember/object";
import DButton from "discourse/ui-kit/d-button";
@@ -12,9 +11,6 @@ import {
import Field from "./field";
export default class AssignmentCollection extends Component {
- @tracked
- itemCount = (this.args.formApi?.get(this.assignmentsPath) || []).length;
-
get assignmentsPath() {
return `${this.args.fieldName}.assignments`;
}
@@ -68,10 +64,6 @@ export default class AssignmentCollection extends Component {
};
}
- get showEmptyState() {
- return this.itemCount === 0;
- }
-
@action
emptyAssignment() {
return {
@@ -88,23 +80,15 @@ export default class AssignmentCollection extends Component {
this.assignmentsPath,
this.emptyAssignment()
);
- this.itemCount++;
this.args.onChange?.();
}
@action
removeAssignment(removeFn, index) {
removeFn(index);
- this.itemCount--;
this.args.onChange?.();
}
- @action
- clearAssignments() {
- this.args.formApi.set(this.assignmentsPath, []);
- this.itemCount = 0;
- }
-
@action
valueSchema(item) {
switch (item?.type) {
@@ -216,19 +200,8 @@ export default class AssignmentCollection extends Component {
@translatedLabel={{i18n
"discourse_workflows.property_engine.add_field"
}}
- class="btn-default"
+ class="btn-default workflows-property-engine__add-attrs-btn"
/>
-
- {{#unless this.showEmptyState}}
- <DButton
- @action={{this.clearAssignments}}
- @icon="xmark"
- @translatedLabel={{i18n
- "discourse_workflows.property_engine.clear_fields"
- }}
- class="btn-flat"
- />
- {{/unless}}
</div>
</@form.Section>
</template>
diff --git a/plugins/discourse-workflows/config/locales/client.en.yml b/plugins/discourse-workflows/config/locales/client.en.yml
index 8775058dc7b..5673782aa08 100644
--- a/plugins/discourse-workflows/config/locales/client.en.yml
+++ b/plugins/discourse-workflows/config/locales/client.en.yml
@@ -382,9 +382,6 @@ en:
include_fields_placeholder: "company, id"
exclude_fields: "Fields to exclude"
exclude_fields_placeholder: "debug, internal.notes"
- options: "Options"
- dot_notation: "Support dot notation"
- ignore_conversion_errors: "Ignore type conversion errors"
type_string: "String"
type_number: "Number"
type_boolean: "Boolean"
@@ -429,7 +426,6 @@ en:
add_item: "Add item"
add_option: "Add option"
add_field: "Add field"
- clear_fields: "Clear fields"
remove_item: "Remove item"
dynamic_hint: "Must resolve to %{value}."
dynamic_values:
diff --git a/plugins/discourse-workflows/lib/discourse_workflows/nodes/set_fields/v1.rb b/plugins/discourse-workflows/lib/discourse_workflows/nodes/set_fields/v1.rb
index 14e8dea8b97..a161ab633ef 100644
--- a/plugins/discourse-workflows/lib/discourse_workflows/nodes/set_fields/v1.rb
+++ b/plugins/discourse-workflows/lib/discourse_workflows/nodes/set_fields/v1.rb
@@ -90,14 +90,6 @@ module DiscourseWorkflows
},
},
},
- options: {
- type: :collection,
- required: false,
- options: [
- { name: "dot_notation", type: :boolean, default: true },
- { name: "ignore_conversion_errors", type: :boolean, default: false },
- ],
- },
},
)
@@ -124,8 +116,7 @@ module DiscourseWorkflows
def process(exec_ctx, item, item_index, config)
item_json = item.fetch("json") { {} }
- options = exec_ctx.get_node_parameter("options", item_index, default: {})
- result = included_fields(item_json, config, options)
+ result = included_fields(item_json, config)
if config["mode"] == "raw"
result.merge(parse_json_fields(config))
@@ -133,21 +124,19 @@ module DiscourseWorkflows
apply_assignments(
result,
exec_ctx.get_node_parameter("assignments.assignments", item_index, default: []),
- options,
)
end
end
- def included_fields(item_json, config, options)
+ def included_fields(item_json, config)
return {} unless config.fetch("include_other_fields", true)
- dot_notation = dot_notation?(options)
fields =
case config.fetch("include") { "all" }
when "selected"
- selected_fields(item_json, config["include_fields"], dot_notation)
+ selected_fields(item_json, config["include_fields"])
when "except"
- except_fields(item_json, config["exclude_fields"], dot_notation)
+ except_fields(item_json, config["exclude_fields"])
else
item_json.deep_dup
end
@@ -171,34 +160,31 @@ module DiscourseWorkflows
raise_node_error!("Invalid JSON", description: e.message)
end
- def apply_assignments(result, assignments, options)
- dot_notation = dot_notation?(options)
- ignore_errors = options.fetch("ignore_conversion_errors", false)
-
+ def apply_assignments(result, assignments)
assignments.each do |field|
key = field["name"].to_s
next if key.blank?
- value = cast_value(field["value"], field.fetch("type") { "string" }, ignore_errors)
- set_field(result, key, value, dot_notation)
+ value = cast_value(field["value"], field.fetch("type") { "string" })
+ set_field(result, key, value)
end
result
end
- def selected_fields(item_json, field_list, dot_notation)
+ def selected_fields(item_json, field_list)
split_fields(field_list).each_with_object({}) do |field, result|
- value = get_field(item_json, field, dot_notation)
+ value = get_field(item_json, field)
next if value.nil?
- output_field = dot_notation && field.include?(".") ? field.split(".").last : field
- set_field(result, output_field, value, dot_notation)
+ output_field = field.include?(".") ? field.split(".").last : field
+ set_field(result, output_field, value)
end
end
- def except_fields(item_json, field_list, dot_notation)
+ def except_fields(item_json, field_list)
result = item_json.deep_dup
- split_fields(field_list).each { |field| unset_field(result, field, dot_notation) }
+ split_fields(field_list).each { |field| unset_field(result, field) }
result
end
@@ -206,19 +192,13 @@ module DiscourseWorkflows
field_list.to_s.split(",").map(&:strip).reject(&:blank?)
end
- def dot_notation?(options)
- options.fetch("dot_notation", true)
- end
-
- def cast_value(value, type, ignore_errors)
- cast_value!(value, type, ignore_errors)
+ def cast_value(value, type)
+ cast_value!(value, type)
rescue JSON::ParserError, ArgumentError => e
- return value if ignore_errors
-
raise_node_error!("Invalid field value", description: e.message)
end
- def cast_value!(value, type, ignore_errors)
+ def cast_value!(value, type)
case type
when "integer"
Integer(value)
@@ -231,27 +211,26 @@ module DiscourseWorkflows
%w[true 1].include?(value.to_s.downcase)
when "array"
- cast_json_value(value, Array, ignore_errors)
+ cast_json_value(value, Array)
when "object"
- cast_json_value(value, Hash, ignore_errors)
+ cast_json_value(value, Hash)
else
value.to_s
end
end
- def cast_json_value(value, expected_class, ignore_errors)
+ def cast_json_value(value, expected_class)
return value if value.is_a?(expected_class)
parsed = JSON.parse(value.to_s)
return parsed if parsed.is_a?(expected_class)
- return value if ignore_errors
expected_type = expected_class == Array ? "array" : "object"
raise_node_error!("Invalid field value", description: "Expected #{expected_type}")
end
- def set_field(result, field, value, dot_notation)
- unless dot_notation && field.include?(".")
+ def set_field(result, field, value)
+ if field.exclude?(".")
result[field] = value
return
end
@@ -266,14 +245,14 @@ module DiscourseWorkflows
target[leaf] = value
end
- def get_field(hash, field, dot_notation)
- return hash[field] unless dot_notation && field.include?(".")
+ def get_field(hash, field)
+ return hash[field] if field.exclude?(".")
field.split(".").reduce(hash) { |value, key| value.is_a?(Hash) ? value[key] : nil }
end
- def unset_field(hash, field, dot_notation)
- unless dot_notation && field.include?(".")
+ def unset_field(hash, field)
+ if field.exclude?(".")
hash.delete(field)
return
end
diff --git a/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/set_fields_spec.rb b/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/set_fields_spec.rb
index 667afc80328..258115612fb 100644
--- a/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/set_fields_spec.rb
+++ b/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/set_fields_spec.rb
@@ -1,6 +1,10 @@
# frozen_string_literal: true
RSpec.describe DiscourseWorkflows::Nodes::SetFields::V1 do
+ it "does not expose optional options" do
+ expect(described_class.property_schema).not_to have_key(:options)
+ end
+
describe "#execute" do
let(:item) { { "json" => { "topic_id" => "42", "username" => "alice" } } }
@@ -131,29 +135,6 @@ RSpec.describe DiscourseWorkflows::Nodes::SetFields::V1 do
expect(result).to eq({ "profile" => { "name" => "Alice" } })
end
- it "can disable dot notation from optional options" do
- config = { "include_other_fields" => false, "options" => { "dot_notation" => false } }.merge(
- assignments(assignment("profile.name", "Alice")),
- )
-
- result = execute_node(configuration: config, item: item)
-
- expect(result).to eq({ "profile.name" => "Alice" })
- end
-
- it "keeps raw values when conversion errors are ignored" do
- config = {
- "include_other_fields" => false,
- "options" => {
- "ignore_conversion_errors" => true,
- },
- }.merge(assignments(assignment("score", "abc", "float")))
-
- result = execute_node(configuration: config, item: item)
-
- expect(result).to eq({ "score" => "abc" })
- end
-
it "includes only selected input fields" do
nested_item = { "json" => item["json"].merge("profile" => { "name" => "Alice" }) }
config = { "include" => "selected", "include_fields" => "topic_id, profile.name" }.merge(