Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: convert overlay template to DOM #15852

Merged
merged 9 commits into from
Mar 12, 2024
Merged

feat: convert overlay template to DOM #15852

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
f3bdecf
Add trusted types support to error overlay
Snugug Feb 8, 2024
e3b7810
Convert to DOM
Snugug Feb 9, 2024
38edd21
Metaprogramming FTW
Snugug Feb 9, 2024
fa808cd
Convert to generic children, not just text content
Snugug Feb 9, 2024
5729d73
Update packages/vite/src/client/overlay.ts
Snugug Feb 11, 2024
b989241
Update packages/vite/src/client/overlay.ts
Snugug Feb 11, 2024
b9f4e67
Update packages/vite/src/client/overlay.ts
Snugug Feb 11, 2024
77095df
Fix append to use children, not child
Snugug Feb 11, 2024
6f2d871
chore: merge main
patak-dev Feb 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
69 changes: 52 additions & 17 deletions packages/vite/src/client/overlay.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,22 @@ declare const __HMR_CONFIG_NAME__: string
const hmrConfigName = __HMR_CONFIG_NAME__
const base = __BASE__ || '/'

// Create an element with provided attributes and optional children
function h(
e: string,
attrs: Record<string, string> = {},
...children: (string | Node)[]
) {
const elem = document.createElement(e)
for (const [k, v] of Object.entries(attrs)) {
elem.setAttribute(k, v)
}
elem.append(...children)
return elem
}

// set :host styles to make playwright detect the element as visible
const template = /*html*/ `
<style>
const templateStyle = /*css*/ `
:host {
position: fixed;
top: 0;
Expand Down Expand Up @@ -148,22 +161,43 @@ kbd {
border-color: rgb(54, 57, 64);
border-image: initial;
}
</style>
<div class="backdrop" part="backdrop">
<div class="window" part="window">
<pre class="message" part="message"><span class="plugin" part="plugin"></span><span class="message-body" part="message-body"></span></pre>
<pre class="file" part="file"></pre>
<pre class="frame" part="frame"></pre>
<pre class="stack" part="stack"></pre>
<div class="tip" part="tip">
Click outside, press <kbd>Esc</kbd> key, or fix the code to dismiss.<br>
You can also disable this overlay by setting
<code part="config-option-name">server.hmr.overlay</code> to <code part="config-option-value">false</code> in <code part="config-file-name">${hmrConfigName}.</code>
</div>
</div>
</div>
`

// Error Template
const template = h(
'div',
{ class: 'backdrop', part: 'backdrop' },
h(
'div',
{ class: 'window', part: 'window' },
h(
'pre',
{ class: 'message', part: 'message' },
h('span', { class: 'plugin', part: 'plugin' }),
h('span', { class: 'message-body', part: 'message-body' }),
),
h('pre', { class: 'file', part: 'file' }),
h('pre', { class: 'frame', part: 'frame' }),
h('pre', { class: 'stack', part: 'stack' }),
h(
'div',
{ class: 'tip', part: 'tip' },
'Click outside, press ',
h('kbd', {}, 'Esc'),
' key, or fix the code to dismiss.',
h('br'),
'You can also disable this overlay by setting ',
h('code', { part: 'config-option-name' }, 'server.hmr.overlay'),
' to ',
h('code', { part: 'config-option-value' }, 'false'),
' in ',
h('code', { part: 'config-file-name' }, hmrConfigName),
'.',
),
),
h('style', {}, templateStyle),
)

const fileRE = /(?:[a-zA-Z]:\\|\/).*?:\d+:\d+/g
const codeframeRE = /^(?:>?\s*\d+\s+\|.*|\s+\|\s*\^.*)\r?\n/gm

Expand All @@ -177,7 +211,8 @@ export class ErrorOverlay extends HTMLElement {
constructor(err: ErrorPayload['err'], links = true) {
super()
this.root = this.attachShadow({ mode: 'open' })
this.root.innerHTML = template

this.root.appendChild(template)

codeframeRE.lastIndex = 0
const hasFrame = err.frame && codeframeRE.test(err.frame)
Expand Down