Commit 8257977
authored
feat: add new
## Explanation
This PR introduces a new `@metamask/connectivity-controller` package
that provides a centralized way to track and manage device internet
connectivity status across MetaMask clients (extension and mobile).
**What is the current state of things and why does it need to change?**
- Have a single source of truth for connectivity state
- Share connectivity status across controllers and UI components
- Test connectivity-related functionality in isolation
- Maintain consistent behavior across platforms
**What is the solution your changes offer and how does it work?**
The `ConnectivityController` is a platform-agnostic controller that:
- Stores the current connectivity status (`online` or `offline`) in its
state
- Uses a service injection pattern where platform-specific
`ConnectivityService` implementations are injected at construction time
- Subscribes to connectivity changes from the service and automatically
updates its state
- Emits `stateChange` events when connectivity status changes, allowing
other controllers and UI components to react accordingly
The controller is designed to work with different service
implementations:
- **Mobile**: `NetInfoConnectivityService` using
`@react-native-community/netinfo`
- **Extension (same context)**: `BrowserConnectivityService` using
browser APIs
**Are there any changes whose purpose might not be obvious to those
unfamiliar with the domain?**
- The `connectivityStatus` field in state is prefixed with
"connectivity" to avoid conflicts when state is flattened in Redux
- The state is configured with `persist: false` since connectivity
status is ephemeral and should not be restored from storage
## References
Fixes: https://consensyssoftware.atlassian.net/browse/WPC-210
<!--
Add any relevant issues, related PRs, or documentation links here
-->
## Checklist
- [x] I've updated the test suite for new or updated code as appropriate
- [x] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [x] I've communicated my changes to consumers by [updating changelogs
for packages I've
changed](https://github.com/MetaMask/core/tree/main/docs/processes/updating-changelogs.md)
- [ ] I've introduced [breaking
changes](https://github.com/MetaMask/core/tree/main/docs/processes/breaking-changes.md)
in this PR and have prepared draft pull requests for clients and
consumer packages to resolve them
<!-- CURSOR_SUMMARY -->
---
> [!NOTE]
> Introduce a new, platform-agnostic controller to track device
connectivity with adapter-driven status updates.
>
> - New package `@metamask/connectivity-controller` exposing
`ConnectivityController`, `CONNECTIVITY_STATUSES`, and
`ConnectivityAdapter` interface
> - Controller initializes from adapter `getStatus()` and updates state
on `onConnectivityChange`, with non-persistent `connectivityStatus`
metadata
> - Comprehensive tests for initialization and status change handling;
100% coverage config
> - Added package docs (README, CHANGELOG, LICENSE) and build/test
configs (tsconfig, typedoc, jest)
> - Monorepo integration: README package list/graph, `CODEOWNERS`,
`teams.json`, tsconfig references, and `yarn.lock` entry
>
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
16c51b5. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->ConnectivityController (#7623)1 parent e7deea3 commit 8257977
File tree
18 files changed
+680
-0
lines changed- .github
- packages/connectivity-controller
- src
18 files changed
+680
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
68 | 68 | | |
69 | 69 | | |
70 | 70 | | |
| 71 | + | |
71 | 72 | | |
72 | 73 | | |
73 | 74 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
| 39 | + | |
39 | 40 | | |
40 | 41 | | |
41 | 42 | | |
| |||
111 | 112 | | |
112 | 113 | | |
113 | 114 | | |
| 115 | + | |
114 | 116 | | |
115 | 117 | | |
116 | 118 | | |
| |||
231 | 233 | | |
232 | 234 | | |
233 | 235 | | |
| 236 | + | |
| 237 | + | |
234 | 238 | | |
235 | 239 | | |
236 | 240 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
0 commit comments