| 1 | import assert from "node:assert/strict"; |
| 2 | import { test } from "node:test"; |
| 3 | |
| 4 | import type { ItemRepo } from "@g1t/contracts"; |
| 5 | |
| 6 | import { |
| 7 | closeSubItemsOf, |
| 8 | filterCount, |
| 9 | emptyListTitle, |
| 10 | filtered, |
| 11 | itemNumberOf, |
| 12 | listPage, |
| 13 | movedWorkPath, |
| 14 | newItemPath, |
| 15 | pageQuery, |
| 16 | repoChips, |
| 17 | repoFilter, |
| 18 | repoWorkPath, |
| 19 | movedSessionsPath, |
| 20 | sessionPath, |
| 21 | sessionsPath, |
| 22 | shortPath, |
| 23 | subItemsDone, |
| 24 | subItemsShare, |
| 25 | workFilters, |
| 26 | workListPath, |
| 27 | workQuery, |
| 28 | } from "./work-items.ts"; |
| 29 | |
| 30 | const query = (text: string) => new URLSearchParams(text); |
| 31 | |
| 32 | test("the Work list's filters come from its address", () => { |
| 33 | assert.deepEqual(workFilters(query("")), { state: "open", horizon: null, label: "", milestone: null, assignee: "", repo: "", role: null, parent: null, project: "" }); |
| 34 | assert.deepEqual(workFilters(query("state=closed&label=Bug&milestone=3&assignee=ana&repo=web&role=target")), { |
| 35 | state: "closed", |
| 36 | horizon: null, |
| 37 | label: "bug", |
| 38 | milestone: 3, |
| 39 | assignee: "ana", |
| 40 | repo: "web", |
| 41 | role: "target", |
| 42 | parent: null, |
| 43 | project: "", |
| 44 | }); |
| 45 | // The same written as a query, which wins over the plain parameters. |
| 46 | assert.deepEqual(workFilters(query("label=docs&q=is:closed label:bug repo:acme/api role:origin assignee:@bo")), { |
| 47 | state: "closed", |
| 48 | horizon: null, |
| 49 | label: "bug", |
| 50 | milestone: null, |
| 51 | assignee: "bo", |
| 52 | repo: "acme/api", |
| 53 | role: "origin", |
| 54 | parent: null, |
| 55 | project: "", |
| 56 | }); |
| 57 | // A role says how a repository is linked: without one it is dropped, and an unknown one is none. |
| 58 | assert.equal(workFilters(query("role=target")).role, null); |
| 59 | assert.equal(workFilters(query("repo=web&role=owner")).role, null); |
| 60 | // `@me` is kept for the page to read as the viewer. |
| 61 | assert.equal(workFilters(query("assignee=@me")).assignee, "@me"); |
| 62 | // A project, by its slug. |
| 63 | assert.equal(workFilters(query("project=Work-Overhaul")).project, "work-overhaul"); |
| 64 | assert.equal(workFilters(query("q=project:mobile")).project, "mobile"); |
| 65 | }); |
| 66 | |
| 67 | test("a horizon of the plan filters the list, written as a parameter or in the query, with a milestone too", () => { |
| 68 | assert.equal(workFilters(query("horizon=now")).horizon, "now"); |
| 69 | assert.equal(workFilters(query("q=horizon:Next")).horizon, "next"); |
| 70 | assert.equal(workFilters(query("q=is:triage")).horizon, "triage"); |
| 71 | assert.equal(workFilters(query("q=horizon:set-aside")).horizon, "set_aside"); |
| 72 | assert.equal(workFilters(query("horizon=soon")).horizon, null); |
| 73 | // A horizon holds only open work items. |
| 74 | assert.deepEqual(workFilters(query("state=closed&horizon=now")).state, "open"); |
| 75 | const both = workFilters(query("q=horizon:next milestone:3")); |
| 76 | assert.deepEqual([both.horizon, both.milestone], ["next", 3]); |
| 77 | assert.equal(workQuery(both), "horizon=next&milestone=3"); |
| 78 | assert.equal(workListPath("acme", both, { horizon: null }), "/acme/-/work/all?milestone=3"); |
| 79 | assert.equal(filterCount(both), 2); |
| 80 | assert.equal(emptyListTitle(workFilters(query("horizon=now")), null), "Nothing in Now"); |
| 81 | assert.equal(emptyListTitle(both, null), "No open work items match these filters"); |
| 82 | }); |
| 83 | |
| 84 | test("the list pages down by the lowest number shown, and back up one page at a time", () => { |
| 85 | const filters = workFilters(query("label=bug")); |
| 86 | const first = listPage(query("label=bug")); |
| 87 | assert.deepEqual(first, { before: null, newer: [] }); |
| 88 | assert.equal(pageQuery(filters, first, { older: 420 }), "?label=bug&before=420"); |
| 89 | const second = listPage(query("label=bug&before=420")); |
| 90 | assert.deepEqual(second, { before: 420, newer: [] }); |
| 91 | assert.equal(pageQuery(filters, second, { older: 300 }), "?label=bug&before=300&newer=420"); |
| 92 | const third = listPage(query("before=300&newer=420")); |
| 93 | assert.equal(pageQuery(filters, third, { older: 180 }), "?label=bug&before=180&newer=420.300"); |
| 94 | // Newer: one page up, to the first page from the second. |
| 95 | assert.equal(pageQuery(filters, listPage(query("before=180&newer=420.300")), "newer"), "?label=bug&before=300&newer=420"); |
| 96 | assert.equal(pageQuery(filters, third, "newer"), "?label=bug&before=420"); |
| 97 | assert.equal(pageQuery(filters, second, "newer"), "?label=bug"); |
| 98 | // Nonsense, or a page above that is not above, is dropped. |
| 99 | assert.deepEqual(listPage(query("before=x&newer=500")), { before: null, newer: [] }); |
| 100 | assert.deepEqual(listPage(query("before=300&newer=200.abc.400")), { before: 300, newer: [400] }); |
| 101 | }); |
| 102 | |
| 103 | test("the filters go back into the address in one order, leaving out what is unset", () => { |
| 104 | assert.equal(workQuery({ state: "open" }), ""); |
| 105 | assert.equal( |
| 106 | workQuery({ state: "closed", label: "bug", repo: "web", role: "target", milestone: 2, assignee: "ana" }), |
| 107 | "state=closed&repo=web&role=target&label=bug&milestone=2&assignee=ana", |
| 108 | ); |
| 109 | // A role without a repository means nothing. |
| 110 | assert.equal(workQuery({ role: "target" }), ""); |
| 111 | const current = workFilters(query("repo=web&label=bug")); |
| 112 | assert.equal(workListPath("Acme", current), "/acme/-/work/all?repo=web&label=bug"); |
| 113 | assert.equal(workListPath("acme", current, { label: "" }), "/acme/-/work/all?repo=web"); |
| 114 | assert.equal(workListPath("acme", current, { repo: "", role: null }), "/acme/-/work/all?label=bug"); |
| 115 | assert.equal(workListPath("acme", current, { state: "closed" }), "/acme/-/work/all?state=closed&repo=web&label=bug"); |
| 116 | }); |
| 117 | |
| 118 | test("how many filters are on, for the phone's Filters button", () => { |
| 119 | assert.equal(filterCount(workFilters(query("state=closed"))), 0); |
| 120 | assert.equal(filtered(workFilters(query("state=closed"))), false); |
| 121 | assert.equal(filterCount(workFilters(query("repo=web&role=target&label=bug&assignee=ana"))), 3); |
| 122 | assert.equal(filtered(workFilters(query("milestone=1"))), true); |
| 123 | }); |
| 124 | |
| 125 | test("the list filters to one item's sub-items, written as parent:N or parent:#N", () => { |
| 126 | assert.equal(workFilters(query("parent=212")).parent, 212); |
| 127 | assert.equal(workFilters(query("q=parent:212")).parent, 212); |
| 128 | assert.equal(workFilters(query("q=is:closed parent:#212")).parent, 212); |
| 129 | // The query wins, and what is not a number is no filter. |
| 130 | assert.equal(workFilters(query("parent=5&q=parent:#7")).parent, 7); |
| 131 | assert.equal(workFilters(query("q=parent:abc")).parent, null); |
| 132 | assert.equal(workFilters(query("parent=0")).parent, null); |
| 133 | const subs = workFilters(query("q=parent:#212")); |
| 134 | assert.equal(workQuery(subs), "parent=212"); |
| 135 | assert.equal(workListPath("acme", subs, { parent: null }), "/acme/-/work/all"); |
| 136 | assert.equal(filterCount(subs), 1); |
| 137 | assert.equal(filtered(subs), true); |
| 138 | assert.equal(emptyListTitle(subs, null), "No open sub-items of #212"); |
| 139 | assert.equal(emptyListTitle(workFilters(query("parent=212&label=bug")), null), "No open work items match these filters"); |
| 140 | }); |
| 141 | |
| 142 | test("a work item's number as a person types it", () => { |
| 143 | assert.equal(itemNumberOf("#212"), 212); |
| 144 | assert.equal(itemNumberOf(" 212 "), 212); |
| 145 | assert.equal(itemNumberOf(""), null); |
| 146 | assert.equal(itemNumberOf(undefined), null); |
| 147 | assert.equal(itemNumberOf("#"), null); |
| 148 | assert.equal(itemNumberOf("12a"), undefined); |
| 149 | assert.equal(itemNumberOf("0"), undefined); |
| 150 | }); |
| 151 | |
| 152 | test("a parent's progress, and what closing it does with its open sub-items", () => { |
| 153 | assert.equal(subItemsDone({ done: 3, total: 7 }), "3 of 7 done"); |
| 154 | assert.equal(subItemsShare({ done: 3, total: 7 }), 43); |
| 155 | assert.equal(subItemsShare({ done: 0, total: 0 }), 0); |
| 156 | const form = (fields: Record<string, string>) => new URLSearchParams(fields); |
| 157 | assert.equal(closeSubItemsOf(form({})), null); |
| 158 | assert.deepEqual(closeSubItemsOf(form({ sub_items: "leave" })), { subItems: "leave" }); |
| 159 | assert.deepEqual(closeSubItemsOf(form({ sub_items: "close", move_to: "9" })), { subItems: "close" }); |
| 160 | assert.deepEqual(closeSubItemsOf(form({ sub_items: "move", move_to: "#212" })), { subItems: "move", moveTo: 212 }); |
| 161 | assert.equal(typeof closeSubItemsOf(form({ sub_items: "move", move_to: "" })), "string"); |
| 162 | assert.equal(closeSubItemsOf(form({ sub_items: "drop" })), null); |
| 163 | }); |
| 164 | |
| 165 | test("a repository's Work tab, and a new work item filed from it", () => { |
| 166 | assert.equal(repoWorkPath("acme", "web"), "/acme/-/work/all?repo=web"); |
| 167 | assert.equal(sessionsPath("Acme"), "/acme/-/chat/sessions"); |
| 168 | assert.equal(sessionsPath("acme", { repo: "web", person: null }), "/acme/-/chat/sessions?repo=web"); |
| 169 | assert.equal(sessionPath("Acme", "ses_1"), "/acme/-/chat/sessions/ses_1"); |
| 170 | assert.equal(newItemPath("Acme"), "/acme/-/work/new"); |
| 171 | assert.equal(newItemPath("acme", "web"), "/acme/-/work/new?repo=web"); |
| 172 | assert.equal(newItemPath("acme", "web", 212), "/acme/-/work/new?repo=web&parent=212"); |
| 173 | assert.equal(newItemPath("acme", null, 212), "/acme/-/work/new?parent=212"); |
| 174 | assert.deepEqual(repoFilter("acme", "web"), { namespace: "acme", name: "web" }); |
| 175 | |
| 176 | test("sessions' addresses from when they were Work's go to Chat, filters and all", () => { |
| 177 | assert.equal(movedSessionsPath("/Acme/-/work/sessions"), "/acme/-/chat/sessions"); |
| 178 | assert.equal(movedSessionsPath("/acme/-/work/sessions/", "?state=recent"), "/acme/-/chat/sessions?state=recent"); |
| 179 | assert.equal(movedSessionsPath("/acme/-/work/sessions/ses_1"), "/acme/-/chat/sessions/ses_1"); |
| 180 | assert.equal(movedSessionsPath("/acme/-/work/sessions/ses_1/entries"), null); |
| 181 | assert.equal(movedSessionsPath("/acme/-/work"), null); |
| 182 | }); |
| 183 | assert.deepEqual(repoFilter("acme", "Beta/api"), { namespace: "beta", name: "api" }); |
| 184 | assert.equal(repoFilter("acme", "a/b/c"), null); |
| 185 | assert.equal(shortPath("acme/web", "acme"), "web"); |
| 186 | assert.equal(shortPath("beta/web", "acme"), "beta/web"); |
| 187 | }); |
| 188 | |
| 189 | test("an item's repositories fit a phone: two, then how many more", () => { |
| 190 | const repo = (path: string, role: ItemRepo["role"]): ItemRepo => ({ repoId: path, path, role, legacyNumber: null, landed: false }); |
| 191 | const repos = [repo("acme/web", "origin"), repo("acme/api", "target"), repo("acme/docs", "target"), repo("acme/cli", "touched")]; |
| 192 | assert.deepEqual(repoChips(repos), { shown: repos.slice(0, 2), more: 2 }); |
| 193 | assert.deepEqual(repoChips(repos.slice(0, 1)), { shown: repos.slice(0, 1), more: 0 }); |
| 194 | assert.deepEqual(repoChips([]), { shown: [], more: 0 }); |
| 195 | }); |
| 196 | |
| 197 | test("old addresses of a repository's issues, labels, milestones and Work page lead on", () => { |
| 198 | assert.equal(movedWorkPath("/acme/web/issues"), "/acme/-/work/all?repo=web"); |
| 199 | // Its filters come along. |
| 200 | assert.equal(movedWorkPath("/Acme/web/issues", "?state=closed&label=bug&_routes=x"), "/acme/-/work/all?repo=web&state=closed&label=bug"); |
| 201 | assert.equal(movedWorkPath("/acme/web/issues/new"), "/acme/-/work/new?repo=web"); |
| 202 | // An old issue's number is read in the repository, which only the work service can do. |
| 203 | assert.deepEqual(movedWorkPath("/acme/web/issues/12"), { resolve: 12 }); |
| 204 | assert.deepEqual(movedWorkPath("/acme/web/issues/12.data"), { resolve: 12 }); |
| 205 | assert.equal(movedWorkPath("/acme/web/issues/0"), null); |
| 206 | assert.equal(movedWorkPath("/acme/web/issues/x"), null); |
| 207 | assert.equal(movedWorkPath("/acme/web/issues/12/extra"), null); |
| 208 | assert.equal(movedWorkPath("/acme/web/labels"), "/acme/-/work/labels"); |
| 209 | // Milestones were numbered again in the workspace: an old one leads to the list. |
| 210 | assert.equal(movedWorkPath("/acme/web/milestones"), "/acme/-/work/milestones"); |
| 211 | assert.equal(movedWorkPath("/acme/web/milestones/3"), "/acme/-/work/milestones"); |
| 212 | // A repository's old Work and Sessions pages are gone: Sessions is the workspace's. |
| 213 | assert.equal(movedWorkPath("/acme/web/work"), null); |
| 214 | assert.equal(movedWorkPath("/acme/web/work/sessions/ses_123"), null); |
| 215 | assert.equal(movedWorkPath("/acme/web/pulls"), null); |
| 216 | assert.equal(movedWorkPath("/acme/-/issues"), null); |
| 217 | }); |
| 218 | |
| 219 | test("an empty Work list names the repository it is filtered to, when that is all it is filtered by", () => { |
| 220 | const query = (text: string) => workFilters(new URLSearchParams(text)); |
| 221 | assert.equal(emptyListTitle(query("repo=web"), "web"), "No open work items linked to web"); |
| 222 | assert.equal(emptyListTitle(query("repo=web&state=closed&role=target"), "web"), "No closed work items linked to web"); |
| 223 | assert.equal(emptyListTitle(query("repo=web&label=bug"), "web"), "No open work items match these filters"); |
| 224 | assert.equal(emptyListTitle(query("label=bug"), null), "No open work items match these filters"); |
| 225 | assert.equal(emptyListTitle(query(""), null), "No open work items"); |
| 226 | assert.equal(emptyListTitle(query("state=closed"), null), "No closed work items"); |
| 227 | }); |