1087978 - Support W3C format of the icons manifest property

Status: RESOLVED WONTFIX

(Core Graveyard :: DOM: Apps, defect)

Description

[Ben Francis [:benfrancis]]

The latest draft of the W3C spec for Web Manifests proposes a slightly different format for the "icons" property to what is currently used in Open Web Apps manifests.

Open Web App manifests use a map of sizes to paths:

"icons": {
  "128": "/img/icon-1.png",
  "512": "/img/icon-2.jpg"
}

W3C Web Manifests use an array of objects containing src, sizes and type properties [1]:

"icons": [
  {
    "src": "icon/lowres",
    "sizes": "64x64",
    "type": "image/webp"
  }, {
    "src": "icon/hd_small",
    "sizes": "64x64"
  }, {
    "src": "icon/hd_hi",
    "sizes": "128x128",
    "density": 2
  }
]

http://w3c.github.io/manifest/#icons-member


This bug is to track adding support for the W3C proposed format.

Comment 1

[Ben Francis [:benfrancis]]

This property is used in lots of places in Gaia (e.g. System, Homescreen, Settings, Search).

Fabrice, do you think we should attempt to translate the W3C format into the Open Web App format so that no changes are required in Gaia to begin with, or do you think we should modify Gaia to support both formats by detecting whether the value is an array or not?

Comment 2

[[:fabrice] Fabrice Desré]

If we do a conversion, it will be best effort and potentially lossy. We'll need a default value for "any" and decide what to do if a non-square image is specified (though it's probably and edge case).

Would gaia benefit from using the new format?

Comment 4

[Ben Francis [:benfrancis]]

It seems the logic to parse the icons property is duplicated in many apps in Gaia. It would be a lot simpler on the Gaia side if Gecko just translated from one format to the other, but actually what might be better would be if we update all the places in Gaia that parse the icons property to use the new App.getIcons() method on the Apps API instead (added in bug 1000305), then Gecko can support whatever it likes.

Ted, would you have bandwidth to add support for the W3C format of the icons property to the getIcon() method before 2.2 FL so we can start to replace all the occurrences in Gaia to use that and automatically support both formats?

Comment 5

[Ted Clancy [:tedders1]]

Hey Ben. I haven't had a chance to check with Gregor, but I do have some spare cycles right now, and unless something comes up in triage tomorrow, I can start work on this.

Comment 6

[Ben Francis [:benfrancis]]

Great, thanks! For what it's worth, I already mentioned this to Gregor in a standup. I'll start filing bugs for all the places in Gaia we need to start using this...

Comment 7

[Ben Francis [:benfrancis]]

I filed meta bug 1134657 to track all the places this needs updating in Gaia.

Comment 8

[Ben Francis [:benfrancis]]

Hi Ted, how is this going?

Comment 9

[Ben Francis [:benfrancis]]

Tip: Check out Marcos' WIP manifest processor in bug 1079453

We may need to copy some of this logic into Gaia for bug 1134795 because as far as I know there's no API to get an icon for an app which isn't installed.

Comment 10

[Ben Francis [:benfrancis]]

Ted, is this what you're looking for? http://lxr.mozilla.org/mozilla-central/source/dom/manifest/ManifestProcessor.jsm#219

Looks like it could be hooked up to http://lxr.mozilla.org/mozilla-central/source/dom/apps/AppsUtils.jsm#908 (or copy the code for now, until we figure out how to hook up Marcos' standalone manifest processor to the Apps API)

Comment 11

[Ben Francis [:benfrancis]]

Unassigning myself as it's not clear whether this is still needed.

Comment 12

[Sylvestre Ledru [:Sylvestre]]

Core Graveyard / DOM: Apps is inactive. Closing all bugs in this component.