feat(app): prompt to reload when a newer deploy is live (#951)

Long-open tabs keep running the JS bundle they first loaded, so a shipped
change can look "missing" (e.g. a new settings field appearing only after a
full reload) until the whole app is reloaded. Add a small, unobtrusive prompt
that detects a newer deploy and offers a one-click reload.

- next.config: inline the deploy's commit SHA into the client bundle as
  NEXT_PUBLIC_BUILD_ID (empty in dev / self-hosted, which disables the check).
- /api/version: public, no-store route returning the running deployment's SHA
  at request time.
- DeployReloadPrompt: compares the two on load, on tab focus, and on a 30-min
  backstop; shows a bottom banner with "Ladda om" on mismatch. Mounted once in
  the root layout. No service worker, degrades to a no-op with no build id.

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
Jakob Wennberg
2026-07-09 22:14:37 +02:00
committed by GitHub
co-authored by Claude Opus 4.8
parent 82c66739d7
commit 0626bb6326
6 changed files with 98 additions and 0 deletions
+20
View File
@@ -0,0 +1,20 @@
import { NextResponse } from 'next/server'
/**
* Public, unauthenticated build-version probe.
*
* The client compares the id it was built with (NEXT_PUBLIC_BUILD_ID, inlined
* into its JS bundle at build time) against this value, which is read at
* request time from the currently running deployment. A mismatch means a newer
* deploy is live and the open tab is running a stale bundle, so the client
* offers a reload (see components/system/DeployReloadPrompt).
*
* force-dynamic + no-store so it always reflects the live deployment rather
* than a value baked in at build.
*/
export const dynamic = 'force-dynamic'
export function GET() {
const id = process.env.VERCEL_GIT_COMMIT_SHA ?? ''
return NextResponse.json({ id }, { headers: { 'Cache-Control': 'no-store' } })
}
+2
View File
@@ -5,6 +5,7 @@ import Script from "next/script";
import { NextIntlClientProvider } from "next-intl";
import { getLocale, getMessages } from "next-intl/server";
import { Toaster } from "@/components/ui/toaster";
import { DeployReloadPrompt } from "@/components/system/DeployReloadPrompt";
import { ThemeProvider } from "@/components/theme-provider";
import { RecaptLoader } from "@/components/RecaptLoader";
import { RecaptHideWidget } from "@/components/RecaptHideWidget";
@@ -86,6 +87,7 @@ export default async function RootLayout({
>
{children}
<Toaster />
<DeployReloadPrompt />
<RecaptHideWidget />
</ThemeProvider>
</NextIntlClientProvider>
+65
View File
@@ -0,0 +1,65 @@
'use client'
import { useEffect, useState } from 'react'
import { useTranslations } from 'next-intl'
import { Button } from '@/components/ui/button'
// Inlined at build time from next.config's `env` (the deploy's commit SHA on
// Vercel; empty in dev / self-hosted, which turns the check off).
const BUILD_ID = process.env.NEXT_PUBLIC_BUILD_ID || ''
/**
* Detects when a newer deploy is live while this tab is still running an old JS
* bundle, and offers a one-click reload. This is why a just-shipped change can
* appear "missing" in a long-open tab until the whole app is reloaded.
*
* Compares the build id baked into this bundle against /api/version (the
* running deployment's id), re-checking when the tab regains focus plus a slow
* interval backstop. No-op when no build id is set.
*/
export function DeployReloadPrompt() {
const t = useTranslations('common')
const [stale, setStale] = useState(false)
useEffect(() => {
if (!BUILD_ID || stale) return
let cancelled = false
async function check() {
try {
const res = await fetch('/api/version', { cache: 'no-store' })
if (!res.ok) return
const { id } = await res.json()
if (!cancelled && id && id !== BUILD_ID) setStale(true)
} catch {
// Transient network error: ignore, the next trigger retries.
}
}
function onVisible() {
if (document.visibilityState === 'visible') check()
}
check()
document.addEventListener('visibilitychange', onVisible)
const interval = setInterval(check, 30 * 60 * 1000) // 30 min backstop
return () => {
cancelled = true
document.removeEventListener('visibilitychange', onVisible)
clearInterval(interval)
}
}, [stale])
if (!stale) return null
return (
<div className="fixed inset-x-0 bottom-4 z-[60] flex justify-center px-4">
<div className="flex items-center gap-3 rounded-lg border border-border bg-popover px-4 py-3 text-sm shadow-md">
<span className="text-foreground">{t('update_available')}</span>
<Button size="sm" onClick={() => window.location.reload()}>
{t('reload')}
</Button>
</div>
</div>
)
}
+2
View File
@@ -1,5 +1,7 @@
{
"common": {
"update_available": "A new version is available.",
"reload": "Reload",
"save": "Save",
"saving": "Saving...",
"cancel": "Cancel",
+2
View File
@@ -1,5 +1,7 @@
{
"common": {
"update_available": "En ny version finns tillgänglig.",
"reload": "Ladda om",
"save": "Spara",
"saving": "Sparar...",
"cancel": "Avbryt",
+7
View File
@@ -52,6 +52,13 @@ const cspDirectives = [
const nextConfig: NextConfig = {
output: 'standalone',
// Build id inlined into the client bundle so a running tab can tell when a
// newer deploy is live (see components/system/DeployReloadPrompt). On Vercel
// this is the commit SHA; empty elsewhere (dev / self-hosted), which disables
// the check. The /api/version route reads the same var at runtime to compare.
env: {
NEXT_PUBLIC_BUILD_ID: process.env.VERCEL_GIT_COMMIT_SHA ?? '',
},
// Multiple lockfiles exist above this project (e.g. a parent yarn.lock),
// which makes Turbopack infer the wrong workspace root. Pin it explicitly.
turbopack: {