graphql 2.4.15 → 2.5.0

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

@@ -0,0 +1,71 @@
+<% content_for(:title, "View #{params[:digest]}") %>
+<% if @operation.nil? %>
+  <div class="row">
+    <div class="col">
+      <p>No stored operation found for <code><%= params[:digest] %></code>
+    </div>
+  </div>
+<% else %>
+  <div class="row">
+    <div class="col">
+      <h2>
+        <%= @operation.name %>
+        <% if @operation.is_archived %><small> (archived)</small><% end %>
+      </h2>
+    </div>
+  </div>
+  <div class="row mt-3">
+    <div class="col">
+      <p>Aliases</p>
+      <% if @client_operations.empty? %>
+        <p><em>None</em></p>
+      <% else %>
+        <ul>
+          <% @client_operations.each do |cl_op| %>
+            <li>
+              <code><%= cl_op.operation_alias %></code>
+              <%= link_to(cl_op.client_name, graphql_dashboard.operation_store_client_operations_path(client_name: cl_op.client_name)) %>
+              <%= cl_op.is_archived ?  " (archived)" : "" %>
+            </li>
+          <% end %>
+        </ul>
+      <% end %>
+    </div>
+  </div>
+  <div class="row">
+    <div class="col">
+      <p>Last Used At</p>
+      <p><code><%= @operation.last_used_at %></code></p>
+    </div>
+  </div>
+  <div class="row">
+    <div class="col">
+      <p>Source</p>
+      <%= textarea_tag "_source", @graphql_source, class: "graphql-highlight form-control", disabled: true, rows: @graphql_source.count("\n") + 1 %>
+    </div>
+  </div>
+  <div class="row mt-3">
+    <div class="col">
+      <p>References</p>
+      <ul>
+        <% @entries.each do |entry| %>
+          <li>
+            <%= link_to(entry.name, graphql_dashboard.operation_store_index_entry_path(name: entry.name)) %>
+          </li>
+        <% end %>
+      </ul>
+    </div>
+  </div>
+  <div class="row mt-3">
+    <div class="col">
+      <p>Digest</p>
+      <p><code><%= @operation.digest %></code></p>
+    </div>
+  </div>
+  <div class="row mt-3">
+    <div class="col">
+      <p>Minified Source</p>
+      <%= textarea_tag "_source", @operation.body, class: "graphql-highlight form-control", disabled: true, rows: @operation.body.count("\n") + 1 %>
+    </div>
+  </div>
+<% end %>

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

@@ -0,0 +1,41 @@
+<% content_for(:title, "Subscription #{params[:id]}") %>
+<div class="row mt-3">
+  <div class="col">
+    <h3>Subscription: <code><%= params[:id] %></code></h3>
+  </div>
+</div>
+
+<% if @query_data.nil? %>
+  <div class="row">
+    <div class="col">
+      <p class="muted"><i>This subscription was not found or is no longer active.</i></p>
+    </div>
+  </div>
+<% else %>
+    <div class="row">
+      <div class="col">
+        <p>Created at <%= @query_data[:created_at] %>, last triggered at <%= @query_data[:last_triggered_at] || "--" %></p>
+
+        <p>Subscribed? <code><%= @still_subscribed ? "YES" : "NO" %></code></p>
+        <p>Broadcast? <code><%= @is_broadcast ? "YES" : "NO" %></code> <% if @is_broadcast %>
+          <small class="muted"><% if @subscribers_count.nil? %>
+            This subscription may have multiple subscribers.
+          <% else %>
+            (<%= pluralize(@subscribers_count, "subscriber") %>)
+          <% end %></small>
+        <% end %></p>
+
+        <p>Context:</p>
+        <pre><%= @query_data[:context].inspect %></pre>
+
+        <p>Variables:</p>
+        <pre><%= @query_data[:variables].inspect %></pre>
+
+        <p>Operation Name:</p>
+        <pre><%= @query_data[:operation_name].inspect %></pre>
+
+        <p>Query String:</p>
+        <%= textarea_tag "_source", @query_data[:query_string], class: "graphql-highlight form-control", disabled: true, rows: @query_data[:query_string].count("\n") + 1 %>
+      </div>
+    </div>
+<% end %>

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

@@ -0,0 +1,55 @@
+<% content_for(:title, "Subscriptions - Topics") %>
+<div class="row mt-3 justify-content-between">
+  <div class="col-auto">
+    <h3>
+      <%= pluralize(@all_topics_count, "Subscription Topic") %>
+    </h3>
+  </div>
+  <div class="col-auto">
+    <%= button_tag "Clear All", class: "btn btn-outline-danger", data: { subscriptions_delete_all: graphql_dashboard.subscriptions_clear_all_path } %>
+  </div>
+</div>
+
+<table class="table table-striped">
+  <thead>
+    <tr>
+      <th>Name</th>
+      <th># Subscriptions</th>
+      <th>Last Triggered At</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% if @all_topics_count == 0 %>
+      <tr>
+        <td colspan="3" class="text-center">
+          <em>There aren't any subscriptions right now.</em>
+        </td>
+      </tr>
+    <% else %>
+      <% @topics.each do |topic| %>
+        <tr>
+          <td><%= link_to(topic.name, graphql_dashboard.subscriptions_topic_path(name: topic.name)) %></td>
+          <td><%= topic.subscriptions_count %></td>
+          <td><%= topic.last_triggered_at || "--" %></td>
+        </tr>
+      <% end %>
+    <% end %>
+  </tbody>
+</table>
+
+<div class="row">
+  <div class="col-auto">
+    <% if @page > 1 %>
+      <%= link_to("« prev", graphql_dashboard.subscriptions_topics_path(per_page: params[:per_page], page: @page - 1), class: "btn btn-outline-secondary") %>
+    <% else %>
+      <button class="btn btn-outline-secondary" disabled>« prev</button>
+    <% end %>
+  </div>
+  <div class="col-auto">
+    <% if @has_next_page %>
+      <%= link_to("next »", graphql_dashboard.subscriptions_topics_path(per_page: params[:per_page], page: @page + 1), class: "btn btn-outline-secondary") %>
+    <% else %>
+      <button class="btn btn-outline-secondary" disabled>next »</button>
+    <% end %>
+  </div>
+</div>

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

@@ -0,0 +1,40 @@
+<%= content_for(:title, "Subscriptions - #{params[:name]}") %>
+<div class="row mt-3">
+  <div class="col">
+    <h3>Topic: <code><%= params[:name] %></code></h3>
+  </div>
+</div>
+
+<div class="row">
+  <div class="col">
+    <p>Last triggered: <%= @topic_last_triggered_at || "none" %></p>
+    <p><%= pluralize(@subscriptions_count, "Subscription") %></p>
+  <div>
+</div>
+
+<div class="row">
+  <div class="col">
+    <table class="table table-striped">
+      <thead>
+        <tr>
+          <th>Subscription ID</th>
+          <th>Created At</th>
+          <th>Subscribed?</th>
+          <th>Broadcast?</th>
+          <% if @show_broadcast_subscribers_count %><th>Subscribers</th><% end %>
+        </tr>
+      </thead>
+      <tbody>
+        <% @subscriptions.each do |subscription| %>
+          <tr>
+            <td><%= link_to(subscription[:id], graphql_dashboard.subscriptions_subscription_path(subscription[:id])) %></td>
+            <td><%= subscription[:created_at] %></td>
+            <td><code><%= subscription[:still_subscribed] ? "YES" : "NO" %></code></td>
+            <td><code><%= subscription[:is_broadcast] ? "YES" : "NO" %></code></td>
+            <% if @show_broadcast_subscribers_count %><td><%= subscription[:subscribers_count] %></td><% end %>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+</div>

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

@@ -6,6 +6,7 @@
     <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") %>
@@ -27,7 +28,44 @@
                 <div class="collapse navbar-collapse" id="navbarSupportedContent">
                   <ul class="navbar-nav me-auto mb-2 mb-lg-0">
                     <li class="nav-item">
-                      <%= link_to "Traces", graphql_dashboard.traces_path, class: "nav-link #{params[:controller] == "graphql/dashboard/traces" ? "active" : ""}" %>
+                      <%= link_to "Traces", graphql_dashboard.detailed_traces_traces_path, class: "nav-link #{params[:controller] == "graphql/dashboard/detailed_traces" ? "active" : ""}" %>
+                    </li>
+                    <li class="nav-item dropdown">
+                      <a class="nav-link dropdown-toggle <%= params[:controller].include?("operation_store") ? "active" : "" %>" href="#" role="button" data-bs-toggle="dropdown" aria-expanded="false">
+                        Persisted Operations
+                      </a>
+                      <ul class="dropdown-menu">
+                        <li>
+                          <%= link_to "Clients", graphql_dashboard.operation_store_clients_path, class: "dropdown-item" %>
+                        </li>
+                        <li>
+                          <%= link_to "Operations", graphql_dashboard.operation_store_operations_path, class: "dropdown-item" %>
+                        </li>
+                        <li>
+                          <%= link_to "Index", graphql_dashboard.operation_store_index_entries_path, class: "dropdown-item" %>
+                        </li>
+                      </ul>
+                    </li>
+                    <li class="nav-item">
+                      <%= link_to "Subscriptions", graphql_dashboard.subscriptions_topics_path, class: "nav-link #{params[:controller] == "graphql/dashboard/subscriptions" ? "active" : ""}" %>
+                    </li>
+                    <li class="nav-item dropdown">
+                      <a class="nav-link dropdown-toggle <%= params[:controller].include?("limiters") ? "active" : "" %>" href="#" role="button" data-bs-toggle="dropdown" aria-expanded="false">
+                        Rate Limiters
+                      </a>
+                      <ul class="dropdown-menu">
+                        <li>
+                          <%= link_to "Runtime", graphql_dashboard.limiters_limiter_path("runtime", chart: params[:chart]), class: "dropdown-item" %>
+                        </li>
+                        <li>
+                          <%= link_to "Active Operations", graphql_dashboard.limiters_limiter_path("active_operations", chart: params[:chart]), class: "dropdown-item" %>
+                        </li>
+                        <% if schema_class.respond_to?(:enterprise_mutation_limiter) && schema_class.enterprise_mutation_limiter %>
+                          <li>
+                            <%= link_to "Mutations", graphql_dashboard.limiters_limiter_path("mutations", chart: params[:chart]), class: "dropdown-item" %>
+                          </li>
+                        <% end %>
+                      </ul>
                     </li>
                   </ul>
                   <span class="navbar-text pe-2">
@@ -38,6 +76,16 @@
             </nav>
           </div>
         </div>
+        <% flash.each do |flash_type, flash_message| %>
+          <div class="row mt-2">
+            <div class="col">
+              <div class="alert alert-<%= flash_type %> alert-dismissible fade show" role="alert">
+                <%= flash_message %>
+                <button type="button" class="btn-close" data-bs-dismiss="alert" aria-label="Close"></button>
+              </div>
+            </div>
+          </div>
+        <% end %>
       </div>
       <div class="container-fluid">
         <%= yield %>

data/lib/graphql/dashboard.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require 'rails/engine'
-
 module Graphql
   # `GraphQL::Dashboard` is a `Rails::Engine`-based dashboard for viewing metadata about your GraphQL schema.
   #
@@ -38,8 +37,45 @@ module Graphql
     routes.draw do
       root "landings#show"
       resources :statics, only: :show, constraints: { id: /[0-9A-Za-z\-.]+/ }
-      delete "/traces/delete_all", to: "traces#delete_all", as: :traces_delete_all
-      resources :traces, only: [:index, :show, :destroy]
+
+      namespace :detailed_traces do
+        resources :traces, only: [:index, :show, :destroy] do
+          collection do
+            delete :delete_all, to: "traces#delete_all", as: :delete_all
+          end
+        end
+      end
+
+      namespace :limiters do
+        resources :limiters, only: [:show, :update], param: :name
+      end
+
+      namespace :operation_store do
+        resources :clients, param: :name do
+          resources :operations, param: :digest, only: [:index] do
+            collection do
+              get :archived, to: "operations#index", archived_status: :archived, as: :archived
+              post :archive, to: "operations#update", modification: :archive, as: :archive
+              post :unarchive, to: "operations#update", modification: :unarchive, as: :unarchive
+            end
+          end
+        end
+
+        resources :operations, param: :digest, only: [:index, :show] do
+          collection do
+            get :archived, to: "operations#index", archived_status: :archived, as: :archived
+            post :archive, to: "operations#update", modification: :archive, as: :archive
+            post :unarchive, to: "operations#update", modification: :unarchive, as: :unarchive
+          end
+        end
+        resources :index_entries, only: [:index, :show], param: :name, constraints: { name: /[A-Za-z0-9_.]+/}
+      end
+
+      namespace :subscriptions do
+        resources :topics, only: [:index, :show], param: :name, constraints: { name: /.*/ }
+        resources :subscriptions, only: [:show], constraints: { id: /[a-zA-Z0-9\-]+/ }
+        post "/subscriptions/clear_all", to: "subscriptions#clear_all", as: :clear_all
+      end
     end
 
     class ApplicationController < ActionController::Base
@@ -80,32 +116,6 @@ module Graphql
       end
     end
 
-    class TracesController < ApplicationController
-      def index
-        @detailed_trace_installed = !!schema_class.detailed_trace
-        if @detailed_trace_installed
-          @last = params[:last]&.to_i || 50
-          @before = params[:before]&.to_i
-          @traces = schema_class.detailed_trace.traces(last: @last, before: @before)
-        end
-      end
-
-      def show
-        trace = schema_class.detailed_trace.find_trace(params[:id].to_i)
-        send_data(trace.trace_data)
-      end
-
-      def destroy
-        schema_class.detailed_trace.delete_trace(params[:id])
-        head :no_content
-      end
-
-      def delete_all
-        schema_class.detailed_trace.delete_all_traces
-        head :no_content
-      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
@@ -114,6 +124,7 @@ module Graphql
       [
         "icon.png",
         "header-icon.png",
+        "charts.min.css",
         "dashboard.css",
         "dashboard.js",
         "bootstrap-5.3.3.min.css",
@@ -134,6 +145,11 @@ module Graphql
   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.

data/lib/graphql/execution/interpreter.rb

@@ -23,7 +23,7 @@ module GraphQL
         # @return [Array<GraphQL::Query::Result>] One result per query
         def run_all(schema, query_options, context: {}, max_complexity: schema.max_complexity)
           queries = query_options.map do |opts|
-            case opts
+            query = case opts
             when Hash
               schema.query_class.new(schema, nil, **opts)
             when GraphQL::Query
@@ -31,14 +31,14 @@ module GraphQL
             else
               raise "Expected Hash or GraphQL::Query, not #{opts.class} (#{opts.inspect})"
             end
+            query
           end
 
           return GraphQL::EmptyObjects::EMPTY_ARRAY if queries.empty?
 
           multiplex = Execution::Multiplex.new(schema: schema, queries: queries, context: context, max_complexity: max_complexity)
-          Fiber[:__graphql_current_multiplex] = multiplex
           trace = multiplex.current_trace
-          trace.begin_execute_multiplex(multiplex)
+          Fiber[:__graphql_current_multiplex] = multiplex
           trace.execute_multiplex(multiplex: multiplex) do
             schema = multiplex.schema
             queries = multiplex.queries
@@ -155,8 +155,6 @@ module GraphQL
               }
             end
           end
-        ensure
-          trace&.end_execute_multiplex(multiplex)
         end
       end
 

data/lib/graphql/execution/multiplex.rb

@@ -32,10 +32,10 @@ module GraphQL
         @queries = queries
         @queries.each { |q| q.multiplex = self }
         @context = context
-        @current_trace = @context[:trace] || schema.new_trace(multiplex: self)
         @dataloader = @context[:dataloader] ||= @schema.dataloader_class.new
         @tracers = schema.tracers + (context[:tracers] || [])
         @max_complexity = max_complexity
+        @current_trace = context[:trace] ||= schema.new_trace(multiplex: self)
       end
     end
   end

data/lib/graphql/language/parser.rb

@@ -488,26 +488,33 @@ module GraphQL
       end
 
       def type
-        type = case token_name
+        parsed_type = case token_name
         when :IDENTIFIER
           parse_type_name
         when :LBRACKET
           list_type
+        else
+          nil
         end
 
-        if at?(:BANG)
-          type = Nodes::NonNullType.new(pos: pos, of_type: type, source: self)
+        if at?(:BANG) && parsed_type
+          parsed_type = Nodes::NonNullType.new(pos: pos, of_type: parsed_type, source: self)
           expect_token(:BANG)
         end
-        type
+        parsed_type
       end
 
       def list_type
         loc = pos
         expect_token(:LBRACKET)
-        type = Nodes::ListType.new(pos: loc, of_type: self.type, source: self)
+        inner_type = self.type
+        parsed_list_type = if inner_type
+          Nodes::ListType.new(pos: loc, of_type: inner_type, source: self)
+        else
+          nil
+        end
         expect_token(:RBRACKET)
-        type
+        parsed_list_type
       end
 
       def parse_operation_type

data/lib/graphql/query.rb

@@ -98,9 +98,10 @@ module GraphQL
     # @param max_depth [Numeric] the maximum number of nested selections allowed for this query (falls back to schema-level value)
     # @param max_complexity [Numeric] the maximum field complexity for this query (falls back to schema-level value)
     # @param visibility_profile [Symbol] Another way to assign `context[:visibility_profile]`
-    def initialize(schema, query_string = nil, query: nil, document: nil, context: nil, variables: nil, validate: true, static_validator: nil, visibility_profile: nil, subscription_topic: nil, operation_name: nil, root_value: nil, max_depth: schema.max_depth, max_complexity: schema.max_complexity, warden: nil, use_visibility_profile: nil)
+    def initialize(schema, query_string = nil, query: nil, document: nil, context: nil, variables: nil, multiplex: nil, validate: true, static_validator: nil, visibility_profile: nil, subscription_topic: nil, operation_name: nil, root_value: nil, max_depth: schema.max_depth, max_complexity: schema.max_complexity, warden: nil, use_visibility_profile: nil)
       # Even if `variables: nil` is passed, use an empty hash for simpler logic
       variables ||= {}
+      @multiplex = multiplex
       @schema = schema
       @context = schema.context_class.new(query: self, values: context)
       if visibility_profile
@@ -441,7 +442,6 @@ module GraphQL
       @warden ||= @schema.warden_class.new(schema: @schema, context: @context)
       parse_error = nil
       @document ||= begin
-        current_trace.begin_parse(query_string)
         if query_string
           GraphQL.parse(query_string, trace: self.current_trace, max_tokens: @schema.max_query_string_tokens)
         end
@@ -449,8 +449,6 @@ module GraphQL
         parse_error = err
         @schema.parse_error(err, @context)
         nil
-      ensure
-        current_trace.end_parse(query_string)
       end
 
       @fragments = {}

data/lib/graphql/static_validation/all_rules.rb

@@ -34,7 +34,7 @@ module GraphQL
       GraphQL::StaticValidation::VariableUsagesAreAllowed,
       GraphQL::StaticValidation::MutationRootExists,
       GraphQL::StaticValidation::QueryRootExists,
-      GraphQL::StaticValidation::SubscriptionRootExists,
+      GraphQL::StaticValidation::SubscriptionRootExistsAndSingleSubscriptionSelection,
       GraphQL::StaticValidation::InputObjectNamesAreUnique,
       GraphQL::StaticValidation::OneOfInputObjectsAreValid,
     ]

data/lib/graphql/static_validation/rules/not_single_subscription_error.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module GraphQL
+  module StaticValidation
+    class NotSingleSubscriptionError < StaticValidation::Error
+      def initialize(message, path: nil, nodes: [])
+        super(message, path: path, nodes: nodes)
+      end
+
+      # A hash representation of this Message
+      def to_h
+        extensions = {
+          "code" => code,
+        }
+
+        super.merge({
+          "extensions" => extensions
+        })
+      end
+
+      def code
+        "notSingleSubscription"
+      end
+    end
+  end
+end

data/lib/graphql/static_validation/rules/subscription_root_exists_and_single_subscription_selection.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module GraphQL
+  module StaticValidation
+    module SubscriptionRootExistsAndSingleSubscriptionSelection
+      def on_operation_definition(node, parent)
+        if node.operation_type == "subscription"
+          if context.types.subscription_root.nil?
+            add_error(GraphQL::StaticValidation::SubscriptionRootExistsError.new(
+              'Schema is not configured for subscriptions',
+              nodes: node
+            ))
+          elsif node.selections.size != 1
+            add_error(GraphQL::StaticValidation::NotSingleSubscriptionError.new(
+              'A subscription operation may only have one selection',
+              nodes: node,
+            ))
+          else
+            super
+          end
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/graphql/tracing/active_support_notifications_trace.rb

@@ -10,6 +10,13 @@ module GraphQL
     #   class MySchema < GraphQL::Schema
     #     trace_with(GraphQL::Tracing::ActiveSupportNotificationsTrace)
     #   end
+    #
+    # @example Subscribing to GraphQL events with ActiveSupport::Notifications
+    #   ActiveSupport::Notifications.subscribe(/graphql/) do |event|
+    #     pp event.name
+    #     pp event.payload
+    #   end
+    #
     module ActiveSupportNotificationsTrace
       include NotificationsTrace
       def initialize(engine: ActiveSupport::Notifications, **rest)

data/lib/graphql/tracing/appoptics_tracing.rb

@@ -22,6 +22,11 @@ module GraphQL
       # These GraphQL events will show up as 'graphql.execute' spans
       EXEC_KEYS = ['execute_multiplex', 'execute_query', 'execute_query_lazy'].freeze
 
+      def initialize(...)
+        warn "GraphQL::Tracing::AppOptics tracing is deprecated; update to SolarWindsAPM instead, which uses OpenTelemetry."
+        super
+      end
+
       # During auto-instrumentation this version of AppOpticsTracing is compared
       # with the version provided in the appoptics_apm gem, so that the newer
       # version of the class can be used