Enhance schema hover link to jump to the right table by faraazahmad · Pull Request #212 · Shopify/ruby-lsp-rails

faraazahmad · 2023-12-18T14:24:10Z

Add a SchemaCollector class that expects schema.rb AST and stores the location for all the defined tables.

For issue #52

faraazahmad · 2023-12-18T15:08:39Z

I have signed the CLA!

wbhouston

Hi @faraazahmad! I was looking through the issues and #52 caught my attention. This looks like a great start to me! Although I'm not a maintainer, so that doesn't carry much weight.

I used part of your code and implemented the remaining steps to include the table location in the schema hover link. If you're interested, I opened a PR in my forked repository that is working for me locally. I didn't include any tests, and I'm new to sorbet so the type assertions are probably wrong.

Best regards!

wbhouston · 2023-12-28T14:36:14Z

lib/ruby_lsp/ruby_lsp_rails/schema_collector.rb

+        node.block.body.child_nodes.each do |child_node|
+          next unless child_node.is_a?(Prism::CallNode)
+          next unless child_node.name == :create_table
+
+          table_name = child_node.arguments.child_nodes.first.content
+          @tables[table_name.classify] = child_node.location
+        end


It is not necessary to traverse the nodes directly within a Prism::Visitor. Per the documentation:

def visit_call_node(node) if node.name == "foo" # Do something with the node end # Call super so that the visitor continues walking the tree super end

So this could be restructured to look like:

def visit_call_node(node) if node.name == 'create_table' # ensure the first argument is a string node and store the location end super end

Hi @wbhouston! Thank you for these changes, they look great to me! Feel free to commit these changes to this PR

@faraazahmad it won't be possible for @wbhouston to push to your branch.

andyw8

@wbhouston I tried your PR and it seems to work well. I do have some feedback, but I'd like if you can first work with @faraazahmad to get the work into a single PR against Shopify/ruby-lsp-rails. I'll ensure you are both credited if it is merged.

faraazahmad · 2024-01-10T14:21:50Z

Thanks @andyw8 ! I'll add those changes in my fork

andyw8 · 2024-01-16T16:05:52Z

Hi @faraazahmad, I tried the latest version and it seems to not be jumping to the line in schema.rb. (it was working when I tried on @wbhouston's branch previously). Could you check it please?

vinistock · 2024-01-16T17:47:17Z

lib/ruby_lsp/ruby_lsp_rails/schema_collector.rb

+      sig { void }
+      def parse_schema
+        parse_result = Prism::parse_file(schema_path)
+        return unless parse_result.success?


I don't think this check if necessary. The schema.rb file is generated, so normally it would always be valid Ruby. But in addition to that, Prism is error tolerant, so even if it cannot parse the entire file, it will still return a partial AST, which we can use to find tables.

vinistock · 2024-01-16T17:47:35Z

lib/ruby_lsp/ruby_lsp_rails/schema_collector.rb

+  module Rails
+    class SchemaCollector < Prism::Visitor
+      extend T::Sig
+      extend T::Generic


This probably doesn't need to be generic.

vinistock · 2024-01-16T17:50:05Z

lib/ruby_lsp/ruby_lsp_rails/schema_collector.rb

+        project_root = T.let(
+          Bundler.with_unbundled_env { Bundler.default_gemfile }.dirname,
+          Pathname,
+        )


We should be passing this as an argument from client. Otherwise, we end up with the same information in two separate places, which is likely to get out of sync.

lib/ruby_lsp/ruby_lsp_rails/hover.rb

Co-authored-by: Vinicius Stock <vinistock@users.noreply.github.com>

faraazahmad · 2024-01-22T11:02:21Z

Hey thanks for the reviews! And sorry about the delay I've been busy with a couple of things I'll try and finish this soon

faraazahmad · 2024-01-29T17:14:26Z

@vinistock I've made the changes as needed, but I'm unable to figure out a Sorbet issue. Since, SchemaCollector now requires a constructor argument,

https://github.com/Shopify/ruby-lsp-rails/pull/212/files#diff-7fa7e03da0e012e6c49f2299b22c01b2c3ae6229f62c66ab7a8a52aaf3d03a22R21-R25 errors out

andyw8 · 2024-01-29T18:59:38Z

@faraazahmad I pushed a commit to your branch to address the typing and linting issues. I tried locally and it seems to be working well, but I'll let you confirm before merging.

andyw8 · 2024-01-29T19:02:54Z

test/ruby_lsp_rails/schema_collector_test.rb

+
+require "test_helper"
+
+SCHEMA_FILE = <<~RUBY


Let's move this into SchemaCollectorTest so that it's not defined globally.

andyw8 · 2024-01-29T19:07:30Z

Let's also update the PR title to be more descriptive for when it appears in the release notes.

andyw8 · 2024-02-09T19:57:58Z

Reminder for myself: Check how this performs for apps with a high number of tables, e.g. Core.

andyw8 · 2024-02-09T20:18:35Z

lib/ruby_lsp/ruby_lsp_rails/schema_collector.rb

+        super()
+
+        @tables = T.let({}, T::Hash[String, Prism::Location])
+        @schema_path = T.let(project_root.join("db", "schema.rb").to_s, String)


This isn't quite right as some apps use structure.sql instead.

If you search you'll see we use schema_dump_path elsewhere to get the path.

This means this collector will need to communicate with the server. The path for the schema is unlikely to change, so maybe there's room for a refactor where we fetch the schema path once and reuse it here and in hover.

Maybe we can move forward with this and simply not populate anything if db/schema.rb doesn't exist? That way we can provide the feature for schema users and enhance it later.

vinistock · 2024-02-12T15:46:10Z

lib/ruby_lsp/ruby_lsp_rails/schema_collector.rb

+        super()
+
+        @tables = T.let({}, T::Hash[String, Prism::Location])
+        @schema_path = T.let(project_root.join("db", "schema.rb").to_s, String)


This means this collector will need to communicate with the server. The path for the schema is unlikely to change, so maybe there's room for a refactor where we fetch the schema path once and reuse it here and in hover.

Maybe we can move forward with this and simply not populate anything if db/schema.rb doesn't exist? That way we can provide the feature for schema users and enhance it later.

lib/ruby_lsp/ruby_lsp_rails/hover.rb

Co-authored-by: Vinicius Stock <vinistock@users.noreply.github.com>

Add schema collector

60cc1fe

faraazahmad requested a review from a team as a code owner December 18, 2023 14:24

faraazahmad requested review from andyw8 and vinistock December 18, 2023 14:24

add types

abe9229

github-actions bot added the cla-needed label Dec 18, 2023

faraazahmad added 2 commits December 18, 2023 20:02

fix operator typo

77da138

add RubyLsp::Rails module

e3f748f

github-actions bot removed the cla-needed label Dec 18, 2023

wbhouston reviewed Dec 28, 2023

View reviewed changes

andyw8 suggested changes Jan 4, 2024

View reviewed changes

incorporate changes by @wbhouston

3d9b762

faraazahmad requested a review from andyw8 January 10, 2024 14:52

faraazahmad added 2 commits January 10, 2024 20:30

fix schema collector test

63bf2c1

fix rack app test

da54d63

vinistock reviewed Jan 16, 2024

View reviewed changes

Update lib/ruby_lsp/ruby_lsp_rails/hover.rb

4d97874

Co-authored-by: Vinicius Stock <vinistock@users.noreply.github.com>

fix: address comments

5f65cb9

faraazahmad requested a review from vinistock January 29, 2024 17:14

Fix typing and linting

633edc5

andyw8 reviewed Jan 29, 2024

View reviewed changes

faraazahmad changed the title ~~Add schema collector~~ Enhance schema hover link to jump to the right table Jan 31, 2024

fix: move schema file into class

0e414a7

faraazahmad requested a review from andyw8 January 31, 2024 17:01

andyw8 reviewed Feb 9, 2024

View reviewed changes

vinistock reviewed Feb 12, 2024

View reviewed changes

Update lib/ruby_lsp/ruby_lsp_rails/hover.rb

c24d3d5

Co-authored-by: Vinicius Stock <vinistock@users.noreply.github.com>


		require "test_helper"

		SCHEMA_FILE = <<~RUBY

Conversation

faraazahmad commented Dec 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

faraazahmad commented Dec 18, 2023

Uh oh!

wbhouston left a comment

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!

andyw8 left a comment

Choose a reason for hiding this comment

Uh oh!

faraazahmad commented Jan 10, 2024

Uh oh!

andyw8 commented Jan 16, 2024 • 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!

Uh oh!

faraazahmad commented Jan 22, 2024

Uh oh!

faraazahmad commented Jan 29, 2024

Uh oh!

andyw8 commented Jan 29, 2024 • 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!

andyw8 commented Jan 29, 2024

Uh oh!

andyw8 commented Feb 9, 2024

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!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

faraazahmad commented Dec 18, 2023 •

edited

Loading

andyw8 commented Jan 16, 2024 •

edited

Loading

andyw8 commented Jan 29, 2024 •

edited

Loading