ReviewOS

also looking at this

stacks/stx

chore: wip stx improvements

#1649
Merged fingersandmind wants to merge feat/stx-improvements into main
241 files +19022 -1323
packages/analytics/test/storage.test.tsadded+250-0
Changes to packages/analytics/test/storage.test.ts
@@ -0,0 +1,250 @@
1import { describe, expect, test } from 'bun:test'
2import { MemoryAnalyticsStorage } from '../src/storage/memory'
3import type { AnalyticsEvent, PageView } from '../src/types'
4
5function makePageView(overrides: Partial<PageView> = {}): PageView {
6 return {
7 id: crypto.randomUUID(),
8 path: '/home',
9 timestamp: Date.now(),
10 ...overrides,
11 }
12}
13
14function makeEvent(overrides: Partial<AnalyticsEvent> = {}): AnalyticsEvent {
15 return {
16 id: crypto.randomUUID(),
17 name: 'click',
18 timestamp: Date.now(),
19 ...overrides,
20 }
21}
22
23describe('MemoryAnalyticsStorage', () => {
24 test('savePageView and getPageViews', async () => {
25 const storage = new MemoryAnalyticsStorage()
26 const view = makePageView()
27 await storage.savePageView(view)
28
29 const views = await storage.getPageViews()
30 expect(views).toHaveLength(1)
31 expect(views[0].path).toBe('/home')
32 })
33
34 test('saveEvent and getEvents', async () => {
35 const storage = new MemoryAnalyticsStorage()
36 const event = makeEvent({ name: 'signup' })
37 await storage.saveEvent(event)
38
39 const events = await storage.getEvents()
40 expect(events).toHaveLength(1)
41 expect(events[0].name).toBe('signup')
42 })
43
44 test('count returns total of page views and events', async () => {
45 const storage = new MemoryAnalyticsStorage()
46 await storage.savePageView(makePageView())
47 await storage.savePageView(makePageView())
48 await storage.saveEvent(makeEvent())
49
50 expect(await storage.count()).toBe(3)
51 })
52
53 test('clear removes all data', async () => {
54 const storage = new MemoryAnalyticsStorage()
55 await storage.savePageView(makePageView())
56 await storage.saveEvent(makeEvent())
57 await storage.clear()
58
59 expect(await storage.count()).toBe(0)
60 expect(await storage.getPageViews()).toHaveLength(0)
61 expect(await storage.getEvents()).toHaveLength(0)
62 })
63
64 test('getPageViews filters by date range', async () => {
65 const storage = new MemoryAnalyticsStorage()
66 const now = Date.now()
67 await storage.savePageView(makePageView({ timestamp: now - 86400000 * 3 })) // 3 days ago
68 await storage.savePageView(makePageView({ timestamp: now - 86400000 })) // 1 day ago
69 await storage.savePageView(makePageView({ timestamp: now }))
70
71 const views = await storage.getPageViews({
72 from: new Date(now - 86400000 * 2),
73 to: new Date(now + 1000),
74 })
75 expect(views).toHaveLength(2)
76 })
77
78 test('getPageViews filters by path', async () => {
79 const storage = new MemoryAnalyticsStorage()
80 await storage.savePageView(makePageView({ path: '/about' }))
81 await storage.savePageView(makePageView({ path: '/home' }))
82 await storage.savePageView(makePageView({ path: '/about' }))
83
84 const views = await storage.getPageViews({ path: '/about' })
85 expect(views).toHaveLength(2)
86 })
87
88 test('getPageViews respects limit', async () => {
89 const storage = new MemoryAnalyticsStorage()
90 await storage.savePageView(makePageView())
91 await storage.savePageView(makePageView())
92 await storage.savePageView(makePageView())
93
94 const views = await storage.getPageViews({ limit: 2 })
95 expect(views).toHaveLength(2)
96 })
97
98 test('getEvents filters by event name', async () => {
99 const storage = new MemoryAnalyticsStorage()
100 await storage.saveEvent(makeEvent({ name: 'click' }))
101 await storage.saveEvent(makeEvent({ name: 'signup' }))
102 await storage.saveEvent(makeEvent({ name: 'click' }))
103
104 const events = await storage.getEvents({ event: 'click' })
105 expect(events).toHaveLength(2)
106 })
107
108 test('getEvents filters by path', async () => {
109 const storage = new MemoryAnalyticsStorage()
110 await storage.saveEvent(makeEvent({ path: '/home' }))
111 await storage.saveEvent(makeEvent({ path: '/about' }))
112
113 const events = await storage.getEvents({ path: '/home' })
114 expect(events).toHaveLength(1)
115 })
116
117 test('getEvents filters by date range', async () => {
118 const storage = new MemoryAnalyticsStorage()
119 const now = Date.now()
120 await storage.saveEvent(makeEvent({ timestamp: now - 86400000 * 5 }))
121 await storage.saveEvent(makeEvent({ timestamp: now }))
122
123 const events = await storage.getEvents({
124 from: new Date(now - 86400000),
125 })
126 expect(events).toHaveLength(1)
127 })
128
129 test('getStats computes totalPageViews and uniqueVisitors', async () => {
130 const storage = new MemoryAnalyticsStorage()
131 await storage.savePageView(makePageView({ sessionId: 'a' }))
132 await storage.savePageView(makePageView({ sessionId: 'a' }))
133 await storage.savePageView(makePageView({ sessionId: 'b' }))
134
135 const stats = await storage.getStats()
136 expect(stats.totalPageViews).toBe(3)
137 expect(stats.uniqueVisitors).toBe(2)
138 })
139
140 test('getStats computes topPages', async () => {
141 const storage = new MemoryAnalyticsStorage()
142 await storage.savePageView(makePageView({ path: '/home' }))
143 await storage.savePageView(makePageView({ path: '/about' }))
144 await storage.savePageView(makePageView({ path: '/home' }))
145
146 const stats = await storage.getStats()
147 expect(stats.topPages[0]).toEqual({ path: '/home', views: 2 })
148 expect(stats.topPages[1]).toEqual({ path: '/about', views: 1 })
149 })
150
151 test('getStats computes topReferrers', async () => {
152 const storage = new MemoryAnalyticsStorage()
153 await storage.savePageView(makePageView({ referrer: 'https://google.com' }))
154 await storage.savePageView(makePageView({ referrer: 'https://google.com' }))
155 await storage.savePageView(makePageView({ referrer: 'https://twitter.com' }))
156 await storage.savePageView(makePageView()) // no referrer
157
158 const stats = await storage.getStats()
159 expect(stats.topReferrers).toHaveLength(2)
160 expect(stats.topReferrers[0]).toEqual({ referrer: 'https://google.com', count: 2 })
161 })
162
163 test('getStats computes topCountries', async () => {
164 const storage = new MemoryAnalyticsStorage()
165 await storage.savePageView(makePageView({ country: 'US' }))
166 await storage.savePageView(makePageView({ country: 'US' }))
167 await storage.savePageView(makePageView({ country: 'DE' }))
168
169 const stats = await storage.getStats()
170 expect(stats.topCountries[0]).toEqual({ country: 'US', count: 2 })
171 expect(stats.topCountries[1]).toEqual({ country: 'DE', count: 1 })
172 })
173
174 test('getStats computes averageDuration', async () => {
175 const storage = new MemoryAnalyticsStorage()
176 await storage.savePageView(makePageView({ duration: 1000 }))
177 await storage.savePageView(makePageView({ duration: 3000 }))
178 await storage.savePageView(makePageView()) // no duration
179
180 const stats = await storage.getStats()
181 expect(stats.averageDuration).toBe(2000)
182 })
183
184 test('getStats averageDuration is undefined when no durations', async () => {
185 const storage = new MemoryAnalyticsStorage()
186 await storage.savePageView(makePageView())
187
188 const stats = await storage.getStats()
189 expect(stats.averageDuration).toBeUndefined()
190 })
191
192 test('getStats computes event aggregation', async () => {
193 const storage = new MemoryAnalyticsStorage()
194 await storage.saveEvent(makeEvent({ name: 'click' }))
195 await storage.saveEvent(makeEvent({ name: 'click' }))
196 await storage.saveEvent(makeEvent({ name: 'signup' }))
197
198 const stats = await storage.getStats()
199 expect(stats.events).toBeDefined()
200 expect(stats.events![0]).toEqual({ name: 'click', count: 2 })
201 expect(stats.events![1]).toEqual({ name: 'signup', count: 1 })
202 })
203
204 test('getStats with groupBy day', async () => {
205 const storage = new MemoryAnalyticsStorage()
206 const day1 = new Date('2025-01-15T10:00:00Z').getTime()
207 const day2 = new Date('2025-01-16T10:00:00Z').getTime()
208 await storage.savePageView(makePageView({ timestamp: day1 }))
209 await storage.savePageView(makePageView({ timestamp: day1 + 1000 }))
210 await storage.savePageView(makePageView({ timestamp: day2 }))
211
212 const stats = await storage.getStats({ groupBy: 'day' })
213 expect(stats.pageViewsByPeriod).toBeDefined()
214 expect(stats.pageViewsByPeriod).toHaveLength(2)
215 expect(stats.pageViewsByPeriod![0].count).toBe(2)
216 expect(stats.pageViewsByPeriod![1].count).toBe(1)
217 })
218
219 test('getStats with groupBy month', async () => {
220 const storage = new MemoryAnalyticsStorage()
221 const jan = new Date('2025-01-15T10:00:00Z').getTime()
222 const feb = new Date('2025-02-15T10:00:00Z').getTime()
223 await storage.savePageView(makePageView({ timestamp: jan }))
224 await storage.savePageView(makePageView({ timestamp: feb }))
225
226 const stats = await storage.getStats({ groupBy: 'month' })
227 expect(stats.pageViewsByPeriod).toBeDefined()
228 expect(stats.pageViewsByPeriod).toHaveLength(2)
229 })
230
231 test('getStats returns empty result for empty storage', async () => {
232 const storage = new MemoryAnalyticsStorage()
233 const stats = await storage.getStats()
234
235 expect(stats.totalPageViews).toBe(0)
236 expect(stats.uniqueVisitors).toBe(0)
237 expect(stats.topPages).toHaveLength(0)
238 expect(stats.topReferrers).toHaveLength(0)
239 expect(stats.topCountries).toHaveLength(0)
240 expect(stats.averageDuration).toBeUndefined()
241 })
242
243 test('getStats events is undefined when no events', async () => {
244 const storage = new MemoryAnalyticsStorage()
245 await storage.savePageView(makePageView())
246
247 const stats = await storage.getStats()
248 expect(stats.events).toBeUndefined()
249 })
250})