fix(1769): Do not throw err if cannot get changed files #142
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adong
reviewed
Sep 30, 2019
index.js
Outdated
| @@ -478,7 +478,7 @@ class GithubScm extends Scm { | |||
|
|
|||
| /** | |||
| * Get a list of names and references of opened PRs | |||
| * @async _getOpenedPRs | |||
| * @async getOpenedPRs | |||
There was a problem hiding this comment.
Hmm, _getOpenedPRs and _ getChangedFiles are the function names
There was a problem hiding this comment.
it's not really consistent in the file 🤷♀
adong
reviewed
Sep 30, 2019
index.js
Outdated
| @@ -1236,8 +1238,9 @@ class GithubScm extends Scm { | |||
|
|
|||
| /** | |||
| * Resolve a pull request object based on the config | |||
| * @async getPrRef | |||
| * @async getPrInfo | |||
adong
requested changes
Sep 30, 2019
index.js
Outdated
| @@ -513,7 +513,8 @@ class GithubScm extends Scm { | |||
| })); | |||
| } catch (err) { | |||
| winston.error('Failed to getOpenedPRs: ', err); | |||
| throw err; | |||
|
|
|||
| return []; | |||
There was a problem hiding this comment.
If we are not returning the error, then we can return []; in finally block
There was a problem hiding this comment.
I was wrong about the previous comment. Return in finally block always override the return value in try block.
Maybe we can write something like
let pullRequests = [];
try {
pullRequests = await this.breaker.runCommand({ const pullRequests = await this.breaker.runCommand({
action: 'list', action: 'list',
scopeType: 'pulls', scopeType: 'pulls',
token, token,
params: { params: {
owner, owner,
repo, repo,
state: 'open' state: 'open'
} }
}); });
return pullRequests.data.map(pullRequest => ({ return pullRequests.data.map(pullRequest => ({
name: `PR-${pullRequest.number}`, name: `PR-${pullRequest.number}`,
ref: `pull/${pullRequest.number}/merge`, ref: `pull/${pullRequest.number}/merge`,
username: pullRequest.user.login, username: pullRequest.user.login,
title: pullRequest.title, title: pullRequest.title,
createTime: pullRequest.created_at, createTime: pullRequest.created_at,
url: pullRequest.html_url, url: pullRequest.html_url,
userProfile: pullRequest.user.html_url userProfile: pullRequest.user.html_url
})); }));
} catch (err) {
winston.error('Failed to getOpenedPRs: ', err); winston.error('Failed to getOpenedPRs: ', err);
// throw err;
} finally {
return pullRequests;
}Have a default value. 🤔
There was a problem hiding this comment.
I think it's better practice not to do return in finally
getting eslint error no-unsafe-finally when I try your suggestion
https://eslint.org/docs/rules/no-unsafe-finally
adong
requested changes
Sep 30, 2019
index.js
Outdated
| @@ -513,7 +513,8 @@ class GithubScm extends Scm { | |||
| })); | |||
| } catch (err) { | |||
| winston.error('Failed to getOpenedPRs: ', err); | |||
| throw err; | |||
|
|
|||
| return []; | |||
There was a problem hiding this comment.
I was wrong about the previous comment. Return in finally block always override the return value in try block.
Maybe we can write something like
let pullRequests = [];
try {
pullRequests = await this.breaker.runCommand({ const pullRequests = await this.breaker.runCommand({
action: 'list', action: 'list',
scopeType: 'pulls', scopeType: 'pulls',
token, token,
params: { params: {
owner, owner,
repo, repo,
state: 'open' state: 'open'
} }
}); });
return pullRequests.data.map(pullRequest => ({ return pullRequests.data.map(pullRequest => ({
name: `PR-${pullRequest.number}`, name: `PR-${pullRequest.number}`,
ref: `pull/${pullRequest.number}/merge`, ref: `pull/${pullRequest.number}/merge`,
username: pullRequest.user.login, username: pullRequest.user.login,
title: pullRequest.title, title: pullRequest.title,
createTime: pullRequest.created_at, createTime: pullRequest.created_at,
url: pullRequest.html_url, url: pullRequest.html_url,
userProfile: pullRequest.user.html_url userProfile: pullRequest.user.html_url
})); }));
} catch (err) {
winston.error('Failed to getOpenedPRs: ', err); winston.error('Failed to getOpenedPRs: ', err);
// throw err;
} finally {
return pullRequests;
}Have a default value. 🤔
adong
approved these changes
Sep 30, 2019
index.js
Outdated
| @@ -513,7 +513,8 @@ class GithubScm extends Scm { | |||
| })); | |||
| } catch (err) { | |||
| winston.error('Failed to getOpenedPRs: ', err); | |||
| throw err; | |||
|
|
|||
| return []; | |||
tkyi
changed the title
jithine
approved these changes
Oct 1, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
Sometimes when there are PRs with over 2500 files changed, the webhook will fail since the circuit breaker will timeout.
Objective
This PR does not throw errs when
getChangedFilesorgetOpenedPrscalls fail.References
Short term fix for: screwdriver-cd/screwdriver#1769
License
I confirm that this contribution is made under the terms of the license found in the root directory of this repository's source tree and that I have the authority necessary to make this contribution on behalf of its copyright owner.