rack-graphql 2.1.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89001cf0e27af277a4e74c423e6ebaed600057a5528d9c0b850a76f704690454
-  data.tar.gz: d5250dddf85e2203701d5357f6479001294e64f7d3f28457bc10b55698e0f0c7
+  metadata.gz: 0d1aad090a41b8371934fb35708504a1c08d473aa4991607119fd98485adefbf
+  data.tar.gz: 25902f5ffc962398799a20fe3bdeb4dd7b3dae772d7f5bbcddbd267c8f9eb6d4
 SHA512:
-  metadata.gz: e0975735f7f595af62aeece22cb537e454eef1608b0f012af59e0cc65e14b3015c1db2dd9b7e15402b19bbf1cf564e9982bcd8c79c22681e486d23ae2a96be25
-  data.tar.gz: 508d6a5276bfbc8914c9870e4cfa390455ef687634f7de4fc314f28f2c19feedcf7f78de7a39add4543947a44e08e1b0e2de978a1598ac3e8369e5c921c12140
+  metadata.gz: d5daf847af3b599990248a75664aed30015c88b136bf8a91f530a81716d8739a8dbd3fc272e46bfe36abbc9b1b1f2ad50968e1da64697df23e85adee5183b519
+  data.tar.gz: dd3e2c521fa4112b3c177f29e4a0a53d94036e4aabca5c50b43c79518828ac5140ddd2b94bd41a571aa23ebb7cc45f66af4c1fc1c27df92b8ebbffa8ade55612

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # CHANGELOG
 
+## 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.
+
 ## 2.1.0 - 2020-09-14
 
 - Add `log_exception_backtrace` option to `RackGraphql::Application`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rack-graphql (2.1.0)
+    rack-graphql (2.4.0)
       graphql (~> 1.11)
       oj
       rack (~> 2.2)
@@ -10,13 +10,14 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.1)
+    awesome_print (1.8.0)
     coderay (1.1.3)
     diff-lcs (1.4.4)
-    graphql (1.11.4)
+    graphql (1.11.5)
     method_source (1.0.0)
     oj (3.10.14)
     parallel (1.19.2)
-    parser (2.7.1.4)
+    parser (2.7.1.5)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -26,7 +27,7 @@ GEM
       rack (>= 1.0, < 3)
     rainbow (3.0.0)
     rake (13.0.1)
-    regexp_parser (1.7.1)
+    regexp_parser (1.8.1)
     rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -41,19 +42,20 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (0.90.0)
+    rubocop (0.92.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.7)
       rexml
-      rubocop-ast (>= 0.3.0, < 1.0)
+      rubocop-ast (>= 0.5.0)
       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-ast (0.7.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.8.1)
       rubocop (>= 0.87.0)
+      rubocop-ast (>= 0.4.0)
     rubocop-rspec (1.43.2)
       rubocop (~> 0.87)
     ruby-progressbar (1.10.1)
@@ -63,6 +65,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  awesome_print
   bundler
   pry
   rack-graphql!

data/README.md

@@ -23,12 +23,13 @@ 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, `true` default
+  health_route: true,                              # optional, true by default
+  logger: A9n.logger,                              # optional, not set by default
+  error_status_code_map: { IamTeapotError => 418 }, # optional
 )
 ```
 

data/Rakefile

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

data/lib/rack_graphql/application.rb

@@ -7,12 +7,20 @@ 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
         map '/graphql' do
-          run RackGraphql::Middleware.new(schema: schema, context_handler: context_handler, log_exception_backtrace: log_exception_backtrace, logger: logger)
+          run RackGraphql::Middleware.new(
+            app_name: app_name,
+            schema: schema,
+            context_handler: context_handler,
+            logger: logger,
+            log_exception_backtrace: log_exception_backtrace,
+            error_status_code_map: error_status_code_map,
+          )
         end
 
         if health_route

data/lib/rack_graphql/middleware.rb

@@ -1,10 +1,23 @@
 module RackGraphql
   class Middleware
-    def initialize(schema:, logger: nil, context_handler: 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
-      @logger = logger
+      @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)
@@ -22,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)]
       ]
@@ -44,9 +57,9 @@ 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)])]
+        [Oj.dump('errors' => [exception_hash(e)])]
       ]
     ensure
       ActiveRecord::Base.clear_active_connections! if defined?(ActiveRecord::Base)
@@ -54,7 +67,7 @@ module RackGraphql
 
     private
 
-    attr_reader :schema, :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'
@@ -124,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
@@ -158,8 +178,9 @@ module RackGraphql
 
     def exception_hash(exception)
       {
-        message: "#{exception.class}: #{exception.message}",
-        backtrace: log_exception_backtrace ? exception.backtrace : "[FILTERED]"
+        'app_name' => app_name,
+        'message' => "#{exception.class}: #{exception.message}",
+        'backtrace' => log_exception_backtrace ? exception.backtrace : "[FILTERED]"
       }
     end
   end

data/lib/rack_graphql/version.rb

@@ -1,3 +1,3 @@
 module RackGraphql
-  VERSION = '2.1.0'.freeze
+  VERSION = '2.4.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)}) }
@@ -28,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'oj'
   spec.add_dependency 'rack', '~> 2.2'
 
+  spec.add_development_dependency 'awesome_print'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rack-test'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-graphql
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.4.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-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -53,6 +53,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -202,6 +216,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: