slack_bot-events 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5be1bf5ab14cf6022e8a31b32015e328bd5b1939d928415bb06e610dc3e091e
-  data.tar.gz: e04f3734b913e8514f2ed50eb3f0905906013321f3fa6c26dc3992a7a5136ae4
+  metadata.gz: 653594899c76b05d93054ceb20520d84a487a38451ecee7d561ab5b9e6590bf7
+  data.tar.gz: 3f722375d06dce4ca2a3f4151ed221948b9e1d5e6d87842cf966ff067c54c31b
 SHA512:
-  metadata.gz: 7f59e41eeb158988a8b02ba6b445b1b7ba8009e96c2ec404b313b614e9aa86d5e346518c9ad7e824b49dd29dfc4b04e9f84a827edde5698c07a3d1325b356814
-  data.tar.gz: 4e200610a557c49256745577bca3811e9830609a29009a6f4b09cc1251f972118d013c92a2a9d933e2df3391592c582112abd6911638115987bcdecf7a07fd15
+  metadata.gz: eb0fb66fded40a580f042bd45e9ba139cf3753d2960461265d07394a5c182a35c9f35d33105e7ca5536b6e279c44335baf6b8ba645e531186ffbf3c4d9790dcc
+  data.tar.gz: 02f478db61cabfce5f8e66b7303f47f9ed548d08dafded39d364e579f68ebf448f17ddf851e9717bfea0e755ab41e0821d450ab4b4e3353823a3b161e9ad0dea

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    slack_bot-events (0.3.0)
+    slack_bot-events (0.4.0)
       class_composer (~> 1.0)
       faraday
       faye-websocket

data/lib/slack_bot/events/client.rb

@@ -17,10 +17,10 @@ module SlackBot
           end
 
           websocket.on :message do |socket_event|
-            process_message(socket_event: socket_event) do |parsed_data:, schema: nil|
+            process_message(socket_event: socket_event) do |listener:, parsed_data:, schema: nil|
               case parsed_data["type"]
               when "events_api"
-                events_api(schema: schema, parsed_data: parsed_data)
+                events_api(handler: listener[:handler], schema: schema, parsed_data: parsed_data)
               end
             end
           end
@@ -37,8 +37,11 @@ module SlackBot
 
       def process_message(socket_event:)
         schema_data = Schematize.call(data: socket_event.data)
-        SlackBot::Events.message_middleware.invoke_message(type: :message, socket_event: socket_event, **schema_data) do
-          yield(**schema_data) if block_given?
+
+        listener = find_listener(schema: schema_data[:schema]) # Events.config.listeners[schema_data[:schema]&.type.to_sym]
+
+        SlackBot::Events.message_middleware.invoke_message(websocket: websocket, listener: listener, type: :message, socket_event: socket_event, **schema_data) do
+          yield(listener: listener, **schema_data) if block_given?
         end
       end
 
@@ -48,33 +51,22 @@ module SlackBot
         end
       end
 
-      def events_api(schema:, parsed_data:)
-        if Events.config.print_tldr
-          Events.logger.info { schema.tldr }
-        end
+      def events_api(handler:, schema:, parsed_data:)
+        return if listener.nil?
 
-        object = Events.config.listeners[schema.type.to_sym]
-        if object
-          safe_handler(type: schema.type.to_sym, object: object, schema: schema, parsed_data: parsed_data)
-        end
+        Events.logger.info { schema.tldr } if Events.config.print_tldr
 
-        websocket.send("#{{ envelope_id: schema.envelope_id }.to_json}")
+        # This gets rescued in the MessageHandler middleware
+        # on_success and on_failure happens there as well
+        handler.call(schema: schema, raw_data: parsed_data)
       end
 
       private
 
-      def safe_handler(type:, object:, schema:, parsed_data:)
-        Events.logger.info "Received Handler for #{type}"
-        object[:handler].call(schema: schema, raw_data: parsed_data)
-        object[:on_success]&.call(schema)
-      rescue => error
-        Events.logger.error("#{object[:handler]} returned #{error.class} => #{error.message}. Safely returning to websocket. #{error.backtrace[0...10]}")
-
-        begin
-          object[:on_failure]&.call(schema, error)
-        rescue => on_failure_error
-           Events.logger.error("Failure occured during on_failure block. #{on_failure_error}")
-        end
+      def find_listener(schema:)
+        return nil if schema.nil?
+
+        Events.config.listeners[schema.type.to_sym]
       end
 
       def websocket
@@ -93,9 +85,7 @@ module SlackBot
       end
 
       def faraday_headers
-        {
-          'Authorization' => "Bearer #{SlackBot::Events.config.client_socket_token}"
-        }
+        { 'Authorization' => "Bearer #{SlackBot::Events.config.client_socket_token}" }
       end
     end
   end

data/lib/slack_bot/events/configuration.rb

@@ -26,6 +26,12 @@ module SlackBot
       add_composer :close_middleware, allowed: Middleware::Chain, default: Middleware::Chain.new(type: :close)
       add_composer :envelope_acknowledge, allowed: Symbol, default: DEFAULT_ACKNOWLEDGE, validator: ->(val) { ALLOWED_ACKNOWLEDGE.include?(val) }, invalid_message: ->(_) { "Must by a Symbol in #{ALLOWED_ACKNOWLEDGE}" }
 
+      ALLOWED_ACKNOWLEDGE.each do |ack|
+        define_method :"acknowledge_#{ack}?" do
+          envelope_acknowledge == ack
+        end
+      end
+
       def register_listener(name:, handler:, on_success: nil, on_failure: nil)
         if event_handler = listeners[name.to_sym]
           logger.warn "`#{name}` already exists as listener event. Reseting with new input"

data/lib/slack_bot/events/middleware/chain.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "slack_bot/events/middleware/event_tracer"
+require "slack_bot/events/middleware/message_handler"
 
 ####################
 #
@@ -18,7 +19,7 @@ module SlackBot
         attr_reader :type
 
         DEFAULT_ENTRIES = {
-          message: [Middleware::EventTracer],
+          message: [Middleware::EventTracer, Middleware::MessageHandler],
           open: [Middleware::EventTracer],
           close: [Middleware::EventTracer],
         }
@@ -85,19 +86,21 @@ module SlackBot
           @entries = nil
         end
 
-        def invoke_message(type:, socket_event:, parsed_data:, schema: nil)
+        def invoke_message(type:, socket_event:, parsed_data:, websocket:, listener:, schema: nil)
           return yield if empty?
 
           chain = retrieve
           traverse_chain = proc do
             if chain.empty?
-              yield(yield: schema, parsed_data: parsed_data)
+              yield
             else
               params = {
                 parsed_data: parsed_data,
                 schema: schema,
                 socket_event: socket_event,
+                listener: listener,
                 type: type,
+                websocket: websocket,
               }
               chain.shift.call(**params, &traverse_chain)
             end

data/lib/slack_bot/events/middleware/event_tracer.rb

@@ -4,14 +4,18 @@ module SlackBot
   module Events
     module Middleware
       class EventTracer
-        def call(type:, socket_event:, schema: nil, parsed_data: nil)
+        def call(type:, socket_event:, schema: nil, parsed_data: nil, **params)
           start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
           temp_type = type.dup.to_s
           case type
           when :close
             additional_info = "code: #{socket_event.code} reason:#{socket_event.reason}"
           when :message
-            p_type = parsed_data.dig("type")
+            accurate_type = parsed_data.dig("payload","event","subtype") || parsed_data.dig("payload","event","type")
+            p_type = [
+              parsed_data.dig("type"),
+              accurate_type
+            ].compact.join(":")
             case p_type
             when "app_rate_limited"
               # https://api.slack.com/apis/rate-limits#events
@@ -32,7 +36,7 @@ module SlackBot
           yield
 
           elapsed_time = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time
-          Events.logger.info { "[Event Finished] [#{(elapsed_time * 1000).round(2)}ms] #{temp_type}" }
+          Events.logger.info { "[Event Finished] #{temp_type} [#{(elapsed_time * 1000).round(2)}ms]" }
         end
       end
     end

data/lib/slack_bot/events/middleware/message_handler.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module SlackBot
+  module Events
+    module Middleware
+      class MessageHandler
+        def call(schema:, websocket:, listener:, **params)
+          if SlackBot::Events.config.acknowledge_on_receive?
+            acknowledge!(websocket: websocket, schema: schema)
+          end
+
+          yield
+
+          listener[:on_success]&.call(schema) if listener
+
+          if SlackBot::Events.config.acknowledge_on_success? || SlackBot::Events.config.acknowledge_on_complete?
+            acknowledge!(websocket: websocket, schema: schema)
+          end
+        rescue StandardError => error
+          puts error.message
+          puts error.backtrace
+          Events.logger.error do
+            "#{listener[:handler]} returned #{error.class} => #{error.message}. #{error.backtrace[0...10]}"
+          end
+
+          begin
+            listener[:on_failure]&.call(schema, error) if listener
+          rescue StandardError => on_failure_error
+             Events.logger.error("Failure occured during on_failure block. #{on_failure_error}")
+          end
+
+          if SlackBot::Events.config.acknowledge_on_complete?
+            acknowledge!(websocket: websocket, schema: schema)
+          elsif SlackBot::Events.config.acknowledge_on_success?
+            Events.logger.debug do
+              "Envelope acknowledgment skipped. Ackowledgment on success only. Slack may send a duplicate message"
+            end
+          end
+        end
+
+        private
+
+        def acknowledge!(websocket:, schema:)
+          return if schema.nil?
+
+          websocket.send("#{{ envelope_id: schema.envelope_id }.to_json}")
+          Events.logger.debug { "Envelope acknowledgment completed [#{SlackBot::Events.config.envelope_acknowledge}]" }
+        end
+      end
+    end
+  end
+end

data/lib/slack_bot/events/version.rb

@@ -2,6 +2,6 @@
 
 module SlackBot
   module Events
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack_bot-events
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Matt Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-20 00:00:00.000000000 Z
+date: 2024-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -136,6 +136,7 @@ files:
 - lib/slack_bot/events/configuration.rb
 - lib/slack_bot/events/middleware/chain.rb
 - lib/slack_bot/events/middleware/event_tracer.rb
+- lib/slack_bot/events/middleware/message_handler.rb
 - lib/slack_bot/events/schemas/authorization.rb
 - lib/slack_bot/events/schemas/data_payload.rb
 - lib/slack_bot/events/schemas/socket_payload.rb