387096 - A nsIZipEntry can't be used anymore after nsIZipReader.close()

Status: RESOLVED FIXED

(Core :: Networking: JAR, defect)

Description

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

User-Agent:       Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.8.1.4) Gecko/20070602 Firefox/2.0.0.4 (Swiftfox) XPCOMViewer/0.9.5
Build Identifier: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.8.1.4) Gecko/20070602 Firefox/2.0.0.4 (Swiftfox) XPCOMViewer/0.9.5

In my extension, I used the following process:
* open a nsIZipReader from a file
* locate some entry inside that nsIZipReader
* close the nsIZipReader
* use the name of the entry with nsIZipEntry.name .

The result was random bugs, as the nsIZipEntry had been deallocated by nsIZipReader.close(), although it was still referenced.

I don't think it's a big issue *provided the documentation is clarified*. 

Suggested change:
Change
    /**
     * Closes a zip reader. Subsequent attempts to extract files or read from
     * its input stream will result in an error.
     */
to
    /**
     * Closes a zip reader. Subsequent attempts to extract files or read from
     * its input stream will result in an error. 
     *
     * Subsequent attempts to access a nsIZipEntry obtained from this zip
     * reader will cause unspecified behavior.
     */


Reproducible: Always

Steps to Reproduce:
1.
2.
3.

Comment 1

[:Cykesiopka]

Attachment: Proposed Patch

Comment 2

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

Comment on attachment 722148 [details] [diff] [review]
Proposed Patch

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

I had completely forgotten about that bug.
Thanks for the docfix.

Could you also update https://developer.mozilla.org/en-US/docs/XPCOM_Interface_Reference/nsIZipReader#close%28%29 ?

Comment 3

[:Cykesiopka]

(In reply to David Rajchenbach Teller [:Yoric] from comment #2)
> Comment on attachment 722148 [details] [diff] [review]
> Proposed Patch
> 
> Review of attachment 722148 [details] [diff] [review]:
> -----------------------------------------------------------------
> 
> I had completely forgotten about that bug.
> Thanks for the docfix.
> 
> Could you also update
> https://developer.mozilla.org/en-US/docs/XPCOM_Interface_Reference/
> nsIZipReader#close%28%29 ?

Done.

Comment 4

[:Cykesiopka]

Attachment: Patch for check in

Comment 5

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/integration/mozilla-inbound/rev/31b28458cee6

Comment 6

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/mozilla-central/rev/31b28458cee6