Skip to content

A free and open source instant messaging and VoIP chat app built for friends, groups, and communities.

TypeScript fluxerfluxerapp

feat(app): show instance notices and snooze the unclaimed banner

Hampus27fc51d9444e
diff --git a/fluxer_app/src/features/app/components/layout/app_layout/AppLayoutHooks.ts b/fluxer_app/src/features/app/components/layout/app_layout/AppLayoutHooks.ts
index d3f7bdda3..9ad2998b3 100644
--- a/fluxer_app/src/features/app/components/layout/app_layout/AppLayoutHooks.ts
+++ b/fluxer_app/src/features/app/components/layout/app_layout/AppLayoutHooks.ts
@@ -6,6 +6,10 @@ import {
type NagbarState,
NagbarType,
} from '@app/features/app/components/layout/app_layout/AppLayoutTypes';
+import {
+ useInstanceNoticeRefresh,
+ useVisibleInstanceNotice,
+} from '@app/features/app/components/layout/app_layout/nagbars/InstanceNoticeState';
import {isScheduledMaintenanceNagbarDismissed} from '@app/features/app/components/layout/app_layout/ScheduledMaintenanceDismissal';
import Config from '@app/features/app/config/Config';
import DomainMovedNotice from '@app/features/app/domain_migration/DomainMovedNotice';
@@ -19,6 +23,7 @@ import DeveloperOptions from '@app/features/devtools/state/DeveloperOptions';
import GatewaySessions from '@app/features/gateway/transport/GatewaySessionPool';
import * as NotificationUtils from '@app/features/notification/utils/NotificationUtils';
import {resolvePriceAnnouncementCampaign} from '@app/features/premium/config/PriceAnnouncementCampaign';
+import {resolvePurchaseAccountState} from '@app/features/premium/hooks/usePurchaseAccountGate';
import PremiumState from '@app/features/premium/state/PremiumState';
import {getPremiumGraceEndDate} from '@app/features/premium/utils/PremiumGrace';
import {
@@ -29,10 +34,12 @@ import {
import StreamerMode from '@app/features/streamer_mode/state/StreamerMode';
import WindowsFont, {WINDOWS_FONT_CHANGED_AT_MS} from '@app/features/theme/state/WindowsFont';
import Nagbar from '@app/features/ui/state/Nagbar';
+import {isUnclaimedNagbarSnoozed} from '@app/features/ui/state/UnclaimedNagbarSnooze';
import {hasUnavailableElectronNativeContext, isDesktop, isNativeWindows} from '@app/features/ui/utils/NativeUtils';
import {isStandalonePwa} from '@app/features/ui/utils/PwaUtils';
import StatusPage from '@app/features/user/state/StatusPage';
import Users from '@app/features/user/state/Users';
+import {needsEmailConfirmation} from '@app/features/user/utils/AccountGates';
import MediaEngine, {useVoiceEngineV2Model} from '@app/features/voice/engine/MediaEngineFacade';
import {selectVoiceEngineV2AppConnectionWithFallback} from '@app/features/voice/engine/v2/VoiceEngineV2AppSelectors';
import CallState from '@app/features/voice/state/CallState';
@@ -111,7 +118,7 @@ export const useNagbarConditions = (): NagbarConditions => {
sessionId: voiceConnectionContext.connectionId,
});
const shouldShowDesktopNotification = (() => {
- if (!NotificationUtils.hasNotification()) return false;
+ if (isDesktop() || !NotificationUtils.hasNotification()) return false;
if (typeof Notification !== 'undefined') {
if (Notification.permission === 'granted') return false;
if (Notification.permission === 'denied') return false;
@@ -160,7 +167,7 @@ export const useNagbarConditions = (): NagbarConditions => {
})();
const premiumState = PremiumState.loadedForUserId === user?.id ? PremiumState.state : null;
const priceAnnouncementCampaign = resolvePriceAnnouncementCampaign(premiumState);
- const hasPurchaseReadyAccount = Boolean(user?.isClaimed() && (!RuntimeConfig.emailsEnabled || user.verified));
+ const hasPurchaseReadyAccount = resolvePurchaseAccountState(user).kind === 'ready';
const canShowPriceAnnouncement = (() => {
if (isSelfHosted) return false;
if (!hasPurchaseReadyAccount) return false;
@@ -201,8 +208,11 @@ export const useNagbarConditions = (): NagbarConditions => {
if (nagbarState.forceGuildMembershipCta) return true;
if (!user) return false;
if (isSelfHosted) return false;
+ if (user.accountTier !== 'verified') return false;
return !nagbarState.guildMembershipCtaDismissed;
})();
+ useInstanceNoticeRefresh();
+ const canShowInstanceNotice = useVisibleInstanceNotice() !== null;
void nagbarState.scheduledMaintenanceDismissalVersion;
const canShowScheduledMaintenance = (() => {
if (nagbarState.forceHideScheduledMaintenance) return false;
@@ -265,19 +275,25 @@ export const useNagbarConditions = (): NagbarConditions => {
user.createdAt.getTime() < WINDOWS_FONT_CHANGED_AT_MS &&
!WindowsFont.useFluxerSans &&
!WindowsFont.nagbarDismissed;
- const canShowDomainMoved = nagbarState.forceHideDomainMoved
- ? false
- : nagbarState.forceDomainMoved
- ? true
- : DomainMovedNotice.shouldShow(Date.now());
+ let canShowDomainMoved: boolean;
+ if (nagbarState.forceHideDomainMoved) {
+ canShowDomainMoved = false;
+ } else if (nagbarState.forceDomainMoved) {
+ canShowDomainMoved = true;
+ } else {
+ canShowDomainMoved = DomainMovedNotice.shouldShow(Date.now());
+ }
const canShowBuildEnvironment =
!BUILD_ENVIRONMENT_HIDDEN_RELEASE_CHANNELS.has(Config.PUBLIC_RELEASE_CHANNEL) &&
!nagbarState.buildEnvironmentDismissedThisSession;
- const canShowConnection = nagbarState.forceHideConnectionNotice
- ? false
- : nagbarState.forceConnectionNotice
- ? true
- : isClientReconnecting();
+ let canShowConnection: boolean;
+ if (nagbarState.forceHideConnectionNotice) {
+ canShowConnection = false;
+ } else if (nagbarState.forceConnectionNotice) {
+ canShowConnection = true;
+ } else {
+ canShowConnection = isClientReconnecting();
+ }
const needsTermsAcceptance = (() => {
if (!user) return false;
if (isSelfHosted) return false;
@@ -292,35 +308,62 @@ export const useNagbarConditions = (): NagbarConditions => {
(!user.privacyAgreedAt || user.privacyAgreedAt.toISOString() < PRIVACY_POLICY_LAST_UPDATED);
return termsOutdated || privacyOutdated;
})();
+ let canShowCorruptedInstallation: boolean;
+ if (nagbarState.forceHideCorruptedInstallation) {
+ canShowCorruptedInstallation = false;
+ } else if (nagbarState.forceCorruptedInstallation) {
+ canShowCorruptedInstallation = true;
+ } else {
+ canShowCorruptedInstallation = hasBrokenElectronNativeContext;
+ }
+ let userIsUnclaimed: boolean;
+ if (nagbarState.forceHideUnclaimedAccount) {
+ userIsUnclaimed = false;
+ } else if (nagbarState.forceUnclaimedAccount) {
+ userIsUnclaimed = true;
+ } else {
+ userIsUnclaimed = Boolean(
+ !Accounts.isSwitching &&
+ user &&
+ !user.isClaimed() &&
+ !nagbarState.unclaimedAccountDismissedThisSession &&
+ !isUnclaimedNagbarSnoozed(user.id),
+ );
+ }
+ let userNeedsVerification: boolean;
+ if (nagbarState.forceHideEmailVerification) {
+ userNeedsVerification = false;
+ } else if (nagbarState.forceEmailVerification) {
+ userNeedsVerification = true;
+ } else {
+ userNeedsVerification = needsEmailConfirmation(user);
+ }
+ let canShowAccountLimited: boolean;
+ if (nagbarState.forceHideAccountLimited) {
+ canShowAccountLimited = false;
+ } else if (nagbarState.forceAccountLimited) {
+ canShowAccountLimited = true;
+ } else {
+ canShowAccountLimited = user?.accountLimited === true;
+ }
+ let canShowDesktopNotification: boolean;
+ if (nagbarState.forceHideDesktopNotification) {
+ canShowDesktopNotification = false;
+ } else if (nagbarState.forceDesktopNotification) {
+ canShowDesktopNotification = true;
+ } else {
+ canShowDesktopNotification = shouldShowDesktopNotification && !nagbarState.desktopNotificationDismissed;
+ }
return {
canShowBuildEnvironment,
canShowConnection,
- canShowCorruptedInstallation: nagbarState.forceHideCorruptedInstallation
- ? false
- : nagbarState.forceCorruptedInstallation
- ? true
- : hasBrokenElectronNativeContext,
+ canShowCorruptedInstallation,
canShowScheduledMaintenance,
- userIsUnclaimed: nagbarState.forceHideUnclaimedAccount
- ? false
- : nagbarState.forceUnclaimedAccount
- ? true
- : Boolean(!Accounts.isSwitching && user && !user.isClaimed()),
- userNeedsVerification: nagbarState.forceHideEmailVerification
- ? false
- : nagbarState.forceEmailVerification
- ? true
- : Boolean(RuntimeConfig.emailsEnabled && user?.isClaimed() && !user.verified),
- canShowAccountLimited: nagbarState.forceHideAccountLimited
- ? false
- : nagbarState.forceAccountLimited
- ? true
- : user?.accountLimited === true,
- canShowDesktopNotification: nagbarState.forceHideDesktopNotification
- ? false
- : nagbarState.forceDesktopNotification
- ? true
- : shouldShowDesktopNotification && !nagbarState.desktopNotificationDismissed,
+ canShowInstanceNotice,
+ userIsUnclaimed,
+ userNeedsVerification,
+ canShowAccountLimited,
+ canShowDesktopNotification,
canShowPremiumGracePeriod,
canShowPremiumExpired,
canShowPremiumOnboarding,
@@ -371,11 +414,17 @@ export const useActiveNagbars = (conditions: NagbarConditions): Array<NagbarStat
visible: conditions.canShowScheduledMaintenance,
dismissible: true,
},
+ {
+ type: NagbarType.INSTANCE_NOTICE,
+ priority: -1.5,
+ visible: conditions.canShowInstanceNotice,
+ dismissible: true,
+ },
{
type: NagbarType.UNCLAIMED_ACCOUNT,
priority: -4,
visible: conditions.userIsUnclaimed,
- dismissible: false,
+ dismissible: true,
},
{
type: NagbarType.EMAIL_VERIFICATION,
diff --git a/fluxer_app/src/features/app/components/layout/app_layout/AppLayoutTypes.ts b/fluxer_app/src/features/app/components/layout/app_layout/AppLayoutTypes.ts
index ec33f8a38..bdabd0de4 100644
--- a/fluxer_app/src/features/app/components/layout/app_layout/AppLayoutTypes.ts
+++ b/fluxer_app/src/features/app/components/layout/app_layout/AppLayoutTypes.ts
@@ -7,6 +7,7 @@ export const NagbarType = {
CONNECTION: 'connection',
CORRUPTED_INSTALLATION: 'corrupted-installation',
SCHEDULED_MAINTENANCE: 'scheduled-maintenance',
+ INSTANCE_NOTICE: 'instance-notice',
UNCLAIMED_ACCOUNT: 'unclaimed-account',
EMAIL_VERIFICATION: 'email-verification',
ACCOUNT_LIMITED: 'account-limited',
@@ -46,6 +47,7 @@ export interface NagbarConditions {
canShowConnection: boolean;
canShowCorruptedInstallation: boolean;
canShowScheduledMaintenance: boolean;
+ canShowInstanceNotice: boolean;
userIsUnclaimed: boolean;
userNeedsVerification: boolean;
canShowAccountLimited: boolean;
diff --git a/fluxer_app/src/features/app/components/layout/app_layout/NagbarContainer.tsx b/fluxer_app/src/features/app/components/layout/app_layout/NagbarContainer.tsx
index d295670f5..b3ea00af3 100644
--- a/fluxer_app/src/features/app/components/layout/app_layout/NagbarContainer.tsx
+++ b/fluxer_app/src/features/app/components/layout/app_layout/NagbarContainer.tsx
@@ -12,6 +12,7 @@ import {DomainMovedNagbar} from '@app/features/app/components/layout/app_layout/
import {EmailVerificationNagbar} from '@app/features/app/components/layout/app_layout/nagbars/EmailVerificationNagbar';
import {GiftInventoryNagbar} from '@app/features/app/components/layout/app_layout/nagbars/GiftInventoryNagbar';
import {GuildMembershipCtaNagbar} from '@app/features/app/components/layout/app_layout/nagbars/GuildMembershipCtaNagbar';
+import {InstanceNoticeNagbar} from '@app/features/app/components/layout/app_layout/nagbars/InstanceNoticeNagbar';
import {LegacyPriceOptInNagbar} from '@app/features/app/components/layout/app_layout/nagbars/LegacyPriceOptInNagbar';
import {PremiumOnboardingNagbar} from '@app/features/app/components/layout/app_layout/nagbars/PremiumOnboardingNagbar';
import {PremiumStatusNagbar} from '@app/features/app/components/layout/app_layout/nagbars/PremiumStatusNagbar';
@@ -88,6 +89,14 @@ export const NagbarContainer: React.FC<NagbarContainerProps> = observer(({nagbar
data-flx="app.app-layout.nagbar-container.scheduled-maintenance-nagbar"
/>
);
+ case NagbarType.INSTANCE_NOTICE:
+ return (
+ <InstanceNoticeNagbar
+ key={nagbar.type}
+ isMobile={mobileLayout.enabled}
+ data-flx="app.app-layout.nagbar-container.instance-notice-nagbar"
+ />
+ );
case NagbarType.UNCLAIMED_ACCOUNT:
return (
<UnclaimedAccountNagbar
diff --git a/fluxer_app/src/features/app/components/layout/app_layout/nagbars/InstanceNoticeNagbar.tsx b/fluxer_app/src/features/app/components/layout/app_layout/nagbars/InstanceNoticeNagbar.tsx
new file mode 100644
index 000000000..6a5237bf4
--- /dev/null
+++ b/fluxer_app/src/features/app/components/layout/app_layout/nagbars/InstanceNoticeNagbar.tsx
@@ -0,0 +1,59 @@
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+import {
+ instanceNoticeDismissals,
+ useVisibleInstanceNotice,
+} from '@app/features/app/components/layout/app_layout/nagbars/InstanceNoticeState';
+import {Nagbar} from '@app/features/app/components/layout/Nagbar';
+import {NagbarButton} from '@app/features/app/components/layout/NagbarButton';
+import {NagbarContent} from '@app/features/app/components/layout/NagbarContent';
+import {NAGBAR_TONES, NagbarToneKind} from '@app/features/app/components/layout/NagbarTones';
+import {openExternalUrlWithWarning} from '@app/features/messaging/utils/ExternalLinkUtils';
+import {msg} from '@lingui/core/macro';
+import {useLingui} from '@lingui/react/macro';
+import {observer} from 'mobx-react-lite';
+
+const LEARN_MORE_DESCRIPTOR = msg({
+ message: 'Learn more',
+ comment:
+ 'Button on the banner with a notice from the instance administrator. Opens the link the administrator added.',
+});
+
+export const InstanceNoticeNagbar = observer(({isMobile}: {isMobile: boolean}) => {
+ const {i18n} = useLingui();
+ const notice = useVisibleInstanceNotice();
+ if (!notice) {
+ return null;
+ }
+ const tone = NAGBAR_TONES[NagbarToneKind.MAINTENANCE];
+ const handleDismiss = () => instanceNoticeDismissals.dismiss(notice.id);
+ const url = notice.url;
+ return (
+ <Nagbar
+ isMobile={isMobile}
+ backgroundColor={tone.backgroundColor}
+ textColor={tone.textColor}
+ dismissible
+ onDismiss={handleDismiss}
+ data-flx="app.app-layout.nagbars.instance-notice-nagbar.nagbar"
+ >
+ <NagbarContent
+ isMobile={isMobile}
+ onDismiss={handleDismiss}
+ message={notice.message}
+ actions={
+ url ? (
+ <NagbarButton
+ isMobile={isMobile}
+ onClick={() => openExternalUrlWithWarning(url)}
+ data-flx="app.app-layout.nagbars.instance-notice-nagbar.nagbar-button.open-link"
+ >
+ {i18n._(LEARN_MORE_DESCRIPTOR)}
+ </NagbarButton>
+ ) : undefined
+ }
+ data-flx="app.app-layout.nagbars.instance-notice-nagbar.nagbar-content"
+ />
+ </Nagbar>
+ );
+});
diff --git a/fluxer_app/src/features/app/components/layout/app_layout/nagbars/InstanceNoticeSchedule.ts b/fluxer_app/src/features/app/components/layout/app_layout/nagbars/InstanceNoticeSchedule.ts
new file mode 100644
index 000000000..9066e222f
--- /dev/null
+++ b/fluxer_app/src/features/app/components/layout/app_layout/nagbars/InstanceNoticeSchedule.ts
@@ -0,0 +1,22 @@
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+import type {InstanceNotice} from '@fluxer/schema/src/domains/instance/InstanceSchemas';
+
+function timeOf(value: string | null): number | null {
+ if (value === null) return null;
+ const parsed = Date.parse(value);
+ return Number.isFinite(parsed) ? parsed : null;
+}
+
+export function isInstanceNoticeLive(notice: InstanceNotice, nowMs: number): boolean {
+ const startsAt = timeOf(notice.starts_at);
+ const endsAt = timeOf(notice.ends_at);
+ return (startsAt === null || startsAt <= nowMs) && (endsAt === null || nowMs < endsAt);
+}
+
+export function nextInstanceNoticeChangeAt(notice: InstanceNotice, nowMs: number): number | null {
+ const upcoming = [timeOf(notice.starts_at), timeOf(notice.ends_at)].filter(
+ (time): time is number => time !== null && time > nowMs,
+ );
+ return upcoming.length === 0 ? null : Math.min(...upcoming);
+}
diff --git a/fluxer_app/src/features/app/components/layout/app_layout/nagbars/InstanceNoticeState.ts b/fluxer_app/src/features/app/components/layout/app_layout/nagbars/InstanceNoticeState.ts
new file mode 100644
index 000000000..d05fd8d8c
--- /dev/null
+++ b/fluxer_app/src/features/app/components/layout/app_layout/nagbars/InstanceNoticeState.ts
@@ -0,0 +1,82 @@
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+import {
+ isInstanceNoticeLive,
+ nextInstanceNoticeChangeAt,
+} from '@app/features/app/components/layout/app_layout/nagbars/InstanceNoticeSchedule';
+import RuntimeConfig from '@app/features/app/state/RuntimeConfig';
+import AppStorage from '@app/features/platform/state/PersistentStorage';
+import {Logger} from '@app/features/platform/utils/AppLogger';
+import type {InstanceNotice} from '@fluxer/schema/src/domains/instance/InstanceSchemas';
+import {makeAutoObservable} from 'mobx';
+import {useEffect, useState} from 'react';
+
+const DISMISS_KEY_PREFIX = 'fluxer_instance_notice_dismissed:';
+const LONGEST_TIMER_MS = 24 * 60 * 60 * 1000;
+const NOTICE_REFRESH_INTERVAL_MS = 5 * 60 * 1000;
+
+const logger = new Logger('InstanceNotice');
+let lastNoticeRefreshAt = Date.now();
+
+function refreshInstanceNoticeIfStale(now: number = Date.now()): void {
+ if (now - lastNoticeRefreshAt < NOTICE_REFRESH_INTERVAL_MS) return;
+ if (document.visibilityState !== 'visible') return;
+ if (RuntimeConfig.getSnapshotOrNull()?.features.self_hosted !== true) return;
+ lastNoticeRefreshAt = now;
+ RuntimeConfig.revalidateDiscovery().catch((error: unknown) => {
+ logger.warn('Instance notice refresh failed', error);
+ });
+}
+
+export function useInstanceNoticeRefresh(): void {
+ useEffect(() => {
+ const refresh = () => refreshInstanceNoticeIfStale();
+ document.addEventListener('visibilitychange', refresh);
+ window.addEventListener('focus', refresh);
+ const timer = window.setInterval(refresh, NOTICE_REFRESH_INTERVAL_MS);
+ return () => {
+ document.removeEventListener('visibilitychange', refresh);
+ window.removeEventListener('focus', refresh);
+ window.clearInterval(timer);
+ };
+ }, []);
+}
+
+class InstanceNoticeDismissals {
+ version = 0;
+
+ constructor() {
+ makeAutoObservable(this);
+ }
+
+ isDismissed(id: string): boolean {
+ void this.version;
+ return AppStorage.getItem(`${DISMISS_KEY_PREFIX}${id}`) === '1';
+ }
+
+ dismiss(id: string): void {
+ AppStorage.setItem(`${DISMISS_KEY_PREFIX}${id}`, '1');
+ this.version += 1;
+ }
+}
+
+export const instanceNoticeDismissals = new InstanceNoticeDismissals();
+
+export function useVisibleInstanceNotice(): InstanceNotice | null {
+ const notice = RuntimeConfig.instanceNotice;
+ const [tick, setTick] = useState(0);
+ useEffect(() => {
+ if (!notice) return;
+ const nextChangeAt = nextInstanceNoticeChangeAt(notice, Date.now());
+ if (nextChangeAt === null) return;
+ const timer = window.setTimeout(
+ () => setTick((value) => value + 1),
+ Math.min(nextChangeAt - Date.now(), LONGEST_TIMER_MS),
+ );
+ return () => window.clearTimeout(timer);
+ }, [notice, tick]);
+ if (!notice || !isInstanceNoticeLive(notice, Date.now()) || instanceNoticeDismissals.isDismissed(notice.id)) {
+ return null;
+ }
+ return notice;
+}