File: warden.rb

package info (click to toggle)
ruby-graphql 2.2.17-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 9,584 kB
  • sloc: ruby: 67,505; ansic: 1,753; yacc: 831; javascript: 331; makefile: 6
file content (472 lines) | stat: -rw-r--r-- 18,851 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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
# frozen_string_literal: true

require 'set'

module GraphQL
  class Schema
    # Restrict access to a {GraphQL::Schema} with a user-defined `visible?` implementations.
    #
    # When validating and executing a query, all access to schema members
    # should go through a warden. If you access the schema directly,
    # you may show a client something that it shouldn't be allowed to see.
    #
    # @api private
    class Warden
      def self.from_context(context)
        context.warden || PassThruWarden
      rescue NoMethodError
        # this might be a hash which won't respond to #warden
        PassThruWarden
      end

      # @param visibility_method [Symbol] a Warden method to call for this entry
      # @param entry [Object, Array<Object>] One or more definitions for a given name in a GraphQL Schema
      # @param context [GraphQL::Query::Context]
      # @param warden [Warden]
      # @return [Object] `entry` or one of `entry`'s items if exactly one of them is visible for this context
      # @return [nil] If neither `entry` nor any of `entry`'s items are visible for this context
      def self.visible_entry?(visibility_method, entry, context, warden = Warden.from_context(context))
        if entry.is_a?(Array)
          visible_item = nil
          entry.each do |item|
            if warden.public_send(visibility_method, item, context)
              if visible_item.nil?
                visible_item = item
              else
                raise DuplicateNamesError.new(
                  duplicated_name: item.path, duplicated_definition_1: visible_item.inspect, duplicated_definition_2: item.inspect
                )
              end
            end
          end
          visible_item
        elsif warden.public_send(visibility_method, entry, context)
          entry
        else
          nil
        end
      end

      # This is used when a caller provides a Hash for context.
      # We want to call the schema's hooks, but we don't have a full-blown warden.
      # The `context` arguments to these methods exist purely to simplify the code that
      # calls methods on this object, so it will have everything it needs.
      class PassThruWarden
        class << self
          def visible_field?(field, ctx); field.visible?(ctx); end
          def visible_argument?(arg, ctx); arg.visible?(ctx); end
          def visible_type?(type, ctx); type.visible?(ctx); end
          def visible_enum_value?(ev, ctx); ev.visible?(ctx); end
          def visible_type_membership?(tm, ctx); tm.visible?(ctx); end
          def interface_type_memberships(obj_t, ctx); obj_t.interface_type_memberships; end
          def arguments(owner, ctx); owner.arguments(ctx); end
          def loadable?(type, ctx); type.visible?(ctx); end
        end
      end

      class NullWarden
        def initialize(_filter = nil, context:, schema:)
          @schema = schema
        end

        def visible_field?(field_defn, _ctx = nil, owner = nil); true; end
        def visible_argument?(arg_defn, _ctx = nil); true; end
        def visible_type?(type_defn, _ctx = nil); true; end
        def visible_enum_value?(enum_value, _ctx = nil); true; end
        def visible_type_membership?(type_membership, _ctx = nil); true; end
        def interface_type_memberships(obj_type, _ctx = nil); obj_type.interface_type_memberships; end
        def get_type(type_name); @schema.get_type(type_name); end # rubocop:disable Development/ContextIsPassedCop
        def arguments(argument_owner, ctx = nil); argument_owner.all_argument_definitions; end
        def enum_values(enum_defn); enum_defn.enum_values; end # rubocop:disable Development/ContextIsPassedCop
        def get_argument(parent_type, argument_name); parent_type.get_argument(argument_name); end # rubocop:disable Development/ContextIsPassedCop
        def types; @schema.types; end # rubocop:disable Development/ContextIsPassedCop
        def root_type_for_operation(op_name); @schema.root_type_for_operation(op_name); end
        def directives; @schema.directives.values; end
        def fields(type_defn); type_defn.all_field_definitions; end # rubocop:disable Development/ContextIsPassedCop
        def get_field(parent_type, field_name); @schema.get_field(parent_type, field_name); end
        def reachable_type?(type_name); true; end
        def loadable?(type, _ctx); true; end
        def reachable_types; @schema.types.values; end # rubocop:disable Development/ContextIsPassedCop
        def possible_types(type_defn); @schema.possible_types(type_defn); end
        def interfaces(obj_type); obj_type.interfaces; end
      end

      # @param context [GraphQL::Query::Context]
      # @param schema [GraphQL::Schema]
      def initialize(context:, schema:)
        @schema = schema
        # Cache these to avoid repeated hits to the inheritance chain when one isn't present
        @query = @schema.query
        @mutation = @schema.mutation
        @subscription = @schema.subscription
        @context = context
        @visibility_cache = read_through { |m| schema.visible?(m, context) }
        @visibility_cache.compare_by_identity
        # Initialize all ivars to improve object shape consistency:
        @types = @visible_types = @reachable_types = @visible_parent_fields =
          @visible_possible_types = @visible_fields = @visible_arguments = @visible_enum_arrays =
          @visible_enum_values = @visible_interfaces = @type_visibility = @type_memberships =
          @visible_and_reachable_type = @unions = @unfiltered_interfaces =
          @reachable_type_set =
            nil
      end

      # @return [Hash<String, GraphQL::BaseType>] Visible types in the schema
      def types
        @types ||= begin
          vis_types = {}
          @schema.types(@context).each do |n, t|
            if visible_and_reachable_type?(t)
              vis_types[n] = t
            end
          end
          vis_types
        end
      end

      # @return [Boolean] True if this type is used for `loads:` but not in the schema otherwise and not _explicitly_ hidden.
      def loadable?(type, _ctx)
        !reachable_type_set.include?(type) && visible_type?(type)
      end

      # @return [GraphQL::BaseType, nil] The type named `type_name`, if it exists (else `nil`)
      def get_type(type_name)
        @visible_types ||= read_through do |name|
          type_defn = @schema.get_type(name, @context)
          if type_defn && visible_and_reachable_type?(type_defn)
            type_defn
          else
            nil
          end
        end

        @visible_types[type_name]
      end

      # @return [Array<GraphQL::BaseType>] Visible and reachable types in the schema
      def reachable_types
        @reachable_types ||= reachable_type_set.to_a
      end

      # @return Boolean True if the type is visible and reachable in the schema
      def reachable_type?(type_name)
        type = get_type(type_name) # rubocop:disable Development/ContextIsPassedCop -- `self` is query-aware
        type && reachable_type_set.include?(type)
      end

      # @return [GraphQL::Field, nil] The field named `field_name` on `parent_type`, if it exists
      def get_field(parent_type, field_name)
        @visible_parent_fields ||= read_through do |type|
          read_through do |f_name|
            field_defn = @schema.get_field(type, f_name, @context)
            if field_defn && visible_field?(field_defn, nil, type)
              field_defn
            else
              nil
            end
          end
        end

        @visible_parent_fields[parent_type][field_name]
      end

      # @return [GraphQL::Argument, nil] The argument named `argument_name` on `parent_type`, if it exists and is visible
      def get_argument(parent_type, argument_name)
        argument = parent_type.get_argument(argument_name, @context)
        return argument if argument && visible_argument?(argument, @context)
      end

      # @return [Array<GraphQL::BaseType>] The types which may be member of `type_defn`
      def possible_types(type_defn)
        @visible_possible_types ||= read_through { |type_defn|
          pt = @schema.possible_types(type_defn, @context)
          pt.select { |t| visible_and_reachable_type?(t) }
        }
        @visible_possible_types[type_defn]
      end

      # @param type_defn [GraphQL::ObjectType, GraphQL::InterfaceType]
      # @return [Array<GraphQL::Field>] Fields on `type_defn`
      def fields(type_defn)
        @visible_fields ||= read_through { |t| @schema.get_fields(t, @context).values }
        @visible_fields[type_defn]
      end

      # @param argument_owner [GraphQL::Field, GraphQL::InputObjectType]
      # @return [Array<GraphQL::Argument>] Visible arguments on `argument_owner`
      def arguments(argument_owner, ctx = nil)
        @visible_arguments ||= read_through { |o|
          args = o.arguments(@context)
          if args.any?
            args = args.values
            args.select! { |a| visible_argument?(a, @context) }
            args
          else
            EmptyObjects::EMPTY_ARRAY
          end
        }
        @visible_arguments[argument_owner]
      end

      # @return [Array<GraphQL::EnumType::EnumValue>] Visible members of `enum_defn`
      def enum_values(enum_defn)
        @visible_enum_arrays ||= read_through { |e|
          values = e.enum_values(@context)
          if values.size == 0
            raise GraphQL::Schema::Enum::MissingValuesError.new(e)
          end
          values
        }
        @visible_enum_arrays[enum_defn]
      end

      def visible_enum_value?(enum_value, _ctx = nil)
        @visible_enum_values ||= read_through { |ev| visible?(ev) }
        @visible_enum_values[enum_value]
      end

      # @return [Array<GraphQL::InterfaceType>] Visible interfaces implemented by `obj_type`
      def interfaces(obj_type)
        @visible_interfaces ||= read_through { |t|
          ints = t.interfaces(@context)
          if ints.any?
            ints.select! { |i| visible_type?(i) }
          end
          ints
        }
        @visible_interfaces[obj_type]
      end

      def directives
        @schema.directives.each_value.select { |d| visible?(d) }
      end

      def root_type_for_operation(op_name)
        root_type = @schema.root_type_for_operation(op_name)
        if root_type && visible?(root_type)
          root_type
        else
          nil
        end
      end

      # @param owner [Class, Module] If provided, confirm that field has the given owner.
      def visible_field?(field_defn, _ctx = nil, owner = field_defn.owner)
        # This field is visible in its own right
        visible?(field_defn) &&
          # This field's return type is visible
          visible_and_reachable_type?(field_defn.type.unwrap) &&
          # This field is either defined on this object type,
          # or the interface it's inherited from is also visible
          ((field_defn.respond_to?(:owner) && field_defn.owner == owner) || field_on_visible_interface?(field_defn, owner))
      end

      def visible_argument?(arg_defn, _ctx = nil)
        visible?(arg_defn) && visible_and_reachable_type?(arg_defn.type.unwrap)
      end

      def visible_type?(type_defn, _ctx = nil)
        @type_visibility ||= read_through { |type_defn| visible?(type_defn) }
        @type_visibility[type_defn]
      end

      def visible_type_membership?(type_membership, _ctx = nil)
        visible?(type_membership)
      end

      def interface_type_memberships(obj_type, _ctx = nil)
        @type_memberships ||= read_through do |obj_t|
          obj_t.interface_type_memberships
        end
        @type_memberships[obj_type]
      end

      private

      def visible_and_reachable_type?(type_defn)
        @visible_and_reachable_type ||= read_through do |type_defn|
          next false unless visible_type?(type_defn)
          next true if root_type?(type_defn) || type_defn.introspection?

          if type_defn.kind.union?
            possible_types(type_defn).any? && (referenced?(type_defn) || orphan_type?(type_defn))
          elsif type_defn.kind.interface?
            if possible_types(type_defn).any?
              true
            else
              if @context.respond_to?(:logger) && (logger = @context.logger)
                logger.debug { "Interface `#{type_defn.graphql_name}` hidden because it has no visible implementors" }
              end
              false
            end
          else
            if referenced?(type_defn)
              true
            elsif type_defn.kind.object?
              # Show this object if it belongs to ...
              interfaces(type_defn).any? { |t| referenced?(t) } ||  # an interface which is referenced in the schema
                union_memberships(type_defn).any? { |t| referenced?(t) || orphan_type?(t) } # or a union which is referenced or added via orphan_types
            else
              false
            end
          end
        end

        @visible_and_reachable_type[type_defn]
      end

      def union_memberships(obj_type)
        @unions ||= read_through { |obj_type| @schema.union_memberships(obj_type).select { |u| visible?(u) } }
        @unions[obj_type]
      end

      # We need this to tell whether a field was inherited by an interface
      # even when that interface is hidden from `#interfaces`
      def unfiltered_interfaces(type_defn)
        @unfiltered_interfaces ||= read_through(&:interfaces)
        @unfiltered_interfaces[type_defn]
      end

      # If this field was inherited from an interface, and the field on that interface is _hidden_,
      # then treat this inherited field as hidden.
      # (If it _wasn't_ inherited, then don't hide it for this reason.)
      def field_on_visible_interface?(field_defn, type_defn)
        if type_defn.kind.object?
          any_interface_has_field = false
          any_interface_has_visible_field = false
          ints = unfiltered_interfaces(type_defn)
          ints.each do |interface_type|
            if (iface_field_defn = interface_type.get_field(field_defn.graphql_name, @context))
              any_interface_has_field = true

              if interfaces(type_defn).include?(interface_type) && visible_field?(iface_field_defn, nil, interface_type)
                any_interface_has_visible_field = true
              end
            end
          end

          if any_interface_has_field
            any_interface_has_visible_field
          else
            # it's the object's own field
            true
          end
        else
          true
        end
      end

      def root_type?(type_defn)
        @query == type_defn ||
          @mutation == type_defn ||
          @subscription == type_defn
      end

      def referenced?(type_defn)
        graphql_name = type_defn.unwrap.graphql_name
        members = @schema.references_to(graphql_name)
        members.any? { |m| visible?(m) }
      end

      def orphan_type?(type_defn)
        @schema.orphan_types.include?(type_defn)
      end

      def visible?(member)
        @visibility_cache[member]
      end

      def read_through
        h = Hash.new { |h, k| h[k] = yield(k) }
        h.compare_by_identity
        h
      end

      def reachable_type_set
        return @reachable_type_set if @reachable_type_set

        @reachable_type_set = Set.new
        rt_hash = {}

        unvisited_types = []
        ['query', 'mutation', 'subscription'].each do |op_name|
          root_type = root_type_for_operation(op_name)
          unvisited_types << root_type if root_type
        end
        unvisited_types.concat(@schema.introspection_system.types.values)

        directives.each do |dir_class|
          arguments(dir_class).each do |arg_defn|
            arg_t = arg_defn.type.unwrap
            if get_type(arg_t.graphql_name) # rubocop:disable Development/ContextIsPassedCop -- `self` is query-aware
              unvisited_types << arg_t
            end
          end
        end

        @schema.orphan_types.each do |orphan_type|
          if get_type(orphan_type.graphql_name) == orphan_type # rubocop:disable Development/ContextIsPassedCop -- `self` is query-aware
            unvisited_types << orphan_type
          end
        end

        included_interface_possible_types_set = Set.new

        until unvisited_types.empty?
          type = unvisited_types.pop
          visit_type(type, unvisited_types, @reachable_type_set, rt_hash, included_interface_possible_types_set, include_interface_possible_types: false)
        end

        @reachable_type_set
      end

      def visit_type(type, unvisited_types, visited_type_set, type_by_name_hash, included_interface_possible_types_set, include_interface_possible_types:)
        if visited_type_set.add?(type) || (include_interface_possible_types && type.kind.interface? && included_interface_possible_types_set.add?(type))
          type_by_name = type_by_name_hash[type.graphql_name] ||= type
          if type_by_name != type
            name_1, name_2 = [type.inspect, type_by_name.inspect].sort
            raise DuplicateNamesError.new(
              duplicated_name: type.graphql_name, duplicated_definition_1: name_1, duplicated_definition_2: name_2
            )
          end
          if type.kind.input_object?
            # recurse into visible arguments
            arguments(type).each do |argument|
              argument_type = argument.type.unwrap
              unvisited_types << argument_type
            end
          elsif type.kind.union?
            # recurse into visible possible types
            possible_types(type).each do |possible_type|
              unvisited_types << possible_type
            end
          elsif type.kind.fields?
            if type.kind.object?
              # recurse into visible implemented interfaces
              interfaces(type).each do |interface|
                unvisited_types << interface
              end
            elsif include_interface_possible_types
              possible_types(type).each do |pt|
                unvisited_types << pt
              end
            end
            # Don't visit interface possible types -- it's not enough to justify visibility

            # recurse into visible fields
            fields(type).each do |field|
              field_type = field.type.unwrap
              # In this case, if it's an interface, we want to include
              visit_type(field_type, unvisited_types, visited_type_set, type_by_name_hash, included_interface_possible_types_set, include_interface_possible_types: true)
              # recurse into visible arguments
              arguments(field).each do |argument|
                argument_type = argument.type.unwrap
                unvisited_types << argument_type
              end
            end
          end
        end
      end
    end
  end
end