Repository navigation
Expand file tree
/
Copy pathgithub.ts
More file actions
3527 lines (3211 loc) · 105 KB
/
Copy pathgithub.ts
File metadata and controls
3527 lines (3211 loc) · 105 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
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import 'server-only';
// Resolves Issue #6105 (Intelligent API Resilience)
import type {
ContributionCalendar,
ContributionDay,
ContributedRepo,
ExtendedContributionData,
RepoContribution,
GraphNode,
GraphLink,
} from '@/types';
import { calculateStreak, aggregateCalendars, convertLocalToUtc } from '@/lib/calculate';
import { isBotAuthor } from './bot-filter';
import { DistributedCache } from '@/lib/cache';
import { LANGUAGE_COLORS } from '@/lib/svg/languageColors';
import { CONTRIBUTION_MILESTONES, STREAK_MILESTONES } from './svg/constants';
import { quotaMonitor } from '@/services/github/quota-monitor';
import pLimit from 'p-limit';
import logger from '@/lib/logger';
import { decryptGitHubToken, isEncryptedToken } from '@/lib/github-token-encryption';
export interface GitHubRepo {
name: string;
stargazers_count: number;
language: string | null;
fork?: boolean;
forks_count?: number;
updated_at?: string;
pushed_at?: string;
owner?: { login: string };
created_at?: string;
homepage?: string | null;
description?: string | null;
participation?: number[];
}
/** Maximum number of retry attempts for GitHub API calls. Configurable via GITHUB_MAX_RETRIES env var (default: 3). */
export const MAX_RETRIES = Number(process.env.GITHUB_MAX_RETRIES ?? '3');
/** Base delay in milliseconds before the first retry. Configurable via GITHUB_BASE_DELAY_MS env var (default: 500). */
export const BASE_DELAY_MS = Number(process.env.GITHUB_BASE_DELAY_MS ?? '500');
/** Maximum delay in milliseconds between retries. Configurable via GITHUB_MAX_RETRY_DELAY_MS env var (default: 5000). */
export const MAX_RETRY_DELAY_MS = Number(process.env.GITHUB_MAX_RETRY_DELAY_MS ?? '5000');
/**
* Calculates a jittered backoff delay for retry logic.
* @param attempt - The zero-based retry attempt number.
* @returns The delay in milliseconds with random jitter applied.
*/
export function getJitteredBackoff(attempt: number): number {
const base = BASE_DELAY_MS * Math.pow(2, attempt);
const jitter = 0.5 + Math.random() * 0.5;
return Math.round(base * jitter);
}
export function shouldFallbackOnError(err: unknown): boolean {
if (!err) return false;
const msg = err instanceof Error ? err.message : String(err);
if (
msg.includes('not found') ||
msg.includes('Not Found') ||
msg.includes('401') ||
msg.includes('Unauthorized') ||
msg.includes('token') ||
msg.includes('PAT') ||
msg.includes('Authorization') ||
msg.includes('status 500') ||
msg.includes('error: 500') ||
msg.includes('Bad credentials')
) {
return false;
}
if (
msg.includes('fetch') ||
msg.includes('timeout') ||
msg.includes('timed out') ||
msg.includes('AbortError') ||
msg.includes('rate limit') ||
msg.includes('RATE_LIMITED') ||
msg.includes('Rate Limit') ||
err instanceof RateLimitError
) {
return true;
}
return false;
}
/**
* Read a positive integer from the environment, falling back to the
* default when the variable is unset, not a number, or non-positive.
* A value like "abc" or "-5" would otherwise produce a NaN or negative
* timeout and break AbortSignal scheduling at request time.
*/
function positiveIntFromEnv(name: string, fallback: number): number {
const raw = process.env[name];
if (raw === undefined || raw === '') return fallback;
const parsed = Number(raw);
return Number.isInteger(parsed) && parsed > 0 ? parsed : fallback;
}
const GRAPHQL_TIMEOUT_MS = positiveIntFromEnv('GITHUB_GRAPHQL_TIMEOUT_MS', 8000);
const REST_TIMEOUT_MS = positiveIntFromEnv('GITHUB_REST_TIMEOUT_MS', 5000);
const ORG_MEMBER_LIMIT = positiveIntFromEnv('GITHUB_ORG_MEMBER_LIMIT', 100);
const GRAPHQL_REPOSITORY_PAGE_SIZE = 100;
const MAX_GRAPHQL_REPOSITORY_RESULTS = 500;
let currentTokenIndex = 0;
const rateLimitedTokens = new Map<string, number>();
const tokenStats = new Map<string, { remaining: number; resetTime: number }>();
// Issue #7380: Promise-based mutex serializing every read-modify-write of
// currentTokenIndex. Because getGitHubToken and the 401/429 handlers run
// across `await` boundaries, two concurrent async requests can otherwise
// interleave between reading currentTokenIndex and writing it back — corrupting
// the value (e.g. letting it exceed tokens.length or skipping a healthy token).
// The lock guarantees only one caller mutates the index at a time. getGitHubToken
// itself is synchronous and therefore already atomic, but the handlers below run
// asynchronously and must take the lock before touching the shared index.
let tokenIndexLock: Promise<void> = Promise.resolve();
function withTokenIndexLock<T>(fn: () => T | Promise<T>): Promise<T> {
const acquire = tokenIndexLock;
let release!: () => void;
const released = new Promise<void>((r) => {
release = r;
});
tokenIndexLock = released.then(() => undefined);
return acquire.then(() => {
try {
return Promise.resolve(fn()).finally(release);
} catch (err) {
release();
throw err;
}
});
}
export function getTokenIndexLockForTests() {
return tokenIndexLock;
}
// Issue #7213: Per-token pending refresh promise to deduplicate concurrent rotations.
// When multiple concurrent requests detect an expired token, only one triggers
// the rotation; subsequent requests await the same in-flight promise.
const pendingRefreshPromises = new Map<string, Promise<void>>();
export function getTokenStatsForTests() {
return tokenStats;
}
export function getRateLimitedTokensForTests() {
return rateLimitedTokens;
}
export function getGlobalCircuitBreakerOpenUntilForTests() {
return globalCircuitBreakerOpenUntil;
}
//Explicit, strongly-typed Error subclass
export class RateLimitError extends Error {
constructor(
message: string,
public readonly retryAfterMs: number
) {
super(message);
this.name = 'RateLimitError';
}
}
// Global circuit state tracking
let globalCircuitBreakerOpenUntil = 0;
function isValidGitHubTokenFormat(token: string): boolean {
return (
token.length >= 36 &&
(token.startsWith('ghp_') ||
token.startsWith('ghu_') ||
token.startsWith('ghs_') ||
token.startsWith('ghr_') ||
token.startsWith('github_pat_'))
);
}
export function getGitHubTokens(): string[] {
const envToken =
process.env.GITHUB_TOKENS || process.env.GITHUB_PAT || process.env.GITHUB_TOKEN || '';
return envToken
.split(',')
.map((t) => t.trim())
.filter((t) => t !== '')
.map((token) => {
if (isEncryptedToken(token)) {
try {
return decryptGitHubToken(token);
} catch (error: unknown) {
const message = error instanceof Error ? error.message : String(error);
logger.warn(`Failed to decrypt GitHub token: ${message}`);
return token;
}
}
return token;
})
.filter((token) => isValidGitHubTokenFormat(token));
}
export function isAbortError(error: unknown): boolean {
if (
typeof error === 'object' &&
error !== null &&
'name' in error &&
((error as { name?: unknown }).name === 'AbortError' ||
(error as { name?: unknown }).name === 'TimeoutError')
) {
return true;
}
const message = error instanceof Error ? error.message : typeof error === 'string' ? error : '';
const lower = message.toLowerCase();
return (
lower.includes('timeout') ||
lower.includes('timed out') ||
lower.includes('aborted') ||
lower.includes('operation was aborted')
);
}
export async function fetchWithRetry(
url: string | URL,
options: RequestInit,
attempt = 0,
timeoutMs?: number,
userToken?: string
): Promise<Response> {
const now = Date.now();
// Problem 1 & 5 Fix: Global Short-Circuit Guard at the absolute front door
if (now < globalCircuitBreakerOpenUntil) {
throw new RateLimitError(
'Circuit Breaker Open: Request blocked due to total token exhaustion.',
globalCircuitBreakerOpenUntil - now
);
}
const resolvedTimeout =
timeoutMs ?? (url.toString().includes('graphql') ? GRAPHQL_TIMEOUT_MS : REST_TIMEOUT_MS);
if (options.signal?.aborted) throw new Error('AbortError');
const urlStr = url.toString();
const isGitHubRequest = urlStr.includes('api.github.com');
let currentToken = '';
let requestOptions: RequestInit = options;
if (isGitHubRequest) {
try {
currentToken = userToken || getGitHubToken();
const headers = new Headers(options.headers);
headers.set('Authorization', `Bearer ${currentToken}`);
requestOptions = {
...options,
headers,
};
} catch (e) {
if (e instanceof RateLimitError) {
throw e;
}
if (attempt === 0) throw e;
}
}
const controller = new AbortController();
const timeoutId = setTimeout(() => controller.abort(), resolvedTimeout);
const abortRequest = () => controller.abort();
if (options.signal) {
options.signal.addEventListener('abort', abortRequest, { once: true });
}
let res: Response | null = null;
let fetchError: unknown;
let didThrow = false;
try {
res = await fetch(url, { ...requestOptions, signal: controller.signal });
} catch (err: unknown) {
fetchError = err;
didThrow = true;
} finally {
clearTimeout(timeoutId);
options.signal?.removeEventListener('abort', abortRequest);
}
if (didThrow) {
if (options.signal?.aborted) throw fetchError;
const isTimeoutAbort = isAbortError(fetchError);
if (attempt >= MAX_RETRIES) {
if (isTimeoutAbort) {
throw new Error(`GitHub API request timed out after ${resolvedTimeout / 1000}s`);
}
throw fetchError;
}
const delay = getJitteredBackoff(attempt);
await new Promise((resolve) => setTimeout(resolve, delay));
return fetchWithRetry(url, requestOptions, attempt + 1, timeoutMs, userToken);
}
if (!res) throw new Error('GitHub API request failed without a response');
try {
quotaMonitor.updateQuotaFromHeaders(res.headers, currentToken);
} catch (err) {
logger.error('Failed to update quota monitor', {
component: 'GitHub',
error: err,
});
}
if (isGitHubRequest && currentToken && res) {
const remainingHeader = res.headers.get('x-ratelimit-remaining');
const resetHeader = res.headers.get('x-ratelimit-reset');
if (remainingHeader !== null) {
const remaining = parseInt(remainingHeader, 10);
let resetTime = Date.now() + 60 * 1000;
if (resetHeader) {
const parsed = parseInt(resetHeader, 10);
if (!Number.isNaN(parsed)) {
resetTime = parsed * 1000;
}
}
if (!Number.isNaN(remaining)) {
tokenStats.set(currentToken, { remaining, resetTime });
}
}
}
// Handle invalid/expired tokens (HTTP 401)
const isInvalidToken = res.status === 401;
if (isInvalidToken && currentToken) {
// Issue #7213: Use per-token pending refresh promise to prevent
// concurrent duplicate rotations that skip healthy tokens
await handleTokenExpiration(currentToken);
const tokens = getGitHubTokens();
// Retry immediately with the next token if available
if (attempt < MAX_RETRIES && tokens.length > 1) {
const delay = getJitteredBackoff(attempt);
await new Promise((resolve) => setTimeout(resolve, delay));
return fetchWithRetry(url, requestOptions, attempt + 1, timeoutMs, userToken);
}
}
// Check for rate limit headers
const retryAfter = res.headers.get('retry-after');
const isRateLimited =
res.status === 429 || (res.status === 403 && res.headers.get('x-ratelimit-remaining') === '0');
if (isRateLimited) {
if (currentToken) {
const resetHeader = res.headers.get('x-ratelimit-reset');
let resetTime = Date.now() + 60 * 1000; // default 1 min
if (resetHeader) {
const parsed = parseInt(resetHeader, 10);
if (!Number.isNaN(parsed)) {
resetTime = parsed * 1000;
}
}
rateLimitedTokens.set(currentToken, resetTime);
tokenStats.set(currentToken, { remaining: 0, resetTime });
// Issue #7380: advance the rotation index under the mutex so concurrent
// rate-limit handlers cannot both read then write the same value.
await withTokenIndexLock(() => {
const tokens = getGitHubTokens();
if (tokens.length > 1) {
currentTokenIndex = (currentTokenIndex + 1) % tokens.length;
}
});
}
if (attempt >= MAX_RETRIES) return res;
let delay = getJitteredBackoff(attempt);
if (retryAfter) {
const parsed = parseInt(retryAfter, 10);
if (!Number.isNaN(parsed) && String(parsed) === retryAfter) {
delay = parsed * 1000;
} else {
const dateDelay = Date.parse(retryAfter) - Date.now();
if (!Number.isNaN(dateDelay) && dateDelay > 0) {
delay = dateDelay;
}
}
}
// Clamp between exponential default and maximum safe delay before we early exit anyway
delay = Math.max(BASE_DELAY_MS, delay);
// If the delay is too long (e.g., > 5 seconds), it's a hard limit.
// Return immediately to avoid serverless function timeouts.
if (delay > MAX_RETRY_DELAY_MS) {
return res;
}
await new Promise((resolve) => setTimeout(resolve, delay));
return fetchWithRetry(url, requestOptions, attempt + 1, timeoutMs, userToken);
}
// Only retry on 5xx — all other statuses are returned immediately
const shouldRetry = res.status >= 500;
if (!shouldRetry || attempt >= MAX_RETRIES) return res;
const delay = getJitteredBackoff(attempt);
await new Promise((resolve) => setTimeout(resolve, delay));
return fetchWithRetry(url, requestOptions, attempt + 1, timeoutMs, userToken);
}
const GRAPHQL_INJECTION_PATTERNS: RegExp[] = [
/;\s*DROP/i,
/;\s*DELETE/i,
/;\s*TRUNCATE/i,
/union\s+select/i,
/exec\s*\(/i,
];
function assertValidGraphQLBody(options: RequestInit): void {
if (typeof options.body !== 'string') return;
let parsed: unknown;
try {
parsed = JSON.parse(options.body);
} catch {
throw new Error('GraphQL request body is not valid JSON');
}
const query = (parsed as Record<string, unknown>)?.query;
if (typeof query !== 'string' || query.trim() === '') {
throw new Error('GraphQL request must include a non-empty query string');
}
for (const pattern of GRAPHQL_INJECTION_PATTERNS) {
if (pattern.test(query)) {
throw new Error('GraphQL query contains disallowed patterns');
}
}
const open = (query.match(/{/g) ?? []).length;
const close = (query.match(/}/g) ?? []).length;
if (open === 0 || open !== close) {
throw new Error('GraphQL query has unbalanced braces');
}
const MAX_QUERY_DEPTH = 10;
let depth = 0;
let maxDepth = 0;
for (const ch of query) {
if (ch === '{') {
depth++;
if (depth > maxDepth) maxDepth = depth;
} else if (ch === '}') {
depth--;
}
if (maxDepth > MAX_QUERY_DEPTH) {
throw new Error(`GraphQL query exceeds maximum depth of ${MAX_QUERY_DEPTH}`);
}
}
}
// Wraps fetchWithRetry to also retry on GraphQL-level RATE_LIMITED errors
// that GitHub returns with HTTP 200 OK instead of 429.
async function fetchGraphQLWithRetry(
url: string | URL,
options: RequestInit,
attempt = 0,
timeoutMs?: number,
userToken?: string
): Promise<Response> {
if (attempt === 0) assertValidGraphQLBody(options);
const res = await fetchWithRetry(url, options, attempt, timeoutMs, userToken);
if (!res.ok || attempt >= MAX_RETRIES) return res;
const body: unknown = await res
.clone()
.json()
.catch(() => null);
const isBodyRateLimited =
Array.isArray((body as { errors?: unknown })?.errors) &&
(body as { errors: unknown[] }).errors.some(
(e) =>
(e as { type?: string })?.type === 'RATE_LIMITED' ||
(e as { message?: string })?.message?.toLowerCase().includes('rate limit')
);
if (!isBodyRateLimited) return res;
const delay = getJitteredBackoff(attempt);
await new Promise((resolve) => setTimeout(resolve, delay));
return fetchGraphQLWithRetry(url, options, attempt + 1, timeoutMs, userToken);
}
const GITHUB_GRAPHQL_URL = 'https://api.github.com/graphql';
const GITHUB_REST_URL = 'https://api.github.com';
type GitHubRateLimitInfo = {
limit: number | null;
remaining: number | null;
reset: number | null;
resetAt: string | null;
};
function parseRateLimitHeader(value: string | null): number | null {
if (!value) return null;
const parsed = parseInt(value, 10);
return Number.isFinite(parsed) ? parsed : null;
}
function getGitHubRateLimitInfo(res: Response): GitHubRateLimitInfo {
const limit = parseRateLimitHeader(res.headers.get('x-ratelimit-limit'));
const remaining = parseRateLimitHeader(res.headers.get('x-ratelimit-remaining'));
const reset = parseRateLimitHeader(res.headers.get('x-ratelimit-reset'));
return {
limit,
remaining,
reset,
resetAt: reset ? new Date(reset * 1000).toISOString() : null,
};
}
// Extract rate limit telemetry headers if available
function createRateLimitError(res: Response): RateLimitError {
const limitHeader = res.headers.get('x-ratelimit-limit');
const remainingHeader = res.headers.get('x-ratelimit-remaining');
const resetHeader = res.headers.get('x-ratelimit-reset');
const now = Date.now();
let retryAfterMs = 60000; // Default 1-minute safety window
if (resetHeader) {
const resetUnixTimeSeconds = parseInt(resetHeader, 10);
if (!isNaN(resetUnixTimeSeconds)) {
retryAfterMs = Math.max(0, resetUnixTimeSeconds * 1000 - now);
}
}
return new RateLimitError(
`GitHub API rate limit exceeded. Limit: ${limitHeader || 'unknown'}, Remaining: ${remainingHeader || '0'}.`,
retryAfterMs
);
}
function throwIfRateLimited(res: Response): void {
const rateLimit = getGitHubRateLimitInfo(res);
if (res.status === 403 && rateLimit.remaining === 0) {
throw createRateLimitError(res);
}
if (res.status === 429) {
throw createRateLimitError(res);
}
}
interface GitHubGraphQLResponse {
data?: {
user: {
contributionsCollection: {
totalPullRequestContributions: number;
totalIssueContributions: number;
totalPullRequestReviewContributions: number;
contributionCalendar: ContributionCalendar;
commitContributionsByRepository: RepoContribution[];
};
} | null;
};
errors?: unknown;
}
interface GitHubContributedReposResponse {
data?: {
user: {
repositoriesContributedTo: {
nodes: ContributedRepo[];
pageInfo: {
hasNextPage: boolean;
endCursor: string | null;
};
} | null;
} | null;
};
errors?: unknown;
}
function getGraphQLErrorMessage(errors: unknown): string {
if (!Array.isArray(errors)) return 'GitHub GraphQL API returned an unknown error';
const firstError = errors[0];
if (
firstError !== null &&
typeof firstError === 'object' &&
'message' in firstError &&
typeof firstError.message === 'string'
) {
return firstError.message;
}
return 'GitHub GraphQL API returned an unknown error';
}
type FetchOptions = {
bypassCache?: boolean;
forceRefresh?: boolean;
from?: string;
to?: string;
rangeLabel?: string;
signal?: AbortSignal;
org?: string;
excludeBots?: boolean;
// Authenticated user's OAuth token. When set, GitHub calls use THIS token
// (the user's personal rate-limit quota) instead of the global PAT pool.
token?: string;
};
export const GITHUB_CACHE_TTL_MS = Number(process.env.GITHUB_CACHE_TTL_MS ?? String(5 * 60 * 1000));
export interface CachedContributions {
data: ExtendedContributionData;
fetchedAt: number;
}
export const contributionsCache = new DistributedCache<CachedContributions>(1000);
export const profileCache = new DistributedCache<GitHubUserProfile>(1000);
const reposCache = new DistributedCache<GitHubRepo[]>(500);
const contributedReposCache = new DistributedCache<ContributedRepo[]>(500);
const popularReposCache = new DistributedCache<PopularRepo[]>(500);
const pinnedReposCache = new DistributedCache<PopularRepo[]>(500);
const starredReposCache = new DistributedCache<PopularRepo[]>(500);
const deploymentsCache = new DistributedCache<import('../types/dashboard').DeploymentData[]>(500);
interface GitHubUserProfile {
login: string;
name: string | null;
avatar_url: string;
public_repos: number;
followers: number;
following: number;
created_at: string;
bio: string | null;
location: string | null;
type?: string;
plan?: { name?: string } | null;
isOfflineFallback?: boolean;
}
function sanitizeUserProfile(profile: GitHubUserProfile): GitHubUserProfile {
return {
login: profile.login,
name: profile.name,
avatar_url: profile.avatar_url,
public_repos: profile.public_repos,
followers: profile.followers,
following: profile.following,
created_at: profile.created_at,
bio: profile.bio,
location: profile.location,
type: profile.type,
plan: profile.plan ? { name: profile.plan.name } : null,
};
}
function sanitizeRepo(repo: GitHubRepo): GitHubRepo {
return {
name: repo.name,
stargazers_count: repo.stargazers_count,
language: repo.language,
fork: repo.fork,
forks_count: repo.forks_count,
updated_at: repo.updated_at,
pushed_at: repo.pushed_at,
created_at: repo.created_at,
owner: repo.owner,
homepage: repo.homepage,
};
}
export function cacheKey(
kind:
| 'contributions'
| 'profile'
| 'repos'
| 'repos:contributed'
| 'popular'
| 'pinned'
| 'starred'
| 'deployments',
username: string,
year?: string,
to?: string,
org?: string
): string;
export function cacheKey(
kind:
| 'contributions'
| 'profile'
| 'repos'
| 'repos:contributed'
| 'popular'
| 'pinned'
| 'starred'
| 'deployments',
username: string,
from?: string,
to?: string,
org?: string
): string;
export function cacheKey(
kind:
| 'contributions'
| 'profile'
| 'repos'
| 'repos:contributed'
| 'popular'
| 'pinned'
| 'starred'
| 'deployments',
username: string,
yearOrFrom?: string,
to?: string,
org?: string
): string {
let keyStr = '';
if (yearOrFrom && to) {
keyStr = `${kind}:${username.toLowerCase()}:${yearOrFrom.substring(0, 10)}:${to.substring(0, 10)}`;
} else if (yearOrFrom) {
keyStr = `${kind}:${username.toLowerCase()}:${yearOrFrom.substring(0, 4)}`;
} else {
keyStr = `${kind}:${username.toLowerCase()}`;
}
if (org) {
keyStr += `:org:${org.toLowerCase()}`;
}
return keyStr;
}
export function clearGitHubApiCacheForTests(): void {
contributionsCache.clear();
profileCache.clear();
reposCache.clear();
contributedReposCache.clear();
popularReposCache.clear();
pinnedReposCache.clear();
starredReposCache.clear();
deploymentsCache.clear();
rateLimitedTokens.clear();
orgNodeIdCache.clear();
tokenStats.clear();
pendingRefreshPromises.clear();
currentTokenIndex = 0;
// Issue #7380: reset the mutex so tests start from a clean (unlocked) state.
tokenIndexLock = Promise.resolve();
globalCircuitBreakerOpenUntil = 0;
activeProfilePromises.clear();
activeContributionsPromises.clear();
}
function getGitHubToken(): string {
const tokens = getGitHubTokens();
const MISSING_GITHUB_TOKEN_MESSAGE = 'GitHub token is missing. Set GITHUB_PAT or GITHUB_TOKEN.';
if (tokens.length === 0) {
throw new Error(MISSING_GITHUB_TOKEN_MESSAGE);
}
const now = Date.now();
const tokenSet = new Set(tokens);
// Clear expired and missing env tokens from map
for (const [t, expiry] of rateLimitedTokens.entries()) {
if (now >= expiry || !tokenSet.has(t)) {
rateLimitedTokens.delete(t);
}
}
// Clear missing env tokens from tokenStats
for (const t of tokenStats.keys()) {
if (!tokenSet.has(t)) {
tokenStats.delete(t);
}
}
// Find all active (non-rate-limited) tokens
const activeTokens: string[] = [];
for (const token of tokens) {
const expiry = rateLimitedTokens.get(token);
if (expiry && now < expiry) {
continue;
}
const stats = tokenStats.get(token);
if (stats && stats.remaining === 0 && stats.resetTime > now) {
continue;
}
activeTokens.push(token);
}
if (activeTokens.length > 0) {
// Separate into known and unknown
const unknownTokens = activeTokens.filter((t) => !tokenStats.has(t));
let bestToken = '';
if (unknownTokens.length > 0) {
// Two-phase fallback: pick the next unknown token in round-robin order
let bestTokenIndex = -1;
for (let i = 0; i < tokens.length; i++) {
const idx = (currentTokenIndex + i) % tokens.length;
const token = tokens[idx];
if (unknownTokens.includes(token)) {
bestToken = token;
bestTokenIndex = idx;
break;
}
}
if (bestTokenIndex !== -1) {
currentTokenIndex = bestTokenIndex;
return bestToken;
}
} else {
// All active tokens have known stats: pick the one with the highest remaining quota
let maxRemaining = -1;
let bestIndex = -1;
for (const token of activeTokens) {
const stats = tokenStats.get(token)!;
if (stats.remaining > maxRemaining) {
maxRemaining = stats.remaining;
bestToken = token;
bestIndex = tokens.indexOf(token);
}
}
if (bestIndex !== -1) {
currentTokenIndex = bestIndex;
return bestToken;
}
}
}
// Calculate the optimal, absolute earliest reset timestamp if all tokens are limited
const resetTimes: number[] = [];
for (const token of tokens) {
const expiry = rateLimitedTokens.get(token);
if (expiry) {
resetTimes.push(expiry);
}
const stats = tokenStats.get(token);
if (stats) {
resetTimes.push(stats.resetTime);
}
}
const earliestResetTime = resetTimes.length > 0 ? Math.min(...resetTimes) : now + 60 * 1000;
const backoffMs = Math.max(0, earliestResetTime - now);
// Trip the global circuit breaker state immediately
globalCircuitBreakerOpenUntil = earliestResetTime;
// Throw RateLimitError
throw new RateLimitError('API Rate Limit Exceeded', backoffMs);
}
/**
* Issue #7213: Handles token expiration with a per-token pending refresh promise pattern.
* When multiple concurrent requests detect an expired token, only one triggers
* the rotation; subsequent requests await the same in-flight promise.
*
* This prevents:
* - Double rotation: skipping a healthy token in the pool
* - Stale token use: continued use of a token that was already rotated
* - Lost token state: overwritten rate-limit tracking
*/
export async function handleTokenExpiration(token: string): Promise<void> {
if (pendingRefreshPromises.has(token)) {
await pendingRefreshPromises.get(token)!;
return;
}
const refreshPromise = (async () => {
rateLimitedTokens.set(token, Date.now() + 24 * 60 * 60 * 1000);
// Issue #7380: advance the rotation index under the mutex so concurrent
// expiration handlers cannot both read then write the same value.
await withTokenIndexLock(() => {
const tokens = getGitHubTokens();
if (tokens.length > 1) {
currentTokenIndex = (currentTokenIndex + 1) % tokens.length;
}
});
})();
pendingRefreshPromises.set(token, refreshPromise);
try {
await refreshPromise;
} finally {
pendingRefreshPromises.delete(token);
}
}
export const getHeaders = (userToken?: string) => ({
Authorization: `bearer ${userToken || getGitHubToken()}`,
'Content-Type': 'application/json',
});
export function displayName(profile: GitHubUserProfile): string {
if (typeof profile.name === 'string' && profile.name.trim() !== '') return profile.name;
return profile.login;
}
export function getCircuitTelemetry() {
const now = Date.now();
const isOpen = now < globalCircuitBreakerOpenUntil;
return {
isOpen,
resetInMs: isOpen ? Math.max(0, globalCircuitBreakerOpenUntil - now) : 0,
};
}
/* ==========================================================================
* DATA FETCHING
* ========================================================================== */
const FETCH_TIMEOUT_MS = Number(process.env.GITHUB_FETCH_TIMEOUT_MS ?? '4000');
const activeContributionsPromises = new Map<string, Promise<ExtendedContributionData>>();
const activeProfilePromises = new Map<string, Promise<GitHubUserProfile>>();
export function getMockContributions(): ExtendedContributionData {
return {
calendar: {
totalContributions: 0,
weeks: [],
lastSyncedAt: new Date().toISOString(),
},
repoContributions: [],
totalPRs: 0,
totalIssues: 0,
totalReviews: 0,
isOfflineFallback: true,
};
}
export async function fetchGitHubContributions(
username: string,
options: FetchOptions = {}
): Promise<ExtendedContributionData> {
const key = cacheKey('contributions', username, options.from, options.to, options.org);
const LONG_CACHE_TTL = Number(
process.env.GITHUB_LONG_CACHE_TTL_MS ?? String(7 * 24 * 60 * 60 * 1000)
);
const loadWithTimeout = async (): Promise<ExtendedContributionData> => {
const controller = new AbortController();
if (options.signal) {
if (options.signal.aborted) {
controller.abort();
} else {
options.signal.addEventListener('abort', () => controller.abort(), { once: true });
}
}
let timerId = null;
const timeoutPromise = new Promise<never>((_, reject) => {
timerId = setTimeout(() => {
controller.abort();
reject(new Error(`GitHub API request timed out after ${FETCH_TIMEOUT_MS / 1000}s`));
}, FETCH_TIMEOUT_MS);
if (timerId && typeof timerId.unref === 'function') {
timerId.unref();
}
});
try {
return await Promise.race([
fetchContributionsUncached(username, key, { ...options, signal: controller.signal }),
timeoutPromise,
]);
} finally {
if (timerId) {
clearTimeout(timerId);
}
}
};
const coalescedLoad = () => {
if (options.signal) {
return loadWithTimeout();
}
let pending = activeContributionsPromises.get(key);
if (!pending) {
pending = loadWithTimeout().finally(() => {
activeContributionsPromises.delete(key);
});
activeContributionsPromises.set(key, pending);
// Safety max-age cleanup: remove from promise map after 30 seconds anyway
const timer = setTimeout(() => {
activeContributionsPromises.delete(key);
}, 30000);
if (timer && typeof timer.unref === 'function') {
timer.unref();