feat(mv3): Manifest V3 Migration Checklist #1170
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| v18.14.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| { | ||
| "action": { | ||
| "browser_style": false | ||
| }, | ||
| "options_ui": { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,7 +23,6 @@ import createRuntimeChecks from './runtime-checks.js' | |
| import { createContextMenus, findValueForContext, contextMenuCopyAddressAtPublicGw, contextMenuCopyRawCid, contextMenuCopyCanonicalAddress, contextMenuViewOnGateway, contextMenuCopyPermalink, contextMenuCopyCidAddress } from './context-menus.js' | ||
| import { registerSubdomainProxy } from './http-proxy.js' | ||
| import { runPendingOnInstallTasks } from './on-installed.js' | ||
| const log = debug('ipfs-companion:main') | ||
| log.error = debug('ipfs-companion:main:error') | ||
|
|
||
|
|
@@ -57,11 +56,8 @@ export default async function init () { | |
| runtime = await createRuntimeChecks(browser) | ||
| state = initState(options) | ||
| notify = createNotifier(getState) | ||
|
|
||
| if (state.active) { | ||
| // It's ok for this to fail, node might be unavailable or mis-configured | ||
| try { | ||
| ipfs = await initIpfsClient(browser, state) | ||
|
|
@@ -108,7 +104,7 @@ export default async function init () { | |
| throw new Error('IPFS Companion: API client is disabled') | ||
| } | ||
|
|
||
| function registerListeners() { | ||
| const onBeforeSendInfoSpec = ['blocking', 'requestHeaders'] | ||
| if (browser.webRequest.OnBeforeSendHeadersOptions && 'EXTRA_HEADERS' in browser.webRequest.OnBeforeSendHeadersOptions) { | ||
| // Chrome 72+ requires 'extraHeaders' for accessing all headers | ||
|
|
@@ -172,16 +168,6 @@ export default async function init () { | |
| const result = validIpfsOrIpns(path) ? resolveToPublicUrl(path) : null | ||
| return Promise.resolve({ pubGwUrlForIpfsOrIpnsPath: result }) | ||
| } | ||
| } | ||
|
|
||
| // PORTS (connection-based messaging) | ||
|
|
@@ -473,7 +459,7 @@ export default async function init () { | |
| // ------------------------------------------------------------------- | ||
|
|
||
| async function updateBrowserActionBadge () { | ||
| if (typeof browser.action.setBadgeBackgroundColor === 'undefined') { | ||
| // Firefox for Android does not have this UI, so we just skip it | ||
| return | ||
| } | ||
|
Comment on lines
+466
to
469
There was a problem hiding this comment. It looks like this is supported in firefox for android now, https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/action/setBadgeBackgroundColor#browser_compatibility, so we can remove the comment, but we may still want to double check for the existence of this method There was a problem hiding this comment. the weird part is, firefox for android limited the number of extensions, there was IIRC a brief moment in time to get this running, but not anymore for the foreseeable future. I replaced a regex, so could be removed, I'd rather not touch it rn. |
||
|
|
@@ -498,13 +484,13 @@ export default async function init () { | |
| badgeIcon = '/icons/ipfs-logo-off.svg' | ||
| } | ||
| try { | ||
| const oldColor = colorArraytoHex(await browser.action.getBadgeBackgroundColor({})) | ||
| if (badgeColor !== oldColor) { | ||
| await browser.action.setBadgeBackgroundColor({ color: badgeColor }) | ||
| await setBrowserActionIcon(badgeIcon) | ||
| } | ||
| const oldText = await browser.action.getBadgeText({}) | ||
| if (oldText !== badgeText) await browser.action.setBadgeText({ text: badgeText }) | ||
| } catch (error) { | ||
| console.error('Unable to update browserAction badge due to error', error) | ||
| } | ||
|
|
@@ -525,14 +511,17 @@ export default async function init () { | |
| let iconDefinition = { path: iconPath } | ||
| try { | ||
| // Try SVG first -- Firefox supports it natively | ||
| await browser.action.setIcon(iconDefinition) | ||
| if (browser.runtime.lastError.message === 'Icon invalid.') { | ||
| throw new Error('Icon invalid.') | ||
whizzzkid marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| } catch (error) { | ||
| // Fallback! | ||
| // 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 | ||
| // Still, we want icon, so we precompute rasters of popular sizes and use them instead | ||
| iconDefinition = await rasterIconDefinition(iconPath) | ||
| await browser.action.setIcon(iconDefinition) | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -568,8 +557,6 @@ export default async function init () { | |
| await registerSubdomainProxy(getState, runtime) | ||
| shouldRestartIpfsClient = true | ||
| shouldStopIpfsClient = !state.active | ||
| break | ||
| case 'ipfsNodeType': | ||
| if (change.oldValue !== braveNodeType && change.newValue === braveNodeType) { | ||
|
|
@@ -636,8 +623,6 @@ export default async function init () { | |
| break | ||
| } | ||
| } | ||
|
|
||
| if ((state.active && shouldRestartIpfsClient) || shouldStopIpfsClient) { | ||
| try { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,6 +7,7 @@ import { browserActionFilesCpImportCurrentTab } from '../../lib/ipfs-import.js' | |
| import { ipfsContentPath } from '../../lib/ipfs-path.js' | ||
| import { welcomePage, optionsPage } from '../../lib/constants.js' | ||
| import { contextMenuViewOnGateway, contextMenuCopyAddressAtPublicGw, contextMenuCopyPermalink, contextMenuCopyRawCid, contextMenuCopyCanonicalAddress, contextMenuCopyCidAddress } from '../../lib/context-menus.js' | ||
| import { endSession, handleConsentFromState, startSession, trackView } from '../../lib/telemetry.js' | ||
|
|
||
| // The store contains and mutates the state for the app | ||
| export default (state, emitter) => { | ||
|
|
@@ -38,7 +39,8 @@ export default (state, emitter) => { | |
| let port | ||
|
|
||
| emitter.on('DOMContentLoaded', async () => { | ||
| handleConsentFromState(state) | ||
| trackView('browser-action') | ||
|
|
||
| // initial render with status stub | ||
| emitter.emit('render') | ||
|
|
@@ -205,6 +207,7 @@ export default (state, emitter) => { | |
| const prev = state.active | ||
| state.active = !prev | ||
| if (!state.active) { | ||
| endSession() | ||
|
There was a problem hiding this comment. if we're only calling startSession and endSession inside this DOMContentLoaded for browser-action now, then I don't think we're going to be tracking sessions properly anymore. Is that blocked by ipfs-shipyard/ignite-metrics#103 ? There was a problem hiding this comment. hmm.. that can be revisited, this was to just make sure we didn't miss out on these events, but these or on the best effort basis. |
||
| state.gatewayAddress = state.pubGwURLString | ||
| state.ipfsApiUrl = null | ||
| state.gatewayVersion = null | ||
|
|
@@ -213,6 +216,8 @@ export default (state, emitter) => { | |
| } | ||
| try { | ||
| await browser.storage.local.set({ active: state.active }) | ||
| startSession() | ||
| handleConsentFromState(state) | ||
| } catch (error) { | ||
| console.error(`Unable to update global Active flag due to ${error}`) | ||
| state.active = prev | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I took a look at https://developer.chrome.com/docs/extensions/mv3/manifest/web_accessible_resources/ and the first line
It appears that this is needed so that webpages can test if companion is being used, and if so, they can load recovery.html/js/css. Is that correct? are there other usecases where this is needed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These are resources needed by the extension to load a webpage from the extension.
They changed the way, we don't need
<all_urls>fixing it.