Sign upLogin

wikimedia/mediawiki-core

View on GitHub
Star
includes/Rest/Handler/ParsoidHandler.php

Summary

Maintainability
F
6 days
Test Coverage

File ParsoidHandler.php has 672 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php
/**
 * Copyright (C) 2011-2020 Wikimedia Foundation and others.
 *
 * This program is free software; you can redistribute it and/or modify
Severity: Major
Found in includes/Rest/Handler/ParsoidHandler.php - About 1 day to fix

    Function wt2html has a Cognitive Complexity of 47 (exceeds 5 allowed). Consider refactoring.
    Open

        protected function wt2html(
        PageConfig $pageConfig, array $attribs, ?string $wikitext = null
    ) {
        $request = $this->getRequest();
        $opts = $attribs['opts'];
    Severity: Minor
    Found in includes/Rest/Handler/ParsoidHandler.php - About 7 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 wt2html has 112 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        protected function wt2html(
        PageConfig $pageConfig, array $attribs, ?string $wikitext = null
    ) {
        $request = $this->getRequest();
        $opts = $attribs['opts'];
    Severity: Major
    Found in includes/Rest/Handler/ParsoidHandler.php - About 4 hrs to fix

      Function acceptable has a Cognitive Complexity of 29 (exceeds 5 allowed). Consider refactoring.
      Open

          protected function acceptable( array &$attribs ): bool {
        $request = $this->getRequest();
        $format = $attribs['opts']['format'];

        if ( $format === ParsoidFormatHelper::FORMAT_WIKITEXT ) {
      Severity: Minor
      Found in includes/Rest/Handler/ParsoidHandler.php - About 4 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 getRequestAttributes has 99 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          protected function &getRequestAttributes(): array {
        if ( $this->requestAttributes ) {
            return $this->requestAttributes;
        }
      Severity: Major
      Found in includes/Rest/Handler/ParsoidHandler.php - About 3 hrs to fix

        Function getRequestAttributes has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
        Open

            protected function &getRequestAttributes(): array {
        if ( $this->requestAttributes ) {
            return $this->requestAttributes;
        }
        Severity: Minor
        Found in includes/Rest/Handler/ParsoidHandler.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

        ParsoidHandler has 24 functions (exceeds 20 allowed). Consider refactoring.
        Open

        abstract class ParsoidHandler extends Handler {

    // TODO logging, timeouts(?), CORS
    // TODO content negotiation (routes.js routes.acceptable)
    // TODO handle MaxConcurrentCallsError (pool counter?)
        Severity: Minor
        Found in includes/Rest/Handler/ParsoidHandler.php - About 2 hrs to fix

          Method pb2pb has 54 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              protected function pb2pb( array $attribs ) {
        $opts = $attribs['opts'];

        $revision = $opts['previous'] ?? $opts['original'] ?? null;
        if ( !isset( $revision['html'] ) ) {
          Severity: Major
          Found in includes/Rest/Handler/ParsoidHandler.php - About 2 hrs to fix

            Method acceptable has 44 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                protected function acceptable( array &$attribs ): bool {
        $request = $this->getRequest();
        $format = $attribs['opts']['format'];

        if ( $format === ParsoidFormatHelper::FORMAT_WIKITEXT ) {
            Severity: Minor
            Found in includes/Rest/Handler/ParsoidHandler.php - About 1 hr to fix

              Method languageConversion has 38 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  protected function languageConversion(
        PageConfig $pageConfig, array $attribs, array $revision
    ) {
        $opts = $attribs['opts'];
        $target = $opts['updates']['variant']['target'] ??
              Severity: Minor
              Found in includes/Rest/Handler/ParsoidHandler.php - About 1 hr to fix

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

                    protected function pb2pb( array $attribs ) {
        $opts = $attribs['opts'];

        $revision = $opts['previous'] ?? $opts['original'] ?? null;
        if ( !isset( $revision['html'] ) ) {
                Severity: Minor
                Found in includes/Rest/Handler/ParsoidHandler.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 tryToCreatePageConfig has 33 lines of code (exceeds 25 allowed). Consider refactoring.
                Open

                    protected function tryToCreatePageConfig(
        array $attribs, ?string $wikitextOverride = null, bool $html2WtMode = false
    ): PageConfig {
        $revId = $attribs['oldid'];
        $pagelanguageOverride = $attribs['pagelanguage'];
                Severity: Minor
                Found in includes/Rest/Handler/ParsoidHandler.php - About 1 hr to fix

                  Method assertDomainIsCorrect has 28 lines of code (exceeds 25 allowed). Consider refactoring.
                  Open

                      protected function assertDomainIsCorrect( $domain ): void {
        // We are cutting some corners here (IDN, non-ASCII casing)
        // since domain name support is provisional.
        // TODO use a proper validator instead
        $server = RequestContext::getMain()->getConfig()->get( MainConfigNames::Server );
                  Severity: Minor
                  Found in includes/Rest/Handler/ParsoidHandler.php - About 1 hr to fix

                    Consider simplifying this complex logical expression.
                    Open

                                if (
                ( $format === ParsoidFormatHelper::FORMAT_HTML && $type === 'text/html' ) ||
                ( $format === ParsoidFormatHelper::FORMAT_PAGEBUNDLE && $type === 'application/json' )
            ) {
                if ( $profile ) {
                    Severity: Major
                    Found in includes/Rest/Handler/ParsoidHandler.php - About 40 mins to fix

                      Avoid too many return statements within this method.
                      Open

                                          return true;
                      Severity: Major
                      Found in includes/Rest/Handler/ParsoidHandler.php - About 30 mins to fix

                        Avoid too many return statements within this method.
                        Open

                                return false;
                        Severity: Major
                        Found in includes/Rest/Handler/ParsoidHandler.php - About 30 mins to fix

                          Avoid too many return statements within this method.
                          Open

                                          return true;
                          Severity: Major
                          Found in includes/Rest/Handler/ParsoidHandler.php - About 30 mins to fix

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

                                protected function tryToCreatePageConfig(
        array $attribs, ?string $wikitextOverride = null, bool $html2WtMode = false
    ): PageConfig {
        $revId = $attribs['oldid'];
        $pagelanguageOverride = $attribs['pagelanguage'];
                            Severity: Minor
                            Found in includes/Rest/Handler/ParsoidHandler.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 assertDomainIsCorrect has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                            Open

                                protected function assertDomainIsCorrect( $domain ): void {
        // We are cutting some corners here (IDN, non-ASCII casing)
        // since domain name support is provisional.
        // TODO use a proper validator instead
        $server = RequestContext::getMain()->getConfig()->get( MainConfigNames::Server );
                            Severity: Minor
                            Found in includes/Rest/Handler/ParsoidHandler.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

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

                                    $pb = new PageBundle(
            $revision['html']['body'],
            $revision['data-parsoid']['body'] ?? null,
            $revision['data-mw']['body'] ?? null,
            $attribs['envOptions']['inputContentVersion'],
                            Severity: Major
                            Found in includes/Rest/Handler/ParsoidHandler.php and 1 other location - About 1 hr to fix
                            includes/Rest/Handler/ParsoidHandler.php on lines 1023..1030

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

                            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

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

                                    $pb = new PageBundle(
            $revision['html']['body'],
            $revision['data-parsoid']['body'] ?? null,
            $revision['data-mw']['body'] ?? null,
            $attribs['envOptions']['inputContentVersion'],
                            Severity: Major
                            Found in includes/Rest/Handler/ParsoidHandler.php and 1 other location - About 1 hr to fix
                            includes/Rest/Handler/ParsoidHandler.php on lines 980..987

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

                            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