Skip to content

Commit

Permalink
Refactor
Browse files Browse the repository at this point in the history
  • Loading branch information
@siddheshranade
siddheshranade committed Jan 30, 2024
1 parent 96b54d5 commit 96ecaeb
Showing 1 changed file with 109 additions and 87 deletions.
196 changes: 109 additions & 87 deletions .github/actions/check-for-CLA/index.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,150 +3,172 @@ import { google } from "googleapis";
import Handlebars from "handlebars";
import fs from "fs-extra";

const GITHUB_REPOSITORY = process.env.GITHUB_REPOSITORY || "mockOwner/mockRepo";

// TODO: remove hardcoded id; `id: process.env.PR_NUMBER`
const PULL_REQUST_INFO = {
id: 11781,
owner: process.env.GITHUB_REPOSITORY.split('/')[0],
repoName: process.env.GITHUB_REPOSITORY.split('/')[1],
id: process.env.PR_NUMBER || 11781,
owner: GITHUB_REPOSITORY.split("/")[0],
repoName: GITHUB_REPOSITORY.split("/")[1],
username: process.env.GITHUB_ACTOR,
gitHubToken: process.env.GITHUB_TOKEN
gitHubToken: process.env.GITHUB_TOKEN,
};

/* TODO: 1. Replace with actual Cesium CLA spreadsheet Ids, 2. Retrieve Ids from GitHub Secrets, not expose */
const GOOGLE_SHEETS_INFO = {
individualCLASheetId: 'abcd',
corporateCLASheetId: 'efgh'
individualCLASheetId: "abcd",
corporateCLASheetId: "efgh",
};

/* TODO: Change to actual link */
const LINKS = {
contributorsListURL: 'https://google.com'
contributorsListURL: "https://google.com",
};

const main = async () => {
console.log('main()');
console.log(PULL_REQUST_INFO.repoName, PULL_REQUST_INFO.owner, PULL_REQUST_INFO.username);
console.log("main()");
console.log(
PULL_REQUST_INFO.repoName,
PULL_REQUST_INFO.owner,
PULL_REQUST_INFO.username
);

let hasSignedCLA;
let errorFoundOnCLACheck;

try {
hasSignedCLA = await checkIfUserHasSignedAnyCLA();
} catch (error) {
console.log('ERROR2 ', error);
console.log("ERROR2 ", error);
errorFoundOnCLACheck = error.toString();
}

console.log('pre-comment...');
const response = await postCommentOnPullRequest(hasSignedCLA, errorFoundOnCLACheck);
console.log('post-comment, response: ', response);
console.log("pre-comment...");
const response = await postCommentOnPullRequest(
hasSignedCLA,
errorFoundOnCLACheck
);
console.log("post-comment, response: ", response);
};

const checkIfUserHasSignedAnyCLA = async () => {
const googleSheetsApi = await getGoogleSheetsApiClient();

let foundIndividualCLA = await checkIfIndividualCLAFound(googleSheetsApi);
console.log('CLA #1 ', foundIndividualCLA);
const checkIfUserHasSignedAnyCLA = async () => {
let foundIndividualCLA = await checkIfIndividualCLAFound();
console.log("CLA #1 ", foundIndividualCLA);
if (foundIndividualCLA) {
return true;
return true;
}

let foundCorporateCLA = await checkIfCorporateCLAFound(googleSheetsApi);
console.log('CLA #2 ', foundCorporateCLA);
let foundCorporateCLA = await checkIfCorporateCLAFound();
console.log("CLA #2 ", foundCorporateCLA);
return foundCorporateCLA;
};

const getGoogleSheetsApiClient = async () => {
const auth = new google.auth.GoogleAuth({
// TODO: 1. Get similar config file for Cesium Google account, 2. Retrive file from secrets and remove from source control
keyFile: 'TempGoogleConfig.json',
scopes: ['https://www.googleapis.com/auth/spreadsheets']
});
const googleAuthClient = await auth.getClient();

return google.sheets({version: 'v4', auth: googleAuthClient });
};

const checkIfIndividualCLAFound = async (googleSheetsApi) => {
const response = await googleSheetsApi.spreadsheets.values.get({
spreadsheetId: GOOGLE_SHEETS_INFO.individualCLASheetId,
range: 'D2:D'
});
const checkIfIndividualCLAFound = async () => {
const response = await getValuesFromGoogleSheet(
GOOGLE_SHEETS_INFO.individualCLASheetId,
"D2:D"
);

const rows = response.data.values;
for (let i = 0; i < rows.length; i++) {
if(rows[i].length === 0) {
continue;
}
if (rows[i].length === 0) {
continue;
}

const rowUsername = rows[i][0].toLowerCase();
if (PULL_REQUST_INFO.username.toLowerCase() === rowUsername) {
return true;
}
const rowUsername = rows[i][0].toLowerCase();
if (PULL_REQUST_INFO.username.toLowerCase() === rowUsername) {
return true;
}
}

return false;
};

const checkIfCorporateCLAFound = async (googleSheetsApi) => {
const response = await googleSheetsApi.spreadsheets.values.get({
spreadsheetId: GOOGLE_SHEETS_INFO.corporateCLASheetId,
range: 'H2:H'
});
const checkIfCorporateCLAFound = async () => {
const response = await getValuesFromGoogleSheet(
GOOGLE_SHEETS_INFO.corporateCLASheetId,
"H2:H"
);

const rows = response.data.values;
for (let i = 0; i < rows.length; i++) {
if(rows[i].length === 0) {
continue;
}

// We're more lenient with the ScheduleA username check since it's an unformatted text field.
let rowScheduleA = rows[i][0].toLowerCase();
rowScheduleA = rowScheduleA.replace(/\n/g, ' ');
const words = rowScheduleA.split(' ');

for (let j = 0; j < words.length; j++) {
// Checking for substrings because many input their
// GitHub username as "github.com/username".
if (words[j].includes(PULL_REQUST_INFO.username.toLowerCase())) {
return true;
}
if (rows[i].length === 0) {
continue;
}

// We're more lenient with the ScheduleA username check since it's an unformatted text field.
let rowScheduleA = rows[i][0].toLowerCase();
rowScheduleA = rowScheduleA.replace(/\n/g, " ");
const words = rowScheduleA.split(" ");

for (let j = 0; j < words.length; j++) {
// Checking for substrings because many input their
// GitHub username as "github.com/username".
if (words[j].includes(PULL_REQUST_INFO.username.toLowerCase())) {
return true;
}
}
}

return false;
};

const getValuesFromGoogleSheet = async (sheetId, cellRanges) => {
const googleSheetsApi = await getGoogleSheetsApiClient();

return googleSheetsApi.spreadsheets.values.get({
spreadsheetId: sheetId,
range: cellRanges,
});
};

const getGoogleSheetsApiClient = async () => {
const auth = new google.auth.GoogleAuth({
// TODO: 1. Get similar config file for Cesium Google account, 2. Retrive file from secrets and remove from source control
keyFile: "TempGoogleConfig.json",
scopes: ["https://www.googleapis.com/auth/spreadsheets"],
});
const googleAuthClient = await auth.getClient();

return google.sheets({ version: "v4", auth: googleAuthClient });
};

const postCommentOnPullRequest = async (hasSignedCLA, errorFoundOnCLACheck) => {
console.log('adding comment...');

const octokit = new Octokit();
return octokit.request(`POST /repos/${PULL_REQUST_INFO.owner}/${PULL_REQUST_INFO.repoName}/issues/${PULL_REQUST_INFO.id}/comments`, {
owner: PULL_REQUST_INFO.username,
repo: PULL_REQUST_INFO.repoName,
issue_number: PULL_REQUST_INFO.id,
body: getCommentBody(hasSignedCLA, errorFoundOnCLACheck),
headers: {
authorization: `bearer ${PULL_REQUST_INFO.gitHubToken}`,
accept: 'application/vnd.github+json',
'X-GitHub-Api-Version': '2022-11-28'
}
});
console.log("adding comment...");

const octokit = new Octokit();
return octokit.request(
`POST /repos/${PULL_REQUST_INFO.owner}/${PULL_REQUST_INFO.repoName}/issues/${PULL_REQUST_INFO.id}/comments`,
{
owner: PULL_REQUST_INFO.username,
repo: PULL_REQUST_INFO.repoName,
issue_number: PULL_REQUST_INFO.id,
body: getCommentBody(hasSignedCLA, errorFoundOnCLACheck),
headers: {
authorization: `bearer ${PULL_REQUST_INFO.gitHubToken}`,
accept: "application/vnd.github+json",
"X-GitHub-Api-Version": "2022-11-28",
},
}
);
};

const getCommentBody = (hasSignedCLA, errorFoundOnCLACheck) => {
console.log('getting comment template...');
console.log("getting comment template...");

const commentTemplate = fs.readFileSync('./.github/actions/check-for-CLA/templates/pullRequestComment.hbs', 'utf-8');
const commentTemplate = fs.readFileSync(
"./.github/actions/check-for-CLA/templates/pullRequestComment.hbs",
"utf-8"
);
const getTemplate = Handlebars.compile(commentTemplate);
const commentBody = getTemplate({
errorCla: errorFoundOnCLACheck,
hasCla: hasSignedCLA,
username: PULL_REQUST_INFO.username,
contributorsUrl: LINKS.contributorsListURL
});
const commentBody = getTemplate({
errorCla: errorFoundOnCLACheck,
hasCla: hasSignedCLA,
username: PULL_REQUST_INFO.username,
contributorsUrl: LINKS.contributorsListURL,
});

return commentBody;
};

main();
main();

0 comments on commit 96ecaeb

Please sign in to comment.