Add basic benchmarks

Author: alcaeus

.gitattributes

@@ -1,6 +1,7 @@
 .* export-ignore
 *.md export-ignore
 tests export-ignore
+benchmark export-ignore
 docs export-ignore
 examples export-ignore
 mongo-orchestration export-ignore

.gitignore

@@ -15,4 +15,8 @@ phpcs.xml
 # psalm
 psalm.xml
 
+# phpbench
+.phpbench/
+phpbench.json
+
 mongocryptd.pid

benchmark/BSON/DocumentBench.php

@@ -0,0 +1,100 @@
+<?php
+/*
+ * Copyright 2023-present MongoDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace MongoDB\Benchmark\BSON;
+
+use MongoDB\Benchmark\BaseBench;
+use MongoDB\BSON\Document;
+use PhpBench\Attributes\BeforeMethods;
+
+use function file_get_contents;
+use function iterator_to_array;
+use function MongoDB\BSON\fromJSON;
+
+#[BeforeMethods('prepareData')]
+final class DocumentBench extends BaseBench
+{
+    private static string $rawBSON;
+    private static Document $document;
+
+    public function prepareData(): void
+    {
+        self::$rawBSON = fromJSON(file_get_contents(self::LARGE_FILE_PATH));
+    }
+
+    /** Create a document from the BSON string */
+    public static function getBSONDocument(): Document
+    {
+        return self::$document ??= Document::fromBSON(self::$rawBSON);
+    }
+
+    public function benchCheckFirst(): void
+    {
+        self::getBSONDocument()->has('qx3MigjubFSm');
+    }
+
+    public function benchCheckLast(): void
+    {
+        self::getBSONDocument()->has('Zz2MOlCxDhLl');
+    }
+
+    public function benchAccessFirst(): void
+    {
+        self::getBSONDocument()->get('qx3MigjubFSm');
+    }
+
+    public function benchAccessLast(): void
+    {
+        self::getBSONDocument()->get('Zz2MOlCxDhLl');
+    }
+
+    public function benchIteratorToArray(): void
+    {
+        iterator_to_array(self::getBSONDocument());
+    }
+
+    public function benchToPHPObject(): void
+    {
+        self::getBSONDocument()->toPHP();
+    }
+
+    public function benchToPHPArray(): void
+    {
+        self::getBSONDocument()->toPHP(['root' => 'array']);
+    }
+
+    public function benchIteration(): void
+    {
+        // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedForeach
+        foreach (self::getBSONDocument() as $key => $value) {
+        }
+    }
+
+    public function benchIterationAsArray(): void
+    {
+        // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedForeach
+        foreach (self::getBSONDocument()->toPHP(['root' => 'array']) as $key => $value) {
+        }
+    }
+
+    public function benchIterationAsObject(): void
+    {
+        // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedForeach
+        foreach (self::getBSONDocument()->toPHP() as $key => $value) {
+        }
+    }
+}

benchmark/BSON/PackedArrayBench.php

@@ -0,0 +1,103 @@
+<?php
+/*
+ * Copyright 2023-present MongoDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace MongoDB\Benchmark\BSON;
+
+use MongoDB\Benchmark\BaseBench;
+use MongoDB\BSON\Document;
+use MongoDB\BSON\PackedArray;
+use PhpBench\Attributes\BeforeMethods;
+
+use function array_values;
+use function file_get_contents;
+use function iterator_to_array;
+use function json_decode;
+use function MongoDB\BSON\fromPHP;
+
+use const JSON_THROW_ON_ERROR;
+
+#[BeforeMethods('prepareData')]
+final class PackedArrayBench extends BaseBench
+{
+    private static string $rawBSONDocument;
+    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));
+
+        // Store BSON string for a document since we can't create packed arrays from BSON strings
+        self::$rawBSONDocument = fromPHP(['array' => $array]);
+    }
+
+    /** Create a document from the BSON string */
+    public static function getBSONArray(): PackedArray
+    {
+        return self::$array ??= Document::fromBSON(self::$rawBSONDocument)->get('array');
+    }
+
+    public function benchCheckFirst(): void
+    {
+        self::getBSONArray()->has(0);
+    }
+
+    public function benchCheckLast(): void
+    {
+        self::getBSONArray()->has(94354);
+    }
+
+    public function benchAccessFirst(): void
+    {
+        self::getBSONArray()->get(0);
+    }
+
+    public function benchAccessLast(): void
+    {
+        self::getBSONArray()->get(94354);
+    }
+
+    public function benchIteratorToArray(): void
+    {
+        iterator_to_array(self::getBSONArray());
+    }
+
+    public function benchToPHPArray(): void
+    {
+        self::getBSONArray()->toPHP();
+    }
+
+    public function benchIteration(): void
+    {
+        // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedForeach
+        foreach (self::getBSONArray() as $key => $value) {
+        }
+    }
+
+    public function benchIterationAfterIteratorToArray(): void
+    {
+        // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedForeach
+        foreach (iterator_to_array(self::getBSONArray()) as $key => $value) {
+        }
+    }
+
+    public function benchIterationAsArray(): void
+    {
+        // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedForeach
+        foreach (self::getBSONArray()->toPHP() as $key => $value) {
+        }
+    }
+}

benchmark/BaseBench.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace MongoDB\Benchmark;
+
+use MongoDB\Client;
+use MongoDB\Collection;
+
+use function getenv;
+
+abstract class BaseBench
+{
+    protected const LARGE_FILE_PATH = __DIR__ . '/data/large_doc.json';
+    protected const TWEET_FILE_PATH = __DIR__ . '/data/tweet.json';
+
+    private static ?Collection $collection;
+
+    protected static function getCollection(): Collection
+    {
+        return self::$collection ??= self::createCollection();
+    }
+
+    protected static function createClient(array $options = [], array $driverOptions = []): Client
+    {
+        return new Client(self::getUri(), $options, $driverOptions);
+    }
+
+    public static function createCollection(): Collection
+    {
+        $client = self::createClient();
+
+        return $client->selectCollection(self::getDatabase(), 'perftest');
+    }
+
+    protected static function getUri(): string
+    {
+        return getenv('MONGODB_URI') ?: 'mongodb://localhost:27017/';
+    }
+
+    protected static function getDatabase(): string
+    {
+        return getenv('MONGODB_DATABASE') ?: 'phplib_test';
+    }
+}