1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
// Copyright 2025 CUE Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package server
import (
"context"
"errors"
"fmt"
"path"
"cuelang.org/go/internal/cueversion"
"cuelang.org/go/internal/golangorgx/gopls/progress"
"cuelang.org/go/internal/golangorgx/gopls/protocol"
"cuelang.org/go/internal/golangorgx/gopls/settings"
"cuelang.org/go/internal/golangorgx/tools/event"
"cuelang.org/go/internal/golangorgx/tools/jsonrpc2"
"cuelang.org/go/internal/lsp/cache"
)
func validateWorkspaceFolders(folders []protocol.WorkspaceFolder) (map[protocol.WorkspaceFolder]protocol.DocumentURI, error) {
withParsedUri := make(map[protocol.WorkspaceFolder]protocol.DocumentURI)
for _, folder := range folders {
if folder.URI == "" {
return nil, fmt.Errorf("empty WorkspaceFolder.URI")
}
uri, err := protocol.ParseDocumentURI(folder.URI)
if err != nil {
return nil, fmt.Errorf("invalid WorkspaceFolder.URI: %v", err)
}
withParsedUri[folder] = uri
}
return withParsedUri, nil
}
// Initialize is a request from the editor/client to initialize the
// workspace. It gets a response. Once the response is sent, the
// client needs to send an Initialized async message before any work
// starts.
//
// https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#initialize
func (s *server) Initialize(ctx context.Context, params *protocol.ParamInitialize) (*protocol.InitializeResult, error) {
ctx, done := event.Start(ctx, "lsp.Server.initialize")
defer done()
if s.state != serverCreated {
return nil, fmt.Errorf("%w: initialize called while server in %v state", jsonrpc2.ErrInvalidRequest, s.state)
}
s.state = serverInitializing
// TODO(myitcv): need to better understand events, and the mechanisms that
// hang off that. At least for now we know that the integration expectation
// setup relies on the progress messaging titles to track things being done.
s.progress = progress.NewTracker(s.client, params.Capabilities.Window.WorkDoneProgress)
// Clone the existing (default?) options, and update from the params.
options := s.Options().Clone()
// TODO(myitcv): review and slim down option handling code
if err := s.handleOptionResults(ctx, settings.SetOptions(options, params.InitializationOptions)); err != nil {
return nil, err
}
options.ForClientCapabilities(params.ClientInfo, params.Capabilities)
s.SetOptions(options)
folders := params.WorkspaceFolders
if len(folders) == 0 && params.RootURI != "" {
folders = []protocol.WorkspaceFolder{{
URI: string(params.RootURI),
Name: path.Base(params.RootURI.Path()),
}}
}
validFolders, err := validateWorkspaceFolders(folders)
if err != nil {
return nil, err
} else if len(validFolders) == 0 {
return nil, errors.New("no WorkspaceFolders")
}
s.eventuallyUseWorkspaceFolders(validFolders)
return &protocol.InitializeResult{
ServerInfo: &protocol.ServerInfo{
Name: "cuelsp",
// NB, this is not strictly the same as "cue version" because
// "cue version" allows the version to be set via ldflags.
Version: cueversion.ModuleVersion(),
},
Capabilities: protocol.ServerCapabilities{
DocumentFormattingProvider: &protocol.Or_ServerCapabilities_documentFormattingProvider{Value: true},
TextDocumentSync: &protocol.TextDocumentSyncOptions{
Change: protocol.Incremental,
OpenClose: true,
Save: &protocol.SaveOptions{
IncludeText: false,
},
},
Workspace: &protocol.WorkspaceOptions{
WorkspaceFolders: &protocol.WorkspaceFolders5Gn{
Supported: true,
ChangeNotifications: "workspace/didChangeWorkspaceFolders",
},
},
},
}, nil
}
// Initialized is the handler for the async message from the
// client. The client should send this only after it's received our
// InitializeResult message.
//
// https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#initialized
func (s *server) Initialized(ctx context.Context, params *protocol.InitializedParams) error {
ctx, done := event.Start(ctx, "lsp.Server.initialized")
defer done()
if s.state != serverInitializing {
return fmt.Errorf("%w: initialized called while server in %v state", jsonrpc2.ErrInvalidRequest, s.state)
}
s.state = serverInitialized
err := s.maybeShowPendingMessages(ctx)
if err != nil {
return err
}
options := s.Options()
if options.ConfigurationSupported && options.DynamicConfigurationSupported {
err := s.client.RegisterCapability(ctx, &protocol.RegistrationParams{
Registrations: []protocol.Registration{{
ID: "workspace/didChangeConfiguration",
Method: "workspace/didChangeConfiguration",
}},
})
if err != nil {
return err
}
}
s.workspace = cache.NewWorkspace(s.cache, s.debugLog)
err = s.maybeUseWorkspaceFolders(ctx)
// Initialized is a notification, so if there's an error, we show
// it rather than return it.
if err != nil {
s.client.ShowMessage(ctx, &protocol.ShowMessageParams{Type: protocol.Error, Message: err.Error()})
}
return nil
}
|
