Implement Webdriver by TheSyscall · Pull Request #88 · Icinga/icingaweb2-module-pdfexport

TheSyscall · 2026-03-13T10:42:08Z

Changes

Removed ReactPHP dependency
The module no longer relies on ReactPHP, as such it no longer provides the asynchronous methods to generate PDFs that were never part of the Hook
Introduced backend abstraction
A new backend concept allows different rendering strategies to be plugged in and extended more easily.
Added WebDriver support
Implemented a WebDriver-based backend with support for Chrome and Firefox.
Automatic backend fallback
If a backend fails or is unavailable, the system now automatically falls back to the next available option. (The order of this is currently hardcoded as Webdriver > Remote Chrome > Local Chrome)
New configuration form
Replaced the existing configuration with a new ipl\Web\Compat\Form-based ConfigForm.

requires Icinga/icingaweb2#5480
~~requires Icinga/ipl-web#358~~
~~requires Icinga/icingaweb2#5491~~

related to Icinga/icingaweb2-module-reporting#275

WebDriver

This module can be configured to connect to a webdriver instance. (Backend)

When a PDF is requested, via the Print PDF button on any site or the one in the reporting module, it sends commands to the WebDriver server in a standardized format.

Each browser has its own driver (like ChromeDriver for Chrome or GeckoDriver for Firefox).
This driver acts as a bridge between your script and the browser.

Browser
The driver sends commands to the browser, which executes them just like a user interaction.

For this to work we require a working chromedriver or geckodriver (firefox) instance.

Adding this this to a docker compose file will spin up one for each of the supported webdrivers.

  selenium-chrome:
    image: selenium/standalone-chrome
    container_name: selenium-chrome
    ports:
      - "4444:4444"
    shm_size: '2gb'
    restart: always

  selenium-firefox:
    image: selenium/standalone-firefox
    container_name: selenium-firefox
    ports:
      - "4445:4444"
      - "7900:7900"
    shm_size: '2gb'
    restart: always

Currently supported features:

Backend	Generate PDF	Layout Plugins	Merge PDF (Coverpage)	Coverpage Layout	Header/Footer
HeadlessChrome Remote (Legacy)	Yes	Yes	Yes	Yes	Yes
HeadlessChrome Local (Legacy)	Yes	Yes	Yes	Yes	Yes
Chromedriver	Yes	Yes	Yes	No	Yes
Geckodriver	Yes	No	No	No	No

Known issues

Firefox seems to generate compressed PDFs and the TCPDF library we use https://github.com/karriereat/pdf-merge seems to not handle the deflate process properly.
~~Chromedriver reports an error with the coverpage properties.~~ Is actually related to a deprecated command.

(
x   [error] => invalid argument
   [message] => invalid argument: params not passed
   (Session info: chrome=145.0.7632.116)
   [stacktrace] => #0 0x55aaccc62b6a <unknown>
#1 0x55aacc675a32 <unknown>
#2 0x55aacc71fcee <unknown>
#3 0x55aacc713369 <unknown>
#4 0x55aacc6bcc0f <unknown>
#5 0x55aacc6bd9d1 <unknown>
#6 0x55aaccc276b9 <unknown>
#7 0x55aaccc2a5c1 <unknown>
#8 0x55aaccc13e29 <unknown>
#9 0x55aaccc2b17e <unknown>
#10 0x55aaccbfa4b0 <unknown>
#11 0x55aaccc4f578 <unknown>
#12 0x55aaccc4f74b <unknown>
#13 0x55aaccc611a3 <unknown>
#14 0x7fc8d9558aa4 <unknown>
#15 0x7fc8d95e5a64 __clone
)

TheSyscall · 2026-03-19T14:45:04Z

If you use docker you can just use the two services provided in the PR description.
The only other configuration apart from this is to go to the module's configuration page and add the host + port to the webdriver server.

To test the legacy chrome backend, just follow the existing documentation.

The PdfExport module allows you to create PDFs of any page in IW2, it is also used to create reports with a custom cover page in the reporting module.

TheSyscall · 2026-03-23T09:18:25Z

The master is also affected, so this is not our problem, is it?

It is not. The connection to the user can time out before the PDF is done generating, that seems to be a problem that has always existed, and this PR doesn't change that.

ReactPHP event loop, promise and child process have been removed and replaced with native PHP io stream functions

This allows us to set headers and footers

Now requires Icinga/icingaweb2#5480

No longer requires callouts

Makes pdfexport compatible with Icinga/icingaweb2#5491

sukhwinder33445 · 2026-04-10T09:19:57Z

Please have a look at this comment and the screenshot.

This is only done to provide backward compatibility and can be removed after we decide to break compatability.

TheSyscall · 2026-04-15T11:40:28Z

Please have a look at this comment and the screenshot.

This has been addressed in 6861696

Al2Klimov · 2026-04-15T14:24:55Z

+            'required'    => true,
+            'placeholder' => 100,
+            'min'         => 0,
+            'description' => $this->translate('The priority of the backend. A lower priority will be used first.'),


This ordering seems counter-intuitive to me at first sight.

@flourish86 What do you think?

This is the same order as menu items internally.

To be fair afaik. it is the first time that a user would have to interact with the number directly.

Al2Klimov · 2026-04-15T15:02:07Z

+        $this->addContent($table);
+    }
+
+    public function backendAction(): void


Being able to rename a backend would be nice. See https://github.com/Icinga/icinga-sso-web/pull/3

I would leave that up to Icinga/icingaweb2#5480

Shouldn't be necessary if you use random IDs as section keys like https://github.com/Icinga/icinga-sso-web/pull/3.

Al2Klimov · 2026-04-15T15:04:35Z

+        $this->addContent($table);
+    }
+
+    public function backendAction(): void


Being able to deactivate a backend temporarily for testing would be nice, but I guess changing priorities will do it as well. You decide.

Al2Klimov · 2026-04-15T15:07:54Z

+            case 'local_chrome':
+                $this->addElement('text', 'binary', [
+                    'label'       => $this->translate('Binary'),
+                    'placeholder' => '/usr/bin/google-chrome',


On my Fedora, it's sbin. While on it, I'd evaluate whether we can suggest Chromium instead.

Al2Klimov · 2026-04-15T15:46:45Z

+    ) {
+    }
+
+    public function execute(Command $command): mixed


Seems like all variables here can be inlined.

cla-bot Bot added the cla/signed label Mar 13, 2026

TheSyscall force-pushed the webdriver branch 2 times, most recently from cf3eb8d to 1a6156a Compare March 13, 2026 11:18

TheSyscall self-assigned this Mar 19, 2026

TheSyscall marked this pull request as ready for review March 19, 2026 08:26

TheSyscall requested a review from Al2Klimov March 19, 2026 08:26

This comment was marked as resolved.

Sign in to view

TheSyscall added 20 commits April 7, 2026 11:37

Removed dependency on ReactPHP

c803fcd

ReactPHP event loop, promise and child process have been removed and replaced with native PHP io stream functions

Install php-webdriver

b04bf63

Add types to printable html document

529a1c7

Use str_starts_with whereever possible

ec4097f

Add method to create parameters for printing with the webdriver

a890086

Add webdrivers for chrome and gecko (firefox)

1607807

Use destructor instead of close method

42fb217

Rewrite Pdfexport hook

380b66a

Convert the HeadlessChrome class into a PdfPrintDriver

7a28a6a

Move and rename HeadlessChrome to HeadlessChromeDriver

a634193

Rename $targetId -> $frameId

1e255ef

Always waitForPageLoad after setting content

835e92b

Implement basic driver selection

059642c

Fix form connection validation

1168851

Use chrome Page.printToPDF

c66980d

This allows us to set headers and footers

Fix coverpage creation

48d7829

FIXUP: remove comment

4161126

Use try catch

b863a7a

Format changes

fb9f483

Rename Driver to Backend

df37ddb

TheSyscall added 9 commits April 7, 2026 11:37

Add missing license headers and remove unused files

aa7704c

Code review suggestions

c5ab073

Use ConfigForm in IW2

92a0d2b

Now requires Icinga/icingaweb2#5480

Use 0/1 instead of n/y

085922b

Move script blocks into separate JavaScript files

eef4330

Update config form to allow for an arbitrary number of backends

5854c67

No longer requires callouts

Document webdriver installation

1dc3217

Add docstrings

322bbeb

Use ShellCommand abstraction

b08e5e2

TheSyscall force-pushed the webdriver branch from e870efa to b08e5e2 Compare April 7, 2026 12:38

TheSyscall requested a review from Al2Klimov April 7, 2026 12:48

TheSyscall added 3 commits April 8, 2026 10:30

Add a function to check if adding a cover page is supported

174faf2

Fix a deprecation with unset member access

958467f

fixme! Docstrings for ShellCommand

0a5dfa2

TheSyscall mentioned this pull request Apr 8, 2026

Add CompatForm based version of ConfigForm Icinga/icingaweb2#5480

Open

Bring back htmlToPdf function

907a1fd

Makes pdfexport compatible with Icinga/icingaweb2#5491

sukhwinder33445 mentioned this pull request Apr 9, 2026

Switch back to using syncronous pdf export Icinga/icingaweb2-module-reporting#275

Open

Store the last working backend instance

6861696

TheSyscall added 2 commits April 10, 2026 13:09

Remove types to stay backward compatible

50f297c

Change first method to mimic the behaviour of the base class

0cec004

This is only done to provide backward compatibility and can be removed after we decide to break compatability.

Al2Klimov mentioned this pull request Apr 15, 2026

Introduce PdfexportHook::htmlToPdf method Icinga/icingaweb2#5491

Open

Al2Klimov reviewed Apr 15, 2026

View reviewed changes

Al2Klimov self-requested a review April 15, 2026 16:03

TheSyscall added 3 commits April 16, 2026 08:15

Add deprecation warning for the old first method

f03bfc6

Use new ConfigSectionForm

c14c7a5

Code review changes

5864d1f

TheSyscall force-pushed the webdriver branch from e553152 to 5864d1f Compare April 16, 2026 09:53

Al2Klimov removed their request for review April 16, 2026 10:55

Conversation

TheSyscall commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

WebDriver

Currently supported features:

Known issues

Uh oh!

This comment was marked as resolved.

Uh oh!

TheSyscall commented Mar 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as resolved.

Uh oh!

TheSyscall commented Mar 23, 2026

Uh oh!

sukhwinder33445 commented Apr 10, 2026

Uh oh!

TheSyscall commented Apr 15, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

TheSyscall commented Mar 13, 2026 •

edited

Loading

TheSyscall commented Mar 19, 2026 •

edited

Loading