1221754 - HAR fails to specify encoding for base64-encoded resources

Status: RESOLVED FIXED

(DevTools :: Netmonitor, defect)

Description

[Eric Lawrence (@ericlaw)]

User Agent: Mozilla/5.0 (Windows NT 6.3; WOW64; rv:45.0) Gecko/20100101 Firefox/45.0
Build ID: 20151104030437

Steps to reproduce:

1. Open the Developer Tools, Network Tool.
2. Visit any page with binary resources (or directly navigate to a binary resource like this image: https://www.bayden.com/images/banner.jpg?12345)
3. Right click in the Network Request list and choose "Copy all as HAR"




Actual results:

HAR text is copied to the clipboard, and the resource is base64 encoded:

    "content": {
            "mimeType": "image/jpeg",
            "size": 6171,
            "text": "/9j/4AAQSkZJRgD...VKgD//Z"
          }

... however the "encoding" attribute indicating that this encoding was performed is missing from the JSON.



Expected results:


Specifically, the JSON should look like this:

    "content": {
            "mimeType": "image/jpeg",
            "size": 6171,
            "text": "/9j/4AAQSkZJRgD...VKgD//Z",
            "encoding": "base64"
          },

From the HAR spec:

text [string, optional] - Response body sent from the server or loaded from the browser cache. This field is populated with textual content only. The text field is either HTTP decoded text or a encoded (e.g. "base64") representation of the response body. Leave out this field if the information is not available.

encoding [string, optional] (new in 1.2) - Encoding used for response text field e.g "base64".

This bug should be linked to https://bugzilla.mozilla.org/show_bug.cgi?id=859058

Comment 1

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

Honza, this looks like an easy fix.  Would you like to do it, or maybe mentor someone else to do so?

Comment 2

[Jan Honza Odvarko [:Honza] (always need-info? me)]

Attachment: bug1221754-1.patch

The attached patch exports also encoding.

Eric, thanks for the report!


Honza

Comment 3

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

Comment on attachment 8684881 [details] [diff] [review]
bug1221754-1.patch

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

In general this looks fine, but I recall :tromey recently removed encoding somewhere, so let's have him take a look too.

Comment 4

[Tom Tromey :tromey]

Comment on attachment 8684881 [details] [diff] [review]
bug1221754-1.patch

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

Looks good.

Comment 5

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

From IRC discussion, it sounds like there may be more details to resolve here before landing.

Comment 6

[Jan Honza Odvarko [:Honza] (always need-info? me)]

Yep, I am working it.

Honz

Comment 7

[Jan Honza Odvarko [:Honza] (always need-info? me)]

Attachment: bug1221754-bodySize.patch

I double checked and the patch works correctly.

I wasn't clear on IRC, here are corrected notes:

1) 'response.content.encoding' - specified encoding used for response.content.text field (e.g "base64"). This has nothing to do with encoding in HTTP, it only says how the response content is encoded in the HAR file.
2) 'response.content.size' - length of the returned content in bytes. Should be equal to response.bodySize if there is no compression and bigger when the content has been compressed.
3) 'response.bodySize' - Size of the received response body in bytes. Should zero in case of responses coming from the cache (304). Should be -1 if the info is not available.


Tom's patch in bug 937586 is just fine and making things better.


Add #3 was -1 even for 304 requests, it's fixed by the (second) attached patch. But, let me know if I should report another bug for this.

Honza

Comment 8

[Pulsebot]

https://hg.mozilla.org/integration/fx-team/rev/0788d3d50016
https://hg.mozilla.org/integration/fx-team/rev/69777d636519

Comment 9

[Phil Ringnalda (:philor)]

https://hg.mozilla.org/mozilla-central/rev/0788d3d50016
https://hg.mozilla.org/mozilla-central/rev/69777d636519