summaryrefslogtreecommitdiff
path: root/lib/gitlab/graphql/calls_gitaly/instrumentation.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/gitlab/graphql/calls_gitaly/instrumentation.rb')
-rw-r--r--lib/gitlab/graphql/calls_gitaly/instrumentation.rb40
1 files changed, 40 insertions, 0 deletions
diff --git a/lib/gitlab/graphql/calls_gitaly/instrumentation.rb b/lib/gitlab/graphql/calls_gitaly/instrumentation.rb
new file mode 100644
index 00000000000..fbd5e348c7d
--- /dev/null
+++ b/lib/gitlab/graphql/calls_gitaly/instrumentation.rb
@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Gitlab
+ module Graphql
+ module CallsGitaly
+ class Instrumentation
+ # Check if any `calls_gitaly: true` declarations need to be added
+ # Do nothing if a constant complexity was provided
+ def instrument(_type, field)
+ type_object = field.metadata[:type_class]
+ return field unless type_object.respond_to?(:calls_gitaly?)
+ return field if type_object.constant_complexity? || type_object.calls_gitaly?
+
+ old_resolver_proc = field.resolve_proc
+
+ gitaly_wrapped_resolve = -> (typed_object, args, ctx) do
+ previous_gitaly_call_count = Gitlab::GitalyClient.get_request_count
+ result = old_resolver_proc.call(typed_object, args, ctx)
+ current_gitaly_call_count = Gitlab::GitalyClient.get_request_count
+ calls_gitaly_check(type_object, current_gitaly_call_count - previous_gitaly_call_count)
+ result
+ end
+
+ field.redefine do
+ resolve(gitaly_wrapped_resolve)
+ end
+ end
+
+ def calls_gitaly_check(type_object, calls)
+ return if calls < 1
+
+ # Will inform you if there needs to be `calls_gitaly: true` as a kwarg in the field declaration
+ # if there is at least 1 Gitaly call involved with the field resolution.
+ error = RuntimeError.new("Gitaly is called for field '#{type_object.name}' on #{type_object.owner.try(:name)} - please either specify a constant complexity or add `calls_gitaly: true` to the field declaration")
+ Gitlab::Sentry.track_exception(error)
+ end
+ end
+ end
+ end
+end