Skip to content

Commit 57a7f3b

Browse files
alcaeusalcaeus
authored
PHPLIB-1183: Initial performance tests (#1141)
* Add basic benchmarks * Add GitHub actions workflow for performance benchmarks * Use semicolon for empty foreach * Remove separate phpbench configuration for CI * Simplify BSON structure creation * Remove unnecessary copyright notices * Ignore phpcs error for inline control structure
1 parent 3cd7091 commit 57a7f3b

13 files changed

+707
-1
lines changed

‎.gitattributes

+2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
.* export-ignore
22
*.md export-ignore
33
tests export-ignore
4+
benchmark export-ignore
45
docs export-ignore
56
examples export-ignore
67
mongo-orchestration export-ignore
78
stubs export-ignore
89
tools export-ignore
910
Makefile export-ignore
11+
phpbench.json.dist export-ignore
1012
phpcs.xml.dist export-ignore
1113
phpunit.evergreen.xml export-ignore
1214
phpunit.xml.dist export-ignore

‎.github/workflows/benchmark.yml

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
name: "Performance Benchmark"
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- "v*.*"
7+
- "master"
8+
- "feature/*"
9+
paths-ignore:
10+
- "docs/**"
11+
push:
12+
branches:
13+
- "v*.*"
14+
- "master"
15+
- "feature/*"
16+
paths-ignore:
17+
- "docs/**"
18+
19+
env:
20+
PHP_VERSION: "8.2"
21+
DRIVER_VERSION: "stable"
22+
23+
jobs:
24+
psalm:
25+
name: "phpbench"
26+
runs-on: "ubuntu-22.04"
27+
28+
steps:
29+
- name: "Checkout"
30+
uses: "actions/checkout@v3"
31+
32+
- id: setup-mongodb
33+
uses: mongodb-labs/drivers-evergreen-tools@master
34+
with:
35+
version: "6.0"
36+
topology: "server"
37+
skip-legacy-shell: true
38+
39+
- name: Setup cache environment
40+
id: extcache
41+
uses: shivammathur/cache-extensions@v1
42+
with:
43+
php-version: ${{ env.PHP_VERSION }}
44+
extensions: "mongodb-${{ ENV.DRIVER_VERSION }}"
45+
key: "extcache-v1"
46+
47+
- name: Cache extensions
48+
uses: actions/cache@v3
49+
with:
50+
path: ${{ steps.extcache.outputs.dir }}
51+
key: ${{ steps.extcache.outputs.key }}
52+
restore-keys: ${{ steps.extcache.outputs.key }}
53+
54+
- name: "Install PHP"
55+
uses: "shivammathur/setup-php@v2"
56+
with:
57+
coverage: "none"
58+
extensions: "mongodb-${{ ENV.DRIVER_VERSION }}"
59+
php-version: "${{ env.PHP_VERSION }}"
60+
61+
- name: "Show driver information"
62+
run: "php --ri mongodb"
63+
64+
- name: "Install dependencies with Composer"
65+
uses: "ramsey/[email protected]"
66+
with:
67+
composer-options: "--no-suggest"
68+
69+
- name: "Run phpbench"
70+
run: "vendor/bin/phpbench run --report=aggregate --report=bar_chart_time --output html"
71+
72+
- name: Upload HTML report
73+
uses: actions/upload-artifact@v3
74+
with:
75+
name: phpbench-${{ github.sha }}.html
76+
path: .phpbench/html/index.html
77+
retention-days: 3

‎.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,8 @@ phpcs.xml
1515
# psalm
1616
psalm.xml
1717

18+
# phpbench
19+
.phpbench/
20+
phpbench.json
21+
1822
mongocryptd.pid

‎benchmark/BSON/DocumentBench.php

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
<?php
2+
3+
namespace MongoDB\Benchmark\BSON;
4+
5+
use MongoDB\Benchmark\BaseBench;
6+
use MongoDB\BSON\Document;
7+
use PhpBench\Attributes\BeforeMethods;
8+
9+
use function file_get_contents;
10+
use function iterator_to_array;
11+
12+
#[BeforeMethods('prepareData')]
13+
final class DocumentBench extends BaseBench
14+
{
15+
private static Document $document;
16+
17+
public function prepareData(): void
18+
{
19+
self::$document = Document::fromJSON(file_get_contents(self::LARGE_FILE_PATH));
20+
}
21+
22+
public function benchCheckFirst(): void
23+
{
24+
self::$document->has('qx3MigjubFSm');
25+
}
26+
27+
public function benchCheckLast(): void
28+
{
29+
self::$document->has('Zz2MOlCxDhLl');
30+
}
31+
32+
public function benchAccessFirst(): void
33+
{
34+
self::$document->get('qx3MigjubFSm');
35+
}
36+
37+
public function benchAccessLast(): void
38+
{
39+
self::$document->get('Zz2MOlCxDhLl');
40+
}
41+
42+
public function benchIteratorToArray(): void
43+
{
44+
iterator_to_array(self::$document);
45+
}
46+
47+
public function benchToPHPObject(): void
48+
{
49+
self::$document->toPHP();
50+
}
51+
52+
public function benchToPHPArray(): void
53+
{
54+
self::$document->toPHP(['root' => 'array']);
55+
}
56+
57+
public function benchIteration(): void
58+
{
59+
// phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedForeach
60+
// phpcs:ignore Generic.ControlStructures.InlineControlStructure.NotAllowed
61+
foreach (self::$document as $key => $value);
62+
}
63+
64+
public function benchIterationAsArray(): void
65+
{
66+
// phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedForeach
67+
// phpcs:ignore Generic.ControlStructures.InlineControlStructure.NotAllowed
68+
foreach (self::$document->toPHP(['root' => 'array']) as $key => $value);
69+
}
70+
71+
public function benchIterationAsObject(): void
72+
{
73+
// phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedForeach
74+
// phpcs:ignore Generic.ControlStructures.InlineControlStructure.NotAllowed
75+
foreach (self::$document->toPHP() as $key => $value);
76+
}
77+
}

‎benchmark/BSON/PackedArrayBench.php

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
<?php
2+
3+
namespace MongoDB\Benchmark\BSON;
4+
5+
use MongoDB\Benchmark\BaseBench;
6+
use MongoDB\BSON\PackedArray;
7+
use PhpBench\Attributes\BeforeMethods;
8+
9+
use function array_values;
10+
use function file_get_contents;
11+
use function iterator_to_array;
12+
use function json_decode;
13+
14+
use const JSON_THROW_ON_ERROR;
15+
16+
#[BeforeMethods('prepareData')]
17+
final class PackedArrayBench extends BaseBench
18+
{
19+
private static PackedArray $array;
20+
21+
public function prepareData(): void
22+
{
23+
$array = array_values(json_decode(file_get_contents(self::LARGE_FILE_PATH), true, 512, JSON_THROW_ON_ERROR));
24+
25+
self::$array = PackedArray::fromPHP($array);
26+
}
27+
28+
public function benchCheckFirst(): void
29+
{
30+
self::$array->has(0);
31+
}
32+
33+
public function benchCheckLast(): void
34+
{
35+
self::$array->has(94354);
36+
}
37+
38+
public function benchAccessFirst(): void
39+
{
40+
self::$array->get(0);
41+
}
42+
43+
public function benchAccessLast(): void
44+
{
45+
self::$array->get(94354);
46+
}
47+
48+
public function benchIteratorToArray(): void
49+
{
50+
iterator_to_array(self::$array);
51+
}
52+
53+
public function benchToPHPArray(): void
54+
{
55+
self::$array->toPHP();
56+
}
57+
58+
public function benchIteration(): void
59+
{
60+
// phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedForeach
61+
// phpcs:ignore Generic.ControlStructures.InlineControlStructure.NotAllowed
62+
foreach (self::$array as $key => $value);
63+
}
64+
65+
public function benchIterationAfterIteratorToArray(): void
66+
{
67+
// phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedForeach
68+
// phpcs:ignore Generic.ControlStructures.InlineControlStructure.NotAllowed
69+
foreach (iterator_to_array(self::$array) as $key => $value);
70+
}
71+
72+
public function benchIterationAsArray(): void
73+
{
74+
// phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedForeach
75+
// phpcs:ignore Generic.ControlStructures.InlineControlStructure.NotAllowed
76+
foreach (self::$array->toPHP() as $key => $value);
77+
}
78+
}

‎benchmark/BaseBench.php

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<?php
2+
3+
namespace MongoDB\Benchmark;
4+
5+
use MongoDB\Client;
6+
use MongoDB\Collection;
7+
8+
use function getenv;
9+
10+
abstract class BaseBench
11+
{
12+
protected const LARGE_FILE_PATH = __DIR__ . '/data/large_doc.json';
13+
protected const TWEET_FILE_PATH = __DIR__ . '/data/tweet.json';
14+
15+
private static ?Collection $collection;
16+
17+
protected static function getCollection(): Collection
18+
{
19+
return self::$collection ??= self::createCollection();
20+
}
21+
22+
protected static function createClient(array $options = [], array $driverOptions = []): Client
23+
{
24+
return new Client(self::getUri(), $options, $driverOptions);
25+
}
26+
27+
public static function createCollection(): Collection
28+
{
29+
$client = self::createClient();
30+
31+
return $client->selectCollection(self::getDatabase(), 'perftest');
32+
}
33+
34+
protected static function getUri(): string
35+
{
36+
return getenv('MONGODB_URI') ?: 'mongodb://localhost:27017/';
37+
}
38+
39+
protected static function getDatabase(): string
40+
{
41+
return getenv('MONGODB_DATABASE') ?: 'phplib_test';
42+
}
43+
}

0 commit comments

Comments
 (0)