factory_bot_instrumentation 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54a54c125597690d91ed7fd019112d3645cce6dfe056b6ae6246ad57bddc28ef
-  data.tar.gz: 06d728a403143c456beba2da6cf19d10cc4b4271bb9c1e3171cd8e94b2684994
+  metadata.gz: ff6458a1179520c115511b80ad9bdcb335fb652a04c647a12e7515a678440942
+  data.tar.gz: dce3493555ed93a948fea4b4d79b0dbb8c9d1984439706d4b0d1b400a75748fb
 SHA512:
-  metadata.gz: aa3ca826e2d9a6ab252d5e81399946e3f620f8342663fc139362a9f7d19945fb5b12e78512631aac222fda6496cd506bae35142f7704f1d45b3cba319cbe6c52
-  data.tar.gz: e481b8193bb3529e88ee6725e3fbcf6b85058984705b2a378032862d5d3e2dad95e53ad473dfb606e5344f746d59224a223f5d376bf8f71a1bc54ce5f677a217
+  metadata.gz: 24a2ffa2f0c9092222f13826ec2e5232db505fcaddb8df33ae0eed39494ac8a36248f3c3cd39582fc88b6447401dbdd7850a08b6ed045091321f543d67eacc89
+  data.tar.gz: ab32dc405102f93ea3b6dfc409c292600b8bfdac8839bc4cabe949fe8168729d8f8a6b435798c3703bfcd1eba9853870344e2875f9ebef77d1182bea81c71276

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 0.6.0
+
+* Added support for custom error handling and improved the default error
+  handling on FactoryBot usage (#9)
+
 ### 0.5.1
 
 * Corrected a bug on the scenario description update (#8)

data/README.md

@@ -316,6 +316,18 @@ FactoryBot::Instrumentation.configure do |conf|
     controller.render plain: entity.to_json,
                       content_type: 'application/json'
   end
+  # By default we assemble a JSON response on errors which may be
+  # helpful for debugging, but you can configure your own logic here
+  conf.render_error = proc do |controller, error|
+    app_name = FactoryBot::Instrumentation.configuration.application_name
+    controller.render status: :internal_server_error,
+                      content_type: 'application/json',
+                      plain: {
+                        application: app_name,
+                        error: error.message,
+                        backtrace: error.backtrace.join("\n")
+                      }.to_json
+  end
   # By default we do not perform any custom +before_action+ filters on the
   # instrumentation controllers, with this option you can implement your
   # custom logic like authentication

data/app/controllers/factory_bot/instrumentation/root_controller.rb

@@ -43,9 +43,8 @@ module FactoryBot::Instrumentation
       # Render the resulting entity with the configured rendering block
       FactoryBot::Instrumentation.configuration.render_entity.call(self, entity)
     rescue StandardError => err
-      # Log for local factory debugging and re-raise for canary onwards
-      Rails.logger.error("#{err}\n#{err.backtrace.join("\n")}")
-      raise err
+      # Handle any error gracefully with the configured error handler
+      FactoryBot::Instrumentation.configuration.render_error.call(self, err)
     end
 
     private

data/lib/factory_bot/instrumentation/configuration.rb

@@ -25,6 +25,21 @@ module FactoryBot
         end
       end
 
+      # By default we assemble a JSON response on errors which may be
+      # helpful for debugging, but you can configure your own logic here
+      config_accessor(:render_error) do
+        proc do |controller, error|
+          app_name = FactoryBot::Instrumentation.configuration.application_name
+          controller.render status: :internal_server_error,
+                            content_type: 'application/json',
+                            plain: {
+                              application: app_name,
+                              error: error.message,
+                              backtrace: error.backtrace.join("\n")
+                            }.to_json
+        end
+      end
+
       # By default we do not perform any custom +before_action+ filters on the
       # instrumentation controllers, with this option you can implement your
       # custom logic like authentication

data/lib/factory_bot/instrumentation/version.rb

@@ -2,6 +2,6 @@
 
 module FactoryBot
   module Instrumentation
-    VERSION = '0.5.1'.freeze
+    VERSION = '0.6.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factory_bot_instrumentation
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Hermann Mayer
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-12 00:00:00.000000000 Z
+date: 2020-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -188,7 +188,7 @@ files:
 homepage: https://github.com/hausgold/factory_bot_instrumentation
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -203,8 +203,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Allow your testers to generate test data on demand
 test_files: []