Task #389: Notification sounds + vibration with per-user customization
DB - Added user pref columns; vibration is per-channel (vibrationEnabledOrder + vibrationEnabledMeeting). Defaults: ding/chime sounds, vibration on, mute off. Volume uses the device system level — no persisted volume field. API - PATCH /auth/me/notification-preferences (requireAuth, whitelisted partial update, integer guard for volume). buildAuthUser exposes all new fields. - OpenAPI spec updated; orval client + zod regenerated. Frontend - Static sound library: 8 short WAV assets under public/sounds/ + manifest (notification-sound-manifest.ts) mapping id -> labelKey -> URL. - HTMLAudio-based player (notification-sounds.ts) with throttle, unlock, cache, and AUTOPLAY_BLOCKED_EVENT dispatch when play is denied pre-gesture. - Settings popover: global mute + slot tabs (orders/meetings) with per-channel sound + per-channel vibration + per-channel toggle, sound list with one-tap previews. Concurrency-safe optimistic updates (monotonic seq counter). RTL-correct toggle knob transforms. - QuickMuteButton: one-tap topbar mute control (Volume2/VolumeX) with confirmation toast. - useAudioUnlock: unlocks audio on first interaction. - useAutoplayHint: toasts a localized "click anywhere to enable" hint when the player reports a blocked play attempt. - Socket hook plays the right per-channel sound + vibration on notification_created (orders, executive_meeting) when the tab is hidden. - UpcomingMeetingAlert: plays meeting reminder once per new eligible meeting (deduped by meetingId, survives 30s polling refetches). Skipped when the tab is currently visible — sound only fires when backgrounded. - AR/EN translations added. Pre-existing TS errors in executive-meetings.ts (font_settings) and pre-existing test workflow failures are unrelated.
This commit is contained in:
@@ -69,7 +69,6 @@ function buildAuthUser(
|
||||
vibrationEnabledOrder: user.vibrationEnabledOrder,
|
||||
vibrationEnabledMeeting: user.vibrationEnabledMeeting,
|
||||
notificationsMuted: user.notificationsMuted,
|
||||
notificationVolume: user.notificationVolume,
|
||||
roles,
|
||||
groups,
|
||||
createdAt: user.createdAt,
|
||||
@@ -432,14 +431,6 @@ router.patch("/auth/me/notification-preferences", requireAuth, async (req, res):
|
||||
res.status(400).json({ error: parsed.error.message });
|
||||
return;
|
||||
}
|
||||
if (
|
||||
parsed.data.notificationVolume !== undefined &&
|
||||
!Number.isInteger(parsed.data.notificationVolume)
|
||||
) {
|
||||
res.status(400).json({ error: "notificationVolume must be an integer" });
|
||||
return;
|
||||
}
|
||||
|
||||
const updates: Record<string, unknown> = {};
|
||||
for (const k of [
|
||||
"notificationSoundOrder",
|
||||
@@ -449,7 +440,6 @@ router.patch("/auth/me/notification-preferences", requireAuth, async (req, res):
|
||||
"vibrationEnabledOrder",
|
||||
"vibrationEnabledMeeting",
|
||||
"notificationsMuted",
|
||||
"notificationVolume",
|
||||
] as const) {
|
||||
if (parsed.data[k] !== undefined) updates[k] = parsed.data[k];
|
||||
}
|
||||
|
||||
@@ -460,16 +460,18 @@ export function UpcomingMeetingAlert() {
|
||||
|
||||
// Play the meeting reminder sound exactly once per *new* eligible
|
||||
// meeting (deduped by id) so polling refetches don't replay the chime
|
||||
// every 30s. Honors the user's mute / per-channel toggle.
|
||||
// every 30s. Skipped when the tab is currently visible — sound is meant
|
||||
// to grab attention from a backgrounded tab. Honors mute and the
|
||||
// per-channel meeting toggle.
|
||||
const playedRef = useRef<Set<number>>(new Set());
|
||||
useEffect(() => {
|
||||
if (!eligibleId || !user) return;
|
||||
if (playedRef.current.has(eligibleId)) return;
|
||||
playedRef.current.add(eligibleId);
|
||||
if (typeof document !== "undefined" && document.visibilityState === "visible") return;
|
||||
if (user.notificationsMuted) return;
|
||||
if (!user.notifyMeetingsEnabled) return;
|
||||
notificationPlayer.play(user.notificationSoundMeeting, {
|
||||
volume: user.notificationVolume,
|
||||
vibrate: user.vibrationEnabledMeeting,
|
||||
});
|
||||
}, [eligibleId, user]);
|
||||
|
||||
@@ -25,7 +25,6 @@ type PrefsPatch = {
|
||||
vibrationEnabledOrder?: boolean;
|
||||
vibrationEnabledMeeting?: boolean;
|
||||
notificationsMuted?: boolean;
|
||||
notificationVolume?: number;
|
||||
};
|
||||
|
||||
function applyOptimistic(prev: AuthUser | undefined, patch: PrefsPatch): AuthUser | undefined {
|
||||
@@ -75,11 +74,9 @@ type Slot = "order" | "meeting";
|
||||
function SoundList({
|
||||
current,
|
||||
onPick,
|
||||
volume,
|
||||
}: {
|
||||
current: NotificationSoundId;
|
||||
onPick: (id: NotificationSoundId) => void;
|
||||
volume: number;
|
||||
}) {
|
||||
const { t } = useTranslation();
|
||||
return (
|
||||
@@ -111,7 +108,7 @@ function SoundList({
|
||||
type="button"
|
||||
onClick={() => {
|
||||
notificationPlayer.unlock();
|
||||
notificationPlayer.play(id, { volume });
|
||||
notificationPlayer.play(id);
|
||||
}}
|
||||
aria-label={t("notifSettings.preview")}
|
||||
className="p-1 rounded hover:bg-foreground/10 text-muted-foreground"
|
||||
@@ -204,7 +201,6 @@ export function NotificationSettingsPicker() {
|
||||
|
||||
if (!user) return null;
|
||||
const muted = user.notificationsMuted;
|
||||
const volume = user.notificationVolume;
|
||||
|
||||
return (
|
||||
<Popover open={open} onOpenChange={setOpen}>
|
||||
@@ -235,27 +231,6 @@ export function NotificationSettingsPicker() {
|
||||
|
||||
<div className="h-px bg-foreground/10 mx-1 my-1" />
|
||||
|
||||
<div className="flex items-center gap-2 px-2 py-1.5">
|
||||
<Volume2 size={14} className="text-muted-foreground" />
|
||||
<input
|
||||
type="range"
|
||||
min={0}
|
||||
max={100}
|
||||
step={5}
|
||||
value={volume}
|
||||
onChange={(e) =>
|
||||
apply({ notificationVolume: Number(e.target.value) })
|
||||
}
|
||||
className="flex-1 accent-primary"
|
||||
aria-label={t("notifSettings.volume")}
|
||||
/>
|
||||
<span className="text-xs text-muted-foreground w-8 text-end tabular-nums">
|
||||
{volume}
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div className="h-px bg-foreground/10 mx-1 my-1" />
|
||||
|
||||
<div
|
||||
className="grid grid-cols-2 gap-1 mx-1 mb-1 p-1 rounded-lg bg-foreground/5"
|
||||
role="group"
|
||||
@@ -334,7 +309,6 @@ export function NotificationSettingsPicker() {
|
||||
: { notificationSoundMeeting: id },
|
||||
)
|
||||
}
|
||||
volume={volume}
|
||||
/>
|
||||
</PopoverContent>
|
||||
</Popover>
|
||||
|
||||
@@ -59,10 +59,7 @@ export function useNotificationsSocket() {
|
||||
const vibrate = isOrder
|
||||
? user.vibrationEnabledOrder
|
||||
: user.vibrationEnabledMeeting;
|
||||
notificationPlayer.play(soundId, {
|
||||
volume: user.notificationVolume,
|
||||
vibrate,
|
||||
});
|
||||
notificationPlayer.play(soundId, { vibrate });
|
||||
});
|
||||
|
||||
socket.on("order_updated", () => {
|
||||
|
||||
@@ -71,7 +71,7 @@ class NotificationPlayer {
|
||||
|
||||
play(
|
||||
soundId: NotificationSoundId,
|
||||
opts: { volume?: number; vibrate?: boolean } = {},
|
||||
opts: { vibrate?: boolean } = {},
|
||||
): void {
|
||||
// Throttle: at most one sound every 600ms to avoid cacophony when
|
||||
// many events arrive at once.
|
||||
@@ -94,7 +94,10 @@ class NotificationPlayer {
|
||||
} catch {
|
||||
/* some browsers throw if not loaded */
|
||||
}
|
||||
el.volume = Math.max(0, Math.min(1, (opts.volume ?? 70) / 100));
|
||||
// Use the device/system volume — explicit volume control is out of
|
||||
// scope. Setting el.volume = 1 ensures we don't attenuate the OS
|
||||
// mixer level the user already controls.
|
||||
el.volume = 1;
|
||||
const promise = el.play();
|
||||
if (promise && typeof promise.then === "function") {
|
||||
promise.catch(() => {
|
||||
|
||||
@@ -118,11 +118,6 @@ export interface UpdateNotificationPreferencesBody {
|
||||
vibrationEnabledOrder?: boolean;
|
||||
vibrationEnabledMeeting?: boolean;
|
||||
notificationsMuted?: boolean;
|
||||
/**
|
||||
* @minimum 0
|
||||
* @maximum 100
|
||||
*/
|
||||
notificationVolume?: number;
|
||||
}
|
||||
|
||||
export interface UpdateClockHour12Body {
|
||||
@@ -164,7 +159,6 @@ export interface AuthUser {
|
||||
vibrationEnabledOrder: boolean;
|
||||
vibrationEnabledMeeting: boolean;
|
||||
notificationsMuted: boolean;
|
||||
notificationVolume: number;
|
||||
roles: string[];
|
||||
groups: GroupSummary[];
|
||||
createdAt: string;
|
||||
|
||||
@@ -3010,10 +3010,6 @@ components:
|
||||
type: boolean
|
||||
notificationsMuted:
|
||||
type: boolean
|
||||
notificationVolume:
|
||||
type: integer
|
||||
minimum: 0
|
||||
maximum: 100
|
||||
|
||||
UpdateClockHour12Body:
|
||||
type: object
|
||||
@@ -3063,8 +3059,6 @@ components:
|
||||
type: boolean
|
||||
notificationsMuted:
|
||||
type: boolean
|
||||
notificationVolume:
|
||||
type: integer
|
||||
roles:
|
||||
type: array
|
||||
items:
|
||||
@@ -3089,7 +3083,6 @@ components:
|
||||
- vibrationEnabledOrder
|
||||
- vibrationEnabledMeeting
|
||||
- notificationsMuted
|
||||
- notificationVolume
|
||||
- roles
|
||||
- groups
|
||||
- createdAt
|
||||
|
||||
@@ -79,7 +79,6 @@ export const LoginResponse = zod.object({
|
||||
vibrationEnabledOrder: zod.boolean(),
|
||||
vibrationEnabledMeeting: zod.boolean(),
|
||||
notificationsMuted: zod.boolean(),
|
||||
notificationVolume: zod.number(),
|
||||
roles: zod.array(zod.string()),
|
||||
groups: zod.array(
|
||||
zod.object({
|
||||
@@ -193,7 +192,6 @@ export const GetMeResponse = zod.object({
|
||||
vibrationEnabledOrder: zod.boolean(),
|
||||
vibrationEnabledMeeting: zod.boolean(),
|
||||
notificationsMuted: zod.boolean(),
|
||||
notificationVolume: zod.number(),
|
||||
roles: zod.array(zod.string()),
|
||||
groups: zod.array(
|
||||
zod.object({
|
||||
@@ -256,7 +254,6 @@ export const UpdateLanguageResponse = zod.object({
|
||||
vibrationEnabledOrder: zod.boolean(),
|
||||
vibrationEnabledMeeting: zod.boolean(),
|
||||
notificationsMuted: zod.boolean(),
|
||||
notificationVolume: zod.number(),
|
||||
roles: zod.array(zod.string()),
|
||||
groups: zod.array(
|
||||
zod.object({
|
||||
@@ -326,7 +323,6 @@ export const UpdateClockStyleResponse = zod.object({
|
||||
vibrationEnabledOrder: zod.boolean(),
|
||||
vibrationEnabledMeeting: zod.boolean(),
|
||||
notificationsMuted: zod.boolean(),
|
||||
notificationVolume: zod.number(),
|
||||
roles: zod.array(zod.string()),
|
||||
groups: zod.array(
|
||||
zod.object({
|
||||
@@ -342,9 +338,6 @@ export const UpdateClockStyleResponse = zod.object({
|
||||
/**
|
||||
* @summary Update notification sound, vibration & mute preferences
|
||||
*/
|
||||
export const updateNotificationPreferencesBodyNotificationVolumeMin = 0;
|
||||
export const updateNotificationPreferencesBodyNotificationVolumeMax = 100;
|
||||
|
||||
export const UpdateNotificationPreferencesBody = zod.object({
|
||||
notificationSoundOrder: zod
|
||||
.enum(["ding", "chime", "bell", "knock", "pop", "alert", "beep", "soft"])
|
||||
@@ -357,11 +350,6 @@ export const UpdateNotificationPreferencesBody = zod.object({
|
||||
vibrationEnabledOrder: zod.boolean().optional(),
|
||||
vibrationEnabledMeeting: zod.boolean().optional(),
|
||||
notificationsMuted: zod.boolean().optional(),
|
||||
notificationVolume: zod
|
||||
.number()
|
||||
.min(updateNotificationPreferencesBodyNotificationVolumeMin)
|
||||
.max(updateNotificationPreferencesBodyNotificationVolumeMax)
|
||||
.optional(),
|
||||
});
|
||||
|
||||
export const UpdateNotificationPreferencesResponse = zod.object({
|
||||
@@ -407,7 +395,6 @@ export const UpdateNotificationPreferencesResponse = zod.object({
|
||||
vibrationEnabledOrder: zod.boolean(),
|
||||
vibrationEnabledMeeting: zod.boolean(),
|
||||
notificationsMuted: zod.boolean(),
|
||||
notificationVolume: zod.number(),
|
||||
roles: zod.array(zod.string()),
|
||||
groups: zod.array(
|
||||
zod.object({
|
||||
@@ -475,7 +462,6 @@ export const UpdateClockHour12Response = zod.object({
|
||||
vibrationEnabledOrder: zod.boolean(),
|
||||
vibrationEnabledMeeting: zod.boolean(),
|
||||
notificationsMuted: zod.boolean(),
|
||||
notificationVolume: zod.number(),
|
||||
roles: zod.array(zod.string()),
|
||||
groups: zod.array(
|
||||
zod.object({
|
||||
|
||||
@@ -21,7 +21,6 @@ export const usersTable = pgTable("users", {
|
||||
vibrationEnabledOrder: boolean("vibration_enabled_order").notNull().default(true),
|
||||
vibrationEnabledMeeting: boolean("vibration_enabled_meeting").notNull().default(true),
|
||||
notificationsMuted: boolean("notifications_muted").notNull().default(false),
|
||||
notificationVolume: integer("notification_volume").notNull().default(70),
|
||||
createdAt: timestamp("created_at", { withTimezone: true }).notNull().defaultNow(),
|
||||
updatedAt: timestamp("updated_at", { withTimezone: true }).notNull().defaultNow().$onUpdate(() => new Date()),
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user