Marco Pasqualettiandmartin-mfg
8c065b473f
* tests: fix float problems and PAT problem * extend CONTRIBUTING.md * extend build documentation, add GH action, fix build on MacOS * fix build on Vercel * update .gitignore and CONTRIBUTING.md * feat: begin work on monorepo * chore(actions/basic-build): use pnpm * fix: vercel-deploy * docs: updates with new folders * chore: apply PR review comments --------- Co-authored-by: martin-mfg <2026226+martin-mfg@users.noreply.github.com>
125 lines
2.8 KiB
JavaScript
125 lines
2.8 KiB
JavaScript
// @ts-check
|
|
|
|
/**
|
|
* @file Contains a simple cloud function that can be used to check if the PATs are still
|
|
* functional.
|
|
*
|
|
* @description This function is currently rate limited to 1 request per 3 minutes.
|
|
*/
|
|
|
|
import { request } from "../../src/common/http.js";
|
|
import retryer from "../../src/common/retryer.js";
|
|
import { logger } from "../../src/common/log.js";
|
|
|
|
export const RATE_LIMIT_SECONDS = 60 * 3; // 1 request per 3 minutes
|
|
|
|
/**
|
|
* Simple uptime check fetcher for the PATs.
|
|
*
|
|
* @param {any} variables Fetcher variables.
|
|
* @param {string} token GitHub token.
|
|
* @returns {Promise<import('axios').AxiosResponse>} The response.
|
|
*/
|
|
const uptimeFetcher = (variables, token) => {
|
|
return request(
|
|
{
|
|
query: `
|
|
query {
|
|
rateLimit {
|
|
remaining
|
|
}
|
|
}
|
|
`,
|
|
variables,
|
|
},
|
|
{
|
|
Authorization: `bearer ${token}`,
|
|
},
|
|
);
|
|
};
|
|
|
|
/**
|
|
* @typedef {{
|
|
* schemaVersion: number;
|
|
* label: string;
|
|
* message: "up" | "down";
|
|
* color: "brightgreen" | "red";
|
|
* isError: boolean
|
|
* }} ShieldsResponse Shields.io response object.
|
|
*/
|
|
|
|
/**
|
|
* Creates Json response that can be used for shields.io dynamic card generation.
|
|
*
|
|
* @param {boolean} up Whether the PATs are up or not.
|
|
* @returns {ShieldsResponse} Dynamic shields.io JSON response object.
|
|
*
|
|
* @see https://shields.io/endpoint.
|
|
*/
|
|
const shieldsUptimeBadge = (up) => {
|
|
const schemaVersion = 1;
|
|
const isError = true;
|
|
const label = "Public Instance";
|
|
const message = up ? "up" : "down";
|
|
const color = up ? "brightgreen" : "red";
|
|
return {
|
|
schemaVersion,
|
|
label,
|
|
message,
|
|
color,
|
|
isError,
|
|
};
|
|
};
|
|
|
|
/**
|
|
* Cloud function that returns whether the PATs are still functional.
|
|
*
|
|
* @param {any} req The request.
|
|
* @param {any} res The response.
|
|
* @returns {Promise<void>} Nothing.
|
|
*/
|
|
export default async (req, res) => {
|
|
let { type } = req.query;
|
|
type = type ? type.toLowerCase() : "boolean";
|
|
|
|
res.setHeader("Content-Type", "application/json");
|
|
|
|
try {
|
|
let PATsValid = true;
|
|
try {
|
|
await retryer(uptimeFetcher, null, {});
|
|
} catch (err) {
|
|
// Resolve eslint no-unused-vars
|
|
err;
|
|
|
|
PATsValid = false;
|
|
}
|
|
|
|
if (PATsValid) {
|
|
res.setHeader(
|
|
"Cache-Control",
|
|
`max-age=0, s-maxage=${RATE_LIMIT_SECONDS}`,
|
|
);
|
|
} else {
|
|
res.setHeader("Cache-Control", "no-store");
|
|
}
|
|
|
|
switch (type) {
|
|
case "shields":
|
|
res.send(shieldsUptimeBadge(PATsValid));
|
|
break;
|
|
case "json":
|
|
res.send({ up: PATsValid });
|
|
break;
|
|
default:
|
|
res.send(PATsValid);
|
|
break;
|
|
}
|
|
} catch (err) {
|
|
// Return fail boolean if something went wrong.
|
|
logger.error(err);
|
|
res.setHeader("Cache-Control", "no-store");
|
|
res.send("Something went wrong: " + err.message);
|
|
}
|
|
};
|