From b74c374def0efa5bf84b4cce85a9a11e39735d1c Mon Sep 17 00:00:00 2001 From: Jinbo Wang Date: Mon, 26 Apr 2021 11:18:05 +0800 Subject: [PATCH] Clean up deprecated logs (#987) --- CHANGELOG.md | 3 ++ package-lock.json | 12 ++--- package.json | 6 ++- src/configurationProvider.ts | 8 +-- src/extension.ts | 8 --- src/javaDebugAdapterDescriptorFactory.ts | 3 +- src/javaLogger.ts | 7 +++ src/logger.ts | 63 ------------------------ src/utility.ts | 11 +---- 9 files changed, 23 insertions(+), 98 deletions(-) delete mode 100644 src/logger.ts diff --git a/CHANGELOG.md b/CHANGELOG.md index 93a1975..7f1205e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Show VARIABLES with different data views. [PR#982](https://github.com/microsoft/vscode-java-debug/pull/982). - Adopt new APIs from vscode-tas-client. [#974](https://github.com/microsoft/vscode-java-debug/pull/974). +### Changed +- Engineering: Clean up deprecated logs. [PR#987](https://github.com/microsoft/vscode-java-debug/pull/987). + ### Fixed - Breakpoints inside record methods don't work. [#973](https://github.com/microsoft/vscode-java-debug/issues/973). - Support environment variable for port number in launch.json debug configuration. [#962](https://github.com/microsoft/vscode-java-debug/issues/962). diff --git a/package-lock.json b/package-lock.json index 80ade00..f1eac4b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -3208,9 +3208,9 @@ } }, "y18n": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.0.tgz", - "integrity": "sha512-r9S/ZyXu/Xu9q1tYlpsLIsa3EeLXXk0VwlxqTcFRfg9EhMW+17kbt9G0NrgCmhGb5vT2hyhJZLfDGx+7+5Uj/w==", + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.3.tgz", + "integrity": "sha512-JKhqTOwSrqNA1NY5lSztJ1GrBiUodLMmIZuLiDaMRJ+itFd+ABVE8XBjOvIWL+rSqNDC74LCSFmlb/U4UZ4hJQ==", "dev": true }, "yargs": { @@ -5408,9 +5408,9 @@ } }, "y18n": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.0.tgz", - "integrity": "sha512-r9S/ZyXu/Xu9q1tYlpsLIsa3EeLXXk0VwlxqTcFRfg9EhMW+17kbt9G0NrgCmhGb5vT2hyhJZLfDGx+7+5Uj/w==", + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.3.tgz", + "integrity": "sha512-JKhqTOwSrqNA1NY5lSztJ1GrBiUodLMmIZuLiDaMRJ+itFd+ABVE8XBjOvIWL+rSqNDC74LCSFmlb/U4UZ4hJQ==", "dev": true }, "yargs": { diff --git a/package.json b/package.json index 113a72c..3dde151 100644 --- a/package.json +++ b/package.json @@ -535,7 +535,10 @@ "description": "%java.debugger.attach.hostName.description%" }, "port": { - "type": ["number", "string"], + "type": [ + "number", + "string" + ], "description": "%java.debugger.attach.port.description%" }, "processId": { @@ -917,7 +920,6 @@ "compare-versions": "^3.6.0", "lodash": "^4.17.20", "uuid": "^8.3.1", - "vscode-extension-telemetry": "^0.1.6", "vscode-extension-telemetry-wrapper": "^0.9.0", "vscode-languageclient": "6.0.0-next.9", "vscode-languageserver-types": "3.16.0", diff --git a/src/configurationProvider.ts b/src/configurationProvider.ts index 4d96da3..36bb4b8 100644 --- a/src/configurationProvider.ts +++ b/src/configurationProvider.ts @@ -11,9 +11,9 @@ import * as anchor from "./anchor"; import { buildWorkspace } from "./build"; import { populateStepFilters, substituteFilterVariables } from "./classFilter"; import * as commands from "./commands"; +import { Type } from "./javaLogger"; import * as lsPlugin from "./languageServerPlugin"; import { addMoreHelpfulVMArgs, getJavaVersion, getShortenApproachForCLI, validateRuntimeCompatibility } from "./launchCommand"; -import { logger, Type } from "./logger"; import { mainClassPicker } from "./mainClassPicker"; import { resolveJavaProcess } from "./processPicker"; import { IProgressReporter } from "./progressAPI"; @@ -477,12 +477,6 @@ export class JavaDebugConfigurationProvider implements vscode.DebugConfiguration fix: "yes", fixMessage: errors.join(os.EOL), }); - - // Deprecated - logger.log(Type.USAGEDATA, { - fix: "yes", - fixMessage: errors.join(os.EOL), - }); await this.persistMainClassOption(folder, config, selectedFix); } diff --git a/src/extension.ts b/src/extension.ts index 0d11d2f..721e332 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -18,7 +18,6 @@ import { JavaDebugAdapterDescriptorFactory } from "./javaDebugAdapterDescriptorF import { JavaInlineValuesProvider } from "./JavaInlineValueProvider"; import { logJavaException, logJavaInfo } from "./javaLogger"; import { IMainClassOption, IMainMethod, resolveMainMethod } from "./languageServerPlugin"; -import { logger, Type } from "./logger"; import { mainClassPicker } from "./mainClassPicker"; import { pickJavaProcess } from "./processPicker"; import { IProgressReporter } from "./progressAPI"; @@ -37,12 +36,8 @@ export async function activate(context: vscode.ExtensionContext): Promise { } function initializeExtension(_operationId: string, context: vscode.ExtensionContext): any { - // Deprecated - logger.initialize(context, true); - registerDebugEventListener(context); registerVariableMenuCommands(context); - context.subscriptions.push(logger); context.subscriptions.push(vscode.window.registerTerminalLinkProvider(new JavaTerminalLinkProvder())); context.subscriptions.push(vscode.debug.registerDebugConfigurationProvider("java", new JavaDebugConfigurationProvider())); context.subscriptions.push(vscode.debug.registerDebugAdapterDescriptorFactory("java", new JavaDebugAdapterDescriptorFactory())); @@ -115,9 +110,6 @@ function registerDebugEventListener(context: vscode.ExtensionContext) { } else { logJavaInfo(commonProperties, measureProperties); } - - // Deprecated - logger.log(entry.scope === "exception" ? Type.EXCEPTION : Type.USAGEDATA, commonProperties, measureProperties); }); } }); diff --git a/src/javaDebugAdapterDescriptorFactory.ts b/src/javaDebugAdapterDescriptorFactory.ts index 0fd731f..99bd78c 100644 --- a/src/javaDebugAdapterDescriptorFactory.ts +++ b/src/javaDebugAdapterDescriptorFactory.ts @@ -2,9 +2,8 @@ // Licensed under the MIT license. import { DebugAdapterDescriptor, DebugAdapterDescriptorFactory, DebugAdapterExecutable, DebugAdapterServer, DebugSession } from "vscode"; - +import { Type } from "./javaLogger"; import { startDebugSession } from "./languageServerPlugin"; -import { Type } from "./logger"; import { convertErrorToMessage, showErrorMessageWithTroubleshooting } from "./utility"; export class JavaDebugAdapterDescriptorFactory implements DebugAdapterDescriptorFactory { diff --git a/src/javaLogger.ts b/src/javaLogger.ts index 7158d43..a7631d3 100644 --- a/src/javaLogger.ts +++ b/src/javaLogger.ts @@ -3,6 +3,13 @@ import { sendInfo, sendOperationError } from "vscode-extension-telemetry-wrapper"; +export enum Type { + EXCEPTION = "exception", + USAGEDATA = "usageData", + USAGEERROR = "usageError", + ACTIVATEEXTENSION = "activateExtension", // TODO: Activation belongs to usage data, remove this category. +} + export function logJavaException(errorProperties: any): void { /** * A sample errorProperties from Java code. diff --git a/src/logger.ts b/src/logger.ts deleted file mode 100644 index 470a96a..0000000 --- a/src/logger.ts +++ /dev/null @@ -1,63 +0,0 @@ -// Copyright (c) Microsoft Corporation. All rights reserved. -// Licensed under the MIT license. - -import * as fs from "fs"; -import * as vscode from "vscode"; -import TelemetryReporter from "vscode-extension-telemetry"; - -export enum Type { - EXCEPTION = "exception", - USAGEDATA = "usageData", - USAGEERROR = "usageError", - ACTIVATEEXTENSION = "activateExtension", // TODO: Activation belongs to usage data, remove this category. -} - -const SENSITIVE_PROPS = ["message", "stacktrace", "detailmessage"]; - -// Deprecate -class Logger implements vscode.Disposable { - private reporter: TelemetryReporter | null = null; - - public initialize(context: vscode.ExtensionContext, firstParty?: boolean): void { - if (this.reporter) { - return; - } - - const extensionPackage = JSON.parse(fs.readFileSync(context.asAbsolutePath("./package.json"), "utf-8")); - if (extensionPackage) { - const aiKey = extensionPackage.aiKey instanceof Array ? extensionPackage.aiKey[0] : extensionPackage.aiKey; - const packageInfo = { - name: extensionPackage.name, - version: extensionPackage.version, - aiKey, - }; - if (packageInfo.aiKey) { - this.reporter = new TelemetryReporter(packageInfo.name, packageInfo.version, packageInfo.aiKey, firstParty); - } - } - } - - public log(type: Type, properties?: { [key: string]: string; }, measures?: { [key: string]: number; }): void { - if (!this.reporter) { - return; - } - - if (type === Type.EXCEPTION || type === Type.USAGEERROR) { - this.reporter.sendTelemetryErrorEvent(type, properties, measures, SENSITIVE_PROPS); - } else { - this.reporter.sendTelemetryEvent(type, properties, measures); - } - } - - public logMessage(type: Type, message: string): void { - this.log(type, { message }); - } - - public dispose() { - if (this.reporter) { - this.reporter.dispose(); - } - } -} - -export const logger = new Logger(); diff --git a/src/utility.ts b/src/utility.ts index 377cb0a..29f1994 100644 --- a/src/utility.ts +++ b/src/utility.ts @@ -4,8 +4,8 @@ import * as path from "path"; import * as vscode from "vscode"; import { sendError, sendInfo, setUserError } from "vscode-extension-telemetry-wrapper"; +import { Type } from "./javaLogger"; import { IMainClassOption, resolveMainClass } from "./languageServerPlugin"; -import { logger, Type } from "./logger"; import { IProgressReporter } from "./progressAPI"; const TROUBLESHOOTING_LINK = "https://github.com/Microsoft/vscode-java-debug/blob/master/Troubleshooting.md"; @@ -64,9 +64,6 @@ function logMessage(message: ILoggingMessage): void { } else { sendInfo("", { message: message.message }); } - - // Deprecated - logger.log(message.type, { message: message.message, stack: message.stack || "" }); } export async function showInformationMessage(message: ILoggingMessage, ...items: string[]): Promise { @@ -114,12 +111,6 @@ export function openTroubleshootingPage(message: string, anchor?: string) { troubleshooting: "yes", troubleshootingMessage: message, }); - - // Deprecated - logger.log(Type.USAGEDATA, { - troubleshooting: "yes", - troubleshootingMessage: message, - }); } export async function guideToInstallJavaExtension() {