Move lsp server to this repo (#5619)
This commit is contained in:
Jess Frazelle
GitHub
387
rust/kcl-language-server/client/src/ctx.ts
Normal file
387
rust/kcl-language-server/client/src/ctx.ts
Normal file
@ -0,0 +1,387 @@
|
||||
/* eslint suggest-no-throw/suggest-no-throw: 0 */
|
||||
import * as vscode from 'vscode'
|
||||
import type * as lc from 'vscode-languageclient/node'
|
||||
|
||||
import { Config, prepareVSCodeConfig } from './config'
|
||||
import { createClient } from './client'
|
||||
import {
|
||||
isKclDocument,
|
||||
isKclEditor,
|
||||
LazyOutputChannel,
|
||||
log,
|
||||
type KclEditor,
|
||||
} from './util'
|
||||
import type { ServerStatusParams } from './lsp_ext'
|
||||
import { PersistentState } from './persistent_state'
|
||||
import { bootstrap } from './bootstrap'
|
||||
import { TransportKind } from 'vscode-languageclient/node'
|
||||
|
||||
// We only support local folders, not eg. Live Share (`vlsl:` scheme), so don't activate if
|
||||
// only those are in use. We use "Empty" to represent these scenarios
|
||||
// (r-a still somewhat works with Live Share, because commands are tunneled to the host)
|
||||
|
||||
export type Workspace =
|
||||
| { kind: 'Empty' }
|
||||
| {
|
||||
kind: 'Workspace Folder'
|
||||
}
|
||||
| {
|
||||
kind: 'Detached Files'
|
||||
files: vscode.TextDocument[]
|
||||
}
|
||||
|
||||
export function fetchWorkspace(): Workspace {
|
||||
const folders = (vscode.workspace.workspaceFolders || []).filter(
|
||||
(folder) => folder.uri.scheme === 'file'
|
||||
)
|
||||
const kclDocuments = vscode.workspace.textDocuments.filter((document) =>
|
||||
isKclDocument(document)
|
||||
)
|
||||
|
||||
return folders.length === 0
|
||||
? kclDocuments.length === 0
|
||||
? { kind: 'Empty' }
|
||||
: {
|
||||
kind: 'Detached Files',
|
||||
files: kclDocuments,
|
||||
}
|
||||
: { kind: 'Workspace Folder' }
|
||||
}
|
||||
|
||||
export type CommandFactory = {
|
||||
enabled: (ctx: CtxInit) => Cmd
|
||||
disabled?: (ctx: Ctx) => Cmd
|
||||
}
|
||||
|
||||
export type CtxInit = Ctx & {
|
||||
readonly client: lc.LanguageClient
|
||||
}
|
||||
|
||||
export class Ctx {
|
||||
readonly statusBar: vscode.StatusBarItem
|
||||
config: Config
|
||||
readonly workspace: Workspace
|
||||
|
||||
private _client: lc.LanguageClient | undefined
|
||||
private _serverPath: string | undefined
|
||||
private traceOutputChannel: vscode.OutputChannel | undefined
|
||||
private outputChannel: vscode.OutputChannel | undefined
|
||||
private clientSubscriptions: Disposable[]
|
||||
private state: PersistentState
|
||||
private commandFactories: Record<string, CommandFactory>
|
||||
private commandDisposables: Disposable[]
|
||||
private lastStatus: ServerStatusParams | { health: 'stopped' } = {
|
||||
health: 'stopped',
|
||||
}
|
||||
|
||||
get client() {
|
||||
return this._client
|
||||
}
|
||||
|
||||
constructor(
|
||||
readonly extCtx: vscode.ExtensionContext,
|
||||
commandFactories: Record<string, CommandFactory>,
|
||||
workspace: Workspace
|
||||
) {
|
||||
extCtx.subscriptions.push(this)
|
||||
this.statusBar = vscode.window.createStatusBarItem(
|
||||
vscode.StatusBarAlignment.Left
|
||||
)
|
||||
this.workspace = workspace
|
||||
this.clientSubscriptions = []
|
||||
this.commandDisposables = []
|
||||
this.commandFactories = commandFactories
|
||||
this.state = new PersistentState(extCtx.globalState)
|
||||
this.config = new Config(extCtx)
|
||||
|
||||
this.updateCommands('disable')
|
||||
this.setServerStatus({
|
||||
health: 'stopped',
|
||||
})
|
||||
}
|
||||
|
||||
dispose() {
|
||||
this.config.dispose()
|
||||
this.statusBar.dispose()
|
||||
void this.disposeClient()
|
||||
this.commandDisposables.forEach((disposable) => disposable.dispose())
|
||||
}
|
||||
|
||||
async onWorkspaceFolderChanges() {
|
||||
const workspace = fetchWorkspace()
|
||||
if (
|
||||
workspace.kind === 'Detached Files' &&
|
||||
this.workspace.kind === 'Detached Files'
|
||||
) {
|
||||
if (workspace.files !== this.workspace.files) {
|
||||
if (this.client?.isRunning()) {
|
||||
// Ideally we wouldn't need to tear down the server here, but currently detached files
|
||||
// are only specified at server start
|
||||
await this.stopAndDispose()
|
||||
await this.start()
|
||||
}
|
||||
return
|
||||
}
|
||||
}
|
||||
if (
|
||||
workspace.kind === 'Workspace Folder' &&
|
||||
this.workspace.kind === 'Workspace Folder'
|
||||
) {
|
||||
return
|
||||
}
|
||||
if (workspace.kind === 'Empty') {
|
||||
await this.stopAndDispose()
|
||||
return
|
||||
}
|
||||
if (this.client?.isRunning()) {
|
||||
await this.restart()
|
||||
}
|
||||
}
|
||||
|
||||
private async getOrCreateClient() {
|
||||
if (this.workspace.kind === 'Empty') {
|
||||
return
|
||||
}
|
||||
|
||||
if (!this.traceOutputChannel) {
|
||||
this.traceOutputChannel = new LazyOutputChannel(
|
||||
'KittyCAD Language Server Trace'
|
||||
)
|
||||
this.pushExtCleanup(this.traceOutputChannel)
|
||||
}
|
||||
if (!this.outputChannel) {
|
||||
this.outputChannel = vscode.window.createOutputChannel(
|
||||
'KittyCAD Language Server'
|
||||
)
|
||||
this.pushExtCleanup(this.outputChannel)
|
||||
}
|
||||
|
||||
if (!this._client) {
|
||||
this._serverPath = await bootstrap(
|
||||
this.extCtx,
|
||||
this.config,
|
||||
this.state
|
||||
).catch((err) => {
|
||||
let message = 'bootstrap error. '
|
||||
|
||||
message +=
|
||||
'See the logs in "OUTPUT > KittyCAD Language Client" (should open automatically). '
|
||||
message +=
|
||||
'To enable verbose logs use { "kcl-language-server.trace.extension": true }'
|
||||
|
||||
log.error('Bootstrap error', err)
|
||||
throw new Error(message)
|
||||
})
|
||||
const run: lc.Executable = {
|
||||
command: this._serverPath,
|
||||
args: ['--json', 'server'],
|
||||
transport: TransportKind.stdio,
|
||||
options: { env: { ...process.env } },
|
||||
}
|
||||
const serverOptions = {
|
||||
run,
|
||||
debug: run,
|
||||
}
|
||||
|
||||
let rawInitializationOptions = vscode.workspace.getConfiguration(
|
||||
'kcl-language-server'
|
||||
)
|
||||
|
||||
if (this.workspace.kind === 'Detached Files') {
|
||||
rawInitializationOptions = {
|
||||
detachedFiles: this.workspace.files.map((file) => file.uri.fsPath),
|
||||
...rawInitializationOptions,
|
||||
}
|
||||
}
|
||||
|
||||
const initializationOptions = prepareVSCodeConfig(
|
||||
rawInitializationOptions
|
||||
)
|
||||
|
||||
this._client = await createClient(
|
||||
this.traceOutputChannel,
|
||||
this.outputChannel,
|
||||
initializationOptions,
|
||||
serverOptions
|
||||
)
|
||||
}
|
||||
return this._client
|
||||
}
|
||||
|
||||
async start() {
|
||||
log.info('Starting language client')
|
||||
const client = await this.getOrCreateClient()
|
||||
if (!client) {
|
||||
return
|
||||
}
|
||||
await client.start()
|
||||
this.setServerStatus({ health: 'ok', quiescent: true })
|
||||
this.updateCommands()
|
||||
}
|
||||
|
||||
async restart() {
|
||||
// FIXME: We should reuse the client, that is ctx.deactivate() if none of the configs have changed
|
||||
await this.stopAndDispose()
|
||||
await this.start()
|
||||
}
|
||||
|
||||
async stop() {
|
||||
if (!this._client) {
|
||||
return
|
||||
}
|
||||
log.info('Stopping language client')
|
||||
this.updateCommands('disable')
|
||||
await this._client.stop()
|
||||
}
|
||||
|
||||
async stopAndDispose() {
|
||||
if (!this._client) {
|
||||
return
|
||||
}
|
||||
log.info('Disposing language client')
|
||||
this.updateCommands('disable')
|
||||
await this.disposeClient()
|
||||
}
|
||||
|
||||
private async disposeClient() {
|
||||
this.clientSubscriptions?.forEach((disposable) => disposable.dispose())
|
||||
this.clientSubscriptions = []
|
||||
try {
|
||||
await this._client?.dispose(2000)
|
||||
} catch (e) {
|
||||
// DO nothing.
|
||||
}
|
||||
this._serverPath = undefined
|
||||
this._client = undefined
|
||||
}
|
||||
|
||||
get activeKclEditor(): KclEditor | undefined {
|
||||
const editor = vscode.window.activeTextEditor
|
||||
return editor && isKclEditor(editor) ? editor : undefined
|
||||
}
|
||||
|
||||
get extensionPath(): string {
|
||||
return this.extCtx.extensionPath
|
||||
}
|
||||
|
||||
get subscriptions(): Disposable[] {
|
||||
return this.extCtx.subscriptions
|
||||
}
|
||||
|
||||
get serverPath(): string | undefined {
|
||||
return this._serverPath
|
||||
}
|
||||
|
||||
private updateCommands(forceDisable?: 'disable') {
|
||||
this.commandDisposables.forEach((disposable) => disposable.dispose())
|
||||
this.commandDisposables = []
|
||||
|
||||
const clientRunning = (!forceDisable && this._client?.isRunning()) ?? false
|
||||
const isClientRunning = function (_ctx: Ctx): _ctx is CtxInit {
|
||||
return clientRunning
|
||||
}
|
||||
|
||||
for (const [name, factory] of Object.entries(this.commandFactories)) {
|
||||
const fullName = `kcl-language-server.${name}`
|
||||
let callback
|
||||
if (isClientRunning(this)) {
|
||||
// we asserted that `client` is defined
|
||||
callback = factory.enabled(this)
|
||||
} else if (factory.disabled) {
|
||||
callback = factory.disabled(this)
|
||||
} else {
|
||||
callback = () =>
|
||||
vscode.window.showErrorMessage(
|
||||
`command ${fullName} failed: kcl-language-server server is not running`
|
||||
)
|
||||
}
|
||||
|
||||
this.commandDisposables.push(
|
||||
vscode.commands.registerCommand(fullName, callback)
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
setServerStatus(status: ServerStatusParams | { health: 'stopped' }) {
|
||||
this.lastStatus = status
|
||||
this.updateStatusBarItem()
|
||||
}
|
||||
refreshServerStatus() {
|
||||
this.updateStatusBarItem()
|
||||
}
|
||||
private updateStatusBarItem() {
|
||||
let icon = ''
|
||||
const status = this.lastStatus
|
||||
const statusBar = this.statusBar
|
||||
statusBar.show()
|
||||
statusBar.tooltip = new vscode.MarkdownString('', true)
|
||||
statusBar.tooltip.isTrusted = true
|
||||
switch (status.health) {
|
||||
case 'ok':
|
||||
statusBar.tooltip.appendText(status.message ?? 'Ready')
|
||||
statusBar.color = undefined
|
||||
statusBar.backgroundColor = undefined
|
||||
statusBar.command = 'kcl-language-server.openLogs'
|
||||
break
|
||||
case 'warning':
|
||||
if (status.message) {
|
||||
statusBar.tooltip.appendText(status.message)
|
||||
}
|
||||
statusBar.color = new vscode.ThemeColor(
|
||||
'statusBarItem.warningForeground'
|
||||
)
|
||||
statusBar.backgroundColor = new vscode.ThemeColor(
|
||||
'statusBarItem.warningBackground'
|
||||
)
|
||||
statusBar.command = 'kcl-language-server.openLogs'
|
||||
icon = '$(warning) '
|
||||
break
|
||||
case 'error':
|
||||
if (status.message) {
|
||||
statusBar.tooltip.appendText(status.message)
|
||||
}
|
||||
statusBar.color = new vscode.ThemeColor('statusBarItem.errorForeground')
|
||||
statusBar.backgroundColor = new vscode.ThemeColor(
|
||||
'statusBarItem.errorBackground'
|
||||
)
|
||||
statusBar.command = 'kcl-language-server.openLogs'
|
||||
icon = '$(error) '
|
||||
break
|
||||
case 'stopped':
|
||||
statusBar.tooltip.appendText('Server is stopped')
|
||||
statusBar.tooltip.appendMarkdown(
|
||||
'\n\n[Start server](command:kcl-language-server.startServer)'
|
||||
)
|
||||
statusBar.color = new vscode.ThemeColor(
|
||||
'statusBarItem.warningForeground'
|
||||
)
|
||||
statusBar.backgroundColor = new vscode.ThemeColor(
|
||||
'statusBarItem.warningBackground'
|
||||
)
|
||||
statusBar.command = 'kcl-language-server.startServer'
|
||||
statusBar.text = '$(stop-circle) kcl-language-server'
|
||||
return
|
||||
}
|
||||
if (statusBar.tooltip.value) {
|
||||
statusBar.tooltip.appendMarkdown('\n\n---\n\n')
|
||||
}
|
||||
statusBar.tooltip.appendMarkdown(
|
||||
'\n\n[Restart server](command:kcl-language-server.restartServer)'
|
||||
)
|
||||
statusBar.tooltip.appendMarkdown(
|
||||
'\n\n[Stop server](command:kcl-language-server.stopServer)'
|
||||
)
|
||||
if (!status.quiescent) icon = '$(sync~spin) '
|
||||
statusBar.text = `${icon}kcl-language-server`
|
||||
}
|
||||
|
||||
pushExtCleanup(d: Disposable) {
|
||||
this.extCtx.subscriptions.push(d)
|
||||
}
|
||||
}
|
||||
|
||||
export interface Disposable {
|
||||
dispose(): void
|
||||
}
|
||||
|
||||
export type Cmd = (...args: any[]) => unknown
|
||||
Reference in New Issue
Block a user