rack-graphql 1.2.0 → 2.0.0.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa676bb1795a98e7072837c677ce6b1dbd2cecf63bbf09ec1da762ac93826f01
-  data.tar.gz: baaeac57d1febfa1b30dee33c589d08ebc9e2258d9d5b4fac87a047e023e023f
+  metadata.gz: 1075eb9d4a87a4e94b555c8b7f60a6a36c8369b2ff0d60a8e7be9db675f47494
+  data.tar.gz: ae1137154106d644ee012734ed0d5d21ac11412fb55a4ba12394bdc26e57b873
 SHA512:
-  metadata.gz: fe96ed09318ad1d487a2437596e5150f28e1a721a7127eeff1bd615898831f1365097b8dce89aa40ed46584eadaff2f5baf31d0ae413230158a7af4ab52380ed
-  data.tar.gz: 3c97c70827c54268518ec6e4552a962e140bd1742f3cc0e20a83900a4b3dc820afdf933ec79a90cd37622c2a8d44ffd6a732dc83115fcadeb339af927c3b324e
+  metadata.gz: 2eeb4e9eed9cf0030651c30d6ef16bb53f14ece2cf2f94c36f162d13d3732fe53e699e64b59d2d807b2d64386453d21627f3f718a50db99e10ab74f1fa2c9c20
+  data.tar.gz: efe2f531123d657e2480a08f4d0b898d9cda4fea50bbe9422faaeb4fc0d4d3ddec13c93c54c4aae5a9792d7bece88652cb35bdeca82bfdbdf315f6c9df724427

data/.dependabot/config.yml

@@ -0,0 +1,11 @@
+version: 1
+
+update_configs:
+  - package_manager: "ruby:bundler"
+    directory: "/"
+    update_schedule: "monthly"
+    commit_message:
+      prefix: "[dependabot]"
+    allowed_updates:
+      - match:
+          update_type: "all"

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to track an issue that has been identified
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Mutation/Query**
+
+**URL and HTTP method (for non-GQL):**
+
+**Sentry or Logs URL:**
+
+**User/authentication details**
+Impacted user name or service account
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

data/.github/ISSUE_TEMPLATE/story.md

@@ -0,0 +1,22 @@
+---
+name: New story
+about: Add a new story for implementation
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the solution**
+A clear and concise description of what you want to happen.
+When will this feature be done?
+
+**Describe the users**
+Who are we building this feature for?
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
+Link to any applicable documents describing the feature.
+
+**Designs**
+Link to any applicable designs on Invision.

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,18 @@
+## Description
+<!--- Describe your changes in detail -->
+
+## Related issue(s)
+<!--- GH issue number -->
+
+## Motivation and Context
+<!--- Why is this change required? What problem does it solve? -->
+<!--- If it fixes an open issue, please link to the issue here. -->
+
+## How Has This Been Tested?
+<!--- Please describe in detail how you tested your changes. -->
+
+## Screenshots (if appropriate):
+<!--- Please add any screenshots of the feature. -->
+
+## Related PRs
+<!--- Please add links to any related PRs (backend, component packages, etc). -->

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

@@ -0,0 +1,16 @@
+# 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 dependency upgrades PRs
+
+on:
+  pull_request
+
+jobs:
+  auto-approve:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: hmarr/auto-approve-action@v2.0.0
+      if: github.actor == 'dependabot[bot]' || github.actor == 'dependabot-preview[bot]' || github.actor == 'renofidev'
+      with:
+        github-token: "${{ secrets.GITHUB_TOKEN }}"

data/.travis.yml

@@ -3,8 +3,9 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.5
   - 2.6
+  - 2.7
 before_install: gem install bundler
 script:
-  - bundle exec rake
+  - bundle exec rake rubocop
+  - bundle exec rake spec

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,56 +1,63 @@
 PATH
   remote: .
   specs:
-    rack-graphql (1.2.0)
-      graphql (>= 1.9.0)
+    rack-graphql (2.0.0.rc)
+      graphql (~> 1.9)
       oj
-      rack (>= 2.0.0)
+      rack (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    coderay (1.1.2)
-    diff-lcs (1.3)
-    graphql (1.9.17)
-    jaro_winkler (1.5.4)
-    method_source (0.9.2)
-    oj (3.10.0)
-    parallel (1.19.1)
-    parser (2.7.0.1)
-      ast (~> 2.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rack (2.0.8)
+    ast (2.4.1)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    graphql (1.11.4)
+    method_source (1.0.0)
+    oj (3.10.14)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rainbow (3.0.0)
     rake (13.0.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    rubocop (0.78.0)
-      jaro_winkler (~> 1.5.1)
+    rspec-support (3.9.3)
+    rubocop (0.90.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.3.0, < 1.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.2)
-      rubocop (>= 0.71.0)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
+    rubocop-performance (1.8.0)
+      rubocop (>= 0.87.0)
+    rubocop-rspec (1.43.2)
+      rubocop (~> 0.87)
     ruby-progressbar (1.10.1)
-    unicode-display_width (1.6.0)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
@@ -64,6 +71,7 @@ DEPENDENCIES
   rspec
   rubocop
   rubocop-performance
+  rubocop-rspec
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

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/Rakefile

@@ -5,4 +5,4 @@ require 'rubocop/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new
 
-task default: %i[rubocop spec]
+task default: %i[rubocop:auto_correct spec]

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

@@ -13,17 +13,40 @@ module RackGraphql
 
       return [400, {}, []] unless params.is_a?(Hash)
 
-      variables      = ensure_hash(params['variables'])
+      variables = ensure_hash(params['variables'])
       operation_name = params['operationName']
-      context        = context_handler.call(env)
+      context = context_handler.call(env)
 
       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
@@ -37,7 +60,7 @@ module RackGraphql
     end
 
     def post_data(env)
-      ::Oj.load(env['rack.input'].gets)
+      ::Oj.load(env['rack.input'].gets.to_s)
     rescue Oj::ParseError
       nil
     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.0'.freeze
+  VERSION = '2.0.0.rc'.freeze
 end

data/rack-graphql.gemspec

@@ -3,14 +3,14 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'rack_graphql/version'
 
 Gem::Specification.new do |spec|
-  spec.name     = 'rack-graphql'
-  spec.version  = RackGraphql::VERSION
-  spec.authors  = ['Krzysztof Knapik', 'RenoFi Engineering Team']
-  spec.email    = ['knapo@knapo.net', 'engineering@renofi.com']
+  spec.name = 'rack-graphql'
+  spec.version = RackGraphql::VERSION
+  spec.authors = ['Krzysztof Knapik', 'RenoFi Engineering Team']
+  spec.email = ['knapo@knapo.net', 'engineering@renofi.com']
 
-  spec.summary  = 'Rack middleware implementing graphql endpoint.'
+  spec.summary = 'Rack middleware implementing graphql endpoint.'
   spec.homepage = 'https://github.com/RenoFi/rack-graphql'
-  spec.license  = 'MIT'
+  spec.license = 'MIT'
 
   spec.metadata['homepage_uri'] = 'https://github.com/RenoFi/rack-graphql'
   spec.metadata['source_code_uri'] = 'https://github.com/RenoFi/rack-graphql'
@@ -18,15 +18,15 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin/|spec/|\.rub)}) }
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.5'
+  spec.required_ruby_version = '>= 2.6'
 
-  spec.add_dependency 'graphql', '>= 1.9.0'
+  spec.add_dependency 'graphql', '~> 1.9'
   spec.add_dependency 'oj'
-  spec.add_dependency 'rack', '>= 2.0.0'
+  spec.add_dependency 'rack', '~> 2.0'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'pry'
@@ -35,4 +35,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rspec'
 end

metadata

@@ -1,30 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: rack-graphql
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0.rc
 platform: ruby
 authors:
 - Krzysztof Knapik
 - RenoFi Engineering Team
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-01-02 00:00:00.000000000 Z
+date: 2020-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: '1.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -43,16 +43,16 @@ dependencies:
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -151,7 +151,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
 email:
 - knapo@knapo.net
 - engineering@renofi.com
@@ -159,9 +173,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".dependabot/config.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/config.yml"
+- ".github/ISSUE_TEMPLATE/story.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/workflows/auto-approve.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -181,7 +202,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/RenoFi/rack-graphql
   source_code_uri: https://github.com/RenoFi/rack-graphql
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -189,15 +210,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      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.0.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Rack middleware implementing graphql endpoint.
 test_files: []