thread_weaver 0.1.0

data/lib/thread_weaver/iterative_race_detector.rb

@@ -0,0 +1,178 @@
+# typed: strict
+
+module ThreadWeaver
+  class RaceConditionDetectedError < Error; end
+
+  class DeadlockDetectedError < Error; end
+
+  class BlockingSynchronizationDetected < Error; end
+
+  DEADLOCK_MIGHT_BE_CONFIG = T.let(
+    "Either there is a deadlock, or assume_deadlocked_after_ms is set too low. Try increasing "\
+    "assume_deadlocked_after_ms to a higher value.",
+    String
+  )
+
+  class IterativeRaceDetector
+    extend T::Sig
+
+    sig do
+      params(
+        setup: T.proc.returns(T.untyped),
+        run: T.proc.params(arg0: T.untyped).void,
+        check: T.proc.params(arg0: T.untyped).returns(T::Boolean),
+        target_classes: T::Array[Module],
+        assume_deadlocked_after_ms: Integer,
+        run_secondary: T.nilable(T.proc.params(arg0: T.untyped).void),
+        expect_nonblocking: T::Boolean
+      ).void
+    end
+    def initialize(setup:, run:, check:, target_classes:, assume_deadlocked_after_ms:, run_secondary: nil, expect_nonblocking: false)
+      @setup_blk = T.let(setup, T.proc.returns(T.untyped))
+      @check_blk = T.let(check, T.proc.params(arg0: T.untyped).returns(T::Boolean))
+      @target_classes = T.let(target_classes, T::Array[Module])
+      @expect_nonblocking = T.let(expect_nonblocking, T::Boolean)
+
+      @run_blk = T.let(run, T.proc.params(arg0: T.untyped).void)
+      # Secondary is optional as the common case will be testing two identical blocks of code
+      @run_secondary_blk = T.let(run_secondary || run, T.proc.params(arg0: T.untyped).void)
+
+      @assume_deadlocked_after = T.let(assume_deadlocked_after_ms / 1000.0, Float)
+
+      @scenarios_run = T.let(0, Integer)
+      @secondary_deadlocked_count = T.let(0, Integer)
+    end
+
+    sig { void }
+    def run
+      check_if_can_run_standalone(@run_blk, "run")
+      if @run_secondary_blk != @run_blk
+        check_if_can_run_standalone(@run_secondary_blk, "run_secondary")
+      end
+
+      hold_primary_at_line_count = -1
+      done = T.let(false, T::Boolean)
+
+      error_encountered = T.let(nil, T.nilable(Exception))
+
+      until done
+        Timeout.timeout(2 * @assume_deadlocked_after) do
+          hold_primary_at_line_count += 1
+
+          context = @setup_blk.call
+
+          primary_thread = ControllableThread.new(context, name: "primary_thread", &@run_blk)
+
+          # Pause the primary thread after it executes hold_primary_at_line_count number of lines
+          primary_thread.set_and_wait_for_next_instruction(
+            PauseWhenLineCount.new(
+              count: hold_primary_at_line_count,
+              target_classes: @target_classes
+            )
+          )
+
+          # Start secondary thread and instruct it to run until completion. The primary thread is
+          # still paused part-way through its execution
+          secondary_thread = ControllableThread.new(context, name: "secondary_thread", &@run_secondary_blk)
+          secondary_thread.set_next_instruction(ContinueToThreadEnd.new)
+
+          if check_for_deadlock(secondary_thread)
+            # At this point, it appears that the secondary thread is deadlocked. This could be
+            # because of a true deadlock, but this also is expected to happen even in thread-safe
+            # code that uses blocking locks. If blocking locks are used then its quite likely that
+            # pausing the primary thread at certain points might would block the secondary thread.
+            # For that reason, this isn't considered an outright error.
+            @secondary_deadlocked_count += 1
+            primary_thread.set_and_wait_for_next_instruction(ContinueToThreadEnd.new)
+
+            if @expect_nonblocking
+              error_encountered ||= BlockingSynchronizationDetected.new(
+                "Deadlock detected, but expect_nonblocking was set to true. Make sure you aren't "\
+                "blocking waiting for a lock."
+              )
+            end
+          end
+
+          # Wait for the secondary thread to complete, taking note of any errors
+          begin
+            secondary_thread.join
+          rescue => e
+            # Defer exception until after the primary thread gets a chance to join, to avoid leaking
+            # threads
+            error_encountered ||= e
+          end
+
+          # Only now that the secondary thread has completed, release the primary thread
+          primary_thread.set_and_wait_for_next_instruction(ContinueToThreadEnd.new)
+
+          begin
+            primary_thread.join
+            @scenarios_run += 1
+          rescue ThreadCompletedEarlyError
+            # ThreadCompletedEarlyError will occur if the primary thread never successfully paused
+            # at the specified location. This happens normally, when hold_primary_at_line_count is
+            # incremented until it exceeds the number of lines actually executed in the primary
+            # thread. Once that point is reached, the primary thread will never get caught on the
+            # PauseWhenLineCount instruction. ControllableThread signals failures to execute a given
+            # instruction by returning a ThreadCompletedEarlyError, which we use as a signal to stop
+            # probing for race conditions. When this happens, we have done a race condition check
+            # with the primary thread paused at every possible location in target_classes, assuming
+            # the code in question is deterministic, so there is nothing left to check.
+            done = true
+          end
+
+          # Now that both threads have had a chance to join, raise any errors discovered
+          raise error_encountered if error_encountered
+
+          check_passed = @check_blk.call(context)
+
+          unless check_passed
+            raise RaceConditionDetectedError.new("Test failed")
+          end
+        end
+      end
+
+      if @secondary_deadlocked_count == @scenarios_run
+        message = "In every scenario, the secondary thread was assumed deadlocked while the "\
+                  "primary thread was paused. #{DEADLOCK_MIGHT_BE_CONFIG}"
+        raise DeadlockDetectedError.new(message)
+      end
+    end
+
+    sig { params(blk: T.proc.params(arg0: T.untyped).void, name: String).void }
+    def check_if_can_run_standalone(blk, name)
+      context = @setup_blk.call
+      thread = ControllableThread.new(context, name: name, &blk)
+      thread.set_next_instruction(ContinueToThreadEnd.new)
+
+      if check_for_deadlock(thread)
+        thread.kill
+        message = "#{name} appears to be deadlocked when running alone, with no other concurrent "\
+                  "threads. #{DEADLOCK_MIGHT_BE_CONFIG}"
+
+        raise DeadlockDetectedError.new(message)
+      end
+
+      check_passed = @check_blk.call(context)
+
+      unless check_passed
+        message = "#{name} failed check when running alone, with no other concurrent threads. "\
+                  "Your check logic may be flawed."
+        raise RaceConditionDetectedError.new(message)
+      end
+    end
+
+    private
+
+    sig { params(thread: ControllableThread).returns(T::Boolean) }
+    def check_for_deadlock(thread)
+      started_at = Time.now
+
+      while thread.alive? && (Time.now - started_at) < @assume_deadlocked_after
+        Thread.pass
+      end
+
+      thread.alive?
+    end
+  end
+end

data/lib/thread_weaver/thread_instruction.rb

@@ -0,0 +1,68 @@
+# typed: strict
+
+module ThreadWeaver
+  module ThreadInstruction
+    extend T::Sig
+    extend T::Helpers
+    interface!
+    sealed!
+
+    sig { abstract.params(m: Module).returns(T::Boolean) }
+    def is_a?(m)
+    end
+  end
+
+  class PauseAtThreadStart < T::Struct
+    include ThreadInstruction
+  end
+
+  class ContinueToThreadEnd < T::Struct
+    include ThreadInstruction
+  end
+
+  class PauseWhenLineCount < T::Struct
+    include ThreadInstruction
+    extend T::Sig
+
+    const :count, Integer
+    const :target_classes, T::Array[Module]
+
+    sig { returns(PauseWhenLineCount) }
+    def next
+      PauseWhenLineCount.new(
+        count: count + 1,
+        target_classes: target_classes
+      )
+    end
+  end
+
+  class PauseAtMethodCall < T::Struct
+    include ThreadInstruction
+
+    const :klass, Class
+    const :method_name, Symbol
+  end
+
+  class PauseAtMethodReturn < T::Struct
+    include ThreadInstruction
+
+    const :klass, Class
+    const :method_name, Symbol
+  end
+
+  class PauseAtSourceLine < T::Struct
+    include ThreadInstruction
+    extend T::Sig
+
+    const :path_suffix, String
+    const :line, Integer
+
+    sig { returns(PauseAtSourceLine) }
+    def next
+      PauseAtSourceLine.new(
+        line: line + 1,
+        path_suffix: path_suffix
+      )
+    end
+  end
+end

data/lib/thread_weaver/version.rb

@@ -0,0 +1,6 @@
+# typed: strict
+# frozen_string_literal: true
+
+module ThreadWeaver
+  VERSION = "0.1.0"
+end

data/sorbet/config

@@ -0,0 +1,2 @@
+--dir
+.

data/sorbet/rbi/gems/ast.rbi

@@ -0,0 +1,48 @@
+# This file is autogenerated. Do not edit it by hand. Regenerate it with:
+#   srb rbi gems
+
+# typed: strict
+#
+# If you would like to make changes to this file, great! Please create the gem's shim here:
+#
+#   https://github.com/sorbet/sorbet-typed/new/master?filename=lib/ast/all/ast.rbi
+#
+# ast-2.4.1
+
+module AST
+end
+class AST::Node
+  def +(array); end
+  def <<(element); end
+  def ==(other); end
+  def append(element); end
+  def assign_properties(properties); end
+  def children; end
+  def clone; end
+  def concat(array); end
+  def dup; end
+  def eql?(other); end
+  def fancy_type; end
+  def hash; end
+  def initialize(type, children = nil, properties = nil); end
+  def inspect(indent = nil); end
+  def original_dup; end
+  def to_a; end
+  def to_ast; end
+  def to_s(indent = nil); end
+  def to_sexp(indent = nil); end
+  def to_sexp_array; end
+  def type; end
+  def updated(type = nil, children = nil, properties = nil); end
+end
+class AST::Processor
+  include AST::Processor::Mixin
+end
+module AST::Processor::Mixin
+  def handler_missing(node); end
+  def process(node); end
+  def process_all(nodes); end
+end
+module AST::Sexp
+  def s(type, *children); end
+end

data/sorbet/rbi/gems/coderay.rbi

@@ -0,0 +1,285 @@
+# This file is autogenerated. Do not edit it by hand. Regenerate it with:
+#   srb rbi gems
+
+# typed: true
+#
+# If you would like to make changes to this file, great! Please create the gem's shim here:
+#
+#   https://github.com/sorbet/sorbet-typed/new/master?filename=lib/coderay/all/coderay.rbi
+#
+# coderay-1.1.3
+
+module CodeRay
+  def self.coderay_path(*path); end
+  def self.encode(code, lang, format, options = nil); end
+  def self.encode_file(filename, format, options = nil); end
+  def self.encode_tokens(tokens, format, options = nil); end
+  def self.encoder(format, options = nil); end
+  def self.get_scanner_options(options); end
+  def self.highlight(code, lang, options = nil, format = nil); end
+  def self.highlight_file(filename, options = nil, format = nil); end
+  def self.scan(code, lang, options = nil, &block); end
+  def self.scan_file(filename, lang = nil, options = nil, &block); end
+  def self.scanner(lang, options = nil, &block); end
+end
+module CodeRay::FileType
+  def self.[](filename, read_shebang = nil); end
+  def self.fetch(filename, default = nil, read_shebang = nil); end
+  def self.type_from_shebang(filename); end
+end
+class CodeRay::FileType::UnknownFileType < Exception
+end
+class CodeRay::Tokens < Array
+  def begin_group(kind); end
+  def begin_line(kind); end
+  def count; end
+  def encode(encoder, options = nil); end
+  def end_group(kind); end
+  def end_line(kind); end
+  def method_missing(meth, options = nil); end
+  def scanner; end
+  def scanner=(arg0); end
+  def split_into_parts(*sizes); end
+  def text_token(*arg0); end
+  def to_s; end
+  def tokens(*arg0); end
+end
+class CodeRay::TokensProxy
+  def block; end
+  def block=(arg0); end
+  def each(*args, &blk); end
+  def encode(encoder, options = nil); end
+  def initialize(input, lang, options = nil, block = nil); end
+  def input; end
+  def input=(arg0); end
+  def lang; end
+  def lang=(arg0); end
+  def method_missing(method, *args, &blk); end
+  def options; end
+  def options=(arg0); end
+  def scanner; end
+  def tokens; end
+end
+module CodeRay::PluginHost
+  def [](id, *args, &blk); end
+  def all_plugins; end
+  def const_missing(const); end
+  def default(id = nil); end
+  def list; end
+  def load(id, *args, &blk); end
+  def load_all; end
+  def load_plugin_map; end
+  def make_plugin_hash; end
+  def map(hash); end
+  def path_to(plugin_id); end
+  def plugin_hash; end
+  def plugin_path(*args); end
+  def register(plugin, id); end
+  def self.extended(mod); end
+  def validate_id(id); end
+end
+class CodeRay::PluginHost::PluginNotFound < LoadError
+end
+class CodeRay::PluginHost::HostNotFound < LoadError
+end
+module CodeRay::Plugin
+  def aliases; end
+  def plugin_host(host = nil); end
+  def plugin_id; end
+  def register_for(id); end
+  def title(title = nil); end
+end
+module CodeRay::Scanners
+  extend CodeRay::PluginHost
+end
+class CodeRay::Scanners::Scanner < StringScanner
+  def binary_string; end
+  def column(pos = nil); end
+  def each(&block); end
+  def file_extension; end
+  def initialize(code = nil, options = nil); end
+  def lang; end
+  def line(pos = nil); end
+  def raise_inspect(message, tokens, state = nil, ambit = nil, backtrace = nil); end
+  def raise_inspect_arguments(message, tokens, state, ambit); end
+  def reset; end
+  def reset_instance; end
+  def scan_rest; end
+  def scan_tokens(tokens, options); end
+  def scanner_state_info(state); end
+  def self.encode_with_encoding(code, target_encoding); end
+  def self.encoding(name = nil); end
+  def self.file_extension(extension = nil); end
+  def self.guess_encoding(s); end
+  def self.lang; end
+  def self.normalize(code); end
+  def self.to_unix(code); end
+  def set_string_from_source(source); end
+  def set_tokens_from_options(options); end
+  def setup; end
+  def state; end
+  def state=(arg0); end
+  def string=(code); end
+  def tokenize(source = nil, options = nil); end
+  def tokens; end
+  def tokens_last(tokens, n); end
+  def tokens_size(tokens); end
+  extend CodeRay::Plugin
+  include Enumerable
+end
+class CodeRay::Scanners::Scanner::ScanError < StandardError
+end
+class CodeRay::WordList < Hash
+  def add(words, value = nil); end
+  def initialize(default = nil); end
+end
+class CodeRay::WordList::CaseIgnoring < CodeRay::WordList
+  def [](key); end
+  def []=(key, value); end
+end
+module CodeRay::Scanners::Java::BuiltinTypes
+end
+class CodeRay::Scanners::Java < CodeRay::Scanners::Scanner
+  def scan_tokens(encoder, options); end
+end
+class CodeRay::Scanners::Ruby < CodeRay::Scanners::Scanner
+  def interpreted_string_state; end
+  def scan_tokens(encoder, options); end
+  def setup; end
+end
+module CodeRay::Scanners::Ruby::Patterns
+end
+class Anonymous_Struct_1 < Struct
+  def delim; end
+  def delim=(_); end
+  def heredoc; end
+  def heredoc=(_); end
+  def interpreted; end
+  def interpreted=(_); end
+  def next_state; end
+  def next_state=(_); end
+  def opening_paren; end
+  def opening_paren=(_); end
+  def paren_depth; end
+  def paren_depth=(_); end
+  def pattern; end
+  def pattern=(_); end
+  def self.[](*arg0); end
+  def self.inspect; end
+  def self.members; end
+  def self.new(*arg0); end
+  def type; end
+  def type=(_); end
+end
+class CodeRay::Scanners::Ruby::StringState < Anonymous_Struct_1
+  def heredoc_pattern(delim, interpreted, indented); end
+  def initialize(kind, interpreted, delim, heredoc = nil); end
+  def self.simple_key_pattern(delim); end
+end
+module CodeRay::Encoders
+  extend CodeRay::PluginHost
+end
+class CodeRay::Encoders::Encoder
+  def <<(token); end
+  def begin_group(kind); end
+  def begin_line(kind); end
+  def compile(tokens, options = nil); end
+  def encode(code, lang, options = nil); end
+  def encode_tokens(tokens, options = nil); end
+  def end_group(kind); end
+  def end_line(kind); end
+  def file_extension; end
+  def finish(options); end
+  def get_output(options); end
+  def highlight(code, lang, options = nil); end
+  def initialize(options = nil); end
+  def options; end
+  def options=(arg0); end
+  def output(data); end
+  def scanner; end
+  def scanner=(arg0); end
+  def self.const_missing(sym); end
+  def self.file_extension; end
+  def setup(options); end
+  def text_token(text, kind); end
+  def token(content, kind); end
+  def tokens(tokens, options = nil); end
+  extend CodeRay::Plugin
+end
+class CodeRay::Encoders::HTML < CodeRay::Encoders::Encoder
+  def begin_group(kind); end
+  def begin_line(kind); end
+  def break_lines(text, style); end
+  def check_group_nesting(name, kind); end
+  def check_options!(options); end
+  def close_span; end
+  def css; end
+  def css_class_for_kinds(kinds); end
+  def end_group(kind); end
+  def end_line(kind); end
+  def finish(options); end
+  def make_span_for_kinds(method, hint); end
+  def self.make_html_escape_hash; end
+  def self.token_path_to_hint(hint, kinds); end
+  def setup(options); end
+  def style_for_kinds(kinds); end
+  def text_token(text, kind); end
+end
+module CodeRay::Encoders::HTML::Output
+  def apply_title!(title); end
+  def css; end
+  def css=(arg0); end
+  def self.extended(o); end
+  def self.make_stylesheet(css, in_tag = nil); end
+  def self.page_template_for_css(css); end
+  def stylesheet(in_tag = nil); end
+  def wrap!(element, *args); end
+  def wrap_in!(template); end
+  def wrapped_in; end
+  def wrapped_in=(arg0); end
+  def wrapped_in?(element); end
+end
+class CodeRay::Encoders::HTML::Output::Template < String
+  def apply(target, replacement); end
+  def self.wrap!(str, template, target); end
+end
+class CodeRay::Encoders::HTML::CSS
+  def get_style_for_css_classes(css_classes); end
+  def initialize(style = nil); end
+  def parse(stylesheet); end
+  def self.load_stylesheet(style = nil); end
+  def stylesheet; end
+end
+module CodeRay::Encoders::HTML::Numbering
+  def self.number!(output, mode = nil, options = nil); end
+end
+module CodeRay::Styles
+  extend CodeRay::PluginHost
+end
+class CodeRay::Styles::Style
+  extend CodeRay::Plugin
+end
+class CodeRay::Duo
+  def call(code, options = nil); end
+  def encode(code, options = nil); end
+  def encoder; end
+  def format; end
+  def format=(arg0); end
+  def highlight(code, options = nil); end
+  def initialize(lang = nil, format = nil, options = nil); end
+  def lang; end
+  def lang=(arg0); end
+  def options; end
+  def options=(arg0); end
+  def scanner; end
+  def self.[](*arg0); end
+end
+class CodeRay::Encoders::Terminal < CodeRay::Encoders::Encoder
+  def begin_group(kind); end
+  def begin_line(kind); end
+  def end_group(kind); end
+  def end_line(kind); end
+  def open_token(kind); end
+  def setup(options); end
+  def text_token(text, kind); end
+end