rack-graphql 1.2.5 → 2.0.0.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbb7b5de3d2e500fee04bf1820a5c37ffc64ad0a16abfae3055ec1e8aec3b2c3
-  data.tar.gz: 17d62e7a1b6649cdb5abce402401a18ba7ba44b1f12aeee1bcf8263f3e4c05a6
+  metadata.gz: 1075eb9d4a87a4e94b555c8b7f60a6a36c8369b2ff0d60a8e7be9db675f47494
+  data.tar.gz: ae1137154106d644ee012734ed0d5d21ac11412fb55a4ba12394bdc26e57b873
 SHA512:
-  metadata.gz: ec64d07ae37fe8fbefa7060a0602d47d7a45f3f66c0e71100e9c604825271d8b81be2d98fb0efd3aa4b5c68be467d46991cccd4a7061a245843b820aec45e557
-  data.tar.gz: 6bdf228ad21ddc91ff1a1ebc2eb966d797ea274d1e893e695f783a304ad497028b76384a764841bb57e99614cc9f61cbd07a9cd527968e041d875134cc862da2
+  metadata.gz: 2eeb4e9eed9cf0030651c30d6ef16bb53f14ece2cf2f94c36f162d13d3732fe53e699e64b59d2d807b2d64386453d21627f3f718a50db99e10ab74f1fa2c9c20
+  data.tar.gz: efe2f531123d657e2480a08f4d0b898d9cda4fea50bbe9422faaeb4fc0d4d3ddec13c93c54c4aae5a9792d7bece88652cb35bdeca82bfdbdf315f6c9df724427

data/.github/workflows/auto-approve.yml

@@ -1,7 +1,7 @@
-# automatically approve PRs submitted by Dependabot
+# automatically approve PRs submitted by Dependabot or Renofidev
 # this will allow Dependabot to automatically merge dependency update PRs where CI passes
 # from: https://github.com/hmarr/auto-approve-action
-name: Auto approve Dependabot PRs
+name: Auto approve dependency upgrades PRs
 
 on:
   pull_request
@@ -11,6 +11,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: hmarr/auto-approve-action@v2.0.0
-      if: github.actor == 'dependabot[bot]' || github.actor == 'dependabot-preview[bot]'
+      if: github.actor == 'dependabot[bot]' || github.actor == 'dependabot-preview[bot]' || github.actor == 'renofidev'
       with:
         github-token: "${{ secrets.GITHUB_TOKEN }}"

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# CHANGELOG
+
+## 2.0.0.rc - 2020-09-11
+
+- Catch all exceptions raised by the app respond with 500 status codea and json content type
+- Add ability to not log exception backtrace with `RackGraphql.log_exception_backtrace = false`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rack-graphql (1.2.5)
+    rack-graphql (2.0.0.rc)
       graphql (~> 1.9)
       oj
       rack (~> 2.0)
@@ -14,7 +14,7 @@ GEM
     diff-lcs (1.4.4)
     graphql (1.11.4)
     method_source (1.0.0)
-    oj (3.10.13)
+    oj (3.10.14)
     parallel (1.19.2)
     parser (2.7.1.4)
       ast (~> 2.4.1)
@@ -52,8 +52,8 @@ GEM
       unicode-display_width (>= 1.4.0, < 2.0)
     rubocop-ast (0.3.0)
       parser (>= 2.7.1.4)
-    rubocop-performance (1.7.1)
-      rubocop (>= 0.82.0)
+    rubocop-performance (1.8.0)
+      rubocop (>= 0.87.0)
     rubocop-rspec (1.43.2)
       rubocop (~> 0.87)
     ruby-progressbar (1.10.1)

data/README.md

@@ -27,6 +27,7 @@ run RackGraphql::Application.call(
   app_name: 'your-service-name',              # optional, used for health endpoint content
   context_handler: YourGraphqlContextHandler, # optional, empty `proc` by default
   health_route: true,                         # optional, true by default
+  logger: A9n.logger,                         # optional, not set by default
 )
 ```
 
@@ -69,6 +70,14 @@ class GraphqlContextHandler
 end
 ```
 
+### Logging exception backtrace
+
+RackGraphql catches all errors and respond with 500 code. By default it adds exception backtrace to the response body. If you don't want to have the backtrace in the response set:
+
+```
+RackGraphql.log_exception_backtrace = false
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/RenoFi/rack-graphql. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/rack_graphql.rb

@@ -7,3 +7,11 @@ require 'rack_graphql/exceptions'
 require 'rack_graphql/health_response_builder'
 require 'rack_graphql/middleware'
 require 'rack_graphql/application'
+
+module RackGraphql
+  class << self
+    attr_accessor :log_exception_backtrace
+  end
+
+  self.log_exception_backtrace = true
+end

data/lib/rack_graphql/middleware.rb

@@ -20,10 +20,33 @@ module RackGraphql
       log("Executing with params: #{params.inspect}, operationName: #{operation_name}, variables: #{variables.inspect}")
       result = execute(params: params, operation_name: operation_name, variables: variables, context: context)
 
-      [200, response_headers(result), [response_body(result)]]
+      [
+        200,
+        response_headers(result),
+        [response_body(result)]
+      ]
     rescue AmbiguousParamError => e
-      log("Responded with #{e.class} because of #{e.message}")
-      [400, { 'Content-Type' => 'application/json' }, [Oj.dump({})]]
+      exception_string = dump_exception(e)
+      log(exception_string)
+      env[Rack::RACK_ERRORS].puts(exception_string)
+      env[Rack::RACK_ERRORS].flush
+      [
+        400,
+        { 'Content-Type' => 'application/json' },
+        [Oj.dump({})]
+      ]
+    rescue StandardError, LoadError, SyntaxError => e
+      # To respect the graphql spec, all errors need to be returned as json.
+      # It needs to take Rack::ShowExceptions role of catching all exceptions raised by the app.
+      exception_string = dump_exception(e)
+      log(exception_string)
+      env[Rack::RACK_ERRORS].puts(exception_string)
+      env[Rack::RACK_ERRORS].flush
+      [
+        500,
+        { 'Content-Type' => 'application/json' },
+        [Oj.dump(errors: [{ message: exception_string }])]
+      ]
     ensure
       ActiveRecord::Base.clear_active_connections! if defined?(ActiveRecord::Base)
     end
@@ -124,5 +147,12 @@ module RackGraphql
       return unless logger
       logger.debug("[rack-graphql] #{message}")
     end
+
+    # Based on https://github.com/rack/rack/blob/master/lib/rack/show_exceptions.rb
+    def dump_exception(exception)
+      string = "#{exception.class}: #{exception.message}\n"
+      string << exception.backtrace.map { |l| "\t#{l}" }.join("\n") if RackGraphql.log_exception_backtrace
+      string
+    end
   end
 end

data/lib/rack_graphql/version.rb

@@ -1,3 +1,3 @@
 module RackGraphql
-  VERSION = '1.2.5'.freeze
+  VERSION = '2.0.0.rc'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-graphql
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 2.0.0.rc
 platform: ruby
 authors:
 - Krzysztof Knapik
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-02 00:00:00.000000000 Z
+date: 2020-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -182,6 +182,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -212,9 +213,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.2
 signing_key: