slack_socket_mode_bot 0.9.0 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea84a2e36d8b349ef867322ad4e932703dc5fa7eea1397f693268977aecfb001
-  data.tar.gz: 1802e47527f56357fa5a3d564f61f91a6a3f3741bb107227dad18be8beedb08f
+  metadata.gz: ecdae100a7f27d51751fe1fd77c772ca8a88cfab323266c874b996ffaed909c8
+  data.tar.gz: 92b4827386e87485f3adf26e93de16e910a2c4f9d320ba4cc683768d067b130f
 SHA512:
-  metadata.gz: 4b5cbb57859b8f34a2d45c8869d2f197ef84f24d7554c12027e331a783edc510357dd6d7cd1b199db98870b17abb2a27e2ca1f70fc4fce0151fa82392db4456a
-  data.tar.gz: e84f97c7a0dbe89e249315f5142b7c275de3b7cfb4f90127727d7d9e943f14c1eb493994a56554d8af22c7a2248e9e5a9c873a2a08e3f21bd7614265d5fa383b
+  metadata.gz: 497006f3d3854a431e29f12f6463c57ed35290e5d722de7fe7bab24a886f667483821553da14ecc904d64b6de45c3d48ae446f90ba4424c3fbcbf7c59362ec38
+  data.tar.gz: a0e94a4812aaf022a7e62e02f0a56718ecb38cfd49002fc0dbdc7e9833fcb6520dfe799ff3d2279d9239520a615215240337261a4116c4c4ab1b7496d4239af5

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Yusuke Endoh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -64,22 +64,18 @@ bot.run
 ```
 
 ```
-$ ruby example/echo_bot.rb
+$ ruby examples/echo_bot.rb
 I, [20XX-XX-XXTXX:XX:XX.XXXXXX #XXXXXX]  INFO -- : [ws:2560] websocket open
 I, [20XX-XX-XXTXX:XX:XX.XXXXXX #XXXXXX]  INFO -- : [ws:2600] websocket open
-I, [20XX-XX-XXTXX:XX:XX.XXXXXX #XXXXXX]  INFO -- : [ws:2560] slack hello
-I, [20XX-XX-XXTXX:XX:XX.XXXXXX #XXXXXX]  INFO -- : [ws:2560] active connection count: 4
-I, [20XX-XX-XXTXX:XX:XX.XXXXXX #XXXXXX]  INFO -- : [ws:2600] slack hello
-I, [20XX-XX-XXTXX:XX:XX.XXXXXX #XXXXXX]  INFO -- : [ws:2600] active connection count: 4
 I, [20XX-XX-XXTXX:XX:XX.XXXXXX #XXXXXX]  INFO -- : [ws:2640] websocket open
-I, [20XX-XX-XXTXX:XX:XX.XXXXXX #XXXXXX]  INFO -- : [ws:2640] slack hello
-I, [20XX-XX-XXTXX:XX:XX.XXXXXX #XXXXXX]  INFO -- : [ws:2640] active connection count: 4
 I, [20XX-XX-XXTXX:XX:XX.XXXXXX #XXXXXX]  INFO -- : [ws:2680] websocket open
-I, [20XX-XX-XXTXX:XX:XX.XXXXXX #XXXXXX]  INFO -- : [ws:2680] slack hello
-I, [20XX-XX-XXTXX:XX:XX.XXXXXX #XXXXXX]  INFO -- : [ws:2680] active connection count: 4
-I, [20XX-XX-XXTXX:XX:XX.XXXXXX #XXXXXX]  INFO -- : [ws:2680] slack events_api (event_callback)
-I, [20XX-XX-XXTXX:XX:XX.XXXXXX #XXXXXX]  INFO -- : [ws:2680] slack events_api (event_callback)
-I, [20XX-XX-XXTXX:XX:XX.XXXXXX #XXXXXX]  INFO -- : [ws:2680] slack events_api (event_callback)
+I, [20XX-XX-XXTXX:XX:XX.XXXXXX #XXXXXX]  INFO -- : [ws:2560] hello (active connections: 4)
+I, [20XX-XX-XXTXX:XX:XX.XXXXXX #XXXXXX]  INFO -- : [ws:2600] hello (active connections: 4)
+I, [20XX-XX-XXTXX:XX:XX.XXXXXX #XXXXXX]  INFO -- : [ws:2640] hello (active connections: 4)
+I, [20XX-XX-XXTXX:XX:XX.XXXXXX #XXXXXX]  INFO -- : [ws:2680] hello (active connections: 4)
+I, [20XX-XX-XXTXX:XX:XX.XXXXXX #XXXXXX]  INFO -- : [ws:2680] events_api app_mention Ev08H3RABCDE
+I, [20XX-XX-XXTXX:XX:XX.XXXXXX #XXXXXX]  INFO -- : [ws:2680] events_api app_mention Ev08H3RFGHIJ
+I, [20XX-XX-XXTXX:XX:XX.XXXXXX #XXXXXX]  INFO -- : [ws:2680] events_api app_mention Ev08H3RKLMNO
 ...
 ```
 
@@ -94,6 +90,9 @@ Connects to Slack with Socket Mode.
 * `logger`: A Logger instance (optional)
 * block: Handles events received from Slack
 
+Note: The block must return as soon as possible. Otherwise, the Slack server will re-send the event.
+If you want to do a time-consuming process, it is recommended that you do it in a sub thread.
+
 ### `SlackSocketModeBot#call(method, data, token:)`
 
 Calls Slack's [Web API](https://api.slack.com/methods), such as [chat.postMessage](https://api.slack.com/methods/chat.postMessage).
@@ -107,6 +106,11 @@ This method returns the response as a JSON data.
 
 Starts the main loop of communication with Slack. This method does not return.
 
+On an unrecoverable error (for example, losing every connection and being unable
+to reopen any), this method raises an exception instead of silently continuing in
+a degraded state. Running your bot under a process supervisor such as systemd is
+recommended so that it is restarted when this happens.
+
 ### `SlackSocketModeBot#step`
 
 Proceeds with the communication one step.

data/Rakefile

@@ -1,4 +1,12 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-task default: %i[]
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib" << "test"
+  t.test_files = FileList["test/test_*.rb"]
+  t.warning = false
+end
+
+task default: %i[test]

data/lib/slack_socket_mode_bot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class SlackSocketModeBot
-  VERSION = "0.9.0"
+  VERSION = "0.9.2"
 end

data/lib/slack_socket_mode_bot.rb

@@ -12,6 +12,21 @@ require_relative "slack_socket_mode_bot/simple_web_socket"
 class SlackSocketModeBot
   class Error < StandardError; end
 
+  API_BASE = "https://slack.com/api/"
+
+  # Internal signal: retry after `wait` seconds. Always caught in #call.
+  class Retry < StandardError
+    attr_reader :wait
+    def initialize(wait)
+      @wait = wait
+      super("retry after #{ wait }s")
+    end
+  end
+  private_constant :Retry
+
+  # Max seconds to sleep on a 429 Retry-After; #call may run in the event loop.
+  RETRY_AFTER_CAP = 60
+
   #: (token: String, ?app_token: String, ?num_of_connections: Integer, ?debug: boolean, ?logger: Logger) { (untyped) -> untyped } -> void
   def initialize(token:, app_token: nil, num_of_connections: 4, debug: false, logger: nil, &callback)
     @token = token
@@ -19,30 +34,67 @@ class SlackSocketModeBot
     @conns = []
     @debug = debug
     @logger = logger
-    num_of_connections.times { add_connection(callback) } if app_token
+    @events = {}
+    @callback = callback
+    # No app token: Web API calls only, no Socket Mode connections.
+    @num_of_connections = app_token ? num_of_connections : 0
+    replenish_connections
   end
 
   #: (String method, untyped data, ?token: String) -> untyped
   def call(method, data, token: @token)
-    count = 0
+    url = URI(API_BASE + method)
+    body = JSON.generate(data)
+    headers = {
+      "Content-type" => "application/json; charset=utf-8",
+      "Authorization" => "Bearer " + token,
+    }
+
+    retries = 0
     begin
-      url = URI("https://slack.com/api/" + method)
-      res = Net::HTTP.post(
-        url, JSON.generate(data),
-        "Content-type" => "application/json; charset=utf-8",
-        "Authorization" => "Bearer " + token,
-      )
-      json = JSON.parse(res.body, symbolize_names: true)
-      raise Error, json[:error] unless json[:ok]
-      json
-    rescue Socket::ResolutionError
+      res = Net::HTTP.post(url, body, headers)
+
+      case res
+      when Net::HTTPSuccess
+        json = JSON.parse(res.body, symbolize_names: true)
+        raise Error, json[:error] unless json[:ok]
+        json
+      when Net::HTTPTooManyRequests
+        # Rejected, not processed: safe to retry after Retry-After seconds.
+        raise Retry, Integer(res["retry-after"] || retries + 1)
+      else
+        # 5xx etc.: may already be processed, so don't retry; just don't crash.
+        raise Error, "HTTP #{ res.code } #{ res.message }"
+      end
+    rescue Socket::ResolutionError, Net::OpenTimeout
+      # Never sent (DNS / connect failure): safe to retry.
+      retries += 1
+      raise if retries >= 3
       sleep 1
-      count += 1
-      retry if count < 3
-      raise
+      retry
+    rescue Retry => e
+      # Don't block the event loop on an absurdly long wait.
+      retries += 1
+      raise Error, "rate limited (retry-after: #{ e.wait }s)" if retries >= 3 || e.wait > RETRY_AFTER_CAP
+      sleep e.wait
+      retry
     end
   end
 
+  private def replenish_connections
+    # Reopen from the main loop, tolerating a single failure; #step retries.
+    while @conns.size < @num_of_connections
+      begin
+        add_connection(@callback)
+      rescue => e
+        @logger.warn("[reconnect] failed: #{ e.message }") if @logger
+        break
+      end
+    end
+    # Fail loud rather than degrade silently once every connection is gone.
+    raise Error, "all socket connections lost" if @num_of_connections > 0 && @conns.empty?
+  end
+
   private def add_connection(callback)
     json = call("apps.connections.open", {}, token: @app_token)
 
@@ -53,35 +105,56 @@ class SlackSocketModeBot
       when :open
         @logger.info("[ws:#{ ws.object_id }] websocket open") if @logger
       when :close
+        # #step drops the dead connection; #replenish_connections reopens it.
         @logger.info("[ws:#{ ws.object_id }] websocket closed") if @logger
-        add_connection(callback)
       when :message
         begin
           json = JSON.parse(data, symbolize_names: true)
         rescue JSON::ParserError
-          add_connection(callback)
+          # A stray non-JSON frame: skip it, don't open a spurious connection.
+          @logger.warn("[ws:#{ ws.object_id }] received a non-JSON message; ignored") if @logger
           next
         end
 
         if @logger
           @logger.debug("[ws:#{ ws.object_id }] slack message: #{ JSON.generate(json) }")
-          msg = "slack #{ json[:type] }"
-          payload_type = json.dig(:payload, :type)
-          msg += " (#{ payload_type })" if payload_type
-          @logger.info("[ws:#{ ws.object_id }] " + msg)
         end
 
         case json[:type]
         when "hello"
-          @logger.info("[ws:#{ ws.object_id }] active connection count: #{ @conns.size }") if @logger
+          @logger.info("[ws:#{ ws.object_id }] hello (active connections: #{ @conns.size })") if @logger
         when "disconnect"
           ws.close
+          @logger.info("[ws:#{ ws.object_id }] disconnect (active connections: #{ @conns.size })") if @logger
         else
+          payload = json[:payload]
+          if @logger
+            # Log a per-type identifier; event_id/retry only apply to events_api.
+            detail =
+              case json[:type]
+              when "events_api"   then [payload.dig(:event, :type), payload[:event_id]].compact.join(" ")
+              when "slash_commands" then payload[:command]
+              else payload[:type]
+              end
+            retry_n = json[:retry_attempt].to_i
+            line = "[ws:#{ ws.object_id }] #{ json[:type] }"
+            line += " #{ detail }" if detail && !detail.empty?
+            line += " (retry ##{ retry_n })" if retry_n > 0
+            @logger.info(line)
+          end
+          # Only events_api has an event_id; dedup just those (others have none).
+          event_id = payload[:event_id]
+          expired = Time.now.to_i - 600
+          @events.reject! {|_, timestamp| timestamp < expired }
+
+          # ACK every message; only skip the handler for a duplicate, else Slack resends.
+          duplicate = event_id && @events[event_id]
+          @events[event_id] = payload[:event_time] if event_id
+
           response = { envelope_id: json[:envelope_id] }
-          if json[:accepts_response_payload]
-            response[:payload] = callback.call(json)
-          else
-            callback.call(json)
+          unless duplicate
+            result = callback.call(json)
+            response[:payload] = result if json[:accepts_response_payload]
           end
           ws.send(JSON.generate(response))
         end
@@ -95,6 +168,7 @@ class SlackSocketModeBot
   def step
     read_ios, write_ios = [], []
     @conns.select! {|ws| ws.step(read_ios, write_ios) }
+    replenish_connections
     return read_ios, write_ios
   end
 

data/sig/slack_socket_mode.rbs

@@ -1,13 +1,14 @@
-module Slack
-  class SocketMode
-    VERSION: String
-  
-    def initialize: (token: String, ?app_token: String, ?num_of_connections: Integer, ?debug: boolean, ?logger: Logger) { (untyped) -> untyped } -> void
-  
-    def call: (String method, untyped data, ?token: String) -> untyped
-  
-    def step: -> [Array[IO], Array[IO]]
-  
-    def run: -> bot
+class SlackSocketModeBot
+  VERSION: String
+
+  class Error < StandardError
   end
+
+  def initialize: (token: String, ?app_token: String?, ?num_of_connections: Integer, ?debug: bool, ?logger: Logger?) { (untyped) -> untyped } -> void
+
+  def call: (String method, untyped data, ?token: String) -> untyped
+
+  def step: () -> [ Array[IO], Array[IO] ]
+
+  def run: () -> void
 end

metadata

@@ -1,60 +1,66 @@
 --- !ruby/object:Gem::Specification
 name: slack_socket_mode_bot
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.2
 platform: ruby
 authors:
-- Yusuke Endoh
+  - Yusuke Endoh
 bindir: bin
 cert_chain: []
-date: 2024-06-21 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: websocket
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
+  - !ruby/object:Gem::Dependency
+    name: websocket
+    requirement: !ruby/object:Gem::Requirement
+      requirements:
+        -
+          - ~>
+          - !ruby/object:Gem::Version
+            version: "1.2"
+    type: :runtime
+    prerelease: false
+    version_requirements: !ruby/object:Gem::Requirement
+      requirements:
+        -
+          - ~>
+          - !ruby/object:Gem::Version
+            version: "1.2"
 email:
-- mame@ruby-lang.org
+  - mame@ruby-lang.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README.md
-- Rakefile
-- lib/slack_socket_mode_bot.rb
-- lib/slack_socket_mode_bot/simple_web_socket.rb
-- lib/slack_socket_mode_bot/version.rb
-- sig/slack_socket_mode.rbs
-homepage: https://github.com/mame/slack_socket_mode_bot
-licenses: []
+  - LICENSE
+  - README.md
+  - Rakefile
+  - lib/slack_socket_mode_bot.rb
+  - lib/slack_socket_mode_bot/simple_web_socket.rb
+  - lib/slack_socket_mode_bot/version.rb
+  - sig/slack_socket_mode.rbs
+homepage: "https://github.com/mame/slack_socket_mode_bot"
+licenses:
+  - MIT
 metadata:
-  homepage_uri: https://github.com/mame/slack_socket_mode_bot
-  source_code_uri: https://github.com/mame/slack_socket_mode_bot
+  homepage_uri: "https://github.com/mame/slack_socket_mode_bot"
+  source_code_uri: "https://github.com/mame/slack_socket_mode_bot"
 rdoc_options: []
 require_paths:
-- lib
+  - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
-    - !ruby/object:Gem::Version
-      version: 3.0.0
+    -
+      - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
-    - !ruby/object:Gem::Version
-      version: '0'
+    -
+      - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
 requirements: []
-rubygems_version: 3.6.0.dev
+rubygems_version: 4.1.0.dev
 specification_version: 4
 summary: A simple wrapper library for Slack's Socket Mode API
 test_files: []