Merge pull request #1365 from scyzoryck/add-phpbench

Add performnace benchmarks

.github/workflows/benchmark.yaml

@@ -0,0 +1,34 @@
+name: Benchmarks
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  phpbench:
+    name: "PHPBench"
+    runs-on: "ubuntu-20.04"
+
+    strategy:
+      matrix:
+        php-version:
+          - "7.2"
+          - "8.0"
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+
+      - name: "Install dependencies with Composer"
+        uses: "ramsey/composer-install@v1"
+
+      - name: Run tests
+        run: |
+          vendor/bin/phpbench run tests/Benchmark/ --report=aggregate

composer.json

@@ -36,6 +36,7 @@
         "doctrine/phpcr-odm": "^1.3|^2.0",
         "jackalope/jackalope-doctrine-dbal": "^1.1.5",
         "ocramius/proxy-manager": "^1.0|^2.0",
+        "phpbench/phpbench": "^1.0",
         "phpstan/phpstan": "^1.0.2",
         "phpunit/phpunit": "^8.0||^9.0",
         "psr/container": "^1.0",

phpbench.json

@@ -0,0 +1,5 @@
+{
+  "runner.bootstrap": "tests/bootstrap.php",
+  "runner.iterations": 3,
+  "runner.revs": 1
+}

tests/Benchmark/AbstractSerializationBench.php

@@ -0,0 +1,75 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JMS\Serializer\Tests\Benchmark;
+
+use JMS\Serializer\SerializationContext;
+use JMS\Serializer\Serializer;
+use JMS\Serializer\SerializerBuilder;
+use JMS\Serializer\Tests\Fixtures\Author;
+use JMS\Serializer\Tests\Fixtures\BlogPost;
+use JMS\Serializer\Tests\Fixtures\Comment;
+use JMS\Serializer\Tests\Fixtures\Publisher;
+
+abstract class AbstractSerializationBench
+{
+    /**
+     * @var Serializer
+     */
+    private $serializer;
+
+    /**
+     * @var array|BlogPost[]
+     */
+    private $collection;
+
+    /**
+     * @var string
+     */
+    private $format;
+
+    public function __construct()
+    {
+        $this->serializer = SerializerBuilder::create()->build();
+        $this->collection = $this->createCollection();
+        $this->format = $this->getFormat();
+    }
+
+    public function benchSerialization(): void
+    {
+        $this->serializer->serialize($this->collection, $this->format, $this->createContext());
+    }
+
+    abstract protected function getFormat(): string;
+
+    protected function createContext(): SerializationContext
+    {
+        return new SerializationContext();
+    }
+
+    private function createCollection()
+    {
+        $collection = [];
+        for ($i = 0; $i < 200; $i++) {
+            $collection[] = $this->createPost();
+        }
+
+        return $collection;
+    }
+
+    private function createPost()
+    {
+        $post = new BlogPost(
+            'FooooooooooooooooooooooBAR',
+            new Author('Foo'),
+            new \DateTime(),
+            new Publisher('bar')
+        );
+        for ($i = 0; $i < 100; $i++) {
+            $post->addComment(new Comment(new Author('foo'), 'foobar'));
+        }
+
+        return $post;
+    }
+}

tests/Benchmark/JsonMaxDepthSerializationBench.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JMS\Serializer\Tests\Benchmark;
+
+use JMS\Serializer\SerializationContext;
+
+class JsonMaxDepthSerializationBench extends JsonSerializationBench
+{
+    protected function createContext(): SerializationContext
+    {
+        return parent::createContext()->enableMaxDepthChecks();
+    }
+}

tests/Benchmark/JsonSerializationBench.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JMS\Serializer\Tests\Benchmark;
+
+class JsonSerializationBench extends AbstractSerializationBench
+{
+    protected function getFormat(): string
+    {
+        return 'json';
+    }
+}

tests/Benchmark/XmlSerializationBench.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JMS\Serializer\Tests\Benchmark;
+
+class XmlSerializationBench extends AbstractSerializationBench
+{
+    protected function getFormat(): string
+    {
+        return 'xml';
+    }
+}