graphql 2.5.11 → 2.5.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c2ef756861a779063236ee9f8745d30ae3494138674239c8f638556d7f5105e
-  data.tar.gz: 23592e61f76acb0be2a4c60d953a829e8f1d46534633513ac44797a5d3386d2a
+  metadata.gz: 724e526bb33dee5a8b39cb04b4d42f2e969e45aafe73581c5bdd02177cfa1347
+  data.tar.gz: f211ca87d49c5077b0ae4744ce5956795835a6405a07e8782970cde14d172d7e
 SHA512:
-  metadata.gz: 5c8db1d976343d569aa1fec1cee02de2c72947e0937fcd9917f8f6e078204efd373d244954e9e03b8dc7fd20066dcf7533bf4b52c706dba0f5640b60ae0465f0
-  data.tar.gz: 38422c543b159cc7243ac4dcc9139ed95b2583cab7942c60e4c557b89d6a4ffaa8fb1df94286fa3fbe4b918f5c116364d5fbe5c2afa611ba9d46d7ac56c18e61
+  metadata.gz: 5d9c249f5d7bbe3ef06070cf52b04586eedf2df06f7c1fc95c6ab47bdc8182218fff2281d76a3f2a18bef4f1ad9c508901e6c7a3f882d28390afdd2f4dca6fd0
+  data.tar.gz: 5179a34bc5c34769021fab1dff6384c22f73f776dc994a82f9bce635ddf6ead05ec0a3d2ff37bfcedbc892d87d2d7a82b08eab4e4cf319ee390e2c5a34db76fa

data/lib/generators/graphql/detailed_trace_generator.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+require 'rails/generators/active_record'
+
+module Graphql
+  module Generators
+    class DetailedTraceGenerator < ::Rails::Generators::Base
+      include ::Rails::Generators::Migration
+      desc "Install GraphQL::Tracing::DetailedTrace for your schema"
+      source_root File.expand_path('../templates', __FILE__)
+
+      class_option :redis,
+        type: :boolean,
+        default: false,
+        desc: "Use Redis for persistence instead of ActiveRecord"
+
+      def self.next_migration_number(dirname)
+        ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+
+      def install_detailed_traces
+
+        schema_glob = File.expand_path("app/graphql/*_schema.rb", destination_root)
+        schema_file = Dir.glob(schema_glob).first
+        if !schema_file
+          raise ArgumentError, "Failed to find schema definition file (checked: #{schema_glob.inspect})"
+        end
+        schema_file_match = /( *)class ([A-Za-z:]+) < GraphQL::Schema/.match(File.read(schema_file))
+        schema_name = schema_file_match[2]
+        indent = schema_file_match[1] + "  "
+
+        if !options.redis?
+          migration_template 'create_graphql_detailed_traces.erb', 'db/migrate/create_graphql_detailed_traces.rb'
+        end
+
+        log :add_detailed_traces_plugin
+        sentinel = /< GraphQL::Schema\s*\n/m
+        code = <<-RUBY
+#{indent}use GraphQL::Tracing::DetailedTrace#{options.redis? ? ", redis: raise(\"TODO: pass a connection to a persistent redis database\")" : ""}, limit: 50
+
+#{indent}# When this returns true, DetailedTrace will trace the query
+#{indent}# Could use `query.context`, `query.selected_operation_name`, `query.query_string` here
+#{indent}# Could call out to Flipper, etc
+#{indent}def self.detailed_trace?(query)
+#{indent}  rand <= 0.000_1 # one in ten thousand
+#{indent}end
+
+        RUBY
+
+        in_root do
+          inject_into_file schema_file, code, after: sentinel, force: false
+        end
+
+        routes_source = File.read(File.expand_path("config/routes.rb", destination_root))
+        already_has_dashboard = routes_source.include?("GraphQL::Dashboard") ||
+          routes_source.include?("Schema.dashboard") ||
+          routes_source.include?("GraphQL::Pro::Routes::Lazy")
+
+        if (!already_has_dashboard || behavior == :revoke)
+          log :route, "GraphQL::Dashboard"
+          shell.mute do
+            route <<~RUBY
+            # TODO: add authorization to this route and expose it in production
+            # See https://graphql-ruby.org/pro/dashboard.html#authorizing-the-dashboard
+            if Rails.env.development?
+              mount GraphQL::Dashboard, at: "/graphql/dashboard", schema: #{schema_name.inspect}
+            end
+
+            RUBY
+          end
+
+          gem("google-protobuf")
+
+        end
+      end
+    end
+  end
+end

data/lib/generators/graphql/templates/create_graphql_detailed_traces.erb

@@ -0,0 +1,10 @@
+class CreateGraphqlDetailedTraces < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :graphql_detailed_traces, force: true do |t|
+      t.bigint :begin_ms, null: false
+      t.float :duration_ms, null: false
+      t.binary :trace_data, null: false
+      t.string :operation_name, null: false
+    end
+  end
+end

data/lib/graphql/dashboard/application_controller.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+require "action_controller"
+
+module Graphql
+  class Dashboard < Rails::Engine
+    class ApplicationController < ActionController::Base
+      protect_from_forgery with: :exception
+      prepend_view_path(File.expand_path("../views", __FILE__))
+
+      content_security_policy do |policy|
+        policy.default_src(:self) if policy.default_src(*policy.default_src).blank?
+        policy.connect_src(:self) if policy.connect_src(*policy.connect_src).blank?
+        policy.base_uri(:none) if policy.base_uri(*policy.base_uri).blank?
+        policy.font_src(:self) if policy.font_src(*policy.font_src).blank?
+        policy.img_src(:self, :data) if policy.img_src(*policy.img_src).blank?
+        policy.object_src(:none) if policy.object_src(*policy.object_src).blank?
+        policy.script_src(:self) if policy.script_src(*policy.script_src).blank?
+        policy.style_src(:self) if policy.style_src(*policy.style_src).blank?
+        policy.form_action(:self) if policy.form_action(*policy.form_action).blank?
+        policy.frame_ancestors(:none) if policy.frame_ancestors(*policy.frame_ancestors).blank?
+      end
+
+      def schema_class
+        @schema_class ||= begin
+          schema_param = request.query_parameters["schema"] || params[:schema]
+          case schema_param
+          when Class
+            schema_param
+          when String
+            schema_param.constantize
+          else
+            raise "Missing `params[:schema]`, please provide a class or string to `mount GraphQL::Dashboard, schema: ...`"
+          end
+        end
+      end
+      helper_method :schema_class
+    end
+  end
+end
+
+ActiveSupport.run_load_hooks(:graphql_dashboard_application_controller, GraphQL::Dashboard::ApplicationController)

data/lib/graphql/dashboard/landings_controller.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+module Graphql
+  class Dashboard < Rails::Engine
+    class LandingsController < ApplicationController
+      def show
+      end
+    end
+  end
+end

data/lib/graphql/dashboard/statics_controller.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+module Graphql
+  class Dashboard < Rails::Engine
+    class StaticsController < ApplicationController
+      skip_forgery_protection
+      # Use an explicit list of files to avoid any chance of reading other files from disk
+      STATICS = {}
+
+      [
+        "icon.png",
+        "header-icon.png",
+        "charts.min.css",
+        "dashboard.css",
+        "dashboard.js",
+        "bootstrap-5.3.3.min.css",
+        "bootstrap-5.3.3.min.js",
+      ].each do |static_file|
+        STATICS[static_file] = File.expand_path("../statics/#{static_file}", __FILE__)
+      end
+
+      def show
+        expires_in 1.year, public: true
+        if (filepath = STATICS[params[:id]])
+          render file: filepath
+        else
+          head :not_found
+        end
+      end
+    end
+  end
+end

data/lib/graphql/dashboard/subscriptions.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require_relative "./installable"
 module Graphql
   class Dashboard < Rails::Engine
     module Subscriptions
@@ -6,7 +7,7 @@ module Graphql
         include Installable
 
         def feature_installed?
-          schema_class.subscriptions.is_a?(GraphQL::Pro::Subscriptions)
+          defined?(GraphQL::Pro::Subscriptions) && schema_class.subscriptions.is_a?(GraphQL::Pro::Subscriptions)
         end
 
         INSTALLABLE_COMPONENT_HEADER_HTML = "GraphQL-Pro Subscriptions aren't installed on this schema yet.".html_safe

data/lib/graphql/dashboard/views/graphql/dashboard/operation_store/clients/_form.html.erb

@@ -20,4 +20,5 @@
     <div class="col-auto">
       <%= link_to "Back", graphql_dashboard.operation_store_clients_path, class: "btn btn-outline-secondary" %>
     </div>
+  </div>
 <% end %>

data/lib/graphql/dashboard/views/graphql/dashboard/operation_store/clients/edit.html.erb

@@ -3,10 +3,10 @@
   <div class="col">
     <h1>Edit <%= @client.name %></h1>
   </div>
-<div>
+</div>
 <%= render partial: "graphql/dashboard/operation_store/clients/form" %>
 
-<hr class="mt-5"/>
+<hr class="mt-5">
 <div class="row mt-5">
   <div class="col">
     <div class="alert alert-danger">

data/lib/graphql/dashboard/views/graphql/dashboard/operation_store/clients/index.html.erb

@@ -33,7 +33,7 @@
           <td><%= link_to(client.name, graphql_dashboard.edit_operation_store_client_path(name: client.name)) %></td>
           <td>
             <%= link_to(graphql_dashboard.operation_store_client_operations_path(client_name: client.name)) do %>
-              <%= client.operations_count %><% if client.archived_operations_count > 0 %> <span class="muted">(<%=client.archived_operations_count%> archived)</span><% end %>
+              <%= client.operations_count %><% if client.archived_operations_count > 0 %> <span class="muted">(<%= client.archived_operations_count %> archived)</span><% end %>
             <% end %>
           </td>
           <td><%= client.created_at %></td>

data/lib/graphql/dashboard/views/graphql/dashboard/operation_store/clients/new.html.erb

@@ -3,5 +3,5 @@
   <div class="col">
     <h1>New Client</h1>
   </div>
-<div>
+</div>
 <%= render partial: "graphql/dashboard/operation_store/clients/form" %>

data/lib/graphql/dashboard/views/graphql/dashboard/operation_store/index_entries/index.html.erb

@@ -10,7 +10,7 @@
     <form method="GET" action="<%= graphql_dashboard.operation_store_index_entries_path %>" style="margin-left: auto; margin-top:-5px;">
       <div class="input-group">
         <%= text_field_tag "q", @search_term, class: "form-control", placeholder: "Find types, fields, arguments, or enum values" %>
-        <input type="submit" value="Search" class="btn btn-outline-primary btn-sm"/>
+        <input type="submit" value="Search" class="btn btn-outline-primary btn-sm">
       </div>
     </form>
   </div>

data/lib/graphql/dashboard/views/graphql/dashboard/operation_store/operations/show.html.erb

@@ -2,7 +2,7 @@
 <% if @operation.nil? %>
   <div class="row">
     <div class="col">
-      <p>No stored operation found for <code><%= params[:digest] %></code>
+      <p>No stored operation found for <code><%= params[:digest] %></code></p>
     </div>
   </div>
 <% else %>

data/lib/graphql/dashboard/views/graphql/dashboard/subscriptions/topics/show.html.erb

@@ -9,7 +9,7 @@
   <div class="col">
     <p>Last triggered: <%= @topic_last_triggered_at || "none" %></p>
     <p><%= pluralize(@subscriptions_count, "Subscription") %></p>
-  <div>
+  </div>
 </div>
 
 <div class="row">

data/lib/graphql/dashboard/views/layouts/graphql/dashboard/application.html.erb

@@ -1,15 +1,15 @@
 <!doctype html>
 <html lang="en" class="h-100" >
   <head>
-    <link rel="icon" type="image/png" href="<%= graphql_dashboard.static_path("icon.png") %>" />
+    <link rel="icon" type="image/png" href="<%= graphql_dashboard.static_path("icon.png") %>">
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <title>GraphQL Dashboard <%= content_for?(:title) ? " · #{content_for(:title)}" : "" %> </title>
-    <%= stylesheet_link_tag graphql_dashboard.static_path("bootstrap-5.3.3.min.css") %>
-    <%= stylesheet_link_tag graphql_dashboard.static_path("charts.min.css") %>
-    <%= stylesheet_link_tag graphql_dashboard.static_path("dashboard.css") %>
-    <%= javascript_include_tag graphql_dashboard.static_path("bootstrap-5.3.3.min.js") %>
-    <%= javascript_include_tag graphql_dashboard.static_path("dashboard.js") %>
+    <link rel="stylesheet" href="<%= graphql_dashboard.static_path("bootstrap-5.3.3.min.css") %>" media="screen">
+    <link rel="stylesheet" href="<%= graphql_dashboard.static_path("charts.min.css") %>" media="screen">
+    <link rel="stylesheet" href="<%= graphql_dashboard.static_path("dashboard.css") %>" media="screen">
+    <script src="<%= graphql_dashboard.static_path("bootstrap-5.3.3.min.js") %>"></script>
+    <script src="<%= graphql_dashboard.static_path("dashboard.js") %>"></script>
     <%= csrf_meta_tags %>
   </head>
   <body class="h-100 d-flex flex-column">
@@ -20,7 +20,7 @@
             <nav class="navbar navbar-expand-lg bg-body-tertiary">
               <div class="container-fluid">
                 <%= link_to graphql_dashboard.root_path, class: "navbar-brand" do %>
-                  <img id="header-icon" src="<%= graphql_dashboard.static_path("header-icon.png") %>" alt="GraphQL-Ruby" />
+                  <img id="header-icon" src="<%= graphql_dashboard.static_path("header-icon.png") %>" alt="GraphQL-Ruby">
                 <% end %>
                 <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
                   <span class="navbar-toggler-icon"></span>

data/lib/graphql/dashboard.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require 'rails/engine'
+require 'action_controller'
 module Graphql
   # `GraphQL::Dashboard` is a `Rails::Engine`-based dashboard for viewing metadata about your GraphQL schema.
   #
@@ -34,7 +35,16 @@ module Graphql
   class Dashboard < Rails::Engine
     engine_name "graphql_dashboard"
     isolate_namespace(Graphql::Dashboard)
-    routes.draw do
+
+    autoload :ApplicationController, "graphql/dashboard/application_controller"
+    autoload :LandingsController, "graphql/dashboard/landings_controller"
+    autoload :StaticsController, "graphql/dashboard/statics_controller"
+    autoload :DetailedTraces, "graphql/dashboard/detailed_traces"
+    autoload :Subscriptions, "graphql/dashboard/subscriptions"
+    autoload :OperationStore, "graphql/dashboard/operation_store"
+    autoload :Limiters, "graphql/dashboard/limiters"
+
+    routes do
       root "landings#show"
       resources :statics, only: :show, constraints: { id: /[0-9A-Za-z\-.]+/ }
 
@@ -77,82 +87,10 @@ module Graphql
         post "/subscriptions/clear_all", to: "subscriptions#clear_all", as: :clear_all
       end
     end
-
-    class ApplicationController < ActionController::Base
-      protect_from_forgery with: :exception
-      prepend_view_path(File.join(__FILE__, "../dashboard/views"))
-
-      content_security_policy do |policy|
-        policy.default_src(:self) if policy.default_src(*policy.default_src).blank?
-        policy.connect_src(:self) if policy.connect_src(*policy.connect_src).blank?
-        policy.base_uri(:none) if policy.base_uri(*policy.base_uri).blank?
-        policy.font_src(:self) if policy.font_src(*policy.font_src).blank?
-        policy.img_src(:self, :data) if policy.img_src(*policy.img_src).blank?
-        policy.object_src(:none) if policy.object_src(*policy.object_src).blank?
-        policy.script_src(:self) if policy.script_src(*policy.script_src).blank?
-        policy.style_src(:self) if policy.style_src(*policy.style_src).blank?
-        policy.form_action(:self) if policy.form_action(*policy.form_action).blank?
-        policy.frame_ancestors(:none) if policy.frame_ancestors(*policy.frame_ancestors).blank?
-      end
-
-      def schema_class
-        @schema_class ||= begin
-          schema_param = request.query_parameters["schema"] || params[:schema]
-          case schema_param
-          when Class
-            schema_param
-          when String
-            schema_param.constantize
-          else
-            raise "Missing `params[:schema]`, please provide a class or string to `mount GraphQL::Dashboard, schema: ...`"
-          end
-        end
-      end
-      helper_method :schema_class
-    end
-
-    class LandingsController < ApplicationController
-      def show
-      end
-    end
-
-    class StaticsController < ApplicationController
-      skip_after_action :verify_same_origin_request
-      # Use an explicit list of files to avoid any chance of reading other files from disk
-      STATICS = {}
-
-      [
-        "icon.png",
-        "header-icon.png",
-        "charts.min.css",
-        "dashboard.css",
-        "dashboard.js",
-        "bootstrap-5.3.3.min.css",
-        "bootstrap-5.3.3.min.js",
-      ].each do |static_file|
-        STATICS[static_file] = File.expand_path("../dashboard/statics/#{static_file}", __FILE__)
-      end
-
-      def show
-        expires_in 1.year, public: true
-        if (filepath = STATICS[params[:id]])
-          render file: filepath
-        else
-          head :not_found
-        end
-      end
-    end
   end
 end
 
-require 'graphql/dashboard/detailed_traces'
-require 'graphql/dashboard/limiters'
-require 'graphql/dashboard/operation_store'
-require 'graphql/dashboard/subscriptions'
-
 # Rails expects the engine to be called `Graphql::Dashboard`,
 # but `GraphQL::Dashboard` is consistent with this gem's naming.
 # So define both constants to refer to the same class.
 GraphQL::Dashboard = Graphql::Dashboard
-
-ActiveSupport.run_load_hooks(:graphql_dashboard_application_controller, GraphQL::Dashboard::ApplicationController)

data/lib/graphql/dataloader/async_dataloader.rb

@@ -14,7 +14,7 @@ module GraphQL
         nil
       end
 
-      def run
+      def run(trace_query_lazy: nil)
         trace = Fiber[:__graphql_current_multiplex]&.current_trace
         jobs_fiber_limit, total_fiber_limit = calculate_fiber_limit
         job_fibers = []
@@ -29,16 +29,7 @@ module GraphQL
             first_pass = false
             fiber_vars = get_fiber_variables
 
-            while (f = (job_fibers.shift || (((job_fibers.size + next_job_fibers.size + source_tasks.size) < jobs_fiber_limit) && spawn_job_fiber(trace))))
-              if f.alive?
-                finished = run_fiber(f)
-                if !finished
-                  next_job_fibers << f
-                end
-              end
-            end
-            job_fibers.concat(next_job_fibers)
-            next_job_fibers.clear
+            run_pending_steps(job_fibers, next_job_fibers, source_tasks, jobs_fiber_limit, trace)
 
             Sync do |root_task|
               set_fiber_variables(fiber_vars)
@@ -54,6 +45,13 @@ module GraphQL
                 next_source_tasks.clear
               end
             end
+
+            if !@lazies_at_depth.empty?
+              with_trace_query_lazy(trace_query_lazy) do
+                run_next_pending_lazies(job_fibers, trace)
+                run_pending_steps(job_fibers, next_job_fibers, source_tasks, jobs_fiber_limit, trace)
+              end
+            end
           end
           trace&.end_dataloader(self)
         end
@@ -69,6 +67,19 @@ module GraphQL
 
       private
 
+      def run_pending_steps(job_fibers, next_job_fibers, source_tasks, jobs_fiber_limit, trace)
+        while (f = (job_fibers.shift || (((job_fibers.size + next_job_fibers.size + source_tasks.size) < jobs_fiber_limit) && spawn_job_fiber(trace))))
+          if f.alive?
+            finished = run_fiber(f)
+            if !finished
+              next_job_fibers << f
+            end
+          end
+        end
+        job_fibers.concat(next_job_fibers)
+        next_job_fibers.clear
+      end
+
       def spawn_source_task(parent_task, condition, trace)
         pending_sources = nil
         @source_cache.each_value do |source_by_batch_params|

data/lib/graphql/dataloader/null_dataloader.rb

@@ -2,24 +2,62 @@
 
 module GraphQL
   class Dataloader
-    # The default implementation of dataloading -- all no-ops.
+    # GraphQL-Ruby uses this when Dataloader isn't enabled.
     #
-    # The Dataloader interface isn't public, but it enables
-    # simple internal code while adding the option to add Dataloader.
+    # It runs execution code inline and gathers lazy objects (eg. Promises)
+    # and resolves them during {#run}.
     class NullDataloader < Dataloader
-      # These are all no-ops because code was
-      # executed synchronously.
+      def initialize(*)
+        @lazies_at_depth = Hash.new { |h,k| h[k] = [] }
+      end
+
+      def freeze
+        @lazies_at_depth.default_proc = nil
+        @lazies_at_depth.freeze
+        super
+      end
+
+      def run(trace_query_lazy: nil)
+        with_trace_query_lazy(trace_query_lazy) do
+          while !@lazies_at_depth.empty?
+            smallest_depth = nil
+            @lazies_at_depth.each_key do |depth_key|
+              smallest_depth ||= depth_key
+              if depth_key < smallest_depth
+                smallest_depth = depth_key
+              end
+            end
+
+            if smallest_depth
+              lazies = @lazies_at_depth.delete(smallest_depth)
+              lazies.each(&:value) # resolve these Lazy instances
+            end
+          end
+        end
+      end
+
+      def run_isolated
+        # Reuse this instance because execution code may already have a reference to _this_ `dataloader` inside the given block.
+        prev_lazies_at_depth = @lazies_at_depth
+        @lazies_at_depth = @lazies_at_depth.dup.clear
+        res = nil
+        append_job {
+          res = yield
+        }
+        run
+        res
+      ensure
+        @lazies_at_depth = prev_lazies_at_depth
+      end
 
-      def initialize(*); end
-      def run; end
-      def run_isolated; yield; end
       def clear_cache; end
+
       def yield(_source)
         raise GraphQL::Error, "GraphQL::Dataloader is not running -- add `use GraphQL::Dataloader` to your schema to use Dataloader sources."
       end
 
-      def append_job
-        yield
+      def append_job(callable = nil)
+        callable ? callable.call : yield
         nil
       end