errorMessage.js 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. /*---------------------------------------------------------------------------------------------
  2. * Copyright (c) Microsoft Corporation. All rights reserved.
  3. * Licensed under the MIT License. See License.txt in the project root for license information.
  4. *--------------------------------------------------------------------------------------------*/
  5. import * as arrays from './arrays.js';
  6. import * as types from './types.js';
  7. import * as nls from '../../nls.js';
  8. function exceptionToErrorMessage(exception, verbose) {
  9. if (verbose && (exception.stack || exception.stacktrace)) {
  10. return nls.localize('stackTrace.format', "{0}: {1}", detectSystemErrorMessage(exception), stackToString(exception.stack) || stackToString(exception.stacktrace));
  11. }
  12. return detectSystemErrorMessage(exception);
  13. }
  14. function stackToString(stack) {
  15. if (Array.isArray(stack)) {
  16. return stack.join('\n');
  17. }
  18. return stack;
  19. }
  20. function detectSystemErrorMessage(exception) {
  21. // See https://nodejs.org/api/errors.html#errors_class_system_error
  22. if (typeof exception.code === 'string' && typeof exception.errno === 'number' && typeof exception.syscall === 'string') {
  23. return nls.localize('nodeExceptionMessage', "A system error occurred ({0})", exception.message);
  24. }
  25. return exception.message || nls.localize('error.defaultMessage', "An unknown error occurred. Please consult the log for more details.");
  26. }
  27. /**
  28. * Tries to generate a human readable error message out of the error. If the verbose parameter
  29. * is set to true, the error message will include stacktrace details if provided.
  30. *
  31. * @returns A string containing the error message.
  32. */
  33. export function toErrorMessage(error = null, verbose = false) {
  34. if (!error) {
  35. return nls.localize('error.defaultMessage', "An unknown error occurred. Please consult the log for more details.");
  36. }
  37. if (Array.isArray(error)) {
  38. const errors = arrays.coalesce(error);
  39. const msg = toErrorMessage(errors[0], verbose);
  40. if (errors.length > 1) {
  41. return nls.localize('error.moreErrors', "{0} ({1} errors in total)", msg, errors.length);
  42. }
  43. return msg;
  44. }
  45. if (types.isString(error)) {
  46. return error;
  47. }
  48. if (error.detail) {
  49. const detail = error.detail;
  50. if (detail.error) {
  51. return exceptionToErrorMessage(detail.error, verbose);
  52. }
  53. if (detail.exception) {
  54. return exceptionToErrorMessage(detail.exception, verbose);
  55. }
  56. }
  57. if (error.stack) {
  58. return exceptionToErrorMessage(error, verbose);
  59. }
  60. if (error.message) {
  61. return error.message;
  62. }
  63. return nls.localize('error.defaultMessage', "An unknown error occurred. Please consult the log for more details.");
  64. }