869709 - Define inline manifest API

Status: RESOLVED FIXED

(L20n :: HTML Bindings, defect, P2)

Description

[Zibi Braniecki [:zbraniecki][:gandalf]]

We currently have no way to inline the manifest.json file. It could be a win for fxos scenarios.

Comment 1

[Staś Małolepszy :stas]

As a reminder, see https://github.com/l20n/l20n.js/blob/master/bindings/README.md for the current HTML API.

Manifest files are linked to like so:

    <link rel="localization" href="../locales/browser.json">

Comment 2

[Staś Małolepszy :stas]

Gandalf, do you have any perf numbers to share?

Comment 3

[Zibi Braniecki [:zbraniecki][:gandalf]]

I mean, inlining the content of the manifest to halve the number of files loaded at startup.

Comment 4

[Staś Małolepszy :stas]

I understand, I'm just wondering what the potential perf gain is.  IIRC, last time we concluded that file IO *is not* where we should be looking for perf gains.

Bug 868930 is related.

Comment 5

[Zibi Braniecki [:zbraniecki][:gandalf]]

Last time I measured it was:

manifest: 1106ms (24)
no-manifest: 1067ms (16)

I believe this number to be around 30-40ms.

Comment 6

[Zibi Braniecki [:zbraniecki][:gandalf]]

Attachment: POC

Comment 7

[Staś Małolepszy :stas]

Reading the patch, it looks like the proposed syntax is:

  <meta name="languages" content="pl, fr, de">
  <meta name="resources" content="../locales/{{lang}}/res.l20n, /shared/{{lang}}/res.l20n">

It looks good to me except the fact that the comma is a valid character to have in URLs.  Reading http://www.ietf.org/rfc/rfc3986.txt, may I suggest "|" (the pipe character) as a delimiter of the resources' URLs?

Also, should all of this go into bindings/l20n/html.js or bindings/l20n/gaia.js (a new file)?

Comment 8

[Zibi Braniecki [:zbraniecki][:gandalf]]

Attachment: patch

patch with "," replaced by "|" as per stas suggestion

Comment 9

[Staś Małolepszy :stas]

Comment on attachment 751749 [details] [diff] [review]
patch

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

::: bindings/l20n/gaia.js
@@ +32,5 @@
> +      var metaRes = headNode.querySelector('meta[name="resources"]');
> +      if (metaLang && metaRes) {
> +        initializeManifest({
> +          'languages': metaLang.getAttribute('content').split('|').map(String.trim),
> +          'resources': metaRes.getAttribute('content').split('|').map(String.trim)

I think I'd prefer the comma for languages and the pipe for resources, but I don't have a strong opinion about this.

Comment 10

[Zibi Braniecki [:zbraniecki][:gandalf]]

https://github.com/l20n/l20n.js/commit/17ea6209ddf8c64cbdfee862350e44f4d1418461