Generate PDFs on Amazon AWS with PHP and Puppeteer

<?php declare(strict_types=1);
// src/Chromium/Chromium.php

namespace App\Chromium;

class Chromium
{
    private $path;

    public function __construct(string $path)
    {
        $this->path = $path;
    }

    public function getPath(): string
    {
        return $this->path;
    }
}

<?php declare(strict_types=1);
// src/Chromium/Chromium.php

namespace App\Chromium;

class Chromium
{
    private $path;

    public function __construct(string $path)
    {
        $this->path = $path;
    }

    public function getPath(): string
    {
        return $this->path;
    }
}

<?php declare(strict_types=1);
// src/Chromium/Factory/ChromiumFactory.php

namespace App\Chromium\Factory;

use App\Chromium\Chromium;
use Symfony\Component\Finder\Finder;
use Symfony\Component\Finder\SplFileInfo;
use Symfony\Component\Process\Exception\ProcessFailedException;
use Symfony\Component\Process\Process;

class ChromiumFactory
{
    private $binDir;
    private $tmpDir;
    private $chromiumDir;

    public function __construct(string $binDir, string $tmpDir, string $chromiumDir)
    {
        $this->binDir      = $binDir;
        $this->tmpDir      = $tmpDir;
        $this->chromiumDir = $chromiumDir;
    }

    public function initialize(): Chromium
    {
        $finder = new Finder();
        $finder->name('chromium-*')->files()->in($this->chromiumDir);

        foreach ($finder as $chromiumFile) {
            break;
        }

        if (!isset($chromiumFile) || !($chromiumFile instanceof SplFileInfo)) {
            throw new \RuntimeException(sprintf(
                'Unable to find Chromium binary in "%s" directory.',
                $this->chromiumDir
            ));
        }

        $this->inflate($chromiumFile->getFilename());
        $this->inflate('swiftshader/libEGL.so.br');
        $this->inflate('swiftshader/libGLESv2.so.br');

        $chromiumPath = $this->tmpDir.'/'.$chromiumFile->getFilenameWithoutExtension();

        $this->markAsExecutable($chromiumPath);

        return new Chromium($chromiumPath);
    }

    protected function inflate(string $filename): void
    {
        $extension = '.br';
        $extensionLength = strlen($extension);

        if (substr($filename, -$extensionLength) !== $extension) {
            throw new \InvalidArgumentException('Not a brotli file.');
        }

        $outputFilename = $this->tmpDir.'/'.substr($filename, 0, -$extensionLength);
        @mkdir(dirname($outputFilename), 0777, true);

        // Inflate file only if output file does not exist
        if (!file_exists($outputFilename)) {
            $process = new Process(["{$this->binDir}/brotli-amd64", '-d', "{$this->chromiumDir}/{$filename}", '-o', $outputFilename]);
            $process->run();

            if (!$process->isSuccessful()) {
                throw new ProcessFailedException($process);
            }
        }
    }

    protected function markAsExecutable(string $filename): void
    {
        $process = new Process(['chmod', '+x', $filename]);
        $process->run();

        if (!$process->isSuccessful()) {
            throw new ProcessFailedException($process);
        }
    }
}

<?php declare(strict_types=1);
// src/Chromium/Factory/ChromiumFactory.php

namespace App\Chromium\Factory;

use App\Chromium\Chromium;
use Symfony\Component\Finder\Finder;
use Symfony\Component\Finder\SplFileInfo;
use Symfony\Component\Process\Exception\ProcessFailedException;
use Symfony\Component\Process\Process;

class ChromiumFactory
{
    private $binDir;
    private $tmpDir;
    private $chromiumDir;

    public function __construct(string $binDir, string $tmpDir, string $chromiumDir)
    {
        $this->binDir      = $binDir;
        $this->tmpDir      = $tmpDir;
        $this->chromiumDir = $chromiumDir;
    }

    public function initialize(): Chromium
    {
        $finder = new Finder();
        $finder->name('chromium-*')->files()->in($this->chromiumDir);

        foreach ($finder as $chromiumFile) {
            break;
        }

        if (!isset($chromiumFile) || !($chromiumFile instanceof SplFileInfo)) {
            throw new \RuntimeException(sprintf(
                'Unable to find Chromium binary in "%s" directory.',
                $this->chromiumDir
            ));
        }

        $this->inflate($chromiumFile->getFilename());
        $this->inflate('swiftshader/libEGL.so.br');
        $this->inflate('swiftshader/libGLESv2.so.br');

        $chromiumPath = $this->tmpDir.'/'.$chromiumFile->getFilenameWithoutExtension();

        $this->markAsExecutable($chromiumPath);

        return new Chromium($chromiumPath);
    }

    protected function inflate(string $filename): void
    {
        $extension = '.br';
        $extensionLength = strlen($extension);

        if (substr($filename, -$extensionLength) !== $extension) {
            throw new \InvalidArgumentException('Not a brotli file.');
        }

        $outputFilename = $this->tmpDir.'/'.substr($filename, 0, -$extensionLength);
        @mkdir(dirname($outputFilename), 0777, true);

        // Inflate file only if output file does not exist
        if (!file_exists($outputFilename)) {
            $process = new Process(["{$this->binDir}/brotli-amd64", '-d', "{$this->chromiumDir}/{$filename}", '-o', $outputFilename]);
            $process->run();

            if (!$process->isSuccessful()) {
                throw new ProcessFailedException($process);
            }
        }
    }

    protected function markAsExecutable(string $filename): void
    {
        $process = new Process(['chmod', '+x', $filename]);
        $process->run();

        if (!$process->isSuccessful()) {
            throw new ProcessFailedException($process);
        }
    }
}

<?php declare(strict_types=1);

namespace App\MessageHandler;

use App\Chromium\Factory\ChromiumFactory;
use App\Message\GeneratePdfMessage;
use League\Flysystem\FilesystemInterface;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use Spatie\Browsershot\Browsershot;
use Symfony\Component\Messenger\Handler\MessageHandlerInterface;

class GeneratePdfMessageHandler implements MessageHandlerInterface, LoggerAwareInterface
{
    use LoggerAwareTrait;

    private $chromiumFactory;
    private $s3Storage;

    public function __construct(ChromiumFactory $chromiumFactory, FilesystemInterface $s3Storage)
    {
        $this->chromiumFactory = $chromiumFactory;
        $this->s3Storage = $s3Storage;
    }

    public function __invoke(GeneratePdfMessage $message): void
    {
        $pdf = $this->getBrowsershot()
            ->setHtml('My html...')
            ->pdf();
        // $pdf contains binary file content

        // Let's save it on Scaleway!
        $this->s3Storage->put('my-file.pdf', $pdf);
    }

    protected function getBrowsershot(): Browsershot
    {
        $chromium = $this->chromiumFactory->initialize();

        $browsershot = (new Browsershot())
            ->setChromePath($chromium->getPath())

            // recommended arguments
            ->addChromiumArguments([
                'disable-dev-shm-usage', // https://github.com/GoogleChrome/puppeteer/blob/master/docs/troubleshooting.md#tips
                'disable-gpu',
                'single-process',
                'no-sandbox',
            ])

            // we needed those options in our lambda to prevent issues, but you can ignore them
            ->ignoreHttpsErrors()
            ->setOption('waitUntil', 'domcontentloaded') // when event `DOMContentLoaded` is fired, external resources that takes longer to load (or timeout after 2 min) are not waited.
          ;

        return $browsershot;
    }
}

<?php declare(strict_types=1);

namespace App\MessageHandler;

use App\Chromium\Factory\ChromiumFactory;
use App\Message\GeneratePdfMessage;
use League\Flysystem\FilesystemInterface;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use Spatie\Browsershot\Browsershot;
use Symfony\Component\Messenger\Handler\MessageHandlerInterface;

class GeneratePdfMessageHandler implements MessageHandlerInterface, LoggerAwareInterface
{
    use LoggerAwareTrait;

    private $chromiumFactory;
    private $s3Storage;

    public function __construct(ChromiumFactory $chromiumFactory, FilesystemInterface $s3Storage)
    {
        $this->chromiumFactory = $chromiumFactory;
        $this->s3Storage = $s3Storage;
    }

    public function __invoke(GeneratePdfMessage $message): void
    {
        $pdf = $this->getBrowsershot()
            ->setHtml('My html...')
            ->pdf();
        // $pdf contains binary file content

        // Let's save it on Scaleway!
        $this->s3Storage->put('my-file.pdf', $pdf);
    }

    protected function getBrowsershot(): Browsershot
    {
        $chromium = $this->chromiumFactory->initialize();

        $browsershot = (new Browsershot())
            ->setChromePath($chromium->getPath())

            // recommended arguments
            ->addChromiumArguments([
                'disable-dev-shm-usage', // https://github.com/GoogleChrome/puppeteer/blob/master/docs/troubleshooting.md#tips
                'disable-gpu',
                'single-process',
                'no-sandbox',
            ])

            // we needed those options in our lambda to prevent issues, but you can ignore them
            ->ignoreHttpsErrors()
            ->setOption('waitUntil', 'domcontentloaded') // when event `DOMContentLoaded` is fired, external resources that takes longer to load (or timeout after 2 min) are not waited.
          ;

        return $browsershot;
    }
}