wikimedia/mediawiki-extensions-CirrusSearch

View on GitHub
maintenance/UpdateSuggesterIndex.php

Summary

Maintainability
F
4 days
Test Coverage

File UpdateSuggesterIndex.php has 522 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

namespace CirrusSearch\Maintenance;

use CirrusSearch\BuildDocument\Completion\SuggestBuilder;
Severity: Major
Found in maintenance/UpdateSuggesterIndex.php - About 1 day to fix

    UpdateSuggesterIndex has 26 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class UpdateSuggesterIndex extends Maintenance {
        /**
         * @var string language code we're building for
         */
        private $langCode;
    Severity: Minor
    Found in maintenance/UpdateSuggesterIndex.php - About 3 hrs to fix

      Method indexData has 66 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private function indexData(): int {
              // We build the suggestions by reading CONTENT and GENERAL indices.
              // This does not support extra indices like FILES on commons.
              $sourceIndexSuffixes = [ Connection::CONTENT_INDEX_SUFFIX, Connection::GENERAL_INDEX_SUFFIX ];
      
      
      Severity: Major
      Found in maintenance/UpdateSuggesterIndex.php - About 2 hrs to fix

        Function indexData has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
        Open

            private function indexData(): int {
                // We build the suggestions by reading CONTENT and GENERAL indices.
                // This does not support extra indices like FILES on commons.
                $sourceIndexSuffixes = [ Connection::CONTENT_INDEX_SUFFIX, Connection::GENERAL_INDEX_SUFFIX ];
        
        
        Severity: Minor
        Found in maintenance/UpdateSuggesterIndex.php - About 2 hrs to fix

        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

        Method execute has 60 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public function execute() {
                global $wgLanguageCode,
                    $wgCirrusSearchBannedPlugins,
                    $wgCirrusSearchMasterTimeout;
        
        
        Severity: Major
        Found in maintenance/UpdateSuggesterIndex.php - About 2 hrs to fix

          Method recycle has 56 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              private function recycle() {
                  $this->log( "Recycling index {$this->getIndex()->getName()}\n" );
                  $this->recycle = true;
                  $indexedDocs = $this->indexData();
                  // This is fragile... hopefully most of the docs will be deleted from the old segments
          Severity: Major
          Found in maintenance/UpdateSuggesterIndex.php - About 2 hrs to fix

            Method canRecycle has 52 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                private function canRecycle() {
                    global $wgCirrusSearchRecycleCompletionSuggesterIndex;
                    if ( !$wgCirrusSearchRecycleCompletionSuggesterIndex ) {
                        return false;
                    }
            Severity: Major
            Found in maintenance/UpdateSuggesterIndex.php - About 2 hrs to fix

              Function recycle has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
              Open

                  private function recycle() {
                      $this->log( "Recycling index {$this->getIndex()->getName()}\n" );
                      $this->recycle = true;
                      $indexedDocs = $this->indexData();
                      // This is fragile... hopefully most of the docs will be deleted from the old segments
              Severity: Minor
              Found in maintenance/UpdateSuggesterIndex.php - About 1 hr to fix

              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

              Method createIndex has 34 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  private function createIndex() {
                      // This is "create only" for now.
                      if ( $this->getIndex()->exists() ) {
                          throw new RuntimeException( "Index already exists." );
                      }
              Severity: Minor
              Found in maintenance/UpdateSuggesterIndex.php - About 1 hr to fix

                Method __construct has 32 lines of code (exceeds 25 allowed). Consider refactoring.
                Open

                    public function __construct() {
                        parent::__construct();
                        $this->addDescription( "Create a new suggester index. Always operates on a single cluster." );
                        $this->addOption( 'baseName', 'What basename to use for all indexes, ' .
                            'defaults to wiki id', false, true );
                Severity: Minor
                Found in maintenance/UpdateSuggesterIndex.php - About 1 hr to fix

                  Function canRecycle has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
                  Open

                      private function canRecycle() {
                          global $wgCirrusSearchRecycleCompletionSuggesterIndex;
                          if ( !$wgCirrusSearchRecycleCompletionSuggesterIndex ) {
                              return false;
                          }
                  Severity: Minor
                  Found in maintenance/UpdateSuggesterIndex.php - About 55 mins to fix

                  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 execute has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                  Open

                      public function execute() {
                          global $wgLanguageCode,
                              $wgCirrusSearchBannedPlugins,
                              $wgCirrusSearchMasterTimeout;
                  
                  
                  Severity: Minor
                  Found in maintenance/UpdateSuggesterIndex.php - About 35 mins to fix

                  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

                  Avoid too many return statements within this method.
                  Open

                              return false;
                  Severity: Major
                  Found in maintenance/UpdateSuggesterIndex.php - About 30 mins to fix

                    Avoid too many return statements within this method.
                    Open

                                return false;
                    Severity: Major
                    Found in maintenance/UpdateSuggesterIndex.php - About 30 mins to fix

                      Avoid too many return statements within this method.
                      Open

                                  return false;
                      Severity: Major
                      Found in maintenance/UpdateSuggesterIndex.php - About 30 mins to fix

                        Avoid too many return statements within this method.
                        Open

                                    return false;
                        Severity: Major
                        Found in maintenance/UpdateSuggesterIndex.php - About 30 mins to fix

                          Avoid too many return statements within this method.
                          Open

                                  return true;
                          Severity: Major
                          Found in maintenance/UpdateSuggesterIndex.php - About 30 mins to fix

                            Avoid too many return statements within this method.
                            Open

                                        return false;
                            Severity: Major
                            Found in maintenance/UpdateSuggesterIndex.php - About 30 mins to fix

                              Similar blocks of code found in 2 locations. Consider refactoring.
                              Open

                                      try {
                                          $this->requireCirrusReady();
                                          $this->builder = SuggestBuilder::create( $this->getConnection(),
                                              $this->getOption( 'scoringMethod' ), $this->indexBaseName );
                                          # check for broken indices and delete them
                              Severity: Major
                              Found in maintenance/UpdateSuggesterIndex.php and 1 other location - About 2 hrs to fix
                              maintenance/UpdateOneSearchIndexConfig.php on lines 237..300

                              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 131.

                              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

                              Further Reading

                              There are no issues that match your filters.

                              Category
                              Status