rack-graphql 2.6.1 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b053aa44a60a954fb34b510282d975db883c54f3e301778f601cef8cee9f82b
-  data.tar.gz: 9ef8753993d89d6a0ac98864b01dd0a89ad8552765930e7ea933e63a9d60fd92
+  metadata.gz: b0aed325620504c52731b38726309a1633831e5af42af1f2a42b9a85e1c7b662
+  data.tar.gz: df13c1c063bab50027908d4c44f0ecc242fca1bf6d7485e1fadb69a2e9dddbac
 SHA512:
-  metadata.gz: 1745f7f487e8a06447184464f9f2b2d97ac6f35dc4224d0122f4ed1f4c3ac37aec268c016db8d36c10f379e84e94e11d9b54a1d1512db07a20ac3684c355b31b
-  data.tar.gz: 2518a9c2c8842b34f23a4323b9579276a25a45065ffe97e7a155b3344cf00aadd5b7018c70af4ab9370979bda61dfdab4c5c046e933b2cd7f42ea51a90b77c15
+  metadata.gz: a0ca07400a4d7229462f720310d9da3a734c91ca78318bcba122734d8983cae935563488c1e146f19a991d3a1890be740ba6f752fb6ef0babeca791f188bed3b
+  data.tar.gz: 571b478112fd84ae108c78afd17a1e48a7163d8c2c2b582824ec9b2bdb1057aaa934a9a12f9a0dadfa6fe0008a80391e5d210970cc7736bfcfee173b09757ca6

data/.bundler-version

@@ -0,0 +1 @@
+2.2.14

data/.dependabot/config.yml

@@ -3,9 +3,14 @@ version: 1
 update_configs:
   - package_manager: "ruby:bundler"
     directory: "/"
-    update_schedule: "monthly"
+    update_schedule: "daily"
     commit_message:
       prefix: "[dependabot]"
     allowed_updates:
       - match:
-          update_type: "all"
+          dependency_type: "all"
+          update_type: "security"
+    automerged_updates:
+      - match:
+          dependency_type: "all"
+          update_type: "security:patch"

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 2.7.0 - 2021-03-24
+
+- Add ability to skip setting up health endpoint on root path with `health_on_root_path` option.
+
+## 2.6.1 - 2021-01-14
+
+- Fix uninitialized `Timeout` error. The issue was fixed in https://github.com/rmosolgo/graphql-ruby/commit/56abba472dbb48a1f8445d41f928bea72b5148e9, but new version has not yet been relased.
+
 ## 2.6.0 - 2021-01-14
 
 - Add ability to re-raise exception (`re_raise_exceptions` option)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rack-graphql (2.6.1)
+    rack-graphql (2.7.0)
       graphql
       oj
       rack (~> 2.2)
@@ -10,16 +10,16 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    awesome_print (1.8.0)
+    awesome_print (1.9.2)
     coderay (1.1.3)
     diff-lcs (1.4.4)
-    graphql (1.12.0)
+    graphql (1.12.6)
     method_source (1.0.0)
-    oj (3.11.1)
+    oj (3.11.3)
     parallel (1.20.1)
     parser (3.0.0.0)
       ast (~> 2.4.1)
-    pry (0.13.1)
+    pry (0.14.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rack (2.2.3)
@@ -27,7 +27,7 @@ GEM
       rack (>= 1.0, < 3)
     rainbow (3.0.0)
     rake (13.0.3)
-    regexp_parser (2.0.3)
+    regexp_parser (2.1.1)
     rexml (3.2.4)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -38,11 +38,11 @@ GEM
     rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.1)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.1)
-    rubocop (1.8.1)
+    rspec-support (3.10.2)
+    rubocop (1.11.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -55,7 +55,7 @@ GEM
       parser (>= 2.7.1.5)
     rubocop-rake (0.5.1)
       rubocop
-    rubocop-rspec (2.1.0)
+    rubocop-rspec (2.2.0)
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.11.0)
@@ -63,6 +63,7 @@ GEM
 
 PLATFORMS
   x86_64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
   awesome_print
@@ -77,4 +78,4 @@ DEPENDENCIES
   rubocop-rspec
 
 BUNDLED WITH
-   2.2.4
+   2.2.15

data/README.md

@@ -29,6 +29,7 @@ run RackGraphql::Application.call(
   log_exception_backtrace: !A9n.env.production?,    # optional, `false` default
   # `true` when `RACK_GRAPHQL_LOG_EXCEPTION_BACKTRACE` env var is set to `'1'` or `'true'`
   health_route: true,                               # optional, true by default
+  health_on_root_path: health_route,                # optional, health_route value by default (mind map '/' is covering '/any/path-123') 
   logger: A9n.logger,                               # optional, not set by default
   error_status_code_map: { IamTeapotError => 418 }, # optional
   re_raise_exceptions: true,                        # optional, false by default
@@ -87,32 +88,31 @@ RackGraphql.log_exception_backtrace = false
 To respect the graphql spec, all errors need to be returned as json and `rack-graphql` catches all exceptions and does NOT re-raise them. You can change this behavior via `re_raise_exceptions` argument.
 Because of this, using error tracking middleware (`use Sentry::Rack::CaptureExceptions`, `use Raven::Rack`) does not take any effect for graphql requests.
 
-To use Sentry or other reporting tool for graphql queries, you can use `GraphQL::Schema` middleware:
+To use Sentry or other reporting tool for graphql queries, you should handle it on graphql schema level:
 
 ```ruby
-class GraphqlErrorTrackerMiddleware
-  def self.call(parent_type, parent_object, field_definition, field_args, query_context)
-    yield
-  rescue StandardError => e
+class MySchema < GraphQL::Schema
+  rescue_from StandardError do |e, obj, args, ctx, field|
     extra = {
-      parent_type: parent_type.inspect,
-      parent_object: parent_object.inspect,
-      field_definition: field_definition.to_s,
-      field_args: field_args&.to_h,
-      query_context: query_context&.to_h
+      args: args,
+      field: field.inspect,
+      context: ctx
     }
     Sentry.capture_exception(e, extra: extra)
+    # re-raise to be handled by rack middleware
     raise
+    # or return execution error
+    ::GraphQL::ExecutionError.new(
+      exception.class.to_s,
+      options: { "http_status" => 500 },
+      extensions: {
+        "code" => exception.class.to_s,
+        "http_status" => 500,
+        "details" => exception.inspect
+      }
+    )
   end
 end
-
-# MySchema.middleware GraphqlErrorTrackerMiddleware
-# or
-# GraphQL::Schema.middleware GraphqlErrorTrackerMiddleware
-# or
-# class MySchema < GraphQL::Schema
-#   middleware GraphqlErrorTrackerMiddleware
-# end
 ```
 
 ## Contributing

data/lib/rack_graphql/application.rb

@@ -9,6 +9,7 @@ module RackGraphql
       log_exception_backtrace: RackGraphql.log_exception_backtrace,
       health_route: true,
       health_response_builder: RackGraphql::HealthResponseBuilder,
+      health_on_root_path: health_route,
       error_status_code_map: {}
     )
 
@@ -33,7 +34,9 @@ module RackGraphql
           map '/healthz' do
             run ->(env) { health_response_builder.new(app_name: app_name, env: env).build }
           end
+        end
 
+        if health_on_root_path
           map '/' do
             run ->(env) { health_response_builder.new(app_name: app_name, env: env).build }
           end

data/lib/rack_graphql/version.rb

@@ -1,3 +1,3 @@
 module RackGraphql
-  VERSION = '2.6.1'.freeze
+  VERSION = '2.7.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-graphql
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.7.0
 platform: ruby
 authors:
 - Krzysztof Knapik
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-25 00:00:00.000000000 Z
+date: 2021-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -187,6 +187,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".bundler-version"
 - ".dependabot/config.yml"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/config.yml"
@@ -233,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: Rack middleware implementing graphql endpoint.