overlay.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268
  1. function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
  2. function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
  3. function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
  4. function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
  5. function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
  6. // The error overlay is inspired (and mostly copied) from Create React App (https://github.com/facebookincubator/create-react-app)
  7. // They, in turn, got inspired by webpack-hot-middleware (https://github.com/glenjamin/webpack-hot-middleware).
  8. import ansiHTML from "ansi-html-community";
  9. import { encode } from "html-entities";
  10. import { listenToRuntimeError, listenToUnhandledRejection, parseErrorToStacks } from "./overlay/runtime-error.js";
  11. import createOverlayMachine from "./overlay/state-machine.js";
  12. import { containerStyle, dismissButtonStyle, headerStyle, iframeStyle, msgStyles, msgTextStyle, msgTypeStyle } from "./overlay/styles.js";
  13. var colors = {
  14. reset: ["transparent", "transparent"],
  15. black: "181818",
  16. red: "E36049",
  17. green: "B3CB74",
  18. yellow: "FFD080",
  19. blue: "7CAFC2",
  20. magenta: "7FACCA",
  21. cyan: "C3C2EF",
  22. lightgrey: "EBE7E3",
  23. darkgrey: "6D7891"
  24. };
  25. ansiHTML.setColors(colors);
  26. /**
  27. * @param {string} type
  28. * @param {string | { file?: string, moduleName?: string, loc?: string, message?: string; stack?: string[] }} item
  29. * @returns {{ header: string, body: string }}
  30. */
  31. function formatProblem(type, item) {
  32. var header = type === "warning" ? "WARNING" : "ERROR";
  33. var body = "";
  34. if (typeof item === "string") {
  35. body += item;
  36. } else {
  37. var file = item.file || "";
  38. // eslint-disable-next-line no-nested-ternary
  39. var moduleName = item.moduleName ? item.moduleName.indexOf("!") !== -1 ? "".concat(item.moduleName.replace(/^(\s|\S)*!/, ""), " (").concat(item.moduleName, ")") : "".concat(item.moduleName) : "";
  40. var loc = item.loc;
  41. header += "".concat(moduleName || file ? " in ".concat(moduleName ? "".concat(moduleName).concat(file ? " (".concat(file, ")") : "") : file).concat(loc ? " ".concat(loc) : "") : "");
  42. body += item.message || "";
  43. }
  44. if (Array.isArray(item.stack)) {
  45. item.stack.forEach(function (stack) {
  46. if (typeof stack === "string") {
  47. body += "\r\n".concat(stack);
  48. }
  49. });
  50. }
  51. return {
  52. header: header,
  53. body: body
  54. };
  55. }
  56. /**
  57. * @typedef {Object} CreateOverlayOptions
  58. * @property {string | null} trustedTypesPolicyName
  59. * @property {boolean | (error: Error) => void} [catchRuntimeError]
  60. */
  61. /**
  62. *
  63. * @param {CreateOverlayOptions} options
  64. */
  65. var createOverlay = function createOverlay(options) {
  66. /** @type {HTMLIFrameElement | null | undefined} */
  67. var iframeContainerElement;
  68. /** @type {HTMLDivElement | null | undefined} */
  69. var containerElement;
  70. /** @type {HTMLDivElement | null | undefined} */
  71. var headerElement;
  72. /** @type {Array<(element: HTMLDivElement) => void>} */
  73. var onLoadQueue = [];
  74. /** @type {TrustedTypePolicy | undefined} */
  75. var overlayTrustedTypesPolicy;
  76. /**
  77. *
  78. * @param {HTMLElement} element
  79. * @param {CSSStyleDeclaration} style
  80. */
  81. function applyStyle(element, style) {
  82. Object.keys(style).forEach(function (prop) {
  83. element.style[prop] = style[prop];
  84. });
  85. }
  86. /**
  87. * @param {string | null} trustedTypesPolicyName
  88. */
  89. function createContainer(trustedTypesPolicyName) {
  90. // Enable Trusted Types if they are available in the current browser.
  91. if (window.trustedTypes) {
  92. overlayTrustedTypesPolicy = window.trustedTypes.createPolicy(trustedTypesPolicyName || "webpack-dev-server#overlay", {
  93. createHTML: function createHTML(value) {
  94. return value;
  95. }
  96. });
  97. }
  98. iframeContainerElement = document.createElement("iframe");
  99. iframeContainerElement.id = "webpack-dev-server-client-overlay";
  100. iframeContainerElement.src = "about:blank";
  101. applyStyle(iframeContainerElement, iframeStyle);
  102. iframeContainerElement.onload = function () {
  103. var contentElement = /** @type {Document} */
  104. /** @type {HTMLIFrameElement} */
  105. iframeContainerElement.contentDocument.createElement("div");
  106. containerElement = /** @type {Document} */
  107. /** @type {HTMLIFrameElement} */
  108. iframeContainerElement.contentDocument.createElement("div");
  109. contentElement.id = "webpack-dev-server-client-overlay-div";
  110. applyStyle(contentElement, containerStyle);
  111. headerElement = document.createElement("div");
  112. headerElement.innerText = "Compiled with problems:";
  113. applyStyle(headerElement, headerStyle);
  114. var closeButtonElement = document.createElement("button");
  115. applyStyle(closeButtonElement, dismissButtonStyle);
  116. closeButtonElement.innerText = "×";
  117. closeButtonElement.ariaLabel = "Dismiss";
  118. closeButtonElement.addEventListener("click", function () {
  119. // eslint-disable-next-line no-use-before-define
  120. overlayService.send({
  121. type: "DISMISS"
  122. });
  123. });
  124. contentElement.appendChild(headerElement);
  125. contentElement.appendChild(closeButtonElement);
  126. contentElement.appendChild(containerElement);
  127. /** @type {Document} */
  128. /** @type {HTMLIFrameElement} */
  129. iframeContainerElement.contentDocument.body.appendChild(contentElement);
  130. onLoadQueue.forEach(function (onLoad) {
  131. onLoad( /** @type {HTMLDivElement} */contentElement);
  132. });
  133. onLoadQueue = [];
  134. /** @type {HTMLIFrameElement} */
  135. iframeContainerElement.onload = null;
  136. };
  137. document.body.appendChild(iframeContainerElement);
  138. }
  139. /**
  140. * @param {(element: HTMLDivElement) => void} callback
  141. * @param {string | null} trustedTypesPolicyName
  142. */
  143. function ensureOverlayExists(callback, trustedTypesPolicyName) {
  144. if (containerElement) {
  145. containerElement.innerHTML = "";
  146. // Everything is ready, call the callback right away.
  147. callback(containerElement);
  148. return;
  149. }
  150. onLoadQueue.push(callback);
  151. if (iframeContainerElement) {
  152. return;
  153. }
  154. createContainer(trustedTypesPolicyName);
  155. }
  156. // Successful compilation.
  157. function hide() {
  158. if (!iframeContainerElement) {
  159. return;
  160. }
  161. // Clean up and reset internal state.
  162. document.body.removeChild(iframeContainerElement);
  163. iframeContainerElement = null;
  164. containerElement = null;
  165. }
  166. // Compilation with errors (e.g. syntax error or missing modules).
  167. /**
  168. * @param {string} type
  169. * @param {Array<string | { moduleIdentifier?: string, moduleName?: string, loc?: string, message?: string }>} messages
  170. * @param {string | null} trustedTypesPolicyName
  171. * @param {'build' | 'runtime'} messageSource
  172. */
  173. function show(type, messages, trustedTypesPolicyName, messageSource) {
  174. ensureOverlayExists(function () {
  175. headerElement.innerText = messageSource === "runtime" ? "Uncaught runtime errors:" : "Compiled with problems:";
  176. messages.forEach(function (message) {
  177. var entryElement = document.createElement("div");
  178. var msgStyle = type === "warning" ? msgStyles.warning : msgStyles.error;
  179. applyStyle(entryElement, _objectSpread(_objectSpread({}, msgStyle), {}, {
  180. padding: "1rem 1rem 1.5rem 1rem"
  181. }));
  182. var typeElement = document.createElement("div");
  183. var _formatProblem = formatProblem(type, message),
  184. header = _formatProblem.header,
  185. body = _formatProblem.body;
  186. typeElement.innerText = header;
  187. applyStyle(typeElement, msgTypeStyle);
  188. if (message.moduleIdentifier) {
  189. applyStyle(typeElement, {
  190. cursor: "pointer"
  191. });
  192. // element.dataset not supported in IE
  193. typeElement.setAttribute("data-can-open", true);
  194. typeElement.addEventListener("click", function () {
  195. fetch("/webpack-dev-server/open-editor?fileName=".concat(message.moduleIdentifier));
  196. });
  197. }
  198. // Make it look similar to our terminal.
  199. var text = ansiHTML(encode(body));
  200. var messageTextNode = document.createElement("div");
  201. applyStyle(messageTextNode, msgTextStyle);
  202. messageTextNode.innerHTML = overlayTrustedTypesPolicy ? overlayTrustedTypesPolicy.createHTML(text) : text;
  203. entryElement.appendChild(typeElement);
  204. entryElement.appendChild(messageTextNode);
  205. /** @type {HTMLDivElement} */
  206. containerElement.appendChild(entryElement);
  207. });
  208. }, trustedTypesPolicyName);
  209. }
  210. var overlayService = createOverlayMachine({
  211. showOverlay: function showOverlay(_ref) {
  212. var _ref$level = _ref.level,
  213. level = _ref$level === void 0 ? "error" : _ref$level,
  214. messages = _ref.messages,
  215. messageSource = _ref.messageSource;
  216. return show(level, messages, options.trustedTypesPolicyName, messageSource);
  217. },
  218. hideOverlay: hide
  219. });
  220. if (options.catchRuntimeError) {
  221. /**
  222. * @param {Error | undefined} error
  223. * @param {string} fallbackMessage
  224. */
  225. var handleError = function handleError(error, fallbackMessage) {
  226. var errorObject = error instanceof Error ? error : new Error(error || fallbackMessage);
  227. var shouldDisplay = typeof options.catchRuntimeError === "function" ? options.catchRuntimeError(errorObject) : true;
  228. if (shouldDisplay) {
  229. overlayService.send({
  230. type: "RUNTIME_ERROR",
  231. messages: [{
  232. message: errorObject.message,
  233. stack: parseErrorToStacks(errorObject)
  234. }]
  235. });
  236. }
  237. };
  238. listenToRuntimeError(function (errorEvent) {
  239. // error property may be empty in older browser like IE
  240. var error = errorEvent.error,
  241. message = errorEvent.message;
  242. if (!error && !message) {
  243. return;
  244. }
  245. handleError(error, message);
  246. });
  247. listenToUnhandledRejection(function (promiseRejectionEvent) {
  248. var reason = promiseRejectionEvent.reason;
  249. handleError(reason, "Unknown promise rejection reason");
  250. });
  251. }
  252. return overlayService;
  253. };
  254. export { formatProblem, createOverlay };