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.

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

fix(compiler): Addressed infinite loop in compiler #3992

Merged
merged 4 commits into from
Jul 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions packages/shared/__tests__/__snapshots__/codeframe.spec.ts.snap
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,29 @@ exports[`compiler: codeframe multi-line highlights 1`] = `
4 | \\">
| ^"
`;

exports[`compiler: codeframe newline sequences - unix 1`] = `
"8 | <input name=\\"email\\" type=\\"text\\"/>
9 | </div>
10 | <div id=\\"hook\\">
| ^^^^^^^^^^^^^^^
11 | <label for=\\"password\\">Password</label>
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12 | <input name=\\"password\\" type=\\"password\\"/>
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13 | </div>
| ^^^^^^^^^^^^"
`;

exports[`compiler: codeframe newline sequences - windows 1`] = `
"8 | <input name=\\"email\\" type=\\"text\\"/>
9 | </div>
10 | <div id=\\"hook\\">
| ^^^^^^^^^^^^^^^
11 | <label for=\\"password\\">Password</label>
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12 | <input name=\\"password\\" type=\\"password\\"/>
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13 | </div>
| ^^^^^^^^^^^^"
`;
45 changes: 45 additions & 0 deletions packages/shared/__tests__/codeframe.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,49 @@ attr
const attrEnd = source.indexOf(`">`) + 1
expect(generateCodeFrame(source, attrStart, attrEnd)).toMatchSnapshot()
})

{
const source = `
<template>
<div>
<h1>Sign In</h1>
<form>
<div>
<label for="email">Email</label>
<input name="email" type="text"/>
</div>
<div id="hook">
<label for="password">Password</label>
<input name="password" type="password"/>
</div>
</form>
</div>
</template>
`
const startToken = '<div id="hook">'
const endToken = '</div>'

// Explicitly ensure the line-ending for the platform instead of assuming
// the newline sequences used in the source above.
const unixNewlineSource = source.replace(/\r\n/g, '\n')
const windowsNewLineSource = unixNewlineSource.replace(/\n/g, '\r\n')

test('newline sequences - windows', () => {
const keyStart = windowsNewLineSource.indexOf(startToken)
const keyEnd =
windowsNewLineSource.indexOf(endToken, keyStart) + endToken.length
expect(
generateCodeFrame(windowsNewLineSource, keyStart, keyEnd)
).toMatchSnapshot()
})

test('newline sequences - unix', () => {
const keyStart = unixNewlineSource.indexOf(startToken)
const keyEnd =
unixNewlineSource.indexOf(endToken, keyStart) + endToken.length
expect(
generateCodeFrame(unixNewlineSource, keyStart, keyEnd)
).toMatchSnapshot()
})
}
})
23 changes: 19 additions & 4 deletions packages/shared/src/codeframe.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,22 @@ export function generateCodeFrame(
start = 0,
end = source.length
): string {
const lines = source.split(/\r?\n/)
// Split the content into individual lines but capture the newline sequence
// that separated each line. This is important because the actual sequence is
// needed to properly take into account the full line length for offset
// comparison
let lines = source.split(/(\r?\n)/)

// Separate the lines and newline sequences into separate arrays for easier referencing
const newlineSequences = lines.filter((_, idx) => idx % 2 === 1)
lines = lines.filter((_, idx) => idx % 2 === 0)

let count = 0
const res: string[] = []
for (let i = 0; i < lines.length; i++) {
count += lines[i].length + 1
count +=
lines[i].length +
((newlineSequences[i] && newlineSequences[i].length) || 0)
if (count >= start) {
for (let j = i - range; j <= i + range || end > count; j++) {
if (j < 0 || j >= lines.length) continue
Expand All @@ -20,9 +31,12 @@ export function generateCodeFrame(
}`
)
const lineLength = lines[j].length
const newLineSeqLength =
(newlineSequences[j] && newlineSequences[j].length) || 0

if (j === i) {
// push underline
const pad = start - (count - lineLength) + 1
const pad = start - (count - (lineLength + newLineSeqLength))
const length = Math.max(
1,
end > count ? lineLength - pad : end - start
Expand All @@ -33,7 +47,8 @@ export function generateCodeFrame(
const length = Math.max(Math.min(end - count, lineLength), 1)
res.push(` | ` + '^'.repeat(length))
}
count += lineLength + 1

count += lineLength + newLineSeqLength
}
}
break
Expand Down