Skip to content

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

DEV: Expose avatar and profile images to workflows (#42723)

Régis Hanol1a174dee996d
diff --git a/plugins/discourse-workflows/app/serializers/discourse_workflows/user_serializer.rb b/plugins/discourse-workflows/app/serializers/discourse_workflows/user_serializer.rb
index cde29e93579..3bf5efb5fc5 100644
--- a/plugins/discourse-workflows/app/serializers/discourse_workflows/user_serializer.rb
+++ b/plugins/discourse-workflows/app/serializers/discourse_workflows/user_serializer.rb
@@ -13,7 +13,9 @@ module DiscourseWorkflows
:created_at,
:approved,
:silenced,
- :suspended
+ :suspended,
+ :uploaded_avatar_id,
+ :avatar_template
def trust_level_name
TrustLevel.name(object.trust_level)
diff --git a/plugins/discourse-workflows/lib/discourse_workflows/nodes/user/v1.rb b/plugins/discourse-workflows/lib/discourse_workflows/nodes/user/v1.rb
index 9c2ea22248d..05713cc0976 100644
--- a/plugins/discourse-workflows/lib/discourse_workflows/nodes/user/v1.rb
+++ b/plugins/discourse-workflows/lib/discourse_workflows/nodes/user/v1.rb
@@ -247,21 +247,17 @@ module DiscourseWorkflows
end
def user_data(user, guardian, extensions:)
- include_profile_details = include_profile_details?(user, guardian)
+ profile = user.user_profile if include_profile_details?(user, guardian)
serialize_user(user, guardian: guardian).merge(
title: user.title,
- bio_raw: include_profile_details ? user.user_profile.bio_raw : nil,
+ bio_raw: profile&.bio_raw,
+ website: profile&.website,
+ profile_background_upload_id: profile&.profile_background_upload_id,
+ card_background_upload_id: profile&.card_background_upload_id,
manual_locked_trust_level: user.manual_locked_trust_level,
trust_level_locked: !user.manual_locked_trust_level.nil?,
- user_fields:
- (
- if include_profile_details
- user.user_fields(guardian.allowed_user_field_ids(user))
- else
- {}
- end
- ),
+ user_fields: profile ? user.user_fields(guardian.allowed_user_field_ids(user)) : {},
groups: groups_data(user, guardian),
).merge(extensions_data(user, guardian, extensions))
end
diff --git a/plugins/discourse-workflows/lib/discourse_workflows/schema.rb b/plugins/discourse-workflows/lib/discourse_workflows/schema.rb
index 1e372c41356..349d61ba515 100644
--- a/plugins/discourse-workflows/lib/discourse_workflows/schema.rb
+++ b/plugins/discourse-workflows/lib/discourse_workflows/schema.rb
@@ -122,7 +122,9 @@ module DiscourseWorkflows
"created_at": { "type": "string", "format": "date-time" },
"approved": { "type": "boolean" },
"silenced": { "type": "boolean" },
- "suspended": { "type": "boolean" }
+ "suspended": { "type": "boolean" },
+ "uploaded_avatar_id": { "type": ["integer", "null"] },
+ "avatar_template": { "type": "string" }
}
JSON
@@ -186,6 +188,9 @@ module DiscourseWorkflows
{
"title": { "type": ["string", "null"] },
"bio_raw": { "type": ["string", "null"] },
+ "website": { "type": ["string", "null"] },
+ "profile_background_upload_id": { "type": ["integer", "null"] },
+ "card_background_upload_id": { "type": ["integer", "null"] },
"manual_locked_trust_level": { "type": ["integer", "null"] },
"trust_level_locked": { "type": "boolean" },
"user_fields": { "type": "object" },
diff --git a/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/user_spec.rb b/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/user_spec.rb
index 6fe18ff2a2e..24e35df241e 100644
--- a/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/user_spec.rb
+++ b/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/user_spec.rb
@@ -40,6 +40,35 @@ RSpec.describe DiscourseWorkflows::Nodes::User::V1 do
expect(result["user"]).not_to have_key("email")
end
+ it "returns profile images and website", :aggregate_failures do
+ avatar = Fabricate(:upload)
+ profile_background = Fabricate(:upload)
+ card_background = Fabricate(:upload)
+ user.update!(uploaded_avatar_id: avatar.id)
+ user.user_profile.update!(
+ website: "https://example.com",
+ profile_background_upload_id: profile_background.id,
+ card_background_upload_id: card_background.id,
+ )
+
+ result = execute_node(configuration: { "operation" => "get", "username" => user.username })
+
+ expect(result["user"]).to include(
+ "uploaded_avatar_id" => avatar.id,
+ "website" => "https://example.com",
+ "profile_background_upload_id" => profile_background.id,
+ "card_background_upload_id" => card_background.id,
+ )
+ expect(result.dig("user", "avatar_template")).to include(avatar.id.to_s)
+ expect(
+ DiscourseWorkflows::Schema::USER_ACTION_SCHEMA.dig(
+ "properties",
+ "user",
+ "properties",
+ ).keys - result["user"].keys,
+ ).to be_empty
+ end
+
it "always returns account status signals", :aggregate_failures do
user.update!(silenced_till: 1.day.from_now, approved: true)
diff --git a/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/user_updated_spec.rb b/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/user_updated_spec.rb
index 348723ce182..021cd16ec6b 100644
--- a/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/user_updated_spec.rb
+++ b/plugins/discourse-workflows/spec/lib/discourse_workflows/nodes/user_updated_spec.rb
@@ -64,6 +64,16 @@ RSpec.describe DiscourseWorkflows::Nodes::UserUpdated::V1 do
)
expect(output).to match_node_output_schema(described_class)
end
+
+ it "exposes the avatar so vision triage can reach it", :aggregate_failures do
+ avatar = Fabricate(:upload)
+ user.update!(uploaded_avatar_id: avatar.id)
+
+ output = described_class.new(user).output
+
+ expect(output.dig(:user, :uploaded_avatar_id)).to eq(avatar.id)
+ expect(output.dig(:user, :avatar_template)).to include(avatar.id.to_s)
+ end
end
describe "#matches?" do
diff --git a/plugins/discourse-workflows/spec/lib/discourse_workflows/schema_serializer_sync_spec.rb b/plugins/discourse-workflows/spec/lib/discourse_workflows/schema_serializer_sync_spec.rb
new file mode 100644
index 00000000000..c5b94c31268
--- /dev/null
+++ b/plugins/discourse-workflows/spec/lib/discourse_workflows/schema_serializer_sync_spec.rb
@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+RSpec.describe DiscourseWorkflows::Schema do
+ fab!(:user)
+
+ let(:guardian) { Discourse.system_user.guardian }
+
+ def serialized_keys(serializer_class, object)
+ MultiJson.load(serializer_class.new(object, scope: guardian, root: false).to_json).keys
+ end
+
+ def expect_emitted(declared, emitted)
+ expect(declared.keys - emitted).to be_empty
+ end
+
+ it "emits every property USER_PROPERTIES declares" do
+ expect_emitted(
+ described_class::USER_PROPERTIES,
+ serialized_keys(DiscourseWorkflows::UserSerializer, user),
+ )
+ end
+
+ it "emits every property BASIC_USER_PROPERTIES declares" do
+ expect_emitted(
+ described_class::BASIC_USER_PROPERTIES,
+ serialized_keys(BasicUserSerializer, user),
+ )
+ end
+end