mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-11-20 19:16:08 +00:00
fix(native): widgets turn to the next trip day by themselves
TestFlight feedback: during a trip the widgets stayed on day 1 until the app was opened again. The app wrote only today's day into the widget snapshot, and only while it ran, so every timeline entry after midnight still showed the day it last ran, with its stops all ahead again. The snapshot now also carries the trip's days from today on (a month at most, sixteen stops a day), each with its date. On iOS every timeline entry takes the day of its own date, so the quarter-hour entry at midnight turns the widget to the next day, and the bookings list drops the days behind; the Android widgets do the same on each update. A snapshot from an app without the days reads as it was written, and an older app binary ignores them.
This commit is contained in:
@@ -0,0 +1,87 @@
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
import { render, waitFor } from '../../../tests/helpers/render';
|
||||
import { offlineDb } from '../../db/offlineDb';
|
||||
import type { Day, Trip } from '../../types';
|
||||
|
||||
const published = vi.hoisted(() => ({ calls: [] as unknown[][] }));
|
||||
|
||||
vi.mock('@capacitor/app', () => ({ App: { addListener: vi.fn(async () => ({ remove: vi.fn() })) } }));
|
||||
vi.mock('../../native/capabilities', () => ({ useNativeCapabilities: () => ({ caps: {} }) }));
|
||||
vi.mock('../../native/watch', () => ({
|
||||
applyWatchActions: vi.fn(async () => []),
|
||||
buildWatchSnapshot: vi.fn(),
|
||||
publishWatch: vi.fn(async () => {}),
|
||||
takeWatchActions: vi.fn(async () => []),
|
||||
watchActive: () => false,
|
||||
}));
|
||||
vi.mock('../../native/widgetMedia', () => ({
|
||||
widgetCover: vi.fn(async () => null),
|
||||
widgetWeather: vi.fn(async () => null),
|
||||
}));
|
||||
vi.mock('../../native/widgetOnline', () => ({
|
||||
atlasSummary: vi.fn(async () => null),
|
||||
collabSummary: vi.fn(async () => null),
|
||||
packingDetail: vi.fn(async () => null),
|
||||
}));
|
||||
vi.mock('../../native/widgets', async (importOriginal) => {
|
||||
const actual = await importOriginal<typeof import('../../native/widgets')>();
|
||||
return {
|
||||
...actual,
|
||||
widgetsActive: () => true,
|
||||
publishWidgets: vi.fn(async (...args: unknown[]) => {
|
||||
published.calls.push(args);
|
||||
}),
|
||||
};
|
||||
});
|
||||
|
||||
import NativeWidgetsSync from './NativeWidgetsSync';
|
||||
|
||||
const trip = {
|
||||
id: 7,
|
||||
title: 'Lisbon',
|
||||
start_date: '2026-11-06',
|
||||
end_date: '2026-11-08',
|
||||
is_archived: 0,
|
||||
} as unknown as Trip;
|
||||
const day = (id: number, n: number, date: string, name: string) =>
|
||||
({
|
||||
id,
|
||||
trip_id: 7,
|
||||
day_number: n,
|
||||
date,
|
||||
assignments: [{ id: id * 10, order_index: 0, place: { name, place_time: '10:00' } }],
|
||||
}) as unknown as Day;
|
||||
|
||||
describe('NativeWidgetsSync', () => {
|
||||
beforeEach(async () => {
|
||||
vi.useFakeTimers({ toFake: ['Date'] });
|
||||
vi.setSystemTime(new Date(2026, 10, 7, 9, 0));
|
||||
published.calls = [];
|
||||
await offlineDb.trips.put(trip as never);
|
||||
await offlineDb.days.bulkPut([
|
||||
day(1, 1, '2026-11-06', 'Castle'),
|
||||
day(2, 2, '2026-11-07', 'Harbour'),
|
||||
day(3, 3, '2026-11-08', 'Market'),
|
||||
] as never);
|
||||
});
|
||||
|
||||
afterEach(async () => {
|
||||
vi.useRealTimers();
|
||||
await offlineDb.trips.clear();
|
||||
await offlineDb.days.clear();
|
||||
});
|
||||
|
||||
it('FE-NATIVE-WSYNC-001: writes today and every day ahead, so the widgets turn the day without the app', async () => {
|
||||
render(<NativeWidgetsSync />);
|
||||
await waitFor(() => expect(published.calls.length).toBeGreaterThan(0));
|
||||
const snapshot = published.calls[0][0] as {
|
||||
today: { date: string; stops: { name: string }[] } | null;
|
||||
days: { date: string; stops: { name: string }[] }[];
|
||||
};
|
||||
expect(snapshot.today).toMatchObject({ date: '2026-11-07', stops: [{ name: 'Harbour' }] });
|
||||
expect(snapshot.days.map((d) => [d.date, d.stops[0]?.name])).toEqual([
|
||||
['2026-11-07', 'Harbour'],
|
||||
['2026-11-08', 'Market'],
|
||||
]);
|
||||
});
|
||||
});
|
||||
@@ -25,11 +25,10 @@ import {
|
||||
liveFlightOf,
|
||||
pickTrip,
|
||||
publishWidgets,
|
||||
todayOf,
|
||||
snapshotDays,
|
||||
tripDayState,
|
||||
widgetTripChoices,
|
||||
widgetsActive,
|
||||
withBookings,
|
||||
type TripWidgetSnapshot,
|
||||
type WidgetLabels,
|
||||
} from '../../native/widgets';
|
||||
@@ -191,11 +190,15 @@ export default function NativeWidgetsSync(): null {
|
||||
const tripSnapshot = async (trip: Trip | null, context: SyncContext, atlas: WidgetAtlas | null) => {
|
||||
const days = trip ? await offlineDb.days.where('trip_id').equals(trip.id).toArray() : [];
|
||||
const extra = trip ? await tripExtras(trip, days, context) : null;
|
||||
const plain = trip
|
||||
? todayOf(trip, days, context.today, (n, m) => t('native.widget.dayOf', { n, m }), context.time)
|
||||
: null;
|
||||
const day = plain ? withBookings(plain, extra?.reservations ?? [], context.today, context.time) : null;
|
||||
return { day, days, extra, snapshot: buildSnapshot(trip, day, labels(t), { ...extra?.extras, atlas }) };
|
||||
// Today and the days after it: the widgets turn to the next day at midnight by themselves.
|
||||
const { today: day, ahead } = snapshotDays(trip, days, {
|
||||
reservations: extra?.reservations ?? [],
|
||||
from: context.today,
|
||||
dayLabel: (n, m) => t('native.widget.dayOf', { n, m }),
|
||||
formatTime: context.time,
|
||||
});
|
||||
const snapshot = buildSnapshot(trip, day, labels(t), { ...extra?.extras, atlas, days: ahead });
|
||||
return { day, days, extra, snapshot };
|
||||
};
|
||||
|
||||
/** The hero trip in full for the watch, with the ticks from it applied so far. */
|
||||
|
||||
@@ -18,8 +18,11 @@ import {
|
||||
liveDayDue,
|
||||
pickTrip,
|
||||
publishWidgets,
|
||||
snapshotDays,
|
||||
todayOf,
|
||||
tripDaysFrom,
|
||||
tripDayState,
|
||||
WIDGET_DAYS_AHEAD,
|
||||
widgetTripChoices,
|
||||
withBookings,
|
||||
} from './widgets';
|
||||
@@ -405,3 +408,90 @@ describe('widgets set to a trip', () => {
|
||||
expect(JSON.parse(calls[2].json)).toEqual([{ id: 2, title: 'Trip 2', start: '2026-12-01', end: '2026-12-05' }]);
|
||||
});
|
||||
});
|
||||
|
||||
describe('the days ahead, for a widget that turns the day itself', () => {
|
||||
const tripDays = [
|
||||
day(1, 1, '2026-11-06', [{ name: 'Museum', time: '09:00' }]),
|
||||
day(2, 2, '2026-11-07', [{ name: 'Harbour', time: '10:00' }, { name: 'Market' }]),
|
||||
day(3, 3, '2026-11-08', []),
|
||||
];
|
||||
const label = (n: number, m: number) => `${n}/${m}`;
|
||||
|
||||
it('FE-NATIVE-WDAYS-001: carries every day from today on with its date, label and stops', () => {
|
||||
const ahead = tripDaysFrom(trip(1, '2026-11-06', '2026-11-08'), tripDays, {
|
||||
reservations: [],
|
||||
from: '2026-11-07',
|
||||
dayLabel: label,
|
||||
formatTime: (t) => t,
|
||||
});
|
||||
expect(ahead.map((d) => [d.date, d.dayLabel, d.stops.map((s) => s.name)])).toEqual([
|
||||
['2026-11-07', '2/3', ['Harbour', 'Market']],
|
||||
['2026-11-08', '3/3', []],
|
||||
]);
|
||||
});
|
||||
|
||||
it('FE-NATIVE-WDAYS-002: joins each day to the bookings of its own date', () => {
|
||||
const reservations = [
|
||||
{ id: 1, type: 'restaurant', title: 'Dinner', status: 'confirmed', reservation_time: '2026-11-08T19:30' },
|
||||
] as never;
|
||||
const ahead = tripDaysFrom(trip(1, '2026-11-06', '2026-11-08'), tripDays, {
|
||||
reservations,
|
||||
from: '2026-11-06',
|
||||
dayLabel: label,
|
||||
formatTime: (t) => t,
|
||||
});
|
||||
expect(ahead.find((d) => d.date === '2026-11-08')?.stops.map((s) => s.name)).toEqual(['Dinner']);
|
||||
expect(ahead.find((d) => d.date === '2026-11-06')?.stops.map((s) => s.name)).toEqual(['Museum']);
|
||||
});
|
||||
|
||||
it('FE-NATIVE-WDAYS-003: holds a month at most and nothing of a trip that is over', () => {
|
||||
const long = Array.from({ length: 40 }, (_, i) =>
|
||||
day(i + 1, i + 1, `2026-12-${String(i + 1).padStart(2, '0')}`, [])
|
||||
).map((d, i) => (i >= 31 ? { ...d, date: `2027-01-${String(i - 30).padStart(2, '0')}` } : d)) as Day[];
|
||||
const t = trip(1, '2026-12-01', '2027-01-09');
|
||||
expect(
|
||||
tripDaysFrom(t, long, { reservations: [], from: '2026-12-01', dayLabel: label, formatTime: (x) => x })
|
||||
).toHaveLength(WIDGET_DAYS_AHEAD);
|
||||
expect(
|
||||
tripDaysFrom(t, long, { reservations: [], from: '2027-02-01', dayLabel: label, formatTime: (x) => x })
|
||||
).toEqual([]);
|
||||
});
|
||||
|
||||
it('FE-NATIVE-WDAYS-004: the snapshot has today with its date and the days ahead, each held to 16 stops', () => {
|
||||
const busy = day(
|
||||
4,
|
||||
1,
|
||||
'2026-11-06',
|
||||
Array.from({ length: 20 }, (_, i) => ({ name: `Stop ${i}` }))
|
||||
);
|
||||
const t = trip(1, '2026-11-06', '2026-11-06');
|
||||
const ahead = tripDaysFrom(t, [busy], {
|
||||
reservations: [],
|
||||
from: '2026-11-06',
|
||||
dayLabel: label,
|
||||
formatTime: (x) => x,
|
||||
});
|
||||
const snapshot = buildSnapshot(t, ahead[0] ?? null, labels, { days: ahead });
|
||||
expect(snapshot.today?.date).toBe('2026-11-06');
|
||||
// Today stays whole, as the app has always written it; the days ahead keep their first 16.
|
||||
expect(snapshot.today?.stops).toHaveLength(20);
|
||||
expect(snapshot.days?.[0]).toMatchObject({ date: '2026-11-06', dayLabel: '1/1' });
|
||||
expect(snapshot.days?.[0]?.stops).toHaveLength(16);
|
||||
});
|
||||
|
||||
it('FE-NATIVE-WDAYS-005: a snapshot without days ahead leaves the field out', () => {
|
||||
expect(buildSnapshot(trip(1, '2026-11-06', '2026-11-08'), null, labels, { days: [] })).not.toHaveProperty('days');
|
||||
});
|
||||
|
||||
it('FE-NATIVE-WDAYS-006: today is the first day ahead while the trip runs today, none before it starts or without a trip', () => {
|
||||
const options = { reservations: [], dayLabel: label, formatTime: (x: string) => x };
|
||||
const t = trip(1, '2026-11-06', '2026-11-08');
|
||||
const running = snapshotDays(t, tripDays, { ...options, from: '2026-11-07' });
|
||||
expect(running.today?.date).toBe('2026-11-07');
|
||||
expect(running.ahead).toHaveLength(2);
|
||||
const before = snapshotDays(t, tripDays, { ...options, from: '2026-11-01' });
|
||||
expect(before.today).toBeNull();
|
||||
expect(before.ahead.map((d) => d.date)).toEqual(['2026-11-06', '2026-11-07', '2026-11-08']);
|
||||
expect(snapshotDays(null, tripDays, { ...options, from: '2026-11-07' })).toEqual({ today: null, ahead: [] });
|
||||
});
|
||||
});
|
||||
|
||||
@@ -104,7 +104,14 @@ export interface WidgetSnapshot {
|
||||
placeCount?: number;
|
||||
memberCount?: number;
|
||||
} | null;
|
||||
today: { dayLabel: string; stops: SnapshotStop[]; index?: number; total?: number } | null;
|
||||
today: SnapshotDay | null;
|
||||
/**
|
||||
* Every day of the trip from the day it was written on, each with its date,
|
||||
* so a widget turns to the next day by itself at midnight instead of showing
|
||||
* the day the app last ran until it is opened again. A binary without it
|
||||
* reads `today` as before.
|
||||
*/
|
||||
days?: SnapshotDay[];
|
||||
weather?: WidgetWeather;
|
||||
bookings?: WidgetBooking[];
|
||||
todos?: WidgetTodos;
|
||||
@@ -128,7 +135,18 @@ export interface WidgetWeather {
|
||||
}
|
||||
|
||||
/** What goes along with the trip beyond its day; each part optional. */
|
||||
/** A trip day as the widgets read it; `date` (yyyy-MM-dd) says which day of the calendar it is. */
|
||||
interface SnapshotDay {
|
||||
date?: string;
|
||||
dayLabel: string;
|
||||
stops: SnapshotStop[];
|
||||
index?: number;
|
||||
total?: number;
|
||||
}
|
||||
|
||||
interface SnapshotExtras {
|
||||
/** The trip's days from today on (tripDaysFrom), for the widgets to turn the day themselves. */
|
||||
days?: TripDay[];
|
||||
place?: string | null;
|
||||
cover?: string | null;
|
||||
placeCount?: number;
|
||||
@@ -152,8 +170,15 @@ export interface TripDay {
|
||||
/** 1-based position of the day in the trip, and the trip's day count. */
|
||||
index?: number;
|
||||
total?: number;
|
||||
/** The calendar day it is, yyyy-MM-dd. */
|
||||
date?: string;
|
||||
}
|
||||
|
||||
/** How many days ahead a snapshot carries: a month of a trip without the app being opened. */
|
||||
export const WIDGET_DAYS_AHEAD = 31;
|
||||
/** The stops a day carries at most, which is more than the largest widget shows. */
|
||||
const WIDGET_DAY_STOPS = 16;
|
||||
|
||||
/** iOS (WidgetKit) and Android (Glance) read the same snapshot. */
|
||||
export function widgetsActive(): boolean {
|
||||
return isNativeApp() && hasNativeFeature('widgets');
|
||||
@@ -243,9 +268,45 @@ export function todayOf(
|
||||
dayId: day.id,
|
||||
index: index + 1,
|
||||
total: ordered.length,
|
||||
date: today,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* The trip's days from `from` on, each with its stops and its timed bookings, at
|
||||
* most WIDGET_DAYS_AHEAD of them: what a widget needs to show the right day on
|
||||
* the days the app is not opened.
|
||||
*/
|
||||
/** What tripDaysFrom reads besides the trip and its days. */
|
||||
interface DaysFromOptions {
|
||||
reservations: Reservation[];
|
||||
/** The first date, yyyy-MM-dd: today. */
|
||||
from: string;
|
||||
dayLabel: (index: number, total: number) => string;
|
||||
formatTime: (time: string) => string;
|
||||
}
|
||||
|
||||
export function tripDaysFrom(
|
||||
trip: Trip,
|
||||
days: Day[],
|
||||
{ reservations, from, dayLabel, formatTime }: DaysFromOptions
|
||||
): TripDay[] {
|
||||
const dates = [
|
||||
...new Set(
|
||||
days
|
||||
.filter((d) => d.trip_id === trip.id)
|
||||
.map((d) => (d.date ?? '').slice(0, 10))
|
||||
.filter((date) => date >= from)
|
||||
),
|
||||
]
|
||||
.sort((a, b) => a.localeCompare(b))
|
||||
.slice(0, WIDGET_DAYS_AHEAD);
|
||||
return dates.flatMap((date) => {
|
||||
const day = todayOf(trip, days, date, dayLabel, formatTime);
|
||||
return day ? [withBookings(day, reservations, date, formatTime)] : [];
|
||||
});
|
||||
}
|
||||
|
||||
/** The day with its timed bookings (a flight, the table tonight) joined to the stops in time order. */
|
||||
export function withBookings(
|
||||
day: TripDay,
|
||||
@@ -303,6 +364,29 @@ function snapshotStop({ time, name, minutes, color, symbol }: WidgetStop): Snaps
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* The days a trip's snapshot carries: `today` while the trip runs today, and
|
||||
* every day from today on for the widgets to turn to by themselves.
|
||||
*/
|
||||
export function snapshotDays(
|
||||
trip: Trip | null,
|
||||
days: Day[],
|
||||
options: DaysFromOptions
|
||||
): { today: TripDay | null; ahead: TripDay[] } {
|
||||
const ahead = trip ? tripDaysFrom(trip, days, options) : [];
|
||||
return { today: ahead[0]?.date === options.from ? ahead[0] : null, ahead };
|
||||
}
|
||||
|
||||
/** A day for the snapshot; the days ahead keep their first `limit` stops, so a month of them stays small. */
|
||||
function snapshotDay(day: TripDay, limit = day.stops.length): SnapshotDay {
|
||||
return {
|
||||
...(day.date ? { date: day.date } : {}),
|
||||
dayLabel: day.dayLabel,
|
||||
stops: day.stops.slice(0, limit).map(snapshotStop),
|
||||
...(day.index ? { index: day.index, total: day.total } : {}),
|
||||
};
|
||||
}
|
||||
|
||||
export function buildSnapshot(
|
||||
trip: Trip | null,
|
||||
day: TripDay | null,
|
||||
@@ -323,15 +407,10 @@ export function buildSnapshot(
|
||||
...(extras.memberCount ? { memberCount: extras.memberCount } : {}),
|
||||
}
|
||||
: null,
|
||||
today: day
|
||||
? {
|
||||
dayLabel: day.dayLabel,
|
||||
stops: day.stops.map(snapshotStop),
|
||||
...(day.index ? { index: day.index, total: day.total } : {}),
|
||||
}
|
||||
: null,
|
||||
today: day ? snapshotDay(day) : null,
|
||||
labels,
|
||||
};
|
||||
if (extras.days?.length) snapshot.days = extras.days.map((d) => snapshotDay(d, WIDGET_DAY_STOPS));
|
||||
if (extras.weather) snapshot.weather = extras.weather;
|
||||
if (extras.bookings) snapshot.bookings = extras.bookings;
|
||||
if (extras.todos) snapshot.todos = extras.todos;
|
||||
|
||||
Reference in New Issue
Block a user