898315 - Deprecate and get rid of FileUtils.getDir(..., ..., true)

Status: RESOLVED FIXED

(Toolkit :: IOUtils and PathUtils, task)

Description

[David Teller [:Yoric] - still alive but not very active]

FileUtils.getDir(..., ..., true) causes main thread I/O that's hard to spot. We should deprecate the method and eliminate its use.

Comment 1

[Marco Castelluccio [:marco]]

I've just noticed that FileUtils.getFile is using FileUtils.getDir(..., ..., true) and we have a bunch of consumers of this function!

Comment 2

[David Teller [:Yoric] - still alive but not very active]

Good catch. Filed as bug 920187.

Comment 3

[David Teller [:Yoric] - still alive but not very active]

We could do this as a mentored bug, see how awful the result is, and prioritize based on the results.

Comment 4

[Barret Rennie [:barret] (they/them)]

IOUtils and PathUtils offers async alternatives

Comment 5

[Marco Castelluccio [:marco]]

Attachment: Bug 898315 - Remove two instances of FileUtils.getDir(..., ..., true) usage in async functions. r=barret

Comment 6

[Marco Castelluccio [:marco]]

Attachment: Bug 898315 - Print a deprecation warning for FileUtils.getDir(..., ..., true) even if not starting up or shutting down. r=Gijs

Depends on D180562

Comment 7

[Marco Castelluccio [:marco]]

Attachment: Bug 898315 - Remove usage of FileUtils.getDir(..., ..., true) in production code. r=barret

Depends on D180563

Comment 8

[Marco Castelluccio [:marco]]

Attachment: Bug 898315 - Remove main thread IO from Browser Toolbox launcher. r=#devtools-reviewers

Depends on D180564

Comment 9

[Marco Castelluccio [:marco]]

Attachment: Bug 898315 - Update all callers of FileUtils.getDir to remove usage of the shouldCreate parameter. r=Gijs

Depends on D180566

Comment 10

[Marco Castelluccio [:marco]]

Attachment: Bug 898315 - Remove 'shouldCreate' parameter from FileUtils.getDir to avoid footguns. r=Gijs

Depends on D180603

Comment 11

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/660b84a21af5
Remove two instances of FileUtils.getDir(..., ..., true) usage in async functions. r=barret,application-update-reviewers,nalexander
https://hg.mozilla.org/integration/autoland/rev/3ba31405d9d6
Print a deprecation warning for FileUtils.getDir(..., ..., true) even if not starting up or shutting down. r=barret
https://hg.mozilla.org/integration/autoland/rev/d108bd53c60b
Remove usage of FileUtils.getDir(..., ..., true) in production code. r=barret,application-update-reviewers,devtools-reviewers,nalexander,jdescottes
https://hg.mozilla.org/integration/autoland/rev/3999920d4893
Remove main thread IO from Browser Toolbox launcher. r=devtools-reviewers,ochameau

Comment 12

[Cosmin Sabou [:CosminS]]

https://hg.mozilla.org/mozilla-central/rev/660b84a21af5
https://hg.mozilla.org/mozilla-central/rev/3ba31405d9d6
https://hg.mozilla.org/mozilla-central/rev/d108bd53c60b
https://hg.mozilla.org/mozilla-central/rev/3999920d4893

Comment 13

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/63ccd00a399a
Update all callers of FileUtils.getDir to remove usage of the shouldCreate parameter. r=Gijs,extension-reviewers,application-update-reviewers,nalexander,robwu

Comment 14

[Marco Castelluccio [:marco]]

Barret, the last patch depends on removing getFile. Do you think that will be done soon? If not, I can just modify my patch to move the directory creation in getFile for now.

Comment 15

[Noemi Erli[:noemi_erli]]

Backed out changeset 63ccd00a399a (Bug 898315) for causing failures in test_no_window_update_restart.py CLOSED TREE

Push with failures: https://treeherder.mozilla.org/jobs?repo=autoland&group_state=expanded&collapsedPushes=842382&resultStatus=pending%2Crunning%2Ctestfailed%2Cbusted%2Cexception%2Cretry%2Cusercancel&revision=63ccd00a399a8423226295df82ff93920cfa1889&searchStr=os%2Cx%2C10.15%2Cwebrender%2Copt%2Ctest-macosx1015-64-qr%2Fopt-marionette%2Cmn&selectedTaskRun=Ty-kfwblRESyvN1L4PrhwA.0

Log: https://treeherder.mozilla.org/logviewer?job_id=419340323&repo=autoland&lineNumber=134271

Backout: https://hg.mozilla.org/integration/autoland/rev/2200d22a37dd7278fa6f151c2d1a1100efaec0e7

Comment 16

[Barret Rennie [:barret] (they/them)]

Bug 920187 should land tomorrow

Comment 17

[Marco Castelluccio [:marco]]

The test is only running on OS X, and I didn't test that in my try push. I'll fix it and reland.

Comment 18

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/314d09f09c5e
Update all callers of FileUtils.getDir to remove usage of the shouldCreate parameter. r=Gijs,extension-reviewers,application-update-reviewers,nalexander,robwu

Comment 19

[Cosmin Sabou [:CosminS]]

https://hg.mozilla.org/mozilla-central/rev/314d09f09c5e

Comment 20

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/789349491e2f
Remove 'shouldCreate' parameter from FileUtils.getDir to avoid footguns. r=Gijs

Comment 21

[Cristian Tuns]

https://hg.mozilla.org/mozilla-central/rev/789349491e2f