Manifest V3 #297
Merged
Manifest V3 #297
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
The goal is to use event to sync content-scripts and background-script store by doing the following steps: 1. Content-script load in the tab/page and request the latest state available to the background-script 2. Background script will broadcast any changes to the store 3. Background script will initialise with the latest state available in chrome.storage (Implemented outside of the library for the time being) and broadcast the state to all content-scripts running in Chrome
Merged
wrapStore is no longer directly exported, it's constructed by createWrapStore. createWrapStore must be called synchronously when the service worker starts, allowing any message events to be queued and processed later after wrapStore is called. This avoids dropping dispatches from extension contexts that wake the service worker with a message.
Previously, we used ports to know which external contexts were interested in store updates. We don't use ports anymore, so there isn't an obvious mechanism to know which external contexts are interested in store updates. This means webext-redux can't be used across extensions anymore. I'm not sure how often this was used [1], but if there's use-cases for this, we could consider tracking contexts that recently requested messages and broadcast state updates to them, in addition to broadcasting state updates to the open tabs and our own extension pages. 1: Tried searching GitHub but found no results. This indicates the `extensionId` option is never used in open-source code. Or I didn't use the right search query. https://github.com/search?q=webext-redux+extensionId&type=code
eduardoacskimlinks
approved these changes
Jun 12, 2024
src/store/Store.js
Outdated
|
|
||
| // We request the latest available state data to initialise our store | ||
| this.browserAPI.runtime.sendMessage( | ||
| { type: FETCH_STATE_TYPE, portName }, undefined, this.initializeStore |
There was a problem hiding this comment.
I know I was responsible for not doing it 😅, but now that it will become part of the main package, I wonder if we are drooping port, and if it would make sense to rename portName to a more accurate representation.
There was a problem hiding this comment.
Good point, it would make sense to rename. The first name that comes to mind is messageType, any other ideas?
There was a problem hiding this comment.
Ended up renaming to channelName
This was referenced Jun 19, 2024
SentientClee
approved these changes
Jun 21, 2024
src/store/Store.js
Outdated
|
|
||
| default: | ||
| // do nothing | ||
| if(message.portName === this.portName){ |
There was a problem hiding this comment.
My follow-up pr #298 lints some additional files but this specific case isn't handled by the existing ESLint config. We should setup prettier in the future.
The default value is 0
chromex was likely chosen since that was part of the original name for the library: 739d7fe#diff-7ae45ad102eab3b6d7e7896acd08c427a9b25b346470d7bc6507b6481575d519R2 Updating the prefix to webext for clarity when debugging. It's not clear if these constants are part of the public API so I'll mention this in the changelog just in case someone relies on the value.
We no longer use ports for communication.
See 5c7d998 for context
ie messages that are sent over the messaging API but not created by this library. This commit adds some guards to avoid throwing type errors at runtime.
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.
This PR builds on the excellent work by @eduardoacskimlinks (#282), which is included in this PR.
sendMessagedirectly instead. This fixes a problem where the port stops working when the service worker sleeps. (by @eduardoacskimlinks)createWrapStore(). This addresses an issue where webext-redux wouldn't process dispatches or other messages if the message woke the service worker. This is a breaking change but I believe required for MV3. See diagram below and commit for details. bf485adnew Store({ extensionId: '...' })). See details in the commit message. 5c7d998Diagram for (2)
Closes #284, closes #244
TODO: (rough order)