microsoft/vscode-react-native
Publicmirrored from https://github.com/microsoft/vscode-react-nativeAvailable
src/common/log/logHelper.ts
88lines · modeblame
17161993Meena Kunnathur Balakrishnan10 years ago | 1 | // Copyright (c) Microsoft Corporation. All rights reserved. |
| 2 | // Licensed under the MIT license. See LICENSE file in the project root for details. | |
| 3 | | |
| 4 | /** | |
adaa8cc8Meena Kunnathur Balakrishnan10 years ago | 5 | * Helper for the log utility. |
17161993Meena Kunnathur Balakrishnan10 years ago | 6 | */ |
| 7 | | |
190e393cMeena Kunnathur Balakrishnan10 years ago | 8 | import * as util from "util"; |
adaa8cc8Meena Kunnathur Balakrishnan10 years ago | 9 | import {InternalError, InternalErrorLevel} from "../error/internalError"; |
17161993Meena Kunnathur Balakrishnan10 years ago | 10 | |
| 11 | export enum LogLevel { | |
| 12 | None = 0, | |
| 13 | Error = 1, | |
| 14 | Warning = 2, | |
| 15 | Info = 3, | |
| 16 | Debug = 4, | |
| 17 | Trace = 5 | |
| 18 | } | |
| 19 | | |
| 20 | export class LogHelper { | |
| 21 | public static MESSAGE_TAG: string = "[vscode-react-native]"; | |
| 22 | public static INTERNAL_TAG: string = "[Internal]"; | |
adaa8cc8Meena Kunnathur Balakrishnan10 years ago | 23 | public static ERROR_TAG_FORMATSTRING: string = "[Error : %s] "; |
190e393cMeena Kunnathur Balakrishnan10 years ago | 24 | public static WARN_TAG: string = "[Warning]"; |
| 25 | private static ERROR_CODE_WIDTH: string = "0000"; | |
adaa8cc8Meena Kunnathur Balakrishnan10 years ago | 26 | private static LOG_LEVEL_NAME: string = "RN_LOG_LEVEL"; |
17161993Meena Kunnathur Balakrishnan10 years ago | 27 | |
a289475bMeena Kunnathur Balakrishnan10 years ago | 28 | public static get logLevel(): LogLevel { |
| 29 | let valName: string = process.env[LogHelper.LOG_LEVEL_NAME]; | |
f29c7bfeMeena Kunnathur Balakrishnan10 years ago | 30 | |
| 31 | if (typeof(valName) === "undefined") { | |
09c00558digeff10 years ago | 32 | valName = "None"; // Set the default LogLevel to LogLevel.None |
f29c7bfeMeena Kunnathur Balakrishnan10 years ago | 33 | } |
| 34 | | |
a289475bMeena Kunnathur Balakrishnan10 years ago | 35 | return (<any> LogLevel)[valName]; |
| 36 | } | |
| 37 | | |
| 38 | public static set logLevel(level: LogLevel) { | |
| 39 | if (!level) { | |
| 40 | return; | |
| 41 | } | |
| 42 | | |
| 43 | // Set the process env value | |
| 44 | process.env[LogHelper.LOG_LEVEL_NAME] = LogLevel[level]; | |
| 45 | } | |
| 46 | | |
17161993Meena Kunnathur Balakrishnan10 years ago | 47 | /** |
| 48 | * Gets the message of a non null error, if any. Otherwise it returns the empty string. | |
| 49 | */ | |
898cb3c6Meena Kunnathur Balakrishnan10 years ago | 50 | public static getErrorString(e: any): string { |
190e393cMeena Kunnathur Balakrishnan10 years ago | 51 | |
adaa8cc8Meena Kunnathur Balakrishnan10 years ago | 52 | if (e.isInternalError) { |
190e393cMeena Kunnathur Balakrishnan10 years ago | 53 | let errorMessage = e.message; |
adaa8cc8Meena Kunnathur Balakrishnan10 years ago | 54 | let errorMessagePrefix = LogHelper.getErrorMessagePrefix(e); |
898cb3c6Meena Kunnathur Balakrishnan10 years ago | 55 | return errorMessagePrefix + " " + errorMessage; |
190e393cMeena Kunnathur Balakrishnan10 years ago | 56 | } else { |
bf6ca504Meena Kunnathur Balakrishnan10 years ago | 57 | let message = e.message || e.error && e.error.message; |
| 58 | if (!message) { | |
| 59 | try { | |
| 60 | return JSON.stringify(e); | |
| 61 | } catch (exception) { | |
| 62 | // This is a best-effort feature, so we ignore any exceptions. If possible we'll print the error stringified. | |
| 63 | // If not, we'll just use one of the fallbacks | |
| 64 | return e.error || e.toString() || ""; | |
| 65 | } | |
| 66 | } else { | |
| 67 | return message; | |
190e393cMeena Kunnathur Balakrishnan10 years ago | 68 | } |
| 69 | } | |
| 70 | } | |
adaa8cc8Meena Kunnathur Balakrishnan10 years ago | 71 | |
| 72 | private static getErrorMessagePrefix(error: InternalError) { | |
| 73 | if (!error) { | |
| 74 | return ""; | |
| 75 | } | |
| 76 | | |
| 77 | switch (error.errorLevel) { | |
c6d7ee27dlebu10 years ago | 78 | case InternalErrorLevel.Error: |
adaa8cc8Meena Kunnathur Balakrishnan10 years ago | 79 | // Encode the error code to a four-char code - ex, 0198 |
| 80 | let errorCodeString = (LogHelper.ERROR_CODE_WIDTH + error.errorCode).slice(-LogHelper.ERROR_CODE_WIDTH.length); | |
| 81 | return util.format(LogHelper.ERROR_TAG_FORMATSTRING, errorCodeString); | |
| 82 | case InternalErrorLevel.Warning: | |
c6d7ee27dlebu10 years ago | 83 | return `${LogHelper.WARN_TAG}`; |
adaa8cc8Meena Kunnathur Balakrishnan10 years ago | 84 | default: |
c6d7ee27dlebu10 years ago | 85 | return `${LogHelper.WARN_TAG}`; |
adaa8cc8Meena Kunnathur Balakrishnan10 years ago | 86 | } |
| 87 | } | |
17161993Meena Kunnathur Balakrishnan10 years ago | 88 | } |