wikimedia/mediawiki-core

View on GitHub
includes/installer/DatabaseUpdater.php

Summary

Maintainability
F
5 days
Test Coverage

File DatabaseUpdater.php has 682 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php
/**
 * DBMS-specific updater helper.
 *
 * This program is free software; you can redistribute it and/or modify
Severity: Major
Found in includes/installer/DatabaseUpdater.php - About 1 day to fix

    DatabaseUpdater has 55 functions (exceeds 20 allowed). Consider refactoring.
    Open

    abstract class DatabaseUpdater {
        public const REPLICATION_WAIT_TIMEOUT = 300;
    
        /**
         * Array of updates to perform on the database
    Severity: Major
    Found in includes/installer/DatabaseUpdater.php - About 7 hrs to fix

      Function runUpdates has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
      Open

          private function runUpdates( array $updates, $passSelf, $hasVirtualDomain = false ) {
              $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
              $updatesDone = [];
              $updatesSkipped = [];
              foreach ( $updates as $params ) {
      Severity: Minor
      Found in includes/installer/DatabaseUpdater.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 loadExtensions has 39 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private function loadExtensions() {
              if ( $this->autoExtensionHookContainer ) {
                  // Already injected by installer
                  return $this->autoExtensionHookContainer;
              }
      Severity: Minor
      Found in includes/installer/DatabaseUpdater.php - About 1 hr to fix

        Method runUpdates has 37 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            private function runUpdates( array $updates, $passSelf, $hasVirtualDomain = false ) {
                $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
                $updatesDone = [];
                $updatesSkipped = [];
                foreach ( $updates as $params ) {
        Severity: Minor
        Found in includes/installer/DatabaseUpdater.php - About 1 hr to fix

          Method renameIndex has 27 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              protected function renameIndex( $table, $oldIndex, $newIndex,
                  $skipBothIndexExistWarning, $patch, $fullpath = false
              ) {
                  if ( !$this->doTable( $table ) ) {
                      return true;
          Severity: Minor
          Found in includes/installer/DatabaseUpdater.php - About 1 hr to fix

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

                private function loadExtensions() {
                    if ( $this->autoExtensionHookContainer ) {
                        // Already injected by installer
                        return $this->autoExtensionHookContainer;
                    }
            Severity: Minor
            Found in includes/installer/DatabaseUpdater.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

            Method renameIndex has 6 arguments (exceeds 4 allowed). Consider refactoring.
            Open

                protected function renameIndex( $table, $oldIndex, $newIndex,
                    $skipBothIndexExistWarning, $patch, $fullpath = false
            Severity: Minor
            Found in includes/installer/DatabaseUpdater.php - About 45 mins to fix

              Method renameExtensionIndex has 5 arguments (exceeds 4 allowed). Consider refactoring.
              Open

                  public function renameExtensionIndex( $tableName, $oldIndexName, $newIndexName,
                      $sqlPath, $skipBothIndexExistWarning = false
              Severity: Minor
              Found in includes/installer/DatabaseUpdater.php - About 35 mins to fix

                Function renameIndex has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                Open

                    protected function renameIndex( $table, $oldIndex, $newIndex,
                        $skipBothIndexExistWarning, $patch, $fullpath = false
                    ) {
                        if ( !$this->doTable( $table ) ) {
                            return true;
                Severity: Minor
                Found in includes/installer/DatabaseUpdater.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

                Function modifyField has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                Open

                    protected function modifyField( $table, $field, $patch, $fullpath = false ) {
                        if ( !$this->doTable( $table ) ) {
                            return true;
                        }
                
                
                Severity: Minor
                Found in includes/installer/DatabaseUpdater.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 $this->applyPatch(
                            $patch,
                            $fullpath,
                            "Renaming index $oldIndex into $newIndex to table $table"
                        );
                Severity: Major
                Found in includes/installer/DatabaseUpdater.php - About 30 mins to fix

                  Function ifFieldExists has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                  Open

                      protected function ifFieldExists( $table, $field, $func, ...$params ) {
                          // Handle $passSelf from runUpdates().
                          $passSelf = false;
                          if ( $table === $this ) {
                              $passSelf = true;
                  Severity: Minor
                  Found in includes/installer/DatabaseUpdater.php - About 25 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 modifyTable has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                  Open

                      protected function modifyTable( $table, $patch, $fullpath = false ) {
                          if ( !$this->doTable( $table ) ) {
                              return true;
                          }
                  
                  
                  Severity: Minor
                  Found in includes/installer/DatabaseUpdater.php - About 25 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 dropTable has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                  Open

                      protected function dropTable( $table, $patch = false, $fullpath = false ) {
                          if ( !$this->doTable( $table ) ) {
                              return true;
                          }
                  
                  
                  Severity: Minor
                  Found in includes/installer/DatabaseUpdater.php - About 25 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

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

                      protected function addIndex( $table, $index, $patch, $fullpath = false ) {
                          if ( !$this->doTable( $table ) ) {
                              return true;
                          }
                  
                  
                  Severity: Major
                  Found in includes/installer/DatabaseUpdater.php and 1 other location - About 2 hrs to fix
                  includes/installer/DatabaseUpdater.php on lines 827..841

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

                  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

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

                      protected function addField( $table, $field, $patch, $fullpath = false ) {
                          if ( !$this->doTable( $table ) ) {
                              return true;
                          }
                  
                  
                  Severity: Major
                  Found in includes/installer/DatabaseUpdater.php and 1 other location - About 2 hrs to fix
                  includes/installer/DatabaseUpdater.php on lines 855..869

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

                  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

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

                      protected function migrateTemplatelinks() {
                          if ( $this->updateRowExists( MigrateLinksTable::class . 'templatelinks' ) ) {
                              $this->output( "...templatelinks table has already been migrated.\n" );
                              return;
                          }
                  Severity: Major
                  Found in includes/installer/DatabaseUpdater.php and 1 other location - About 1 hr to fix
                  includes/installer/DatabaseUpdater.php on lines 1275..1294

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

                  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

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

                      protected function migratePagelinks() {
                          if ( $this->updateRowExists( MigrateLinksTable::class . 'pagelinks' ) ) {
                              $this->output( "...pagelinks table has already been migrated.\n" );
                              return;
                          }
                  Severity: Major
                  Found in includes/installer/DatabaseUpdater.php and 1 other location - About 1 hr to fix
                  includes/installer/DatabaseUpdater.php on lines 1254..1273

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

                  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

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

                          if ( $this->db->indexExists( $table, $newIndex, __METHOD__ ) ) {
                              $this->output( "...index $newIndex already set on $table table.\n" );
                              if ( !$skipBothIndexExistWarning &&
                                  $this->db->indexExists( $table, $oldIndex, __METHOD__ )
                              ) {
                  Severity: Minor
                  Found in includes/installer/DatabaseUpdater.php and 1 other location - About 40 mins to fix
                  includes/installer/PostgresUpdater.php on lines 635..646

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

                  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