Allow specifiy user different from guardian.user in chat services such as Chat::CreateMessage

Lhc_fl · November 12, 2023, 12:16pm

Now that PostCreator can specify user as post’s creator and guardian to verify posting permissions, I would like Discourse Chat to have similar behavior, which would allow plugins to help send messages from a user (whether it is in the chat channel or not) with the guardian of the system user.

github.com

discourse/discourse/blob/main/plugins/chat/app/services/chat/create_message.rb#L129


      
            return true if contract.thread_id.blank?
            thread&.channel == channel
          end
          
          def ensure_thread_matches_parent(thread:, reply:)
            return true unless thread && reply
            reply.thread == thread
          end
          
          def fetch_uploads(contract:, guardian:)
            return [] if !SiteSetting.chat_allow_uploads
            guardian.user.uploads.where(id: contract.upload_ids)
          end
          
          def clean_message(contract:)
            contract.message =
              TextCleaner.clean(
                contract.message,
                strip_whitespaces: contract.strip_whitespaces,
                strip_zero_width_spaces: true,
              )

github.com

discourse/discourse/blob/cdbe0f74e8659661281decdc9b54ce5e6aa53075/lib/post_creator.rb#L86


      
          
          def spam?
            @spam
          end
          
          def skip_validations?
            @opts[:skip_validations]
          end
          
          def guardian
            @guardian ||= @opts[:guardian] || Guardian.new(@user)
          end
          
          def valid?
            @topic = nil
            @post = nil
          
            if @user.suspended? && !skip_validations?
              errors.add(:base, I18n.t(:user_is_suspended))
              return false
            end

Usage: In Discourse Automation and Chat bridge, you need to send chat messages from plugin. But currently this script will most likely fail to be sent because the user you specify (e.g. DiscoBot) may not be in the channel.

github.com

discourse/discourse/blob/cdbe0f74e8659661281decdc9b54ce5e6aa53075/plugins/chat/plugin.rb#L454


      
          
              script do |context, fields, automation|
                sender = User.find_by(username: fields.dig("sender", "value")) || Discourse.system_user
                channel = Chat::Channel.find_by(id: fields.dig("chat_channel_id", "value"))
          
                placeholders = { channel_name: channel.title(sender) }.merge(context["placeholders"] || {})
          
                creator =
                  ::Chat::CreateMessage.call(
                    chat_channel_id: channel.id,
                    guardian: sender.guardian,
                    message: utils.apply_placeholders(fields.dig("message", "value"), placeholders),
                  )
          
                if creator.failure?
                  Rails.logger.warn "[discourse-automation] Chat message failed to send:\n#{creator.inspect_steps.inspect}\n#{creator.inspect_steps.error}"
                end
              end
            end
          end

I know the team is very busy, so I can do this by myself. I hope the Discourse team thinks this can be added to the core, then I will take the time to modify the code here and submit a pull request.

merefield · November 13, 2023, 2:52pm

Discourse Chatbot solved a similar challenge with current code without needing any specific changes in core, have you taken a look at my solution?

github.com

merefield/discourse-chatbot/blob/f782223d5f6306e865a1604548fd11d4833b5c7c/lib/discourse_chatbot/reply_creator.rb#L7


      
          # frozen_string_literal: true
          module ::DiscourseChatbot
            class ReplyCreator
          
              def initialize(options = {})
                @author = ::User.find_by(id: options[:bot_user_id])
                @guardian = Guardian.new(@author)
                @reply_to = options[:reply_to_message_or_post_id]
                @reply_to_post_number = options[:original_post_number]
                @topic_or_channel_id = options[:topic_or_channel_id]
                @message_body = options[:reply]
                @is_private_msg = options[:is_private_msg]
                @inner_thoughts = options[:inner_thoughts]
                if @message_body.blank?
                  @message_body = '...'
                end
              end

github.com

merefield/discourse-chatbot/blob/f782223d5f6306e865a1604548fd11d4833b5c7c/lib/discourse_chatbot/message/message_reply_creator.rb#L12


      
          module ::DiscourseChatbot
            class MessageReplyCreator < ReplyCreator
          
              def initialize(options = {})
                super(options)
              end
          
              def create
                ::DiscourseChatbot.progress_debug_message("5. Creating a new Chat Nessage...")
                begin
                  Chat::CreateMessage.call(
                    chat_channel_id: @topic_or_channel_id,
                    guardian: @guardian,
                    message: @message_body,
                  )
          
                  presence = PresenceChannel.new("/chat-reply/#{@topic_or_channel_id}")
                  presence.leave(user_id: @author.id, client_id: "12345")
          
                  ::DiscourseChatbot.progress_debug_message("6. The Message has been created successfully")
                rescue => e

Lhc_fl · November 14, 2023, 2:36am

thank you so much for your suggestion! let me see it

joffreyjaffeux · December 4, 2023, 7:53pm

Yes as @merefield said, a chat service accepts a guardian, and you can set the guardian as you want.

joffreyjaffeux · December 8, 2023, 7:54pm

This topic was automatically closed 4 days after the last reply. New replies are no longer allowed.

Topic		Replies	Views
Chat message failed to send because of channel membership Bug automation , chat	0	255	October 26, 2023
Better Control Over Incoming Chats Feature chat	7	429	January 3, 2024
Create/See and Create Permissions (again) Feature	96	10925	July 17, 2020
Private category comments exposed via email Bug	17	1540	January 17, 2020
New category permission : "Create and see" Feature	32	11351	December 28, 2017

Allow specifiy user different from guardian.user in chat services such as Chat::CreateMessage

Related topics