Lucas WintherandClaude Opus 5.5
e7ee43f92d
Weekly chores like 2,100 activity points are a number, not a count of days, and monthly ones need a month. The status shape now carries its measure and period start, so tasks can reuse it whole. Co-Authored-By: Claude Opus 5.5 <[email protected]>
282 lines
11 KiB
TypeScript
282 lines
11 KiB
TypeScript
import { describe, expect, test } from "bun:test";
|
||
import {
|
||
clampRequired,
|
||
goalCaption,
|
||
goalCount,
|
||
goalLabel,
|
||
goalRequired,
|
||
goalStatus,
|
||
readGoal,
|
||
type Goal,
|
||
type GoalStatus,
|
||
} from "../src/shared/goal.ts";
|
||
|
||
/**
|
||
* Check-in goals: N distinct game-days per week or across an event, rather than
|
||
* every day. The owner's case is Genshin's “To Temper Thyself and Journey
|
||
* Far” — five of seven, weeks from Monday — and these dates are that event's.
|
||
*/
|
||
|
||
// Genshin, Europe: the day rolls at 03:00Z. Noon is safely inside a game-day.
|
||
const noon = (key: string) => Date.parse(`${key}T12:00:00Z`);
|
||
const START = Date.parse("2026-08-10T03:00:00Z"); // Monday's reset
|
||
const END = Date.parse("2026-11-02T03:00:00Z"); // twelve weeks later
|
||
const weekly: Goal = { period: "week", measure: "days", required: 5, weekStartsOn: 1 };
|
||
const base = { startsMs: START, endsMs: END, region: "europe" as const, game: "genshin" };
|
||
|
||
describe("readGoal", () => {
|
||
test("reads a valid goal", () => {
|
||
expect(readGoal(weekly)).toEqual(weekly);
|
||
});
|
||
|
||
test("absent, malformed or future-shaped is undefined, and never throws", () => {
|
||
expect(readGoal(undefined)).toBeUndefined();
|
||
expect(readGoal({ period: "week", required: 9 })).toBeUndefined();
|
||
// A shape no version yet writes stands in for "newer than this build".
|
||
expect(readGoal({ period: "fortnight", measure: "streak", required: 3 })).toBeUndefined();
|
||
expect(readGoal("five")).toBeUndefined();
|
||
});
|
||
});
|
||
|
||
describe("goalStatus: each week", () => {
|
||
test("three distinct ticks this week read 3 of 5", () => {
|
||
const s = goalStatus({
|
||
...base, goal: weekly, now: noon("2026-10-15"),
|
||
logged: ["2026-10-12", "2026-10-13", "2026-10-15"],
|
||
});
|
||
expect(s).toMatchObject({ scope: "week", count: 3, required: 5, met: false, needed: 2 });
|
||
// Today (Thu) is ticked; Fri, Sat and Sun remain.
|
||
expect(s.open).toBe(3);
|
||
expect(s.shortfall).toBe(false);
|
||
});
|
||
|
||
test("five non-consecutive days meet the week", () => {
|
||
const s = goalStatus({
|
||
...base, goal: weekly, now: noon("2026-10-18"),
|
||
logged: ["2026-10-12", "2026-10-14", "2026-10-15", "2026-10-17", "2026-10-18"],
|
||
});
|
||
expect(s.met).toBe(true);
|
||
expect(s.needed).toBe(0);
|
||
});
|
||
|
||
test("last week's ticks and backfills never count toward this week", () => {
|
||
const s = goalStatus({
|
||
...base, goal: weekly, now: noon("2026-10-19"),
|
||
logged: ["2026-10-12", "2026-10-14", "2026-10-15", "2026-10-17", "2026-10-18"],
|
||
});
|
||
expect(s.count).toBe(0);
|
||
expect(s.met).toBe(false);
|
||
});
|
||
|
||
test("a future tick never counts", () => {
|
||
const s = goalStatus({
|
||
...base, goal: weekly, now: noon("2026-10-13"),
|
||
logged: ["2026-10-12", "2026-10-16"],
|
||
});
|
||
expect(s.count).toBe(1);
|
||
});
|
||
|
||
test("removing a tick below target unmeets the week", () => {
|
||
const five = ["2026-10-12", "2026-10-13", "2026-10-14", "2026-10-15", "2026-10-16"];
|
||
const now = noon("2026-10-16");
|
||
expect(goalStatus({ ...base, goal: weekly, now, logged: five }).met).toBe(true);
|
||
expect(goalStatus({ ...base, goal: weekly, now, logged: five.slice(1) }).met).toBe(false);
|
||
});
|
||
|
||
test("a short last week keeps its target and reports the shortfall", () => {
|
||
// An event ending Thursday 29 Oct at reset: its last week is Mon–Wed.
|
||
const s = goalStatus({
|
||
...base, endsMs: Date.parse("2026-10-29T03:00:00Z"), goal: weekly,
|
||
now: noon("2026-10-27"), logged: ["2026-10-26"],
|
||
});
|
||
expect(s.required).toBe(5);
|
||
expect(s.needed).toBe(4);
|
||
expect(s.open).toBe(2); // Tue 27 and Wed 28
|
||
expect(s.shortfall).toBe(true);
|
||
});
|
||
|
||
test("the first week is cut at the event start, not padded", () => {
|
||
// An event opening on Thursday: Mon–Wed were never claimable.
|
||
const s = goalStatus({
|
||
...base, startsMs: Date.parse("2026-10-15T03:00:00Z"), goal: weekly,
|
||
now: noon("2026-10-15"), logged: ["2026-10-12", "2026-10-15"],
|
||
});
|
||
expect(s.count).toBe(1); // the Monday tick predates the event
|
||
expect(s.open).toBe(3); // Fri, Sat, Sun
|
||
expect(s.shortfall).toBe(true);
|
||
});
|
||
|
||
test("an unknown end still has this week's boundary", () => {
|
||
const s = goalStatus({
|
||
...base, endsMs: null, goal: weekly, now: noon("2026-10-15"), logged: [],
|
||
});
|
||
expect(s.open).toBe(4);
|
||
});
|
||
|
||
test("before the event starts, nothing counts and nothing is negative", () => {
|
||
const s = goalStatus({
|
||
...base, goal: weekly, now: noon("2026-08-05"), logged: ["2026-08-05"],
|
||
});
|
||
expect(s.count).toBe(0);
|
||
expect(s.needed).toBe(5);
|
||
});
|
||
});
|
||
|
||
describe("goalStatus: across the event", () => {
|
||
const seven = {
|
||
...base,
|
||
startsMs: Date.parse("2026-10-12T03:00:00Z"),
|
||
endsMs: Date.parse("2026-10-19T03:00:00Z"),
|
||
};
|
||
const total: Goal = { period: "event", measure: "days", required: 5 };
|
||
|
||
test("reaches its target on the fifth recorded day", () => {
|
||
const logged = ["2026-10-12", "2026-10-13", "2026-10-14", "2026-10-15"];
|
||
expect(goalStatus({ ...seven, goal: total, now: noon("2026-10-15"), logged }).met).toBe(
|
||
false,
|
||
);
|
||
const s = goalStatus({
|
||
...seven, goal: total, now: noon("2026-10-16"), logged: [...logged, "2026-10-16"],
|
||
});
|
||
expect(s).toMatchObject({ scope: "event", count: 5, met: true });
|
||
});
|
||
|
||
test("an unknown end counts ticks but cannot say how many days are left", () => {
|
||
const s = goalStatus({
|
||
...seven, endsMs: null, goal: total, now: noon("2026-10-14"),
|
||
logged: ["2026-10-12", "2026-10-14", "2026-10-20"],
|
||
});
|
||
expect(s.count).toBe(2);
|
||
expect(s.open).toBeNull();
|
||
expect(s.shortfall).toBe(false);
|
||
});
|
||
|
||
test("a tick outside the window does not count", () => {
|
||
const s = goalStatus({
|
||
...seven, goal: total, now: noon("2026-10-14"), logged: ["2026-10-11", "2026-10-13"],
|
||
});
|
||
expect(s.count).toBe(1);
|
||
});
|
||
});
|
||
|
||
describe("copy", () => {
|
||
const status = (over: Partial<GoalStatus>): GoalStatus => ({
|
||
scope: "week", measure: "days", periodStart: "2026-10-12", required: 5, count: 3,
|
||
met: false, needed: 2, open: 4, shortfall: false, ...over,
|
||
});
|
||
|
||
test("captions", () => {
|
||
expect(goalCaption(status({}))).toBe("3 of 5 this week · 2 needed · 4 days left this week");
|
||
expect(goalCaption(status({ open: 1, shortfall: true }))).toBe(
|
||
"3 of 5 this week · 2 needed, 1 day left this week",
|
||
);
|
||
expect(goalCaption(status({ count: 5, met: true, needed: 0 }))).toBe(
|
||
"5 of 5 · Done this week",
|
||
);
|
||
expect(goalCaption(status({ scope: "event", open: 9 }))).toBe(
|
||
"3 of 5 · 2 needed · 9 days left",
|
||
);
|
||
expect(goalCaption(status({ scope: "event", open: null }))).toBe("3 of 5 · 2 needed");
|
||
expect(goalCaption(status({ scope: "event", count: 5, met: true, needed: 0 }))).toBe(
|
||
"5 of 5 · Goal reached",
|
||
);
|
||
});
|
||
|
||
test("chip count and spoken state", () => {
|
||
expect(goalCount(status({}))).toBe("3/5 wk");
|
||
expect(goalCount(status({ scope: "event" }))).toBe("3/5");
|
||
expect(goalLabel(status({}))).toBe("3 of 5 this week");
|
||
expect(goalLabel(status({ met: true }))).toBe("done this week");
|
||
expect(goalLabel(status({ scope: "event", met: true }))).toBe("goal reached");
|
||
expect(goalLabel(status({ scope: "event" }))).toBe("3 of 5");
|
||
});
|
||
});
|
||
|
||
describe("clampRequired", () => {
|
||
test("weekly is 1–7; event-wide is capped by the known days", () => {
|
||
expect(clampRequired("week", 9, null)).toBe(7);
|
||
expect(clampRequired("week", 0, null)).toBe(1);
|
||
expect(clampRequired("event", 30, 14)).toBe(14);
|
||
expect(clampRequired("event", 30, null)).toBe(30);
|
||
expect(clampRequired("event", Number.NaN, 14)).toBe(1);
|
||
});
|
||
});
|
||
|
||
describe("amount goals", () => {
|
||
const points: Goal = { period: "week", measure: "amount", target: 2100, weekStartsOn: 1 };
|
||
const amounts = {
|
||
"2026-10-05": { value: 2100, at: "2026-10-11T12:00:00.000Z" },
|
||
"2026-10-12": { value: 1900, at: "2026-10-15T12:00:00.000Z" },
|
||
};
|
||
|
||
test("reads amount shapes, and still refuses one with no target", () => {
|
||
expect(readGoal(points)).toEqual(points);
|
||
expect(readGoal({ period: "week", measure: "amount", weekStartsOn: 1 })).toBeUndefined();
|
||
expect(readGoal({ period: "event", measure: "amount", target: 0 })).toBeUndefined();
|
||
});
|
||
|
||
test("counts this week's stored value, not last week's", () => {
|
||
const s = goalStatus({ ...base, goal: points, now: noon("2026-10-15"), logged: [], amounts });
|
||
expect(s).toMatchObject({
|
||
measure: "amount", scope: "week", periodStart: "2026-10-12",
|
||
count: 1900, required: 2100, met: false, needed: 200, shortfall: false,
|
||
});
|
||
});
|
||
|
||
test("a new week starts at nothing", () => {
|
||
const s = goalStatus({ ...base, goal: points, now: noon("2026-10-19"), logged: [], amounts });
|
||
expect(s.count).toBe(0);
|
||
expect(s.periodStart).toBe("2026-10-19");
|
||
});
|
||
|
||
test("met at or above the target", () => {
|
||
const s = goalStatus({ ...base, goal: points, now: noon("2026-10-11"), logged: [], amounts });
|
||
expect(s.met).toBe(true);
|
||
});
|
||
|
||
test("an event-wide amount is keyed by the event's first game-day", () => {
|
||
const s = goalStatus({
|
||
...base, goal: { period: "event", measure: "amount", target: 500 },
|
||
now: noon("2026-10-15"), logged: [],
|
||
amounts: { "2026-08-10": { value: 600, at: "2026-10-15T12:00:00.000Z" } },
|
||
});
|
||
expect(s).toMatchObject({ scope: "event", periodStart: "2026-08-10", count: 600, met: true });
|
||
});
|
||
|
||
test("days goals report their measure and period start too", () => {
|
||
const s = goalStatus({ ...base, goal: weekly, now: noon("2026-10-15"), logged: [] });
|
||
expect(s).toMatchObject({ measure: "days", periodStart: "2026-10-12" });
|
||
});
|
||
});
|
||
|
||
describe("copy for amounts and months", () => {
|
||
const status = (over: Partial<GoalStatus>): GoalStatus => ({
|
||
scope: "week", measure: "amount", periodStart: "2026-10-12", required: 2100,
|
||
count: 1900, met: false, needed: 200, open: 4, shortfall: false, ...over,
|
||
});
|
||
|
||
test("amount captions, counts and labels group thousands", () => {
|
||
expect(goalCaption(status({}))).toBe("1,900 of 2,100 this week · 200 to go");
|
||
expect(goalCaption(status({ count: 2100, met: true, needed: 0 }))).toBe(
|
||
"2,100 of 2,100 · Done this week",
|
||
);
|
||
expect(goalCount(status({}))).toBe("1,900/2,100 wk");
|
||
expect(goalLabel(status({}))).toBe("1,900 of 2,100 this week");
|
||
});
|
||
|
||
test("month scope", () => {
|
||
const month = status({ scope: "month", measure: "days", required: 1, count: 0, needed: 1 });
|
||
expect(goalCount(month)).toBe("0/1 mo");
|
||
expect(goalLabel(month)).toBe("0 of 1 this month");
|
||
expect(goalLabel({ ...month, count: 1, met: true, needed: 0 })).toBe("done this month");
|
||
expect(goalCaption({ ...month, count: 1, met: true, needed: 0 })).toBe(
|
||
"1 of 1 · Done this month",
|
||
);
|
||
});
|
||
|
||
test("goalRequired reads either measure", () => {
|
||
expect(goalRequired(weekly)).toBe(5);
|
||
expect(goalRequired({ period: "event", measure: "amount", target: 2100 })).toBe(2100);
|
||
});
|
||
});
|