forked from codecov/sourcegraph-codecov
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi.ts
More file actions
129 lines (117 loc) · 4 KB
/
Copy pathapi.ts
File metadata and controls
129 lines (117 loc) · 4 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
/** The arguments for getCommitCoverage. */
export interface CodecovGetCommitCoverageArgs {
/**
* The base URL of the Codecov instance.
* @example https://codecov.io
*/
baseURL: string
/** The identifier for the service where the repository lives. */
service: string
/** The value for the :owner URL parameter (the repository's owner). */
owner: string
/** The value for the :repo URL parameter (the repository's name). */
repo: string
/** The value for the :sha URL parameter (the Git commit SHA). */
sha: string
/** The Codecov API token (required for private repositories). */
token?: string
}
/** The response data from the Codecov API for a commit. */
export interface CodecovCommitData {
commit: {
commitid: string
report: {
files: {
[path: string]:
| undefined
| {
/** Line coverage data for this file at this commit.. */
l: {
/**
* The coverage for the line (1-indexed).
* @type {number} number of hits on a fully covered line
* @type {string} "(partial hits)/branches" on a partially covered line
* @type {null} skipped line
*/
[line: number]: number | string | null | undefined
}
/** Totals for this file at this commit. */
t: {
/** The coverage ratio for this file, as a string (e.g., "62.5000000"). */
c: string
}
}
}
}
totals: {
/** The coverage ratio of the repository at this commit. */
coverage: number
}
}
owner: {
/** An identifier for the code host or other service where the repository lives. */
service: 'github' | 'gitlab' | 'bitbucket'
/** For GitHub, the name of the repository's owner. */
username: string
}
repo: {
/** The repository name (without the owner). */
name: string
}
}
/**
* Gets the Codecov coverage data for a single commit of a repository.
*
* See https://docs.codecov.io/v5.0.0/reference#section-get-a-single-commit.
*/
export const codecovGetCommitCoverage = memoizeAsync(
async (args: CodecovGetCommitCoverageArgs): Promise<CodecovCommitData> =>
(await fetch(commitCoverageURL(args), {
method: 'GET',
mode: 'cors',
})).json(),
commitCoverageURL
)
/**
* Constructs the URL for Codecov coverage data for a single commit of a repository.
*
* See https://docs.codecov.io/v5.0.0/reference#section-get-a-single-commit.
*/
function commitCoverageURL({
baseURL,
service,
owner,
repo,
sha,
token,
}: CodecovGetCommitCoverageArgs): string {
const tokenSuffix = token
? `&access_token=${encodeURIComponent(token)}`
: ''
// The ?src=extension is necessary to get the data for all files in the response.
return `${baseURL}/api/${service}/${owner}/${repo}/commits/${sha}?src=extension${tokenSuffix}`
}
/**
* Creates a function that memoizes the async result of func. If the Promise is rejected, the result will not be
* cached.
*
* @param toKey etermines the cache key for storing the result based on the first argument provided to the memoized
* function
*/
function memoizeAsync<P, T>(
func: (params: P) => Promise<T>,
toKey: (params: P) => string
): (params: P) => Promise<T> {
const cache = new Map<string, Promise<T>>()
return (params: P) => {
const key = toKey(params)
const hit = cache.get(key)
if (hit) {
return hit
}
const p = func(params)
p.then(null, () => cache.delete(key))
cache.set(key, p)
return p
}
}