gdbots/ncr-php

View on GitHub

Showing 92 of 92 total issues

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

        foreach ($messages as $message) {
            foreach ($paths as $fieldName => $qname) {
                if (!$message->has($fieldName)) {
                    continue;
                }
Severity: Major
Found in src/NcrLazyLoader.php and 1 other location - About 3 hrs to fix
src/NcrPreloader.php on lines 142..165

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

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

        foreach ($messages as $message) {
            foreach ($paths as $fieldName => $qname) {
                if (!$message->has($fieldName)) {
                    continue;
                }
Severity: Major
Found in src/NcrPreloader.php and 1 other location - About 3 hrs to fix
src/NcrLazyLoader.php on lines 74..97

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

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

Function doPipeNodes has a Cognitive Complexity of 25 (exceeds 5 allowed). Consider refactoring.
Open

    private function doPipeNodes(SchemaQName $qname, array $context): \Generator
    {
        static $alreadyPiped = [];

        $tableName = $context['table_name'] ?? $this->tableManager->getNodeTableName($qname, $context);
Severity: Minor
Found in src/Repository/DynamoDb/DynamoDbNcr.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 findNodeRefs has 79 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function findNodeRefs(IndexQuery $query, array $context = []): IndexQueryResult
    {
        $context = $this->enrichContext(__FUNCTION__, $context);
        $tableName = $this->tableManager->getNodeTableName($query->getQName(), $context);
        $table = $this->tableManager->getNodeTable($query->getQName());
Severity: Major
Found in src/Repository/DynamoDb/DynamoDbNcr.php - About 3 hrs to fix

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

        public function findNodeRefs(IndexQuery $query, array $context = []): IndexQueryResult
        {
            $context = $this->enrichContext(__FUNCTION__, $context);
            $tableName = $this->tableManager->getNodeTableName($query->getQName(), $context);
            $table = $this->tableManager->getNodeTable($query->getQName());
    Severity: Minor
    Found in src/Repository/DynamoDb/DynamoDbNcr.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

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

        public function addEmbeddedNodeRefs(array $messages, array $paths, string $namespace = self::DEFAULT_NAMESPACE): void
        {
            $nodeRefs = [];
    
            if (array_is_list($paths)) {
    Severity: Minor
    Found in src/NcrPreloader.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

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

        public function addEmbeddedNodeRefs(array $messages, array $paths): void
        {
            $nodeRefs = [];
    
            if (array_is_list($paths)) {
    Severity: Minor
    Found in src/NcrLazyLoader.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

    File ElasticaNcrSearch.php has 288 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    <?php
    declare(strict_types=1);
    
    namespace Gdbots\Ncr\Search\Elastica;
    
    
    Severity: Minor
    Found in src/Search/Elastica/ElasticaNcrSearch.php - About 2 hrs to fix

      Method getNodes has 70 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          final public function getNodes(array $nodeRefs, bool $consistent = false, array $context = []): array
          {
              if (empty($nodeRefs)) {
                  return [];
              } elseif (count($nodeRefs) === 1) {
      Severity: Major
      Found in src/Repository/Psr6Ncr.php - About 2 hrs to fix

        Method searchNodes has 69 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public function searchNodes(Message $request, ParsedQuery $parsedQuery, Message $response, array $qnames = [], array $context = []): void
            {
                $context = $this->enrichContext(__FUNCTION__, $context);
                $skipValidation = filter_var($context['skip_validation'] ?? true, FILTER_VALIDATE_BOOLEAN);
                $client = $this->getClientForRead($context);
        Severity: Major
        Found in src/Search/Elastica/ElasticaNcrSearch.php - About 2 hrs to fix

          Function getNode has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
          Open

              final public function getNode(NodeRef $nodeRef, bool $consistent = false, array $context = []): Message
              {
                  $cacheKey = $this->getCacheKey($nodeRef, $context);
                  $cacheItem = null;
          
          
          Severity: Minor
          Found in src/Repository/Psr6Ncr.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 createQuery has 64 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              final public function createQuery(IndexQuery $query): array
              {
                  $filterables = $this->getFilterableAttributes();
                  $params = [
                      'IndexName'                 => $this->getName(),
          Severity: Major
          Found in src/Repository/DynamoDb/AbstractIndex.php - About 2 hrs to fix

            Method indexNodes has 59 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                public function indexNodes(array $nodes, array $context = []): void
                {
                    if (empty($nodes)) {
                        return;
                    }
            Severity: Major
            Found in src/Search/Elastica/ElasticaNcrSearch.php - About 2 hrs to fix

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

                  final public function createIndex(Client $client, SchemaQName $qname, array $context = []): Index
                  {
                      static $created = [];
              
                      $indexName = $this->getIndexName($qname, $context);
              Severity: Major
              Found in src/Search/Elastica/IndexManager.php - About 2 hrs to fix

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

                    public function getNode(NodeRef $nodeRef, bool $consistent = false, array $context = []): Message
                    {
                        $context = $this->enrichContext(__FUNCTION__, $context);
                        $tableName = $this->tableManager->getNodeTableName($nodeRef->getQName(), $context);
                
                
                Severity: Major
                Found in src/Repository/DynamoDb/DynamoDbNcr.php - About 2 hrs to fix

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

                      final public function create(DynamoDbClient $client, string $tableName): void
                      {
                          try {
                              $client->describeTable(['TableName' => $tableName]);
                              return;
                  Severity: Major
                  Found in src/Repository/DynamoDb/NodeTable.php - About 2 hrs to fix

                    Method putNode has 50 lines of code (exceeds 25 allowed). Consider refactoring.
                    Open

                        public function putNode(Message $node, ?string $expectedEtag = null, array $context = []): void
                        {
                            $node->freeze();
                            $nodeRef = $node->generateNodeRef();
                    
                    
                    Severity: Minor
                    Found in src/Repository/DynamoDb/DynamoDbNcr.php - About 2 hrs to fix

                      Method updateNode has 49 lines of code (exceeds 25 allowed). Consider refactoring.
                      Open

                          public function updateNode(Message $command): void
                          {
                              /** @var NodeRef $nodeRef */
                              $nodeRef = $command->get('node_ref');
                              $this->assertNodeRefMatches($nodeRef);
                      Severity: Minor
                      Found in src/Aggregate.php - About 1 hr to fix

                        Method deleteNodes has 49 lines of code (exceeds 25 allowed). Consider refactoring.
                        Open

                            public function deleteNodes(array $nodeRefs, array $context = []): void
                            {
                                if (empty($nodeRefs)) {
                                    return;
                                }
                        Severity: Minor
                        Found in src/Search/Elastica/ElasticaNcrSearch.php - About 1 hr to fix

                          Method derefNodes has 48 lines of code (exceeds 25 allowed). Consider refactoring.
                          Open

                              public function derefNodes(Message $node, array $fields, ?string $return = null): array
                              {
                                  $nodeRefs = [];
                                  foreach ($fields as $field) {
                                      if (!$node->has($field)) {
                          Severity: Minor
                          Found in src/NcrCache.php - About 1 hr to fix
                            Severity
                            Category
                            Status
                            Source
                            Language