mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-10-20 14:06:27 +00:00
fix(notices): hand the release notice only to a bundle built for the running version
After an update the service worker keeps serving the previous bundle until the new one is installed. That shell announces the release layout too, so the layout alone let it draw the notice with its own older texts and use it up for the version now running with one click on X. The bundle now sends the version it was built as (client/package.json, baked in by define), and the server compares it with its own before it hands a notice with a release block over. A shell of another version is told nothing and gets the notice after the reload, from the bundle that can draw it. This holds for every update, not only the one that introduced the parameter.
This commit is contained in:
@@ -7,6 +7,10 @@ import { systemNoticeDtoSchema, type SystemNoticeDto } from '@trek/shared';
|
||||
// SystemNoticeBanner/Modal consumers don't need to change their imports.
|
||||
export type SystemNoticeDTO = SystemNoticeDto;
|
||||
|
||||
// Baked in by `define` in vite.config.js; a build without it (a bare tsc run) sends
|
||||
// nothing and therefore gets no release notice, which is the safe side.
|
||||
const UI_VERSION: string = typeof __TREK_UI_VERSION__ === 'string' ? __TREK_UI_VERSION__ : '';
|
||||
|
||||
interface SystemNoticeState {
|
||||
notices: SystemNoticeDTO[];
|
||||
loaded: boolean;
|
||||
@@ -25,12 +29,14 @@ export const useSystemNoticeStore = create<SystemNoticeState>()((set, get) => ({
|
||||
if (get().fetching || get().loaded) return;
|
||||
set({ fetching: true });
|
||||
try {
|
||||
// Names the layouts this bundle can draw. The server holds the release notice
|
||||
// back from a bundle that does not say so: after an update the service worker
|
||||
// Names the layouts this bundle can draw and the version it was built as. The
|
||||
// server hands the release notice only to a bundle that can draw it AND was
|
||||
// built for the version the server runs: after an update the service worker
|
||||
// serves the previous bundle until the new one is installed, and that bundle
|
||||
// would draw the release notice as bare keys and let the reader dismiss it for
|
||||
// good. It gets the notice after the reload, from this very line.
|
||||
const res = await axios.get('/system-notices/active', { params: { supports: 'release' } });
|
||||
// would draw the release notice as bare keys or with its own older texts, and
|
||||
// let the reader dismiss it for good. It gets the notice after the reload,
|
||||
// from this very line.
|
||||
const res = await axios.get('/system-notices/active', { params: { supports: 'release', ui: UI_VERSION } });
|
||||
const notices = parseInDev(systemNoticeDtoSchema.array(), res.data, 'systemNotices.fetch');
|
||||
set({ notices, loaded: true, fetching: false });
|
||||
} catch (err) {
|
||||
|
||||
Vendored
+3
@@ -1,2 +1,5 @@
|
||||
/// <reference types="vite/client" />
|
||||
/// <reference types="vitest/globals" />
|
||||
|
||||
/** The version this bundle was built as (client/package.json), set by `define` in vite.config.js. */
|
||||
declare const __TREK_UI_VERSION__: string;
|
||||
|
||||
Reference in New Issue
Block a user