messageFormatter.tsx 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. import type {OnExpandCallback} from 'sentry/components/objectInspector';
  2. import {defined} from 'sentry/utils';
  3. import type {BreadcrumbFrame, ConsoleFrame} from 'sentry/utils/replays/types';
  4. import {isConsoleFrame} from 'sentry/utils/replays/types';
  5. import Format from 'sentry/views/replays/detail/console/format';
  6. interface Props {
  7. frame: BreadcrumbFrame;
  8. expandPaths?: string[];
  9. onExpand?: OnExpandCallback;
  10. }
  11. // There is a special case where `console.error()` is called with an Error object.
  12. // The SDK uses the Error's `message` property as the breadcrumb message, but we lose the Error type,
  13. // resulting in an empty object in the breadcrumb arguments.
  14. //
  15. // In this special case, we re-create the error object
  16. function isSerializedError(frame: ConsoleFrame) {
  17. const args = frame.data.arguments;
  18. return (
  19. frame.message &&
  20. typeof frame.message === 'string' &&
  21. Array.isArray(args) &&
  22. args.length <= 2 &&
  23. args[0] &&
  24. typeof args[0] === 'object' &&
  25. Object.keys(args[0]).length === 0
  26. );
  27. }
  28. /**
  29. * Attempt to emulate the browser console as much as possible
  30. */
  31. export default function MessageFormatter({frame, expandPaths, onExpand}: Props) {
  32. if (!isConsoleFrame(frame)) {
  33. return (
  34. <Format
  35. expandPaths={expandPaths}
  36. onExpand={onExpand}
  37. args={[frame.category, frame.message, frame.data].filter(defined)}
  38. />
  39. );
  40. }
  41. const args = frame.data.arguments;
  42. // Turn this back into an Error object so <Format> can pretty print it
  43. if (args && isSerializedError(frame)) {
  44. // Sometimes message can include stacktrace
  45. const splitMessage = frame.message.split('\n');
  46. const errorMessagePiece = splitMessage[0].trim();
  47. // Error.prototype.toString() will prepend the error type meaning it will
  48. // not be the same as `message` property. We want message only when
  49. // creating a new Error instance, otherwise the type will repeat.
  50. const errorMessageSplit = errorMessagePiece.split('Error: ');
  51. // Restitch together in case there were other `Error: ` strings in the message
  52. const errorMessage = errorMessageSplit
  53. .splice(errorMessageSplit.length - 1)
  54. .join('Error: ');
  55. const fakeError = new Error(errorMessage);
  56. try {
  57. // Messages generally do not include stack trace due to SDK serialization
  58. fakeError.stack = args.length === 2 ? (args[1] as string) : undefined;
  59. // Re-create the error name
  60. if (errorMessageSplit.length > 1) {
  61. fakeError.name = errorMessageSplit[0] + 'Error: ';
  62. }
  63. } catch {
  64. // Some browsers won't allow you to write to error properties
  65. }
  66. return <Format expandPaths={expandPaths} onExpand={onExpand} args={[fakeError]} />;
  67. }
  68. return (
  69. <Format
  70. expandPaths={expandPaths}
  71. onExpand={onExpand}
  72. args={args ?? [frame.message]}
  73. />
  74. );
  75. }