1681055 - console editor pretty-print button does not handle async function

Status: VERIFIED FIXED

(DevTools :: Console, defect, P2)

Description

[Nicolas Chevobbe [:nchevobbe]]

Steps to reproduce

1. Open the console, switch to editor mode if it wasn't in it already
2. Paste the following snippet

async function test() {
  await new Promise(res => {})
}

3. Click on the pretty print button in the top toolbar

Expected results

The snippet stays more or less the same

Actual results

The expression is turned into

async 
function test() {
  await new Promise(res => {})
}

which throws a SyntaxError when evaluated

---

This might be because the library that we use there (js_beautify), is not up-to-date/doesn't handle es6 syntax

---

Comment 1

[Nicolas Chevobbe [:nchevobbe]]

Attachment: Bug 1681055 - [devtools] Update beautify-js to 1.13.0. r=ochameau.

This fix pretty-printing of async functions in console. A test case is added
to make sure we don't regress.

We used to copy the library tests and run them in xpcshell. The tests changed
a lot, and I don't think we get much value running tests that are already ran on
the project CI (we do have a few tests that checks that we get the output we want)
, so this patch remove the xpcshell test and the associated files.

The upgrade documentation is updated to remove some unecessary steps:

• no need to rename the exported module for each file
• no need to replace the acorn module, since what's in the file is just a subset
  of the library (~100 lines)
• no need to update the test file, which doesn't seem to exist anymore

Comment 2

[Nicolas Chevobbe [:nchevobbe]]

Attachment: Bug 1681055 - [devtools] Add test case to check pretty-printing works on async function in console editor. r=ochameau.

Depends on D99320

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/477e4951eeda
[devtools] Update beautify-js to 1.13.0. r=ochameau.
https://hg.mozilla.org/integration/autoland/rev/0f8c6dedfc2b
[devtools] Add test case to check pretty-printing works on async function in console editor. r=ochameau.

Comment 4

[Dorel Luca [:dluca]]

https://hg.mozilla.org/mozilla-central/rev/477e4951eeda
https://hg.mozilla.org/mozilla-central/rev/0f8c6dedfc2b

Comment 5

[Nicolas Chevobbe [:nchevobbe]]

Comment on attachment 9192349 [details]
Bug 1681055 - [devtools] Update beautify-js to 1.13.0. r=ochameau.

Beta/Release Uplift Approval Request

• User impact if declined: Pretty-printing in the DevTools console editor (which is a new feature) an expression with es6 syntax (e.g. async/await), might turn valid code into code with syntax errors.
  It would be nice to avoid shipping a kinda broken feature to release.
• Is this code covered by automated tests?: Yes
• Has the fix been verified in Nightly?: No
• Needs manual test from QE?: Yes
• If yes, steps to reproduce: 1. Open the console

1. Switch to editor mode
2. Type the following async function test() { await new Promise(res => {})}
3. Click on the pretty print button ({}) in the toolbar

Expected result:

async function test() {
  await new Promise(res => {})
}

(valid expression)

• List of other uplifts needed: None
• Risk to taking this patch: Low
• Why is the change risky/not risky? (and alternatives if risky): Updating a third-party library only used in a couple places in devtools, for non-critical features, covered by an automated test (in the other patch of this bug)
• String changes made/needed:

Comment 6

[Julien Cristau [:jcristau] (back August 18)]

When did this break? Can the new feature be turned off?

Comment 7

[Nicolas Chevobbe [:nchevobbe]]

It was already broken when we introduced the feature, we didn't realized soon enough.
We don't have a simple pref to turn it off, but I could do a patch to do that, that would then be uplifted. Is this the preferred way for you Julien?

Comment 8

[Julien Cristau [:jcristau] (back August 18)]

Comment on attachment 9192349 [details]
Bug 1681055 - [devtools] Update beautify-js to 1.13.0. r=ochameau.

It's early enough in beta that I think we can take this, but asking in case there's other issues down the road.

approved for 85.0b3

Comment 9

[Julien Cristau [:jcristau] (back August 18)]

https://hg.mozilla.org/releases/mozilla-beta/rev/799c2cb7e40e
https://hg.mozilla.org/releases/mozilla-beta/rev/5f674e896aaf

Comment 10

[Bogdan Maris, Desktop Test Engineering]

Reproduced the initial issue using old Nightly from 2020-12-07, verified that this is fixed using latest Nightly 86.0a1 and Latest Beta 85 from treeherder across platforms (Windows 10 64bit, macOS 11 and Ubuntu 18.04 64bit).