chat_notifier 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5308e4e0f01c30a99f8757f25931aac529ef902c6104b430e262c883a6682f87
-  data.tar.gz: f51b1b019ce7039cb962b5d85e717e5e6c44f82c093c5c0a9cb9e2c920c88191
+  metadata.gz: 62958f54e981fe03f20e8e7b954b18b0cc7f404542698d58db36a3fd7911b3ed
+  data.tar.gz: 42760f3c980906d660c601a984719ea551d137e6db064545ef9fcc446442a6d0
 SHA512:
-  metadata.gz: a3e69e1c6e97a60716ba7ef51c3e9ee9f3416a27e63b1ba91dc0dfa1dc69c31f8ea5b06da3ba12f8b68407415f06022737a15af5ee6b33418cb9fd74ab21bdb4
-  data.tar.gz: 97430ec5fd718f4a81c7b98d84bae7cc1d85520d92b5daf293d64853d2f3af3898ca8cd640c753f55910255f61182715d159c029d37c35e8f270b72c1751d30e
+  metadata.gz: 4c37610777e3d4cc791791339e8b39ea7cacc386fb4032290a29040c0ef0184ee87d0d5ae26d3d072b16e9ed85d6abbd668e37b46adbaff98faeab1aff2a9396
+  data.tar.gz: d70529078358faeb2d419bae2951958b0ca94fdcaec00bfe5d820092dd4e366e784b5825ea1f0541eb041d91758427265256f30efd1f487e9427b6022e19c382

data/CHANGELOG.md

@@ -5,15 +5,23 @@ 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.2.4] - 2025-01-16
+## [0.3.0] - 2026-07-24
 
-### Changed
+### 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
 
-- Add support for Ruby 3.4
-- Check for Rails application before using Rails.application
+### Added
+
+- Dependabot configuration with weekly updates
+
+### Changed
 
-## [0.2.3] - 2024-09-21
+- Moved ENV variable setting `NOTIFY_APP_NAME` into the test helper
+- Refactored method signatures for easier testing
 
-### Fixed
+### Removed
 
-- Incorrect configuration of the logger
+- OpenStruct dependency

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
@@ -79,12 +95,4 @@ end
 
 ## Contributing
 
-This gem is managed with [Reissue](https://github.com/SOFware/reissue).
-
-Releasing a new version:
-
-```sh
-rake build:checksum
-rake release
-git push
-```
+This gem is managed with [Reissue](https://github.com/SOFware/reissue). Releases are automated via the [shared release workflow](https://github.com/SOFware/reissue/blob/main/.github/workflows/SHARED_WORKFLOW_README.md). Trigger a release by running the "Release gem to RubyGems.org" workflow from the Actions tab.

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/chatter.rb

@@ -13,7 +13,7 @@ module ChatNotifier
       @environment = environment
     end
 
-    attr :settings, :repository, :environment
+    attr_reader :settings, :repository, :environment
 
     class << self
       def handlers
@@ -45,16 +45,16 @@ module ChatNotifier
     def body
     end
 
-    def post(messenger)
+    def post(messenger, process: Net::HTTP.method(:post))
       uri = URI(webhook_url)
 
-      Net::HTTP.post(uri, payload(messenger))
+      process.call(uri, payload(messenger))
     end
 
-    def conditional_post(messenger)
+    def conditional_post(messenger, process: Net::HTTP.method(:post))
       return if messenger.success? && !verbose?
 
-      post(messenger)
+      post(messenger, process:)
     end
 
     def verbose?

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/messenger.rb

@@ -36,7 +36,7 @@ module ChatNotifier
       @environment = environment
     end
 
-    attr :summary, :app, :repository, :environment
+    attr_reader :summary, :app, :repository, :environment
 
     def failures = summary.failed_examples
 

data/lib/chat_notifier/version.rb

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

data/lib/chat_notifier.rb

@@ -16,25 +16,32 @@ module ChatNotifier
   class << self
     attr_accessor :logger
 
-    def app
-      if defined?(::Rails) && Rails.respond_to?(:application)
+    def app(env: ENV, name: env.fetch("NOTIFY_APP_NAME"))
+      name ||= if defined?(::Rails) && Rails.respond_to?(:application)
         Rails.application.class.module_parent
       else
-        ENV.fetch("NOTIFY_APP_NAME")
+        raise "No app name provided and Rails is not defined"
       end
     end
 
+    STANDARDS = {
+      repository: Repository,
+      environment: TestEnvironment,
+      chatter: Chatter,
+      messenger: Messenger
+    }
+
     # In order to test this locally see `rake chat_notifier:debug`
-    def debug!(env, summary:, notifier: :Debug)
-      repository = Repository.for(env)
-      environment = TestEnvironment.for(env)
+    def debug!(env, summary:, notifier: :Debug, **kwargs)
+      repository = (kwargs[:repository] || STANDARDS[:repository]).for(env)
+      environment = (kwargs[:environment] || STANDARDS[:environment]).for(env)
 
-      chatter = Chatter.const_get(notifier).new(
+      chatter = (kwargs[:chatter] || STANDARDS[:chatter]).const_get(notifier).new(
         settings: env,
         repository: repository,
         environment: environment
       )
-      messenger = Messenger.for(
+      messenger = (kwargs[:messenger] || STANDARDS[:messenger]).for(
         summary,
         app:,
         repository:,
@@ -44,16 +51,16 @@ module ChatNotifier
       chatter.post(messenger)
     end
 
-    def call(summary:)
-      repository = Repository.for(ENV)
-      environment = TestEnvironment.for(ENV)
-      chatter = Chatter.handling(
+    def call(summary:, **kwargs)
+      repository = (kwargs[:repository] || STANDARDS[:repository]).for(ENV)
+      environment = (kwargs[:environment] || STANDARDS[:environment]).for(ENV)
+      chatter = (kwargs[:chatter] || STANDARDS[:chatter]).handling(
         ENV,
         repository:,
         environment:
       )
 
-      messenger = Messenger.for(
+      messenger = (kwargs[:messenger] || STANDARDS[:messenger]).for(
         summary,
         app:,
         repository:,
@@ -61,11 +68,9 @@ module ChatNotifier
       )
 
       chatter.each do |box|
-        begin
-          box.conditional_post(messenger)
-        rescue => exception
-          logger.error("ChatNotifier: #{box.webhook_url} #{exception.class}: #{exception.message}")
-        end
+        box.conditional_post(messenger)
+      rescue => exception
+        logger.error("ChatNotifier: #{box.webhook_url} #{exception.class}: #{exception.message}")
       end
     end
   end

data/lib/minitest/chat_notifier_plugin.rb

@@ -8,8 +8,8 @@ module Minitest
     ExceptionLocation = Data.define(:location)
     Summary = Data.define(:failed_examples)
     def report
-      summary = Summary[(results.map{ |result| ExceptionLocation[result.source_location] })]
+      summary = Summary[(results.map { |result| ExceptionLocation[result.source_location] })]
       ::ChatNotifier.call(summary:)
     end
   end
-end
+end

metadata

@@ -1,16 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: chat_notifier
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Jim Gay
 - Savannah Albanez
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-16 00:00:00.000000000 Z
-dependencies: []
+date: 1980-01-02 00:00:00.000000000 Z
+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
@@ -26,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
@@ -36,12 +50,10 @@ files:
 - lib/chat_notifier/test_environment/github.rb
 - lib/chat_notifier/version.rb
 - lib/minitest/chat_notifier_plugin.rb
-homepage:
 licenses: []
 metadata:
   source_code_uri: https://github.com/SOFware/chat_notifier.git
   changelog_uri: https://github.com/SOFWare/chat_notifier/blob/master/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -49,15 +61,14 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Notify chat of test results
 test_files: []