File: fields_have_appropriate_selections_spec.rb

package info (click to toggle)
ruby-graphql 2.5.19-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 13,868 kB
  • sloc: ruby: 80,420; ansic: 1,808; yacc: 845; javascript: 480; makefile: 6
file content (214 lines) | stat: -rw-r--r-- 8,234 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# frozen_string_literal: true
require "spec_helper"

describe GraphQL::StaticValidation::FieldsHaveAppropriateSelections do
  include StaticValidationHelpers
  let(:query_string) {"
    query getCheese {
      okCheese: cheese(id: 1) { fatContent, similarCheese(source: YAK) { source } }
      missingFieldsObject: cheese(id: 1)
      missingFieldsInterface: cheese(id: 1) { selfAsEdible }
      illegalSelectionCheese: cheese(id: 1) { id { something, ... someFields } }
      incorrectFragmentSpread: cheese(id: 1) { flavor { ... on String { __typename } } }
    }
  "}

  it "adds errors for selections on scalars" do
    assert_equal(4, errors.length)

    illegal_selection_error = {
      "message"=>"Selections can't be made on scalars (field 'id' returns Int but has selections [\"something\", \"someFields\"])",
      "locations"=>[{"line"=>6, "column"=>47}],
      "path"=>["query getCheese", "illegalSelectionCheese", "id"],
      "extensions"=>{"code"=>"selectionMismatch", "nodeName"=>"field 'id'", "typeName"=>"Int"}
    }
    assert_includes(errors, illegal_selection_error, "finds illegal selections on scalars")

    objects_selection_required_error = {
      "message"=>"Field must have selections (field 'cheese' returns Cheese but has no selections. Did you mean 'cheese { ... }'?)",
      "locations"=>[{"line"=>4, "column"=>7}],
      "path"=>["query getCheese", "missingFieldsObject"],
      "extensions"=>{"code"=>"selectionMismatch", "nodeName"=>"field 'cheese'", "typeName"=>"Cheese"}
    }
    assert_includes(errors, objects_selection_required_error, "finds objects without selections")

    interfaces_selection_required_error = {
      "message"=>"Field must have selections (field 'selfAsEdible' returns Edible but has no selections. Did you mean 'selfAsEdible { ... }'?)",
      "locations"=>[{"line"=>5, "column"=>47}],
      "path"=>["query getCheese", "missingFieldsInterface", "selfAsEdible"],
      "extensions"=>{"code"=>"selectionMismatch", "nodeName"=>"field 'selfAsEdible'", "typeName"=>"Edible"}
    }
    assert_includes(errors, interfaces_selection_required_error, "finds interfaces without selections")

    incorrect_fragment_error = {
      "message"=>"Selections can't be made on scalars (field 'flavor' returns String but has selections [\"... on String { ... }\"])",
      "locations"=>[{"line"=>7, "column"=>48}],
      "path"=>["query getCheese", "incorrectFragmentSpread", "flavor"],
      "extensions"=>{"code"=>"selectionMismatch", "nodeName"=>"field 'flavor'", "typeName"=>"String"}
    }
    assert_includes(errors, incorrect_fragment_error, "finds scalar fields with selections")
  end

  describe "anonymous operations" do
    let(:query_string) { "{ }" }
    it "requires selections" do
      assert_equal(1, errors.length)

      selections_required_error = {
        "message"=> "Field must have selections (anonymous query returns Query but has no selections. Did you mean ' { ... }'?)",
        "locations"=>[{"line"=>1, "column"=>1}],
        "path"=>["query"],
        "extensions"=>{"code"=>"selectionMismatch", "nodeName"=>"anonymous query", "typeName"=>"Query"}
      }
      assert_includes(errors, selections_required_error)
    end
  end

  describe "selections and inline fragments on scalars" do
    let(:query_string) {"
    {
      cheese(id: 1) {
        fatContent {
          name
          ... on User {
            id
          }
          ... F
        }
      }
    }

    fragment F on Cheese {
      id
    }
    "}
    it "returns an error" do
      expected_err = "Selections can't be made on scalars (field 'fatContent' returns Float but has selections [\"name\", \"... on User { ... }\", \"F\"])"
      assert_includes(errors.map { |e| e["message"] }, expected_err)
    end
  end

  describe "selections on unions" do
    let(:query_string) { "{ searchDairy }"}
    describe "When the schema has custom handling with type to return the message" do
      let(:schema) { Class.new(Dummy::Schema) {
          allow_legacy_invalid_empty_selections_on_union(true)
          def self.legacy_invalid_empty_selections_on_union_with_type(query, type)
            :return_validation_error
          end
        }
      }

      it "returns the default message" do
        expected_err = "Field must have selections (field 'searchDairy' returns DairyProduct but has no selections. Did you mean 'searchDairy { ... }'?)"
        assert_includes(errors.map { |e| e["message"] }, expected_err)
      end
    end

    describe "When the schema has custom handling to return the message" do
      let(:schema) { Class.new(Dummy::Schema) {
          allow_legacy_invalid_empty_selections_on_union(true)
          def self.legacy_invalid_empty_selections_on_union(query)
            :return_validation_error
          end
        }
      }

      it "returns the default message" do
        expected_err = "Field must have selections (field 'searchDairy' returns DairyProduct but has no selections. Did you mean 'searchDairy { ... }'?)"
        assert_includes(errors.map { |e| e["message"] }, expected_err)
      end
    end

    describe "When the schema has custom handling with type to return a custom message" do
      let(:schema) { Class.new(Dummy::Schema) {
          allow_legacy_invalid_empty_selections_on_union(true)
          def self.legacy_invalid_empty_selections_on_union_with_type(query, type)
            "Boo, hiss!"
          end
        }
      }

      it "returns the custom message" do
        expected_err = "Boo, hiss!"
        assert_includes(errors.map { |e| e["message"] }, expected_err)
      end
    end

    describe "When the schema has custom handling to return a custom message" do
      let(:schema) { Class.new(Dummy::Schema) {
          allow_legacy_invalid_empty_selections_on_union(true)
          def self.legacy_invalid_empty_selections_on_union(query)
            "Boo, hiss!"
          end
        }
      }

      it "returns the custom message" do
        expected_err = "Boo, hiss!"
        assert_includes(errors.map { |e| e["message"] }, expected_err)
      end
    end

    describe "When the schema has custom handling with type to allow the query" do
      let(:schema) { Class.new(Dummy::Schema) {
          allow_legacy_invalid_empty_selections_on_union(true)
          def self.legacy_invalid_empty_selections_on_union_with_type(query, type)
            nil
          end
        }
      }

      it "returns no errors" do
        assert_equal [], errors
      end
    end

    describe "When the schema has custom handling to allow the query" do
      let(:schema) { Class.new(Dummy::Schema) {
          allow_legacy_invalid_empty_selections_on_union(true)
          def self.legacy_invalid_empty_selections_on_union(query)
            nil
          end
        }
      }

      it "returns no errors" do
        assert_equal [], errors
      end
    end

    describe "When the schema has no setting" do
      it "allows it with a warning to query.logger" do
        expected_warning = "Unions require selections but searchDairy (DairyProduct) doesn't have any. This will fail with a validation error on a future GraphQL-Ruby version. More info: https://graphql-ruby.org/api-doc/#{GraphQL::VERSION}/GraphQL/Schema.html#allow_legacy_invalid_empty_selections_on_union-class_method"
        stdout, _stderr = capture_io do
          assert_equal [], errors
        end
        assert_includes stdout, expected_warning
      end
    end

    describe "When the schema has legacy mode disabled" do
      let(:schema) { Class.new(Dummy::Schema) {
          allow_legacy_invalid_empty_selections_on_union(false)
        }
      }

      it "requires some" do
        expected_err = "Field must have selections (field 'searchDairy' returns DairyProduct but has no selections. Did you mean 'searchDairy { ... }'?)"
        assert_includes(errors.map { |e| e["message"] }, expected_err)
      end
    end

    describe "With inherited setting" do
      let(:schema) { Class.new(Class.new(Dummy::Schema) {
          allow_legacy_invalid_empty_selections_on_union(true)
        })
      }

      it "has correct value" do
        assert schema.allow_legacy_invalid_empty_selections_on_union
      end
    end
  end
end