initial test approach

Author: eceltov

app/V1Module/presenters/RegistrationPresenter.php

@@ -27,7 +27,12 @@
 use App\Helpers\RegistrationConfig;
 use App\Helpers\InvitationHelper;
 use App\Helpers\MetaFormats\Attributes\Format;
+use App\Helpers\MetaFormats\Attributes\Path;
+use App\Helpers\MetaFormats\Attributes\Query;
 use App\Helpers\MetaFormats\FormatDefinitions\UserFormat;
+use App\Helpers\MetaFormats\Validators\VDouble;
+use App\Helpers\MetaFormats\Validators\VInt;
+use App\Helpers\MetaFormats\Validators\VUuid;
 use App\Security\Roles;
 use App\Security\ACL\IUserPermissions;
 use App\Security\ACL\IGroupPermissions;
@@ -447,4 +452,18 @@ public function actionAcceptInvitation()
             IResponse::S201_Created
         );
     }
+
+    /**
+     * Endpoint for performance testing.
+     * @POST
+     * @throws BadRequestException
+     * @throws InvalidArgumentException
+     */
+    #[Path("a", new VUuid())]
+    #[Query("b", new VInt())]
+    #[Post("c", new VDouble())]
+    public function actionTest()
+    {
+        $this->sendSuccessResponse("OK");
+    }
 }

app/V1Module/router/RouterFactory.php

@@ -478,6 +478,7 @@ private static function createUsersRoutes(string $prefix): RouteList
         $router[] = new PostRoute("$prefix/list", "Users:listByIds");
         $router[] = new GetRoute("$prefix/ical/<id>", "UserCalendars:");
         $router[] = new DeleteRoute("$prefix/ical/<id>", "UserCalendars:expireCalendar");
+        $router[] = new PostRoute("$prefix/test", "Registration:test");
         $router[] = new PostRoute("$prefix/invite", "Registration:createInvitation");
         $router[] = new PostRoute("$prefix/accept-invitation", "Registration:acceptInvitation");
 

app/commands/TestFormatPerformance.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace App\Console;
+
+use App\Helpers\Mocks\MockHelper;
+use App\V1Module\Presenters\RegistrationPresenter;
+use Nette\Application\Request;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use OpenApi\Generator;
+
+/**
+ * Command that consumes a temporary file containing endpoint annotations and generates a swagger documentation.
+ */
+class TestFormatPerformance extends Command
+{
+    protected static $defaultName = 'meta:performance';
+
+    protected function configure()
+    {
+        $this->setName(self::$defaultName)->setDescription(
+            'Generate an OpenAPI documentation from the temporary file created by the swagger:annotate command.'
+            . ' The temporary file is deleted afterwards.'
+        );
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $output->writeln("test");
+
+        $presenter = new RegistrationPresenter();
+        MockHelper::initPresenter($presenter);
+
+        $request = new Request(
+            "name",
+            method: "POST",
+            params: ["action" => "test", "a" => "497dcba3-ecbf-4587-a2dd-5eb0665e6880", "b" => "1"],
+            post: ["c" => 1.1]
+        );
+
+        // test whether the request works        
+        $response = $presenter->run($request);
+        if ($response->getPayload()["payload"] != "OK") {
+            $output->writeln("The endpoint did not run correctly.");
+            return Command::FAILURE;
+        }
+        
+        $startTime = microtime(true);
+        $iterations = 100_000;
+        for ($i = 0; $i < $iterations; $i++) {
+            $response = $presenter->run($request);
+        }
+        $endTime = microtime(true);
+        
+        $elapsed = $endTime - $startTime;
+        $output->writeln($elapsed);
+
+        return Command::SUCCESS;
+    }
+}

app/config/config.neon

@@ -322,6 +322,7 @@ services:
   - App\Console\ExportDatabase
   - App\Console\MetaConverter
   - App\Console\GenerateSwagger
+  - App\Console\TestFormatPerformance
   - App\Console\SwaggerAnnotator
   - App\Console\CleanupLocalizedTexts
   - App\Console\CleanupExerciseConfigs