Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support sending more than 50 annotations to Github checks API #764

Closed
wants to merge 7 commits into from
Closed

Support sending more than 50 annotations to Github checks API #764

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e8cc907
instead of only sending first 50, chunk them into 50 and send them in a
cbackas Dec 7, 2023
946b0a0
add rate limit handling
cbackas Dec 7, 2023
be38754
format
cbackas Dec 7, 2023
d4c866a
build
cbackas Dec 7, 2023
220cca2
check for existing check before sending
cbackas Dec 8, 2023
cf05cba
use the correct request for updates
cbackas Dec 8, 2023
9ef2c2b
actually send annotations
cbackas Dec 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
151 changes: 102 additions & 49 deletions dist/index.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

131 changes: 84 additions & 47 deletions src/github/api.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,6 @@ async function createCheck(linterName, sha, context, lintResult, neutralCheckOnW
];
}

// Only use the first 50 annotations (limit for a single API request)
if (annotations.length > 50) {
core.info(
`There are more than 50 errors/warnings from ${linterName}. Annotations are created for the first 50 issues only.`,
);
annotations = annotations.slice(0, 50);
}

let conclusion;
if (lintResult.isSuccess) {
if (annotations.length > 0 && neutralCheckOnWarning) {
Expand All @@ -52,50 +44,95 @@ async function createCheck(linterName, sha, context, lintResult, neutralCheckOnW
conclusion = "failure";
}

const body = {
name: linterName,
head_sha: sha,
conclusion,
output: {
title: capitalizeFirstLetter(summary),
summary: `${linterName} found ${summary}`,
annotations,
},
const headers = {
"Content-Type": "application/json",
// "Accept" header is required to access Checks API during preview period
Accept: "application/vnd.github.antiope-preview+json",
Authorization: `Bearer ${context.token}`,
"User-Agent": actionName,
};
try {
core.info(
`Creating GitHub check with ${conclusion} conclusion and ${annotations.length} annotations for ${linterName}…`,
);
await request(`${process.env.GITHUB_API_URL}/repos/${context.repository.repoName}/check-runs`, {
method: "POST",
headers: {
"Content-Type": "application/json",
// "Accept" header is required to access Checks API during preview period
Accept: "application/vnd.github.antiope-preview+json",
Authorization: `Bearer ${context.token}`,
"User-Agent": actionName,

// GitHub only allows 50 annotations per request, chunk them and send multiple requests
const chunkSize = 50;
for (let i = 0; i < annotations.length; i += chunkSize) {
const annotationChunk = annotations.slice(i, i + chunkSize);

const checkRuns = await request(
`${process.env.GITHUB_API_URL}/repos/${context.repository.repoName}/commits/${sha}/check-runs`,
{
method: "GET",
headers,
},
body,
});
core.info(`${linterName} check created successfully`);
} catch (err) {
let errorMessage = err.message;
if (err.data) {
try {
const errorData = JSON.parse(err.data);
if (errorData.message) {
errorMessage += `. ${errorData.message}`;
}
if (errorData.documentation_url) {
errorMessage += ` ${errorData.documentation_url}`;
);
const existingRun = checkRuns.data.check_runs.find((run) => run.name === linterName);

try {
core.info(
`Creating GitHub check with ${conclusion} conclusion and ${annotations.length} annotations for ${linterName}…`,
);

if (existingRun == null) {
await request(
`${process.env.GITHUB_API_URL}/repos/${context.repository.repoName}/check-runs`,
{
method: "POST",
headers,
body: {
name: linterName,
conclusion,
head_sha: sha,
output: {
title: capitalizeFirstLetter(summary),
summary: `${linterName} found ${summary}`,
annotations: annotationChunk,
},
},
},
);

core.info(`${linterName} check created successfully`);
} else {
const existingRunId = existingRun.id;

await request(
`${process.env.GITHUB_API_URL}/repos/${context.repository.repoName}/check-runs/${existingRunId}`,
{
method: "PATCH",
headers,
body: {
name: linterName,
conclusion,
check_run_id: existingRunId,
output: {
title: capitalizeFirstLetter(summary),
summary: `${linterName} found ${summary}`,
annotations: annotationChunk,
},
},
},
);

core.info(`${linterName} check updated successfully`);
}
} catch (err) {
let errorMessage = err.message;
if (err.data) {
try {
const errorData = JSON.parse(err.data);
if (errorData.message) {
errorMessage += `. ${errorData.message}`;
}
if (errorData.documentation_url) {
errorMessage += ` ${errorData.documentation_url}`;
}
} catch (e) {
// Ignore
}
} catch (e) {
// Ignore
}
}
core.error(errorMessage);
core.error(errorMessage);

throw new Error(`Error trying to create GitHub check for ${linterName}: ${errorMessage}`);
throw new Error(`Error trying to create GitHub check for ${linterName}: ${errorMessage}`);
}
}
}

Expand Down
20 changes: 18 additions & 2 deletions src/utils/request.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ const https = require("https");
* Helper function for making HTTP requests
* @param {string | URL} url - Request URL
* @param {object} options - Request options
* @param {number} retryCount - Current attempted number of retries
* @returns {Promise<object>} - JSON response
*/
function request(url, options) {
function request(url, options, retryCount = 0) {
return new Promise((resolve, reject) => {
const req = https
.request(url, options, (res) => {
Expand All @@ -15,7 +16,21 @@ function request(url, options) {
data += chunk;
});
res.on("end", () => {
if (res.statusCode >= 400) {
if (res.statusCode === 429) {
if (retryCount < 3) {
// max retries
const retryAfter = res.headers["retry-after"]
? parseInt(res.headers["retry-after"], 10) * 1000
: 5000 * retryCount; // default backoff time if 'retry-after' header is not present
setTimeout(() => {
request(url, options, retryCount + 1)
.then(resolve)
.catch(reject);
}, retryAfter);
} else {
reject(new Error(`Max retries reached. Status code: ${res.statusCode}`));
}
} else if (res.statusCode >= 400) {
const err = new Error(`Received status code ${res.statusCode}`);
err.response = res;
err.data = data;
Expand All @@ -26,6 +41,7 @@ function request(url, options) {
});
})
.on("error", reject);

if (options.body) {
req.end(JSON.stringify(options.body));
} else {
Expand Down
Loading