README

Laravel Dusk Screenrecording is a package, that was created by and maintained by Sander van Kasteel that enables you to do screenrecording of your Dusk tests.

<INSERT_EXAMPLE>

Usage

Warning: Currently only Chrome is supported

Requires PHP 7.4+

Requires Laravel 7 (or higher)

First install the pacakge

composer require --dev sandervankasteel/laravel-dusk-screenrecordings

Publish the configuration

php artisan vendor:publish

Modify your tests/DuskTestcase.php to have screen recordings work.

Example implmentation

    protected function driver()
    {
        $options = (new ChromeOptions)
            ->setExperimentalOption("prefs", [
                "download.default_directory" => $this->downloadDir
            ])
        ->addArguments(collect([
            '--window-size=1920,1080',
        ])->unless($this->hasHeadlessDisabled(), function ($items) {
            return $items->merge([
                '--disable-gpu',
                '--headless',
            ]);
        })->merge(
            $this->getChromeArgs()
        )->all());

        return RemoteWebDriver::create(
            $_ENV['DUSK_DRIVER_URL'] ?? 'http://localhost:9515',
            DesiredCapabilities::chrome()->setCapability(
                ChromeOptions::CAPABILITY, $options
            )
        );
    }

The most important parts are the

$this->getChromeArgs()

and the

->setExperimentalOption("prefs", [
                "download.default_directory" => $this->downloadDir
            ])

Firstly, we need to get a specific set of arguments, so that Chrome will allow us to record from an non-HTTPS source and automatically select the source from which to record from.

Lastly, we need to set download.default_directory to a known directory, so we know from which directory we need to move our recordings from.

Add the WithScreenRecordings to your tests/DuskTestCase.php, so we will actually record and store the recordings.

use Sandervankasteel\LaravelDuskScreenrecordings\WithScreenRecordings;

abstract class DuskTestCase extends BaseTestCase
{
    use CreatesApplication,
        WithScreenRecordings;
        
    // Rest of your DuskTestCase
}

Run php artisan dusk to see it in action 🥳 🚀

How it works

This package works by loading a browser plugin, which in turns creates a new (pinned) tab in the browser, then it initializes the screenrecording and then executes the test as usual.

Once the tests are finished, based on the configuration it will 'download' the screenrecording from the tab created by the browser extension.

TODO

Add Firefox support
Fix --auto-select-desktop-capture-source argument under Linux
Ideal case scenario: enable window recording (instead of the full desktop).

apsonex / laravel-dusk-screenrecordings

Maintainers

Details