sorbet-runtime 0.5.6336 → 0.5.6351

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b81aa820085c3f82ab984100ffa4eca33fc67ed314655818113d3af1968f7af
-  data.tar.gz: c8fc6e0885c3a8851e0a68f55dccda195006b1745c9d55dbb872723fc07c39b5
+  metadata.gz: d598bc133cb90dc719b9072e14eb5bc578c679694887ee98e657571d85a46d2a
+  data.tar.gz: 7c718728dfb154109f628a36566bf7fa85ca3d8df7f379a391344863e520fa63
 SHA512:
-  metadata.gz: acd340a1290ddba91e093fe315f25bf0e17f4648faf0fe0bfee7c09f3e1793ca7ff8832eb9fa5d880215fba349c2c4bb8512d3825dc5b4741bdc79cd92dc5928
-  data.tar.gz: d8297b731b4d5dfab1566092c53ae78e9db20d9a0fc9a7e51bf9d59f36b4361095df0d19ccd74ba6153e9145545e2cd5535515440e88a7529978a5700e05c739
+  metadata.gz: 10c9194b02d89b13d546bcf3a9e2ca6e4e1d3d0b7225e1f4b3d17d7fb8f599a3e5f55815fd36997d86ad4834c531674befe7e224dcf8697b3f856c173812f78c
+  data.tar.gz: 184e4212a39731ae43f29a4120505c9d0f4b974d1a8ec9dba015b804f57c1ec17fceebefafd260aaca32fd08600cdf7f8a9b723248d5535e8397639ff520783d

data/lib/types/configuration.rb

@@ -433,6 +433,22 @@ module T::Configuration
     @sensitivity_and_pii_handler
   end
 
+  @redaction_handler = nil
+  # Set to a redaction handling function. This will be called when the
+  # `_redacted` version of a prop reader is used. By default this is set to
+  # `nil` and will raise an exception when the redacted version of a prop is
+  # accessed.
+  #
+  # @param [Lambda, Proc, nil] value Proc that converts a value into its
+  # redacted version according to the spec passed as the second argument.
+  def self.redaction_handler=(handler)
+    @redaction_handler = handler
+  end
+
+  def self.redaction_handler
+    @redaction_handler
+  end
+
   # Set to a function which can get the 'owner' of a class. This is
   # used in reporting deserialization errors
   #

data/lib/types/private/final.rb

@@ -37,7 +37,6 @@ module T::Private::Final
     mod.extend(mod.is_a?(Class) ? NoInherit : NoIncludeExtend)
     mark_as_final_module(mod)
     mark_as_final_module(mod.singleton_class)
-    T::Private::Methods.add_module_with_final(mod)
     T::Private::Methods.install_hooks(mod)
   end
 

data/lib/types/private/methods/_methods.rb

@@ -6,22 +6,21 @@ module T::Private::Methods
   @signatures_by_method = {}
   @sig_wrappers = {}
   @sigs_that_raised = {}
-  # the info about whether a method is final is not stored in a DeclBuilder nor a Signature, but instead right here.
-  # this is because final checks are special:
-  # - they are done possibly before any sig block has run.
-  # - they are done even if the method being defined doesn't have a sig.
-  @final_methods = Set.new
   # stores method names that were declared final without regard for where.
   # enables early rejection of names that we know can't induce final method violations.
   @was_ever_final_names = Set.new
-  # a non-singleton is a module for which at least one of the following is true:
-  # - is declared final
-  # - defines a method that is declared final
-  # - includes an non-singleton
-  # - extends an non-singleton
-  # a singleton is the singleton_class of a non-singleton.
-  # modules_with_final is the set of singletons and non-singletons.
-  @modules_with_final = Set.new
+  # maps from modules to the set of final methods declared in that module.
+  # we also overload entries slightly: if the value is nil, that means that the
+  # module has final methods somewhere along its ancestor chain, but does not itself
+  # have any final methods.
+  #
+  # we need the latter information to know whether we need to check along the ancestor
+  # chain for final method violations.  we need the former information because we
+  # care about exactly where a final method is defined (e.g. including the same module
+  # twice is permitted).  we could do this with two tables, but it seems slightly
+  # cleaner with a single table.
+  # Effectively T::Hash[Module, T.nilable(Set))]
+  @modules_with_final = Hash.new { |hash, key| hash[key] = nil }
   # this stores the old [included, extended] hooks for Module and inherited hook for Class that we override when
   # enabling final checks for when those hooks are called. the 'hooks' here don't have anything to do with the 'hooks'
   # in installed_hooks.
@@ -99,80 +98,86 @@ module T::Private::Methods
   # when target includes a module with instance methods source_method_names, ensure there is zero intersection between
   # the final instance methods of target and source_method_names. so, for every m in source_method_names, check if there
   # is already a method defined on one of target_ancestors with the same name that is final.
-  def self._check_final_ancestors(target, target_ancestors, source_method_names)
-    if !module_with_final?(target)
-      return
-    end
-    source_method_names.select! do |method_name|
-      was_ever_final?(method_name)
-    end
-    if source_method_names.empty?
-      return
-    end
-    # use reverse_each to check farther-up ancestors first, for better error messages. we could avoid this if we were on
-    # the version of ruby that adds the optional argument to method_defined? that allows you to exclude ancestors.
+  #
+  # we assume that source_method_names has already been filtered to only include method
+  # names that were declared final at one point.
+  def self._check_final_ancestors(target, target_ancestors, source_method_names, source)
+    source_ancestors = nil
+    # use reverse_each to check farther-up ancestors first, for better error messages.
     target_ancestors.reverse_each do |ancestor|
-      next if !module_with_final?(ancestor)
+      final_methods = @modules_with_final.fetch(ancestor, nil)
+      # In this case, either ancestor didn't have any final methods anywhere in its
+      # ancestor chain, or ancestor did have final methods somewhere in its ancestor
+      # chain, but no final methods defined in ancestor itself.  Either way, there
+      # are no final methods to check here, so we can move on to the next ancestor.
+      next unless final_methods
       source_method_names.each do |method_name|
-        # the usage of method_owner_and_name_to_key(ancestor, method_name) instead of
-        # method_to_key(ancestor.instance_method(method_name)) is not (just) an optimization, but also required for
-        # correctness, since ancestor.method_defined?(method_name) may return true even if method_name is not defined
-        # directly on ancestor but instead an ancestor of ancestor.
-        if final_method?(method_owner_and_name_to_key(ancestor, method_name))
-          definition_file, definition_line = T::Private::Methods.signature_for_method(ancestor.instance_method(method_name)).method.source_location
-          is_redefined = target == ancestor
-          caller_loc = caller_locations&.find {|l| !l.to_s.match?(%r{sorbet-runtime[^/]*/lib/}) }
-          extra_info = "\n"
-          if caller_loc
-            extra_info = (is_redefined ? "Redefined" : "Overridden") + " here: #{caller_loc.path}:#{caller_loc.lineno}\n"
+        next unless final_methods.include?(method_name)
+
+        # If we get here, we are defining a method that some ancestor declared as
+        # final.  however, we permit a final method to be defined multiple
+        # times if it is the same final method being defined each time.
+        if source
+          if !source_ancestors
+            source_ancestors = source.ancestors
+            # filter out things without actual final methods just to make sure that
+            # the below checks (which should be uncommon) go as quickly as possible.
+            source_ancestors.select! do |a|
+              @modules_with_final.fetch(a, nil)
+            end
           end
-
-          error_message = "The method `#{method_name}` on #{ancestor} was declared as final and cannot be " +
-                          (is_redefined ? "redefined" : "overridden in #{target}")
-          pretty_message = "#{error_message}\n" \
-                           "Made final here: #{definition_file}:#{definition_line}\n" \
-                           "#{extra_info}"
-
-          begin
-            raise pretty_message
-          rescue => e
-            # sig_validation_error_handler raises by default; on the off chance that
-            # it doesn't raise, we need to ensure that the rest of signature building
-            # sees a consistent state.  This sig failed to validate, so we should get
-            # rid of it.  If we don't do this, errors of the form "You called sig
-            # twice without declaring a method in between" will non-deterministically
-            # crop up in tests.
-            T::Private::DeclState.current.reset!
-            T::Configuration.sig_validation_error_handler(e, {})
+          # final-ness means that there should be no more than one index for which
+          # the below block returns true.
+          defining_ancestor_idx = source_ancestors.index do |a|
+            @modules_with_final.fetch(a).include?(method_name)
           end
+          next if defining_ancestor_idx && source_ancestors[defining_ancestor_idx] == ancestor
         end
-      end
-    end
-  end
-
-  private_class_method def self.add_final_method(method_key)
-    @final_methods.add(method_key)
-  end
 
-  private_class_method def self.final_method?(method_key)
-    @final_methods.include?(method_key)
-  end
-
-  private_class_method def self.add_was_ever_final(method_name)
-    @was_ever_final_names.add(method_name)
-  end
+        definition_file, definition_line = T::Private::Methods.signature_for_method(ancestor.instance_method(method_name)).method.source_location
+        is_redefined = target == ancestor
+        caller_loc = caller_locations&.find {|l| !l.to_s.match?(%r{sorbet-runtime[^/]*/lib/}) }
+        extra_info = "\n"
+        if caller_loc
+          extra_info = (is_redefined ? "Redefined" : "Overridden") + " here: #{caller_loc.path}:#{caller_loc.lineno}\n"
+        end
 
-  private_class_method def self.was_ever_final?(method_name)
-    @was_ever_final_names.include?(method_name)
+        error_message = "The method `#{method_name}` on #{ancestor} was declared as final and cannot be " +
+                        (is_redefined ? "redefined" : "overridden in #{target}")
+        pretty_message = "#{error_message}\n" \
+                         "Made final here: #{definition_file}:#{definition_line}\n" \
+                         "#{extra_info}"
+
+        begin
+          raise pretty_message
+        rescue => e
+          # sig_validation_error_handler raises by default; on the off chance that
+          # it doesn't raise, we need to ensure that the rest of signature building
+          # sees a consistent state.  This sig failed to validate, so we should get
+          # rid of it.  If we don't do this, errors of the form "You called sig
+          # twice without declaring a method in between" will non-deterministically
+          # crop up in tests.
+          T::Private::DeclState.current.reset!
+          T::Configuration.sig_validation_error_handler(e, {})
+        end
+      end
+    end
   end
 
-  def self.add_module_with_final(mod)
-    @modules_with_final.add(mod)
-    @modules_with_final.add(mod.singleton_class)
+  def self.add_module_with_final_method(mod, method_name, is_singleton_method)
+    m = is_singleton_method ? mod.singleton_class : mod
+    methods = @modules_with_final[m]
+    if methods.nil?
+      methods = Set.new
+      @modules_with_final[m] = methods
+    end
+    methods.add(method_name)
   end
 
-  private_class_method def self.module_with_final?(mod)
-    @modules_with_final.include?(mod)
+  def self.note_module_deals_with_final(mod)
+    # Side-effectfully initialize the value if it's not already there
+    @modules_with_final[mod]
+    @modules_with_final[mod.singleton_class]
   end
 
   # Only public because it needs to get called below inside the replace_method blocks below.
@@ -187,11 +192,14 @@ module T::Private::Methods
     if T::Private::Final.final_module?(mod) && (current_declaration.nil? || !current_declaration.final)
       raise "#{mod} was declared as final but its method `#{method_name}` was not declared as final"
     end
-    _check_final_ancestors(mod, mod.ancestors, [method_name])
+    # Don't compute mod.ancestors if we don't need to bother checking final-ness.
+    if @was_ever_final_names.include?(method_name) && @modules_with_final.include?(mod)
+      _check_final_ancestors(mod, mod.ancestors, [method_name], nil)
+      # We need to fetch the active declaration again, as _check_final_ancestors
+      # may have reset it (see the comment in that method for details).
+      current_declaration = T::Private::DeclState.current.active_declaration
+    end
 
-    # We need to fetch the active declaration again, as _check_final_ancestors
-    # may have reset it (see the comment in that method for details).
-    current_declaration = T::Private::DeclState.current.active_declaration
     if current_declaration.nil?
       return
     end
@@ -213,9 +221,9 @@ module T::Private::Methods
     # which is called only on the *first* invocation.
     # This wrapper is very slow, so it will subsequently re-wrap with a much faster wrapper
     # (or unwrap back to the original method).
-    new_method = nil
+    key = method_owner_and_name_to_key(mod, method_name)
     T::Private::ClassUtils.replace_method(mod, method_name) do |*args, &blk|
-      method_sig = T::Private::Methods.maybe_run_sig_block_for_method(new_method)
+      method_sig = T::Private::Methods.maybe_run_sig_block_for_key(key)
       method_sig ||= T::Private::Methods._handle_missing_method_signature(
         self,
         original_method,
@@ -242,15 +250,13 @@ module T::Private::Methods
       end
     end
 
-    new_method = mod.instance_method(method_name)
-    key = method_to_key(new_method)
     @sig_wrappers[key] = sig_block
     if current_declaration.final
-      add_final_method(key)
-      add_was_ever_final(method_name)
+      @was_ever_final_names.add(method_name)
       # use hook_mod, not mod, because for example, we want class C to be marked as having final if we def C.foo as
       # final. change this to mod to see some final_method tests fail.
-      add_module_with_final(hook_mod)
+      note_module_deals_with_final(hook_mod)
+      add_module_with_final_method(hook_mod, method_name, is_singleton_method)
     end
   end
 
@@ -382,7 +388,8 @@ module T::Private::Methods
     maybe_run_sig_block_for_key(method_to_key(method))
   end
 
-  private_class_method def self.maybe_run_sig_block_for_key(key)
+  # Only public so that it can be accessed in the closure for _on_method_added
+  def self.maybe_run_sig_block_for_key(key)
     run_sig_block_for_key(key) if has_sig_block_for_key(key)
   end
 
@@ -426,15 +433,28 @@ module T::Private::Methods
 
   # the module target is adding the methods from the module source to itself. we need to check that for all instance
   # methods M on source, M is not defined on any of target's ancestors.
-  def self._hook_impl(target, target_ancestors, source)
-    if !module_with_final?(target) && !module_with_final?(source)
-      return
-    end
+  def self._hook_impl(target, singleton_class, source)
     # we do not need to call add_was_ever_final here, because we have already marked
     # any such methods when source was originally defined.
-    add_module_with_final(target)
-    install_hooks(target)
-    _check_final_ancestors(target, target_ancestors - source.ancestors, source.instance_methods)
+    if !@modules_with_final.include?(target)
+      if !@modules_with_final.include?(source)
+        return
+      end
+      note_module_deals_with_final(target)
+      install_hooks(target)
+      return
+    end
+
+    methods = source.instance_methods
+    methods.select! do |method_name|
+      @was_ever_final_names.include?(method_name)
+    end
+    if methods.empty?
+      return
+    end
+
+    target_ancestors = singleton_class ? target.singleton_class.ancestors : target.ancestors
+    _check_final_ancestors(target, target_ancestors, methods, source)
   end
 
   def self.set_final_checks_on_hooks(enable)
@@ -448,15 +468,15 @@ module T::Private::Methods
     else
       old_included = T::Private::ClassUtils.replace_method(Module, :included) do |arg|
         old_included.bind(self).call(arg)
-        ::T::Private::Methods._hook_impl(arg, arg.ancestors, self)
+        ::T::Private::Methods._hook_impl(arg, false, self)
       end
       old_extended = T::Private::ClassUtils.replace_method(Module, :extended) do |arg|
         old_extended.bind(self).call(arg)
-        ::T::Private::Methods._hook_impl(arg, arg.singleton_class.ancestors, self)
+        ::T::Private::Methods._hook_impl(arg, true, self)
       end
       old_inherited = T::Private::ClassUtils.replace_method(Class, :inherited) do |arg|
         old_inherited.bind(self).call(arg)
-        ::T::Private::Methods._hook_impl(arg, arg.ancestors, self)
+        ::T::Private::Methods._hook_impl(arg, false, self)
       end
       @old_hooks = [old_included, old_extended, old_inherited]
     end

data/lib/types/props/decorator.rb

@@ -449,8 +449,11 @@ class T::Props::Decorator
 
     @class.send(:define_method, redacted_method) do
       value = self.public_send(prop_name)
-      Chalk::Tools::RedactionUtils.redact_with_directive(
-        value, redaction)
+      handler = T::Configuration.redaction_handler
+      if !handler
+        raise "Using `redaction:` on a prop requires specifying `T::Configuration.redaction_handler`"
+      end
+      handler.call(value, redaction)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sorbet-runtime
 version: !ruby/object:Gem::Version
-  version: 0.5.6336
+  version: 0.5.6351
 platform: ruby
 authors:
 - Stripe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-11 00:00:00.000000000 Z
+date: 2021-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest