Use new vscode.LogOutputChannel api (#33)

jeanp413 · web-flow · commit 8ddd0050abb9 · 2023-02-10T13:22:58.000-05:00
diff --git a/package.json b/package.json
@@ -14,7 +14,7 @@
 		"url": "https://github.com/gitpod-io/gitpod/issues"
 	},
 	"engines": {
-		"vscode": "^1.63.0"
+		"vscode": "^1.74.0"
 	},
 	"categories": [
 		"Other"
@@ -146,7 +146,7 @@
 		"@types/ssh2": "^0.5.52",
 		"@types/tmp": "^0.2.1",
 		"@types/uuid": "8.0.0",
-		"@types/vscode": "^1.63.0",
+		"@types/vscode": "1.74.0",
 		"@types/webpack": "^5.28.0",
 		"@types/ws": "^7.4.7",
 		"@types/yazl": "^2.4.2",
diff --git a/src/authentication.ts b/src/authentication.ts
@@ -7,7 +7,6 @@ import * as vscode from 'vscode';
 import { v4 as uuid } from 'uuid';
 import Keychain from './common/keychain';
 import GitpodServer from './gitpodServer';
-import Log from './common/logger';
 import { arrayEquals } from './common/utils';
 import { Disposable } from './common/dispose';
 import TelemetryReporter from './telemetryReporter';
@@ -27,7 +26,6 @@ interface SessionData {
 
 export default class GitpodAuthenticationProvider extends Disposable implements vscode.AuthenticationProvider {
 	private _sessionChangeEmitter = new vscode.EventEmitter<vscode.AuthenticationProviderAuthenticationSessionsChangeEvent>();
-	private _logger: Log;
 	private _telemetry: TelemetryReporter;
 
 	private _gitpodServer!: GitpodServer;
@@ -40,13 +38,12 @@ export default class GitpodAuthenticationProvider extends Disposable implements
 
 	constructor(
 		private readonly context: vscode.ExtensionContext,
-		logger: Log,
+		private readonly _logger: vscode.LogOutputChannel,
 		telemetry: TelemetryReporter,
 		private readonly notifications: NotificationService
 	) {
 		super();
 
-		this._logger = logger;
 		this._telemetry = telemetry;
 
 		this.reconcile();
diff --git a/src/common/keychain.ts b/src/common/keychain.ts
@@ -6,13 +6,12 @@
 // keytar depends on a native module shipped in vscode, so this is
 // how we load it
 import * as vscode from 'vscode';
-import Log from './logger';
 
 export default class Keychain {
 	constructor(
 		private readonly context: vscode.ExtensionContext,
 		private readonly serviceId: string,
-		private readonly logger: Log
+		private readonly logger: vscode.LogOutputChannel
 	) { }
 
 	async setToken(token: string): Promise<void> {
diff --git a/src/common/logger.ts b/src/common/logger.ts
diff --git a/src/experiments.ts b/src/experiments.ts
@@ -7,7 +7,6 @@ import * as vscode from 'vscode';
 import * as configcat from 'configcat-node';
 import * as configcatcommon from 'configcat-common';
 import * as semver from 'semver';
-import Log from './common/logger';
 
 const EXPERTIMENTAL_SETTINGS = [
     'gitpod.remote.useLocalApp'
@@ -21,7 +20,7 @@ export class ExperimentalSettings {
         key: string,
         extensionVersion: string,
         private readonly context: vscode.ExtensionContext,
-        private readonly logger: Log
+        private readonly logger: vscode.LogOutputChannel
     ) {
         this.configcatClient = configcat.createClientWithLazyLoad(key, {
             baseUrl: new URL('/configcat', this.context.extensionMode === vscode.ExtensionMode.Production ? 'https://gitpod.io' : 'https://gitpod-staging.com').href,
diff --git a/src/extension.ts b/src/extension.ts
@@ -7,7 +7,6 @@ import * as os from 'os';
 import * as vscode from 'vscode';
 import fetch, { Headers, Request, Response, AbortError, FetchError } from 'node-fetch-commonjs';
 import GitpodAuthenticationProvider from './authentication';
-import Log from './common/logger';
 import { UserFlowTelemetry } from './common/telemetry';
 import { ExperimentalSettings } from './experiments';
 import { exportLogs } from './exportLogs';
@@ -40,7 +39,15 @@ export async function activate(context: vscode.ExtensionContext) {
 	// sync between machines
 	context.globalState.setKeysForSync([ReleaseNotes.RELEASE_NOTES_LAST_READ_KEY]);
 
-	const logger = new Log('Gitpod');
+	const logger = vscode.window.createOutputChannel('Gitpod', { log: true });
+	context.subscriptions.push(logger);
+
+	const onDidChangeLogLevel = (logLevel: vscode.LogLevel) => {
+		logger.appendLine(`Log level: ${vscode.LogLevel[logLevel]}`);
+	};
+	context.subscriptions.push(logger.onDidChangeLogLevel(onDidChangeLogLevel));
+	onDidChangeLogLevel(logger.logLevel);
+
 	logger.info(`${extensionId}/${packageJSON.version} (${os.release()} ${os.platform()} ${os.arch()}) vscode/${vscode.version} (${vscode.env.appName})`);
 
 	const experiments = new ExperimentalSettings('gitpod', packageJSON.version, context, logger);
diff --git a/src/featureSupport.ts b/src/featureSupport.ts
@@ -4,7 +4,6 @@
  *--------------------------------------------------------------------------------------------*/
 import * as vscode from 'vscode';
 import * as semver from 'semver';
-import Log from './common/logger';
 import { retry } from './common/async';
 
 export class GitpodVersion {
@@ -37,7 +36,7 @@ export class GitpodVersion {
 }
 
 let cacheGitpodVersion: { host: string; version: GitpodVersion } | undefined;
-async function getOrFetchVersionInfo(serviceUrl: string, logger: Log) {
+async function getOrFetchVersionInfo(serviceUrl: string, logger: vscode.LogOutputChannel) {
     if (serviceUrl === 'https://gitpod.io') {
         // SaaS default allow all features, should proper handle SaaS feature support if needed in the future
         return {
@@ -83,7 +82,7 @@ async function getOrFetchVersionInfo(serviceUrl: string, logger: Log) {
     return cacheGitpodVersion;
 }
 
-export async function getGitpodVersion(gitpodHost: string, logger: Log) {
+export async function getGitpodVersion(gitpodHost: string, logger: vscode.LogOutputChannel) {
     const serviceUrl = new URL(gitpodHost).toString().replace(/\/$/, '');
     const versionInfo = await getOrFetchVersionInfo(serviceUrl, logger);
     return versionInfo.version;
diff --git a/src/gitpodServer.ts b/src/gitpodServer.ts
@@ -4,7 +4,6 @@
  *--------------------------------------------------------------------------------------------*/
 
 import * as vscode from 'vscode';
-import Log from './common/logger';
 import { PromiseAdapter, promiseFromEvent } from './common/utils';
 import { withServerApi } from './internalApi';
 import pkceChallenge from 'pkce-challenge';
@@ -21,7 +20,7 @@ interface ExchangeTokenResponse {
 	scope: string;
 }
 
-async function getUserInfo(token: string, serviceUrl: string, logger: Log) {
+async function getUserInfo(token: string, serviceUrl: string, logger: vscode.LogOutputChannel) {
 	const user = await withServerApi(token, serviceUrl, service => service.server.getLoggedInUser(), logger);
 	return {
 		id: user.id,
@@ -41,7 +40,7 @@ export default class GitpodServer extends Disposable {
 
 	constructor(
 		serviceUrl: string,
-		private readonly _logger: Log,
+		private readonly _logger: vscode.LogOutputChannel,
 		private readonly notifications: NotificationService
 	) {
 		super();
diff --git a/src/heartbeat.ts b/src/heartbeat.ts
@@ -7,7 +7,6 @@ import { WorkspaceInfo } from '@gitpod/gitpod-protocol';
 import { Workspace, WorkspaceInstanceStatus_Phase } from '@gitpod/public-api/lib/gitpod/experimental/v1/workspaces_pb';
 import * as vscode from 'vscode';
 import { Disposable } from './common/dispose';
-import Log from './common/logger';
 import { withServerApi } from './internalApi';
 import { GitpodPublicApi } from './publicApi';
 import TelemetryReporter from './telemetryReporter';
@@ -28,7 +27,7 @@ export class HeartbeatManager extends Disposable {
         readonly debugWorkspace: boolean,
         private readonly accessToken: string,
         private readonly publicApi: GitpodPublicApi | undefined,
-        private readonly logger: Log,
+        private readonly logger: vscode.LogOutputChannel,
         private readonly telemetry: TelemetryReporter
     ) {
         super();
@@ -79,7 +78,7 @@ export class HeartbeatManager extends Disposable {
             }
         }));
 
-        this.logger.trace(`Heartbeat manager for workspace ${workspaceId} (${instanceId}) - ${gitpodHost} started`);
+        this.logger.debug(`Heartbeat manager for workspace ${workspaceId} (${instanceId}) - ${gitpodHost} started`);
 
         // Start heartbeating interval
         this.sendHeartBeat();
@@ -103,7 +102,6 @@ export class HeartbeatManager extends Disposable {
     }
 
     private async sendHeartBeat(wasClosed?: true) {
-        const suffix = wasClosed ? 'closed heartbeat' : 'heartbeat';
         try {
             await withServerApi(this.accessToken, this.gitpodHost, async service => {
                 const workspaceInfo = this.publicApi
@@ -118,15 +116,18 @@ export class HeartbeatManager extends Disposable {
                         : await service.server.sendHeartBeat({ instanceId: this.instanceId, wasClosed });
                     if (wasClosed) {
                         this.telemetry.sendTelemetryEvent('ide_close_signal', { workspaceId: this.workspaceId, instanceId: this.instanceId, gitpodHost: this.gitpodHost, clientKind: 'vscode', debugWorkspace: String(!!this.debugWorkspace) });
-                        this.logger.trace('Send ' + suffix);
+                        this.logger.trace(`Send closed heartbeat`);
+                    } else {
+                        this.logger.trace(`Send heartbeat, triggered by ${this.lastActivityEvent} event`);
                     }
                 } else {
                     this.logger.trace('Stopping heartbeat as workspace is not running');
                     this.stopHeartbeat();
                 }
             }, this.logger);
         } catch (err) {
-            this.logger.error(`Failed to send ${suffix} with event ${this.lastActivityEvent}:`, err);
+            const suffix = wasClosed ? 'closed heartbeat' : 'heartbeat';
+            this.logger.error(`Failed to send ${suffix}, triggered by ${this.lastActivityEvent} event:`, err);
         }
     }
 
diff --git a/src/internalApi.ts b/src/internalApi.ts
@@ -9,7 +9,6 @@ import { listen as doListen } from 'vscode-ws-jsonrpc';
 import WebSocket, { ErrorEvent } from 'ws';
 import ReconnectingWebSocket from 'reconnecting-websocket';
 import * as vscode from 'vscode';
-import Log from './common/logger';
 
 type UsedGitpodFunction = ['getLoggedInUser', 'getWorkspace', 'getOwnerToken', 'getSSHPublicKeys', 'sendHeartBeat'];
 type Union<Tuple extends any[], Union = never> = Tuple[number] | Union;
@@ -26,7 +25,7 @@ class GitpodServerApi extends vscode.Disposable {
 	private readonly onErrorEmitter = new vscode.EventEmitter<Error>();
 	readonly onError = this.onErrorEmitter.event;
 
-	constructor(accessToken: string, serviceUrl: string, private readonly logger: Log) {
+	constructor(accessToken: string, serviceUrl: string, readonly logger: vscode.LogOutputChannel) {
 		super(() => this.internalDispose());
 
 		serviceUrl = serviceUrl.replace(/\/$/, '');
@@ -59,7 +58,12 @@ class GitpodServerApi extends vscode.Disposable {
 
 		doListen({
 			webSocket: (webSocket as any),
-			logger: this.logger,
+			logger: {
+				error(m: string) { logger.error(m); },
+				warn(m: string) { logger.warn(m); },
+				info(m: string) { logger.info(m); },
+				log(m: string) { logger.info(m); }
+			},
 			onConnection: connection => factory.listen(connection),
 		});
 		this.webSocket = webSocket;
@@ -71,7 +75,7 @@ class GitpodServerApi extends vscode.Disposable {
 	}
 }
 
-export function withServerApi<T>(accessToken: string, serviceUrl: string, cb: (service: GitpodConnection) => Promise<T>, logger: Log): Promise<T> {
+export function withServerApi<T>(accessToken: string, serviceUrl: string, cb: (service: GitpodConnection) => Promise<T>, logger: vscode.LogOutputChannel): Promise<T> {
 	const api = new GitpodServerApi(accessToken, serviceUrl, logger);
 	return Promise.race([
 		cb(api.service),
diff --git a/src/releaseNotes.ts b/src/releaseNotes.ts
@@ -7,7 +7,6 @@ import * as vscode from 'vscode';
 import { load } from 'js-yaml';
 import { CacheHelper } from './common/cache';
 import { Disposable, disposeAll } from './common/dispose';
-import Log from './common/logger';
 
 export class ReleaseNotes extends Disposable {
 	public static readonly viewType = 'gitpodReleaseNotes';
@@ -21,7 +20,7 @@ export class ReleaseNotes extends Disposable {
 
 	constructor(
 		private readonly context: vscode.ExtensionContext,
-		private readonly logger: Log,
+		private readonly logger: vscode.LogOutputChannel,
 	) {
 		super();
 
diff --git a/src/remoteConnector.ts b/src/remoteConnector.ts
@@ -20,7 +20,6 @@ import { ParsedKey } from 'ssh2-streams';
 import * as tmp from 'tmp';
 import * as path from 'path';
 import * as vscode from 'vscode';
-import Log from './common/logger';
 import { Disposable } from './common/dispose';
 import { withServerApi } from './internalApi';
 import TelemetryReporter from './telemetryReporter';
@@ -127,7 +126,7 @@ export default class RemoteConnector extends Disposable {
 		private readonly context: vscode.ExtensionContext,
 		private readonly settingsSync: SettingsSync,
 		private readonly experiments: ExperimentalSettings,
-		private readonly logger: Log,
+		private readonly logger: vscode.LogOutputChannel,
 		private readonly telemetry: TelemetryReporter,
 		private readonly notifications: NotificationService
 	) {
diff --git a/src/settingsSync.ts b/src/settingsSync.ts
@@ -5,7 +5,6 @@
 
 import * as vscode from 'vscode';
 import { Disposable } from './common/dispose';
-import Log from './common/logger';
 import { UserFlowTelemetry } from './common/telemetry';
 import { NotificationService } from './notification';
 import TelemetryReporter from './telemetryReporter';
@@ -107,7 +106,7 @@ export class SettingsSync extends Disposable {
 	private readonly flow: Readonly<UserFlowTelemetry> = { flow: 'settings_sync' };
 
 	constructor(
-		private readonly logger: Log,
+		private readonly logger: vscode.LogOutputChannel,
 		private readonly telemetry: TelemetryReporter,
 		private readonly notifications: NotificationService
 	) {
diff --git a/src/ssh/identityFiles.ts b/src/ssh/identityFiles.ts
@@ -10,7 +10,7 @@ import * as crypto from 'crypto';
 import { ParsedKey } from 'ssh2-streams';
 import * as ssh2 from 'ssh2';
 import { untildify, exists as fileExists } from '../common/files';
-import Log from '../common/logger';
+import * as vscode from 'vscode';
 
 const homeDir = os.homedir();
 const PATH_SSH_CLIENT_ID_DSA = path.join(homeDir, '.ssh', '/id_dsa');
@@ -40,7 +40,7 @@ export interface SSHKey {
 }
 
 // From https://github.com/openssh/openssh-portable/blob/acb2059febaddd71ee06c2ebf63dcf211d9ab9f2/sshconnect2.c#L1689-L1690
-export async function gatherIdentityFiles(identityFiles: string[], sshAgentSock: string | undefined, identitiesOnly: boolean, logger: Log) {
+export async function gatherIdentityFiles(identityFiles: string[], sshAgentSock: string | undefined, identitiesOnly: boolean, logger: vscode.LogOutputChannel) {
     identityFiles = identityFiles.map(untildify).map(i => i.replace(/\.pub$/, ''));
     if (identityFiles.length === 0) {
         identityFiles.push(...DEFAULT_IDENTITY_FILES);
diff --git a/src/sshTestConnection.ts b/src/sshTestConnection.ts
diff --git a/src/test/featureSupport.test.ts b/src/test/featureSupport.test.ts
diff --git a/yarn.lock b/yarn.lock
