tpt-rails 1.6.0 → 1.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 300608f90255d2884190ff472e70781927269af457bf549d57443edc396186ca
-  data.tar.gz: 5dd5a558b911dd7dae7486f0984ddeac4fa8c05d5d3407e5ef269d64fe7a3e4c
+  metadata.gz: 0f941f7fce901677f655f42b56d87869e4dde19545e0547ba27d54ff1875604d
+  data.tar.gz: 79f31a854f4b9baea66dbf5d45e85332426e2061350e66cd3ad770195743e9d8
 SHA512:
-  metadata.gz: 849e1766a9d4a6668516bb1d52d313e375bd823d2723668fb9917c218e79444e71400803cfecdea4f4ec7f8521832fea4c962d36af814b93fe1d4735e228d3c0
-  data.tar.gz: 7865a91a0e8b6553647ee022d84617aad7ef590c5e9fce5f64ea30eeeb25f7dd60ea0f71ea28702cad0f0eed20f02cd588467c657edb4610bd679437e2a63784
+  metadata.gz: d7132817e8d53a875af5d13f74b1b8c8dba725aaac5b8bad18615e15342c4ca5615002226c5d8cb250bc3dd8423da5b019c13013a9f82ca9b3b1afcbf48c6e15
+  data.tar.gz: 4aaf53023b9a035e0a13f65b380c2f9046718667d73f7663c935674c21165e77c2402f2f79c6bb15f7a1c9d5139988b25a84fb8b8bd7396998eada8090bc022c

data/README.md

@@ -68,25 +68,53 @@ See the documentation in [lib/tpt/rails.rb](lib/tpt/rails.rb).
 
 `Tpt::Rails::EventBridgePublisher` is the class used to emit events to EventBridge (in batches). To use:
 
-1. In an initializer, pass in the `Datadog::Statsd` object you're using to the class method ::set_metrics.
-   (Failure to do so will result in an error.) When testing, you can pass in a local Statsd, eg:
+1. Add EventBridge to your gemfile:
 
    ```ruby
-   Tpt::Rails::EventBridgePublisher.set_metrics(
-      Datadog::Statsd.new('localhost', 8125)
-   )
+   gem "aws-sdk-eventbridge", "~> 1.3.0"
    ```
 
-2. By default (#new with no arguments) EventBridgePublisher will try to use the following environment
+2. Instantiate with
+
+   ```ruby
+   Tpt::Rails::EventBridgePublisher.new
+   ```
+
+3. By default (#new with no arguments) EventBridgePublisher will try to use the following environment
    variables: `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `TPT_EVENT_SOURCE`, `TPT_SHARED_EVENT_BUS_NAME`.
 
    Additional configuration can be set as part of the constructor;
-   [see event_bridge_publisher.rb implementation](https://github.com/TeachersPayTeachers/tpt-rails/blob/ad768d3bac0c8bd28e60a48a89aed36f01c4e17b/app/models/tpt/rails/event_bridge_publisher.rb) for more details.
+   [see event_bridge_publisher.rb implementation](https://github.com/TeachersPayTeachers/tpt-rails/blob/master/app/models/tpt/rails/event_bridge_publisher.rb) for more details.
 
-3. Create events by instantiating or inheriting from `Tpt::Rails::ApplicationEvent`. Event types are derived from the text before
+4. Create events by instantiating or inheriting from `Tpt::Rails::ApplicationEvent`. Event types are derived from the text before
    "Event", so ResourceEvent has the event_type "Resource". Pass in an event or an array of events to EventBridgePublisher#publish
    and they will be published immediately. Large arrays will be batched (default 10 per batch).
 
+5. EventBridgePublisher uses Tpt::Rails.statsd as its datadog instance by default. If you want to change that behavior, call `Tpt::Rails::EventBridgePublisher.set_metrics`
+   with the statsd you want to use inside an initializer, as part of a `reloader.to_prepare` call:
+
+   ```ruby
+   Rails.application.reloader.to_prepare do
+     Tpt::Rails::EventBridgePublisher.set_metrics(
+       # your statsd here
+     )
+   end
+   ```
+
+   You can also do this when testing by using the default test publisher (see below).
+
+### EventBridge Testing
+
+1. To create a ready-made test publisher, use
+
+   ```ruby
+   Tpt::Rails::EventBridgeTestHelper.publisher
+   ```
+
+   This method accepts two parameters, batch_size and stub_responses. [See implementation docs](https://github.com/TeachersPayTeachers/tpt-rails/blob/master/app/helpers/tpt/rails/event_bridge_test_helper.rb) for more details.
+
+2. The test publisher overwrites statsd that EventBridgePublisher uses to be a dummy statsd when called.
+
 ### Error reporting (e.g. Bugsnag/Rollbar)
 
 If you configure `rollbar_access_token` & `rollbar_enabled`, or `bugsnag_api_key` then your project

data/app/helpers/tpt/rails/event_bridge_test_helper.rb

@@ -0,0 +1,27 @@
+module Tpt::Rails
+  module EventBridgeTestHelper
+    ###
+    # @description: Instantiates an EventBridgePublisher ready for testing. AWS and DataDog info is faked. Note that this sets the
+    #               metrics object for the class to be a stub. The AWS EventBridge gem will never actually be called as the gem's
+    #               #put_events method is replaced with a stub.
+    # @param {batch_size}: The number of events to send per batch.
+    # @param {stub_responses}: Responses to stub, eg. { put_events: { failed_entry_count: 0, entries: [{ event_id: "1" }, { event_id: "2" }] } }
+    # @return {EventBridgePublisher}: The EventBridgePublisher object.
+    ###
+    def self.publisher(batch_size: 10, stub_responses: {})
+      Tpt::Rails::EventBridgePublisher.set_metrics(
+        Datadog::Statsd.new('localhost', 8125)
+      )
+
+      Tpt::Rails::EventBridgePublisher.new(
+        event_source: ENV.fetch('TPT_EVENT_SOURCE', 'test-source'),
+        batch_size: batch_size,
+        client_options: {
+          access_key_id: '1234',
+          secret_access_key: 'abcd',
+          stub_responses: stub_responses
+        }
+      )
+    end
+  end
+end

data/app/models/tpt/rails/application_event.rb

@@ -12,7 +12,7 @@ module Tpt::Rails
     end
 
     def ==(other)
-      data == other.data
+      @data == other.data
     end
 
     def attributes

data/app/models/tpt/rails/event_bridge_publisher.rb

@@ -1,5 +1,10 @@
 module Tpt::Rails
   class EventBridgePublisher
+    class NoEntriesInResponseData < StandardError; end
+
+    attr_accessor :batch_size
+    attr_reader :client
+
     def initialize(
       event_bus_name: default_event_bus_name,
       event_source: default_event_source,
@@ -26,7 +31,10 @@ module Tpt::Rails
       events
     end
 
-    protected
+    private
+
+    attr_reader :event_bus_name, :event_source
+
     def publish_batch(events)
       metrics.time('tpt.event_bridge.publish_batch') do
         wrapped_events = wrap_events(events)
@@ -43,7 +51,7 @@ module Tpt::Rails
       metrics.increment('tpt.event_bridge.publish_failure', by: events.length, tags: ["error_code:publish_batch_failure"])
 
       # re-reraise the error for users to handle
-      raise e
+      raise
     end
 
     def wrap_events(events)
@@ -59,6 +67,15 @@ module Tpt::Rails
     end
 
     def handle_response(res, events)
+      unless res&.data&.entries
+        logger.error({
+          msg:      "No entries in the response data",
+          response: res,
+          events:   events,
+        })
+        raise NoEntriesInResponseData, "No entries in the response data"
+      end
+
       res.data.entries.each_with_index do |entry, index|
         if entry.error_code.present?
           metrics.increment('tpt.event_bridge.publish_failure', tags: ["error_code:#{entry.error_code}"])
@@ -77,17 +94,13 @@ module Tpt::Rails
       res.data.entries
     end
 
-    private
-
-    attr_reader :client, :event_bus_name, :event_source
-
     def make_client(options)
       all_options = {
-        access_key_id: ENV.fetch('AWS_ACCESS_KEY_ID'),
-        secret_access_key: ENV.fetch('AWS_SECRET_ACCESS_KEY'),
+        access_key_id: ENV.fetch('AWS_ACCESS_KEY_ID', nil),
+        secret_access_key: ENV.fetch('AWS_SECRET_ACCESS_KEY', nil),
         region: ENV.fetch('AWS_REGION', 'us-east-1'),
-        http_open_timeout: 1, # default is 15
-        http_read_timeout: 1, # default is 60
+        http_open_timeout: 3,  # default is 15
+        http_read_timeout: 15, # default is 60
       }.merge(options)
 
       Aws::EventBridge::Client.new(all_options)
@@ -125,8 +138,9 @@ module Tpt::Rails
     end
 
     def metrics
-      raise "metrics object not set; use EventBridgePublisher#set_metrics" unless @@statsd
+      @@statsd ||= Tpt::Rails.statsd
 
+      raise "metrics object not set and no default found; use EventBridgePublisher#set_metrics" unless @@statsd
       @@statsd
     end
   end

data/lib/tpt/rails/version.rb

@@ -1,6 +1,6 @@
 module Tpt
   module Rails
     # Do not change this manually. Our tooling will do it automatically.
-    VERSION = '1.6.0'
+    VERSION = '1.6.4'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tpt-rails
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.4
 platform: ruby
 authors:
 - TpT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-20 00:00:00.000000000 Z
+date: 2022-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -114,6 +114,7 @@ files:
 - app/controllers/tpt/rails/error_tests_controller.rb
 - app/controllers/tpt/rails/health_checks_controller.rb
 - app/helpers/tpt/rails/application_helper.rb
+- app/helpers/tpt/rails/event_bridge_test_helper.rb
 - app/jobs/tpt/rails/application_job.rb
 - app/mailers/tpt/rails/application_mailer.rb
 - app/models/tpt/rails/application_event.rb