# frozen_string_literal: true
require "spec_helper"

describe GraphQL::Analysis do
  class AstTypeCollector < GraphQL::Analysis::Analyzer
    def initialize(query)
      super
      @types = []
    end

    def on_enter_operation_definition(node, parent, visitor)
      @types << visitor.type_definition
    end

    def on_enter_field(memo, node, visitor)
      @types << visitor.field_definition.type.unwrap
    end

    def result
      @types
    end
  end

  class AstNodeCounter < GraphQL::Analysis::Analyzer
    def initialize(query)
      super
      @nodes = Hash.new { |h,k| h[k] = 0 }
    end

    def on_enter_abstract_node(node, parent, _visitor)
      @nodes[node.class] += 1
    end

    alias :on_enter_operation_definition :on_enter_abstract_node
    alias :on_enter_field :on_enter_abstract_node
    alias :on_enter_argument :on_enter_abstract_node

    def result
      @nodes
    end
  end

  class AstConditionalAnalyzer < GraphQL::Analysis::Analyzer
    def initialize(query)
      super
      @i_have_been_called = false
    end

    def analyze?
      !!query.context[:analyze]
    end

    def on_operation_definition(node, parent, visitor)
      @i_have_been_called = true
    end

    def result
      @i_have_been_called
    end
  end

  class AstPrecomputedAnalyzer < GraphQL::Analysis::Analyzer
    def initialize(query)
      super
      @i_have_been_visited = false
    end

    def visit?
      query.context[:precomputed_result].nil?
    end

    def on_enter_field(node, parent, visitor)
      @i_have_been_visited = true
    end

    def result
      return query.context[:precomputed_result], @i_have_been_visited
    end
  end

  class AstErrorAnalyzer < GraphQL::Analysis::Analyzer
    def result
      GraphQL::AnalysisError.new("An Error!")
    end
  end

  class AstPreviousField < GraphQL::Analysis::Analyzer
    def on_enter_field(node, parent, visitor)
      @previous_field = visitor.previous_field_definition
    end

    def result
      @previous_field
    end
  end

  class AstArguments < GraphQL::Analysis::Analyzer
    def on_enter_argument(node, parent, visitor)
      @argument = visitor.argument_definition
      @previous_argument = visitor.previous_argument_definition
    end

    def result
      [@argument, @previous_argument]
    end
  end

  class AstSkipInclude < GraphQL::Analysis::Analyzer
    def initialize(query)
      super
      @included = []
    end

    def on_enter_field(node, parent, visitor)
      @included << "enter #{node.name}" unless visitor.skipping?
    end

    def on_leave_field(node, parent, visitor)
      @included << "leave #{node.name}" unless visitor.skipping?
    end

    def on_enter_inline_fragment(node, parent, visitor)
      @included << "enter ...on #{node.type.name}" unless visitor.skipping?
    end

    def on_leave_inline_fragment(node, parent, visitor)
      @included << "leave ...on #{node.type.name}" unless visitor.skipping?
    end

    def on_enter_fragment_spread(node, parent, visitor)
      @included << "enter ...#{node.name}" unless visitor.skipping?
    end

    def on_leave_fragment_spread(node, parent, visitor)
      @included << "leave ...#{node.name}" unless visitor.skipping?
    end

    def result
      @included
    end
  end

  describe "skip and include behaviors" do
    let(:reduce_result) { GraphQL::Analysis.analyze_query(query, [AstSkipInclude]) }
    let(:query) { GraphQL::Query.new(Dummy::Schema, query_string) }
    let(:query_string) {%|{}|}

    describe "for fields" do
      let(:query_string) {%|
        {
          cheese {
            flavor
            origin @skip(if: true)
            source @include(if: false)
          }
          cheese @skip(if: true) { flavor }
          cheese @include(if: false) { flavor }
        }
      |}

      it "tracks inclusions" do
        expected = [
          "enter cheese",
          "enter flavor",
          "leave flavor",
          "leave cheese",
        ]
        assert_equal expected, reduce_result.first
      end
    end

    describe "for inline fragments" do
      let(:query_string) {%|
        {
          cheese {
            ...on Cheese @skip(if: true) { origin }
            ...on Cheese { flavor }
            ...on Cheese @include(if: false) { source }
          }
        }
      |}

      it "tracks inclusions" do
        expected = [
          "enter cheese",
          "enter ...on Cheese",
          "enter flavor",
          "leave flavor",
          "leave ...on Cheese",
          "leave cheese",
        ]
        assert_equal expected, reduce_result.first
      end
    end

    describe "for fragment spreads" do
      let(:query_string) {%|
        {
          cheese {
            ...Original @skip(if: true)
            ...Flavorful
            ...Sourced @include(if: false)
          }
        }
        fragment Flavorful on Cheese { flavor }
        fragment Original on Cheese { origin }
        fragment Sourced on Cheese { source }
      |}

      it "tracks inclusions" do
        expected = [
          "enter cheese",
          "enter ...Flavorful",
          "enter flavor",
          "leave flavor",
          "leave ...Flavorful",
          "leave cheese",
        ]
        assert_equal expected, reduce_result.first
      end
    end
  end

  describe "using the AST analysis engine" do
    let(:schema) do
      query_type = Class.new(GraphQL::Schema::Object) do
        graphql_name 'Query'

        field :foobar, Integer, null: false

        def foobar
          1337
        end
      end

      Class.new(GraphQL::Schema) do
        query query_type
        query_analyzer AstErrorAnalyzer
      end
    end

    let(:query_string) {%|
      query {
        foobar
      }
    |}

    let(:query) { GraphQL::Query.new(schema, query_string, variables: {}) }

    it "runs the AST analyzers correctly" do
      res = query.result
      refute res.key?("data")
      assert_equal ["An Error!"], res["errors"].map { |e| e["message"] }
    end
  end

  describe ".analyze_query" do
    let(:analyzers) { [AstTypeCollector, AstNodeCounter] }
    let(:reduce_result) { GraphQL::Analysis.analyze_query(query, analyzers) }
    let(:variables) { {} }
    let(:query) { GraphQL::Query.new(Dummy::Schema, query_string, variables: variables) }
    let(:query_string) {%|
      {
        cheese(id: 1) {
          id
          flavor
        }
      }
    |}

    describe "without a valid operation" do
      let(:query_string) {%|
        # A comment
        # is an invalid operation
         # Should break
      |}

      it "bails early when there is no selected operation to be executed" do
        assert_equal 2, reduce_result.size
      end
    end

    describe "conditional analysis" do
      let(:analyzers) { [AstTypeCollector, AstConditionalAnalyzer] }

      describe "when analyze? returns false" do
        let(:query) { GraphQL::Query.new(Dummy::Schema, query_string, variables: variables, context: { analyze: false }) }

        it "does not run the analyzer" do
          # Only type_collector ran
          assert_equal 1, reduce_result.size
        end
      end

      describe "when analyze? returns true" do
        let(:query) { GraphQL::Query.new(Dummy::Schema, query_string, variables: variables, context: { analyze: true }) }

        it "it runs the analyzer" do
          # Both analyzers ran
          assert_equal 2, reduce_result.size
        end
      end

      describe "Visitor#previous_field_definition" do
        let(:analyzers) { [AstPreviousField] }
        let(:query) { GraphQL::Query.new(Dummy::Schema, "{ __schema { types { name } } }") }

        it "it runs the analyzer" do
          prev_field = reduce_result.first
          assert_equal "__Schema.types", prev_field.path
        end
      end

      describe "Visitor#argument_definition" do
        let(:analyzers) { [AstArguments] }
        let(:query) do
          GraphQL::Query.new(
            Dummy::Schema,
            '{ searchDairy(product: [{ source: "SHEEP" }]) { ... on Cheese { id } } }'
          )
        end

        it "it runs the analyzer" do
          argument, prev_argument = reduce_result.first
          assert_equal "DairyProductInput.source", argument.path
          assert_equal "Query.searchDairy.product", prev_argument.path
        end
      end
    end

    describe "precomputed analysis" do
      let(:analyzers) { [AstPrecomputedAnalyzer] }

      describe "when visit? returns true" do
        let(:query) { GraphQL::Query.new(Dummy::Schema, query_string, variables: variables, context: {}) }

        it "runs the analyzer with visitation" do
          assert_equal [nil, true], reduce_result.first
        end
      end

      describe "when visit? returns false" do
        let(:query) { GraphQL::Query.new(Dummy::Schema, query_string, variables: variables, context: { precomputed_result: 23 }) }

        it "runs the analyzer without visitation" do
          assert_equal [23, false], reduce_result.first
        end
      end
    end

    it "calls the defined analyzers" do
      collected_types, node_counts = reduce_result
      expected_visited_types = [
        Dummy::DairyAppQuery,
        Dummy::Cheese,
        GraphQL::Types::Int,
        GraphQL::Types::String
      ]
      assert_equal expected_visited_types, collected_types

      expected_node_counts = {
        GraphQL::Language::Nodes::OperationDefinition => 1,
        GraphQL::Language::Nodes::Field => 3,
        GraphQL::Language::Nodes::Argument => 1
      }

      assert_equal expected_node_counts, node_counts
    end

    class FinishedSchema < GraphQL::Schema
      class FinishedAnalyzer < GraphQL::Analysis::Analyzer
        def on_enter_field(node, parent, visitor)
          if query.context[:force_prepare]
            visitor.arguments_for(node, visitor.field_definition)
          end
        end

        def result
          query.context[:analysis_finished] = true
        end
      end

      class Query < GraphQL::Schema::Object
        field :f1, Int do
          argument :arg, String, prepare: ->(val, ctx) {
            ctx[:analysis_finished] ? val.to_i : raise("Prepared too soon!")
          }
        end
        def f1(arg:)
          arg
        end
      end

      query(Query)

      query_analyzer(FinishedAnalyzer)
    end

    it "doesn't call prepare hooks by default" do
      res = FinishedSchema.execute("{ f1(arg: \"5\") }")
      assert_equal 5, res["data"]["f1"]
      err = assert_raises RuntimeError do
        FinishedSchema.execute("{ f1(arg: \"5\") }", context: { force_prepare: true })
      end
      assert_equal "Prepared too soon!", err.message
    end

    describe "tracing" do
      let(:query_string) { "{ t: __typename }"}

      it "emits traces" do
        traces = TestTracing.with_trace do
          ctx = { tracers: [TestTracing] }
          Dummy::Schema.execute(query_string, context: ctx)
        end

        # The query_trace is on the list _first_ because it finished first
        if USING_C_PARSER
          _lex, _parse, _validate, query_trace, multiplex_trace, *_rest = traces
        else
          _parse, _validate, query_trace, multiplex_trace, *_rest = traces
        end

        assert_equal "analyze_multiplex", multiplex_trace[:key]
        assert_instance_of GraphQL::Execution::Multiplex, multiplex_trace[:multiplex]

        assert_equal "analyze_query", query_trace[:key]
        assert_instance_of GraphQL::Query, query_trace[:query]
      end
    end

    class AstConnectionCounter < GraphQL::Analysis::Analyzer
      def initialize(query)
        super
        @fields = 0
        @connections = 0
      end

      def on_enter_field(node, parent, visitor)
        if visitor.field_definition.connection?
          @connections += 1
        else
          @fields += 1
        end
      end

      def result
        {
          fields: @fields,
          connections: @connections
        }
      end
    end

    describe "when processing fields" do
      let(:analyzers) { [AstConnectionCounter] }
      let(:reduce_result) { GraphQL::Analysis.analyze_query(query, analyzers) }
      let(:query) { GraphQL::Query.new(StarWars::Schema, query_string, variables: variables) }
      let(:query_string) {%|
        query getBases {
          empire {
            basesByName(first: 30) { edges { cursor } }
            bases(first: 30) { edges { cursor } }
          }
        }
      |}

      it "knows which fields are connections" do
        connection_counts = reduce_result.first
        expected_connection_counts = {
          :fields => 5,
          :connections => 2
        }
        assert_equal expected_connection_counts, connection_counts
      end
    end
  end

  describe "Detecting all-introspection queries" do
    class AllIntrospectionSchema < GraphQL::Schema
      class Query < GraphQL::Schema::Object
        field :int, Int
      end
      query(Query)
    end

    class AllIntrospectionAnalyzer < GraphQL::Analysis::Analyzer
      def initialize(query)
        @is_introspection = true
        super
      end

      def on_enter_field(node, parent, visitor)
        @is_introspection &= (visitor.field_definition.introspection? || ((owner = visitor.field_definition.owner) && owner.introspection?))
      end

      def result
        @is_introspection
      end
    end

    def is_introspection?(query_str)
      query = GraphQL::Query.new(AllIntrospectionSchema, query_str)
      result = GraphQL::Analysis.analyze_query(query, [AllIntrospectionAnalyzer])
      result.first
    end

    it "returns true for queries containing only introspection types and fields" do
      assert is_introspection?("{ __typename }")
      refute is_introspection?("{ int }")
      assert is_introspection?(GraphQL::Introspection::INTROSPECTION_QUERY)
      assert is_introspection?("{ __type(name: \"Something\") { fields { name } } }")
      refute is_introspection?("{ int __type(name: \"Thing\") { name } }")
    end
  end

  describe "when there's a hidden field" do
    class HiddenAnalyzedFieldSchema < GraphQL::Schema
      use GraphQL::Schema::Warden if ADD_WARDEN
      class DoNothingAnalyzer < GraphQL::Analysis::Analyzer
        def on_enter_field(node, parent, visitor)
          @result ||= []
          @result << [node.name, visitor.field_definition.class]
          super
        end

        attr_reader :result
      end
      class BaseField < GraphQL::Schema::Field
        def initialize(*args, visible: true, **kwargs, &block)
          @visible = visible
          super(*args, **kwargs, &block)
        end

        def visible?(context)
          return @visible
        end
      end

      class BaseObject < GraphQL::Schema::Object
        field_class BaseField
      end

      class Article < BaseObject
        field :title, String, null: false
      end

      class Query < BaseObject
        field :article, String, visible: false do |f|
          f.argument(:id, Integer)
        end

        def article(id:)
          { title: "hello world" }
        end
      end

      query Query
    end

    it "uses nil for the field definition" do
      gql = <<~GQL
      {
        article(id: 1) {
          title
        }
      }
      GQL

      query = GraphQL::Query.new(HiddenAnalyzedFieldSchema, gql)
      result = GraphQL::Analysis.analyze_query(query, [HiddenAnalyzedFieldSchema::DoNothingAnalyzer])
      assert_equal [[["article", NilClass], ["title", NilClass]]], result
    end
  end


  describe ".validate_timeout" do
    class AnalysisTimeoutSchema < GraphQL::Schema
      class SlowAnalyzer < GraphQL::Analysis::Analyzer
        def initialize(...)
          super
          if query.context[:initialize_sleep]
            sleep 0.6
          end
        end

        def on_enter_field(node, parent, visitor)
          if node.name != "__typename"
            sleep 0.1
          end
          super
        end

        def on_enter_directive(...)
          sleep 0.1
          super
        end

        def on_enter_argument(...)
          sleep 0.1
          super
        end

        def on_enter_inline_fragment(...)
          sleep 0.1
          super
        end

        def on_enter_fragment_spread(node, _parent, _visitor)
          if !node.name.include?("NoSleep")
            sleep 0.1
          end
          super
        end

        def result
          nil
        end
      end

      class Query < GraphQL::Schema::Object
        field :f1, Int do
          argument :a, String, required: false
          argument :b, String, required: false
          argument :c, String, required: false
          argument :d, String, required: false
          argument :e, String, required: false
          argument :f, String, required: false
        end

        def f1(...)
          context[:int] ||= 0
          context[:int] += 1
        end
      end

      class Nothing < GraphQL::Schema::Directive
        locations(GraphQL::Schema::Directive::FIELD)
        repeatable(true)
      end
      directive(Nothing)

      query(Query)
      query_analyzer(SlowAnalyzer)
      validate_timeout 0.5
    end

    it "covers analysis too" do
      res = AnalysisTimeoutSchema.execute("{ f1: f1 f2: f1 }")
      assert_equal({ "f1" => 1, "f2" => 2}, res["data"])

      res2 = AnalysisTimeoutSchema.execute("{ f1: f1, f2: f1, f3: f1, f4: f1, f5: f1, f6: f1}")
      assert_equal ["Timeout on validation of query"], res2["errors"].map { |e| e["message"]}
    end

    it "covers directives" do
      res = AnalysisTimeoutSchema.execute("{ f1 @nothing @nothing }")
      assert_equal({ "f1" => 1 }, res["data"])

      res2 = AnalysisTimeoutSchema.execute("{ f1 @nothing @nothing @nothing @nothing @nothing }")
      assert_equal ["Timeout on validation of query"], res2["errors"].map { |e| e["message"]}
    end

    it "covers arguments" do
      res = AnalysisTimeoutSchema.execute("{ f1(a: \"a\", b: \"b\")}")
      assert_equal({ "f1" => 1 }, res["data"])

      res2 = AnalysisTimeoutSchema.execute('{ f1(a: "a", b: "b", c: "c", d: "d", e: "e", f: "f") }')
      assert_equal ["Timeout on validation of query"], res2["errors"].map { |e| e["message"]}
    end

    it "covers inline fragments" do
      res = AnalysisTimeoutSchema.execute("{ ... { f1 } ... { f1 } }")
      assert_equal({ "f1" => 1 }, res["data"])

      res2 = AnalysisTimeoutSchema.execute("{ ... { f1 } ... { f1 } ... { f1 } ... { f1 } ... { f1 } ... { f1 } }")
      assert_equal ["Timeout on validation of query"], res2["errors"].map { |e| e["message"]}
    end

    it "covers operation definitions" do
      res = AnalysisTimeoutSchema.execute('query Q1 { __typename }', operation_name: "Q1")
      assert_equal({ "__typename" => "Query" }, res["data"])

      res = AnalysisTimeoutSchema.execute('query Q1 { __typename }', operation_name: "Q1", context: { initialize_sleep: true })
      assert_equal({ "__typename" => "Query" }, res["data"])
    end

    it "covers fragment spreads" do
      res = AnalysisTimeoutSchema.execute("{ ...F } fragment F on Query { f1 }")
      assert_equal({ "f1" => 1 }, res["data"])

      res2 = AnalysisTimeoutSchema.execute('{ ...F ...F ...F ...F ...F ...F } fragment F on Query { f1 }')
      assert_equal ["Timeout on validation of query"], res2["errors"].map { |e| e["message"]}
    end

    it "can be ignored" do
      no_timeout_schema = Class.new(AnalysisTimeoutSchema) do
        validate_timeout(nil)
      end
      res = no_timeout_schema.execute("{ f1 @nothing @nothing @nothing @nothing @nothing }")
      assert_equal({ "f1" => 1 }, res["data"])

      res2 = no_timeout_schema.execute('{ ...F ...F ...F ...F ...F ...F } fragment F on Query { f1 }')
      assert_equal({ "f1" => 1 }, res2["data"])
    end
  end
end