Sign upLogin

wikimedia/mediawiki-extensions-CirrusSearch

View on GitHub
Star
includes/BuildDocument/DocumentSizeLimiter.php

Summary

Maintainability
C
1 day
Test Coverage

Function truncateField has a Cognitive Complexity of 22 (exceeds 5 allowed). Consider refactoring.
Open

    private function truncateField( string $field, bool $keyword, int $minFieldLength, int $maxDocSize, string $statBucket ): void {
        if ( !$this->document->has( $field ) ) {
            return;
        }
        $fieldData = $this->document->get( $field );
Severity: Minor
Found in includes/BuildDocument/DocumentSizeLimiter.php - About 3 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 truncateField has 59 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    private function truncateField( string $field, bool $keyword, int $minFieldLength, int $maxDocSize, string $statBucket ): void {
        if ( !$this->document->has( $field ) ) {
            return;
        }
        $fieldData = $this->document->get( $field );
Severity: Major
Found in includes/BuildDocument/DocumentSizeLimiter.php - About 2 hrs to fix

    Function resize has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
    Open

        public function resize( Document $document ): array {
        $this->stats = [];
        $this->document = $document;
        $originalDocLength = self::estimateDataSize( $document );
        $this->docLength = $originalDocLength;
    Severity: Minor
    Found in includes/BuildDocument/DocumentSizeLimiter.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 resize has 26 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function resize( Document $document ): array {
        $this->stats = [];
        $this->document = $document;
        $originalDocLength = self::estimateDataSize( $document );
        $this->docLength = $originalDocLength;
    Severity: Minor
    Found in includes/BuildDocument/DocumentSizeLimiter.php - About 1 hr to fix

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

          private function truncateField( string $field, bool $keyword, int $minFieldLength, int $maxDocSize, string $statBucket ): void {
      Severity: Minor
      Found in includes/BuildDocument/DocumentSizeLimiter.php - About 35 mins to fix

        Avoid too many return statements within this method.
        Open

                    return;
        Severity: Major
        Found in includes/BuildDocument/DocumentSizeLimiter.php - About 30 mins to fix

          Avoid too many return statements within this method.
          Open

                      return $siz + strlen( $str );
          Severity: Major
          Found in includes/BuildDocument/DocumentSizeLimiter.php - About 30 mins to fix

            There are no issues that match your filters.

            Category
            Status