import { afterAll, beforeEach, describe, expect, it } from 'vitest'; import { classifyAsset } from '../src/analytics/assets.js'; import { rollUp } from '../src/analytics/recorder.js'; import { SLOT_MS, slotOf, windowOf } from '../src/analytics/time.js'; import { IssueIndexer } from '../src/domain/issue-index.js'; import { acceptSubmission } from '../src/domain/submissions.js'; import { createInvite } from '../src/domain/workspaces.js'; import { form, get, grant, makeAdmin, makeApp, makeWorkspace, resetDb, testDb, type Admin, type ConfiguredWorkspace, type TestEnv } from './helpers.js'; describe('Analytics: release files and time', () => { it('reads what each release file is from its name', () => { expect(classifyAsset('photocraft-0.11.1-windows-x64.msi')).toEqual({ platform: 'windows', arch: 'x64', format: 'MSI', kind: 'app' }); expect(classifyAsset('photocraft-0.11.1-windows-x86-portable.zip')).toMatchObject({ platform: 'windows', arch: 'x86', format: 'Portable zip' }); expect(classifyAsset('photocraft-0.11.1-macos-universal.dmg')).toMatchObject({ platform: 'macos', arch: 'universal', format: 'DMG' }); expect(classifyAsset('photocraft-0.11.1-linux-aarch64.AppImage')).toMatchObject({ platform: 'linux', arch: 'arm64', format: 'AppImage' }); expect(classifyAsset('photocraft-0.11.1-linux-x86_64.pkg.tar.zst')).toMatchObject({ platform: 'linux', arch: 'x64', format: 'pkg.tar.zst' }); expect(classifyAsset('photocraft-0.11.1-freebsd-x86_64.tar.gz')).toMatchObject({ platform: 'freebsd', format: 'tar.gz' }); expect(classifyAsset('photocraft-cli-0.11.1-macos-universal.zip')).toMatchObject({ platform: 'macos', kind: 'cli' }); expect(classifyAsset('photocraft-web-0.11.1.zip')).toMatchObject({ platform: 'web', kind: 'web' }); for (const meta of ['SHA256SUMS.txt', 'photocraft-0.11.1-linux-x86_64.AppImage.zsync', 'latest.json', 'app.msi.sig']) expect(classifyAsset(meta).kind).toBe('meta'); }); it('starts today at the viewer’s midnight, and only offers steps that fit', () => { const now = Date.parse('2026-10-21T06:20:00Z'); const today = windowOf(undefined, undefined, 'America/Los_Angeles', now); expect(today).toMatchObject({ start: Date.parse('2026-10-20T07:00:00Z'), end: Date.parse('2026-10-21T07:00:00Z'), until: now }); expect(today.step.id).toBe('30m'); expect(today.buckets).toHaveLength(48); // Compared with the same time yesterday. expect(today.prevEnd - today.prevStart).toBe(now - today.start); expect(windowOf('7d', undefined, 'UTC', now).step.id).toBe('3h'); // 30 minutes over 30 days would be 1,440 bars: not offered, so the range's own step is used. const month = windowOf('30d', '30m', 'UTC', now); expect(month.step.id).toBe('1d'); expect(month.steps.filter((s) => s.ok).map((s) => s.id)).toEqual(['3h', '6h', '12h', '1d']); expect(windowOf('90d', '6h', 'UTC', now).steps.filter((s) => s.ok).map((s) => s.id)).toEqual(['1d']); // A day of 25 hours when the clocks go back. const fall = windowOf('7d', '1d', 'America/Los_Angeles', Date.parse('2026-11-03T20:00:00Z')); expect(fall.buckets[5]! - fall.buckets[4]!).toBe(25 * 3_600_000); }); }); let env: TestEnv; let ws: ConfiguredWorkspace; const w = () => `/w/${ws.workspace.id}`; const page = (url: string, who: Admin = ws.owner) => env.server.inject({ method: 'GET', url: `${w()}${url}`, ...get(who) }); const post = (url: string, fields: Record = {}, who: Admin = ws.owner) => env.server.inject({ method: 'POST', url: `${w()}${url}`, ...form(who, fields) }); const repo = (i = 0) => env.github.repos.get(ws.repoIds[i]!)!; const tick = (now: number) => env.triage.engine.analytics.tick(now); const counts = async () => (await env.db.query( 'SELECT a.name, a.release, c.slot_at, c.downloads FROM download_counts c JOIN download_assets a ON a.id = c.asset_id ORDER BY c.slot_at, a.name', )).rows.map((r) => ({ name: r.name, release: r.release, slot: r.slot_at.getTime(), n: r.downloads })); const ago = (h: number, from = Date.now()) => new Date(from - h * 3_600_000).toISOString(); function seed(now = Date.now()) { repo().releases = [ { tag: 'v0.11.1', published_at: ago(30, now), assets: [ { name: 'photocraft-0.11.1-windows-x64.msi', downloads: 1000 }, { name: 'photocraft-0.11.1-macos-universal.dmg', downloads: 500 }, { name: 'photocraft-0.11.1-linux-x86_64.AppImage', downloads: 200 }, { name: 'SHA256SUMS.txt', downloads: 90 }, ] }, { tag: 'v0.10.0', published_at: ago(200, now), assets: [{ name: 'photocraft-0.10.0-windows-x64.msi', downloads: 4000 }] }, ]; repo().stars = [{ login: 'ana', at: ago(5, now) }, { login: 'ben', at: ago(400, now) }]; } const asset = (name: string) => repo().releases!.flatMap((r) => r.assets ?? []).find((a) => a.name === name)!; beforeEach(async () => { await resetDb(); env = await makeApp(); ws = await makeWorkspace(env, { apps: [{ name: 'PhotoCraft', repoIndex: 0 }] }); }); afterAll(async () => { await testDb().end(); }); describe('Analytics: recording downloads', () => { it('is off until turned on, then records how much each file grew per 30 minutes', async () => { seed(); const t0 = slotOf(Date.now()) - 4 * SLOT_MS + 60_000; expect(await tick(t0)).toBe(0); const off = (await page('/analytics')).body; expect(off).toContain('See downloads every half hour'); expect(off).toContain('Turn on'); expect((await post('/analytics/enabled', { enabled: '1' })).statusCode).toBe(302); // The first read is a starting point. expect(await tick(t0)).toBe(1); expect(await counts()).toEqual([]); expect(await tick(t0 + 60_000)).toBe(0); // Half an hour later: what grew, in the slot that just ended; checksums aren't downloads. asset('photocraft-0.11.1-windows-x64.msi').downloads += 40; asset('photocraft-0.11.1-macos-universal.dmg').downloads += 10; asset('SHA256SUMS.txt').downloads += 9; expect(await tick(t0 + SLOT_MS)).toBe(1); expect(await counts()).toEqual([ { name: 'photocraft-0.11.1-macos-universal.dmg', release: 'v0.11.1', slot: slotOf(t0), n: 10 }, { name: 'photocraft-0.11.1-windows-x64.msi', release: 'v0.11.1', slot: slotOf(t0), n: 40 }, ]); // A read missed: the growth is spread over the slots in between. asset('photocraft-0.11.1-windows-x64.msi').downloads += 7; await tick(t0 + 3 * SLOT_MS); const spread = (await counts()).filter((c) => c.slot > slotOf(t0)); expect(spread).toEqual([ { name: 'photocraft-0.11.1-windows-x64.msi', release: 'v0.11.1', slot: slotOf(t0) + SLOT_MS, n: 3 }, { name: 'photocraft-0.11.1-windows-x64.msi', release: 'v0.11.1', slot: slotOf(t0) + 2 * SLOT_MS, n: 4 }, ]); }); it('counts a new release from when it was published, and starts again after a long gap', async () => { seed(); const t0 = slotOf(Date.now()) - 60 * SLOT_MS; await post('/analytics/enabled', { enabled: '1' }); await tick(t0); repo().releases!.unshift({ tag: 'v0.12.0', published_at: new Date(t0 + 10 * 60_000).toISOString(), assets: [{ name: 'photocraft-0.12.0-windows-x64.msi', downloads: 25 }] }); await tick(t0 + SLOT_MS); expect(await counts()).toEqual([{ name: 'photocraft-0.12.0-windows-x64.msi', release: 'v0.12.0', slot: slotOf(t0), n: 25 }]); // Off for over a day: nothing invented for the gap. asset('photocraft-0.12.0-windows-x64.msi').downloads += 5000; const later = t0 + 50 * SLOT_MS; await tick(later); expect((await counts()).length).toBe(1); const sync = (await env.db.query('SELECT started_at FROM download_sync')).rows[0]; expect(sync.started_at.getTime()).toBe(later); }); it('counts stars from how GitHub’s star count changes; a refused read shows and doesn’t stop downloads; old detail is kept per day', async () => { seed(); await post('/analytics/enabled', { enabled: '1' }); const t0 = slotOf(Date.now()) - 6 * SLOT_MS; await tick(t0); const sync = async () => (await env.db.query('SELECT stars_total, stars_started_at, stars_error, last_slot_at, error FROM download_sync')).rows[0]; const changes = async () => (await env.db.query('SELECT slot_at, change FROM repo_star_changes ORDER BY slot_at')).rows.map((r) => [r.slot_at.getTime() - t0, r.change]); // The first read is a starting point: GitHub's count, no change yet. expect(await sync()).toMatchObject({ stars_total: 2, stars_started_at: new Date(t0), stars_error: null }); expect(await changes()).toEqual([]); repo().stars!.push({ login: 'cy', at: new Date().toISOString() }); await tick(t0 + SLOT_MS); expect(await changes()).toEqual([[0, 1]]); // Two taken back over a missed half hour: spread over both, each -1. repo().stars = repo().stars!.filter((x) => x.login === 'cy'); await tick(t0 + 3 * SLOT_MS); expect(await changes()).toEqual([[0, 1], [SLOT_MS, -1], [2 * SLOT_MS, -1]]); expect((await sync()).stars_total).toBe(1); // GitHub refuses the count: said on the page, and downloads still record. env.github.starCountForbidden = true; asset('photocraft-0.11.1-windows-x64.msi').downloads += 7; await tick(t0 + 4 * SLOT_MS); expect(await sync()).toMatchObject({ stars_total: 1, stars_error: 'GitHub didn’t let the app read the star count.', last_slot_at: new Date(t0 + 4 * SLOT_MS), error: null }); expect((await counts()).at(-1)).toMatchObject({ slot: t0 + 3 * SLOT_MS, n: 7 }); const refused = (await page('/analytics?range=7d&metric=stars')).body; expect(refused).toContain('Stars couldn’t be read'); expect(refused).toContain('PhotoCraft: GitHub didn’t let the app read the star count.'); expect((await page('/analytics?range=7d')).body).not.toContain('Stars couldn’t be read'); env.github.starCountForbidden = false; await tick(t0 + 5 * SLOT_MS); expect((await sync()).stars_error).toBeNull(); // 30-minute rows older than 32 days are added up per UTC day. const old = Date.parse('2026-08-01T10:30:00Z'); const { rows } = await env.db.query('SELECT id FROM download_assets LIMIT 1'); await env.db.query('INSERT INTO download_counts (asset_id, slot_at, downloads) VALUES ($1, $2, 3), ($1, $3, 4)', [rows[0].id, new Date(old), new Date(old + SLOT_MS)]); await rollUp(env.db, Date.parse('2026-10-21T00:00:00Z')); expect((await env.db.query('SELECT day_at, downloads FROM download_days')).rows).toEqual([{ day_at: new Date('2026-08-01T00:00:00Z'), downloads: 7 }]); expect((await env.db.query('SELECT count(*) AS n FROM download_counts WHERE slot_at < $1', [new Date('2026-09-01')])).rows[0].n).toBe(0); }); }); describe('Analytics: the page', () => { async function recorded(): Promise { seed(); await post('/analytics/enabled', { enabled: '1' }); const t0 = slotOf(Date.now()) - 10 * SLOT_MS; await tick(t0); asset('photocraft-0.11.1-windows-x64.msi').downloads += 300; asset('photocraft-0.11.1-macos-universal.dmg').downloads += 100; asset('photocraft-0.11.1-linux-x86_64.AppImage').downloads += 100; await tick(t0 + SLOT_MS); return t0; } async function ticket(title: string) { const r = await acceptSubmission(env.deps, { workspace: ws.workspace, app: ws.apps[0]!, installationId: ws.installationId, source: 'discord', interactionId: `int-an-${title}`, interactionToken: null, guildId: ws.guildId, guildName: 'G', channelId: ws.channelId, reporter: { id: `r-${title}`, displayName: 'Member', username: 'member' }, title, description: `${title}, every time.`, ticketType: null, }); if (r.kind !== 'accepted') throw new Error(r.kind); await env.worker.drain(); } it('shows downloads with their breakdowns, activity and release health, for the range and step picked', async () => { await recorded(); await ticket('Export crashes'); // One issue opened on GitHub, next to the one the ticket filed. repo().issues.push({ number: 77, title: 'Opened on GitHub', body: '', labels: [], created_at: new Date().toISOString(), user: 'someone' }); await new IssueIndexer(env.deps).tick(); const res = await page('/analytics?range=7d'); expect(res.statusCode).toBe(200); const body = res.body; // One app: downloads by platform, in the fixed order. expect(body).toMatch(/data-an-chart='[^']*"name":"Windows"[^']*"name":"macOS"[^']*"name":"Linux"/); expect(body).toContain('
Downloads
500
'); expect(body).toContain('
Tickets per 1K downloads
2.0
'); expect(body).toContain('
Discord tickets
1
'); expect(body).toContain('
Issues opened
2
1 from Discord · 1 on GitHub
'); expect(body).toContain('x64 (Intel, AMD)'); expect(body).toContain('>MSI<'); expect(body).toContain('>v0.11.1 Latest'); // Release health: GitHub's totals for each release, and tickets while it was the latest. expect(body).toMatch(/v0\.11\.1<\/a>.*?2,200<\/td>\s*1<\/td>\s*0\.5<\/td>/s); // Steps too fine for the range are shown but not offered. expect(body).toContain('aria-current="true">3h'); const quarter = (await page('/analytics?range=90d')).body; expect(quarter).toContain('30m'); // The viewer's time zone counts the days. const berlin = await env.server.inject({ method: 'GET', url: `${w()}/analytics`, headers: { ...get(ws.owner).headers, cookie: `${get(ws.owner).headers!.cookie}; tr_tz=Europe/Berlin` } }); expect(berlin.body).toContain('data-an-tz="Europe/Berlin"'); }); it('shows FreeBSD and Web on their own when they have downloads, each in its own colour, most downloaded first', async () => { seed(); repo().releases![0]!.assets!.push({ name: 'photocraft-0.11.1-freebsd-x86_64.tar.gz', downloads: 0 }, { name: 'photocraft-web-0.11.1.zip', downloads: 0 }); await post('/analytics/enabled', { enabled: '1' }); const t0 = slotOf(Date.now()) - 10 * SLOT_MS; await tick(t0); // After the first half hour: the chart leaves the slot recording began in blank, and at 3-hour // steps that slot can close a column, whatever the time of day. await tick(t0 + SLOT_MS); asset('photocraft-0.11.1-windows-x64.msi').downloads += 300; asset('photocraft-0.11.1-linux-x86_64.AppImage').downloads += 50; asset('photocraft-0.11.1-macos-universal.dmg').downloads += 30; asset('photocraft-0.11.1-freebsd-x86_64.tar.gz').downloads += 20; asset('photocraft-web-0.11.1.zip').downloads += 10; await tick(t0 + 2 * SLOT_MS); const body = (await page('/analytics?range=7d')).body; // The chart: Windows, macOS and Linux always, then FreeBSD and Web; no Other without downloads. const chart = body.match(/data-an-chart='([^']*)'/)![1]!.replaceAll('"', '"'); expect(JSON.parse(chart).series.map((s: { name: string; slot: number }) => `${s.name} ${s.slot}`)).toEqual(['Windows 1', 'macOS 2', 'Linux 3', 'FreeBSD 5', 'Web 6']); // Platforms: only what was downloaded, most first (Linux above macOS here), in the same colours. const bars = body.match(/aria-labelledby="an-pl-h">[\s\S]*?data-an-hbar='([^']*)'/)![1]!.replaceAll('"', '"'); expect(JSON.parse(bars).items.map((b: { label: string; value: number; slot: number }) => `${b.label} ${b.value} ${b.slot}`)).toEqual(['Windows 300 1', 'Linux 50 3', 'macOS 30 2', 'FreeBSD 20 5', 'Web 10 6']); }); it('All shows totals since the beginning: GitHub’s own download and star totals, no timeline', async () => { await recorded(); await ticket('Export crashes'); const body = (await page('/analytics?range=all')).body; // All comes first, before Today; the steps are greyed out. expect(body).toMatch(/aria-label="Range">All<\/a>Today<\/a>/); expect(body).toContain('class="seg an-steps off"'); expect(body).not.toMatch(/aria-label="Step"[^>]*>(?:(?!<\/nav>).)*Downloads
6,200
All time
'); expect(body).toContain('
Stars
2
'); expect(body).toContain('
Discord tickets
1
'); // No timeline: the comparison by version (one app), no time chart and no Activity. expect(body).toContain('all time · by version'); expect(body).not.toContain('data-an-chart'); expect(body).not.toContain('id="an-act-h"'); expect(body).toContain('id="an-pl-h"'); const starsAll = (await page('/analytics?range=all&metric=stars')).body; expect(starsAll).toContain('all time · by app'); expect(starsAll).toContain('
  • PhotoCraft2
  • '); // Drawn as a bar chart by app.js from these numbers. expect(starsAll).toContain('data-an-hbar=\'{"items":[{"label":"PhotoCraft","value":2,'); }); it('switches the main chart to stars: stars gained over time, and each app’s total', async () => { const t0 = await recorded(); repo().stars!.push({ login: 'cy', at: new Date().toISOString() }); await tick(t0 + 2 * SLOT_MS); const body = (await page('/analytics?range=7d&metric=stars')).body; expect(body).toMatch(/aria-label="Chart">
    Downloads<\/a>Stars<\/a>/); expect(body).toContain('stars gained · PhotoCraft'); expect(body).toMatch(/data-an-chart='[^']*"name":"Stars gained"/); expect(body).toContain('
    Stars
    +1
    '); // Total 3 (GitHub's count), up 1 in the last 7 days. expect(body).toMatch(/Stars by app[\s\S]*?
  • PhotoCraft<\/span>3 \+1<\/span><\/span><\/li>/); expect(body).not.toContain('Stars couldn’t be read'); // The download breakdowns aren't shown; the app picker keeps the stars view. expect(body).not.toContain('id="an-pl-h"'); expect(body).toContain(''); expect((await page('/analytics?range=7d')).body).toContain('id="an-pl-h"'); }); it('is on the Overview and in the sidebar; moderators need access, and Edit to turn it off', async () => { await recorded(); expect((await page('')).body).toContain('Open Analytics'); const mod = await makeAdmin(env, 'mo'); await env.server.inject({ method: 'POST', url: `/invite/${await createInvite(env.db, ws.workspace.id, ws.owner.user.id, 'moderator')}`, ...form(mod) }); await grant(env, ws.workspace.id, mod.user.id, {}); expect((await page('/analytics', mod)).statusCode).toBe(403); await grant(env, ws.workspace.id, mod.user.id, { analytics: 'view' }); const view = await page('/analytics', mod); expect(view.statusCode).toBe(200); expect(view.body).toContain('View only'); expect((await post('/analytics/enabled', { enabled: '0' }, mod)).statusCode).toBe(403); expect((await post('/analytics/enabled', { enabled: '0' })).statusCode).toBe(302); expect((await page('/analytics')).body).toContain('Turn on'); }); });