forked from TanStack/tanstack.com
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathhomepage-npm-stats.server.ts
More file actions
471 lines (409 loc) · 12.1 KB
/
Copy pathhomepage-npm-stats.server.ts
File metadata and controls
471 lines (409 loc) · 12.1 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
import {
getBlobStorage,
getBlobStorageCache,
type BlobStorage,
type BlobStorageCache,
} from '~/server/runtime/blob-storage.server'
import {
addUtcDays,
NPM_STATS_START_DATE,
toIsoDayUtc,
} from './npm-download-ranges'
import { fetchNpmDownloadsBulkData } from './stats.server'
import { getNpmOrgPackageNames } from './stats.functions'
import { tanStackTotalVisibleNpmPackageNames } from './tanstack-npm-stats'
import { libraries } from '~/libraries'
export type NpmStatsLibrarySummary = {
libraryId: string
packageCount: number
totalDownloads: number
updatedAt: number
}
export type HomepageNpmStatsSummary = {
expiresAt: number
librarySummaries: Array<NpmStatsLibrarySummary>
totalDownloads: number
totalEndDate: string
totalPackageCount: number
totalStartDate: string
updatedAt: number
weeklyDownloads: number
weeklyEndDate: string
weeklyPackageCount: number
weeklyRatePerDay: number
weeklyStartDate: string
}
type FetchPackageDownloadsOptions = {
endDate: string
packageNames: Array<string>
startDate: string
}
const HOME_NPM_STATS_STORAGE = 'npmDownloadCache'
const HOME_NPM_STATS_KEY = 'homepage-npm-stats/v1/tanstack.json'
const HOME_NPM_STATS_CONTENT_TYPE = 'application/json; charset=utf-8'
const HOME_NPM_STATS_TTL_MS = 12 * 60 * 60 * 1000
const PACKAGE_BATCH_SIZE = 32
const PACKAGE_BATCH_CONCURRENCY = 2
let blobStoragePromise: Promise<BlobStorage | undefined> | undefined
let memorySummary: HomepageNpmStatsSummary | undefined
function getHomepageNpmStatsBlobStorage() {
blobStoragePromise ??= getBlobStorage(HOME_NPM_STATS_STORAGE)
return blobStoragePromise
}
function isRecord(value: unknown): value is Record<string, unknown> {
return typeof value === 'object' && value !== null && !Array.isArray(value)
}
function readNumber(value: Record<string, unknown>, key: string) {
const rawValue = Reflect.get(value, key)
return typeof rawValue === 'number' && Number.isFinite(rawValue)
? rawValue
: undefined
}
function readString(value: Record<string, unknown>, key: string) {
const rawValue = Reflect.get(value, key)
return typeof rawValue === 'string' && rawValue.length > 0
? rawValue
: undefined
}
function parseLibrarySummaries(value: unknown): Array<NpmStatsLibrarySummary> {
if (!Array.isArray(value)) {
return []
}
const summaries: Array<NpmStatsLibrarySummary> = []
for (const item of value) {
if (!isRecord(item)) {
continue
}
const libraryId = readString(item, 'libraryId')
const packageCount = readNumber(item, 'packageCount')
const totalDownloads = readNumber(item, 'totalDownloads')
const updatedAt = readNumber(item, 'updatedAt')
if (
libraryId === undefined ||
packageCount === undefined ||
totalDownloads === undefined ||
updatedAt === undefined
) {
continue
}
summaries.push({
libraryId,
packageCount,
totalDownloads,
updatedAt,
})
}
return summaries
}
function parseHomepageNpmStatsSummary(
value: unknown,
): HomepageNpmStatsSummary | undefined {
if (!isRecord(value)) {
return undefined
}
const expiresAt = readNumber(value, 'expiresAt')
const totalDownloads = readNumber(value, 'totalDownloads')
const totalEndDate = readString(value, 'totalEndDate')
const totalPackageCount = readNumber(value, 'totalPackageCount')
const totalStartDate = readString(value, 'totalStartDate')
const updatedAt = readNumber(value, 'updatedAt')
const weeklyDownloads = readNumber(value, 'weeklyDownloads')
const weeklyEndDate = readString(value, 'weeklyEndDate')
const weeklyPackageCount = readNumber(value, 'weeklyPackageCount')
const weeklyRatePerDay = readNumber(value, 'weeklyRatePerDay')
const weeklyStartDate = readString(value, 'weeklyStartDate')
if (
expiresAt === undefined ||
totalDownloads === undefined ||
totalEndDate === undefined ||
totalPackageCount === undefined ||
totalStartDate === undefined ||
updatedAt === undefined ||
weeklyDownloads === undefined ||
weeklyEndDate === undefined ||
weeklyPackageCount === undefined ||
weeklyRatePerDay === undefined ||
weeklyStartDate === undefined
) {
return undefined
}
return {
expiresAt,
librarySummaries: parseLibrarySummaries(
Reflect.get(value, 'librarySummaries'),
),
totalDownloads,
totalEndDate,
totalPackageCount,
totalStartDate,
updatedAt,
weeklyDownloads,
weeklyEndDate,
weeklyPackageCount,
weeklyRatePerDay,
weeklyStartDate,
}
}
function readStoredHomepageNpmStatsSummary(text: string) {
let parsed: unknown
try {
parsed = JSON.parse(text)
} catch {
return undefined
}
return parseHomepageNpmStatsSummary(parsed)
}
function getSummaryMetadata(
summary: HomepageNpmStatsSummary,
): Record<string, string> {
return {
expiresAt: String(summary.expiresAt),
totalDownloads: String(summary.totalDownloads),
totalPackageCount: String(summary.totalPackageCount),
updatedAt: String(summary.updatedAt),
weeklyDownloads: String(summary.weeklyDownloads),
weeklyPackageCount: String(summary.weeklyPackageCount),
}
}
function isFreshSummary(summary: HomepageNpmStatsSummary) {
return summary.expiresAt > Date.now()
}
async function putCacheEntry({
cache,
summary,
text,
}: {
cache: BlobStorageCache | undefined
summary: HomepageNpmStatsSummary
text: string
}) {
try {
await cache?.put(HOME_NPM_STATS_KEY, {
metadata: getSummaryMetadata(summary),
text,
})
} catch (error) {
console.warn('[Homepage NPM Stats] Cache API write failed:', error)
}
}
async function writeHomepageNpmStatsSummary(summary: HomepageNpmStatsSummary) {
const text = JSON.stringify(summary)
const cache = getBlobStorageCache(HOME_NPM_STATS_STORAGE)
const storage = await getHomepageNpmStatsBlobStorage()
memorySummary = summary
if (storage) {
await storage.put(HOME_NPM_STATS_KEY, text, {
contentType: HOME_NPM_STATS_CONTENT_TYPE,
metadata: getSummaryMetadata(summary),
})
}
await putCacheEntry({ cache, summary, text })
}
async function readHomepageNpmStatsSummary({
allowStale,
}: {
allowStale: boolean
}) {
if (memorySummary && (allowStale || isFreshSummary(memorySummary))) {
return memorySummary
}
const cache = getBlobStorageCache(HOME_NPM_STATS_STORAGE)
const cached = await cache?.get(HOME_NPM_STATS_KEY)
if (cached) {
const summary = readStoredHomepageNpmStatsSummary(cached.text)
if (summary && (allowStale || isFreshSummary(summary))) {
memorySummary = summary
return summary
}
}
const storage = await getHomepageNpmStatsBlobStorage()
const object = await storage?.get(HOME_NPM_STATS_KEY)
if (!object) {
return undefined
}
const text = await object.text()
const summary = readStoredHomepageNpmStatsSummary(text)
if (!summary || (!allowStale && !isFreshSummary(summary))) {
return undefined
}
memorySummary = summary
await putCacheEntry({ cache, summary, text })
return summary
}
function chunkPackageNames(packageNames: Array<string>) {
const chunks: Array<Array<string>> = []
for (
let index = 0;
index < packageNames.length;
index += PACKAGE_BATCH_SIZE
) {
chunks.push(packageNames.slice(index, index + PACKAGE_BATCH_SIZE))
}
return chunks
}
async function mapWithConcurrency<T, TResult>(
values: Array<T>,
concurrency: number,
fn: (value: T) => Promise<TResult>,
) {
const results = new Array<TResult>(values.length)
let index = 0
const workers = Array.from(
{ length: Math.min(concurrency, values.length) },
async () => {
while (index < values.length) {
const currentIndex = index
index += 1
results[currentIndex] = await fn(values[currentIndex])
}
},
)
await Promise.all(workers)
return results
}
async function fetchPackageDownloads({
endDate,
packageNames,
startDate,
}: FetchPackageDownloadsOptions) {
const uniquePackageNames = [...new Set(packageNames)].sort()
if (uniquePackageNames.length === 0) {
return new Map<string, number>()
}
const results = await mapWithConcurrency(
chunkPackageNames(uniquePackageNames),
PACKAGE_BATCH_CONCURRENCY,
async (packageBatch) =>
fetchNpmDownloadsBulkData({
data: {
packageGroups: [
{
packages: packageBatch.map((name) => ({ name })),
},
],
startDate,
endDate,
},
}),
)
const packageDownloads = new Map<string, number>()
for (const group of results.flat()) {
for (const pkg of group.packages) {
const downloads = pkg.downloads.reduce(
(downloadTotal, point) => downloadTotal + point.downloads,
0,
)
packageDownloads.set(
pkg.name,
(packageDownloads.get(pkg.name) ?? 0) + downloads,
)
}
}
return packageDownloads
}
function getLibraryNpmPackageNames(library: {
corePackageName?: string
npmPackageNames?: Array<string>
}) {
if (library.npmPackageNames?.length) {
return library.npmPackageNames
}
return library.corePackageName ? [library.corePackageName] : []
}
function sumPackageDownloads(
packageDownloads: Map<string, number>,
packageNames: Array<string>,
) {
return packageNames.reduce(
(total, packageName) => total + (packageDownloads.get(packageName) ?? 0),
0,
)
}
function getLastCompletedNpmStatsDay() {
const today = new Date()
const lastCompletedDay = new Date(
Date.UTC(today.getUTCFullYear(), today.getUTCMonth(), today.getUTCDate()),
)
lastCompletedDay.setUTCDate(lastCompletedDay.getUTCDate() - 1)
return toIsoDayUtc(lastCompletedDay)
}
export async function refreshHomepageNpmStatsSummary({
org = 'tanstack',
}: {
org?: string
} = {}) {
const orgPackageNames = await getNpmOrgPackageNames(org)
const libraryPackageEntries = libraries
.map((library) => ({
libraryId: library.id,
packageNames: getLibraryNpmPackageNames(library),
}))
.filter((entry) => entry.packageNames.length > 0)
const totalPackageNames = [
...new Set([
...orgPackageNames,
...libraryPackageEntries.flatMap((entry) => entry.packageNames),
]),
].sort()
const weeklyPackageNames = [...tanStackTotalVisibleNpmPackageNames].sort()
const totalEndDate = getLastCompletedNpmStatsDay()
const weeklyEndDate = totalEndDate
const weeklyStartDate = addUtcDays(weeklyEndDate, -6)
const updatedAt = Date.now()
const [totalPackageDownloads, weeklyPackageDownloads] = await Promise.all([
fetchPackageDownloads({
packageNames: totalPackageNames,
startDate: NPM_STATS_START_DATE,
endDate: totalEndDate,
}),
fetchPackageDownloads({
packageNames: weeklyPackageNames,
startDate: weeklyStartDate,
endDate: weeklyEndDate,
}),
])
const totalDownloads = sumPackageDownloads(
totalPackageDownloads,
totalPackageNames,
)
const weeklyDownloads = sumPackageDownloads(
weeklyPackageDownloads,
weeklyPackageNames,
)
const librarySummaries = libraryPackageEntries.map((entry) => ({
libraryId: entry.libraryId,
packageCount: entry.packageNames.length,
totalDownloads: sumPackageDownloads(
totalPackageDownloads,
entry.packageNames,
),
updatedAt,
}))
const summary: HomepageNpmStatsSummary = {
expiresAt: updatedAt + HOME_NPM_STATS_TTL_MS,
librarySummaries,
totalDownloads,
totalEndDate,
totalPackageCount: totalPackageNames.length,
totalStartDate: NPM_STATS_START_DATE,
updatedAt,
weeklyDownloads,
weeklyEndDate,
weeklyPackageCount: weeklyPackageNames.length,
weeklyRatePerDay: weeklyDownloads > 0 ? weeklyDownloads / 7 : 0,
weeklyStartDate,
}
await writeHomepageNpmStatsSummary(summary)
return summary
}
export async function getHomepageNpmStatsSummary() {
return (await readHomepageNpmStatsSummary({ allowStale: true })) ?? null
}
export async function getCachedLibraryNpmStatsSummary(libraryId: string) {
const summary = await readHomepageNpmStatsSummary({ allowStale: true })
return (
summary?.librarySummaries.find(
(librarySummary) => librarySummary.libraryId === libraryId,
) ?? null
)
}