From ffd080f172ce2afa9542382b771e8a7b2a5ae1c8 Mon Sep 17 00:00:00 2001 From: Bastian Doetsch Date: Mon, 11 Sep 2023 12:16:36 +0200 Subject: [PATCH] feat: add always start with `language-server` positional arg, add logging args if given [HEAD-693] (#374) * feat: add detection for standalone/cli-embedded based on size, add logging args if given `-d` or env var - SNYK_LOG_DEVEL overrules all log level settings now - `-d` or `--debug` in additional parameters now puts language server in debug mode Signed-off-by: Bastian Doetsch * fix: make test method sync'ed Signed-off-by: Bastian Doetsch * fix: tests Signed-off-by: Bastian Doetsch * chore: remove unnecessary check for binary size Signed-off-by: Bastian Doetsch * docs: update CHANGELOG.md Signed-off-by: Bastian Doetsch --------- Signed-off-by: Bastian Doetsch --- CHANGELOG.md | 7 +- .../common/languageServer/languageServer.ts | 20 +++++- .../languageServer/languageServer.test.ts | 67 +++++++++++++++++-- 3 files changed, 85 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f91212396..499b63c7b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,11 @@ # Snyk Security - Code and Open Source Dependencies Changelog -## [1.21.6] +## [1.23.0] +- add `language-server` as first positional argument to language server start +- enable setting of log level in language server via SNYK_LOG_LEVEL +- enable setting of debug level in language server via `-d` or `--debug` + +## [1.22.0] ### Added diff --git a/src/snyk/common/languageServer/languageServer.ts b/src/snyk/common/languageServer/languageServer.ts index b9ca37a04..b970f6493 100644 --- a/src/snyk/common/languageServer/languageServer.ts +++ b/src/snyk/common/languageServer/languageServer.ts @@ -24,10 +24,13 @@ import { LsExecutable } from './lsExecutable'; import { LanguageClientMiddleware } from './middleware'; import { InitializationOptions, LanguageServerSettings } from './settings'; import { CodeIssueData, IacIssueData, OssIssueData, Scan } from './types'; +import * as fs from 'fs'; export interface ILanguageServer { start(): Promise; + stop(): Promise; + showOutputChannel(): void; cliReady$: ReplaySubject; @@ -77,11 +80,24 @@ export class LanguageServer implements ILanguageServer { const lsBinaryPath = LsExecutable.getPath(this.configuration.getSnykLanguageServerPath()); - this.logger.info(`Snyk Language Server path: ${lsBinaryPath}`); + // log level is set to info by default + let logLevel = 'info'; + const additionalCliParameters = this.configuration.getAdditionalCliParameters(); + if ( + additionalCliParameters != null && + additionalCliParameters.length > 0 && + (additionalCliParameters.includes('-d') || additionalCliParameters.includes('--debug')) + ) { + logLevel = 'debug'; + } + logLevel = process.env.SNYK_LOG_LEVEL ?? logLevel; + const args = ['language-server', '-l', logLevel]; + this.logger.info(`Snyk Language Server - path: ${lsBinaryPath}`); + this.logger.info(`Snyk Language Server - args: ${args}`); const serverOptions: ServerOptions = { command: lsBinaryPath, - args: ['-l', 'info'], + args: args, options: { env: processEnv, }, diff --git a/src/test/unit/common/languageServer/languageServer.test.ts b/src/test/unit/common/languageServer/languageServer.test.ts index 8c79cc50e..731b9f7a6 100644 --- a/src/test/unit/common/languageServer/languageServer.test.ts +++ b/src/test/unit/common/languageServer/languageServer.test.ts @@ -1,5 +1,5 @@ -/* eslint-disable @typescript-eslint/no-unsafe-member-access */ -import assert, { deepStrictEqual, strictEqual } from 'assert'; +/* eslint-disable @typescript-eslint/no-empty-function */ +import assert, { deepStrictEqual, fail, strictEqual } from 'assert'; import { ReplaySubject } from 'rxjs'; import sinon from 'sinon'; import { v4 } from 'uuid'; @@ -24,13 +24,23 @@ suite('Language Server', () => { let configurationMock: IConfiguration; let languageServer: LanguageServer; let downloadServiceMock: DownloadService; + const path = 'testPath'; + const logger = { + info(_msg: string) {}, + warn(_msg: string) {}, + log(_msg: string) {}, + error(msg: string) { + fail(msg); + }, + } as unknown as LoggerMock; + setup(() => { configurationMock = { getInsecure(): boolean { return true; }, getCliPath(): string | undefined { - return 'testPath'; + return path; }, getToken(): Promise { return Promise.resolve('testToken'); @@ -38,10 +48,10 @@ suite('Language Server', () => { shouldReportEvents: true, shouldReportErrors: true, getSnykLanguageServerPath(): string { - return 'testPath'; + return path; }, getAdditionalCliParameters() { - return '--all-projects'; + return '--all-projects -d'; }, isAutomaticDependencyManagementEnabled() { return true; @@ -76,6 +86,49 @@ suite('Language Server', () => { sinon.restore(); }); + test('LanguageServer starts with correct args', async () => { + const lca = sinon.spy({ + create( + _id: string, + _name: string, + serverOptions: ServerOptions, + // eslint-disable-next-line @typescript-eslint/no-unused-vars + _clientOptions: LanguageClientOptions, + ): LanguageClient { + return { + start(): Promise { + assert.strictEqual('args' in serverOptions ? serverOptions?.args?.[0] : '', 'language-server'); + assert.strictEqual('args' in serverOptions ? serverOptions?.args?.[1] : '', '-l'); + assert.strictEqual('args' in serverOptions ? serverOptions?.args?.[2] : '', 'debug'); + return Promise.resolve(); + }, + onNotification(): void { + return; + }, + onReady(): Promise { + return Promise.resolve(); + }, + } as unknown as LanguageClient; + }, + }); + + languageServer = new LanguageServer( + user, + configurationMock, + lca as unknown as ILanguageClientAdapter, + stubWorkspaceConfiguration('snyk.loglevel', 'trace'), + windowMock, + authServiceMock, + logger, + downloadServiceMock, + ); + downloadServiceMock.downloadReady$.next(); + + await languageServer.start(); + sinon.assert.called(lca.create); + sinon.verify(); + }); + test('LanguageServer adds proxy settings to env of started binary', async () => { const expectedProxy = 'http://localhost:8080'; const lca = sinon.spy({ @@ -90,9 +143,11 @@ suite('Language Server', () => { assert.strictEqual(id, 'Snyk LS'); assert.strictEqual(name, 'Snyk Language Server'); assert.strictEqual( + // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access 'options' in serverOptions ? serverOptions?.options?.env?.http_proxy : undefined, expectedProxy, ); + // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access assert.strictEqual(clientOptions.initializationOptions.token, 'testToken'); return Promise.resolve(); }, @@ -158,7 +213,7 @@ suite('Language Server', () => { automaticAuthentication: 'false', endpoint: undefined, organization: undefined, - additionalParams: '--all-projects', + additionalParams: '--all-projects -d', manageBinariesAutomatically: 'true', deviceId: user.anonymousId, filterSeverity: { critical: true, high: true, medium: true, low: true },