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

Jump to bottom

Improve S3776: Exclude complexity of JSX short-circuits #377

Merged
merged 8 commits into from Dec 5, 2022
Merged

Improve S3776: Exclude complexity of JSX short-circuits #377

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
29bd2b1
Improve S3776: Exclude complexity of JSX short-circuits
Nov 30, 2022
796a47f
Exclude condition expression from short-circuits
Nov 30, 2022
4939f4c
Fix comment
Nov 30, 2022
abb96fb
Restrict short-circuit to simple logical expressions directly under a…
Dec 1, 2022
4ac19e4
Fix ESLint errors in cognitive complexity test file
Dec 2, 2022
f3b1d48
Add recursion to the short-circuit logic
Dec 2, 2022
fd9043c
Apply changes suggested in PR
Dec 2, 2022
1563bbb
Move short-circuit logic to jsx.ts and reduce test code size
Dec 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 0 additions & 9 deletions ruling/snapshots/cognitive-complexity
View file
Open in desktop
Expand Up @@ -472,7 +472,6 @@ src/reveal.js/plugin/zoom-js/zoom.js: 34
src/socket.io/lib/index.js: 69,143
src/spectrum/admin/src/helpers/utils.js: 52
src/spectrum/admin/src/views/communities/components/search/index.js: 86
src/spectrum/admin/src/views/dashboard/components/coreMetrics.js: 114
src/spectrum/admin/src/views/users/components/search/index.js: 92
src/spectrum/api/authentication.js: 274
src/spectrum/api/models/community.js: 168,330
Expand Down Expand Up @@ -503,16 +502,13 @@ src/spectrum/shared/graphql/queries/thread/getThreadMessageConnection.js: 78
src/spectrum/src/components/avatar/hoverProfile.js: 44
src/spectrum/src/components/chatInput/index.js: 152
src/spectrum/src/components/composer/index.js: 131
src/spectrum/src/components/draftjs-editor/index.js: 177
src/spectrum/src/components/globals/index.js: 334
src/spectrum/src/components/listItems/index.js: 129
src/spectrum/src/components/modals/ChangeChannelModal/channelSelector.js: 22
src/spectrum/src/components/modals/DeleteDoubleCheckModal/index.js: 74
src/spectrum/src/components/profile/channel.js: 95
src/spectrum/src/components/profile/community.js: 60
src/spectrum/src/components/profile/user.js: 68
src/spectrum/src/components/threadComposer/components/composer.js: 120,215,346
src/spectrum/src/components/threadFeed/index.js: 195
src/spectrum/src/helpers/utils.js: 96
src/spectrum/src/registerServiceWorker.js: 24
src/spectrum/src/views/channel/index.js: 159
Expand All @@ -524,20 +520,15 @@ src/spectrum/src/views/communityMembers/components/communityMembers.js: 141
src/spectrum/src/views/communityMembers/components/importSlack.js: 117
src/spectrum/src/views/dashboard/components/sidebarChannels.js: 50
src/spectrum/src/views/dashboard/components/threadFeed.js: 93,213
src/spectrum/src/views/dashboard/index.js: 98
src/spectrum/src/views/directMessages/containers/newThread.js: 201
src/spectrum/src/views/directMessages/index.js: 83
src/spectrum/src/views/explore/components/search.js: 115
src/spectrum/src/views/explore/view.js: 109
src/spectrum/src/views/navbar/components/notificationsTab.js: 51,234
src/spectrum/src/views/navbar/index.js: 75
src/spectrum/src/views/newCommunity/index.js: 173
src/spectrum/src/views/notifications/components/sortAndGroupNotificationMessages.js: 3
src/spectrum/src/views/thread/components/actionBar.js: 209
src/spectrum/src/views/thread/components/messages.js: 142
src/spectrum/src/views/thread/index.js: 223,286
src/spectrum/src/views/user/components/communityList.js: 23
src/spectrum/src/views/user/index.js: 97
src/three.js/editor/js/Loader.js: 12,520
src/three.js/editor/js/Menubar.Edit.js: 125
src/three.js/editor/js/Script.js: 72,136
Expand Down
43 changes: 39 additions & 4 deletions src/rules/cognitive-complexity.ts
View file
Open in desktop
Expand Up @@ -19,15 +19,15 @@
*/
// https://sonarsource.github.io/rspec/#/rspec/S3776

import type { TSESTree, TSESLint } from '@typescript-eslint/experimental-utils';
import type { TSESLint, TSESTree } from '@typescript-eslint/experimental-utils';
import { isArrowFunctionExpression, isIfStatement, isLogicalExpression } from '../utils/nodes';
import {
getMainFunctionTokenLocation,
getFirstToken,
getFirstTokenAfter,
report,
getMainFunctionTokenLocation,
IssueLocation,
issueLocation,
report,
} from '../utils/locations';
import docsUrl from '../utils/docs-url';

Expand Down Expand Up @@ -339,20 +339,55 @@ const rule: TSESLint.RuleModule<string, (number | 'metric' | 'sonar-runtime')[]>
}

function visitLogicalExpression(logicalExpression: TSESTree.LogicalExpression) {
const jsxShortCircuitNodes = getJsxShortCircuitNodes(logicalExpression);
if (jsxShortCircuitNodes) {
ilia-kebets-sonarsource marked this conversation as resolved.
Show resolved Hide resolved
jsxShortCircuitNodes.forEach(node => consideredLogicalExpressions.add(node));
return;
}

if (!consideredLogicalExpressions.has(logicalExpression)) {
const flattenedLogicalExpressions = flattenLogicalExpression(logicalExpression);

let previous: TSESTree.LogicalExpression | undefined;
for (const current of flattenedLogicalExpressions) {
if (!previous || previous.operator !== current.operator) {
const operatorTokenLoc = getFirstTokenAfter(logicalExpression.left, context)!.loc;
ilia-kebets-sonarsource marked this conversation as resolved.
Show resolved Hide resolved
const operatorTokenLoc = getFirstTokenAfter(current.left, context)!.loc;
addComplexity(operatorTokenLoc);
}
previous = current;
}
}
}

function getJsxShortCircuitNodes(logicalExpression: TSESTree.LogicalExpression) {
if (logicalExpression.parent?.type !== 'JSXExpressionContainer') {
return null;
} else {
return getJsxShortCircuitSubNodes(logicalExpression, logicalExpression);
}
}

function getJsxShortCircuitSubNodes(
root: TSESTree.LogicalExpression,
ilia-kebets-sonarsource marked this conversation as resolved.
Show resolved Hide resolved
node: TSESTree.Node,
): TSESTree.Node[] | null {
if (
node.type === 'ConditionalExpression' ||
(node.type === 'LogicalExpression' && node.operator !== root.operator)
) {
return null;
} else if (node.type !== 'LogicalExpression') {
return [];
} else {
const leftNodes = getJsxShortCircuitSubNodes(root, node.left);
const rightNodes = getJsxShortCircuitSubNodes(root, node.right);
if (leftNodes == null || rightNodes == null) {
return null;
}
return [...leftNodes, node, ...rightNodes];
}
}

function flattenLogicalExpression(node: TSESTree.Node): TSESTree.LogicalExpression[] {
if (isLogicalExpression(node)) {
consideredLogicalExpressions.add(node);
Expand Down
186 changes: 184 additions & 2 deletions tests/rules/cognitive-complexity.test.ts
View file
Open in desktop
Expand Up @@ -21,8 +21,78 @@ import { TSESLint } from '@typescript-eslint/experimental-utils';
import { ruleTester } from '../rule-tester';
import rule = require('../../src/rules/cognitive-complexity');

const SONAR_RUNTIME_OPTION = 'sonar-runtime';

ruleTester.run('cognitive-complexity', rule, {
valid: [{ code: `function zero_complexity() {}`, options: [0] }],
valid: [
{ code: `function zero_complexity() {}`, options: [0] },
{
code: `
function Component(obj) {
return (
<span>{ obj.title?.text }</span>
);
}`,
parserOptions: { ecmaFeatures: { jsx: true } },
options: [0],
},
{
code: `
function Component(obj) {
return (
<>
{ obj.isFriendly && <strong>Welcome</strong> }
</>
);
}`,
parserOptions: { ecmaFeatures: { jsx: true } },
options: [0],
},
{
code: `
function Component(obj) {
return (
<>
{ obj.isFriendly && obj.isLoggedIn && <strong>Welcome</strong> }
</>
);
}`,
parserOptions: { ecmaFeatures: { jsx: true } },
options: [0],
},
{
code: `
function Component(obj) {
return (
<>
{ obj.x && obj.y && obj.z && <strong>Welcome</strong> }
</>
);
}`,
parserOptions: { ecmaFeatures: { jsx: true } },
options: [0],
},
{
code: `
function Component(obj) {
return (
<span title={ obj.title || obj.disclaimer }>Text</span>
);
}`,
parserOptions: { ecmaFeatures: { jsx: true } },
options: [0],
},
{
code: `
function Component(obj) {
return (
<button type="button" disabled={ obj.user?.isBot ?? obj.isDemo }>Logout</button>
);
}`,
parserOptions: { ecmaFeatures: { jsx: true } },
options: [0],
},
],
invalid: [
// if
{
Expand Down Expand Up @@ -217,7 +287,7 @@ ruleTester.run('cognitive-complexity', rule, {

return foo(a && b) && c; // +1 "&&", +1 "&&"
}`,
options: [0, 'sonar-runtime'],
options: [0, SONAR_RUNTIME_OPTION],
errors: [
{
messageId: 'sonarRuntime',
Expand Down Expand Up @@ -262,6 +332,30 @@ ruleTester.run('cognitive-complexity', rule, {
},

// expressions
{
code: `
function and_or_locations() {
foo(1 && 2 || 3 && 4);
}`,
options: [0, SONAR_RUNTIME_OPTION],
errors: [
{
messageId: 'sonarRuntime',
data: {
threshold: 0,
sonarRuntimeData: JSON.stringify({
secondaryLocations: [
{ line: 3, column: 14, endLine: 3, endColumn: 16, message: '+1' }, // &&
{ line: 3, column: 19, endLine: 3, endColumn: 21, message: '+1' }, // ||
{ line: 3, column: 24, endLine: 3, endColumn: 26, message: '+1' }, // &&
],
message: cognitiveComplexityMessage(3),
cost: 3,
}),
},
},
],
},
{
code: `
function and_or() {
Expand Down Expand Up @@ -516,6 +610,90 @@ ruleTester.run('cognitive-complexity', rule, {
options: [0],
errors: [message(1, { line: 2 }), message(1, { line: 3 })],
},
{
code: `
function Component(obj) {
return (
<>
<span title={ obj.user?.name ?? (obj.isDemo ? 'demo' : 'none') }>Text</span>
</>
);
}`,
parserOptions: { ecmaFeatures: { jsx: true } },
options: [0, SONAR_RUNTIME_OPTION],
errors: [
{
messageId: 'sonarRuntime',
data: {
threshold: 0,
sonarRuntimeData: JSON.stringify({
secondaryLocations: [
{ line: 5, column: 41, endLine: 5, endColumn: 43, message: '+1' }, // ??
{ line: 5, column: 56, endLine: 5, endColumn: 57, message: '+1' }, // ?:
],
message: cognitiveComplexityMessage(2),
cost: 2,
}),
},
},
],
},
{
code: `
function Component(obj) {
return (
<>
{ obj.isUser && (obj.name || obj.surname) }
</>
);
}`,
parserOptions: { ecmaFeatures: { jsx: true } },
options: [0, SONAR_RUNTIME_OPTION],
errors: [
{
messageId: 'sonarRuntime',
data: {
threshold: 0,
sonarRuntimeData: JSON.stringify({
secondaryLocations: [
{ line: 5, column: 25, endLine: 5, endColumn: 27, message: '+1' }, // &&
{ line: 5, column: 38, endLine: 5, endColumn: 40, message: '+1' }, // ||
],
message: cognitiveComplexityMessage(2),
cost: 2,
}),
},
},
],
},
{
code: `
function Component(obj) {
return (
<>
{ obj.isUser && (obj.isDemo ? 'Demo' : 'None') }
</>
);
}`,
parserOptions: { ecmaFeatures: { jsx: true } },
options: [0, SONAR_RUNTIME_OPTION],
errors: [
{
messageId: 'sonarRuntime',
data: {
threshold: 0,
sonarRuntimeData: JSON.stringify({
secondaryLocations: [
{ line: 5, column: 25, endLine: 5, endColumn: 27, message: '+1' }, // &&
{ line: 5, column: 40, endLine: 5, endColumn: 41, message: '+1' }, // ||
],
message: cognitiveComplexityMessage(2),
cost: 2,
}),
},
},
],
},
],
});

Expand Down Expand Up @@ -655,6 +833,10 @@ class TopLevel {
],
});

function cognitiveComplexityMessage(cost: number) {
return `Refactor this function to reduce its Cognitive Complexity from ${cost} to the 0 allowed.`;
}

function message(complexityAmount: number, other: Partial<TSESLint.TestCaseError<string>> = {}) {
return {
messageId: 'refactorFunction',
Expand Down