feat(graphql): add error codes to graphql errors

app/controllers/api/v2/graphql_controller.rb

@@ -5,7 +5,9 @@ class API::V2::GraphqlController < API::V2::BaseController
 
     render json: result
   rescue GraphQL::ParseError, JSON::ParserError => exception
-    handle_parse_error(exception)
+    handle_parse_error(exception, :graphql_parse_failed)
+  rescue ArgumentError => exception
+    handle_parse_error(exception, :bad_request)
   rescue => exception
     if Rails.env.production?
       handle_error_in_production(exception)
@@ -33,7 +35,12 @@ class API::V2::GraphqlController < API::V2::BaseController
   rescue ActionDispatch::Http::Parameters::ParseError => exception
     render json: {
       errors: [
-        { message: exception.cause.message }
+        {
+          message: exception.cause.message,
+          extensions: {
+            code: :bad_request
+          }
+        }
       ],
       data: nil
     }, status: 400
@@ -75,10 +82,13 @@ class API::V2::GraphqlController < API::V2::BaseController
     end
   end
 
-  def handle_parse_error(exception)
+  def handle_parse_error(exception, code)
     render json: {
       errors: [
-        { message: exception.message }
+        {
+          message: exception.message,
+          extensions: { code: }
+        }
       ],
       data: nil
     }, status: 400
@@ -90,22 +100,32 @@ class API::V2::GraphqlController < API::V2::BaseController
 
     render json: {
       errors: [
-        { message: exception.message, backtrace: exception.backtrace }
+        {
+          message: exception.message,
+          extensions: {
+            code: :internal_server_error,
+            backtrace: exception.backtrace
+          }
+        }
       ],
       data: nil
     }, status: 500
   end
 
   def handle_error_in_production(exception)
-    extra = { exception_id: SecureRandom.uuid }
+    exception_id = SecureRandom.uuid
-    Sentry.capture_exception(exception, extra:)
+    Sentry.with_scope do |scope|
+      scope.set_tags(exception_id:)
+      Sentry.capture_exception(exception)
+    end
 
     render json: {
       errors: [
         {
           message: "Internal Server Error",
           extensions: {
-            exception: { id: extra[:exception_id] }
+            code: :internal_server_error,
+            exception_id:
           }
         }
       ],

app/graphql/api/v2/schema.rb

@@ -50,7 +50,7 @@ class API::V2::Schema < GraphQL::Schema
     when GroupeInstructeur
       Types::GroupeInstructeurType
     else
-      raise GraphQL::ExecutionError.new("Unexpected object: #{object}")
+      type_definition
     end
   end
 

app/graphql/api/v2/stored_query.rb

@@ -8,7 +8,7 @@ class API::V2::StoredQuery
     when 'introspection'
       GraphQL::Introspection::INTROSPECTION_QUERY
     else
-      raise GraphQL::ExecutionError.new("No query with id \"#{query_id}\"")
+      raise GraphQL::ExecutionError.new("No query with id \"#{query_id}\"", extensions: { code: :bad_request })
     end
   end
 

app/graphql/types/base_object.rb

@@ -1,5 +1,11 @@
 module Types
   class BaseObject < GraphQL::Schema::Object
     field_class BaseField
+
+    class InvalidNullError < GraphQL::InvalidNullError
+      def to_h
+        super.merge(extensions: { code: :invalid_null })
+      end
+    end
   end
 end

spec/controllers/api/v2/graphql_controller_spec.rb

@@ -684,7 +684,7 @@ describe API::V2::GraphqlController do
           end
 
           it "should return an error" do
-            expect(gql_errors).to eq([{ message: "Cannot return null for non-nullable field PersonneMorale.siegeSocial" }])
+            expect(gql_errors).to eq([{ message: "Cannot return null for non-nullable field PersonneMorale.siegeSocial", extensions: { code: "invalid_null" } }])
           end
         end
       end