Handle exception in analyze, completion_candidates and doc_namespace

Author: tompng

bin/console

@@ -11,5 +11,6 @@ require "repl_completion"
 # require "pry"
 # Pry.start
 
+ReplCompletion.preload_rbs
 require "irb"
 IRB.start(__FILE__)

lib/repl_completion.rb

@@ -6,7 +6,7 @@
 
 module ReplCompletion
   class << self
-    attr_reader :last_analyze_error
+    attr_reader :last_completion_error
 
     def rbs_load_error
       Types.rbs_load_error
@@ -29,20 +29,18 @@ def preload_rbs
     end
 
     def analyze(code, binding)
-      preload_rbs
-      begin
-        verbose, $VERBOSE = $VERBOSE, nil
-        result = analyze_code(code, binding)
-      rescue Exception => e
-        handle_error(e)
-      ensure
-        $VERBOSE = verbose
-      end
+      verbose, $VERBOSE = $VERBOSE, nil
+      result = analyze_code(code, binding)
       Result.new(result, binding) if result
+    rescue Exception => e
+      handle_exception(e)
+      nil
+    ensure
+      $VERBOSE = verbose
     end
 
-    def handle_error(e)
-      @last_analyze_error = e
+    def handle_exception(e)
+      @last_completion_error = e
     end
 
     def info

lib/repl_completion/result.rb

@@ -66,6 +66,9 @@ def completion_candidates
         []
       end
       candidates.select { _1.start_with?(name) }.map { _1[name.size..] }
+    rescue Exception => e
+      ReplCompletion.handle_exception(e)
+      []
     ensure
       $VERBOSE = verbose
     end
@@ -97,6 +100,9 @@ def doc_namespace(matched)
         end
       else
       end
+    rescue Exception => e
+      ReplCompletion.handle_exception(e)
+      nil
     ensure
       $VERBOSE = verbose
     end

sig/repl_completion.rbs

@@ -9,7 +9,7 @@ module ReplCompletion
   def self.analyze: (String, Binding) -> Result?
 
   def self.rbs_load_error: () -> Exception?
-  def self.last_analyze_error: () -> Exception?
+  def self.last_completion_error: () -> Exception?
 
   def self.rbs_load_started?: () -> bool
   def self.rbs_loaded?: () -> bool

test/repl_completion/test_repl_completion.rb

@@ -166,13 +166,54 @@ def test_none
 
     def test_repl_completion_api
       assert_nil ReplCompletion.rbs_load_error
-      assert_nil ReplCompletion.last_analyze_error
+      assert_nil ReplCompletion.last_completion_error
       assert_equal true, ReplCompletion.rbs_load_started?
       assert_equal true, ReplCompletion.rbs_loaded?
       assert_nothing_raised { ReplCompletion.preload_rbs }
       assert_nothing_raised { ReplCompletion.load_rbs }
     end
 
+    def with_failing_method(klass, method_name, message)
+      original_method = klass.instance_method(method_name)
+      klass.remove_method(method_name)
+      klass.define_method(method_name) do |*, **|
+        raise Exception.new(message)
+      end
+      yield
+    ensure
+      klass.remove_method(method_name)
+      klass.define_method(method_name, original_method)
+    end
+
+    def test_analyze_error
+      with_failing_method(ReplCompletion.singleton_class, :analyze_code, 'error_in_analyze_code') do
+        assert_nil ReplCompletion.analyze '1.', binding
+      end
+      assert_equal 'error_in_analyze_code', ReplCompletion.last_completion_error&.message
+    ensure
+      ReplCompletion.instance_variable_set(:@last_completion_error, nil)
+    end
+
+    def test_completion_candidates_error
+      result = ReplCompletion.analyze '1.', binding
+      with_failing_method(ReplCompletion::Types::InstanceType, :methods, 'error_in_methods') do
+        assert_equal [], result.completion_candidates
+      end
+      assert_equal 'error_in_methods', ReplCompletion.last_completion_error&.message
+    ensure
+      ReplCompletion.instance_variable_set(:@last_completion_error, nil)
+    end
+
+    def test_doc_namespace_error
+      result = ReplCompletion.analyze '1.', binding
+      with_failing_method(ReplCompletion::Result, :method_doc, 'error_in_method_doc') do
+        assert_nil result.doc_namespace('abs')
+      end
+      assert_equal 'error_in_method_doc', ReplCompletion.last_completion_error&.message
+    ensure
+      ReplCompletion.instance_variable_set(:@last_completion_error, nil)
+    end
+
     def test_info
       assert_equal "ReplCompletion: #{ReplCompletion::VERSION}, Prism: #{Prism::VERSION}, RBS: #{RBS::VERSION}", ReplCompletion.info
     end

test/repl_completion/test_type_analyze.rb

@@ -6,17 +6,17 @@
 module TestReplCompletion
   class AnalyzeTest < TestCase
     def setup
-      @handle_error_method = ReplCompletion.method(:handle_error)
-      ReplCompletion.singleton_class.remove_method(:handle_error)
-      def ReplCompletion.handle_error(e)
+      @handle_exception_method = ReplCompletion.method(:handle_exception)
+      ReplCompletion.singleton_class.remove_method(:handle_exception)
+      def ReplCompletion.handle_exception(e)
         raise e
       end
       ReplCompletion::Types.load_rbs_builder unless ReplCompletion::Types.rbs_builder
     end
 
     def teardown
-      ReplCompletion.singleton_class.remove_method(:handle_error)
-      ReplCompletion.define_singleton_method(:handle_error, &@handle_error_method)
+      ReplCompletion.singleton_class.remove_method(:handle_exception)
+      ReplCompletion.define_singleton_method(:handle_exception, &@handle_exception_method)
     end
 
     def empty_binding