[Feature] Async generation

config/builder_pdf.php

@@ -21,6 +21,7 @@
         ->args([
             service('sensiolabs_gotenberg.client'),
             service('sensiolabs_gotenberg.asset.base_dir_formatter'),
+            service('sensiolabs_gotenberg.webhook_configuration_registry'),
             service('request_stack'),
             service('twig')->nullOnInvalid(),
         ])
@@ -33,6 +34,7 @@
         ->args([
             service('sensiolabs_gotenberg.client'),
             service('sensiolabs_gotenberg.asset.base_dir_formatter'),
+            service('sensiolabs_gotenberg.webhook_configuration_registry'),
             service('request_stack'),
             service('twig')->nullOnInvalid(),
             service('router')->nullOnInvalid(),
@@ -47,6 +49,7 @@
         ->args([
             service('sensiolabs_gotenberg.client'),
             service('sensiolabs_gotenberg.asset.base_dir_formatter'),
+            service('sensiolabs_gotenberg.webhook_configuration_registry'),
             service('request_stack'),
             service('twig')->nullOnInvalid(),
         ])
@@ -59,6 +62,7 @@
         ->args([
             service('sensiolabs_gotenberg.client'),
             service('sensiolabs_gotenberg.asset.base_dir_formatter'),
+            service('sensiolabs_gotenberg.webhook_configuration_registry'),
         ])
         ->call('setLogger', [service('logger')->nullOnInvalid()])
         ->tag('sensiolabs_gotenberg.pdf_builder')
@@ -69,6 +73,7 @@
         ->args([
             service('sensiolabs_gotenberg.client'),
             service('sensiolabs_gotenberg.asset.base_dir_formatter'),
+            service('sensiolabs_gotenberg.webhook_configuration_registry'),
         ])
         ->call('setLogger', [service('logger')->nullOnInvalid()])
         ->tag('sensiolabs_gotenberg.pdf_builder')
@@ -79,6 +84,7 @@
         ->args([
             service('sensiolabs_gotenberg.client'),
             service('sensiolabs_gotenberg.asset.base_dir_formatter'),
+            service('sensiolabs_gotenberg.webhook_configuration_registry'),
         ])
         ->call('setLogger', [service('logger')->nullOnInvalid()])
         ->tag('sensiolabs_gotenberg.pdf_builder')

config/builder_screenshot.php

@@ -18,6 +18,7 @@
         ->args([
             service('sensiolabs_gotenberg.client'),
             service('sensiolabs_gotenberg.asset.base_dir_formatter'),
+            service('sensiolabs_gotenberg.webhook_configuration_registry'),
             service('request_stack'),
             service('twig')->nullOnInvalid(),
         ])
@@ -30,6 +31,7 @@
         ->args([
             service('sensiolabs_gotenberg.client'),
             service('sensiolabs_gotenberg.asset.base_dir_formatter'),
+            service('sensiolabs_gotenberg.webhook_configuration_registry'),
             service('request_stack'),
             service('twig')->nullOnInvalid(),
             service('router')->nullOnInvalid(),
@@ -44,6 +46,7 @@
         ->args([
             service('sensiolabs_gotenberg.client'),
             service('sensiolabs_gotenberg.asset.base_dir_formatter'),
+            service('sensiolabs_gotenberg.webhook_configuration_registry'),
             service('request_stack'),
             service('twig')->nullOnInvalid(),
         ])

config/services.php

@@ -11,6 +11,8 @@
 use Sensiolabs\GotenbergBundle\GotenbergScreenshot;
 use Sensiolabs\GotenbergBundle\GotenbergScreenshotInterface;
 use Sensiolabs\GotenbergBundle\Twig\GotenbergAssetExtension;
+use Sensiolabs\GotenbergBundle\Webhook\WebhookConfigurationRegistry;
+use Sensiolabs\GotenbergBundle\Webhook\WebhookConfigurationRegistryInterface;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 use Symfony\Component\Filesystem\Filesystem;
 use function Symfony\Component\DependencyInjection\Loader\Configurator\abstract_arg;
@@ -68,4 +70,13 @@
     $services->set('sensiolabs_gotenberg.http_kernel.stream_builder', ProcessBuilderOnControllerResponse::class)
         ->tag('kernel.event_listener', ['method' => 'streamBuilder', 'event' => 'kernel.view'])
     ;
+
+    $services->set('sensiolabs_gotenberg.webhook_configuration_registry', WebhookConfigurationRegistry::class)
+        ->args([
+            service('router'),
+            service('.sensiolabs_gotenberg.request_context')->nullOnInvalid(),
+        ])
+        ->tag('sensiolabs_gotenberg.webhook_configuration_registry')
+        ->alias(WebhookConfigurationRegistryInterface::class, 'sensiolabs_gotenberg.webhook_configuration_registry')
+    ;
 };

docs/builders_api.md

@@ -2,14 +2,16 @@
 
 ## Pdf
 
-* [HtmlPdfBuilder](./pdf/builders_api/HtmlPdfBuilder.md)
-* [UrlPdfBuilder](./pdf/builders_api/UrlPdfBuilder.md)
-* [MarkdownPdfBuilder](./pdf/builders_api/MarkdownPdfBuilder.md)
-* [LibreOfficePdfBuilder](./pdf/builders_api/LibreOfficePdfBuilder.md)
+* [HtmlPdfBuilder](./Pdf/builders_api/HtmlPdfBuilder.md)
+* [UrlPdfBuilder](./Pdf/builders_api/UrlPdfBuilder.md)
+* [MarkdownPdfBuilder](./Pdf/builders_api/MarkdownPdfBuilder.md)
+* [LibreOfficePdfBuilder](./Pdf/builders_api/LibreOfficePdfBuilder.md)
+* [MergePdfBuilder](./Pdf/builders_api/MergePdfBuilder.md)
+* [ConvertPdfBuilder](./Pdf/builders_api/ConvertPdfBuilder.md)
 
 ## Screenshot
 
-* [HtmlScreenshotBuilder](./screenshot/builders_api/HtmlScreenshotBuilder.md)
-* [UrlScreenshotBuilder](./screenshot/builders_api/UrlScreenshotBuilder.md)
-* [MarkdownScreenshotBuilder](./screenshot/builders_api/MarkdownScreenshotBuilder.md)
+* [HtmlScreenshotBuilder](./Screenshot/builders_api/HtmlScreenshotBuilder.md)
+* [UrlScreenshotBuilder](./Screenshot/builders_api/UrlScreenshotBuilder.md)
+* [MarkdownScreenshotBuilder](./Screenshot/builders_api/MarkdownScreenshotBuilder.md)
 

docs/generate.php

@@ -1,9 +1,11 @@
 #!/usr/bin/env php
 <?php
 
+use Sensiolabs\GotenbergBundle\Builder\Pdf\ConvertPdfBuilder;
 use Sensiolabs\GotenbergBundle\Builder\Pdf\HtmlPdfBuilder;
 use Sensiolabs\GotenbergBundle\Builder\Pdf\LibreOfficePdfBuilder;
 use Sensiolabs\GotenbergBundle\Builder\Pdf\MarkdownPdfBuilder;
+use Sensiolabs\GotenbergBundle\Builder\Pdf\MergePdfBuilder;
 use Sensiolabs\GotenbergBundle\Builder\Pdf\UrlPdfBuilder;
 use Sensiolabs\GotenbergBundle\Builder\Screenshot\HtmlScreenshotBuilder;
 use Sensiolabs\GotenbergBundle\Builder\Screenshot\MarkdownScreenshotBuilder;
@@ -23,6 +25,8 @@
         UrlPdfBuilder::class,
         MarkdownPdfBuilder::class,
         LibreOfficePdfBuilder::class,
+        MergePdfBuilder::class,
+        ConvertPdfBuilder::class,
     ],
     'Screenshot' => [
         HtmlScreenshotBuilder::class,
@@ -36,6 +40,7 @@
     'setLogger',
     'setConfigurations',
     'generate',
+    'generateAsync',
     'getMultipartFormData',
 ];
 
@@ -59,7 +64,7 @@ function parseDocComment(string $rawDocComment): string
 {
     $result = '';
 
-    $lines = explode("\n", $rawDocComment);
+    $lines = explode("\n", trim($rawDocComment, "\n"));
     array_shift($lines);
     array_pop($lines);
 
@@ -89,13 +94,28 @@ function parseBuilder(ReflectionClass $builder): string
     $builderName = $builder->getShortName();
     $markdown .= "# {$builderName}\n\n";
 
+    $builderComment = $builder->getDocComment();
+
+    if (false !== $builderComment) {
+        $markdown .= parseDocComment($builderComment)."\n";
+    }
+
+    $methods = [];
+    foreach ($builder->getInterfaces() as $interface) {
+        foreach ($interface->getMethods() as $method) {
+            if ('' !== ($method->getDocComment() ?: '')) {
+                $methods[$method->getName()] = parseDocComment($method->getDocComment());
+            }
+        }
+    }
+
     foreach ($builder->getMethods(ReflectionMethod::IS_PUBLIC) as $method) {
         if (\in_array($method->getName(), EXCLUDED_METHODS, true) === true) {
             continue;
         }
 
         $methodSignature = parseMethodSignature($method);
-        $docComment = parseDocComment($method->getDocComment() ?: '');
+        $docComment = parseDocComment($methods[$method->getShortName()] ?? $method->getDocComment() ?: '');
 
         $markdown .= <<<"MARKDOWN"
         * `{$methodSignature}`:
@@ -118,7 +138,7 @@ function saveFile(InputInterface $input, string $filename, string $contents): vo
         $summary = "# Builders API\n\n";
 
         foreach (BUILDERS as $type => $builderClasses) {
-            $subDirectory = strtolower($type).'/builders_api';
+            $subDirectory = "{$type}/builders_api";
             $directory = __DIR__.'/'.$subDirectory;
 
             if (!@mkdir($directory, recursive: true) && !is_dir($directory)) {

docs/pdf/builders_api/ConvertPdfBuilder.md

@@ -0,0 +1,25 @@
+# ConvertPdfBuilder
+
+* `pdfFormat(Sensiolabs\GotenbergBundle\Enumeration\PdfFormat $format)`:
+Convert the resulting PDF into the given PDF/A format.
+
+* `pdfUniversalAccess(bool $bool)`:
+Enable PDF for Universal Access for optimal accessibility.
+
+* `files(string $paths)`:
+
+* `downloadFrom(array $downloadFrom)`:
+
+* `webhookConfiguration(string $webhook)`:
+Providing an existing $webhook from the configuration file, it will correctly set both success and error webhook URLs as well as extra_http_headers if defined.
+
+* `webhookUrls(string $successWebhook, ?string $errorWebhook)`:
+Allows to set both $successWebhook and $errorWebhook URLs. If $errorWebhook is not provided, it will fallback to $successWebhook one.
+
+* `webhookExtraHeaders(array $extraHeaders)`:
+Extra headers that will be provided to the webhook endpoint. May it either be Success or Error.
+
+* `fileName(string $fileName, string $headerDisposition)`:
+
+* `processor(Sensiolabs\GotenbergBundle\Processor\ProcessorInterface $processor)`:
+

docs/pdf/builders_api/HtmlPdfBuilder.md

@@ -129,6 +129,15 @@ The metadata to write.
 
 * `downloadFrom(array $downloadFrom)`:
 
+* `webhookConfiguration(string $webhook)`:
+Providing an existing $webhook from the configuration file, it will correctly set both success and error webhook URLs as well as extra_http_headers if defined.
+
+* `webhookUrls(string $successWebhook, ?string $errorWebhook)`:
+Allows to set both $successWebhook and $errorWebhook URLs. If $errorWebhook is not provided, it will fallback to $successWebhook one.
+
+* `webhookExtraHeaders(array $extraHeaders)`:
+Extra headers that will be provided to the webhook endpoint. May it either be Success or Error.
+
 * `fileName(string $fileName, string $headerDisposition)`:
 
 * `processor(Sensiolabs\GotenbergBundle\Processor\ProcessorInterface $processor)`:

docs/pdf/builders_api/LibreOfficePdfBuilder.md

@@ -87,6 +87,15 @@ If the form field reduceImageResolution is set to true, tell if all images will
 
 * `downloadFrom(array $downloadFrom)`:
 
+* `webhookConfiguration(string $webhook)`:
+Providing an existing $webhook from the configuration file, it will correctly set both success and error webhook URLs as well as extra_http_headers if defined.
+
+* `webhookUrls(string $successWebhook, ?string $errorWebhook)`:
+Allows to set both $successWebhook and $errorWebhook URLs. If $errorWebhook is not provided, it will fallback to $successWebhook one.
+
+* `webhookExtraHeaders(array $extraHeaders)`:
+Extra headers that will be provided to the webhook endpoint. May it either be Success or Error.
+
 * `fileName(string $fileName, string $headerDisposition)`:
 
 * `processor(Sensiolabs\GotenbergBundle\Processor\ProcessorInterface $processor)`:

docs/pdf/builders_api/MarkdownPdfBuilder.md

@@ -132,6 +132,15 @@ The metadata to write.
 
 * `downloadFrom(array $downloadFrom)`:
 
+* `webhookConfiguration(string $webhook)`:
+Providing an existing $webhook from the configuration file, it will correctly set both success and error webhook URLs as well as extra_http_headers if defined.
+
+* `webhookUrls(string $successWebhook, ?string $errorWebhook)`:
+Allows to set both $successWebhook and $errorWebhook URLs. If $errorWebhook is not provided, it will fallback to $successWebhook one.
+
+* `webhookExtraHeaders(array $extraHeaders)`:
+Extra headers that will be provided to the webhook endpoint. May it either be Success or Error.
+
 * `fileName(string $fileName, string $headerDisposition)`:
 
 * `processor(Sensiolabs\GotenbergBundle\Processor\ProcessorInterface $processor)`:

docs/pdf/builders_api/MergePdfBuilder.md

@@ -0,0 +1,33 @@
+# MergePdfBuilder
+
+Merge `n` pdf files into a single one.
+
+* `pdfFormat(Sensiolabs\GotenbergBundle\Enumeration\PdfFormat $format)`:
+Convert the resulting PDF into the given PDF/A format.
+
+* `pdfUniversalAccess(bool $bool)`:
+Enable PDF for Universal Access for optimal accessibility.
+
+* `files(string $paths)`:
+
+* `metadata(array $metadata)`:
+Resets the metadata.
+
+* `addMetadata(string $key, string $value)`:
+The metadata to write.
+
+* `downloadFrom(array $downloadFrom)`:
+
+* `webhookConfiguration(string $webhook)`:
+Providing an existing $webhook from the configuration file, it will correctly set both success and error webhook URLs as well as extra_http_headers if defined.
+
+* `webhookUrls(string $successWebhook, ?string $errorWebhook)`:
+Allows to set both $successWebhook and $errorWebhook URLs. If $errorWebhook is not provided, it will fallback to $successWebhook one.
+
+* `webhookExtraHeaders(array $extraHeaders)`:
+Extra headers that will be provided to the webhook endpoint. May it either be Success or Error.
+
+* `fileName(string $fileName, string $headerDisposition)`:
+
+* `processor(Sensiolabs\GotenbergBundle\Processor\ProcessorInterface $processor)`:
+

docs/pdf/builders_api/UrlPdfBuilder.md

@@ -131,6 +131,15 @@ The metadata to write.
 
 * `downloadFrom(array $downloadFrom)`:
 
+* `webhookConfiguration(string $webhook)`:
+Providing an existing $webhook from the configuration file, it will correctly set both success and error webhook URLs as well as extra_http_headers if defined.
+
+* `webhookUrls(string $successWebhook, ?string $errorWebhook)`:
+Allows to set both $successWebhook and $errorWebhook URLs. If $errorWebhook is not provided, it will fallback to $successWebhook one.
+
+* `webhookExtraHeaders(array $extraHeaders)`:
+Extra headers that will be provided to the webhook endpoint. May it either be Success or Error.
+
 * `fileName(string $fileName, string $headerDisposition)`:
 
 * `processor(Sensiolabs\GotenbergBundle\Processor\ProcessorInterface $processor)`:

docs/screenshot/builders_api/HtmlScreenshotBuilder.md

@@ -74,6 +74,15 @@ Adds a file, like an image, font, stylesheet, and so on.
 
 * `downloadFrom(array $downloadFrom)`:
 
+* `webhookConfiguration(string $webhook)`:
+Providing an existing $webhook from the configuration file, it will correctly set both success and error webhook URLs as well as extra_http_headers if defined.
+
+* `webhookUrls(string $successWebhook, ?string $errorWebhook)`:
+Allows to set both $successWebhook and $errorWebhook URLs. If $errorWebhook is not provided, it will fallback to $successWebhook one.
+
+* `webhookExtraHeaders(array $extraHeaders)`:
+Extra headers that will be provided to the webhook endpoint. May it either be Success or Error.
+
 * `fileName(string $fileName, string $headerDisposition)`:
 
 * `processor(Sensiolabs\GotenbergBundle\Processor\ProcessorInterface $processor)`:

docs/screenshot/builders_api/MarkdownScreenshotBuilder.md

@@ -77,6 +77,15 @@ Adds a file, like an image, font, stylesheet, and so on.
 
 * `downloadFrom(array $downloadFrom)`:
 
+* `webhookConfiguration(string $webhook)`:
+Providing an existing $webhook from the configuration file, it will correctly set both success and error webhook URLs as well as extra_http_headers if defined.
+
+* `webhookUrls(string $successWebhook, ?string $errorWebhook)`:
+Allows to set both $successWebhook and $errorWebhook URLs. If $errorWebhook is not provided, it will fallback to $successWebhook one.
+
+* `webhookExtraHeaders(array $extraHeaders)`:
+Extra headers that will be provided to the webhook endpoint. May it either be Success or Error.
+
 * `fileName(string $fileName, string $headerDisposition)`:
 
 * `processor(Sensiolabs\GotenbergBundle\Processor\ProcessorInterface $processor)`:

docs/screenshot/builders_api/UrlScreenshotBuilder.md

@@ -76,6 +76,15 @@ Adds a file, like an image, font, stylesheet, and so on.
 
 * `downloadFrom(array $downloadFrom)`:
 
+* `webhookConfiguration(string $webhook)`:
+Providing an existing $webhook from the configuration file, it will correctly set both success and error webhook URLs as well as extra_http_headers if defined.
+
+* `webhookUrls(string $successWebhook, ?string $errorWebhook)`:
+Allows to set both $successWebhook and $errorWebhook URLs. If $errorWebhook is not provided, it will fallback to $successWebhook one.
+
+* `webhookExtraHeaders(array $extraHeaders)`:
+Extra headers that will be provided to the webhook endpoint. May it either be Success or Error.
+
 * `fileName(string $fileName, string $headerDisposition)`:
 
 * `processor(Sensiolabs\GotenbergBundle\Processor\ProcessorInterface $processor)`:

phpunit.xml

@@ -7,6 +7,10 @@
          requireCoverageMetadata="true"
          beStrictAboutCoverageMetadata="true"
          beStrictAboutOutputDuringTests="true"
+         displayDetailsOnTestsThatTriggerDeprecations="true"
+         displayDetailsOnTestsThatTriggerErrors="true"
+         displayDetailsOnTestsThatTriggerNotices="true"
+         displayDetailsOnTestsThatTriggerWarnings="true"
          failOnRisky="true"
          failOnWarning="true">
     <php>

src/Builder/AsyncBuilderInterface.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Sensiolabs\GotenbergBundle\Builder;
+
+interface AsyncBuilderInterface
+{
+    /**
+     * Generates a file asynchronously.
+     */
+    public function generateAsync(): void;
+}