Use presence information to improve local variable type probing by apiology · Pull Request #1116 · castwide/solargraph

apiology · 2025-10-22T03:05:58Z

Use Pin::LocalVariable#combine_with to merge information from multiple assignments to the same local variable that may be visible from a given location, offering a single pin with consolidated information with ApiMap#var_at_location.

This, combined with #1114 and #1119, enables even more flow-sensitive typing scenarios, making nil-checking more accurate. Examples from a dev branch of enabled scenarios:

Fixes needed to make that happen:

fix: Handle a number of Pin::Block rebinding cases more consistently so that we can rely on the closure information inside to determine visibility of assignments.
fix: Ensure Pin::Base#reset_generated! gets called consistently when information is invalidated so that rebinding cases work more consistently.
fix: Ensure #reduce_class_type is in both ComplexType and UniqueType, a bug this PR tickled
fix: Track location information more consistently so that we can use it to determine visibility of assignments.

Points to pending external release:

More reliable closure and location updates lekemula/solargraph-rspec#30 - direct manipulation of the @closure and @location private instance variable meant that we didn't have a chance to refresh our cached derived state. This PR adds a new public API that will be used when available by solargraph-rspec (tested with .responds_to?)

Includes for better testing:

Enable solargraph-rspec tests #1087

Includes for convenience:

Improve some Pin::Base#inspect representations for easier debugging.
Update build matrix for new RBS release #1102
Add 'solargraph pin' command for debugging #1001

```sh $ SOLARGRAPH_ASSERTS=on bundle exec solargraph method_pin --rbs 'RuboCop::AST::ArrayNode#values' def values: () -> Array $ bundle exec solargraph help method_pin Usage: solargraph method_pin [PATH] Options: [--rbs], [--no-rbs], [--skip-rbs] # Output the pin as RBS # Default: false [--typify], [--no-typify], [--skip-typify] # Output the calculated return type of the pin from annotations # Default: false [--probe], [--no-probe], [--skip-probe] # Output the calculated return type of the pin from annotations and inference # Default: false [--stack], [--no-stack], [--skip-stack] # Show entire stack by including definitions in superclasses # Default: false Describe a method pin $ ```

* Allow newer RBS gem versions This allow users to upgrade to recent Tapioca versions. Tapioca now requires newish versions of the spoom gem, which depends on 4.x pre-releases of the rbs gem. * Add RBS version to test matrix * Add exclude rule * Move to 3.6.1

* Look for external requires before cataloging bench It seems like sync_catalog will go through the motions but not actually load pins from gems here due to passing an empty requires array to ApiMap. I'm sure those requires get pulled in eventually, but we go through at least one catalog cycle without it happening. Found while trying to test a different issue but not being able to get completions from a gem in a spec. * Ensure backport is pre-cached

…astwide#1011) * Complain in strong type-checking if an @sg-ignore line is not needed * Fix return type * Fix spec * Linting/coverage fixes * Coverage fix

* Document a log level env variable * Fix logger reference * Fix env var name * Populate location information from RBS files (castwide#768) * Populate location information from RBS files The 'rbs' gem maps the location of different definitions to the relevant point in the RGS files themselves - this change provides the ability to jump into the right place in those files to see the type definition via the LSP. * Prefer source location in language server * Resolve merge issue * Fix Path vs String type error * Consolidate parameter handling into Pin::Callable (castwide#844) * Consolidate parameter handling into Pin::Closure * Clarify clobbered variable names * Fix bug in to_rbs, add spec, then fix new bug found after running spec * Catch one more Signature.new to translate from strict typechecking * Introduce Pin::Callable * Introduce Pin::Callable * Introduce Pin::Callable * Introduce Pin::Callable * Introduce Pin::Callable * Introduce Pin::Callable * Introduce Pin::Callable * Use Pin::Callable type in args_node.rb * Select String#each_line overload with mandatory vs optional arg info * Adjust local variable presence to start after assignment, not before (castwide#864) * Adjust local variable presence to start after assignment, not before * Add regression test around assignment in return position * Fix assignment visibility code, which relied on bad asgn semantics * Resolve params from ref tags (castwide#872) * Resolve params from ref tags * Resolve ref tags with namespaces * Fix merge issue * RuboCop fixes * Add @sg-ignore * Linting * Linting fix * Linting fix --------- Co-authored-by: Fred Snyder <fsnyder@castwide.com>

* Fix hole in type checking evaluation The call to `bar()` in `[ bar('string') ].compact` is not currently type-checked due to a missed spot in `NodeMethods#call_nodes_from(node)` * Avoid over-reporting call issues * Fix annotation * Add nocov markers around unreachable area * Fix a coverage issue * Cover more paths in type checking * Fix a code coverage issue * Drop blank line * Ratchet Rubocop todo * Fix missing coverage

If we know the target of an unresolved method call, include it in the error message.

* Internal strict type-checking fixes * Add annotation * Add annotation * Add @sg-ignores for now

* Reproduce and fix a ||= (or-asgn) evaluation issue * Fix linting issue

This isn't used anywhere to my knowledge, but it makes sense to think of symbols as being in the global namespace, helps guarantee that closure is always available on a pin, and of course keeps the assert happy ;)

* Fix 'all!' config to reporters Solargraph found the type error here! * Linting fixes

* Fix RuboCop linting errors in regular expressions * Continue on rubocop_todo errors * Move configuration * Continue on undercover errors

* Resolve class aliases via Constant pins This also eliminates the need for Parser::NodeMethods as a searately defined class. * Resolve merge issues * Resolve Solargraph strong complaint * Add @sg-ignore * Fix RuboCop issues * Drop unused method * Ratchet .rubocop_todo.yml

* Improve performance of resolve_method_aliases method - Add indexed lookups for methods and aliases by name - Cache ancestor traversal to avoid repeated computations - Separate regular pins from aliases for more efficient processing - Replace linear search with direct indexed method lookup - Add fast path for creating resolved alias pins without individual lookups Generated with Claude Code * Update .rubocop_todo.yml * Fix typechecking - get_method_stack order `get_method_stack` returns the following order for `Enumerable#select`: - master branch: => ["Enumerable#select", "Kernel#select"] - current branch: => ["Kernel#select", "Enumerable#select"] * Avoid redundant indexing methods_by_name loop through ancestors and rely on store.get_path_pins

apiology · 2025-11-04T14:32:24Z

lib/solargraph/api_map/index.rb

+
+              new_pin.docstring.add_tag(tag)
+              redefine_return_type new_pin, tag
+              new_pin.reset_generated!


fix: Ensure Pin::Base#reset_generated! gets called consistently when information is invalidated so that additional rebinding cases work.

apiology · 2025-11-04T14:33:40Z

lib/solargraph/complex_type/unique_type.rb


+      def nullable?
+        nil_type?
+      end


fix: Ensure #reduce_class_type and #nullable? are in both ComplexType and UniqueType, a bug this PR tickled

apiology · 2025-11-04T14:34:27Z

lib/solargraph/parser/parser_gem/node_processors/block_node.rb

              receiver: node.children[0],
              comments: comments_for(node),
-              scope: region.scope || region.closure.context.scope,
+              scope: scope,


fix: Handle a number of Pin::Block rebinding cases more consistently so that we can rely on the closure information inside to determine visibility of assignments.

Specifically, handle a .class_eval case by directly setting the binder rather than pretending this is in a different closure. A .class_eval block is its own closure, with its parent closure being the call site, not the class. The class being evaled within is still the binder for purposes of method calls.

apiology · 2025-11-12T22:16:21Z

.github/workflows/plugins.yml

+       # pending https://github.com/lekemula/solargraph-rspec/pull/30
+       git clone https://github.com/apiology/solargraph-rspec.git
+       cd solargraph-rspec
+       git checkout reset_closures


Use a branch while lekemula/solargraph-rspec#30 is resolved.

apiology · 2025-11-12T22:19:33Z

lib/solargraph/pin/base.rb

      # @sg-ignore
      # @return [undefined]
      def assert_same(other, attr)
-        return false if other.nil?


This was always a bug - complained about by strong typechecking

apiology · 2025-11-14T13:56:55Z

lib/solargraph/pin/method.rb

+      # @param context [ComplexType, nil]
      def initialize visibility: :public, explicit: true, block: :undefined, node: nil, attribute: false, signatures: nil, anon_splat: false,
-                     **splat
+                     context: nil, **splat


fix: This allows def inside class_evals to work correctly - in that case, our closure is not the same as our context

apiology · 2025-11-14T14:13:08Z

lib/solargraph/pin/namespace.rb

+        @return_type = nil
+        @full_context = nil
+        @path = nil
+      end


Ensure that closure resets also reset the context and path

apiology · 2025-11-14T14:13:52Z

lib/solargraph/source/chain/call.rb

-          end
-          return inferred_pins(found, api_map, name_pin, locals) unless found.empty?
+          found = api_map.var_at_location(locals, word, name_pin, location) if head?
+          return inferred_pins([found], api_map, name_pin, locals) unless found.nil?


Only need to consider a single variable pin - the hard work has been done by combine_with()

apiology · 2025-11-14T14:14:05Z

lib/solargraph/source/chain/call.rb

        private

-        # @param pins [::Enumerable<Pin::Method>]
+        # @param pins [::Enumerable<Pin::Base>]


This was never right

apiology · 2025-11-14T14:26:27Z

lib/solargraph/source/chain/instance_variable.rb

      class InstanceVariable < Link
        def resolve api_map, name_pin, locals
-          api_map.get_instance_variable_pins(name_pin.binder.namespace, name_pin.binder.scope).select{|p| p.name == word}
+          api_map.get_instance_variable_pins(name_pin.context.namespace, name_pin.context.scope).select{|p| p.name == word}


Again, instance variables come from the context, not the binder

…jobs

…iing

apiology · 2026-01-07T12:34:33Z

lib/solargraph/pin/base_variable.rb

-      # @return [Parser::AST::Node, nil]
-      attr_reader :assignment
+      # @return [Array<Parser::AST::Node>]
+      attr_reader :assignments


Once we merge variable pins together, we can know about multiple assignments to the same pin

apiology and others added 30 commits July 13, 2025 12:44

Merge remote-tracking branch 'origin/master' into method_pin

6fab42e

RuboCop and Solargraph fixes

bf61295

Merge remote-tracking branch 'origin/master' into method_pin

8b8c88b

Linting fix

fdd3810

Add spec

30cdfc8

Fix spec

a30d790

Merge branch 'master' into method_pin

20dbf8e

Remove Library#folding_ranges (castwide#904)

0e86b88

Complain in strong type-checking if an @sg-ignore line is not needed (c…

c90f016

…astwide#1011) * Complain in strong type-checking if an @sg-ignore line is not needed * Fix return type * Fix spec * Linting/coverage fixes * Coverage fix

Improve typechecking error message (castwide#1014)

f61b1b6

If we know the target of an unresolved method call, include it in the error message.

Internal strict type-checking fixes (castwide#1013)

9d4c711

* Internal strict type-checking fixes * Add annotation * Add annotation * Add @sg-ignores for now

Reproduce and fix a ||= (or-asgn) evaluation issue (castwide#1017)

3bcbf85

* Reproduce and fix a ||= (or-asgn) evaluation issue * Fix linting issue

Define closure for Pin::Symbol, for completeness (castwide#1027)

25557b4

This isn't used anywhere to my knowledge, but it makes sense to think of symbols as being in the global namespace, helps guarantee that closure is always available on a pin, and of course keeps the assert happy ;)

Fix 'all!' config to reporters (castwide#1018)

32565d4

* Fix 'all!' config to reporters Solargraph found the type error here! * Linting fixes

Fix DocMap.all_rbs_collection_gems_in_memory return type (castwide#1037)

3946cc4

Fix RuboCop linting errors in regular expressions (castwide#1038)

43cacca

* Fix RuboCop linting errors in regular expressions * Continue on rubocop_todo errors * Move configuration * Continue on undercover errors

Merge remote-tracking branch 'origin/master' into method_pin

7a633b1

RuboCop todo update

d1e6b12

Try rbs collection update before specs

5b612dd

RuboCop fixes

f2291f4

Add @sg-ignores

be46aa3

Fix typo

0927309

Exclude problematic combinations on Ruby head

7899550

apiology added 4 commits November 14, 2025 09:03

Document logic

379daf2

Use reset_generated! instead, so future cases are handled

fc4f00f

Revert refactor

7be2cd1

Reformat

401b3e6

apiology commented Nov 14, 2025

View reviewed changes

apiology added 2 commits November 15, 2025 09:14

Fix solargraph-rspec specs

a7cc436

Fix issue revealed by this PR's change

4f94ef8

apiology mentioned this pull request Nov 16, 2025

Presence-based flow-sensitive typing for unions and nilable types #1123

Open

apiology added 2 commits November 16, 2025 14:19

Drop workaround

5e5b6e5

Push logic up to BaseVariable for future expansion

08626af

This was referenced Nov 27, 2025

Union type enforcement #1127

Open

2025-12-01 dev branch apiology/solargraph#21

Closed

apiology added 16 commits December 31, 2025 07:31

Merge remote-tracking branch 'origin/master' into reduce_num_of_buid_…

a497e42

…jobs

Merge branch 'reduce_num_of_buid_jobs' into local_variable_probiing

b4f6c29

Fix typecheck errors

0860447

Fix merge

8d1a96a

Bump RBS versions in rspec test

2b753e8

Fix version

e182a53

Fix version matrix

34cdf78

Fix version matrix

851d142

Fix version matrix

e2d27c9

Fix version matrix

8df808a

Fix version matrix

9974481

Exclude another

56e2535

Exclude another

d9e4936

Add version, fix doc

7514302

Merge branch 'reduce_num_of_buid_jobs' into local_variable_probiing

e64e643

Merge remote-tracking branch 'origin/master' into local_variable_prob…

9846751

…iing

apiology commented Jan 7, 2026

View reviewed changes

apiology mentioned this pull request Jan 11, 2026

Pre-release branch 2026-01-06 #1145

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Use presence information to improve local variable type probing#1116

Use presence information to improve local variable type probing#1116
apiology wants to merge 140 commits intocastwide:masterfrom
apiology:local_variable_probiing

apiology commented Oct 22, 2025 •

edited

Loading

Uh oh!

apiology Nov 4, 2025

Uh oh!

apiology Nov 4, 2025

Uh oh!

apiology Nov 4, 2025

Uh oh!

apiology Nov 12, 2025

Uh oh!

apiology Nov 12, 2025

Uh oh!

apiology Nov 14, 2025 •

edited

Loading

Uh oh!

apiology Nov 14, 2025

Uh oh!

apiology Nov 14, 2025

Uh oh!

apiology Nov 14, 2025

Uh oh!

apiology Nov 14, 2025

Uh oh!

apiology Jan 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

apiology commented Oct 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

apiology Nov 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

apiology commented Oct 22, 2025 •

edited

Loading

apiology Nov 14, 2025 •

edited

Loading