FEATURE: prevent chat emails for messages created via SDK (#27875)

This change allows us to distinguish between regular user generated chat messages and those created via the Chat SDK.

A new created_by_sdk boolean column is added to the Chat Messages table. When this value is true, we will not include the message in the user summary email that is sent to users.

plugins/chat/app/services/chat/create_message.rb

@@ -44,6 +44,7 @@ module Chat
       step :create_webhook_event
       step :update_channel_last_message
       step :update_membership_last_read
+      step :update_created_by_sdk
       step :process_direct_message_channel
     end
     step :publish_new_thread
@@ -65,6 +66,7 @@ module Chat
       attribute :process_inline, :boolean, default: Rails.env.test?
       attribute :force_thread, :boolean, default: false
       attribute :strip_whitespaces, :boolean, default: true
+      attribute :created_by_sdk, :boolean, default: false
 
       validates :chat_channel_id, presence: true
       validates :message, presence: true, if: -> { upload_ids.blank? }
@@ -187,6 +189,10 @@ module Chat
       membership.update!(last_read_message: message_instance)
     end
 
+    def update_created_by_sdk(message_instance:, contract:)
+      message_instance.created_by_sdk = contract.created_by_sdk
+    end
+
     def process_direct_message_channel(membership:)
       Chat::Action::PublishAndFollowDirectMessageChannel.call(channel_membership: membership)
     end

plugins/chat/db/migrate/20240711153837_add_created_by_sdk_to_chat_messages.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+class AddCreatedBySdkToChatMessages < ActiveRecord::Migration[7.1]
+  def change
+    add_column :chat_messages, :created_by_sdk, :boolean
+  end
+end

plugins/chat/db/post_migrate/20240711154622_update_chat_messages_created_by_sdk.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+class UpdateChatMessagesCreatedBySdk < ActiveRecord::Migration[7.1]
+  def up
+    change_column_default :chat_messages, :created_by_sdk, false
+
+    if DB.query_single("SELECT 1 FROM chat_messages WHERE created_by_sdk IS NULL LIMIT 1").first
+      batch_size = 10_000
+      min_id = DB.query_single("SELECT MIN(id) FROM chat_messages").first.to_i
+      max_id = DB.query_single("SELECT MAX(id) FROM chat_messages").first.to_i
+      while max_id >= min_id
+        DB.exec(
+          "UPDATE chat_messages SET created_by_sdk = false WHERE id > #{max_id - batch_size} AND id <= #{max_id}",
+        )
+        max_id -= batch_size
+      end
+    end
+
+    change_column_null :chat_messages, :created_by_sdk, false
+  end
+
+  def down
+    raise ActiveRecord::IrreversibleMigration
+  end
+end

plugins/chat/lib/chat/mailer.rb

@@ -56,6 +56,7 @@ module Chat
         AND chat_messages.deleted_at IS NULL
         AND chat_messages.created_at > now() - interval '1 week'
         AND chat_messages.user_id <> users.id
+        AND chat_messages.created_by_sdk = false
         AND (
           (chat_channels.chatable_type = 'DirectMessage' AND user_options.allow_private_messages) OR
           (chat_channels.chatable_type = 'Category' AND uccm.following AND NOT notifications.read)

plugins/chat/lib/chat_sdk/message.rb

@@ -133,6 +133,7 @@ module ChatSDK
           enforce_membership: enforce_membership,
           force_thread: force_thread,
           strip_whitespaces: strip_whitespaces,
+          created_by_sdk: true,
         ) do
           on_model_not_found(:channel) { raise "Couldn't find channel with id: `#{channel_id}`" }
           on_model_not_found(:membership) do

plugins/chat/spec/components/chat/mailer_spec.rb

@@ -147,6 +147,11 @@ describe Chat::Mailer do
         expect_not_enqueued
       end
 
+      it "does not queue a chat summary email when chat message was created by the SDK" do
+        chat_message.update!(created_by_sdk: true)
+        expect_not_enqueued
+      end
+
       it "queues a chat summary email even when user has private messages disabled" do
         user.user_option.update!(allow_private_messages: false)
         expect_enqueued

plugins/chat/spec/lib/chat_sdk/message_spec.rb

@@ -15,6 +15,11 @@ describe ChatSDK::Message do
       expect(message.message).to eq("something")
     end
 
+    it "sets created_by_sdk to true" do
+      message = described_class.create(**params)
+      expect(message).to have_attributes(created_by_sdk: true)
+    end
+
     context "when thread_id is present" do
       fab!(:thread_1) { Fabricate(:chat_thread, channel: channel_1) }