chat_notifier 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a442afb94e03ba8a40be94d62cb0043abe9a4a88430028bb79a5655ebe2d1f7e
-  data.tar.gz: 2070d04462fc7d9fec4daf08b25e900f03d5d7ce735aa5ac51eace3acc6429c6
+  metadata.gz: 62958f54e981fe03f20e8e7b954b18b0cc7f404542698d58db36a3fd7911b3ed
+  data.tar.gz: 42760f3c980906d660c601a984719ea551d137e6db064545ef9fcc446442a6d0
 SHA512:
-  metadata.gz: e892f14d366c45b01b3665523ee7b47eba8ad9b15021351b3f626763a08bacce3b72bdd5a6425338e5e1a5b3d94c3ae2294c3c92809060607b9bfa9b8aeaa273
-  data.tar.gz: 4a7cdd3397d62a9c7a9e25ea9b1bbf669a9e1c92eac97b95900764df0bc62b878cbd7e7942612852199a8ecd6efff13b0c6ed3604a7160b3d40b8da709e86c3d
+  metadata.gz: 4c37610777e3d4cc791791339e8b39ea7cacc386fb4032290a29040c0ef0184ee87d0d5ae26d3d072b16e9ed85d6abbd668e37b46adbaff98faeab1aff2a9396
+  data.tar.gz: d70529078358faeb2d419bae2951958b0ca94fdcaec00bfe5d820092dd4e366e784b5825ea1f0541eb041d91758427265256f30efd1f487e9427b6022e19c382

data/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.3.0] - 2026-07-24
+
+### Added
+
+- Threaded Slack failure notifications via a Slack bot token (NOTIFY_SLACK_BOT_TOKEN), grouping failing files into batched thread replies (e453cd0)
+
 ## [0.2.5] - 2026-02-02
 
 ### Added
@@ -19,10 +25,3 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Removed
 
 - OpenStruct dependency
-
-## [0.2.4] - 2025-01-16
-
-### Changed
-
-- Add support for Ruby 3.4
-- Check for Rails application before using Rails.application

data/README.md

@@ -51,6 +51,22 @@ If you are _not_ using Rails, you will need to add this ENV variable:
       NOTIFY_APP_NAME
 ```
 
+### Threaded failure notifications (optional)
+
+Incoming webhooks post a single message. If you instead provide a Slack **bot
+token**, ChatNotifier uses the Slack Web API and threads failures: it posts the
+branch/run summary as a parent message, then posts the failing files — grouped
+into reasonably sized batches — as threaded replies.
+
+```
+      NOTIFY_SLACK_BOT_TOKEN        # xoxb-… bot token; enables threading
+      NOTIFY_SLACK_NOTIFY_CHANNEL   # channel id or name to post to
+      NOTIFY_SLACK_THREAD_GROUP_SIZE # optional, files per reply (default 10)
+```
+
+When both `NOTIFY_SLACK_BOT_TOKEN` and `NOTIFY_SLACK_WEBHOOK_URL` are set, the
+bot token is preferred. The bot needs the `chat:write` scope.
+
 ### Debug your Slack setup
 
 Create rake task to test the connection to your Slack channel

data/lib/chat_notifier/chatter/slack.rb

@@ -1,10 +1,15 @@
 # frozen_string_literal: true
 
+require_relative "../failure_groups"
+
 module ChatNotifier
   class Chatter
     class Slack < self
       Chatter.register self
 
+      API_URL = "https://slack.com/api/chat.postMessage"
+      DEFAULT_THREAD_GROUP_SIZE = 10
+
       class << self
         def handles?(settings)
           !settings.keys.grep(/NOTIFY_SLACK/).empty?
@@ -15,14 +20,71 @@ module ChatNotifier
         settings.fetch("NOTIFY_SLACK_WEBHOOK_URL", nil)
       end
 
+      def bot_token
+        settings.fetch("NOTIFY_SLACK_BOT_TOKEN", nil)
+      end
+
       def channel
         settings.fetch("NOTIFY_SLACK_NOTIFY_CHANNEL", nil)
       end
 
+      def thread_group_size
+        Integer(settings.fetch("NOTIFY_SLACK_THREAD_GROUP_SIZE", DEFAULT_THREAD_GROUP_SIZE))
+      end
+
+      # When a bot token is configured we use the Slack Web API, which can
+      # thread failures. The token path is preferred over an incoming webhook.
+      def post(messenger, process: Net::HTTP.method(:post))
+        return super unless bot_token
+
+        post_via_api(messenger, process:)
+      end
+
       def payload(data)
         super(Configuration.for(data, self).to_h)
       end
 
+      private
+
+      def post_via_api(messenger, process:)
+        parent_text = messenger.failure? ? messenger.lede : messenger.message
+        parent = post_message(text: parent_text, process:)
+
+        return parent unless messenger.failure? && ok?(parent)
+
+        thread_ts = response_ts(parent)
+        FailureGroups.new(messenger.failures, group_size: thread_group_size).reply_texts.each do |text|
+          post_message(text:, thread_ts:, process:)
+        end
+      end
+
+      def post_message(text:, process:, thread_ts: nil)
+        body = {channel: channel, text: text}
+        body[:thread_ts] = thread_ts if thread_ts
+        process.call(URI(API_URL), body.to_json, api_headers)
+      end
+
+      def api_headers
+        {
+          "Content-Type" => "application/json; charset=utf-8",
+          "Authorization" => "Bearer #{bot_token}"
+        }
+      end
+
+      def ok?(response)
+        parsed_response(response)["ok"] == true
+      end
+
+      def response_ts(response)
+        parsed_response(response)["ts"]
+      end
+
+      def parsed_response(response)
+        JSON.parse(response.body.to_s)
+      rescue JSON::ParserError
+        {}
+      end
+
       class Configuration
         def self.for(messenger, communicator)
           if messenger.failure?

data/lib/chat_notifier/failure_groups.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module ChatNotifier
+  # Groups test failures by file and packs them into reasonably sized
+  # batches suitable for posting as individual Slack thread replies.
+  class FailureGroups
+    def initialize(failures, group_size: 10, char_limit: 3000)
+      @failures = failures
+      @group_size = group_size
+      @char_limit = char_limit
+    end
+
+    attr_reader :failures, :group_size, :char_limit
+
+    # One rendered string per thread reply: file blocks packed into batches
+    # bounded by group_size (file count) and char_limit (rendered length).
+    def reply_texts
+      batches.map { |blocks| blocks.join("\n") }
+    end
+
+    private
+
+    def batches
+      file_blocks.each_with_object([]) do |block, packed|
+        current = packed.last
+        if current.nil? ||
+            current.size >= group_size ||
+            (current.join("\n").length + 1 + block.length) > char_limit
+          packed << [block]
+        else
+          current << block
+        end
+      end
+    end
+
+    # Render each file (with its failing lines) into a text block.
+    def file_blocks
+      by_file.map do |file, lines|
+        bullets = lines.map { |line| "  • #{File.basename(file)}:#{line}" }
+        ([file] + bullets).join("\n")
+      end
+    end
+
+    # { "path/to/file.rb" => ["42", "88"], ... } preserving first-seen order.
+    def by_file
+      failures.each_with_object({}) do |failure, groups|
+        file, line = normalize(failure.location)
+        (groups[file] ||= []) << line
+      end
+    end
+
+    # RSpec locations are "path:line" strings; Minitest locations are
+    # [file, line] arrays. Normalize both to [file, line].
+    def normalize(location)
+      if location.is_a?(Array)
+        [location[0], location[1]]
+      else
+        file, _, line = location.to_s.rpartition(":")
+        [file, line]
+      end
+    end
+  end
+end

data/lib/chat_notifier/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ChatNotifier
-  VERSION = "0.2.5"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chat_notifier
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Jim Gay
@@ -9,7 +9,21 @@ authors:
 bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Send test results to chat
 email:
 - jim@saturnflyer.com
@@ -25,6 +39,7 @@ files:
 - lib/chat_notifier/chatter.rb
 - lib/chat_notifier/chatter/debug.rb
 - lib/chat_notifier/chatter/slack.rb
+- lib/chat_notifier/failure_groups.rb
 - lib/chat_notifier/messenger.rb
 - lib/chat_notifier/repository.rb
 - lib/chat_notifier/repository/debug.rb
@@ -46,7 +61,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="