rack-graphql 2.2.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6598f80d99758463e5b906b46793eb99e00a4289d575e4a9947049a1a365cad2
-  data.tar.gz: d255f35c7dae31102576f2c20024b3627c5cfe47f41f6c84e91d2d284c297ea9
+  metadata.gz: dc3ae3d43695a7a533d43610adbc28395dcba6b2c53e7c1811402c98599c74bc
+  data.tar.gz: d0fa5477c6fc8006337dd5653f13fb9b486d79e019b24fd58956dc24867d4d71
 SHA512:
-  metadata.gz: ccfe829dc5cb515d817d670ed2f41a414c089cbd959f24c71db11f3ff2aeaa00b365ef2e3db429921db80bf872ed36c3e27fd0915b9645281eb2c383138f79ca
-  data.tar.gz: f10803e7f9fc3db00ba5b6fdbce23b7d52d023d5e8aeafb8201fa1880c5f25f9517fea2ab452ff82b0889a070316f9c8892022d935e95c1ba14d58d2b0cb5472
+  metadata.gz: cb4510a840bcc8450fb96ce824118fe9908bec545da22222484f32f1ca061b68a502c9fb30a5041f05e521c16dbd7c4f2241dec2ccb6e649c727b7c3ebf1ac36
+  data.tar.gz: f423c41a32de086c507006b5b2bea6c557931ce329505b25649dc09a93b6d2c1695c052f553f0fd699c53a2f9a16e6c863b2c5b0af62af6a304e114f0944d626

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

@@ -0,0 +1,19 @@
+name: automerge
+on:
+  pull_request_review:
+    types:
+      - submitted
+  check_suite:
+    types:
+      - completed
+  status: {}
+jobs:
+  automerge:
+    runs-on: ubuntu-latest
+    steps:
+      - name: automerge
+        uses: "pascalgn/automerge-action@v0.11.0"
+        env:
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+          MERGE_METHOD: squash
+          MERGE_DELETE_BRANCH: true

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # CHANGELOG
 
+## 2.5.0 - 2020-11-18
+
+- make `log_exception_backtrace` false by default and allow to be controlled by `RACK_GRAPHQL_LOG_EXCEPTION_BACKTRACE` env var
+
+## 2.4.0 - 2020-09-39
+
+- Use `http_status` from `ExecutionError` for http response
+
+## 2.3.0 - 2020-09-39
+
+- Add `error_status_code_map` option to `RackGraphql::Application`.
+
+  `error_status_code_map` allows for return custom http code when specific errors are raised.
+
+## 2.2.1 - 2020-09-14
+
+- Rename `source_app` to `app_name` in error payload.
+
 ## 2.2.0 - 2020-09-14
 
 - Add `source_app` to error payload.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rack-graphql (2.2.0)
+    rack-graphql (2.5.0)
       graphql (~> 1.11)
       oj
       rack (~> 2.2)
@@ -13,11 +13,11 @@ GEM
     awesome_print (1.8.0)
     coderay (1.1.3)
     diff-lcs (1.4.4)
-    graphql (1.11.4)
+    graphql (1.11.6)
     method_source (1.0.0)
-    oj (3.10.14)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    oj (3.10.16)
+    parallel (1.20.0)
+    parser (2.7.2.0)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -27,36 +27,38 @@ GEM
       rack (>= 1.0, < 3)
     rainbow (3.0.0)
     rake (13.0.1)
-    regexp_parser (1.7.1)
+    regexp_parser (1.8.2)
     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.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.90.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.3.1)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8)
       rexml
-      rubocop-ast (>= 0.3.0, < 1.0)
+      rubocop-ast (>= 1.1.1)
       ruby-progressbar (~> 1.7)
       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)
+    rubocop-ast (1.1.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.9.0)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.0.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.10.1)
     unicode-display_width (1.7.0)
 

data/README.md

@@ -23,12 +23,14 @@ Add following to your `config.ru` file:
 
 ```ruby
 run RackGraphql::Application.call(
-  schema: YourGraqphqlSchema,                    # required
-  app_name: 'your-service-name',                 # optional, used for health endpoint content
-  context_handler: YourGraphqlContextHandler,    # optional, empty `proc` by default
-  log_exception_backtrace: !A9n.env.production?, # optional, `true` default
-  health_route: true,                             # optional, true by default
-  logger: A9n.logger,                            # optional, not set by default
+  schema: YourGraqphqlSchema,                      # required
+  app_name: 'your-service-name',                   # optional, used for health endpoint content
+  context_handler: YourGraphqlContextHandler,      # optional, empty `proc` by default
+  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
+  logger: A9n.logger,                              # optional, not set by default
+  error_status_code_map: { IamTeapotError => 418 }, # optional
 )
 ```
 

data/lib/rack_graphql.rb

@@ -10,8 +10,12 @@ require 'rack_graphql/application'
 
 module RackGraphql
   class << self
-    attr_accessor :log_exception_backtrace
-  end
+    def log_exception_backtrace
+      return @log_exception_backtrace unless @log_exception_backtrace.nil?
+
+      %w[1 true].include?(ENV['RACK_GRAPHQL_LOG_EXCEPTION_BACKTRACE'].to_s)
+    end
 
-  self.log_exception_backtrace = true
+    attr_writer :log_exception_backtrace
+  end
 end

data/lib/rack_graphql/application.rb

@@ -7,7 +7,8 @@ module RackGraphql
       context_handler: nil,
       log_exception_backtrace: RackGraphql.log_exception_backtrace,
       health_route: true,
-      health_response_builder: RackGraphql::HealthResponseBuilder
+      health_response_builder: RackGraphql::HealthResponseBuilder,
+      error_status_code_map: {}
     )
 
       ::Rack::Builder.new do
@@ -18,6 +19,7 @@ module RackGraphql
             context_handler: context_handler,
             logger: logger,
             log_exception_backtrace: log_exception_backtrace,
+            error_status_code_map: error_status_code_map,
           )
         end
 

data/lib/rack_graphql/middleware.rb

@@ -1,11 +1,23 @@
 module RackGraphql
   class Middleware
-    def initialize(schema:, app_name: nil, context_handler: nil, logger: nil, log_exception_backtrace: RackGraphql.log_exception_backtrace)
+    DEFAULT_STATUS_CODE = 200
+    DEFAULT_ERROR_STATUS_CODE = 500
+
+    def initialize(
+      schema:,
+      app_name: nil,
+      context_handler: nil,
+      logger: nil,
+      log_exception_backtrace: RackGraphql.log_exception_backtrace,
+      error_status_code_map: {}
+    )
+
       @schema = schema
       @app_name = app_name
       @context_handler = context_handler || ->(_) {}
       @logger = logger
       @log_exception_backtrace = log_exception_backtrace
+      @error_status_code_map = error_status_code_map
     end
 
     def call(env)
@@ -23,7 +35,7 @@ module RackGraphql
       result = execute(params: params, operation_name: operation_name, variables: variables, context: context)
 
       [
-        200,
+        response_status(result),
         response_headers(result),
         [response_body(result)]
       ]
@@ -45,7 +57,7 @@ module RackGraphql
       env[Rack::RACK_ERRORS].puts(exception_string)
       env[Rack::RACK_ERRORS].flush
       [
-        500,
+        error_status_code_map[e.class] || DEFAULT_ERROR_STATUS_CODE,
         { 'Content-Type' => 'application/json' },
         [Oj.dump('errors' => [exception_hash(e)])]
       ]
@@ -55,7 +67,7 @@ module RackGraphql
 
     private
 
-    attr_reader :schema, :app_name, :logger, :context_handler, :log_exception_backtrace
+    attr_reader :schema, :app_name, :logger, :context_handler, :log_exception_backtrace, :error_status_code_map
 
     def post_request?(env)
       env['REQUEST_METHOD'] == 'POST'
@@ -125,6 +137,13 @@ module RackGraphql
       end
     end
 
+    def response_status(result)
+      return DEFAULT_STATUS_CODE if result.is_a?(Array)
+
+      errors = result.to_h["errors"] || []
+      errors.map { |e| e["http_status"] }.compact.first || DEFAULT_STATUS_CODE
+    end
+
     def response_body(result = nil)
       if result_subscription?(result)
         body = result.to_h
@@ -159,7 +178,7 @@ module RackGraphql
 
     def exception_hash(exception)
       {
-        'source_app' => app_name,
+        'app_name' => app_name,
         'message' => "#{exception.class}: #{exception.message}",
         'backtrace' => log_exception_backtrace ? exception.backtrace : "[FILTERED]"
       }

data/lib/rack_graphql/version.rb

@@ -1,3 +1,3 @@
 module RackGraphql
-  VERSION = '2.2.0'.freeze
+  VERSION = '2.5.0'.freeze
 end

data/rack-graphql.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = 'https://github.com/RenoFi/rack-graphql'
   spec.metadata['source_code_uri'] = 'https://github.com/RenoFi/rack-graphql'
+  spec.metadata['changelog_uri'] = 'https://github.com/RenoFi/rack-graphql/blob/master/CHANGELOG.md'
 
   spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin/|spec/|\.rub)}) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-graphql
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Krzysztof Knapik
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-14 00:00:00.000000000 Z
+date: 2020-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -193,6 +193,7 @@ files:
 - ".github/ISSUE_TEMPLATE/story.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/workflows/auto-approve.yml"
+- ".github/workflows/auto-merge.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -216,6 +217,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/RenoFi/rack-graphql
   source_code_uri: https://github.com/RenoFi/rack-graphql
+  changelog_uri: https://github.com/RenoFi/rack-graphql/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -231,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Rack middleware implementing graphql endpoint.