A local-first personal finance app
import { beforeEach, describe, expect, it } from 'vitest';
import { aqlQuery } from '#server/aql';
import * as db from '#server/db';
import { loadMappings } from '#server/db/mappings';
import { runMutator } from '#server/mutators';
import { q } from '#shared/query';
import type { DashboardWidgetEntity } from '#types/models';
import { app as dashboardApp, isWidgetType } from './app';
function allWidgetTypes<T extends DashboardWidgetEntity['type'][]>(
...types: T &
(DashboardWidgetEntity['type'] extends T[number] ? unknown : never)
): T {
return types;
}
const ALL_WIDGET_TYPES = allWidgetTypes(
'net-worth-card',
'cash-flow-card',
'spending-card',
'crossover-card',
'budget-analysis-card',
'markdown-card',
'summary-card',
'calendar-card',
'formula-card',
'custom-report',
'sankey-card',
'balance-forecast-card',
'age-of-money-card',
'monte-carlo-card',
);
describe('isWidgetType', () => {
it('all known widget types should be recognized', () => {
for (const type of ALL_WIDGET_TYPES) {
expect(isWidgetType(type)).toBe(true);
}
});
it('unknown widget types should be rejected', () => {
expect(isWidgetType('unknown-card')).toBe(false);
});
});
describe('dashboard-update', () => {
beforeEach(async () => {
await global.emptyDatabase()();
await loadMappings();
});
async function addWidget(id: string, x: number) {
await db.insertWithSchema('dashboard', {
id,
type: 'markdown-card',
width: 4,
height: 2,
x,
y: 0,
dashboard_page_id: 'dashboard-page-id',
});
}
// An empty database still carries the default dashboard the migrations
// seed, so only look at the widgets the test added
async function getTestWidgets(ids: string[]) {
const { data } = await aqlQuery(
q('dashboard')
.filter({ id: { $oneof: ids } })
.select('*'),
);
return (data as DashboardWidgetEntity[]).sort((a, b) =>
a.id.localeCompare(b.id),
);
}
it('persists every widget in a layout change', async () => {
await addWidget('widget-1', 0);
await addWidget('widget-2', 4);
await addWidget('widget-3', 8);
await runMutator(() =>
dashboardApp.handlers['dashboard-update']([
{ id: 'widget-1', x: 8, y: 2 },
{ id: 'widget-2', x: 0, y: 4 },
{ id: 'widget-3', x: 4, y: 6 },
]),
);
expect(
(await getTestWidgets(['widget-1', 'widget-2', 'widget-3'])).map(
({ id, x, y }) => ({ id, x, y }),
),
).toEqual([
{ id: 'widget-1', x: 8, y: 2 },
{ id: 'widget-2', x: 0, y: 4 },
{ id: 'widget-3', x: 4, y: 6 },
]);
});
it('round-trips a meta object', async () => {
await addWidget('widget-1', 0);
await runMutator(() =>
dashboardApp.handlers['dashboard-update']([
{ id: 'widget-1', meta: { content: '## Notes' } },
]),
);
expect((await getTestWidgets(['widget-1']))[0].meta).toEqual({
content: '## Notes',
});
});
});