eventq 2.4.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8a55998f78ac404d51a4278b44b802a23d1b9c322cad2a29b8c1e94950ad4fa
-  data.tar.gz: 92dddbaed323bf8f803a07adc483376a2b255c43ce015c6a5ed59c3b81081478
+  metadata.gz: ea953c5716907922d39bdf208905ef63c23d210dd58efb9a9f5744f328608ae3
+  data.tar.gz: ab03fa33de860acc77710fd49b2ee1f42ce782bc9299e8d1e01602e554a1c7b0
 SHA512:
-  metadata.gz: 45465979d1c58fd6cb0a4f54752a7cb4278c002465cbb12e3f4ee8b6e98538d9f65ab35e15d69cb41ae88d28f00fbc275bb73b7bc45be777e3c576d07384143f
-  data.tar.gz: 7011679b0e5c08fc6a0468067816e6bf136ce24900e411d5e1b1afedd53180c92c454dc9696874a2fad3f0a4d30dcd9a829a55fe4e9fb557b519f33abfec33c8
+  metadata.gz: 5e8136b710134b4f924d1414b0620cd77425e980ca5ec07bf3485b02bcc766b82dfe04c2c2604b883ac9cfe77f58822ac14e6d7fdb1b5cc37553cd2f8d940a59
+  data.tar.gz: 796dd866e6190d45c091fe540fa39760569f92aa968b4a72716a64c130b2836b00cb684c8959fa07e55c5d04c28da21f1d6a395acccb5c77becdf9c86abfeee5

data/lib/eventq/eventq_aws/aws_eventq_client.rb

@@ -15,25 +15,37 @@ module EventQ
         @serialization_manager = EventQ::SerializationProviders::Manager.new
         @signature_manager = EventQ::SignatureProviders::Manager.new
 
-        # this array is used to record known event types
-        @known_event_types = []
-
+        # this hash is used to record known event types:
+        # key = event_type / name
+        # value = topic arn
+        @known_event_types = {}
       end
 
+      # Returns true if the event has already been registerd, or false
+      # otherwise.
+      #
+      # @param [String] event_type
+      # @param [String] region
+      #
+      # @return [Boolean]
       def registered?(event_type, region = nil)
         topic_key = "#{region}:#{event_type}"
-        @known_event_types.include?(topic_key)
+        @known_event_types.key?(topic_key)
       end
 
+      # Registers the event event_type and returns its topic arn.
+      #
+      # @param [String] event_type
+      # @param [String] region
+      #
+      # @return [String]
       def register_event(event_type, region = nil)
-        if registered?(event_type, region)
-          return true
-        end
-
         topic_key = "#{region}:#{event_type}"
-        @client.sns_helper(region).create_topic_arn(event_type, region)
-        @known_event_types << topic_key
-        true
+        return @known_event_types[topic_key] if registered?(event_type, region)
+
+        topic_arn = @client.sns_helper(region).create_topic_arn(event_type, region)
+        @known_event_types[topic_key] = topic_arn
+        topic_arn
       end
 
       def publish(topic:, event:, context: {}, region: nil)

data/lib/eventq/eventq_aws/aws_subscription_manager.rb

@@ -12,7 +12,7 @@ module EventQ
         @manager = options[:queue_manager]
       end
 
-      def subscribe(event_type, queue, topic_region = nil, queue_region = nil)
+      def subscribe(event_type, queue, topic_region = nil, queue_region = nil, topic_namespaces = [EventQ.namespace])
         if queue.isolated
           method = :get_topic_arn
         else
@@ -20,26 +20,30 @@ module EventQ
         end
 
         topic_arn = @client.sns_helper(topic_region).public_send(method, event_type, topic_region)
-        raise Exceptions::EventTypeNotFound, 'SNS topic not found, unable to subscribe' unless topic_arn
+        raise Exceptions::EventTypeNotFound, "SNS topic not found, unable to subscribe to #{event_type}" unless topic_arn
 
-        q = @manager.get_queue(queue)
-        queue_arn = @client.sqs_helper(queue_region).get_queue_arn(queue)
+        queue_arn = configure_queue(queue, queue_region)
 
-        attributes = default_queue_attributes(q, queue_arn)
-        @client.sqs(queue_region).set_queue_attributes(attributes)
+        # subscribe the queue to the topic with the namespaces provided
+        topic_namespaces.each do |namespace|
+          namespaced_topic_arn = topic_arn.gsub(":#{EventQ.namespace}-", ":#{namespace}-")
 
-        # skip subscribe if subscription for given queue/topic already exists
-        # this fixes a localstack issue: https://github.com/localstack/localstack/issues/933
-        return true if existing_subscription?(queue_arn, topic_arn)
+          # create the sns topic - this method is idempotent & returns the topic arn if it already exists
+          @client.sns_helper.create_topic_arn("#{namespace}-#{event_type}".delete('.')) unless queue.isolated
 
-        @client.sns(topic_region).subscribe(
-          topic_arn: topic_arn,
-          protocol: 'sqs',
-          endpoint: queue_arn
-        )
+          # skip subscribe if subscription for given queue/topic already exists
+          # this is a workaround for a localstack issue: https://github.com/localstack/localstack/issues/933
+          return true if existing_subscription?(queue_arn, namespaced_topic_arn)
 
-        EventQ.logger.debug do
-          "[#{self.class} #subscribe] - Subscribing Queue: #{queue.name} to topic_arn: #{topic_arn}, endpoint: #{queue_arn}"
+          EventQ.logger.debug do
+            "[#{self.class} #subscribe] - Subscribing Queue: #{queue.name} to topic_arn: #{namespaced_topic_arn}, endpoint: #{queue_arn}"
+          end
+
+          @client.sns(topic_region).subscribe(
+            topic_arn: namespaced_topic_arn,
+            protocol: 'sqs',
+            endpoint: queue_arn
+          )
         end
 
         true
@@ -51,6 +55,15 @@ module EventQ
 
       private
 
+      def configure_queue(queue, region)
+        q = @manager.get_queue(queue)
+        queue_arn = @client.sqs_helper(region).get_queue_arn(queue)
+
+        attributes = default_queue_attributes(q, queue_arn)
+        @client.sqs(region).set_queue_attributes(attributes)
+        queue_arn
+      end
+
       def default_queue_attributes(queue, queue_arn)
         {
           queue_url: queue,

data/lib/eventq/eventq_aws/sns.rb

@@ -32,6 +32,7 @@ module EventQ
       end
 
       # Check if a TopicArn exists.  This will check with AWS if necessary and cache the results if one is found
+      #
       # @return TopicArn [String]
       def get_topic_arn(event_type, region = nil)
         _event_type = EventQ.create_event_type(event_type)
@@ -39,8 +40,7 @@ module EventQ
 
         arn = @@topic_arns[topic_key]
         unless arn
-          response = sns.list_topics
-          arn = response.topics.detect { |topic| topic.topic_arn.end_with?(":#{_event_type}") }&.topic_arn
+          arn = find_topic(_event_type)
 
           @@topic_arns[topic_key] = arn if arn
         end
@@ -62,6 +62,32 @@ module EventQ
       def aws_safe_name(name)
         return name[0..79].gsub(/[^a-zA-Z\d_\-]/,'')
       end
+
+      private
+
+      # Finds the given topic, or returns nil if the topic could not be found
+      #
+      # @note Responses to list_topics can be paged, so to check *all* topics
+      # we'll need to request each page of topics using response.next_token for
+      # until the response no longer contains a next_token. Requests to
+      # list_topics are throttled to 30 TPS, so in the future we may need to
+      # handle this if it becomes a problem.
+      #
+      # @param topic_name [String] the name of the topic to find
+      # @return [String]
+      def find_topic(topic_name)
+        response = sns.list_topics
+        topics = response.topics
+        arn = topics.detect { |topic| topic.topic_arn.end_with?(":#{topic_name}") }&.topic_arn
+
+        while arn.nil? && response.next_token
+          response = sns.list_topics(next_token: response.next_token)
+          topics = response.topics
+          arn = topics.detect { |topic| topic.topic_arn.end_with?(":#{topic_name}") }&.topic_arn
+        end
+
+        arn
+      end
     end
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: eventq
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 3.0.0
 platform: ruby
 authors:
 - SageOne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-12 00:00:00.000000000 Z
+date: 2020-06-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -25,35 +39,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.11'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,19 +109,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: class_kit
+  name: bunny
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: redlock
+  name: class_kit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +165,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: openssl
+  name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +179,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: concurrent-ruby
+  name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -165,7 +193,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: oj
+  name: openssl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -179,7 +207,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bunny
+  name: redlock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -268,7 +296,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubyforge_project: 
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: EventQ is a pub/sub system that uses async notifications and message queues