<commit_before>#
# Copyright (C) 2017 - present Instructure, Inc.
#
# This file is part of Canvas.
#
# Canvas is free software: you can redistribute it and/or modify it under
# the terms of the GNU Affero General Public License as published by the Free
# Software Foundation, version 3 of the License.
#
# Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
# details.
#
# You should have received a copy of the GNU Affero General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.
#

class GraphQLTypeTester
  def initialize(test_object, context = {})
    @obj = test_object
    @context = context
  end

  def resolve(field_and_subfields, context = {})
    field_context = @context.merge(context)
    type = CanvasSchema.resolve_type(@obj, field_context) or
      raise "couldn't resolve type for #{@obj.inspect}"
    field = extract_field(field_and_subfields, type)
    variables = {
      id: CanvasSchema.id_from_object(@obj, type, field_context)
    }

    result = CanvasSchema.execute(<<~GQL, context: field_context, variables: variables)
      query($id: ID!) {
        node(id: $id) {
          ... on #{type} {
            #{field_and_subfields}
          }
        }
      }
    GQL

    if result["errors"]
      raise "QraphQL query error: #{result["errors"].inspect}"
    else
      extract_results(result)
    end
  end

  private

  def extract_field(field_and_subfields, type)
    field_and_subfields =~ /\A(\w+)/
    field = $1
    if !field || !type.fields[field]
      raise "couldn't find field #{field} for #{type}"
    end
    field
  end

  def extract_results(result)
    return result unless result.respond_to?(:reduce)
    result.reduce(nil) do |result, (k, v)|
      case v
      when Hash then extract_results(v)
      when Array then v.map { |x| extract_results(x) }
      else v
      end
    end
  end
end
<commit_msg>add rdoc for GraphQLTypeTester<commit_after>#
# Copyright (C) 2017 - present Instructure, Inc.
#
# This file is part of Canvas.
#
# Canvas is free software: you can redistribute it and/or modify it under
# the terms of the GNU Affero General Public License as published by the Free
# Software Foundation, version 3 of the License.
#
# Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
# details.
#
# You should have received a copy of the GNU Affero General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.
#


##
# = Convenience class for testing graphql types.
#
# This class provides a more convenient workflow for writing graphql queries
# and inspecting their results.  Consider the following example:
#
#   user_type = GraphQLTypeTester.new(@student, current_user: @teacher)
#   expect(user_type.resolve("_id")).to eq @student.id.to_s
#
# this is equivalent to constructing the following query by hand:
#
#   res = CanvasSchema.execute(<<~GQL, context: {current_user: @teacher})
#     node(id: "asdfasdf") {
#       ... on User {
#         _id
#       }
#     }
#   GQL
#   expect(res["data"]["node"]["_id"]).to eq @student.id.to_s
#
class GraphQLTypeTester
  # _test_object_ is the backing object for a GraphQL type.  It must implement
  # +GraphQL::Types::Relay::Node+ (otherwise you'll need to reach down the
  # graph from a parent object).
  #
  # _context_ is an optional default context that will be passed to the query.
  def initialize(test_object, context = {})
    @obj = test_object
    @context = context
  end


  # returns the value (or list of values) for the resolved field.  This can be
  # any fragment of graphql, but ultimately should only select a single scalar
  # field:
  #
  # [good]  * <tt>id</tt>
  #         * <tt>foo(bar: BAZ)</tt>
  #         * <tt>userConnection { edges { node { name } } }</tt> In this case,
  #           the return value of resolve will be a list of names
  #         * <tt>course { updatedAt }</tt>
  # [bad]   * <tt>id, name</tt> selecting multiple fields is not allowed
  #         * <tt>userConnection</tt> must select scalars (not compound types)
  #
  # _context_ represents additional context to pass to the query (or to
  # override the context supplied in the constructor).  This will typically be
  # used to pass the _current_user_.
  def resolve(field_and_subfields, context = {})
    field_context = @context.merge(context)
    type = CanvasSchema.resolve_type(@obj, field_context) or
      raise "couldn't resolve type for #{@obj.inspect}"
    field = extract_field(field_and_subfields, type)
    variables = {
      id: CanvasSchema.id_from_object(@obj, type, field_context)
    }

    result = CanvasSchema.execute(<<~GQL, context: field_context, variables: variables)
      query($id: ID!) {
        node(id: $id) {
          ... on #{type} {
            #{field_and_subfields}
          }
        }
      }
    GQL

    if result["errors"]
      raise "QraphQL query error: #{result["errors"].inspect}"
    else
      extract_results(result)
    end
  end

  private

  def extract_field(field_and_subfields, type)
    field_and_subfields =~ /\A(\w+)/
    field = $1
    if !field || !type.fields[field]
      raise "couldn't find field #{field} for #{type}"
    end
    field
  end

  def extract_results(result)
    return result unless result.respond_to?(:reduce)
    result.reduce(nil) do |result, (k, v)|
      case v
      when Hash then extract_results(v)
      when Array then v.map { |x| extract_results(x) }
      else v
      end
    end
  end
end

{'fraction_non_alphanumeric': 0.10147918816649466, 'fraction_numerical': 0.0020639834881320948, 'mean_word_length': 3.057920446615492, 'pattern_counts': {'":': 0, '<': 23, '<?xml version=': 0, '>': 17, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5882244', 'n_tokens_mistral': 1782, 'n_tokens_neox': 1754, 'n_words': 619}