FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
angular/.circleci/get-commit-range.js at master · al-ramirez/angular · GitHub
al-ramirez
/
angular
Public
forked from
angular/angular
Notifications
You must be signed in to change notification settings
Fork
0
Star
0
Code
Pull requests
0
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Pull requests
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
angular
/
.circleci
/
get-commit-range.js
Copy path
More file actions
More file actions
Latest commit
History
History
History
159 lines (144 loc) · 5.32 KB
Breadcrumbs
angular
/
.circleci
/
get-commit-range.js
Copy path
File metadata and controls
159 lines (144 loc) · 5.32 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
#!/usr/bin/env node
/**
* **Usage:**
* ```
* node get-commit-range <build-number> [<compare-url> [<circle-token>]]
* ```
*
* Returns the value of the `CIRCLE_COMPARE_URL` environment variable (if defined) or, if this is
* not a PR build (i.e. `CIRCLE_PR_NUMBER` is not defined), retrieves the equivalent of
* `CIRCLE_COMPARE_URL` for jobs that are part of a rerun workflow.
*
* **Context:**
* CircleCI sets the `CIRCLE_COMPARE_URL` environment variable (from which we can extract the commit
* range) on push builds (a.k.a. non-PR, non-scheduled builds). Yet, when a workflow is rerun
* (either from the beginning or from failed jobs) - e.g. when a job flakes - CircleCI does not set
* the `CIRCLE_COMPARE_URL`.
*
* **Implementation details:**
* This script relies on the fact that all rerun workflows share the same CircleCI workspace and the
* (undocumented) fact that the workspace ID happens to be the same as the workflow ID that first
* created it.
*
* For example, for a job on push build workflow, the CircleCI API will return data that look like:
* ```js
* {
* compare: 'THE_COMPARE_URL_WE_ARE_LOOKING_FOR',
* //...
* previous: {
* // ...
* build_num: 12345,
* },
* //...
* workflows: {
* //...
* workflow_id: 'SOME_ID_A',
* workspace_id: 'SOME_ID_A', // Same as `workflow_id`.
* }
* }
* ```
*
* If the workflow is rerun, the data for jobs on the new workflow will look like:
* ```js
* {
* compare: null, // ¯\_(ツ)_/¯
* //...
* previous: {
* // ...
* build_num: 23456,
* },
* //...
* workflows: {
* //...
* workflow_id: 'SOME_ID_B',
* workspace_id: 'SOME_ID_A', // Different from current `workflow_id`.
* // Same as original `workflow_id`. \o/
* }
* }
* ```
*
* This script uses the `previous.build_num` (which points to the previous build number on the same
* branch) to traverse the jobs backwards, until it finds a job from the original workflow. Such a
* job (if found) should also contain the compare URL.
*
* **NOTE 1:**
* This is only useful on workflows which are created by rerunning a workflow for which
* `CIRCLE_COMPARE_URL` was defined.
*
* **NOTE 2:**
* The `circleToken` will be used for CircleCI API requests if provided, but it is not needed for
* accessing the read-only endpoints that we need (as long as the current project is FOSS and the
* corresponding setting is turned on in "Advanced Settings" in the project dashboard).
*
* ---
* Inspired by https://circleci.com/orbs/registry/orb/iynere/compare-url
* (source code: https://github.com/iynere/compare-url-orb).
*
* We are not using the `compare-url` orb for the following reasons:
* 1. (By looking at the code) it would only work if the rerun workflow is the latest workflow on
* the branch (which is not guaranteed to be true).
* 2. It is less efficient (e.g. makes unnecessary CircleCI API requests for builds on different
* branches, installs extra dependencies, persists files to the workspace (as a means of passing
* the result to the calling job), etc.).
* 3. It is slightly more complicated to setup and consume than our own script.
* 4. Its implementation is more complicated than needed for our usecase (e.g. handles different git
* providers, handles newly created branches, etc.).
*/
// Imports
const
{
get
:
httpsGet
}
=
require
(
'https'
)
;
// Constants
const
API_URL_BASE
=
'https://circleci.com/api/v1.1/project/github/angular/angular'
;
const
COMPARE_URL_RE
=
/
^
.
*
\/
(
[
0
-
9
a
-
f
]
+
\.
\.
\.
[
0
-
9
a
-
f
]
+
)
$
/
i
;
// Run
_main
(
process
.
argv
.
slice
(
2
)
)
;
// Helpers
async
function
_main
(
[
buildNumber
,
compareUrl
=
''
,
circleToken
=
''
]
)
{
try
{
if
(
!
buildNumber
||
isNaN
(
buildNumber
)
)
{
throw
new
Error
(
'Missing or invalid arguments.\n'
+
'Expected: buildNumber (number), compareUrl? (string), circleToken? (string)'
)
;
}
if
(
!
compareUrl
)
{
compareUrl
=
await
getCompareUrl
(
buildNumber
,
circleToken
)
;
}
const
commitRangeMatch
=
COMPARE_URL_RE
.
exec
(
compareUrl
)
const
commitRange
=
commitRangeMatch
?
commitRangeMatch
[
1
]
:
''
;
console
.
log
(
commitRange
)
;
}
catch
(
err
)
{
console
.
error
(
err
)
;
process
.
exit
(
1
)
;
}
}
function
getBuildInfo
(
buildNumber
,
circleToken
)
{
console
.
error
(
`BUILD
${
buildNumber
}
`
)
;
const
url
=
`
${
API_URL_BASE
}
/
${
buildNumber
}
?circle-token=
${
circleToken
}
`
;
return
getJson
(
url
)
;
}
async
function
getCompareUrl
(
buildNumber
,
circleToken
)
{
let
info
=
await
getBuildInfo
(
buildNumber
,
circleToken
)
;
const
targetWorkflowId
=
info
.
workflows
.
workspace_id
;
while
(
info
.
workflows
.
workflow_id
!==
targetWorkflowId
)
{
info
=
await
getBuildInfo
(
info
.
previous
.
build_num
,
circleToken
)
;
}
return
info
.
compare
||
''
;
}
function
getJson
(
url
)
{
return
new
Promise
(
(
resolve
,
reject
)
=>
{
const
opts
=
{
headers
:
{
Accept
:
'application/json'
}
}
;
const
onResponse
=
res
=>
{
const
statusCode
=
res
.
statusCode
||
-
1
;
const
isSuccess
=
(
200
<=
statusCode
)
&&
(
statusCode
<
400
)
;
let
responseText
=
''
;
res
.
on
(
'error'
,
reject
)
.
on
(
'data'
,
d
=>
responseText
+=
d
)
.
on
(
'end'
,
(
)
=>
isSuccess
?
resolve
(
JSON
.
parse
(
responseText
)
)
:
reject
(
`Error getting '
${
url
}
' (status
${
statusCode
}
):\n
${
responseText
}
`
)
)
;
}
;
httpsGet
(
url
,
opts
,
onResponse
)
.
on
(
'error'
,
reject
)
.
end
(
)
;
}
)
;
}
Back
|
FazBrowse Home
|
New Git URL