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

feat(3146): Skip requests to GitHub if scmRepo is available [2] #231

Merged
merged 1 commit into from
Jul 18, 2024
Merged

feat(3146): Skip requests to GitHub if scmRepo is available [2] #231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
121 changes: 93 additions & 28 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,7 @@ class GithubScm extends Scm {
if (scmRepo) {
repoFullName = scmRepo.name;
privateRepo = scmRepo.privateRepo || false;
defaultBranch = scmRepo.branch;
} else {
try {
const myHost = this.config.gheHost || 'github.com';
Expand Down Expand Up @@ -368,14 +369,15 @@ class GithubScm extends Scm {
* @param {Object} config
* @param {String} config.scmUri The scmUri to get PR info of
* @param {String} config.token The token used to authenticate to the SCM
* @param {Object} [config.scmRepo] The SCM repository to look up
* @param {Integer} config.prNum The PR number used to fetch the PR
* @param {Integer} count The polling count
* @return {Promise} Resolves to object containing result of computing mergeability
* The parameter of success exists for testing
*/
async waitPrMergeability({ scmUri, token, prNum }, count) {
async waitPrMergeability({ scmUri, token, scmRepo, prNum }, count) {
try {
const pullRequestInfo = await this.getPrInfo({ scmUri, token, prNum });
const pullRequestInfo = await this.getPrInfo({ scmUri, token, scmRepo, prNum });

if (pullRequestInfo.mergeable !== null && pullRequestInfo.mergeable !== undefined) {
return { success: pullRequestInfo.mergeable, pullRequestInfo };
Expand All @@ -392,7 +394,7 @@ class GithubScm extends Scm {
throw err;
}

return this.waitPrMergeability({ scmUri, token, prNum }, count + 1);
return this.waitPrMergeability({ scmUri, token, scmRepo, prNum }, count + 1);
}

/**
Expand Down Expand Up @@ -625,15 +627,22 @@ class GithubScm extends Scm {
* @param {Object} config Config object
* @param {String} config.scmUri The SCM URI to add the webhook to
* @param {String} config.token Service token to authenticate with Github
* @param {Object} [config.scmRepo] The SCM repo to look up
* @param {String} config.webhookUrl The URL to use for the webhook notifications
* @param {Array} config.actions The list of actions to be added for this webhook
* @return {Promise} Resolve means operation completed without failure
*/
async _addWebhook(config) {
const scmInfo = await this.lookupScmUri({
const lookupConfig = {
scmUri: config.scmUri,
token: config.token
});
};

if (config.scmRepo) {
lookupConfig.scmRepo = config.scmRepo;
}

const scmInfo = await this.lookupScmUri(lookupConfig);
const hookInfo = await this._findWebhook({
scmInfo,
url: config.webhookUrl,
Expand Down Expand Up @@ -900,15 +909,22 @@ class GithubScm extends Scm {
* Get a list of names and references of opened PRs
* @async _getOpenedPRs
* @param {Object} config
* @param {String} config.scmUri The scmUri to get opened PRs from
* @param {String} config.token The token used to authenticate with the SCM
* @return {Promise} Resolves to an array of objects storing opened PR names and refs
* @param {String} config.scmUri The scmUri to get opened PRs from
* @param {String} config.token The token used to authenticate with the SCM
* @param {Object} [config.scmRepo] The SCM repo to look up
* @return {Promise} Resolves to an array of objects storing opened PR names and refs
*/
async _getOpenedPRs({ scmUri, token }) {
const { owner, repo } = await this.lookupScmUri({
async _getOpenedPRs({ scmUri, token, scmRepo }) {
const lookupConfig = {
scmUri,
token
});
};

if (scmRepo) {
lookupConfig.scmRepo = scmRepo;
}

const { owner, repo } = await this.lookupScmUri(lookupConfig);

try {
const pullRequests = await this.breaker.runCommand({
Expand Down Expand Up @@ -1129,18 +1145,36 @@ class GithubScm extends Scm {
* @param {String} config.sha The sha to apply the status to
* @param {String} config.buildStatus The build status used for figuring out the commit status to set
* @param {String} config.token The token used to authenticate to the SCM
* @param {Object} [config.scmRepo] The SCM repo to look up
* @param {String} config.jobName Optional name of the job that finished
* @param {String} config.url Target url
* @param {Number} config.pipelineId Pipeline Id
* @param {String} config.context Status context
* @param {String} config.description Status description
* @return {Promise} Resolves when operation completed
*/
async _updateCommitStatus({ scmUri, sha, buildStatus, token, jobName, url, pipelineId, context, description }) {
const { owner, repo } = await this.lookupScmUri({
async _updateCommitStatus({
scmUri,
sha,
buildStatus,
token,
scmRepo,
jobName,
url,
pipelineId,
context,
description
}) {
const lookupConfig = {
scmUri,
token
});
};

if (scmRepo) {
lookupConfig.scmRepo = scmRepo;
}

const { owner, repo } = await this.lookupScmUri(lookupConfig);
const statusTitle = context
? `Screwdriver/${pipelineId}/${context}`
: `Screwdriver/${pipelineId}/${jobName.replace(/^PR-\d+/g, 'PR')}`; // (e.g. Screwdriver/12/PR:main)
Expand Down Expand Up @@ -1314,16 +1348,23 @@ class GithubScm extends Scm {
* Decorate the commit based on the repository
* @async _decorateCommit
* @param {Object} config
* @param {Object} config.scmUri SCM URI the commit belongs to
* @param {Object} config.sha SHA to decorate data with
* @param {Object} config.token Service token to authenticate with Github
* @return {Promise} Resolves to decorated commit object
* @param {Object} config.scmUri SCM URI the commit belongs to
* @param {Object} config.sha SHA to decorate data with
* @param {Object} config.token Service token to authenticate with Github
* @param {Object} [config.scmRepo] The SCM repo to look up
* @return {Promise} Resolves to decorated commit object
*/
async _decorateCommit(config) {
const scmInfo = await this.lookupScmUri({
const lookupConfig = {
scmUri: config.scmUri,
token: config.token
});
};

if (config.scmRepo) {
lookupConfig.scmRepo = config.scmRepo;
}

const scmInfo = await this.lookupScmUri(lookupConfig);

try {
const commit = await this.breaker.runCommand({
Expand Down Expand Up @@ -1422,16 +1463,26 @@ class GithubScm extends Scm {
* @param {String} config.type Can be 'pr' or 'repo'
* @param {Object} [config.webhookConfig] The webhook payload received from the SCM service.
* @param {String} config.token Service token to authenticate with Github
* @param {Object} [config.scmRepo] The SCM repo to look up
* @param {String} [config.scmUri] The scmUri to get PR info of
* @param {Integer} [config.prNum] The PR number
* @return {Promise} Resolves to an array of filenames of the changed files
*/
async _getChangedFiles({ type, webhookConfig, token, scmUri, prNum }) {
async _getChangedFiles({ type, webhookConfig, token, scmRepo, scmUri, prNum }) {
if (type === 'pr') {
try {
await this.waitPrMergeability({ scmUri, token, prNum }, 0);
await this.waitPrMergeability({ scmUri, token, scmRepo, prNum }, 0);

const scmInfo = await this.lookupScmUri({ scmUri, token });
const lookupConfig = {
scmUri,
token
};

if (scmRepo) {
lookupConfig.scmRepo = scmRepo;
}

const scmInfo = await this.lookupScmUri(lookupConfig);
const files = await this.breaker.runCommand({
scopeType: 'paginate',
route: 'GET /repos/:owner/:repo/pulls/:pull_number/files',
Expand Down Expand Up @@ -1691,6 +1742,7 @@ class GithubScm extends Scm {
* @param {Object} [config.scmRepo] The SCM repository to look up
* @param {String} config.scmUri The scmUri to get PR info of
* @param {String} config.token The token used to authenticate to the SCM
* @param {Object} [config.scmRepo] The SCM repo to look up
* @param {Integer} config.prNum The PR number used to fetch the PR
* @return {Promise}
*/
Expand Down Expand Up @@ -1755,14 +1807,20 @@ class GithubScm extends Scm {
* @param {Integer} config.prNum The PR number
* @param {String} config.scmUri The SCM URI
* @param {String} config.token Service token to authenticate with Github
* @param {Object} [config.scmRepo] The SCM repo to look up
* @return {Promise} Resolves when complete
*/
async _addPrComment({ comments, jobName, prNum, scmUri, token, pipelineId }) {
const scmInfo = await this.lookupScmUri({
async _addPrComment({ comments, jobName, prNum, scmUri, token, scmRepo, pipelineId }) {
const lookupConfig = {
scmUri,
token
});
};

if (scmRepo) {
lookupConfig.scmRepo = scmRepo;
}

const scmInfo = await this.lookupScmUri(lookupConfig);
const prComments = await this.prComments(scmInfo, prNum, token);
const prCommentData = [];

Expand Down Expand Up @@ -1896,13 +1954,20 @@ class GithubScm extends Scm {
* @param {Object} config
* @param {String} config.scmUri The SCM URI to get branch list
* @param {String} config.token Service token to authenticate with Github
* @param {Object} [config.scmRepo] The SCM repo to look up
* @return {Promise} Resolves when complete
*/
async _getBranchList(config) {
const scmInfo = await this.lookupScmUri({
const lookupConfig = {
scmUri: config.scmUri,
token: config.token
});
};

if (config.scmRepo) {
lookupConfig.scmRepo = config.scmRepo;
}

const scmInfo = await this.lookupScmUri(lookupConfig);

return this._findBranches({
scmInfo,
Expand Down
Loading