1223831 - Add SpecialPowers API for creating files

Status: RESOLVED FIXED

(Testing :: Mochitest, defect)

Description

[Andrew McCreight [:mccr8]]

Creating a file in the profile directory with a specific name and contents is a very common operation in a number of DOM tests (see bug 1220304), so I think it makes sense to add a SpecialPowers API to do this in an e10s-compatible way.

Comment 1

[Andrew McCreight [:mccr8]]

Attachment: SpecialPowers API to create files in an e10s-compatible way.

Andrea, please review the File API stuff in SpecialPowersObserver.js, as I don't really know what I'm doing there. Joel for the rest. Well and that too if you want.

See bug 1220304 for examples of how this is used.

try run: https://treeherder.mozilla.org/#/jobs?repo=try&revision=0258ece2c04d

Comment 2

[Joel Maher ( :jmaher ) (UTC -8)]

Comment on attachment 8686164 [details] [diff] [review]
SpecialPowers API to create files in an e10s-compatible way.

Review of attachment 8686164 [details] [diff] [review]:
-----------------------------------------------------------------

I like this patch in general, it is pretty good and clean.  I would like some unittests for this in https://dxr.mozilla.org/mozilla-central/source/testing/mochitest/tests/Harness_sanity/ directory.  This also gives a clear example of how to use this.

Comment 3

[Andrea Marchesini [:baku]]

Comment on attachment 8686164 [details] [diff] [review]
SpecialPowers API to create files in an e10s-compatible way.

Review of attachment 8686164 [details] [diff] [review]:
-----------------------------------------------------------------

Are you planning to update the existing mochitests in follow-ups?

Comment 4

[Andrew McCreight [:mccr8]]

(In reply to Andrea Marchesini (:baku) from comment #3)
> Are you planning to update the existing mochitests in follow-ups?

Yes, the patches I have so far are in the blocking bug.

Comment 5

[Andrew McCreight [:mccr8]]

Attachment: SpecialPowers API to create files in an e10s-compatible way.

I added some basic tests. I check that the result has the expected length, but I'm not really sure how to check the contents so I didn't do that. This is probably good enough.

I don't check that remove files actually removes the files. We're putting them in the profile directory so I think it isn't a huge deal.

Funnily enough, I did accidentally trigger a bug while writing the tests, in "case "SpecialPowers.FilesCreated"" and the other one: we have to clear the _createFiles* handlers before we call them, in case there's a nested handler. I fixed that.

Comment 6

[Joel Maher ( :jmaher ) (UTC -8)]

Comment on attachment 8686844 [details] [diff] [review]
SpecialPowers API to create files in an e10s-compatible way.

Review of attachment 8686844 [details] [diff] [review]:
-----------------------------------------------------------------

thanks!

Comment 7

[Pulsebot]

https://hg.mozilla.org/integration/mozilla-inbound/rev/dbbf92e8a141

Comment 8

[Phil Ringnalda (:philor)]

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