todos.test.ts

packages/ninety-client/test/todos.test.ts

1. /**
2. * Tests against the real wire shape, captured from the live API.
3. * The fixture is the contract; values are sanitized, structure is untouched.
4. */
6. import { describe, expect, it } from 'vitest'
7. import { toWire, TodosResource } from '../src/resources/todos.js'
8. import { HttpClient } from '../src/http.js'
9. import { Roster } from '../src/roster.js'
10. import {
11. RawTodoSchema,
12. collapseSeries,
13. normalizeTodo,
14. seriesInflation,
15. stripHtml,
16. UNASSIGNED,
17. UNKNOWN_PERSON,
18. type Todo,
19. } from '../src/types.js'
20. import fixture from './fixtures/todos.query.json' with { type: 'json' }
22. const resolve = (id: string | null | undefined) =>
23. !id ? UNASSIGNED : id === '3e894807d73d5a39b03fb411' ? { id, name: 'Ines Carvalho' } : UNKNOWN_PERSON(id)
25. describe('toWire, confirmed against the live API', () => {
26. it('sends page 1 for the first page (page is 1-based)', () => {
27. expect(toWire({}, 0, 25).page).toBe(1)
28. expect(toWire({}, 1, 25).page).toBe(2)
29. })
31. it('does NOT lowercase the sort field', () => {
32. // A live query used sort:"dueDate". Lowercasing it would silently mis-sort.
33. expect(toWire({ sortBy: 'dueDate' }, 0, 25).sort).toBe('dueDate')
34. expect(toWire({}, 0, 25).sort).toBe('dueDate')
35. })
37. it('defaults to open items only', () => {
38. const body = toWire({}, 0, 25)
39. expect(body.completed).toBe(false)
40. expect(body.archived).toBe(false)
41. })
43. it('lets the caller ask for completed items explicitly', () => {
44. expect(toWire({ completed: true }, 0, 25).completed).toBe(true)
45. })
47. it('passes through the confirmed filters and omits the rest', () => {
48. const body = toWire({ teamId: 't1', searchText: 'testimonials', isPersonal: false }, 0, 25)
49. expect(body).toMatchObject({ teamId: 't1', searchText: 'testimonials', isPersonal: false })
50. expect(body).not.toHaveProperty('userId')
51. expect(body).not.toHaveProperty('dueBefore')
52. })
53. })
55. describe('RawTodoSchema against the live fixture', () => {
56. it('parses every row without stripping unknown fields', () => {
57. for (const row of fixture) {
58. const parsed = RawTodoSchema.parse(row)
59. expect(parsed._id).toBeTruthy()
60. expect(parsed).toHaveProperty('userOrdinal') // passthrough kept it
61. }
62. })
63. })
65. describe('normalizeTodo against the live fixture', () => {
66. const todos = fixture.map((r) => normalizeTodo(RawTodoSchema.parse(r), resolve))
68. it('maps the real field names', () => {
69. const t = todos[0]!
70. expect(t.id).toBe('b9954036a9e6c6430fb25939')
71. expect(t.owner.name).toBe('Ines Carvalho')
72. expect(t.teamName).toBe('All Hands')
73. expect(t.dueDate).toBe('2026-08-08T04:59:59.999Z')
74. expect(t.completed).toBe(false)
75. expect(t.repeat).toBe('Weekly')
76. expect(t.seriesId).toBe('c00d32d2dc9473444a1cf427')
77. })
79. it('strips HTML out of the description but keeps the original', () => {
80. const t = todos[0]!
81. expect(t.description).not.toContain('<')
82. expect(t.description).toContain('First item')
83. expect(t.description).toContain('Third & fourth')
84. expect(t.descriptionHtml).toContain('<ul>')
85. })
87. it('never leaks a raw ObjectId as a name', () => {
88. const t = normalizeTodo(RawTodoSchema.parse({ ...fixture[0], userId: 'deadbeef00' }), resolve)
89. expect(t.owner.name).toBe('unknown user')
90. })
92. it('treats "Never" as no recurrence', () => {
93. const t = normalizeTodo(RawTodoSchema.parse({ ...fixture[0], repeat: 'Never' }), resolve)
94. expect(t.repeat).toBeNull()
95. })
96. })
98. describe('stripHtml', () => {
99. it('turns list items into lines', () => {
100. expect(stripHtml('<ul><li>a</li><li>b</li></ul>')).toBe('- a\n- b')
101. })
103. it('decodes the entities Ninety actually emits', () => {
104. expect(stripHtml('A & B')).toBe('A & B')
105. expect(stripHtml('&lt;tag&gt; &quot;q&quot; &#39;s&#39;')).toBe('<tag> "q" \'s\'')
106. })
108. it('drops inline styles without dropping their text', () => {
109. expect(stripHtml('<li style="color: rgba(184, 49, 47, 1)">IMPORTANT</li>')).toBe('- IMPORTANT')
110. })
112. it('handles empty input', () => {
113. expect(stripHtml('')).toBe('')
114. })
115. })
117. describe('collapseSeries and the recurring-to-do double count', () => {
118. const todos = fixture.map((r) => normalizeTodo(RawTodoSchema.parse(r), resolve))
120. it('the fixture really does contain one task twice', () => {
121. expect(todos).toHaveLength(2)
122. expect(new Set(todos.map((t) => t.seriesId)).size).toBe(1)
123. })
125. it('collapses to one row per series', () => {
126. expect(collapseSeries(todos)).toHaveLength(1)
127. })
129. it('keeps the earliest-due occurrence by default, since that is the late one', () => {
130. expect(collapseSeries(todos)[0]!.dueDate).toBe('2026-08-08T04:59:59.999Z')
131. })
133. it('can keep the latest instead', () => {
134. expect(collapseSeries(todos, 'latest')[0]!.dueDate).toBe('2026-08-15T04:59:59.999Z')
135. })
137. it('passes non-recurring to-dos straight through', () => {
138. const oneOff = normalizeTodo(
139. RawTodoSchema.parse({ ...fixture[0], _id: 'x', seriesId: null, repeat: null }),
140. resolve,
141. )
142. expect(collapseSeries([...todos, oneOff])).toHaveLength(2)
143. })
145. it('sorts undated occurrences last rather than treating them as due now', () => {
146. const undated = normalizeTodo(RawTodoSchema.parse({ ...fixture[0], _id: 'y', dueDate: null }), resolve)
147. const kept = collapseSeries([undated, ...todos])[0]!
148. expect(kept.dueDate).toBe('2026-08-08T04:59:59.999Z')
149. })
151. it('reports how much recurrence is inflating the count', () => {
152. expect(seriesInflation(todos)).toEqual({ total: 2, collapsed: 1, duplicates: 1 })
153. })
154. })
156. describe('TodosResource', () => {
157. const http = (fetchImpl: typeof fetch) =>
158. new HttpClient({ token: 't', fetchImpl, sleep: async () => {}, rps: 1000 })
160. const respond = (body: unknown) =>
161. new Response(JSON.stringify(body), { status: 200, headers: { 'Content-Type': 'application/json' } })
163. it('harvests createdBy names for free instead of fetching them', async () => {
164. let userCalls = 0
165. const fetchImpl = (async (url: string | URL | Request) => {
166. const u = String(url)
167. if (u.includes('/users/')) {
168. userCalls++
169. return respond({ _id: 'x', fullName: 'Fetched Name' })
170. }
171. return respond(fixture)
172. }) as unknown as typeof fetch
174. const h = http(fetchImpl)
175. const roster = new Roster(h)
176. const todos = new TodosResource(h, roster)
177. const page = await todos.query({ pageSize: 100 })
179. expect(page.items[0]!.createdBy.name).toBe('Sample Creator')
180. // The creator came free from the payload; only the owner needed a request.
181. expect(userCalls).toBe(1)
182. expect(roster.stats().noted).toBe(1)
183. })
185. it('filters out soft-deleted rows', async () => {
186. const withDeleted = [{ ...fixture[0], deleted: true }, fixture[1]]
187. const fetchImpl = (async (url: string | URL | Request) =>
188. String(url).includes('/users/') ? respond({ _id: 'u', fullName: 'U' }) : respond(withDeleted)) as unknown as typeof fetch
190. const h = http(fetchImpl)
191. const out = await new TodosResource(h, new Roster(h)).list()
192. expect(out).toHaveLength(1)
193. expect(out[0]!.id).toBe('37c62dc317911ffcf43dc486')
194. })
196. it('applies the unconfirmed owner filter client-side', async () => {
197. const mixed = [fixture[0], { ...fixture[1], userId: 'someone-else' }]
198. const fetchImpl = (async (url: string | URL | Request) =>
199. String(url).includes('/users/') ? respond({ _id: 'u', fullName: 'U' }) : respond(mixed)) as unknown as typeof fetch
201. const h = http(fetchImpl)
202. const out = await new TodosResource(h, new Roster(h)).list({ userId: '3e894807d73d5a39b03fb411' })
203. expect(out).toHaveLength(1)
204. })
205. })
207. describe('the dashboard invariant', () => {
208. it('no rendered field ever contains a bare ObjectId', () => {
209. const todos: Todo[] = fixture.map((r) => normalizeTodo(RawTodoSchema.parse(r), () => UNKNOWN_PERSON('x')))
210. for (const t of todos) {
211. expect(t.owner.name).not.toMatch(/^[0-9a-f]{24}$/)
212. expect(t.createdBy.name).not.toMatch(/^[0-9a-f]{24}$/)
213. }
214. })
215. })