activerecord-postgres_pub_sub 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbcb38025bb4b4992bb6a8d7ed1b2c1288fcc9b3df9c3bc4459a9be8ce7e96bd
-  data.tar.gz: fefad9359ecce30c1198a3c34e2c64ebb9993b797e2ff7320dd47ae23e6dfa2f
+  metadata.gz: 1b886594148cd3420c38dee50e9baeba2d73f01901cd682704efb624ee999b51
+  data.tar.gz: ee644f50f830c05f60efc505f50b73ffefbbb4971bbbca256e63d4d00d16c9f2
 SHA512:
-  metadata.gz: ce692f2b1d176e51767ca21d679d8b618a84e9c029cd5f70e4430e32dec6ba6d9d9c226945c25530125d4e7f7692f7ab049673117aa0c86f3ed8bfdae08ef3d6
-  data.tar.gz: 7166ae680431461ea81a0e44e0d3f8b0b26607255d23869417c2c59c98a74a04ba75c783e7682c576a8c4de9b305d0d9906e36fe433e11fe6ff8c979adc57d03
+  metadata.gz: 02d2b855c61be06e21b9acedb849a0ada4a99f7345f5be171ac33fcf4ca67ceced2ffd9fa023cce5851a0cb3eadc8a344192f8d35ab15ac947c45a9d0ccf7ce6
+  data.tar.gz: c23a5d3df02df37aad3e136924926428a366721d1da68e854e6968c2f728db43cb6059f5258e276d0bbc10008ab2bec319908f4c1babc280ead7952d5d102d6d

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # activerecord-postgres_pub_sub
 
+## v2.2.0
+- Add support for listening to multiple channels.
+
 ## v2.1.0
 - Set required ruby version to 2.7.0
 - Add support for Rails 7.0

data/README.md

@@ -2,7 +2,7 @@
 
 [![CircleCI](https://circleci.com/gh/ezcater/activerecord-postgres_pub_sub.svg?style=svg)](https://circleci.com/gh/ezcater/activerecord-postgres_pub_sub)
 
-This gem contains support for PostgreSQL LISTEN and NOTIFY functionality: 
+This gem contains support for PostgreSQL LISTEN and NOTIFY functionality:
 [doc](https://www.postgresql.org/docs/9.6/static/libpq-notify.html).
 
 ## Installation
@@ -25,7 +25,8 @@ Or install it yourself as:
 
 ### Listener
 
-The `Listener` class is used to handle notification messages.
+The `Listener` class is used to handle notification messages on one or more
+channels.
 
 The listener can be configured with three blocks:
 
@@ -33,13 +34,13 @@ The listener can be configured with three blocks:
 * **on_start**: called before receiving any notifications.
 * **on_timeout**: called based on a configurable timeout, when no notifications
   have been received.
-  
+
 When creating a listener, the following configuration is supported:
 
-* **listen_timeout**: If set, the `on_timeout` block will be called if 
-  no notifications are received within this period. (Default `nil`).  
+* **listen_timeout**: If set, the `on_timeout` block will be called if
+  no notifications are received within this period. (Default `nil`).
 * **notify_only**: A payload string can be included in notifications. By default
-  the listener ignores the payload and coalesces multiple notifications into a 
+  the listener ignores the payload and coalesces multiple notifications into a
   single call. When this option is `false`, the `on_notify` block is called with
   the payload for each notification. (Default `true`).
 * **exclusive_lock**: Acquire a lock using
@@ -51,16 +52,16 @@ Example:
 ```ruby
 ActiveRecord::PostgresPubSub::Listener.listen("notify_channel", listen_timeout: 30) do |listener|
   listener.on_start do
-    # when starting assume we missed something and perform regular activity 
+    # when starting assume we missed something and perform regular activity
     handle_notification
   end
-  
+
   listener.on_notify do
     handle_notification
   end
-  
+
   listener.on_timeout do
-    perform_regular_maintenance 
+    perform_regular_maintenance
   end
 end
 ```

data/lib/activerecord/postgres_pub_sub/listener.rb

@@ -9,10 +9,10 @@ module ActiveRecord
       extend PrivateAttr
 
       private_attr_reader :on_notify_blk, :on_start_blk, :on_timeout_blk,
-                          :channel, :listen_timeout, :exclusive_lock, :notify_only
+                          :channels, :listen_timeout, :exclusive_lock, :notify_only
 
-      def self.listen(channel, listen_timeout: nil, exclusive_lock: true, notify_only: true)
-        listener = new(channel,
+      def self.listen(*channels, listen_timeout: nil, exclusive_lock: true, notify_only: true)
+        listener = new(*channels,
                        listen_timeout: listen_timeout,
                        exclusive_lock: exclusive_lock,
                        notify_only: notify_only)
@@ -20,8 +20,8 @@ module ActiveRecord
         listener.listen
       end
 
-      def initialize(channel, listen_timeout: nil, exclusive_lock: true, notify_only: true)
-        @channel = channel
+      def initialize(*channels, listen_timeout: nil, exclusive_lock: true, notify_only: true)
+        @channels = channels
         @listen_timeout = listen_timeout
         @exclusive_lock = exclusive_lock
         @notify_only = notify_only
@@ -44,8 +44,8 @@ module ActiveRecord
           on_start_blk&.call
 
           loop do
-            wait_for_notify(connection) do |payload|
-              notify_only ? on_notify_blk.call : on_notify_blk.call(payload)
+            wait_for_notify(connection) do |payload, channel|
+              notify_only ? on_notify_blk.call : on_notify_blk.call(payload, channel)
             end
           end
         end
@@ -56,12 +56,16 @@ module ActiveRecord
       def with_connection
         ActiveRecord::Base.connection_pool.with_connection do |connection|
           with_optional_lock do
-            connection.execute("LISTEN #{channel}")
+            channels.each do |channel|
+              connection.execute("LISTEN #{channel};")
+            end
 
             begin
               yield(connection)
             ensure
-              connection.execute("UNLISTEN #{channel}")
+              channels.each do |channel|
+                connection.execute("UNLISTEN #{channel}")
+              end
             end
           end
         end
@@ -76,7 +80,7 @@ module ActiveRecord
       end
 
       def lock_name
-        "#{channel}-listener"
+        "#{channels.join('-')}-listener"
       end
 
       def empty_channel(connection)
@@ -87,10 +91,11 @@ module ActiveRecord
 
       def wait_for_notify(connection)
         connection_pid = connection.raw_connection.backend_pid
-        event_result = connection.raw_connection.wait_for_notify(listen_timeout) do |_event, pid, payload|
+        event_result = connection.raw_connection.wait_for_notify(listen_timeout) do |notify_channel, pid, payload|
           if pid != connection_pid
             empty_channel(connection.raw_connection) if notify_only
-            yield(payload)
+
+            yield(payload, notify_channel)
           end
         end
 

data/lib/activerecord/postgres_pub_sub/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   module PostgresPubSub
-    VERSION = "2.1.0"
+    VERSION = "2.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-postgres_pub_sub
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - ezCater, Inc
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-23 00:00:00.000000000 Z
+date: 2022-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -246,7 +246,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -261,8 +261,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Support for Postgres Notify/Listen
 test_files: []