Guard Matrix client lifecycle starts#43
Merged
Merged
Conversation
|
Deploying with
|
| Status | Preview URL | Commit | Alias | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! | https://pr-43-sable.justin-tech.workers.dev | 7da21a2 | pr-43 |
Sat, 13 Jun 2026 15:22:29 GMT |
There was a problem hiding this comment.
Pull request overview
This PR adds lifecycle guards around Matrix client startup/shutdown so the “app” Matrix client behaves like a singleton (preventing duplicate/concurrent starts), while allowing background notification clients to start independently. It also updates call sites to await/chain client shutdown where needed and adds regression tests for the new gating behavior.
Changes:
- Introduces an app-scoped
startClientgate to reuse in-flight starts and stop/replace any previously-active app client. - Changes
stopClientto return aPromise<void>(with a short settlement delay) and updates callers toawait/voidit appropriately. - Adds
clientScope: 'background'for background notification clients and tests covering the new app start gating.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/client/initMatrix.ts | Adds app-scope start gating, background scope opt-out, and makes stopClient async-like for sequencing. |
| src/client/initMatrix.test.ts | Adds tests for app singleton start behavior; expands Sentry mocks. |
| src/app/pages/client/sidebar/AccountSwitcherTab.tsx | Ensures navigation to “add account” happens after client stop completes (via finally). |
| src/app/pages/client/ClientRoot.tsx | Awaits/voids stopClient in lifecycle paths; avoids triggering redundant start while already loading. |
| src/app/pages/client/BackgroundNotifications.tsx | Marks background clients with clientScope: 'background' and prevents duplicate background starts per user. |
Comment on lines
+1074
to
+1094
| if (activeAppClient && activeAppClient !== mx) { | ||
| debugLog.warn('sync', 'Stopping previous app Matrix client before starting replacement', { | ||
| previousUserId: activeAppClient.getUserId(), | ||
| nextUserId: mx.getUserId(), | ||
| previousSyncState: activeAppClient.getSyncState(), | ||
| previousRunning: activeAppClient.clientRunning, | ||
| }); | ||
| Sentry.addBreadcrumb({ | ||
| category: 'sync.lifecycle', | ||
| message: 'Stopping previous app Matrix client before replacement start', | ||
| level: 'warning', | ||
| data: { | ||
| previousUserId: activeAppClient.getUserId(), | ||
| nextUserId: mx.getUserId(), | ||
| previousSyncState: activeAppClient.getSyncState(), | ||
| previousRunning: activeAppClient.clientRunning, | ||
| }, | ||
| }); | ||
| Sentry.metrics.count('sable.sync.previous_app_client_stopped', 1); | ||
| await stopClient(activeAppClient); | ||
| } |
Comment on lines
+63
to
+65
| const startClassicClient = async (mx: MockMatrixClient): Promise<void> => { | ||
| startedClients.push(mx); | ||
| await startClient(mx, { |
This file contains hidden or 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
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.
Description
Fixes #
Type of change
Checklist:
AI disclosure: