| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563 |
- package lsp
- import (
- "context"
- "encoding/json"
- "fmt"
- "log/slog"
- "maps"
- "os"
- "path/filepath"
- "sync"
- "sync/atomic"
- "time"
- "github.com/charmbracelet/crush/internal/config"
- "github.com/charmbracelet/crush/internal/csync"
- "github.com/charmbracelet/crush/internal/fsext"
- "github.com/charmbracelet/crush/internal/home"
- powernap "github.com/charmbracelet/x/powernap/pkg/lsp"
- "github.com/charmbracelet/x/powernap/pkg/lsp/protocol"
- "github.com/charmbracelet/x/powernap/pkg/transport"
- )
- // DiagnosticCounts holds the count of diagnostics by severity.
- type DiagnosticCounts struct {
- Error int
- Warning int
- Information int
- Hint int
- }
- type Client struct {
- client *powernap.Client
- name string
- debug bool
- // Working directory this LSP is scoped to.
- cwd string
- // File types this LSP server handles (e.g., .go, .rs, .py)
- fileTypes []string
- // Configuration for this LSP client
- config config.LSPConfig
- // Original context and resolver for recreating the client
- ctx context.Context
- resolver config.VariableResolver
- // Diagnostic change callback
- onDiagnosticsChanged func(name string, count int)
- // Diagnostic cache
- diagnostics *csync.VersionedMap[protocol.DocumentURI, []protocol.Diagnostic]
- // Cached diagnostic counts to avoid map copy on every UI render.
- diagCountsCache DiagnosticCounts
- diagCountsVersion uint64
- diagCountsMu sync.Mutex
- // Files are currently opened by the LSP
- openFiles *csync.Map[string, *OpenFileInfo]
- // Server state
- serverState atomic.Value
- }
- // New creates a new LSP client using the powernap implementation.
- func New(
- ctx context.Context,
- name string,
- cfg config.LSPConfig,
- resolver config.VariableResolver,
- cwd string,
- debug bool,
- ) (*Client, error) {
- client := &Client{
- name: name,
- fileTypes: cfg.FileTypes,
- diagnostics: csync.NewVersionedMap[protocol.DocumentURI, []protocol.Diagnostic](),
- openFiles: csync.NewMap[string, *OpenFileInfo](),
- config: cfg,
- ctx: ctx,
- debug: debug,
- resolver: resolver,
- cwd: cwd,
- }
- client.serverState.Store(StateStopped)
- if err := client.createPowernapClient(); err != nil {
- return nil, err
- }
- return client, nil
- }
- // Initialize initializes the LSP client and returns the server capabilities.
- func (c *Client) Initialize(ctx context.Context, workspaceDir string) (*protocol.InitializeResult, error) {
- if err := c.client.Initialize(ctx, false); err != nil {
- return nil, fmt.Errorf("failed to initialize the lsp client: %w", err)
- }
- // Convert powernap capabilities to protocol capabilities
- caps := c.client.GetCapabilities()
- protocolCaps := protocol.ServerCapabilities{
- TextDocumentSync: caps.TextDocumentSync,
- CompletionProvider: func() *protocol.CompletionOptions {
- if caps.CompletionProvider != nil {
- return &protocol.CompletionOptions{
- TriggerCharacters: caps.CompletionProvider.TriggerCharacters,
- AllCommitCharacters: caps.CompletionProvider.AllCommitCharacters,
- ResolveProvider: caps.CompletionProvider.ResolveProvider,
- }
- }
- return nil
- }(),
- }
- result := &protocol.InitializeResult{
- Capabilities: protocolCaps,
- }
- c.registerHandlers()
- return result, nil
- }
- // closeTimeout is the maximum time to wait for a graceful LSP shutdown.
- const closeTimeout = 5 * time.Second
- // Kill kills the client without doing anything else.
- func (c *Client) Kill() { c.client.Kill() }
- // Close closes all open files in the client, then shuts down gracefully.
- // If shutdown takes longer than closeTimeout, it falls back to Kill().
- func (c *Client) Close(ctx context.Context) error {
- c.CloseAllFiles(ctx)
- // Use a timeout to prevent hanging on unresponsive LSP servers.
- // jsonrpc2's send lock doesn't respect context cancellation, so we
- // need to fall back to Kill() which closes the underlying connection.
- closeCtx, cancel := context.WithTimeout(ctx, closeTimeout)
- defer cancel()
- done := make(chan error, 1)
- go func() {
- if err := c.client.Shutdown(closeCtx); err != nil {
- slog.Warn("Failed to shutdown LSP client", "error", err)
- }
- done <- c.client.Exit()
- }()
- select {
- case err := <-done:
- return err
- case <-closeCtx.Done():
- c.client.Kill()
- return closeCtx.Err()
- }
- }
- // createPowernapClient creates a new powernap client with the current configuration.
- func (c *Client) createPowernapClient() error {
- rootURI := string(protocol.URIFromPath(c.cwd))
- command, err := c.resolver.ResolveValue(c.config.Command)
- if err != nil {
- return fmt.Errorf("invalid lsp command: %w", err)
- }
- clientConfig := powernap.ClientConfig{
- Command: home.Long(command),
- Args: c.config.Args,
- RootURI: rootURI,
- Environment: maps.Clone(c.config.Env),
- Settings: c.config.Options,
- InitOptions: c.config.InitOptions,
- WorkspaceFolders: []protocol.WorkspaceFolder{
- {
- URI: rootURI,
- Name: filepath.Base(c.cwd),
- },
- },
- }
- powernapClient, err := powernap.NewClient(clientConfig)
- if err != nil {
- return fmt.Errorf("failed to create lsp client: %w", err)
- }
- c.client = powernapClient
- return nil
- }
- // registerHandlers registers the standard LSP notification and request handlers.
- func (c *Client) registerHandlers() {
- c.RegisterServerRequestHandler("workspace/applyEdit", HandleApplyEdit(c.client.GetOffsetEncoding()))
- c.RegisterServerRequestHandler("workspace/configuration", HandleWorkspaceConfiguration)
- c.RegisterServerRequestHandler("client/registerCapability", HandleRegisterCapability)
- c.RegisterNotificationHandler("window/showMessage", func(ctx context.Context, method string, params json.RawMessage) {
- if c.debug {
- HandleServerMessage(ctx, method, params)
- }
- })
- c.RegisterNotificationHandler("textDocument/publishDiagnostics", func(_ context.Context, _ string, params json.RawMessage) {
- HandleDiagnostics(c, params)
- })
- }
- // Restart closes the current LSP client and creates a new one with the same configuration.
- func (c *Client) Restart() error {
- var openFiles []string
- for uri := range c.openFiles.Seq2() {
- openFiles = append(openFiles, string(uri))
- }
- closeCtx, cancel := context.WithTimeout(c.ctx, 10*time.Second)
- defer cancel()
- if err := c.Close(closeCtx); err != nil {
- slog.Warn("Error closing client during restart", "name", c.name, "error", err)
- }
- c.SetServerState(StateStopped)
- c.diagCountsCache = DiagnosticCounts{}
- c.diagCountsVersion = 0
- if err := c.createPowernapClient(); err != nil {
- return err
- }
- initCtx, cancel := context.WithTimeout(c.ctx, 30*time.Second)
- defer cancel()
- c.SetServerState(StateStarting)
- if err := c.client.Initialize(initCtx, false); err != nil {
- c.SetServerState(StateError)
- return fmt.Errorf("failed to initialize lsp client: %w", err)
- }
- c.registerHandlers()
- if err := c.WaitForServerReady(initCtx); err != nil {
- slog.Error("Server failed to become ready after restart", "name", c.name, "error", err)
- c.SetServerState(StateError)
- return err
- }
- for _, uri := range openFiles {
- if err := c.OpenFile(initCtx, uri); err != nil {
- slog.Warn("Failed to reopen file after restart", "file", uri, "error", err)
- }
- }
- return nil
- }
- // ServerState represents the state of an LSP server
- type ServerState int
- const (
- StateUnstarted ServerState = iota
- StateStarting
- StateReady
- StateError
- StateStopped
- StateDisabled
- )
- // GetServerState returns the current state of the LSP server
- func (c *Client) GetServerState() ServerState {
- if val := c.serverState.Load(); val != nil {
- return val.(ServerState)
- }
- return StateStarting
- }
- // SetServerState sets the current state of the LSP server
- func (c *Client) SetServerState(state ServerState) {
- c.serverState.Store(state)
- }
- // GetName returns the name of the LSP client
- func (c *Client) GetName() string {
- return c.name
- }
- // SetDiagnosticsCallback sets the callback function for diagnostic changes
- func (c *Client) SetDiagnosticsCallback(callback func(name string, count int)) {
- c.onDiagnosticsChanged = callback
- }
- // WaitForServerReady waits for the server to be ready
- func (c *Client) WaitForServerReady(ctx context.Context) error {
- // Set initial state
- c.SetServerState(StateStarting)
- // Try to ping the server with a simple request
- ticker := time.NewTicker(500 * time.Millisecond)
- defer ticker.Stop()
- if c.debug {
- slog.Debug("Waiting for LSP server to be ready...")
- }
- c.openKeyConfigFiles(ctx)
- for {
- select {
- case <-ctx.Done():
- c.SetServerState(StateError)
- return fmt.Errorf("timeout waiting for LSP server to be ready")
- case <-ticker.C:
- // Check if client is running
- if !c.client.IsRunning() {
- if c.debug {
- slog.Debug("LSP server not ready yet", "server", c.name)
- }
- continue
- }
- // Server is ready
- c.SetServerState(StateReady)
- if c.debug {
- slog.Debug("LSP server is ready")
- }
- return nil
- }
- }
- }
- // OpenFileInfo contains information about an open file
- type OpenFileInfo struct {
- Version int32
- URI protocol.DocumentURI
- }
- // HandlesFile checks if this LSP client handles the given file based on its
- // extension and whether it's within the working directory.
- func (c *Client) HandlesFile(path string) bool {
- if c == nil {
- return false
- }
- if !fsext.HasPrefix(path, c.cwd) {
- slog.Debug("File outside workspace", "name", c.name, "file", path, "workDir", c.cwd)
- return false
- }
- return handlesFiletype(c.name, c.fileTypes, path)
- }
- // OpenFile opens a file in the LSP server.
- func (c *Client) OpenFile(ctx context.Context, filepath string) error {
- if !c.HandlesFile(filepath) {
- return nil
- }
- uri := string(protocol.URIFromPath(filepath))
- if _, exists := c.openFiles.Get(uri); exists {
- return nil // Already open
- }
- // Skip files that do not exist or cannot be read
- content, err := os.ReadFile(filepath)
- if err != nil {
- return fmt.Errorf("error reading file: %w", err)
- }
- // Notify the server about the opened document
- if err = c.client.NotifyDidOpenTextDocument(ctx, uri, string(powernap.DetectLanguage(filepath)), 1, string(content)); err != nil {
- return err
- }
- c.openFiles.Set(uri, &OpenFileInfo{
- Version: 1,
- URI: protocol.DocumentURI(uri),
- })
- return nil
- }
- // NotifyChange notifies the server about a file change.
- func (c *Client) NotifyChange(ctx context.Context, filepath string) error {
- if c == nil {
- return nil
- }
- uri := string(protocol.URIFromPath(filepath))
- content, err := os.ReadFile(filepath)
- if err != nil {
- return fmt.Errorf("error reading file: %w", err)
- }
- fileInfo, isOpen := c.openFiles.Get(uri)
- if !isOpen {
- return fmt.Errorf("cannot notify change for unopened file: %s", filepath)
- }
- // Increment version
- fileInfo.Version++
- // Create change event
- changes := []protocol.TextDocumentContentChangeEvent{
- {
- Value: protocol.TextDocumentContentChangeWholeDocument{
- Text: string(content),
- },
- },
- }
- return c.client.NotifyDidChangeTextDocument(ctx, uri, int(fileInfo.Version), changes)
- }
- // IsFileOpen checks if a file is currently open.
- func (c *Client) IsFileOpen(filepath string) bool {
- uri := string(protocol.URIFromPath(filepath))
- _, exists := c.openFiles.Get(uri)
- return exists
- }
- // CloseAllFiles closes all currently open files.
- func (c *Client) CloseAllFiles(ctx context.Context) {
- for uri := range c.openFiles.Seq2() {
- if c.debug {
- slog.Debug("Closing file", "file", uri)
- }
- if err := c.client.NotifyDidCloseTextDocument(ctx, uri); err != nil {
- slog.Warn("Error closing file", "uri", uri, "error", err)
- continue
- }
- c.openFiles.Del(uri)
- }
- }
- // GetFileDiagnostics returns diagnostics for a specific file.
- func (c *Client) GetFileDiagnostics(uri protocol.DocumentURI) []protocol.Diagnostic {
- diags, _ := c.diagnostics.Get(uri)
- return diags
- }
- // GetDiagnostics returns all diagnostics for all files.
- func (c *Client) GetDiagnostics() map[protocol.DocumentURI][]protocol.Diagnostic {
- if c == nil {
- return nil
- }
- return c.diagnostics.Copy()
- }
- // GetDiagnosticCounts returns cached diagnostic counts by severity.
- // Uses the VersionedMap version to avoid recomputing on every call.
- func (c *Client) GetDiagnosticCounts() DiagnosticCounts {
- if c == nil {
- return DiagnosticCounts{}
- }
- currentVersion := c.diagnostics.Version()
- c.diagCountsMu.Lock()
- defer c.diagCountsMu.Unlock()
- if currentVersion == c.diagCountsVersion {
- return c.diagCountsCache
- }
- // Recompute counts.
- counts := DiagnosticCounts{}
- for _, diags := range c.diagnostics.Seq2() {
- for _, diag := range diags {
- switch diag.Severity {
- case protocol.SeverityError:
- counts.Error++
- case protocol.SeverityWarning:
- counts.Warning++
- case protocol.SeverityInformation:
- counts.Information++
- case protocol.SeverityHint:
- counts.Hint++
- }
- }
- }
- c.diagCountsCache = counts
- c.diagCountsVersion = currentVersion
- return counts
- }
- // OpenFileOnDemand opens a file only if it's not already open.
- func (c *Client) OpenFileOnDemand(ctx context.Context, filepath string) error {
- if c == nil {
- return nil
- }
- // Check if the file is already open
- if c.IsFileOpen(filepath) {
- return nil
- }
- // Open the file
- return c.OpenFile(ctx, filepath)
- }
- // RegisterNotificationHandler registers a notification handler.
- func (c *Client) RegisterNotificationHandler(method string, handler transport.NotificationHandler) {
- c.client.RegisterNotificationHandler(method, handler)
- }
- // RegisterServerRequestHandler handles server requests.
- func (c *Client) RegisterServerRequestHandler(method string, handler transport.Handler) {
- c.client.RegisterHandler(method, handler)
- }
- // openKeyConfigFiles opens important configuration files that help initialize the server.
- func (c *Client) openKeyConfigFiles(ctx context.Context) {
- // Try to open each file, ignoring errors if they don't exist
- for _, file := range c.config.RootMarkers {
- file = filepath.Join(c.cwd, file)
- if _, err := os.Stat(file); err == nil {
- // File exists, try to open it
- if err := c.OpenFile(ctx, file); err != nil {
- slog.Error("Failed to open key config file", "file", file, "error", err)
- } else {
- slog.Debug("Opened key config file for initialization", "file", file)
- }
- }
- }
- }
- // WaitForDiagnostics waits until diagnostics change or the timeout is reached.
- func (c *Client) WaitForDiagnostics(ctx context.Context, d time.Duration) {
- if c == nil {
- return
- }
- ticker := time.NewTicker(200 * time.Millisecond)
- defer ticker.Stop()
- timeout := time.After(d)
- pv := c.diagnostics.Version()
- for {
- select {
- case <-ctx.Done():
- return
- case <-timeout:
- return
- case <-ticker.C:
- if pv != c.diagnostics.Version() {
- return
- }
- }
- }
- }
- // FindReferences finds all references to the symbol at the given position.
- func (c *Client) FindReferences(ctx context.Context, filepath string, line, character int, includeDeclaration bool) ([]protocol.Location, error) {
- if err := c.OpenFileOnDemand(ctx, filepath); err != nil {
- return nil, err
- }
- // Add timeout to prevent hanging on slow LSP servers.
- ctx, cancel := context.WithTimeout(ctx, 5*time.Second)
- defer cancel()
- // NOTE: line and character should be 0-based.
- // See: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#position
- return c.client.FindReferences(ctx, filepath, line-1, character-1, includeDeclaration)
- }
|