enso/app/gui2/shared/languageServer.ts
somebody1234 93a4937cc4
Add profiling shortcuts to GUI2 (#8406)
- Closes #8404

# Important Notes
- All relevant documentation has already been updated in #8358.
- I've tested that the keyboard shortcuts send appropriate messages over the LS connection, and have confirmed that a non-error response is received, but I'm not sure that the profiling actually works.
- There seem to be no entries in `~/.enso/`, nor in `~/enso/`
2023-11-28 14:44:46 +00:00

435 lines
17 KiB
TypeScript

import { sha3_224 as SHA3 } from '@noble/hashes/sha3'
import { bytesToHex } from '@noble/hashes/utils'
import { Client } from '@open-rpc/client-js'
import { ObservableV2 } from 'lib0/observable'
import { uuidv4 } from 'lib0/random'
import { z } from 'zod'
import { walkFs } from './languageServer/files'
import type {
Checksum,
ContextId,
Event,
ExecutionEnvironment,
ExpressionId,
FileEdit,
FileSystemObject,
Notifications,
Path,
RegisterOptions,
StackItem,
TextFileContents,
VisualizationConfiguration,
response,
} from './languageServerTypes'
import type { Uuid } from './yjsModel'
const DEBUG_LOG_RPC = false
const RPC_TIMEOUT_MS = 15000
export enum ErrorCode {
ACCESS_DENIED = 100,
FILE_SYSTEM_ERROR = 1000,
CONTENT_ROOT_NOT_FOUND = 1001,
FILE_NOT_FOUND = 1003,
FILE_EXISTS = 1004,
OPERATION_TIMEOUT = 1005,
NOT_DIRECTORY = 1006,
NOT_FILE = 1007,
CANNOT_OVERWRITE = 1008,
READ_OUT_OF_BOUNDS = 1009,
CANNOT_DECODE = 1010,
STACK_ITEM_NOT_FOUND = 2001,
CONTEXT_NOT_FOUND = 2002,
EMPTY_STACK = 2003,
INVALID_STACK_ITEM = 2004,
MODULE_NOT_FOUND = 2005,
VISUALIZATION_NOT_FOUND = 2006,
VISUALIZATION_EXPRESSION_ERROR = 2007,
FILE_NOT_OPENED = 3001,
TEXT_EDIT_VALIDATION_ERROR = 3002,
INVALID_VERSION = 3003,
WRITE_DENIED = 3004,
CAPABILITY_NOT_ACQUIRED = 5001,
SESSION_NOT_INITIALIZED = 6001,
SESSION_ALREADY_INITIALIZED = 6002,
RESOURCES_INITIALIZATION_ERROR = 6003,
SUGGESTION_DATABASE_ERROR = 7001,
PROJECT_NOT_FOUND = 7002,
MODULE_NAME_NOT_RESOLVED = 7003,
SUGGESTION_NOT_FOUND = 7004,
EDITION_NOT_FOUND = 8001,
LIBRARY_ALREADY_EXISTS = 8002,
LIBRARY_REPOSITORY_AUTHENTICATION_ERROR = 8003,
LIBRARY_PUBLISH_ERROR = 8004,
LIBRARY_UPLOAD_ERROR = 8005,
LIBRARY_DOWNLOAD_ERROR = 8006,
LOCAL_LIBRARY_NOT_FOUND = 8007,
LIBRARY_NOT_RESOLVED = 8008,
INVALID_LIBRARY_NAME = 8009,
DEPENDENCY_DISCOVERY_ERROR = 8010,
INVALID_SEMVER_VERSION = 8011,
EXPRESSION_NOT_FOUND = 9001,
FAILED_TO_APPLY_EDITS = 9002,
REFACTORING_NOT_SUPPORTED = 9003,
}
const RemoteRpcErrorSchema = z.object({
code: z.nativeEnum(ErrorCode),
message: z.string(),
data: z.optional(z.any()),
})
type RemoteRpcErrorParsed = z.infer<typeof RemoteRpcErrorSchema>
export class RemoteRpcError {
code: ErrorCode
message: string
data?: any
constructor(error: RemoteRpcErrorParsed) {
this.code = error.code
this.message = error.message
this.data = error.data
}
}
export class LsRpcError extends Error {
cause: RemoteRpcError | Error
request: string
params: object
constructor(cause: RemoteRpcError | Error, request: string, params: object) {
super(`Language server request '${request}' failed.`)
this.cause = cause
this.request = request
this.params = params
}
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md) */
export class LanguageServer extends ObservableV2<Notifications> {
client: Client
handlers: Map<string, Set<(...params: any[]) => void>>
constructor(client: Client) {
super()
this.client = client
this.handlers = new Map()
client.onNotification((notification) => {
this.emit(notification.method as keyof Notifications, [notification.params])
})
client.onError((error) => {
console.error(`Unexpected LS connection error:`, error)
})
}
// The "magic bag of holding" generic that is only present in the return type is UNSOUND.
// However, it is SAFE, as the return type of the API is statically known.
private async request<T>(method: string, params: object): Promise<T> {
const uuid = uuidv4()
const now = performance.now()
try {
if (DEBUG_LOG_RPC) {
console.log(`LS [${uuid}] ${method}:`)
console.dir(params)
}
return await this.client.request({ method, params }, RPC_TIMEOUT_MS)
} catch (e) {
const remoteError = RemoteRpcErrorSchema.safeParse(e)
if (remoteError.success) {
throw new LsRpcError(new RemoteRpcError(remoteError.data), method, params)
} else if (e instanceof Error) {
throw new LsRpcError(e, method, params)
}
throw e
} finally {
if (DEBUG_LOG_RPC) {
console.log(`LS [${uuid}] ${method} took ${performance.now() - now}ms`)
}
}
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#capabilityacquire) */
acquireCapability(method: string, registerOptions: RegisterOptions): Promise<void> {
return this.request('capability/acquire', { method, registerOptions })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#filereceivestreeupdates) */
acquireReceivesTreeUpdates(path: Path): Promise<void> {
return this.acquireCapability('file/receivesTreeUpdates', { path })
}
acquireExecutionContextCanModify(contextId: ContextId): Promise<void> {
return this.acquireCapability('executionContext/canModify', { contextId })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#sessioninitprotocolconnection) */
initProtocolConnection(clientId: Uuid): Promise<response.InitProtocolConnection> {
return this.request('session/initProtocolConnection', { clientId })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#textopenfile) */
openTextFile(path: Path): Promise<response.OpenTextFile> {
return this.request('text/openFile', { path })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#textclosefile) */
closeTextFile(path: Path): Promise<void> {
return this.request('text/closeFile', { path })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#textsave) */
saveTextFile(path: Path, currentVersion: Checksum): Promise<void> {
return this.request('text/save', { path, currentVersion })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#textapplyedit) */
applyEdit(edit: FileEdit, execute: boolean): Promise<void> {
return this.request('text/applyEdit', { edit, execute })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#filewrite) */
writeFile(path: Path, contents: TextFileContents): Promise<void> {
return this.request('file/write', { path, contents })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#fileread) */
readFile(path: Path): Promise<response.FileContents> {
return this.request('file/read', { path })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#filecreate) */
createFile(object: FileSystemObject): Promise<void> {
return this.request('file/create', { object })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#filedelete) */
deleteFile(path: Path): Promise<void> {
return this.request('file/delete', { path })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#filecopy) */
copyFile(from: Path, to: Path): Promise<void> {
return this.request('file/copy', { from, to })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#filemove) */
moveFile(from: Path, to: Path): Promise<void> {
return this.request('file/move', { from, to })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#fileexists) */
fileExists(path: Path): Promise<response.FileExists> {
return this.request('file/exists', { path })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#filetree) */
fileTree(path: Path, depth?: number): Promise<response.FileTree> {
return this.request('file/tree', { path, depth })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#filelist) */
listFiles(path: Path): Promise<response.FileList> {
return this.request('file/list', { path })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#fileinfo) */
fileInfo(path: Path): Promise<response.FileInfo> {
return this.request('file/info', { path })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#filechecksum) */
fileChecksum(path: Path): Promise<response.FileChecksum> {
return this.request('file/checksum', { path })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#vcsinit) */
vcsInit(root: Path): Promise<void> {
return this.request('vcs/init', { root })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#vcssave) */
vcsSave(root: Path, name?: string): Promise<response.VCSCommit> {
return this.request('vcs/save', { root, name })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#vcsstatus) */
vcsStatus(root: Path): Promise<response.VCSStatus> {
return this.request('vcs/status', { root })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#vcsrestore) */
vcsRestore(root: Path, commitId?: string): Promise<response.VCSChanges> {
return this.request('vcs/restore', { root, commitId })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#vcslist) */
vcsList(root: Path, limit?: number): Promise<response.VCSSaves> {
return this.request('vcs/list', { root, limit })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#executioncontextcreate) */
createExecutionContext(contextId?: ContextId): Promise<response.ExecutionContext> {
return this.request('executionContext/create', { contextId })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#executioncontextdestroy) */
destroyExecutionContext(contextId: ContextId): Promise<void> {
return this.request('executionContext/destroy', { contextId })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#executioncontextfork) */
forkExecutionContext(contextId: ContextId): Promise<response.ExecutionContext> {
return this.request('executionContext/fork', { contextId })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#executioncontextpush) */
pushExecutionContextItem(contextId: ContextId, stackItem: StackItem): Promise<void> {
return this.request('executionContext/push', { contextId, stackItem })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#executioncontextpop) */
popExecutionContextItem(contextId: ContextId): Promise<void> {
return this.request('executionContext/pop', { contextId })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#executioncontextrecompute) */
recomputeExecutionContext(
contextId: ContextId,
invalidatedExpressions?: 'all' | string[],
executionEnvironment?: ExecutionEnvironment,
): Promise<void> {
return this.request('executionContext/recompute', {
contextId,
invalidatedExpressions,
executionEnvironment,
})
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#executioncontextinterrupt) */
interruptExecutionContext(contextId: ContextId): Promise<void> {
return this.request('executionContext/interrupt', { contextId })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#executioncontextsetexecutionenvironment) */
setExecutionEnvironment(
contextId: ContextId,
executionEnvironment?: ExecutionEnvironment,
): Promise<void> {
return this.request('executionContext/setExecutionEnvironment', {
contextId,
executionEnvironment,
})
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#executioncontextexecuteexpression) */
executeExpression(
visualizationId: Uuid,
expressionId: ExpressionId,
visualizationConfig: VisualizationConfiguration,
): Promise<void> {
return this.request('executionContext/executeExpression', {
visualizationId,
expressionId,
visualizationConfig,
})
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#executioncontextattachvisualization) */
attachVisualization(
visualizationId: Uuid,
expressionId: ExpressionId,
visualizationConfig: VisualizationConfiguration,
): Promise<void> {
return this.request('executionContext/attachVisualization', {
visualizationId,
expressionId,
visualizationConfig,
})
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#executioncontextdetachvisualization) */
detachVisualization(
visualizationId: Uuid,
expressionId: ExpressionId,
contextId: ContextId,
): Promise<void> {
return this.request('executionContext/detachVisualization', {
visualizationId,
expressionId,
contextId,
})
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#executioncontextmodifyvisualization) */
modifyVisualization(
visualizationId: Uuid,
visualizationConfig: VisualizationConfiguration,
): Promise<void> {
return this.request('executionContext/modifyVisualization', {
visualizationId,
visualizationConfig,
})
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#searchgetsuggestionsdatabase) */
getSuggestionsDatabase(): Promise<response.GetSuggestionsDatabase> {
return this.request('search/getSuggestionsDatabase', {})
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#runtimegetcomponentgroups) */
getComponentGroups(): Promise<response.GetComponentGroups> {
return this.request('runtime/getComponentGroups', {})
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#profilingstart) */
profilingStart(memorySnapshot?: boolean): Promise<void> {
return this.request('profiling/start', { memorySnapshot })
}
/** [Documentation](https://github.com/enso-org/enso/blob/develop/docs/language-server/protocol-language-server.md#profilingstop) */
profilingStop(): Promise<void> {
return this.request('profiling/stop', {})
}
/** A helper function to subscribe to file updates.
* Please use `ls.on('file/event')` directly if the initial `'Added'` notifications are not
* needed. */
watchFiles(
rootId: Uuid,
segments: string[],
callback: (event: Event<'file/event'>) => void,
retry: <T>(cb: () => Promise<T>) => Promise<T> = (f) => f(),
) {
let running = true
;(async () => {
this.on('file/event', callback)
walkFs(this, { rootId, segments }, (type, path) => {
if (
!running ||
type !== 'File' ||
path.segments.length < segments.length ||
segments.some((seg, i) => seg !== path.segments[i])
)
return
callback({
path: { rootId: path.rootId, segments: path.segments.slice(segments.length) },
kind: 'Added',
})
})
await retry(() => this.acquireReceivesTreeUpdates({ rootId, segments }))
if (!running) return
})()
return () => {
running = false
this.off('file/event', callback)
}
}
dispose() {
this.client.close()
}
}
export function computeTextChecksum(text: string): Checksum {
return bytesToHex(SHA3.create().update(text).digest()) as Checksum
}