Update manifest.json with browser-specific permissions #529
Conversation
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
1284ab2
to
a1f8c8b
Compare
bbf7707
to
a1f8c8b
Compare
a1f8c8b
to
fdd9946
Compare
maxxcrawford
commented
Oct 9, 2023
config-permissions.sh
Outdated
Comment on lines
6
to
10
| if [[ "$OSTYPE" == "darwin"* ]]; then | ||
| sed -i '' "s|menus|contextMenus|g" src/manifest.json | ||
| else | ||
| sed -i "s|menus|contextMenus|g" src/manifest.json | ||
| fi |
There was a problem hiding this comment.
Note this doesn't take an argument like the configure-domain.sh script.
It's straight menus --> contextMenus
Comment on lines
+13
to
+16
| "build:dev": "npm run build:clean && npm run config:dev && npm run build", | ||
| "build:stage": "npm run build:clean && npm run config:stage && npm run build", | ||
| "build:prod": "npm run build:clean && npm run config:prod && npm run build", |
There was a problem hiding this comment.
Context: Removed the package:chrome script as this build script will no longer work for Chrome (without the extra script)
| @@ -26,8 +30,7 @@ | |||
| "web-ext-run:firefox": "npm run web-ext-run -- --target firefox-desktop", | |||
| "web-ext-run:firefox-mv3": "npm run web-ext-run -- --firefox-preview --pref=extensions.eventPages.enabled=true --verbose", | |||
| "web-ext-run:android": "npm run web-ext-run -- --target firefox-android --adb-device $npm_config_device --firefox-apk org.mozilla.fenix", | |||
| "web-ext-run:chrome": "npm run web-ext-run -- --target chromium", | |||
| "web-ext-run:desktop": "npm run web-ext-run -- --target chromium --target firefox-desktop" | |||
There was a problem hiding this comment.
Removed this npm script as it will the add-on can no longer work simultaneously.
fdd9946
to
6134b51
Compare
maxxcrawford
commented
Oct 9, 2023
| @@ -8,11 +8,16 @@ | |||
| "web-ext": "^7.6.2" | |||
| }, | |||
| "scripts": { | |||
| "build:dirty": "web-ext build -s src/", | |||
There was a problem hiding this comment.
This process moved the reset step (build:clean) to the END of the Chrome-build script
groovecoder
approved these changes
Oct 10, 2023
package.json
Outdated
| "build:chrome-dev": "npm run build:clean && npm run config:dev && npm run config:chrome && npm run build:dirty && npm run package:chrome && npm run build:clean", | ||
| "build:chrome-stage": "npm run build:clean && npm run config:stage && npm run config:chrome && npm run build:dirty && npm run package:chrome && npm run build:clean", | ||
| "build:chrome-prod": "npm run build:clean && npm run config:prod && npm run config:chrome && npm run build:dirty && npm run package:chrome && npm run build:clean", | ||
| "config:chrome": "./config-permissions.sh", |
There was a problem hiding this comment.
suggestion (non-blocking): re-name this script to config-chrome.sh?
Co-authored-by: luke crouch <[email protected]>
eaa1819
to
b38e594
Compare
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Our Chrome submission of the add-on is being rejected because we have a Firefox-specific permission listed in the manifest file:
menusPreviously, this permission was ignored. It is now grounds for rejection: https://developer.chrome.com/docs/webstore/troubleshooting/#does-not-work
Jira: https://mozilla-hub.atlassian.net/browse/MPP-3466
TODO:
Update Chrome release steps in internal documentationWon't update until this PR is mergedStarting now, this project will only update the manifest (for Chrome) during build processes. This means without running the proper script, the add-on will not work for Chrome.
Testing
Confirm defaults work for Firefox
npm run devConfirm you can work on Chrome locally
npm run web-ext-run:chromeConfirm you can build the add-on locally for a targeted platform/stage environment:
Note
You can also test by examining the output manifest.json file and confirming that Firefox builds have the
menuspermission while the Chrome builds havecontextMenus.For Firefox/Stage
npm run build:stageweb-ext-artifactsfor a Firefox build (Test by installing on Nightly) pointed at stageFor Chrome/Prod
npm run build:chrome-prodweb-ext-artifactsfor a Chrome build (Test by installing on Chrome) pointed at prod