Zed excluding Ruby LSP results from project symbol search

[janko]

Summary

Searching Ruby symbols in a project often shows empty results.

Description

When I'm trying to search project symbols, even though Ruby LSP server returns the results, Zed doesn't display them for whatever reason.

1. type cmd-t
2. enter ruby class name

Expected Behavior: I should always see the class name in the result.

Actual Behavior: I see Ruby LSP returns the result, but Zed didn't display it, or it displayed it briefly.

Looking at Zed.log, I'm seeing this error:

ERROR [lsp] failed to deserialize response from language server: data did not match any variant of untagged enum WorkspaceSymbolResponse.

I'm attaching the complete relevant output: Zed.log

settings.json

{
  "features": {
    "edit_prediction_provider": "zed"
  },
  "theme": "Catppuccin Frappé",
  "buffer_font_size": 13.0,
  "tab_size": 2,
  "vim_mode": true,
  "scrollbar": {
    "cursors": false,
    "axes": {
      "horizontal": false
    }
  },
  "show_whitespaces": "boundary",
  "toolbar": {
    "quick_actions": false
  },
  "tab_bar": {
    "show": false
  },
  "use_autoclose": false,
  "pane_split_direction_horizontal": "down",
  "pane_split_direction_vertical": "right",
  "use_system_path_prompts": false,
  "lsp": {
    "tailwindcss-language-server": {
      "settings": {
        "includeLanguages": {
          "html/erb": "html",
          "ruby": "html"
        },
        "experimental": {
          "classRegex": ["\\bclass:\\s*['\"]([^'\"]*)['\"]"]
        }
      }
    }
  },
  "format_on_save": "off",
  "languages": {
    "Ruby": {
      "enable_language_server": true,
      "language_servers": [
        "ruby-lsp",
        "tailwindcss-language-server",
        "!rubocop",
        "!solargraph",
        "!steep",
        "!sorbet",
        "..."
      ]
    },
    "JavaScript": {
      "show_edit_predictions": false,
      "language_servers": ["!stimulus", "..."]
    },
    "YAML": {
      "enable_language_server": false
    },
    "Markdown": {
      "soft_wrap": "editor_width"
    },
    "Slim": {
      "remove_trailing_whitespace_on_save": false
    },
    "Shell Script": {
      "hard_tabs": false
    }
  }
}

Zed Version and System Specs

Zed: v0.208.4 (Zed)
OS: macOS 26.0.1
Memory: 8 GiB
Architecture: aarch64

[dinocosta]

Thank you for reporting @janko !

I've just tried reproducing this with a fresh rails app (rails new) and it seems to be working for me. Can you check if you still get the same error in that scenario? Just trying to understand if it's related to the project itself.

Also, I'm assuming you have the Ruby extension installed. Is that correct? 🙂

[janko]

OK, I was able to narrow it down and reproduce it in a fresh Rails app.

1. add the following methods to app/controllers/application_controller.rb

   class ApplicationController < ActionController::Base
     def foo
     end
     alias foo? foo
   end

2. restart language server
3. do a project symbol search
4. typing foo doesn't return the ApplicationController#foo method

It appears that's because Ruby LSP returns "kind": null for method alias results, which Zed considers to be invalid (and raising the mentioned error). From LSP logs:

// Send:
{"jsonrpc":"2.0","id":30,"method":"workspace/symbol","params":{"query":"foo"}}

// Receive:
{"id":30,"result":[{"name":"foo","kind":6,"containerName":"","location":{"uri":"file:///Users/janko/Code/temp/stimulus_lsp_app/app/controllers/application_controller.rb","range":{"start":{"line":4,"character":2},"end":{"line":5,"character":5}}}},{"name":"foo?","kind":null,"containerName":"","location":{"uri":"file:///Users/janko/Code/temp/stimulus_lsp_app/app/controllers/application_controller.rb","range":{"start":{"line":6,"character":8},"end":{"line":6,"character":12}}}}],"jsonrpc":"2.0"}

I suppose that could be considered a bug in Ruby LSP, because as far as I understand kind is a required field in LSP. However, could Zed also be resilient in these scenarios, by skipping results that are in invalid format and returning only valid ones, as opposed to not returning any results?

And yes, I'm using the official Ruby extension, which provides the Ruby LSP integration.

[janko]

For anyone looking, here is the Ruby LSP issue reported that I just found – Shopify/ruby-lsp#3781.

[dinocosta]

Thank you for digging deeper into this @janko ! 🙇

I've tried replicating this and it, indeed, seems like Ruby LSP behaves differently from Solargraph. Even without a search query, Ruby LSP returns an empty result for the workspace/symbol method:

Solargraph (No Query)

// Send:
{
  "jsonrpc": "2.0",
  "id": 31,
  "method": "workspace/symbol",
  "params": { "query": "" }
}

// Receive:
{
  "jsonrpc": "2.0",
  "id": 31,
  "result": [
    {
      "name": "ApplicationController",
      "containerName": "",
      "kind": 5,
      "location": {
        "uri": "file:///Users/dino/Developer/sample_rails_app/app/controllers/application_controller.rb",
        "range": {
          "start": { "line": 0, "character": 0 },
          "end": { "line": 7, "character": 3 }
        }
      },
      "deprecated": false
    },
    {
      "name": "ApplicationController#foo",
      "containerName": "ApplicationController",
      "kind": 6,
      "location": {
        "uri": "file:///Users/dino/Developer/sample_rails_app/app/controllers/application_controller.rb",
        "range": {
          "start": { "line": 4, "character": 2 },
          "end": { "line": 5, "character": 5 }
        }
      },
      "deprecated": false
    },
    {
      "name": "ApplicationController#foo?",
      "containerName": "ApplicationController",
      "kind": 6,
      "location": {
        "uri": "file:///Users/dino/Developer/sample_rails_app/app/controllers/application_controller.rb",
        "range": {
          "start": { "line": 6, "character": 2 },
          "end": { "line": 6, "character": 16 }
        }
      },
      "deprecated": false
    },
    {
      "name": "ApplicationHelper",
      "containerName": "",
      "kind": 2,
      "location": {
        "uri": "file:///Users/dino/Developer/sample_rails_app/app/helpers/application_helper.rb",
        "range": {
          "start": { "line": 0, "character": 0 },
          "end": { "line": 1, "character": 3 }
        }
      },
      "deprecated": false
    },
    {
      "name": "ApplicationJob",
      "containerName": "",
      "kind": 5,
      "location": {
        "uri": "file:///Users/dino/Developer/sample_rails_app/app/jobs/application_job.rb",
        "range": {
          "start": { "line": 0, "character": 0 },
          "end": { "line": 6, "character": 3 }
        }
      },
      "deprecated": false
    },
    {
      "name": "ApplicationMailer",
      "containerName": "",
      "kind": 5,
      "location": {
        "uri": "file:///Users/dino/Developer/sample_rails_app/app/mailers/application_mailer.rb",
        "range": {
          "start": { "line": 0, "character": 0 },
          "end": { "line": 3, "character": 3 }
        }
      },
      "deprecated": false
    },
    {
      "name": "ApplicationRecord",
      "containerName": "",
      "kind": 5,
      "location": {
        "uri": "file:///Users/dino/Developer/sample_rails_app/app/models/application_record.rb",
        "range": {
          "start": { "line": 0, "character": 0 },
          "end": { "line": 2, "character": 3 }
        }
      },
      "deprecated": false
    },
    {
      "name": "SampleRailsApp",
      "containerName": "",
      "kind": 2,
      "location": {
        "uri": "file:///Users/dino/Developer/sample_rails_app/config/application.rb",
        "range": {
          "start": { "line": 8, "character": 0 },
          "end": { "line": 26, "character": 3 }
        }
      },
      "deprecated": false
    },
    {
      "name": "SampleRailsApp::Application",
      "containerName": "SampleRailsApp",
      "kind": 5,
      "location": {
        "uri": "file:///Users/dino/Developer/sample_rails_app/config/application.rb",
        "range": {
          "start": { "line": 9, "character": 2 },
          "end": { "line": 25, "character": 5 }
        }
      },
      "deprecated": false
    }
  ]
}

Ruby LSP (No Query)

// Send:
{
  "jsonrpc": "2.0",
  "id": 8,
  "method": "workspace/symbol",
  "params": { "query": "" }
}

// Receive:
{ "id": 8, "result": [], "jsonrpc": "2.0" }

And, as you pointed out, even when searching for foo, Ruby LSP returns a list of result that appear to contain an invalid SymbolKind:

Solargraph (With Query)

// Send:
{
  "jsonrpc": "2.0",
  "id": 36,
  "method": "workspace/symbol",
  "params": { "query": "foo" }
}


// Receive:
{
  "jsonrpc": "2.0",
  "id": 36,
  "result": [
    {
      "name": "ApplicationController#foo",
      "containerName": "ApplicationController",
      "kind": 6,
      "location": {
        "uri": "file:///Users/dino/Developer/sample_rails_app/app/controllers/application_controller.rb",
        "range": {
          "start": { "line": 4, "character": 2 },
          "end": { "line": 5, "character": 5 }
        }
      },
      "deprecated": false
    },
    {
      "name": "ApplicationController#foo?",
      "containerName": "ApplicationController",
      "kind": 6,
      "location": {
        "uri": "file:///Users/dino/Developer/sample_rails_app/app/controllers/application_controller.rb",
        "range": {
          "start": { "line": 6, "character": 2 },
          "end": { "line": 6, "character": 16 }
        }
      },
      "deprecated": false
    }
  ]
}

Ruby LSP (With Query)

// Send:
{
  "jsonrpc": "2.0",
  "id": 16,
  "method": "workspace/symbol",
  "params": { "query": "foo" }
}

// Receive:
{
  "id": 16,
  "result": [
    {
      "name": "foo",
      "kind": 6,
      "containerName": "",
      "location": {
        "uri": "file:///Users/dino/Developer/sample_rails_app/app/controllers/application_controller.rb",
        "range": {
          "start": { "line": 4, "character": 2 },
          "end": { "line": 5, "character": 5 }
        }
      }
    },
    {
      "name": "foo?",
      "kind": null,
      "containerName": "",
      "location": {
        "uri": "file:///Users/dino/Developer/sample_rails_app/app/controllers/application_controller.rb",
        "range": {
          "start": { "line": 6, "character": 8 },
          "end": { "line": 6, "character": 12 }
        }
      }
    },
    {
      "name": "for",
      "kind": 6,
      "containerName": "",
      "location": {
        "uri": "file:///Users/dino/Library/Application%20Support/Zed/extensions/work/ruby/gems/parser-3.3.9.0/lib/parser/builders/default.rb",
        "range": {
          "start": { "line": 1338, "character": 4 },
          "end": { "line": 1342, "character": 7 }
        }
      }
    },
    {
      "name": "for",
      "kind": 6,
      "containerName": "",
      "location": {
        "uri": "file:///Users/dino/Library/Application%20Support/Zed/extensions/work/ruby/gems/regexp_parser-2.11.3/lib/regexp_parser/scanner/errors/validation_error.rb",
        "range": {
          "start": { "line": 6, "character": 4 },
          "end": { "line": 8, "character": 7 }
        }
      }
    },
    {
      "name": "for",
      "kind": 6,
      "containerName": "",
      "location": {
        "uri": "file:///Users/dino/Library/Application%20Support/Zed/extensions/work/ruby/gems/regexp_parser-2.11.3/lib/regexp_parser/syntax/version_lookup.rb",
        "range": {
          "start": { "line": 23, "character": 2 },
          "end": { "line": 25, "character": 5 }
        }
      }
    },
    {
      "name": "foreground",
      "kind": 6,
      "containerName": "",
      "location": {
        "uri": "file:///Users/dino/Library/Application%20Support/Zed/extensions/work/ruby/gems/rainbow-3.1.1/lib/rainbow/ext/string.rb",
        "range": {
          "start": { "line": 8, "character": 8 },
          "end": { "line": 10, "character": 11 }
        }
      }
    },
    {
      "name": "foreground",
      "kind": null,
      "containerName": "",
      "location": {
        "uri": "file:///Users/dino/Library/Application%20Support/Zed/extensions/work/ruby/gems/rainbow-3.1.1/lib/rainbow/null_presenter.rb",
        "range": {
          "start": { "line": 92, "character": 10 },
          "end": { "line": 92, "character": 20 }
        }
      }
    },
    {
      "name": "foreground",
      "kind": null,
      "containerName": "",
      "location": {
        "uri": "file:///Users/dino/Library/Application%20Support/Zed/extensions/work/ruby/gems/rainbow-3.1.1/lib/rainbow/presenter.rb",
        "range": {
          "start": { "line": 25, "character": 10 },
          "end": { "line": 25, "character": 20 }
        }
      }
    },
    {
      "name": "following_line",
      "kind": 6,
      "containerName": "",
      "location": {
        "uri": "file:///Users/dino/Library/Application%20Support/Zed/extensions/work/ruby/gems/rubocop-ast-1.47.1/lib/rubocop/ast/processed_source.rb",
        "range": {
          "start": { "line": 182, "character": 6 },
          "end": { "line": 184, "character": 9 }
        }
      }
    },
    {
      "name": "forward_only_args",
      "kind": 6,
      "containerName": "",
      "location": {
        "uri": "file:///Users/dino/Library/Application%20Support/Zed/extensions/work/ruby/gems/parser-3.3.9.0/lib/parser/builders/default.rb",
        "range": {
          "start": { "line": 902, "character": 4 },
          "end": { "line": 910, "character": 7 }
        }
      }
    },
    {
      "name": "force_on_collision?",
      "kind": 6,
      "containerName": "",
      "location": {
        "uri": "file:///Users/dino/Library/Application%20Support/Zed/extensions/work/ruby/gems/thor-1.4.0/lib/thor/actions/create_file.rb",
        "range": {
          "start": { "line": 99, "character": 6 },
          "end": { "line": 101, "character": 9 }
        }
      }
    },
    {
      "name": "force_or_skip_or_conflict",
      "kind": 6,
      "containerName": "",
      "location": {
        "uri": "file:///Users/dino/Library/Application%20Support/Zed/extensions/work/ruby/gems/thor-1.4.0/lib/thor/actions/create_file.rb",
        "range": {
          "start": { "line": 85, "character": 6 },
          "end": { "line": 95, "character": 9 }
        }
      }
    },
    {
      "name": "find_command_possibilities",
      "kind": 6,
      "containerName": "",
      "location": {
        "uri": "file:///Users/dino/Library/Application%20Support/Zed/extensions/work/ruby/gems/thor-1.4.0/lib/thor.rb",
        "range": {
          "start": { "line": 625, "character": 4 },
          "end": { "line": 637, "character": 7 }
        }
      }
    },
    {
      "name": "loop",
      "kind": 6,
      "containerName": "",
      "location": {
        "uri": "file:///Users/dino/Library/Application%20Support/Zed/extensions/work/ruby/gems/parser-3.3.9.0/lib/parser/builders/default.rb",
        "range": {
          "start": { "line": 1324, "character": 4 },
          "end": { "line": 1327, "character": 7 }
        }
      }
    },
    {
      "name": "@cs_before_block_comment",
      "kind": 8,
      "containerName": "",
      "location": {
        "uri": "file:///Users/dino/Library/Application%20Support/Zed/extensions/work/ruby/gems/parser-3.3.9.0/lib/parser/lexer-F0.rb",
        "range": {
          "start": { "line": 8470, "character": 4 },
          "end": { "line": 8470, "character": 28 }
        }
      }
    },
    {
      "name": "@cs_before_block_comment",
      "kind": 8,
      "containerName": "",
      "location": {
        "uri": "file:///Users/dino/Library/Application%20Support/Zed/extensions/work/ruby/gems/parser-3.3.9.0/lib/parser/lexer-F0.rb",
        "range": {
          "start": { "line": 10483, "character": 8 },
          "end": { "line": 10483, "character": 32 }
        }
      }
    },
    {
      "name": "@cs_before_block_comment",
      "kind": 8,
      "containerName": "",
      "location": {
        "uri": "file:///Users/dino/Library/Application%20Support/Zed/extensions/work/ruby/gems/parser-3.3.9.0/lib/parser/lexer-F0.rb",
        "range": {
          "start": { "line": 10876, "character": 8 },
          "end": { "line": 10876, "character": 32 }
        }
      }
    },
    {
      "name": "@cs_before_block_comment",
      "kind": 8,
      "containerName": "",
      "location": {
        "uri": "file:///Users/dino/Library/Application%20Support/Zed/extensions/work/ruby/gems/parser-3.3.9.0/lib/parser/lexer-F1.rb",
        "range": {
          "start": { "line": 8337, "character": 4 },
          "end": { "line": 8337, "character": 28 }
        }
      }
    },
    {
      "name": "@cs_before_block_comment",
      "kind": 8,
      "containerName": "",
      "location": {
        "uri": "file:///Users/dino/Library/Application%20Support/Zed/extensions/work/ruby/gems/parser-3.3.9.0/lib/parser/lexer-F1.rb",
        "range": {
          "start": { "line": 9808, "character": 8 },
          "end": { "line": 9808, "character": 32 }
        }
      }
    },
    {
      "name": "@cs_before_block_comment",
      "kind": 8,
      "containerName": "",
      "location": {
        "uri": "file:///Users/dino/Library/Application%20Support/Zed/extensions/work/ruby/gems/parser-3.3.9.0/lib/parser/lexer-F1.rb",
        "range": {
          "start": { "line": 10051, "character": 8 },
          "end": { "line": 10051, "character": 32 }
        }
      }
    },
    {
      "name": "@cs_before_block_comment",
      "kind": 8,
      "containerName": "",
      "location": {
        "uri": "file:///Users/dino/Library/Application%20Support/Zed/extensions/work/ruby/gems/parser-3.3.9.0/lib/parser/lexer-F1.rb",
        "range": {
          "start": { "line": 11544, "character": 8 },
          "end": { "line": 11544, "character": 32 }
        }
      }
    }
  ],
  "jsonrpc": "2.0"
}

Not sure if it makes sense for Zed to simply discard malformed WorkspaceSymbol and display the rest, as it looks like, even though some entries have "kind": null, we would still be able to handle the others that have a valid kind .

[dinocosta]

Hey 👋

After another look, I believe it makes sense to close the issue seeing as we've confirmed that Ruby LSP is returning an invalid value for SymbolKind Because Zed relies on lsp_types, we'd need to "hack" our way around those types in order to be able to accept an invalid response, just for Ruby LSP.

There's also a PR already attempting to fix the issue in Ruby LSP – Shopify/ruby-lsp#3784 – so hopefully that gets merged soon, and the root issue gets resolved.

Thank you for reporting 🙂

[janko]

Yeah, that makes sense, the bug is arguably on the Ruby LSP side 👍🏻