Add support for chromium-based browsers #218

AlexBeLi · 2017-03-19T11:41:50Z

Because ipfs-chrome-extension and ipfs-chrome-station don't support ipfs>=0.4.5.

lidel · 2017-03-19T14:27:47Z

This may require some additional work due to incompatibilities between WebExtensions and Chrome APIs.
It may be easier/faster to just fix one of mentioned Chrome extensions, at least for now.

"Make it work in Chromium" TODO list 🚧 👷

🛑 Hard Errors

Things that make it impossible to load WebExtension under Chromium or connect to IPFS API.

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 (there is also https://github.com/MetaMask/extensionizer) (fixed in chromium-compat branch)
Only one of browser_action, page_action can be specified in Chromium (we use both) (fixed in chromium-compat branch)
Chromium has some additional restrictions regarding locale files which needs to be addressed (fixed by removing - from key names)
Chromium does not support async / await yet (Firefox does and I plan to use it extensively)
In general, chrome target would probably need some kind of transpilling
(supports since v55)
Chromium complains about some i18 placeholders present in local files (fixed in chromium-compat branch)
Chromium does not support "alpha/beta" suffix in version in manifest (fixed in chromium-compat branch)
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) (fixed in chromium-compat branch)
Chromium sends Origin: null with XHR requests for /api/v0/swarm/peers which causes 403 - Forbidden error (fixed in chromium-compat branch)

⚠️ Soft Errors

These produce feature regressions, warnings / ugly interface, but do not break main functionality.

Chromium does not support protocol_handlers in manifest, this needs to be detected and manual handler needs to be installed.
Chromium does not ship with native CSS classes that are shipped with Firefox (fixed in chromium-compat branch)
Chromium does not accept Alarm periods less than minimum of 1 minutes (fixed in Refactoring of Browser Action and API Polling #266)

On Chrome, unless the add-on is loaded unpackaged, alarms it creates are not allowed to fire more than once per minute. If an add-on tries to set delayInMinutes to a value < 1, or when to a value < 1 minute in the future, then the alarm will fire after 1 minute. If an add-on tries to set periodInMinutes to a value < 1, then the alarm will fire every minute. – alarms.create()
Right-click "Upload to IPFS" does not work due to Origin mismatch

mateon1 · 2017-03-19T15:15:25Z

I just fixed ipfs-chrome-station, but it might take a while for fbaiodias/ipfs-chrome-station#15 to get merged, and the extension updated.
For now, you can use https://github.com/mateon1/ipfs-chrome-station/tree/fix/ipfs-0.4.5
To do so, clone the repo and switch to branch fix/ipfs-0.4.5. Run npm install and npm run build. You can then load the ./build folder in Chrome as an unpacked extension.

This fixes Chromium incompatibility mentioned in #218

daviddias · 2017-05-09T19:39:24Z

Following up ipfs/in-web-browsers#54 (comment), we want to have this WebExtension serving both.

Is Only one of browser_action, page_action can be specified in chrome (we use both) the only thing missing?

lidel · 2017-05-09T21:02:00Z

I remember there were multiple errors about unsupported manifest keys, eg. recently introduced protocol_handlers. I've added them to first post. There is probably more.

This "write once, run everywhere" story provided by Mozilla does not pass reality check.
As soon as we use non-canonical API provided by Firefox, we are not Chrome-compatible.
And as you can see there are discrepancies even within APIs copied from Chrome.

I suspect we will end up with chunks of conditional code and dedicated manifest and build pipeline for each browser.

That being said, we can simplify stuff by merging "pageAction" back into "browserActions".
One thing less to worry about.

lidel · 2017-05-11T12:43:03Z

FYI I'll do my best in diagnosing / mitigating compatibility issues in chromium-compat branch this week.
Stay tuned. 👌

victorb · 2017-05-11T12:47:45Z

I came across extensionizer[0] from the same peeps that are developing MetaMask, maybe
incorporating it and help develop it further would be a good idea

[0] https://www.npmjs.com/package/extensionizer - https://github.com/MetaMask/extensionizer

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

lidel · 2017-05-11T19:04:38Z

I am afraid extensionizer is not enough, as it is still callback-based.

Firefox introduced promise-based syntax and that functionality for Chrome is provided by webextension-polyfill, which is safe to be enabled all the time.

Update:

I've added the polyfill and it should be possible to build via npm run build and load it into Chromium based browser.

Browser button does not work yet, but that's a start.
Each error can be now fixed while using Chromium developer tools.

I also updated the list of known issues.

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

lidel · 2017-05-13T19:21:54Z

Oh hey, look what the cat dragged in:

I made some changes and chromium-compat branch loads under Chromium without "Hard Errors".

So far I noticed 3 issues that need additional work (see "Soft Errors"), but basic functionality works (redirect, Quick Upload, copying public URL, pinning etc)

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

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

This replaces alarm-based updates with message-based signalling based on `browser.runtime.connect` API Chrome does not support Alarm intervals smaller than one minute, so we will replace all of them with this new type of signalling. This is yet another piece of #218 (and #259) efforts. This commit also closes #243 by hiding broken actions in 'incognito' mode.

This fixes 1-minute-refresh lag in Chrome-based browsers (#218) and enables us to skip updates when browser is idle for more than 5 minutes. It should also close #259, as it no longer relies on Alerts for status updates.

styfle · 2017-07-27T00:55:01Z

@lidel Is this published to the Chrome Web Store now?

lidel · 2017-07-27T07:13:47Z

Not yet, but thanks for asking! I created #268 to track that.

lidel added kind/enhancement A net-new feature or improvement to an existing feature help wanted Seeking public contribution on this issue kind/maintenance Work required to avoid breaking changes or harm to project's status quo labels Mar 19, 2017

lidel added a commit that referenced this issue Apr 4, 2017

fix(locales): remove - from key names

ce2c218

This fixes Chromium incompatibility mentioned in #218

lidel self-assigned this May 11, 2017

lidel removed the help wanted Seeking public contribution on this issue label May 11, 2017

lidel added a commit that referenced this issue May 11, 2017

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

6f00741

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

lidel added a commit that referenced this issue May 11, 2017

fix(wx): merge pageAction into browserAction

8c86572

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

lidel closed this as completed May 11, 2017

lidel reopened this May 11, 2017

lidel added a commit that referenced this issue May 11, 2017

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

097e76c

Boilerplate for #218

lidel added a commit that referenced this issue May 11, 2017

fix(wx): wrap badge update in try block

c361d13

This solves load error under Chromium Part of #218

lidel added a commit that referenced this issue May 13, 2017

fix(wx): browser-agnostic CSS for browserAction

ddab60f

Part of #218 effort

lidel added this to In Progress in Rewrite as WebExtension May 18, 2017

lidel added a commit that referenced this issue May 21, 2017

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

2279e10

Part of #218 effort

lidel mentioned this issue May 21, 2017

Initial stab at Chromium compatibility #250

Merged

lidel added a commit that referenced this issue May 24, 2017

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

98d3946

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

lidel added a commit that referenced this issue May 24, 2017

fix(wx): merge pageAction into browserAction

a3650cd

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

lidel added a commit that referenced this issue May 24, 2017

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

cb6d239

Boilerplate for #218

lidel added a commit that referenced this issue May 24, 2017

fix(wx): wrap badge update in try block

176325a

This solves load error under Chromium Part of #218

lidel added a commit that referenced this issue May 24, 2017

fix(wx): browser-agnostic CSS for browserAction

55490d2

Part of #218 effort

lidel added a commit that referenced this issue May 24, 2017

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

34fe31b

Part of #218 effort

lidel mentioned this issue Jul 8, 2017

Captain.log - ipfs-companion #265

Closed

lidel mentioned this issue Jul 9, 2017

Refactoring of Browser Action and API Polling #266

Merged

lidel closed this as completed in #266 Jul 9, 2017

lidel moved this from In Progress to Ready in Rewrite as WebExtension Jul 22, 2017

lidel mentioned this issue Jul 27, 2017

Publish to Chrome Web Store #268

Closed

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for chromium-based browsers #218

Add support for chromium-based browsers #218

AlexBeLi commented Mar 19, 2017

lidel commented Mar 19, 2017 •

edited

Loading

mateon1 commented Mar 19, 2017

daviddias commented May 9, 2017

lidel commented May 9, 2017

lidel commented May 11, 2017

victorb commented May 11, 2017

lidel commented May 11, 2017 •

edited

Loading

lidel commented May 13, 2017 •

edited

Loading

styfle commented Jul 27, 2017

lidel commented Jul 27, 2017

Add support for chromium-based browsers #218

Add support for chromium-based browsers #218

Comments

AlexBeLi commented Mar 19, 2017

lidel commented Mar 19, 2017 • edited Loading

"Make it work in Chromium" TODO list 🚧 👷

🛑 Hard Errors

⚠️ Soft Errors

mateon1 commented Mar 19, 2017

daviddias commented May 9, 2017

lidel commented May 9, 2017

lidel commented May 11, 2017

victorb commented May 11, 2017

lidel commented May 11, 2017 • edited Loading

lidel commented May 13, 2017 • edited Loading

styfle commented Jul 27, 2017

lidel commented Jul 27, 2017

lidel commented Mar 19, 2017 •

edited

Loading

lidel commented May 11, 2017 •

edited

Loading

lidel commented May 13, 2017 •

edited

Loading