Skip to content

fix: prevent 401 errors on authenticated media after service worker restart#516

Merged
7w1 merged 3 commits intoSableClient:devfrom
Just-Insane:fix/sw-media-auth
Mar 25, 2026
Merged

fix: prevent 401 errors on authenticated media after service worker restart#516
7w1 merged 3 commits intoSableClient:devfrom
Just-Insane:fix/sw-media-auth

Conversation

@Just-Insane
Copy link
Copy Markdown
Contributor

@Just-Insane Just-Insane commented Mar 24, 2026

Description

The service worker (SW) loses its in-memory session on restart (e.g. after the browser kills the SW background process). Any authenticated media request arriving before the SW re-reads session data from cache was returning a 401.

Two fixes:

  1. Eager pre-load on activate: the SW now reads session data from the cache during the activate event, so it is available immediately when the first fetch event fires.
  2. Graceful fallback in fetch handler: if session data is still missing or stale at request time, the request is passed through to the network without injecting a bad Authorization header (previously an empty/invalid token was injected, causing the 401).

Fixes #

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings

AI disclosure:

  • Partially AI assisted (clarify which code was AI assisted and briefly explain what it does).
  • Fully AI generated (explain what all the generated code does in moderate detail).

Attempts to resolve issues with the service worker not properly storing and/or refreshing media auth tokens on load. The changes mainly serve to ensure that a session is persisted during restarts (and then drop the persisted session once a live one is available). Also helps with refreshing tokens (sw.ts ln 651-661)

Three changes to src/sw.ts:

1. Fix early-return bug in fetch handler: when sessions.get(clientId)
   returns a session but validMediaRequest(url, session.baseUrl) fails
   (e.g. multi-account users on different homeservers, or URL format
   mismatch), the old code returned without calling event.respondWith(),
   causing the browser to make an unauthenticated request → 401.
   Now we only short-circuit if BOTH conditions are met.

2. Proactively broadcast requestSession to all window clients in the
   activate event. After a SW restart the sessions Map is empty; the
   old code relied on the first intercepted media fetch to trigger
   requestSessionWithTimeout. Now the SW pre-populates the Map right
   after claiming clients, eliminating the 3-second race window.

3. Add loadPersistedSession() as a final fallback in the fetch handler.
   If requestSessionWithTimeout returns nothing (
Three changes to src/sw.ts:

1. Fix early-return bug in fetch handler: when sessions.get(clientId)
   returns a session buo a
1. Fix early-return bug i
On SW restart the in-memory sessions Map is empty. Previously the fetch
handler fell through to requestSessionWithTimeout (3 s race window), so
all simultaneous thumbnail loads during that window 401'd.

Changes:
- Populate preloadedSession from Cache Storage in the activate handler
  so media fetches get immediate auth before the first live setSession
  arrives from the page.
- Include preloadedSession in the byBaseUrl fast path so the synchronous
  branch handles the burst of thumbnail requests without waiting at all.
- Clear preloadedSession as soon as any real setSession arrives so stale
  tokens cannot linger.
- Handle empty clientId (uncontrolled-context fetches) by falling through
  to byBaseUrl / preloadedSession / loadPersistedSession instead of doing
  a bare return that bypassed respondWith and caused an unauthenticated
  request.
@Just-Insane Just-Insane marked this pull request as ready for review March 24, 2026 16:31
@Just-Insane Just-Insane requested review from 7w1 and hazre as code owners March 24, 2026 16:31
@Just-Insane
Copy link
Copy Markdown
Contributor Author

Just-Insane commented Mar 24, 2026

This may actually cause issues with resuming from background in iOS - it seems like new messages don't show in the timeline until the PWA is closed. More testing required.

Edit:

Actually, I think the messages are just rendering out of order (which I don't think is related to this PR) - Clicking on a message notification brings me to the message, at the top of the synced message group.

Should be fixed by 1. in #529

@7w1 7w1 added this pull request to the merge queue Mar 25, 2026
Merged via the queue into SableClient:dev with commit ec2dcfb Mar 25, 2026
9 checks passed
github-merge-queue bot pushed a commit that referenced this pull request Mar 28, 2026
> [!IMPORTANT]
> Merging this PR will create a new release.

## Features

* Add ability to click on usernames in member and state events to view
user info ([#536](#536) by
@thundertheidiot)
* Add black theme ([#437](#437)
by @Elec3137)
* added a limited compatibility with `pk;member` commands
([#550](#550) by @dozro)
* Add /location sharing command, and a /sharemylocation command.
([#509](#509) by @nushea)
* added option to use shorthands to send a message with a Persona, for
example `✨:test` ([#550](#550)
by @dozro)
* Add quick reply keybinds by using <kbd>ctrl</kbd>+<kbd>up</kbd> /
<kbd>ctrl</kbd>+<kbd>down</kbd> you can now cycle through the message
you are replying to with keybinds
([#524](#524) by @CodeF53)
* Adds a `/html` command to send HTML messages
([#560](#560) by @Vespe-r)
* Add room abbreviations with hover tooltips: moderators define
term/definition pairs in room settings; matching terms are highlighted
in messages. ([#514](#514) by
@Just-Insane)
* Add support for timestamps, playlists and youtube music links for the
youtube embeds ([#534](#534) by
@thundertheidiot)
* Add settings sync across devices via Matrix account data, with JSON
export/import ([#515](#515) by
@Just-Insane)

## Fixes

* Add detailed error messages to forwarding failures.
([#532](#532) by @7w1)
* Cap unread badge numbers at `1k+`, and something extra :)
([#484](#484) by @hazre)
* Fix scroll-to-bottom after room navigation, timeline pagination
reliability, and URL preview deduplication.
([#529](#529) by @Just-Insane)
* Fixes the most recent pmp message in encrypted rooms not consistently
rendering the pmp and not grouping with previous pmps.
([#526](#526) by @7w1)
* fixed sending sticker and attachments while having a persona selected
([#525](#525) by @dozro)
* Fix push notifications missing sender/room avatar and showing stale
display names when using event_id_only push format.
([#551](#551) by @Just-Insane)
* Sanitize formatted reply previews before rendering to prevent unsafe
HTML from being parsed in reply snippets.
([#569](#569) by @Just-Insane)
* Fix broken link to Sliding Sync known issues — now points to
#39 instead of the old repository.
([#519](#519) by @Just-Insane)
* Fix service worker authenticated media requests returning 401 errors
after SW restart or when session data is missing/stale.
([#516](#516) by @Just-Insane)
* rephrased the command describtion for `/usepmp` and made `/usepmp
reset` actually reset the room association of the pmp
([#550](#550) by @dozro)
* Fix confusing ui with `Client Side Embeds in Encrypted Rooms` setting
([#535](#535) by
@thundertheidiot)
* fix forwarding metadata by removing the `null` value
([#540](#540) by @dozro)
* fix forwarding issue for users on synapse homeservers, by removing the
relation ([#558](#558) by
@dozro)
* fixed the syntax issues regarding `/addpmp` and `usepmp` (note that
the syntax for `/usepmp` has changed)
([#550](#550) by @dozro)
* fix the display of jumbo emojis on messages sent with a persona
([#530](#530) by @dozro)
* Fix sidebar notification badge positioning so unread and unverified
counts align consistently.
([#484](#484) by @hazre)
* Use the browser's native compact number formatting for room and member
counts. ([#484](#484) by
@hazre)
* fix(sentry): scrub percent-encoded Matrix IDs and opaque base64url
tokens from Sentry URLs
([#531](#531) by @Just-Insane)

## Notes

* new/changed bios will now also be saved in the format MSC4440 expects
([#559](#559) by @dozro)
* moved the setting for filtering pronouns by language from experimental
to the appearance setting
([#521](#521) by @dozro)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants