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.

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

refactor(autoware_behavior_path_start_planner_module): move planner_data to method parameter #9788

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from

Merge branch 'refactor/lane_departure_checker/update_constructor' int…

9a1d8f2
Select commit
Loading
Failed to load commit list.
Draft

refactor(autoware_behavior_path_start_planner_module): move planner_data to method parameter #9788

Merge branch 'refactor/lane_departure_checker/update_constructor' int…
9a1d8f2
Select commit
Loading
Failed to load commit list.
CodeScene Delta Analysis / CodeScene Cloud Delta Analysis (main) failed Jan 6, 2025 in 55s

CodeScene PR Check

Code Health Quality Gates: FAILED

Change in average Code Health of affected files: -0.06 (5.63 -> 5.57)

  • Declining Code Health: 2 findings(s) 🚩
  • Improving Code Health: 1 findings(s) ✅
  • Affected Hotspots: 1 files(s) 🔥

View detailed results in CodeScene

Details

🚩 Declining Code Health (highest to lowest):

  • Brain Method shift_pull_out.cpp: ShiftPullOut::calcPullOutPaths
  • Complex Method shift_pull_out.cpp: ShiftPullOut::plan

✅ Improving Code Health:

  • Lines of Code in a Single File goal_planner_module.cpp 🔥

Annotations

Check warning on line 246 in planning/behavior_path_planner/autoware_behavior_path_start_planner_module/src/shift_pull_out.cpp

See this annotation in the file changed.

@codescene-delta-analysis codescene-delta-analysis / CodeScene Cloud Delta Analysis (main)

❌ New issue: Brain Method

ShiftPullOut::calcPullOutPaths is a brain method. A Brain Method -- aka a God Function -- is a large and complex function that centralizes the behavior of a module. Brain Methods are detected using a combination of the following code smells: Deeply Nested Logic + High Cyclomatic Complexity + Many Lines of Code + Many Function Arguments.

Check warning on line 167 in planning/behavior_path_planner/autoware_behavior_path_start_planner_module/src/shift_pull_out.cpp

See this annotation in the file changed.

@codescene-delta-analysis codescene-delta-analysis / CodeScene Cloud Delta Analysis (main)

❌ Getting worse: Complex Method

ShiftPullOut::plan already has high cyclomatic complexity, and now it increases in Lines of Code from 87 to 90. This function has many conditional statements (e.g. if, for, while), leading to lower code health. Avoid adding more conditionals and code to it without refactoring.

Check notice on line 246 in planning/behavior_path_planner/autoware_behavior_path_start_planner_module/src/shift_pull_out.cpp

See this annotation in the file changed.

@codescene-delta-analysis codescene-delta-analysis / CodeScene Cloud Delta Analysis (main)

ℹ New issue: Excess Number of Function Arguments

ShiftPullOut::calcPullOutPaths has 5 arguments, threshold = 4. This function has too many arguments, indicating a lack of encapsulation. Avoid adding more arguments.

Check notice on line 1 in planning/behavior_path_planner/autoware_behavior_path_goal_planner_module/src/goal_planner_module.cpp

See this annotation in the file changed.

@codescene-delta-analysis codescene-delta-analysis / CodeScene Cloud Delta Analysis (main)

✅ Getting better: Lines of Code in a Single File

The lines of code decreases from 1878 to 1876, improve code health by reducing it to 1000. The number of Lines of Code in a single file. More Lines of Code lowers the code health.