Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
37 changes: 28 additions & 9 deletions src/App.vue
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@ import {
DIRECTORY_RESIZER_WIDTH,
} from './composables/useDirectoryColumnResize';
import { useThunderbirdShortcuts } from './composables/useThunderbirdShortcuts';
import { useDowntimeBanner } from './composables/useDowntimeBanner';
import { APP_TITLE } from './app-config';
import { BUG_REPORT_URL, FEEDBACK_URL } from './defines';
import { BUG_REPORT_URL, FEEDBACK_URL, loginMessagesUrl } from './defines';

import { useAuthStore } from './stores/auth-store';
import { useMailStore } from './stores/mail-store';
Expand All @@ -36,6 +37,7 @@ import type { Palette, Theme } from './constants/settings';
import { shortcutAria, shortcutHint } from './constants/shortcuts';

import AppSpaces from './components/AppSpaces.vue';
import DowntimeBanner from './components/DowntimeBanner.vue';
import LoginGate from './components/LoginGate.vue';
import FolderTree from './components/FolderTree.vue';
import MessageColumns from './components/MessageColumns.vue';
Expand Down Expand Up @@ -180,6 +182,8 @@ watch(activeSpotlight, (id) => {
// With 'system' the OS decides, so a manual light/dark button would fight it.
const showThemeToggle = computed(() => theme.value !== 'system');
const messageViewMaximized = ref(false);
// One load serves the login gate and the shell, so the banner stays put when the gate gives way.
const { banner } = useDowntimeBanner(loginMessagesUrl());
// Modal dialogs own the keyboard: a single-letter mail shortcut must not
// archive or delete the selection behind them, or move focus out of them.
// An open beacon card counts as one.
Expand Down Expand Up @@ -656,7 +660,7 @@ function unwatchSystemTheme() {
</script>

<template>
<LoginGate v-if="showLogin" />
<LoginGate v-if="showLogin" :banner="banner" />
<div
v-else
ref="shellEl"
Expand All @@ -672,6 +676,9 @@ function unwatchSystemTheme() {
}"
:style="shellStyle"
>
<div class="shell__banner" :inert="messageViewMaximized" :aria-hidden="messageViewMaximized">
<DowntimeBanner :banner="banner" />
</div>
<header class="quick-filter" :inert="messageViewMaximized" :aria-hidden="messageViewMaximized">
<div class="quick-filter__brand">
<span class="quick-filter__glyph" aria-hidden="true" v-html="mailGlyph" />
Expand Down Expand Up @@ -938,7 +945,7 @@ html.light,
var(--folder-resizer-width)
minmax(var(--message-list-min-width, 280px), var(--message-columns-width, 360px))
minmax(var(--message-view-min-width, 320px), 1fr);
grid-template-rows: auto minmax(0, 1fr);
grid-template-rows: auto auto minmax(0, 1fr);
height: var(--app-viewport-height);
background: var(--panel);
color: var(--text);
Expand Down Expand Up @@ -1016,6 +1023,7 @@ body.spotlighting .folder-subs {
height: var(--app-viewport-height);
}
.shell--message-view-maximized > :is(
.shell__banner,
.quick-filter,
.app-spaces,
.sidebar-slot,
Expand All @@ -1029,6 +1037,15 @@ body.spotlighting .folder-subs {
}
.shell > .contacts { grid-column: 4 / -1; }

/* Always rendered so the first row stays the banner's, at zero height when there is none. */
.shell__banner {
grid-column: 1 / -1;
background: var(--top-nav-bg);
}
.shell__banner .downtime-banner {
margin: 8px 8px 0;
}

.quick-filter {
grid-column: 1 / -1;
position: relative;
Expand Down Expand Up @@ -1264,19 +1281,21 @@ body.spotlighting .folder-subs {
.shell--message-view-hidden,
.shell--message-list-hidden {
grid-template-columns: minmax(0, 1fr);
grid-template-rows: auto minmax(0, 1fr) var(--spaces-bar-height);
grid-template-rows: auto auto minmax(0, 1fr) var(--spaces-bar-height);
}
.quick-filter {
grid-column: 1;
grid-row: 1;
grid-row: 2;
}
.shell > .app-spaces {
grid-column: 1;
grid-row: 3;
grid-row: 4;
}
/* The content row is the drawer's containing block, so it opens below the header and banner. */
.shell .sidebar-slot {
top: var(--top-nav-height);
bottom: var(--spaces-bar-height);
grid-row: 3 / 4;
top: 0;
bottom: 0;
left: 0;
width: min(var(--folder-list-width, 240px), 100vw);
max-width: 100vw;
Expand All @@ -1290,7 +1309,7 @@ body.spotlighting .folder-subs {
.shell--message-view-hidden > .msg-columns,
.shell--message-list-hidden > .message-view {
grid-column: 1;
grid-row: 2;
grid-row: 3;
}
}

Expand Down
25 changes: 25 additions & 0 deletions src/components/DowntimeBanner.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<script setup lang="ts">
import { NoticeBar, NoticeBarTypes } from '@thunderbirdops/services-ui';
import type { Banner } from '../composables/useDowntimeBanner';

defineProps<{ banner: Banner | null }>();

const NOTICE_BAR_TYPES: Record<Banner['type'], NoticeBarTypes> = {
info: NoticeBarTypes.Info,
warning: NoticeBarTypes.Warning,
critical: NoticeBarTypes.Critical,
};
</script>

<template>
<NoticeBar v-if="banner" :type="NOTICE_BAR_TYPES[banner.type]" role="status" class="downtime-banner">
{{ banner.message }}
</NoticeBar>
</template>

<style scoped>
.downtime-banner {
/* A pasted status URL must wrap instead of widening its container past a phone screen. */
overflow-wrap: anywhere;
}
</style>
6 changes: 6 additions & 0 deletions src/components/LoginGate.vue
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,16 @@ import { useOnline } from '@vueuse/core';
import { Loader2 } from '@lucide/vue';
import { NoticeWarningIcon } from '@thunderbirdops/services-ui';
import AppButton from './AppButton.vue';
import DowntimeBanner from './DowntimeBanner.vue';

import { useAuthStore } from '../stores/auth-store';
import { AUTH_STATE } from '../constants/states';
import type { Banner } from '../composables/useDowntimeBanner';
import { hasAutoLoginFlag, withoutAutoLoginFlag } from '../utils/staff-redirect';
import ThundermailLogo from './ThundermailLogo.vue';

defineProps<{ banner: Banner | null }>();

const authStore = useAuthStore();
const username = ref('');
const password = ref('');
Expand Down Expand Up @@ -50,6 +54,7 @@ onBeforeUnmount(() => window.removeEventListener('pageshow', onPageShow));
<template>
<div class="login-gate">
<div v-if="authStore.appPasswordMode && !authStore.databaseUnavailable" class="login-stack">
<DowntimeBanner :banner="banner" />
<p class="login-warning" role="note">
<NoticeWarningIcon class="login-warning__icon" aria-hidden="true" />
<span>Webmail is in early alpha and subject to frequent changes and instability</span>
Expand Down Expand Up @@ -93,6 +98,7 @@ onBeforeUnmount(() => window.removeEventListener('pageshow', onPageShow));
</div>
</div>
<div v-else class="login-progress">
<DowntimeBanner :banner="banner" />
<div class="login-card__busy" role="status" aria-live="polite">
<Loader2 v-if="!isFailed" :size="32" :stroke-width="2" class="login-card__spinner" aria-hidden="true" />
<p class="login-card__status">{{ statusLabel }}</p>
Expand Down
40 changes: 40 additions & 0 deletions src/composables/useDowntimeBanner.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
// Reads the loginBanner realm message that the Keycloak login page shows (thunderbird-accounts#1491); the app never waits on it.
import { onMounted, ref, type Ref } from 'vue';

const BANNER_TYPES = ['info', 'warning', 'critical'] as const;
type BannerType = (typeof BANNER_TYPES)[number];

export interface Banner {
type: BannerType;
message: string;
}

function parseBanner(messages: unknown): Banner | null {
if (!Array.isArray(messages)) throw new Error('not a message list');
const text = (key: string): string => {
const value: unknown = messages.find((entry) => entry?.key === key)?.value;
return typeof value === 'string' ? value.trim() : '';
};
// The endpoint returns the MessageFormat pattern, where operators type '' for an apostrophe.
const message = text('loginBanner').replaceAll("''", "'");
if (!message) return null;
const type = BANNER_TYPES.find((name) => name === text('loginBannerType')) ?? 'warning';
return { type, message };
}

export function useDowntimeBanner(url: string): { banner: Ref<Banner | null> } {
const banner = ref<Banner | null>(null);

onMounted(async () => {
if (!url) return;
try {
const response = await fetch(url, { signal: AbortSignal.timeout(2000), cache: 'no-store', credentials: 'omit' });
if (!response.ok) throw new Error(`HTTP ${response.status}`);
banner.value = parseBanner(await response.json());
} catch (error) {
console.warn('[banner] Not showing the downtime banner:', error instanceof Error ? error.message : error);
}
});

return { banner };
}
6 changes: 6 additions & 0 deletions src/defines.ts
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,12 @@ export const STAFF_APP_URL =
export const OIDC_ISSUER =
import.meta.env.VITE_OIDC_ISSUER || "https://auth.stage-thundermail.com/realms/tbpro";

/** Keycloak serves the realm's login theme messages, realm overrides included, beside the issuer. */
export function loginMessagesUrl(locale = "en"): string {
const match = /^(.*)\/realms\/([^/]+)\/?$/.exec(OIDC_ISSUER);
return match ? `${match[1]}/resources/${match[2]}/login/${locale}` : "";
}

export const OIDC_CLIENT_ID =
import.meta.env.VITE_OIDC_CLIENT_ID || "thunderbird-stormbox-test";

Expand Down
6 changes: 5 additions & 1 deletion tests/unit/components/app-layout.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ vi.mock('../../../src/services/auth', () => ({
initOidc: async () => null,
getOidc: () => null,
}));
vi.mock('../../../src/composables/useDowntimeBanner', async () => {
const { ref } = await import('vue');
return { useDowntimeBanner: () => ({ banner: ref(null) }) };
});

import App from '../../../src/App.vue';
import AppSpaces from '../../../src/components/AppSpaces.vue';
Expand Down Expand Up @@ -1081,7 +1085,7 @@ describe('App mail layout', () => {
await flushPromises();

expect(wrapper.find('.quick-filter').exists()).toBe(true);
expect(wrapper.find('.quick-filter').element).toBe(wrapper.find('.shell').element.firstElementChild);
expect(wrapper.find('.quick-filter').element).toBe(wrapper.find('.shell__banner').element.nextElementSibling);

await wrapper.get('.quick-filter__input').setValue('alice');
await nextTick();
Expand Down
10 changes: 8 additions & 2 deletions tests/unit/components/login-gate.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,12 @@ import LoginGate from '../../../src/components/LoginGate.vue';
import { useAuthStore } from '../../../src/stores/auth-store';
import { AUTH_STATE } from '../../../src/constants/states';
import { DatabaseUnavailableError } from '../../../src/db/availability';
import type { Banner } from '../../../src/composables/useDowntimeBanner';

const mounted: Array<ReturnType<typeof mount>> = [];

function mountGate() {
const wrapper = mount(LoginGate, { attachTo: document.body });
function mountGate(banner: Banner | null = null) {
const wrapper = mount(LoginGate, { attachTo: document.body, props: { banner } });
mounted.push(wrapper);
return wrapper;
}
Expand Down Expand Up @@ -109,6 +110,11 @@ describe('LoginGate', () => {
.toBe('/inbox?view=compact#message');
});

it('shows the downtime banner', () => {
const wrapper = mountGate({ type: 'warning', message: 'Scheduled maintenance 14:00–16:00 UTC.' });
expect(wrapper.get('.downtime-banner').text()).toContain('Scheduled maintenance 14:00–16:00 UTC.');
});

it('leaves a canceled OIDC redirect retryable when restored from the back-forward cache', () => {
const store = useAuthStore();
const cancel = vi.spyOn(store, 'cancelOidcLogin');
Expand Down
4 changes: 4 additions & 0 deletions tests/unit/components/settings-dialog.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ vi.mock('../../../src/services/auth', () => ({
initOidc: async () => null,
getOidc: () => null,
}));
vi.mock('../../../src/composables/useDowntimeBanner', async () => {
const { ref } = await import('vue');
return { useDowntimeBanner: () => ({ banner: ref(null) }) };
});

import App from '../../../src/App.vue';
import { BEACON_IDS, LATEST_BEACON_SEQ } from '../../../src/constants/feature-beacons';
Expand Down
4 changes: 4 additions & 0 deletions tests/unit/components/staff-settings-lazy.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ vi.mock('../../../src/services/auth', () => ({
initOidc: async () => null,
getOidc: () => null,
}));
vi.mock('../../../src/composables/useDowntimeBanner', async () => {
const { ref } = await import('vue');
return { useDowntimeBanner: () => ({ banner: ref(null) }) };
});

// Records whether the staff section chunk was ever evaluated.
const staffModules = vi.hoisted(() => ({ section: false }));
Expand Down
4 changes: 4 additions & 0 deletions tests/unit/components/tag-manager-dialog.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ vi.mock('../../../src/services/auth', () => ({
initOidc: async () => null,
getOidc: () => null,
}));
vi.mock('../../../src/composables/useDowntimeBanner', async () => {
const { ref } = await import('vue');
return { useDowntimeBanner: () => ({ banner: ref(null) }) };
});

import App from '../../../src/App.vue';
import { requestTagManager } from '../../../src/composables/useTagManagerRequest';
Expand Down
67 changes: 67 additions & 0 deletions tests/unit/composables/useDowntimeBanner.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
// @vitest-environment happy-dom

import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { flushPromises, mount } from '@vue/test-utils';
import { defineComponent, h } from 'vue';

import { useDowntimeBanner } from '../../../src/composables/useDowntimeBanner';

const MESSAGES_URL = 'https://auth.example.org/resources/tbpro/login/en';
const MESSAGE = 'Scheduled maintenance 14:00–16:00 UTC.';

const fetchMock = vi.fn();
let warn: ReturnType<typeof vi.spyOn>;

function respond(messages: Record<string, string>, status = 200) {
const body = Object.entries(messages).map(([key, value]) => ({ key, value }));
fetchMock.mockResolvedValue(new Response(JSON.stringify(body), { status }));
}

async function loadBanner() {
let result!: ReturnType<typeof useDowntimeBanner>;
mount(defineComponent({
setup() {
result = useDowntimeBanner(MESSAGES_URL);
return () => h('div');
},
}));
await flushPromises();
return result.banner.value;
}

beforeEach(() => {
vi.stubGlobal('fetch', fetchMock);
warn = vi.spyOn(console, 'warn').mockImplementation(() => {});
});

afterEach(() => {
fetchMock.mockReset();
vi.unstubAllGlobals();
vi.restoreAllMocks();
});

describe('useDowntimeBanner', () => {
it('returns the loginBanner message with its type', async () => {
respond({ doLogIn: 'Sign in', loginBanner: ` We''re down. ${MESSAGE} `, loginBannerType: 'critical' });
expect(await loadBanner()).toEqual({ type: 'critical', message: `We're down. ${MESSAGE}` });
});

it('shows nothing and stays silent when loginBanner is empty or missing', async () => {
respond({ loginBanner: ' ', loginBannerType: 'warning' });
expect(await loadBanner()).toBeNull();
respond({ doLogIn: 'Sign in' });
expect(await loadBanner()).toBeNull();
expect(warn).not.toHaveBeenCalled();
});

it('shows nothing and warns once when the endpoint fails', async () => {
respond({ loginBanner: MESSAGE }, 500);
expect(await loadBanner()).toBeNull();
expect(warn).toHaveBeenCalledOnce();
});

it('falls back to a warning for an unknown loginBannerType', async () => {
respond({ loginBanner: MESSAGE, loginBannerType: 'urgent' });
expect(await loadBanner()).toEqual({ type: 'warning', message: MESSAGE });
});
});
Loading