PHPLIB-1235 Implements Single-Doc Benchmarks

Author: GromNaN

benchmark/BSON/PackedArrayBench.php

@@ -20,7 +20,7 @@ final class PackedArrayBench extends BaseBench
 
     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(self::readJsonFile(self::LARGE_FILE_PATH));
 
         self::$array = PackedArray::fromPHP($array);
     }

benchmark/BaseBench.php

@@ -4,12 +4,18 @@
 
 use MongoDB\Client;
 use MongoDB\Collection;
+use stdClass;
 
+use function file_get_contents;
 use function getenv;
+use function json_decode;
+
+use const JSON_THROW_ON_ERROR;
 
 abstract class BaseBench
 {
     protected const LARGE_FILE_PATH = __DIR__ . '/Fixtures/data/large_doc.json';
+    protected const SMALL_FILE_PATH = __DIR__ . '/Fixtures/data/small_doc.json';
     protected const TWEET_FILE_PATH = __DIR__ . '/Fixtures/data/tweet.json';
 
     private static ?Collection $collection;
@@ -40,4 +46,9 @@ protected static function getDatabase(): string
     {
         return getenv('MONGODB_DATABASE') ?: 'phplib_test';
     }
+
+    protected static function readJsonFile(string $path): stdClass
+    {
+        return json_decode(file_get_contents($path), false, 512, JSON_THROW_ON_ERROR);
+    }
 }

benchmark/DriverBench/SingleDocBench.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace MongoDB\Benchmark\DriverBench;
+
+use Generator;
+use MongoDB\Benchmark\BaseBench;
+use PhpBench\Attributes as Bench;
+
+use function array_map;
+use function range;
+
+/** @see https://github.com/mongodb/specifications/blob/ddfc8b583d49aaf8c4c19fa01255afb66b36b92e/source/benchmarking/benchmarking.rst#single-doc-benchmarks */
+#[Bench\BeforeMethods('prepareDatabase')]
+final class SingleDocBench extends BaseBench
+{
+    public function prepareDatabase(): void
+    {
+        self::getCollection()->drop();
+    }
+
+    public function setupFindOneByID(): void
+    {
+        $tweet = (array) self::readJsonFile(self::TWEET_FILE_PATH);
+        $docs = array_map(fn ($id) => $tweet + ['_id' => $id], range(1, 10_000));
+        self::getCollection()->insertMany($docs);
+    }
+
+    #[Bench\BeforeMethods('setupFindOneByID')]
+    #[Bench\Revs(1)]
+    #[Bench\Iterations(10)]
+    public function benchFindOneByID(): void
+    {
+        $collection = self::getCollection();
+
+        for ($id = 1; $id <= 10_000; $id++) {
+            $collection->findOne(['_id' => $id]);
+        }
+    }
+
+    public static function provideInsertOneParams(): Generator
+    {
+        yield 'Small doc' => [
+            'document' => self::readJsonFile(self::SMALL_FILE_PATH),
+            'repeat' => 10_000,
+        ];
+
+        yield 'Large doc' => [
+            'document' => self::readJsonFile(self::LARGE_FILE_PATH),
+            'repeat' => 10,
+        ];
+    }
+
+    /** @param array{document: object, repeat: int} $params */
+    #[Bench\ParamProviders('provideInsertOneParams')]
+    #[Bench\Revs(1)]
+    #[Bench\Iterations(1)]
+    public function benchInsertOne(array $params): void
+    {
+        $collection = self::getCollection();
+
+        for ($i = $params['repeat']; $i > 0; $i--) {
+            $collection->insertOne($params['document']);
+        }
+    }
+}

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}

benchmark/ReadMultipleDocumentsBench.php

@@ -31,7 +31,7 @@ public static function prepareDatabase(): void
         $collection = self::getCollection();
         $collection->drop();
 
-        $tweet = json_decode(file_get_contents(self::TWEET_FILE_PATH), false, 512, JSON_THROW_ON_ERROR);
+        $tweet = self::readJsonFile(self::TWEET_FILE_PATH);
 
         $documents = array_fill(0, 1000, $tweet);
 

phpbench.json.dist

@@ -1,6 +1,7 @@
 {
     "$schema": "./vendor/phpbench/phpbench/phpbench.schema.json",
     "runner.bootstrap": "vendor/autoload.php",
+    "runner.file_pattern": ".*Bench.php$",
     "runner.path": "benchmark",
     "runner.iterations": 3,
     "runner.revs": 10,