Skip to content

Commit 30747e5

Browse files
authored
Merge pull request #4424 from rmosolgo/filter-deprecation
Add deprecation warning to GraphQL::Filter
2 parents cb8a6f9 + d2ab8c2 commit 30747e5

File tree

4 files changed

+10
-5
lines changed

4 files changed

+10
-5
lines changed

lib/graphql/filter.rb

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
# frozen_string_literal: true
2+
require "graphql/deprecation"
3+
24
module GraphQL
35
# @api private
46
class Filter
5-
def initialize(only: nil, except: nil)
7+
def initialize(only: nil, except: nil, silence_deprecation_warning: false)
8+
if !silence_deprecation_warning
9+
GraphQL::Deprecation.warn("GraphQL::Filter is deprecated and will be removed in v2.1.0. Implement `visible?` on your schema members instead (https://graphql-ruby.org/authorization/visibility.html).")
10+
end
611
@only = only
712
@except = except
813
end
@@ -17,7 +22,7 @@ def merge(only: nil, except: nil)
1722
onlies = [self].concat(Array(only))
1823
merged_only = MergedOnly.build(onlies)
1924
merged_except = MergedExcept.build(Array(except))
20-
self.class.new(only: merged_only, except: merged_except)
25+
self.class.new(only: merged_only, except: merged_except, silence_deprecation_warning: true)
2126
end
2227

2328
private

lib/graphql/language/document_from_schema_definition.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ def initialize(
2424
@include_built_in_directives = include_built_in_directives
2525
@include_one_of = false
2626

27-
filter = GraphQL::Filter.new(only: only, except: except)
27+
filter = GraphQL::Filter.new(only: only, except: except, silence_deprecation_warning: true)
2828
if @schema.respond_to?(:visible?)
2929
filter = filter.merge(only: @schema.method(:visible?))
3030
end

lib/graphql/query/null_context.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ def initialize
2424
@dataloader = GraphQL::Dataloader::NullDataloader.new
2525
@schema = NullSchema
2626
@warden = NullWarden.new(
27-
GraphQL::Filter.new,
27+
GraphQL::Filter.new(silence_deprecation_warning: true),
2828
context: self,
2929
schema: @schema,
3030
)

lib/graphql/schema.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ def find(path)
221221
end
222222

223223
def default_filter
224-
GraphQL::Filter.new(except: default_mask)
224+
GraphQL::Filter.new(except: default_mask, silence_deprecation_warning: true)
225225
end
226226

227227
def default_mask(new_mask = nil)

0 commit comments

Comments
 (0)