Chat Summary skipping bug

merefield · March 7, 2025, 2:05pm

Chat Summary emails are being skipped for users with a valid email:

I’ve done some analysis and I believe I know why:

Here’s ultimately where the skipping happens:

lib/email/sender.rb

ffdc97f37


      
                 begin
                   @message.message
                 rescue StandardError
                   nil
                 end
               )
            return
          end
          
          return skip(SkippedEmailLog.reason_types[:sender_message_blank]) if @message.blank?
          return skip(SkippedEmailLog.reason_types[:sender_message_to_blank]) if @message.to.blank?
          
          if SiteSetting.disable_emails == "non-staff" && !bypass_disable
            return unless find_user&.staff?
          end
          
          if to_address.end_with?(".invalid")
            return skip(SkippedEmailLog.reason_types[:sender_message_to_invalid])
          end
          
          if @message.text_part

This is because message.to is blank.

message.to is blank because the arguments sent to send_user_email do not include to_address and this is never enriched with the user’s primary email, e.g.:

args: {"type"=>"chat_summary", "user_id"=>3, "force_respect_seen_recently"=>true, "current_site_id"=>"default"}

github.com/discourse/discourse

app/jobs/regular/user_email.rb

ffdc97f37


      
            args[:type] = args[:type].to_s
          
            send_user_email(args)
          
            if args[:type] == "digest"
              # Record every attempt at sending a digest email, even if it was skipped
              UserStat.where(user_id: args[:user_id]).update_all(digest_attempted_at: Time.current)
            end
          end
          
          def send_user_email(args)
            post = nil
            notification = nil
            type = args[:type]
            user = User.find_by(id: args[:user_id])
            to_address =
              args[:to_address].presence || user&.primary_email&.email.presence || "no_email_found"
          
            set_skip_context(type, args[:user_id], to_address, args[:post_id])
          
            return skip(SkippedEmailLog.reason_types[:user_email_no_user]) if !user

This is called by Chat Mailer, and you will notice that to_address is missing:

github.com/discourse/discourse

plugins/chat/lib/chat/mailer.rb

ffdc97f37


      
            return unless SiteSetting.chat_enabled
          
            User
              .real
              .activated
              .not_staged
              .not_suspended
              .where(id: users_with_unreads)
              .find_each do |user|
                if DiscoursePluginRegistry.apply_modifier(:chat_mailer_send_summary_to_user, true, user)
                  Jobs.enqueue(
                    :user_email,
                    type: "chat_summary",
                    user_id: user.id,
                    force_respect_seen_recently: true,
                  )
                end
              end
          end
          
          private

and that is maybe fine, but by the time you get to the top of send_user_email, I believe to_address should be enriched with the user email so that when it is passed forward, the emailer is given access to this property and the emailing succeeds.

When I added this small monkey-patch to send_user_email, the problem goes away:

      # CORE BUG: if we don't set to_address, ultimately the email won't send and will be skipped.
      # This is a core bug and we will need to raise it on Meta.
      if args[:to_address].blank? && user&.primary_email&.email
        args[:to_address] = user&.primary_email&.email
      end

sam · March 9, 2025, 11:07pm

Thanks heaps for the debugging @merefield , will make sure the member xp have a look at this soon.

Topic		Replies	Views
Email notifications Feature chat , completed	3	636	August 13, 2022
Activity Summary not sent if other emails are sent Feature email , completed , activity-summary	19	823	July 18, 2024
Email summary removes bulleted items Bug	5	710	April 12, 2018
Digest / Summary emails not working Support activity-summary	2	827	January 28, 2022
Digest/Summary Emails not working Support activity-summary	5	928	February 19, 2020

Chat Summary skipping bug

Related topics