-
Notifications
You must be signed in to change notification settings - Fork 33
Expand file tree
/
Copy pathteam_usage_stats_test.go
More file actions
390 lines (331 loc) · 12.3 KB
/
team_usage_stats_test.go
File metadata and controls
390 lines (331 loc) · 12.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
package stream_chat
import (
"context"
"os"
"testing"
"github.com/stretchr/testify/require"
)
// =============================================================================
// Basic Tests - Use regular app credentials, expect empty teams
// These tests verify the API works correctly without requiring multi-tenant data
// =============================================================================
func TestQueryTeamUsageStats_BasicAPI(t *testing.T) {
c := initClient(t)
ctx := context.Background()
t.Run("No parameters returns valid response", func(t *testing.T) {
resp, err := c.QueryTeamUsageStats(ctx, nil)
require.NoError(t, err)
require.NotNil(t, resp)
require.NotNil(t, resp.Teams)
// Regular app doesn't have multi-tenant, so teams is empty
require.Empty(t, resp.Teams)
})
t.Run("Empty request returns valid response", func(t *testing.T) {
resp, err := c.QueryTeamUsageStats(ctx, &QueryTeamUsageStatsRequest{})
require.NoError(t, err)
require.NotNil(t, resp.Teams)
require.Empty(t, resp.Teams)
})
t.Run("Month parameter works", func(t *testing.T) {
resp, err := c.QueryTeamUsageStats(ctx, &QueryTeamUsageStatsRequest{
Month: "2026-02",
})
require.NoError(t, err)
require.NotNil(t, resp.Teams)
require.Empty(t, resp.Teams)
})
t.Run("Date range works", func(t *testing.T) {
resp, err := c.QueryTeamUsageStats(ctx, &QueryTeamUsageStatsRequest{
StartDate: "2026-02-01",
EndDate: "2026-02-17",
})
require.NoError(t, err)
require.NotNil(t, resp.Teams)
require.Empty(t, resp.Teams)
})
t.Run("Pagination works", func(t *testing.T) {
limit := 10
resp, err := c.QueryTeamUsageStats(ctx, &QueryTeamUsageStatsRequest{
Limit: &limit,
})
require.NoError(t, err)
require.NotNil(t, resp.Teams)
require.Empty(t, resp.Teams)
// No next cursor when teams is empty
require.Empty(t, resp.Next)
})
t.Run("Invalid month throws error", func(t *testing.T) {
_, err := c.QueryTeamUsageStats(ctx, &QueryTeamUsageStatsRequest{
Month: "invalid",
})
require.Error(t, err)
})
t.Run("Wrong length month throws error", func(t *testing.T) {
_, err := c.QueryTeamUsageStats(ctx, &QueryTeamUsageStatsRequest{
Month: "2026",
})
require.Error(t, err)
})
t.Run("Invalid start date throws error", func(t *testing.T) {
_, err := c.QueryTeamUsageStats(ctx, &QueryTeamUsageStatsRequest{
StartDate: "bad",
})
require.Error(t, err)
})
t.Run("End before start throws error", func(t *testing.T) {
_, err := c.QueryTeamUsageStats(ctx, &QueryTeamUsageStatsRequest{
StartDate: "2026-02-20",
EndDate: "2026-02-10",
})
require.Error(t, err)
})
t.Run("Over max limit throws error", func(t *testing.T) {
limit := 31
_, err := c.QueryTeamUsageStats(ctx, &QueryTeamUsageStatsRequest{
Limit: &limit,
})
require.Error(t, err)
})
t.Run("Past month returns empty", func(t *testing.T) {
resp, err := c.QueryTeamUsageStats(ctx, &QueryTeamUsageStatsRequest{
Month: "2025-01",
})
require.NoError(t, err)
require.NotNil(t, resp.Teams)
require.Empty(t, resp.Teams)
})
}
// =============================================================================
// Integration Tests - Require multi-tenant app credentials
// These tests verify specific data exists and metrics are correct
// =============================================================================
// initMultiTenantClient creates a client using multi-tenant app credentials.
// Returns nil if credentials are not set (tests will be skipped).
func initMultiTenantClient(t *testing.T) *Client {
t.Helper()
apiKey := os.Getenv("STREAM_MULTI_TENANT_KEY")
apiSecret := os.Getenv("STREAM_MULTI_TENANT_SECRET")
if apiKey == "" || apiSecret == "" {
return nil
}
c, err := NewClient(apiKey, apiSecret)
require.NoError(t, err)
return c
}
// skipIfNoMultiTenant skips the test if multi-tenant credentials are not available.
func skipIfNoMultiTenant(t *testing.T, c *Client) {
t.Helper()
if c == nil {
t.Skip("Multi-tenant credentials not set. Set STREAM_MULTI_TENANT_KEY and STREAM_MULTI_TENANT_SECRET to run integration tests.")
}
}
// findTeamByName finds a team by name in the response.
func findTeamByName(teams []TeamUsageStats, teamName string) *TeamUsageStats {
for i := range teams {
if teams[i].Team == teamName {
return &teams[i]
}
}
return nil
}
// assertAllMetricsExact verifies all metrics have expected exact values.
func assertAllMetricsExact(t *testing.T, team *TeamUsageStats, teamName string) {
t.Helper()
// Daily activity metrics
require.Equal(t, int64(5), team.UsersDaily.Total, "%s users_daily", teamName)
require.Equal(t, int64(100), team.MessagesDaily.Total, "%s messages_daily", teamName)
require.Equal(t, int64(0), team.TranslationsDaily.Total, "%s translations_daily", teamName)
require.Equal(t, int64(0), team.ImageModerationsDaily.Total, "%s image_moderations_daily", teamName)
// Peak metrics
require.Equal(t, int64(0), team.ConcurrentUsers.Total, "%s concurrent_users", teamName)
require.Equal(t, int64(0), team.ConcurrentConnections.Total, "%s concurrent_connections", teamName)
// User rolling/cumulative metrics
require.Equal(t, int64(5), team.UsersTotal.Total, "%s users_total", teamName)
require.Equal(t, int64(5), team.UsersLast24Hours.Total, "%s users_last_24_hours", teamName)
require.Equal(t, int64(5), team.UsersLast30Days.Total, "%s users_last_30_days", teamName)
require.Equal(t, int64(5), team.UsersMonthToDate.Total, "%s users_month_to_date", teamName)
require.Equal(t, int64(0), team.UsersEngagedLast30Days.Total, "%s users_engaged_last_30_days", teamName)
require.Equal(t, int64(0), team.UsersEngagedMonthToDate.Total, "%s users_engaged_month_to_date", teamName)
// Message rolling/cumulative metrics
require.Equal(t, int64(100), team.MessagesTotal.Total, "%s messages_total", teamName)
require.Equal(t, int64(100), team.MessagesLast24Hours.Total, "%s messages_last_24_hours", teamName)
require.Equal(t, int64(100), team.MessagesLast30Days.Total, "%s messages_last_30_days", teamName)
require.Equal(t, int64(100), team.MessagesMonthToDate.Total, "%s messages_month_to_date", teamName)
}
// findTeamAcrossPages searches for a team across multiple pages using pagination.
func findTeamAcrossPages(t *testing.T, c *Client, teamName string) *TeamUsageStats {
t.Helper()
ctx := context.Background()
var nextCursor string
maxPages := 10 // Safety limit
limit := 5
for page := 0; page < maxPages; page++ {
req := &QueryTeamUsageStatsRequest{
Limit: &limit,
Next: nextCursor,
}
resp, err := c.QueryTeamUsageStats(ctx, req)
require.NoError(t, err)
team := findTeamByName(resp.Teams, teamName)
if team != nil {
return team
}
nextCursor = resp.Next
if nextCursor == "" {
break // No more pages
}
}
return nil
}
func TestQueryTeamUsageStats_Integration(t *testing.T) {
c := initMultiTenantClient(t)
skipIfNoMultiTenant(t, c)
ctx := context.Background()
t.Run("No parameters returns teams", func(t *testing.T) {
resp, err := c.QueryTeamUsageStats(ctx, nil)
require.NoError(t, err)
require.NotNil(t, resp)
require.NotNil(t, resp.Teams)
require.Greater(t, len(resp.Teams), 0, "Should return at least one team")
})
t.Run("Month parameter returns teams", func(t *testing.T) {
resp, err := c.QueryTeamUsageStats(ctx, &QueryTeamUsageStatsRequest{
Month: "2026-02",
})
require.NoError(t, err)
require.NotNil(t, resp.Teams)
require.Greater(t, len(resp.Teams), 0)
})
t.Run("Date range returns teams", func(t *testing.T) {
resp, err := c.QueryTeamUsageStats(ctx, &QueryTeamUsageStatsRequest{
StartDate: "2026-02-01",
EndDate: "2026-02-18",
})
require.NoError(t, err)
require.NotNil(t, resp.Teams)
require.Greater(t, len(resp.Teams), 0)
})
t.Run("Limit returns correct count", func(t *testing.T) {
limit := 3
resp, err := c.QueryTeamUsageStats(ctx, &QueryTeamUsageStatsRequest{
Limit: &limit,
})
require.NoError(t, err)
require.Equal(t, 3, len(resp.Teams))
})
t.Run("Limit returns next cursor", func(t *testing.T) {
limit := 2
resp, err := c.QueryTeamUsageStats(ctx, &QueryTeamUsageStatsRequest{
Limit: &limit,
})
require.NoError(t, err)
require.NotEmpty(t, resp.Next)
})
t.Run("Pagination returns different teams", func(t *testing.T) {
limit := 2
page1, err := c.QueryTeamUsageStats(ctx, &QueryTeamUsageStatsRequest{
Limit: &limit,
})
require.NoError(t, err)
page2, err := c.QueryTeamUsageStats(ctx, &QueryTeamUsageStatsRequest{
Limit: &limit,
Next: page1.Next,
})
require.NoError(t, err)
// Verify no overlap between pages
for _, t1 := range page1.Teams {
for _, t2 := range page2.Teams {
require.NotEqual(t, t1.Team, t2.Team, "Pages should not have overlapping teams")
}
}
})
t.Run("Teams have team field", func(t *testing.T) {
resp, err := c.QueryTeamUsageStats(ctx, nil)
require.NoError(t, err)
require.Greater(t, len(resp.Teams), 0)
// team field exists (may be empty string for default team)
_ = resp.Teams[0].Team
})
t.Run("All metrics present", func(t *testing.T) {
resp, err := c.QueryTeamUsageStats(ctx, nil)
require.NoError(t, err)
require.Greater(t, len(resp.Teams), 0)
team := resp.Teams[0]
// Daily activity metrics - verify they are initialized
_ = team.UsersDaily.Total
_ = team.MessagesDaily.Total
_ = team.TranslationsDaily.Total
_ = team.ImageModerationsDaily.Total
// Peak metrics
_ = team.ConcurrentUsers.Total
_ = team.ConcurrentConnections.Total
// Rolling/cumulative metrics
_ = team.UsersTotal.Total
_ = team.UsersLast24Hours.Total
_ = team.UsersLast30Days.Total
_ = team.UsersMonthToDate.Total
_ = team.UsersEngagedLast30Days.Total
_ = team.UsersEngagedMonthToDate.Total
_ = team.MessagesTotal.Total
_ = team.MessagesLast24Hours.Total
_ = team.MessagesLast30Days.Total
_ = team.MessagesMonthToDate.Total
})
t.Run("Metric totals non-negative", func(t *testing.T) {
resp, err := c.QueryTeamUsageStats(ctx, nil)
require.NoError(t, err)
for _, team := range resp.Teams {
require.GreaterOrEqual(t, team.MessagesTotal.Total, int64(0), "messages_total should be >= 0")
require.GreaterOrEqual(t, team.UsersDaily.Total, int64(0), "users_daily should be >= 0")
require.GreaterOrEqual(t, team.ConcurrentUsers.Total, int64(0), "concurrent_users should be >= 0")
}
})
}
func TestQueryTeamUsageStats_DataCorrectness(t *testing.T) {
c := initMultiTenantClient(t)
skipIfNoMultiTenant(t, c)
ctx := context.Background()
testTeams := []string{"sdk-test-team-1", "sdk-test-team-2", "sdk-test-team-3"}
t.Run("Date range query returns test teams with exact values", func(t *testing.T) {
resp, err := c.QueryTeamUsageStats(ctx, &QueryTeamUsageStatsRequest{
StartDate: "2026-02-18",
EndDate: "2026-02-19",
})
require.NoError(t, err)
for _, teamName := range testTeams {
team := findTeamByName(resp.Teams, teamName)
require.NotNil(t, team, "%s should exist", teamName)
assertAllMetricsExact(t, team, teamName)
}
})
t.Run("Month query returns test teams with valid metrics", func(t *testing.T) {
resp, err := c.QueryTeamUsageStats(ctx, &QueryTeamUsageStatsRequest{
Month: "2026-02",
})
require.NoError(t, err)
for _, teamName := range testTeams {
team := findTeamByName(resp.Teams, teamName)
require.NotNil(t, team, "%s should exist", teamName)
require.GreaterOrEqual(t, team.UsersTotal.Total, int64(0), "%s users_total", teamName)
require.GreaterOrEqual(t, team.MessagesTotal.Total, int64(0), "%s messages_total", teamName)
}
})
t.Run("No params query returns test teams with valid metrics", func(t *testing.T) {
resp, err := c.QueryTeamUsageStats(ctx, nil)
require.NoError(t, err)
for _, teamName := range testTeams {
team := findTeamByName(resp.Teams, teamName)
require.NotNil(t, team, "%s should exist", teamName)
require.GreaterOrEqual(t, team.UsersTotal.Total, int64(0), "%s users_total", teamName)
require.GreaterOrEqual(t, team.MessagesTotal.Total, int64(0), "%s messages_total", teamName)
}
})
t.Run("Pagination finds test teams with valid metrics", func(t *testing.T) {
for _, teamName := range testTeams {
team := findTeamAcrossPages(t, c, teamName)
require.NotNil(t, team, "%s should exist across paginated results", teamName)
require.GreaterOrEqual(t, team.UsersTotal.Total, int64(0), "%s users_total", teamName)
require.GreaterOrEqual(t, team.MessagesTotal.Total, int64(0), "%s messages_total", teamName)
}
})
}