Initial stab at Chromium compatibility #250

lidel · 2017-05-21T19:49:05Z

This PR provides initial support for Chromium 58+ browsers (ipfs/in-web-browsers#54, #218).

Running in Chromium

First, build it manually:

npm install
npm run build

Then open up chrome://extensions in Chromium-based browser, enable "Developer mode", click "Load unpacked extension..." and point it at add-on/manifest.json.

It should load just fine, with some minor warnings (see known issues below):

Brief list of issues fixed in this PR

Chromium does not have browser object and requires a polyfill for standardized APIs (which is a subset of APIs provided by Firefox): https://github.com/mozilla/webextension-polyfill
Only one of browser_action, page_action can be specified in Chromium
Chromium has some additional restrictions regarding locale files which needs to be addressed (fixed by removing - from key names)
Chromium complains about some i18 placeholders present in local files
Chromium does not support "alpha/beta" suffix in version in manifest
Chromium does not accept SVG as browserAction icon, PNG needs to be provided instead (https://stackoverflow.com/q/38457208, https://bugs.chromium.org/p/chromium/issues/detail?id=647182, https://bugs.chromium.org/p/chromium/issues/detail?id=29683)
Chromium sends Origin: null with XHR requests for /api/v0/swarm/peers which causes 403 - Forbidden error
Chromium does not ship with native CSS classes that are shipped with Firefox
Right-click "Upload to IPFS" does not work due to Origin mismatch

Known Issues

Remaining Issues that are not covered by this PR:

Chromium does not accept Alarm periods less than minimum of 1 minutes. This means "ipfs-api-status-update" will fire approximately every 1 minutes (instead of every 3 seconds). We can leave it that way, or rewrite API polling logic to use something else than Alarms API.
No support for web+foo protocols. Chromium does not support protocol_handlers in manifest, this needs to be detected and manual handler needs to be installed somehow.

Firefox supported simplified syntax, but Chromium does not. Implements part of #218

the syntax defined for Chrome's version is more restrictive than that used by Firefox: - https://developer.mozilla.org/en-US/Add-ons/WebExtensions/manifest.json/version - https://developer.chrome.com/extensions/manifest/version Part of #218 effort

Only one of browser_action, page_action can be specified in Chrome Part of #218 effort

Boilerplate for #218

This solves load error under Chromium Part of #218

Chromium does not support SVG [ticket below is 8 years old, I can't even..] https://bugs.chromium.org/p/chromium/issues/detail?id=29683 We use precomputed PNG versions instead. This fixes part of #218 effort

For some reason `js-ipfs-api` sends requests with "Origin: null" under Chrom which produces '403 - Forbidden' error. This workaround removes bogus header from API requests Part of #218 effort

Part of #218 effort

Turns out workaround introduced for Firefox in #227 broke right-click "Upload to IPFS" function under Chromium ;-) This commit adds userAgent check and enables workaround only under Firefox, making Chromium (#218) happy.

Part of #218 effort

lidel · 2017-05-23T21:32:49Z

Are we good to merge this? If so, hit me up with review approval.
I'd like to release it into Firefox's Development Channel as v2.0.0alpha5

whyrusleeping · 2017-05-23T22:33:27Z

loading it into chrome i get:

Failed to load extension from: ~/gopkg/src/github.com/ipfs/ipfs-companion/add-on
Invalid placeholder errorMsg for key notify_inlineErrorMsg

Followed by the entire manifest.json in a little scrollybox

whyrusleeping · 2017-05-23T22:34:04Z

chromium version: 58.0.3029.110

lidel · 2017-05-23T22:57:13Z

@whyrusleeping Are you sure you loaded code from chromium-compat branch?
Mentioned bug was fixed in 6f00741

whyrusleeping · 2017-05-24T01:41:26Z

@lidel youre right, i missed the checkout a branch bit. Works! 👍 👍

daviddias

This LGTM, exciting!

daviddias · 2017-05-24T18:22:36Z

add-on/src/lib/common.js

+  return context.getImageData(0, 0, size, size)
+}
+*/
+
 // OPTIONS
 // ===================================================================


Wouldn't it make more sense to modularize these sections?

Yes, at some point.
I've added those "section" comments, as common.js grew organically.

I was not sure what is the best course of action for "webextension modularization", as Firefox WX ecosystem was still brand new when I started the rewrite from legacy SDK.

In Chrome world people use ES6 modules, but feature is not implemented in any browsers natively at this time and requires you to transpile everything to a single .js file (example).

I avoided it and right now add-on code runs "as-is" (no transpilling), but I am not sure if this approach can be maintained in the long run, especially now that we support multiple browser vendors.

If you feel it is the time, create a new Issue and copy/link this comment there.
Alternatively, we leave it be a monolith until ES6 modules are natively supported by both Firefox and Chrome:

https://bugzilla.mozilla.org/show_bug.cgi?id=568953

https://bugs.chromium.org/p/v8/issues/detail?id=1569

daviddias · 2017-05-24T18:23:25Z

Ah, only see that purple merged label after. awesome!

lidel added 10 commits May 11, 2017 14:53

fix(wx): fix Chrome error caused by i18 placeholders

6f00741

Firefox supported simplified syntax, but Chromium does not. Implements part of #218

fix(wx): merge pageAction into browserAction

8c86572

Only one of browser_action, page_action can be specified in Chrome Part of #218 effort

fix(wx): add browser object via webextension-polyfill

097e76c

Boilerplate for #218

fix(wx): wrap badge update in try block

c361d13

This solves load error under Chromium Part of #218

fix(wx): Chromium uses raster as browserAction icon

3be4629

Chromium does not support SVG [ticket below is 8 years old, I can't even..] https://bugs.chromium.org/p/chromium/issues/detail?id=29683 We use precomputed PNG versions instead. This fixes part of #218 effort

fix(wx): remove bogus Origin from API requests

a5067bb

For some reason `js-ipfs-api` sends requests with "Origin: null" under Chrom which produces '403 - Forbidden' error. This workaround removes bogus header from API requests Part of #218 effort

fix(wx): browser-agnostic CSS for browserAction

ddab60f

Part of #218 effort

fix(wx): Origin mismatch under Chromium

bdbadd2

Turns out workaround introduced for Firefox in #227 broke right-click "Upload to IPFS" function under Chromium ;-) This commit adds userAgent check and enables workaround only under Firefox, making Chromium (#218) happy.

chore(docs): updated dev notes to include Chromium how-to

2279e10

Part of #218 effort

lidel added kind/enhancement A net-new feature or improvement to an existing feature kind/maintenance Work required to avoid breaking changes or harm to project's status quo labels May 21, 2017

lidel added this to the v2.0.0 milestone May 21, 2017

lidel assigned lidel, victorb, daviddias and whyrusleeping May 21, 2017

lidel requested a review from daviddias May 21, 2017 19:49

chore(scripts): moved generate-png-icons.sh to scripts/

ce6b9de

whyrusleeping approved these changes May 24, 2017

View reviewed changes

lidel merged commit d4e5d1e into master May 24, 2017

lidel deleted the chromium-compat branch May 24, 2017 06:21

daviddias reviewed May 24, 2017

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial stab at Chromium compatibility #250

Initial stab at Chromium compatibility #250

lidel commented May 21, 2017 •

edited

Loading

lidel commented May 23, 2017 •

edited

Loading

whyrusleeping commented May 23, 2017

whyrusleeping commented May 23, 2017

lidel commented May 23, 2017

whyrusleeping commented May 24, 2017

daviddias left a comment

daviddias May 24, 2017

lidel May 24, 2017 •

edited

Loading

daviddias commented May 24, 2017

Initial stab at Chromium compatibility #250

Initial stab at Chromium compatibility #250

Conversation

lidel commented May 21, 2017 • edited Loading

Running in Chromium

Brief list of issues fixed in this PR

Known Issues

lidel commented May 23, 2017 • edited Loading

whyrusleeping commented May 23, 2017

whyrusleeping commented May 23, 2017

lidel commented May 23, 2017

whyrusleeping commented May 24, 2017

daviddias left a comment

Choose a reason for hiding this comment

daviddias May 24, 2017

Choose a reason for hiding this comment

lidel May 24, 2017 • edited Loading

Choose a reason for hiding this comment

daviddias commented May 24, 2017

lidel commented May 21, 2017 •

edited

Loading

lidel commented May 23, 2017 •

edited

Loading

lidel May 24, 2017 •

edited

Loading