1195801 - Add API function for fetching Microdata data to the Browser API

Status: RESOLVED FIXED

(Core :: DOM: Core & HTML, defect)

Comment 1

[Ted Clancy [:tedders1]]

Attachment: bug-1195801-fix.patch

Comment 2

[Ted Clancy [:tedders1]]

This code fetches the Microdata and converts it into JSON, following the WHATWG recommendation.

https://html.spec.whatwg.org/multipage/microdata.html#json

This code also fetches Microformats data for two formats (hCard and hCalendar), which I consider to be legacy support. (The WHATWG spec for Microdata intends to eventually absorb hCard and hCalendar.)

https://html.spec.whatwg.org/multipage/microdata.html#vcard
https://html.spec.whatwg.org/multipage/microdata.html#vevent

Comment 3

[Kan-Ru Chen [:kanru] (UTC+9)]

Comment on attachment 8649331 [details] [diff] [review]
bug-1195801-fix.patch

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

Looks good. We need test cases, you could use dom/browser-element/mochitest/createNewTest.py to create templates

::: dom/browser-element/BrowserElementChildPreload.js
@@ +1587,5 @@
> +
> +  _processItem: function(node, alreadyProcessed) {
> +    if (alreadyProcessed.includes(node)) {
> +      return "ERROR";
> +    }

null check alreadyProcessed.

Do we really want to include "ERROR" in the result if bad things happen? I think we could use a debug message here.

@@ +1647,5 @@
> +
> +    sendAsyncMsg('got-structured-data', {
> +      id: data.json.id,
> +      successRv: resultString
> +    });

return result directly?

Comment 4

[Ted Clancy [:tedders1]]

Attachment: bug-1195801-fix.patch

Comment 5

[Ted Clancy [:tedders1]]

(In reply to Kan-Ru Chen [:kanru] from comment #3)
> 
> Do we really want to include "ERROR" in the result if bad things happen? I
> think we could use a debug message here.

The string "ERROR" is actually part of the WHATWG spec.

> return result directly?

The idea is to support the JSON format described in https://html.spec.whatwg.org/multipage/microdata.html#json, and JSON needs to be a string.

Comment 6

[Ted Clancy [:tedders1]]

Attachment: bug-1195801-fix.patch

Comment 7

[Ted Clancy [:tedders1]]

Attachment: bug-1195801-tests.patch

This uses much the same test infrastructure as Bug 1169633.

Comment 8

[Ted Clancy [:tedders1]]

Comment on attachment 8662753 [details] [diff] [review]
bug-1195801-fix.patch

There were some moderate changes to this file, so I'm flagging it for re-review. Sorry, Kanru.

Comment 9

[Ted Clancy [:tedders1]]

Try run: https://treeherder.mozilla.org/#/jobs?repo=try&revision=5de0f9368e26

Comment 10

[Carsten Book [:Tomcat]]

this needs dom peer review for the change in dom/webidl/BrowserElement.webidl

Comment 11

[marcos]

Ted, please ask :bholly to review the WebIDL :)

Comment 12

[Ted Clancy [:tedders1]]

Comment on attachment 8662753 [details] [diff] [review]
bug-1195801-fix.patch

Bobby, can you review the change to nsIBrowserElementAPI.idl?

Comment 13

[Bobby Holley (:bholley)]

Comment on attachment 8662753 [details] [diff] [review]
bug-1195801-fix.patch

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

Please document that the actual value returned via the DOMRequest is a JSON string.

Comment 14

[Ted Clancy [:tedders1]]

Attachment: bug-1195801-fix.patch

Comment 15

[Pulsebot]

https://hg.mozilla.org/integration/mozilla-inbound/rev/39b57a8b21d5
https://hg.mozilla.org/integration/mozilla-inbound/rev/78abc4497de5

Comment 16

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

https://hg.mozilla.org/mozilla-central/rev/39b57a8b21d5
https://hg.mozilla.org/mozilla-central/rev/78abc4497de5

Comment 17

[Marcos Caceres [:marcosc]]

When the docs are done, please be clear that this is not a standards complaint implementation of any semantic web technology.

Comment 18

[Chris Mills [:cmills]]

Method documented at

https://developer.mozilla.org/en-US/docs/Web/API/HTMLIFrameElement/getStructuredData

Release note added at

https://developer.mozilla.org/en-US/docs/Mozilla/Firefox_OS/Releases/2.5

A tech review would be great — thanks!

Comment 19

[Mike Kaply [:mkaply]]

Removed in bug 1273203.