wikimedia/mediawiki-extensions-CirrusSearch

View on GitHub
includes/ElasticsearchIntermediary.php

Summary

Maintainability
B
4 hrs
Test Coverage

Function runMSearch has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

    protected function runMSearch(
        Search $search,
        RequestLog $log,
        Connection $connection = null,
        callable $resultsTransformer = null
Severity: Minor
Found in includes/ElasticsearchIntermediary.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 finishRequest has 27 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    private function finishRequest( Connection $connection ) {
        if ( !$this->currentRequestLog ) {
            LoggerFactory::getInstance( 'CirrusSearch' )->warning(
                'finishRequest called without staring a request'
            );
Severity: Minor
Found in includes/ElasticsearchIntermediary.php - About 1 hr to fix

    Avoid too many return statements within this method.
    Open

                return $this->failure( $e, $connection );
    Severity: Major
    Found in includes/ElasticsearchIntermediary.php - About 30 mins to fix

      Avoid too many return statements within this method.
      Open

                  return $this->success( $resultsTransformer !== null ? $resultsTransformer( $multiResultSet ) : $multiResultSet, $connection );
      Severity: Major
      Found in includes/ElasticsearchIntermediary.php - About 30 mins to fix

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

            protected function getTimeout( $searchType = 'default' ) {
                $timeout = $this->connection->getConfig()->getElement( 'CirrusSearchSearchShardTimeout', $searchType );
                if ( $timeout !== null ) {
                    return $timeout;
                }
        Severity: Minor
        Found in includes/ElasticsearchIntermediary.php and 1 other location - About 35 mins to fix
        includes/ElasticsearchIntermediary.php on lines 350..360

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

        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 getClientTimeout( $searchType = 'default' ) {
                $timeout = $this->connection->getConfig()->getElement( 'CirrusSearchClientSideSearchTimeout', $searchType );
                if ( $timeout !== null ) {
                    return $timeout;
                }
        Severity: Minor
        Found in includes/ElasticsearchIntermediary.php and 1 other location - About 35 mins to fix
        includes/ElasticsearchIntermediary.php on lines 334..344

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

        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