-
Notifications
You must be signed in to change notification settings - Fork 192
Expand file tree
/
Copy pathAnalyticsService.ts
More file actions
502 lines (446 loc) · 12.9 KB
/
AnalyticsService.ts
File metadata and controls
502 lines (446 loc) · 12.9 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
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
import {
ErrCode,
type FullCustomer,
type RangeEnum,
RecaseError,
} from "@autumn/shared";
import type { ClickHouseClient } from "@clickhouse/client";
import { Decimal } from "decimal.js";
import { StatusCodes } from "http-status-codes";
import type { ExtendedRequest } from "@/utils/models/Request.js";
import { getBillingCycleStartDate } from "./analyticsUtils.js";
export class AnalyticsService {
static clickhouseAvailable =
process.env.CLICKHOUSE_URL &&
process.env.CLICKHOUSE_USERNAME &&
process.env.CLICKHOUSE_PASSWORD;
static handleEarlyExit = () => {
if (!AnalyticsService.clickhouseAvailable) {
throw new RecaseError({
message: "ClickHouse is disabled, cannot fetch events",
code: ErrCode.ClickHouseDisabled,
statusCode: StatusCodes.SERVICE_UNAVAILABLE,
});
}
};
static formatJsDateToClickHouseDateTime(date: Date) {
const year = date.getFullYear();
const month = String(date.getMonth() + 1).padStart(2, "0");
const day = String(date.getDate()).padStart(2, "0");
const hours = String(date.getHours()).padStart(2, "0");
const minutes = String(date.getMinutes() - 1).padStart(2, "0");
const seconds = String(date.getSeconds() - 1).padStart(2, "0");
return `${year}-${month}-${day} ${hours}:${minutes}:${seconds}`;
}
static async getTopEventNames({
req,
limit = 3,
}: {
req: ExtendedRequest;
limit?: number;
}) {
const { clickhouseClient, org, env } = req;
const query = `
select count(*) as count, event_name
from org_events_view(org_id={org_id:String}, org_slug='', env={env:String})
where timestamp >= NOW() - INTERVAL '1 month'
group by event_name
order by count(*) desc
limit {limit:UInt32}
`;
const result = await clickhouseClient.query({
query,
query_params: {
org_id: org?.id,
env: env,
limit,
},
});
const resultJson = await result.json();
return {
eventNames: (resultJson.data as { event_name: string }[]).map(
(row) => row.event_name,
),
result: resultJson,
};
}
static async getTopUser({ req }: { req: ExtendedRequest }) {
const { clickhouseClient, org, env } = req;
const query = `
SELECT
c.name
FROM
events e
JOIN
customers c ON e.customer_id = c.id
WHERE
toDate(e.timestamp) = today()
AND e.org_id = {org_id: String}
AND e.env = {env: String}
GROUP BY
c.name
ORDER BY
COUNT(*) DESC
LIMIT 1
UNION ALL
SELECT
'None'
WHERE
NOT EXISTS (
SELECT
1
FROM
events e
JOIN
customers c ON e.customer_id = c.id
WHERE
toDate(e.timestamp) = today()
AND e.org_id = {org_id: String}
AND e.env = {env: String}
GROUP BY
c.name
ORDER BY
COUNT(*) DESC
LIMIT 1
)
`;
const result = await clickhouseClient.query({
query,
query_params: {
org_id: org?.id,
env: env,
},
});
const resultJson = await result.json();
return (resultJson.data as { name: string; count: number }[])[0];
}
static async getTotalEvents({
req,
eventName,
}: {
req: ExtendedRequest;
eventName?: string;
}) {
const { clickhouseClient, org, env } = req;
const query = `
SELECT SUM(
CASE
WHEN JSONHas(properties, 'value') THEN toInt64(JSONExtractFloat(properties, 'value'))
WHEN value IS NOT NULL THEN toInt64(value)
ELSE 1
END
) AS total_events
FROM org_events_view(org_id={org_id:String}, org_slug='', env={env:String})
WHERE event_name = {eventName:String}
`;
const result = await clickhouseClient.query({
query,
query_params: {
org_id: org?.id,
env: env,
eventName: eventName ?? undefined,
},
});
const resultJson = await result.json();
return (resultJson.data as { total_events: number }[])[0].total_events;
}
static async getTotalCustomers({ req }: { req: ExtendedRequest }) {
const { clickhouseClient, org, env } = req;
const query = `SELECT COUNT(DISTINCT id) AS total_customers
FROM customers
WHERE org_id = {org_id:String}
AND env = {env:String};`;
const result = await clickhouseClient.query({
query,
query_params: {
org_id: org?.id,
env: env,
},
});
const resultJson = await result.json();
return (resultJson.data as { total_customers: number }[])[0]
.total_customers;
}
static async getTimeseriesEvents({
req,
params,
customer,
aggregateAll = false,
}: {
req: ExtendedRequest;
params: {
event_names: string[];
interval: RangeEnum;
customer_id?: string;
no_count?: boolean;
};
customer?: FullCustomer;
aggregateAll?: boolean;
}) {
const { clickhouseClient, org, env, db } = req;
const intervalType: RangeEnum = params.interval || "24h";
const isBillingCycle = intervalType === "1bc" || intervalType === "3bc";
AnalyticsService.handleEarlyExit();
// Skip billing cycle calculation if aggregating all customers
const getBCResults =
isBillingCycle && !aggregateAll && customer
? ((await getBillingCycleStartDate(
customer,
db,
intervalType as "1bc" | "3bc",
)) as { startDate: string; endDate: string; gap: number } | null)
: null;
// Generate expressions for queries (works for both MV and original)
const generateExpressions = (
eventNames: string[],
noCount: boolean,
useMV: boolean,
) => {
const alias = useMV ? "ce" : "e";
return eventNames
.map((eventName) => {
const escapedEventName = eventName.replace(/'/g, "''");
const columnName = noCount ? eventName : `${eventName}_count`;
return `coalesce(sumIf(${alias}.value, ${alias}.event_name = '${escapedEventName}'), 0) as \`${columnName}\``;
})
.join(",\n ");
};
if (AnalyticsService.clickhouseAvailable) {
const queryParams = {
org_id: org?.id,
env: env,
customer_id: params.customer_id,
days:
intervalType === "24h"
? 1
: intervalType === "7d"
? 7
: intervalType === "30d"
? 30
: intervalType === "90d"
? 90
: intervalType === "1bc"
? (getBCResults?.gap ?? 0) + 1
: intervalType === "3bc"
? (getBCResults?.gap ?? 0)
: 0,
bin_size: intervalType === "24h" ? "hour" : "day",
end_date: isBillingCycle ? getBCResults?.endDate : undefined,
};
// Try materialized view first, fallback to original query if it fails
try {
const mvCountExpressions = generateExpressions(
params.event_names,
params.no_count ?? false,
true,
);
const mvQuery = `
with customer_events as (
select
period_hour,
event_name,
sum(value) as value
from events_usage_mv
where org_id = {org_id:String}
and env = {env:String}
${aggregateAll ? "" : "and customer_id = {customer_id:String}"}
and period_hour >= date_trunc({bin_size:String}, now() - INTERVAL {days:UInt32} day)
group by period_hour, event_name
)
select
dr.period,
${mvCountExpressions}
from date_range_view(bin_size={bin_size:String}, days={days:UInt32}) dr
left join customer_events ce
on ${intervalType === "24h" ? "ce.period_hour" : `date_trunc('day', ce.period_hour)`} = dr.period
group by dr.period
order by dr.period;
`;
const mvQueryBillingCycle = `
with customer_events as (
select
period_hour,
event_name,
sum(value) as value
from events_usage_mv
where org_id = {org_id:String}
and env = {env:String}
${aggregateAll ? "" : "and customer_id = {customer_id:String}"}
and period_hour >= date_trunc('day', toDateTime({end_date:String}) - INTERVAL {days:UInt32} day)
and period_hour < date_trunc('day', toDateTime({end_date:String}))
group by period_hour, event_name
)
select
dr.period,
${mvCountExpressions}
from date_range_bc_view(bin_size={bin_size:String}, start_date={end_date:DateTime}, days={days:UInt32}) dr
left join customer_events ce
on ${intervalType === "24h" ? "ce.period_hour" : `date_trunc('day', ce.period_hour)`} = dr.period
group by dr.period
order by dr.period;
`;
const mvQueryToUse =
isBillingCycle && !aggregateAll && getBCResults?.startDate
? mvQueryBillingCycle
: mvQuery;
const result = await (clickhouseClient as ClickHouseClient).query({
query: mvQueryToUse,
query_params: queryParams,
format: "JSON",
clickhouse_settings: {
output_format_json_quote_decimals: 0,
output_format_json_quote_64bit_integers: 1,
output_format_json_quote_64bit_floats: 1,
},
});
const resultJson = await result.json();
(resultJson.data as Record<string, unknown>[]).forEach((row) => {
Object.keys(row).forEach((key: string) => {
if (key !== "period") {
row[key] = new Decimal(row[key] as number)
.toDecimalPlaces(10)
.toNumber();
}
});
});
return resultJson;
} catch {
// Fallback to original query if materialized view doesn't exist or fails
const fallbackCountExpressions = generateExpressions(
params.event_names,
params.no_count ?? false,
false,
);
const fallbackQuery = `
with customer_events as (
select *
from org_events_view(org_id={org_id:String}, org_slug='', env={env:String})
${aggregateAll ? "" : "where customer_id = {customer_id:String}"}
)
select
dr.period,
${fallbackCountExpressions}
from date_range_view(bin_size={bin_size:String}, days={days:UInt32}) dr
left join customer_events e
on date_trunc({bin_size:String}, e.timestamp) = dr.period
group by dr.period
order by dr.period;
`;
const fallbackQueryBillingCycle = `
with customer_events as (
select *
from org_events_view(org_id={org_id:String}, org_slug='', env={env:String})
${aggregateAll ? "" : "where customer_id = {customer_id:String}"}
)
select
dr.period,
${fallbackCountExpressions}
from date_range_bc_view(bin_size={bin_size:String}, start_date={end_date:DateTime}, days={days:UInt32}) dr
left join customer_events e
on date_trunc({bin_size:String}, e.timestamp) = dr.period
group by dr.period
order by dr.period;
`;
const fallbackQueryToUse =
isBillingCycle && !aggregateAll && getBCResults?.startDate
? fallbackQueryBillingCycle
: fallbackQuery;
const result = await (clickhouseClient as ClickHouseClient).query({
query: fallbackQueryToUse,
query_params: queryParams,
format: "JSON",
clickhouse_settings: {
output_format_json_quote_decimals: 0,
output_format_json_quote_64bit_integers: 1,
output_format_json_quote_64bit_floats: 1,
},
});
const resultJson = await result.json();
(resultJson.data as Record<string, unknown>[]).forEach((row) => {
Object.keys(row).forEach((key: string) => {
if (key !== "period") {
row[key] = new Decimal(row[key] as number)
.toDecimalPlaces(10)
.toNumber();
}
});
});
return resultJson;
}
}
}
static async getRawEvents({
req,
params,
customer,
aggregateAll = false,
}: {
req: ExtendedRequest;
params: { customer_id?: string; interval?: string };
customer?: FullCustomer;
aggregateAll?: boolean;
}) {
const { clickhouseClient, org, db, env } = req;
AnalyticsService.handleEarlyExit();
const startDate = new Date();
const intervalType = params.interval || "day";
const isBillingCycle = intervalType === "1bc" || intervalType === "3bc";
// Skip billing cycle calculation if aggregating all customers
const getBCResults =
isBillingCycle && !aggregateAll && customer
? ((await getBillingCycleStartDate(
customer,
db,
intervalType as "1bc" | "3bc",
)) as { startDate: string; endDate: string; gap: number } | null)
: null;
switch (intervalType) {
case "24h":
startDate.setHours(startDate.getHours() - 24);
break;
case "7d":
startDate.setDate(startDate.getDate() - 7);
break;
case "30d":
startDate.setDate(startDate.getDate() - 30);
break;
case "90d":
startDate.setDate(startDate.getDate() - 90);
break;
default:
startDate.setDate(startDate.getDate() - 24);
break;
}
const finalStartDate =
isBillingCycle && getBCResults?.startDate
? getBCResults.startDate
: AnalyticsService.formatJsDateToClickHouseDateTime(startDate);
const finalEndDate =
isBillingCycle && getBCResults?.endDate
? getBCResults.endDate
: AnalyticsService.formatJsDateToClickHouseDateTime(new Date());
const query = `
SELECT *
FROM org_events_view(org_id={organizationId:String}, org_slug='', env={env:String})
WHERE timestamp >= toDateTime({startDate:String})
AND timestamp < toDateTime({endDate:String})
${aggregateAll ? "" : "AND customer_id = {customerId:String}"}
ORDER BY timestamp DESC
limit 10000
`;
const result = await clickhouseClient.query({
query: query,
query_params: {
organizationId: org?.id,
customerId: params.customer_id,
startDate: finalStartDate,
endDate: finalEndDate,
env: env,
},
});
// log the actual query... with params filled in...?
// console.log("query", query);
const resultJson = await result.json();
return resultJson;
}
}