File sync.js
has 270 lines of code (exceeds 250 allowed). Consider refactoring. Wontfix
// Our data source is Security Hub Findings. Auth is provided via the lambda's IAM role.
import AWS from "aws-sdk";
const securityhub = new AWS.SecurityHub();
// The GitHub org/owner and repo for which we're modifying issues
Function getAllActiveFindings
has 44 lines of code (exceeds 35 allowed). Consider refactoring. Wontfix
async function getAllActiveFindings() {
const EMPTY = Symbol("empty");
const res = [];
let severityLabels = [];
process.env.severity.split(",").forEach(function (label) {
Function assignIssuesToProject
has 38 lines of code (exceeds 35 allowed). Consider refactoring. Wontfix
async function assignIssuesToProject(issues, projectId, defaultColumnName) {
console.log(
`******** Project ${projectId}: Ensuring all GitHub Issues are attached to the Project ********`
);
Function createOrUpdateIssuesBasedOnFindings
has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring. Wontfix
async function createOrUpdateIssuesBasedOnFindings(findings, issues) {
console.log(
`******** Creating or updating GitHub Issues based on Security Hub findings. ********`
);
// Search for active SH findings that don't have an open issue
- Read upRead up
Cognitive Complexity
Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.
A method's cognitive complexity is based on a few simple rules:
- Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
- Code is considered more complex for each "break in the linear flow of the code"
- Code is considered more complex when "flow breaking structures are nested"
Further reading
Function closeIssuesWithoutAnActiveFinding
has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring. Wontfix
async function closeIssuesWithoutAnActiveFinding(findings, issues) {
console.log(
`******** Discovering and closing any open GitHub Issues without an underlying, active Security Hub finding. ********`
);
- Read upRead up
Cognitive Complexity
Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.
A method's cognitive complexity is based on a few simple rules:
- Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
- Code is considered more complex for each "break in the linear flow of the code"
- Code is considered more complex when "flow breaking structures are nested"
Further reading
Function assignIssuesToProject
has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring. Wontfix
async function assignIssuesToProject(issues, projectId, defaultColumnName) {
console.log(
`******** Project ${projectId}: Ensuring all GitHub Issues are attached to the Project ********`
);
- Read upRead up
Cognitive Complexity
Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.
A method's cognitive complexity is based on a few simple rules:
- Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
- Code is considered more complex for each "break in the linear flow of the code"
- Code is considered more complex when "flow breaking structures are nested"
Further reading
Similar blocks of code found in 2 locations. Consider refactoring. Wontfix
for (let i = 0; i < projects.length; i++) {
// Find the target Project by name
var targetProject = _.find(repoProjects, function (x) {
return x.name == projects[i];
});
- Read upRead up
Duplicated Code
Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:
Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.
When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).
Tuning
This issue has a mass of 81.
We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.
The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.
If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.
See codeclimate-duplication
's documentation for more information about tuning the mass threshold in your .codeclimate.yml
.
Refactorings
- Extract Method
- Extract Class
- Form Template Method
- Introduce Null Object
- Pull Up Method
- Pull Up Field
- Substitute Algorithm
Further Reading
- Don't Repeat Yourself on the C2 Wiki
- Duplicated Code on SourceMaking
- Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76
Similar blocks of code found in 2 locations. Consider refactoring. Wontfix
for (let i = 0; i < projects.length; i++) {
// Find the target Project by name
var targetProject = _.find(orgProjects, function (x) {
return x.name == projects[i];
});
- Read upRead up
Duplicated Code
Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:
Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.
When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).
Tuning
This issue has a mass of 81.
We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.
The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.
If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.
See codeclimate-duplication
's documentation for more information about tuning the mass threshold in your .codeclimate.yml
.
Refactorings
- Extract Method
- Extract Class
- Form Template Method
- Introduce Null Object
- Pull Up Method
- Pull Up Field
- Substitute Algorithm
Further Reading
- Don't Repeat Yourself on the C2 Wiki
- Duplicated Code on SourceMaking
- Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76