Add server description to the benchmark report (#1163)

GromNaN · web-flow · commit fdd77933b527 · 2023-09-15T15:28:07.000+02:00
* Add server description to the report
* Move warmup to each benchmark
* Remove BaseBench for specialized static classes
diff --git a/benchmark/BSON/DocumentBench.php b/benchmark/BSON/DocumentBench.php
@@ -2,22 +2,24 @@
 
 namespace MongoDB\Benchmark\BSON;
 
-use MongoDB\Benchmark\BaseBench;
+use MongoDB\Benchmark\Fixtures\Data;
 use MongoDB\BSON\Document;
 use PhpBench\Attributes\BeforeMethods;
+use PhpBench\Attributes\Warmup;
 use stdClass;
 
 use function file_get_contents;
 use function iterator_to_array;
 
 #[BeforeMethods('prepareData')]
-final class DocumentBench extends BaseBench
+#[Warmup(1)]
+final class DocumentBench
 {
     private static Document $document;
 
     public function prepareData(): void
     {
-        self::$document = Document::fromJSON(file_get_contents(self::LARGE_FILE_PATH));
+        self::$document = Document::fromJSON(file_get_contents(Data::LARGE_FILE_PATH));
     }
 
     public function benchCheckFirst(): void
diff --git a/benchmark/BSON/PackedArrayBench.php b/benchmark/BSON/PackedArrayBench.php
@@ -2,25 +2,23 @@
 
 namespace MongoDB\Benchmark\BSON;
 
-use MongoDB\Benchmark\BaseBench;
+use MongoDB\Benchmark\Fixtures\Data;
 use MongoDB\BSON\PackedArray;
 use PhpBench\Attributes\BeforeMethods;
+use PhpBench\Attributes\Warmup;
 
 use function array_values;
-use function file_get_contents;
 use function iterator_to_array;
-use function json_decode;
-
-use const JSON_THROW_ON_ERROR;
 
 #[BeforeMethods('prepareData')]
-final class PackedArrayBench extends BaseBench
+#[Warmup(1)]
+final class PackedArrayBench
 {
     private static PackedArray $array;
 
     public function prepareData(): void
     {
-        $array = array_values(json_decode(file_get_contents(self::LARGE_FILE_PATH), true, 512, JSON_THROW_ON_ERROR));
+        $array = array_values(Data::readJsonFile(Data::LARGE_FILE_PATH));
 
         self::$array = PackedArray::fromPHP($array);
     }
diff --git a/benchmark/BaseBench.php b/benchmark/BaseBench.php
diff --git a/benchmark/Extension/EnvironmentProvider.php b/benchmark/Extension/EnvironmentProvider.php
@@ -0,0 +1,74 @@
+<?php
+
+namespace MongoDB\Benchmark\Extension;
+
+use MongoDB\Benchmark\Utils;
+use MongoDB\Driver\Command;
+use MongoDB\Driver\Manager;
+use MongoDB\Driver\ReadPreference;
+use MongoDB\Driver\Server;
+use PhpBench\Environment\Information;
+use PhpBench\Environment\ProviderInterface;
+
+use function array_merge;
+use function implode;
+use function parse_url;
+use function str_replace;
+
+use const PHP_URL_PASS;
+
+class EnvironmentProvider implements ProviderInterface
+{
+    public function isApplicable(): bool
+    {
+        return true;
+    }
+
+    public function getInformation(): Information
+    {
+        $client = Utils::getClient();
+        $client->getManager()->selectServer();
+
+        return new Information('mongodb', array_merge(
+            $this->getUri(),
+            $this->getServerInfo($client->getManager()),
+            $this->getBuildInfo($client->getManager()),
+        ));
+    }
+
+    private function getUri(): array
+    {
+        $uri = Utils::getUri();
+        // Obfuscate the password in the URI
+        $uri = str_replace(':' . parse_url($uri, PHP_URL_PASS) . '@', ':***@', $uri);
+
+        return ['uri' => $uri];
+    }
+
+    private function getServerInfo(Manager $manager): array
+    {
+        $topology = match ($manager->selectServer()->getType()) {
+            Server::TYPE_STANDALONE => 'standalone',
+            Server::TYPE_LOAD_BALANCER => 'load-balanced',
+            Server::TYPE_RS_PRIMARY => 'replica-set',
+            Server::TYPE_MONGOS => 'sharded',
+            default => 'unknown',
+        };
+
+        return ['topology' => $topology];
+    }
+
+    private function getBuildInfo(Manager $manager): array
+    {
+        $buildInfo = $manager->executeCommand(
+            Utils::getDatabase(),
+            new Command(['buildInfo' => 1]),
+            new ReadPreference(ReadPreference::PRIMARY),
+        )->toArray()[0];
+
+        return [
+            'version' => $buildInfo->version ?? 'unknown server version',
+            'modules' => implode(', ', $buildInfo->modules ?? []),
+        ];
+    }
+}
diff --git a/benchmark/Extension/MongoDBExtension.php b/benchmark/Extension/MongoDBExtension.php
@@ -0,0 +1,25 @@
+<?php
+
+namespace MongoDB\Benchmark\Extension;
+
+use PhpBench\DependencyInjection\Container;
+use PhpBench\DependencyInjection\ExtensionInterface;
+use PhpBench\Extension\RunnerExtension;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+class MongoDBExtension implements ExtensionInterface
+{
+    public function load(Container $container): void
+    {
+        $container->register(
+            EnvironmentProvider::class,
+            fn (Container $container) => new EnvironmentProvider(),
+            [RunnerExtension::TAG_ENV_PROVIDER => ['name' => 'mongodb']],
+        );
+    }
+
+    public function configure(OptionsResolver $resolver): void
+    {
+        // No config
+    }
+}
diff --git a/benchmark/Fixtures/Data.php b/benchmark/Fixtures/Data.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace MongoDB\Benchmark\Fixtures;
+
+use function file_get_contents;
+use function json_decode;
+
+use const JSON_THROW_ON_ERROR;
+
+final class Data
+{
+    public const LARGE_FILE_PATH = __DIR__ . '/data/large_doc.json';
+    public const SMALL_FILE_PATH = __DIR__ . '/data/small_doc.json';
+    public const TWEET_FILE_PATH = __DIR__ . '/data/tweet.json';
+
+    public static function readJsonFile(string $path): array
+    {
+        return json_decode(file_get_contents($path), true, 512, JSON_THROW_ON_ERROR);
+    }
+}
diff --git a/benchmark/Fixtures/data/small_doc.json b/benchmark/Fixtures/data/small_doc.json
@@ -0,0 +1 @@
+{"oggaoR4O":"miNVpaKW","Vxri7mmI":"CS5VwrwN","IQ8K4ZMG":"Oq5Csk1w","WzI8s1W0":"ZPm57dhu","E5Aj2zB3":"gxUpzIjg","3MXe8Wi7":"Smo9whci","PHPSSV51":"TW34kfzq","CxSCo4jD":55336395,"5C8GSDC5":41992681,"fC63DsLR":72188733,"l6e0U4bR":46660880,"TLRpkltp":3527055,"Ph9CZN5L":74094448}
diff --git a/benchmark/ReadLargeDocumentBench.php b/benchmark/ReadLargeDocumentBench.php
@@ -3,6 +3,7 @@
 namespace MongoDB\Benchmark;
 
 use Generator;
+use MongoDB\Benchmark\Fixtures\Data;
 use MongoDB\Benchmark\Fixtures\PassThruCodec;
 use MongoDB\Benchmark\Fixtures\ToObjectCodec;
 use MongoDB\BSON\Document;
@@ -11,27 +12,25 @@
 use MongoDB\Model\BSONDocument;
 use PhpBench\Attributes\BeforeClassMethods;
 use PhpBench\Attributes\ParamProviders;
+use PhpBench\Attributes\Warmup;
 
 use function array_fill;
 use function array_intersect_key;
 use function assert;
-use function file_get_contents;
 use function is_array;
 use function is_object;
-use function json_decode;
 use function sprintf;
 
-use const JSON_THROW_ON_ERROR;
-
 #[BeforeClassMethods('prepareDatabase')]
-final class ReadLargeDocumentBench extends BaseBench
+#[Warmup(1)]
+final class ReadLargeDocumentBench
 {
     public static function prepareDatabase(): void
     {
-        $collection = self::getCollection();
+        $collection = Utils::getCollection();
         $collection->drop();
 
-        $document = json_decode(file_get_contents(self::LARGE_FILE_PATH), false, 512, JSON_THROW_ON_ERROR);
+        $document = Data::readJsonFile(Data::LARGE_FILE_PATH);
 
         $documents = array_fill(0, 10, $document);
 
@@ -86,7 +85,7 @@ public function benchCursorToArray(array $params): void
     {
         $options = array_intersect_key($params, ['codec' => true, 'typeMap' => true]);
 
-        $collection = self::getCollection();
+        $collection = Utils::getCollection();
 
         $collection->find([], $options)->toArray();
     }
@@ -96,7 +95,7 @@ public function benchAccessId(array $params): void
     {
         $options = array_intersect_key($params, ['codec' => true, 'typeMap' => true]);
 
-        $collection = self::getCollection();
+        $collection = Utils::getCollection();
 
         // Exhaust cursor and access identifier on each document
         foreach ($collection->find([], $options) as $document) {
@@ -109,7 +108,7 @@ public function benchAccessFirstField(array $params): void
     {
         $options = array_intersect_key($params, ['codec' => true, 'typeMap' => true]);
 
-        $collection = self::getCollection();
+        $collection = Utils::getCollection();
 
         // Exhaust cursor and access identifier on each document
         foreach ($collection->find([], $options) as $document) {
@@ -122,7 +121,7 @@ public function benchAccessLastField(array $params): void
     {
         $options = array_intersect_key($params, ['codec' => true, 'typeMap' => true]);
 
-        $collection = self::getCollection();
+        $collection = Utils::getCollection();
 
         // Exhaust cursor and access identifier on each document
         foreach ($collection->find([], $options) as $document) {
diff --git a/benchmark/ReadMultipleDocumentsBench.php b/benchmark/ReadMultipleDocumentsBench.php
@@ -3,6 +3,7 @@
 namespace MongoDB\Benchmark;
 
 use Generator;
+use MongoDB\Benchmark\Fixtures\Data;
 use MongoDB\Benchmark\Fixtures\PassThruCodec;
 use MongoDB\Benchmark\Fixtures\ToObjectCodec;
 use MongoDB\BSON\Document;
@@ -11,27 +12,25 @@
 use MongoDB\Model\BSONDocument;
 use PhpBench\Attributes\BeforeClassMethods;
 use PhpBench\Attributes\ParamProviders;
+use PhpBench\Attributes\Warmup;
 
 use function array_fill;
 use function array_intersect_key;
 use function assert;
-use function file_get_contents;
 use function is_array;
 use function is_object;
-use function json_decode;
 use function sprintf;
 
-use const JSON_THROW_ON_ERROR;
-
 #[BeforeClassMethods('prepareDatabase')]
-final class ReadMultipleDocumentsBench extends BaseBench
+#[Warmup(1)]
+final class ReadMultipleDocumentsBench
 {
     public static function prepareDatabase(): void
     {
-        $collection = self::getCollection();
+        $collection = Utils::getCollection();
         $collection->drop();
 
-        $tweet = json_decode(file_get_contents(self::TWEET_FILE_PATH), false, 512, JSON_THROW_ON_ERROR);
+        $tweet = Data::readJsonFile(Data::TWEET_FILE_PATH);
 
         $documents = array_fill(0, 1000, $tweet);
 
@@ -86,7 +85,7 @@ public function benchCursorToArray(array $params): void
     {
         $options = array_intersect_key($params, ['codec' => true, 'typeMap' => true]);
 
-        $collection = self::getCollection();
+        $collection = Utils::getCollection();
 
         $collection->find([], $options)->toArray();
     }
@@ -96,7 +95,7 @@ public function benchAccessId(array $params): void
     {
         $options = array_intersect_key($params, ['codec' => true, 'typeMap' => true]);
 
-        $collection = self::getCollection();
+        $collection = Utils::getCollection();
 
         // Exhaust cursor and access identifier on each document
         foreach ($collection->find([], $options) as $document) {
@@ -109,7 +108,7 @@ public function benchAccessNestedItem(array $params): void
     {
         $options = array_intersect_key($params, ['codec' => true, 'typeMap' => true]);
 
-        $collection = self::getCollection();
+        $collection = Utils::getCollection();
 
         // Exhaust cursor and access identifier on each document
         foreach ($collection->find([], $options) as $document) {
diff --git a/benchmark/Utils.php b/benchmark/Utils.php
diff --git a/phpbench.json.dist b/phpbench.json.dist

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"oggaoR4O":"miNVpaKW","Vxri7mmI":"CS5VwrwN","IQ8K4ZMG":"Oq5Csk1w","WzI8s1W0":"ZPm57dhu","E5Aj2zB3":"gxUpzIjg","3MXe8Wi7":"Smo9whci","PHPSSV51":"TW34kfzq","CxSCo4jD":55336395,"5C8GSDC5":41992681,"fC63DsLR":72188733,"l6e0U4bR":46660880,"TLRpkltp":3527055,"Ph9CZN5L":74094448}`