1723807 - Make getURLSpecFromFile [noscript] and improve idl comments to indicate why you should use one or the other

Status: RESOLVED FIXED

(Core :: Networking: File, defect, P3)

Description

[:Gijs (he/him)]

From Florian's feedback:

While reviewing, I wondered "so what happens if the wrong function is called, or if the user messed with a preference in about:config and we are no longer pointing to a folder, ..." and I found the comments at https://searchfox.org/mozilla-central/rev/4f05a46731c1f7f111ec7a41ce38a34594aa0d37/netwerk/protocol/file/nsIFileProtocolHandler.idl#32-58 quite unhelpful.

I don't think this needs to be part of this patch, but I think it would be nice to rephrase the comments to explain that it's fine to call getURLSpecFromActualFile on any file, and that the only difference with getURLSpecFromDir is that it will ensure the url ends with a trailing /.

Comments like "NOTE: Callers should use getURLSpecFromActualFile or getURLSpecFromDirFile if possible, for performance reasons." and "identical to getURLSpecFromFile, but is usually more efficient." don't make much sense to me. Is it just slightly more efficient? When reading such a comment I would never guess that we can block the main thread for 5s.

getURLSpecFromFile should probably be made [noscript], but if we want to do it we should give our Thunderbird friends a heads up, as there are 8 uses (+6 in tests) in mail/.

Comment 1

[:Gijs (he/him)]

Attachment: Bug 1723807 - make getURLSpecFromFile [noscript] and clarify its idl comments to discourage use more forcefully, r?valentin

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/c9d056f74217
make getURLSpecFromFile [noscript] and clarify its idl comments to discourage use more forcefully, r=valentin,necko-reviewers

Comment 3

[Dorel Luca [:dluca]]

https://hg.mozilla.org/mozilla-central/rev/c9d056f74217