Skip to content

fix: let browser handle navigation requests to support auth proxies #2069

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pakerfeldt wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: let browser handle navigation requests to support auth proxies #2069

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 16 additions & 27 deletions ui/src/sw.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,37 +1,26 @@
/// <reference lib="webworker" />
import { clientsClaim } from 'workbox-core'
import { cleanupOutdatedCaches, createHandlerBoundToURL, precacheAndRoute } from 'workbox-precaching'
import { NavigationRoute, registerRoute } from 'workbox-routing'
import { cleanupOutdatedCaches, precacheAndRoute } from 'workbox-precaching'

// self.__WB_MANIFEST is the default injection point
precacheAndRoute(self.__WB_MANIFEST)
// Navigation requests (request.mode === 'navigate') are intentionally NOT
// handled by the Service Worker. This lets the browser perform normal network
// navigation, which is critical when the dashboard sits behind an
// authentication proxy (Cloudflare Access, OAuth2 Proxy, Authelia, etc.).
// Without this, the SW would serve a cached index.html, preventing the browser
// from following HTTP redirects to the login page when the auth session expires.
//
// directoryIndex and cleanURLs are disabled so that precacheAndRoute does not
// implicitly serve index.html for navigation requests to '/dashboard/'.
// Static assets (JS, CSS, fonts, images) are still served from the precache
// via exact URL match, so page loads remain fast.
precacheAndRoute(self.__WB_MANIFEST, {
directoryIndex: null,
cleanURLs: false
})

// clean old assets
cleanupOutdatedCaches()

/** @type {RegExp[] | undefined} */
const denylist = []

// in dev mode, do not precache anything
if (import.meta.env.DEV) {
// don't precache anything
console.log('Development mode, not pre-caching anything')
denylist.push(/.*/)
} else {
// don't precache anything where the urls pathname ends with a slash (including times when the url has a query string)
// this permits the request to be handled by the server which will do a redirect as required
const configPath = self.location.pathname.split('/')[1]
denylist.push(new RegExp(`/${configPath}/[^?]*/(\\?.*)*$`))
}

// to allow work offline for allowed routes only
registerRoute(new NavigationRoute(
createHandlerBoundToURL('index.html'),
{ denylist }
))

self.skipWaiting()
// https://developer.mozilla.org/en-US/docs/Web/API/Clients/claim
clientsClaim()

// Add custom service worker code here