Command options compatibility checking functionality refactoring

Author: petr-buchin

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2016 Tequila Project
+Copyright (c) 2016-2017 Petro Buchyn
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

composer.json

@@ -5,7 +5,7 @@
     "require": {
         "php": ">=5.6",
         "ext-mongodb": ">=1.1.0",
-        "symfony/options-resolver": ">=2.8",
+        "tequila/options-resolver": "dev-master",
         "tequila/mongodb-driver-wrapper": "dev-master"
     },
     "autoload": {

composer.lock

@@ -97,7 +97,7 @@ public function listDatabases()
             new SimpleCommand(['listDatabases' => 1]),
             new ReadPreference(ReadPreference::RP_PRIMARY)
         );
-        $cursor->setTypeMap(TypeMapResolver::getDefault());
+        $cursor->setTypeMap(TypeMapResolver::resolveStatic([]));
         $result = $cursor->current();
 
         if (!isset($result['databases']) || !is_array($result['databases'])) {

src/Client.php

@@ -2,7 +2,7 @@
 
 namespace Tequila\MongoDB;
 
-use Tequila\MongoDB\OptionsResolver\Command\CompatibilityResolverInterface;
+use Tequila\MongoDB\OptionsResolver\Command\CompatibilityResolver;
 
 class Command implements CommandInterface
 {
@@ -12,7 +12,7 @@ class Command implements CommandInterface
     private $options;
 
     /**
-     * @var CompatibilityResolverInterface
+     * @var CompatibilityResolver
      */
     private $compatibilityResolver;
 
@@ -30,20 +30,16 @@ public function __construct(array $options)
     public function getOptions(Server $server)
     {
         if (null !== $this->compatibilityResolver) {
-            $options = new CommandOptions($this->options);
-            $options->setServer($server);
-            $this->compatibilityResolver->resolveCompatibilities($options);
-
-            $this->options = $options->toArray();
+            $this->compatibilityResolver->resolveCompatibilities($server, $this->options);
         }
 
         return $this->options;
     }
 
     /**
-     * @param CompatibilityResolverInterface $resolver
+     * @param CompatibilityResolver $resolver
      */
-    public function setCompatibilityResolver(CompatibilityResolverInterface $resolver)
+    public function setCompatibilityResolver(CompatibilityResolver $resolver)
     {
         $this->compatibilityResolver = $resolver;
     }

src/Command.php

@@ -8,6 +8,7 @@
 use Tequila\MongoDB\Exception\InvalidArgumentException;
 use Tequila\MongoDB\Exception\LogicException;
 use Tequila\MongoDB\OptionsResolver\Command\AggregateResolver;
+use Tequila\MongoDB\OptionsResolver\Command\CompatibilityResolver;
 use Tequila\MongoDB\OptionsResolver\Command\CountResolver;
 use Tequila\MongoDB\OptionsResolver\Command\CreateCollectionResolver;
 use Tequila\MongoDB\OptionsResolver\Command\CreateIndexesResolver;
@@ -17,9 +18,6 @@
 use Tequila\MongoDB\OptionsResolver\Command\DropIndexesResolver;
 use Tequila\MongoDB\OptionsResolver\Command\FindAndModifyResolver;
 use Tequila\MongoDB\OptionsResolver\Command\ListCollectionsResolver;
-use Tequila\MongoDB\OptionsResolver\Command\ReadConcernAwareInterface;
-use Tequila\MongoDB\OptionsResolver\Command\WriteConcernAwareInterface;
-use Tequila\MongoDB\OptionsResolver\Command\CompatibilityResolverInterface;
 use Tequila\MongoDB\OptionsResolver\OptionsResolver;
 use Tequila\MongoDB\OptionsResolver\TypeMapResolver;
 
@@ -41,11 +39,6 @@ class CommandExecutor
         'listCollections' => ListCollectionsResolver::class,
     ];
 
-    /**
-     * @var array
-     */
-    private $cache = [];
-
     /**
      * @var ReadConcern
      */
@@ -83,25 +76,43 @@ public function executeCommand(ManagerInterface $manager, $databaseName, array $
         }
 
         $resolver = $this->getResolver($command);
+
+        // Command should inherit readConcern, readPreference and writeConcern from Client, Database or Collection
+        // instance, from which it is called, due to MongoDB Driver Specifications
+        foreach (['readConcern', 'readPreference', 'writeConcern'] as $optionToBeInherited) {
+            if ($resolver->isDefined($optionToBeInherited) && !$resolver->hasDefault($optionToBeInherited)) {
+                $resolver->setDefault($optionToBeInherited, $this->$optionToBeInherited);
+            }
+        }
+
         $options = $resolver->resolve($options);
 
         if ($resolver->isDefined('readPreference') && isset($options['readPreference'])) {
             $readPreference = $options['readPreference'];
             unset($options['readPreference']);
         } else {
-            $readPreference = $this->readPreference;
+            $readPreference = new ReadPreference(ReadPreference::RP_PRIMARY);
         }
 
-        $commandOptions = $command + $options;
-        $command = new Command($commandOptions);
-
-        if ($resolver instanceof CompatibilityResolverInterface) {
-            $command->setCompatibilityResolver($resolver);
-        }
+        $command = new Command($command + $options);
+        $command->setCompatibilityResolver(new CompatibilityResolver($resolver));
 
         /** @var CursorInterface $cursor */
         $cursor = $manager->executeCommand($databaseName, $command, $readPreference);
-        $cursor->setTypeMap(TypeMapResolver::getDefault());
+        $cursor->setTypeMap(TypeMapResolver::resolveStatic([]));
+
+        // Clean OptionsResolver from default readConcern, readPreference and writeConcern.
+        // This allows to reuse the same resolver in other commands, that may be called from different
+        // Client, Database or Collection instances with different default readConcern, readPreference and writeConcern
+        foreach (['readConcern', 'readPreference', 'writeConcern'] as $inheritedOption) {
+            if (
+                $resolver->isDefined($inheritedOption)
+                && $resolver->hasDefault($inheritedOption)
+                && $this->$inheritedOption === $resolver->getDefault($inheritedOption)
+            ) {
+                $resolver->removeDefault($inheritedOption);
+            }
+        }
 
         return $cursor;
     }
@@ -114,26 +125,13 @@ private function getResolver(array $command)
     {
         $commandName = key($command);
 
-        if (!isset($this->cache[$commandName])) {
-            if (!isset(self::$resolverClassesByCommandName[$commandName])) {
-                throw new LogicException(
-                    sprintf('OptionsResolver for command "%s" does not exist.', $commandName)
-                );
-            }
-            $resolverClass = self::$resolverClassesByCommandName[$commandName];
-            $resolver = clone OptionsResolver::get($resolverClass);
-
-            if ($resolver instanceof ReadConcernAwareInterface) {
-                $resolver->setDefaultReadConcern($this->readConcern);
-            }
-
-            if ($resolver instanceof WriteConcernAwareInterface) {
-                $resolver->setDefaultWriteConcern($this->writeConcern);
-            }
-
-            $this->cache[$commandName] = $resolver;
+        if (!isset(self::$resolverClassesByCommandName[$commandName])) {
+            throw new LogicException(
+                sprintf('OptionsResolver for command "%s" does not exist.', $commandName)
+            );
         }
+        $resolverClass = self::$resolverClassesByCommandName[$commandName];
 
-        return $this->cache[$commandName];
+        return OptionsResolver::get($resolverClass);
     }
 }