Show LSP protocol messages in VSCode extension

[genericptr]

In Sublime Text I get messages from the protocol like :: [20:00:17.228] --> PasLS textDocument/hover (35): in the console. VSCode is have a "trace" feature but I've tried multiple times to get it working and never figured it out.

The reason I want this is because in VSCode I have some files which don't show document symbols and I have no idea what the server is doing. The same files work in Sublime Text.

@mvancanneyt You did some work on the VSCode extension, did you ever figure out how to do this?

[mvancanneyt]

Everything in pasls that goes to stderr is printed on the 'output' tab:

Do you see the initial messages from the server ?
Because if you do, then all should be fine ?

[genericptr]

No stdout is good but the extension doesn't tell you what messages were sent.

This is what Sublime Text does. I want to know why those aforementioned files didn't show symbols. Nothing happens and there's no way to know what was even sent to the server or what it responded with.

:: [20:39:51.206] --> PasLS textDocument/hover (2): {'textDocument': {'uri': 'file:///Users/ryanjoseph/Developer/Projects/FPC/pascal-language-server/src/serverprotocol/PasLS.Completion.pas'}, 'position': {'line': 48, 'character': 21}}
:: [20:39:51.252] <<< PasLS (2) (duration: 46ms): {'contents': {'kind': 'markdown', 'value': '```pascal\npublic property TCompletionItemHelper.secondaryText:string\n/Users/ryanjoseph/Developer/Projects/FPC/pascal-language-server/src/serverprotocol/PasLS.Completion.pas(49,18)\n```'}, 'range': {'end': {'character': 21, 'line': 48}, 'start': {'character': 21, 'line': 48}}}
:: [20:39:52.267] --> PasLS textDocument/hover (3): {'textDocument': {'uri': 'file:///Users/ryanjoseph/Developer/Projects/FPC/pascal-language-server/src/serverprotocol/PasLS.Completion.pas'}, 'position': {'line': 47, 'character': 21}}
:: [20:39:52.268] <<< PasLS (3) (duration: 1ms): {'contents': {'kind': 'markdown', 'value': '```pascal\npublic property TCompletionItemHelper.primaryText:string\n/Users/ryanjoseph/Developer/Projects/FPC/pascal-language-server/src/serverprotocol/PasLS.Completion.pas(48,18)\n```'}, 'range': {'end': {'character': 21, 'line': 47}, 'start': {'character': 21, 'line': 47}}}
:: [20:39:54.205] --> PasLS textDocument/documentHighlight (4): {'textDocument': {'uri': 'file:///Users/ryanjoseph/Developer/Projects/FPC/pascal-language-server/src/serverprotocol/PasLS.Completion.pas'}, 'position': {'line': 59, 'character': 39}}
:: [20:39:54.207] <<< PasLS (4) (duration: 1ms): []
:: [20:39:54.272] --> PasLS textDocument/definition (5): {'textDocument': {'uri': 'file:///Users/ryanjoseph/Developer/Projects/FPC/pascal-language-server/src/serverprotocol/PasLS.Completion.pas'}, 'position': {'line': 59, 'character': 39}, 'workDoneToken': '$ublime-work-done-progress-5'}
:: [20:39:54.272] <<< PasLS (5) (duration: 0ms): {'range': {'end': {'character': 32, 'line': 44}, 'start': {'character': 18, 'line': 44}}, 'uri': 'file:///Users/ryanjoseph/Developer/Projects/FPC/pascal-language-server/src/serverprotocol/PasLS.Completion.pas'}
:: [20:39:54.595] --> PasLS textDocument/documentHighlight (6): {'textDocument': {'uri': 'file:///Users/ryanjoseph/Developer/Projects/FPC/pascal-language-server/src/serverprotocol/PasLS.Completion.pas'}, 'position': {'line': 44, 'character': 18}}
:: [20:39:54.597] <<< PasLS (6) (duration: 1ms): []

[mvancanneyt]

This took some time to pinpoint.

The problem is the following. In the extension.js the folowing happens:

client = new vscode_languageclient_1.LanguageClient('pascal-language-server',...

The VSCode language client will look for the logging settings under 'pascal-language-server', but that does not exist, as the tool uses 'pascalLanguageServer' for its settings !

So the solution is to change the above to

client = new vscode_languageclient_1.LanguageClient('pascalLanguageServer',...

With this modification, when you set in your settings.json somewhere

"pascalLanguageServer.trace.server": "verbose"

Then you will see the output.

So long story short: name mismatch in extension.js, needs to be fixed.

[genericptr]

Excellent catch! I want to test this but I'm getting an error in the extension now.

src/extension.ts:39:8 - error TS2307: Cannot find module './servermessages' or its corresponding type declarations.

Is this a regression from me merging the repos? I'm looking at the old repo and I don't see any servermessages.ts file, I guess it's part of VSCode or did it not get committed?

[genericptr]

Claude suggested adding this file, which actually worked but where is the original file?

import { TextEditorDecorationType } from 'vscode';

export interface InputRegion {
    startLine: number;
    startCol: number;
    endLine: number;
    endCol: number;
}

export interface InactiveRegionParams {
    uri: string;
    regions: InputRegion[];
}

export interface DecorationRangesPair {
    decoration: TextEditorDecorationType;
    ranges: any[];
}

[mvancanneyt]

Here is the original: #137

[mvancanneyt]

It builds when I add that file to src. But there are really a lot of warnings when building, we should probably look at the dependencies. the following is shown when you run npm install:

npm warn deprecated inflight@1.0.6: This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.
npm warn deprecated rimraf@3.0.2: Rimraf versions prior to v4 are no longer supported
npm warn deprecated glob@7.2.3: Glob versions prior to v9 are no longer supported
npm warn deprecated fstream@1.0.12: This package is no longer supported.
npm warn deprecated rimraf@2.6.3: Rimraf versions prior to v4 are no longer supported
npm warn deprecated mkdirp@0.5.4: Legacy versions of mkdirp are no longer supported. Please update to mkdirp 1.x. (Note that the API surface has changed to use Promises in 1.x.)
npm warn deprecated debug@3.2.6: Debug versions >=3.2.0 <3.2.7 || >=4 <4.3.1 have a low-severity ReDos regression when used in a Node.js environment. It is recommended you upgrade to 3.2.7 or 4.3.1. (https://github.com/visionmedia/debug/issues/797)
npm warn deprecated vscode-test@1.6.1: This package has been renamed to @vscode/test-electron, please update to the new name
npm warn deprecated eslint@6.8.0: This version is no longer supported. Please see https://eslint.org/version-support for other options.
npm warn deprecated glob@7.1.3: Glob versions prior to v9 are no longer supported

Probably vscode-test is the culprit ?

[angelozerr]

@genericptr perhaps I have not understood the issue, but if you want to see LSP Traces with your vscode extension, you should add in your settings.json:

pascalLanguageServer.trace.server": "verbose"

and you should see in the Output combo your Pascal Language Server. Select it and you should see LSP Traces