Dashboard for Laravel Lighthouse GraphQL

:warning: WORK IN PROGRESS! BREAKING CHANGES ARE EXPECTED!

This package adds a standalone analytics dasbhoard with metrics collected from Laravel Lighthouse GraphQL Server.

Requirements:

• PHP >= 7.4
• Laravel >= 8.x
• Laravel Lighthouse >= 5.x

Questions? Join us in Slack Channel.

Install

Require the package.

composer require robsontenorio/lighthouse-dashboard

Publish package assets and config file.

php artisan lighthouse-dashboard:publish

Configure the package.

// config/lighthouse-dashboard.php

return [
    /**
     * Authenticated user attribute for identify the current client.
     * 
     * If there is no authenticated user a `anonymous` will be used.
     * Default is `Auth::user()->username`
     */

    'client_identifier' => 'username',

    /**
     * Database connection name for the dashboard.
     * 
     * By default it uses different connection. You must create it.
     * Or set it to `null` if want to use same connection from target app.
     */

    'connection' => 'dashboard',
];

Run package migrations.

php artisan lighthouse-dashboard:migrate

Open the dashboard.

http://your-app/lighthouse-dashboard

To keep the assets up-to-date and avoid issues in future updates, we highly recommend adding the command to the post-autoload-dump section in your composer.json file:

{    
    "scripts": {
        "post-autoload-dump": [            
            "@php artisan lighthouse-dashboard:publish-assets"
        ]
    }
}

Note about phpunit tests

This dashboard collects metrics by listening Nuwave\Lighthouse\Events\ManipulateResult . Make sure to disable this on your parent TestCase, in order to prevent metrics collecting while testing your app.

use Nuwave\Lighthouse\Events\ManipulateResult;

abstract class TestCase extends BaseTestCase
{    
    // use this Trait
    use DisableDashboardMetrics;

    public  function setUp(): void
    {
        parent::setUp();

        // Then, disable metrics while testing
        $this->withoutDashboardMetrics();
    }
}

How does it works?

Configurations

Tests

Local development

See more ...

Once this package includes UI, the only way to see it is by running it through target app. ### Uninstall If you previous installed this package, **first uninstall it from target app**. Remove this entry from `composer.json`. ```json { "scripts": { "post-autoload-dump": [ "@php artisan lighthouse-dashboard:publish-assets" ] } } ``` Remove package. ``` composer remove robsontenorio/lighthouse-dashboard ``` Remove package public assets from target app. ``` rm -rf /path/to/app/public/vendor/lighthouse-dashboard ``` ### Install locally Clone the repository, then on target app add to `composer.json` ```json "repositories": { "robsontenorio/lighthouse-dashboard": { "type": "path", "url": "/local/path/to/lighthouse-dashboard", "options": { "symlink": true } } } ``` Require local package version. ```sh composer require robsontenorio/lighthouse-dashboard @dev ``` Then, create a symlink from package vendor folder to app public assets folder. ```sh ln -s /path/to/app/vendor/robsontenorio/lighthouse-dashboard/public/vendor/lighthouse-dashboard /path/to/app/public/vendor ``` From target app enter to package vendor folder. ```sh cd vendor/robsontenorio/lighthouse-dashboard ``` Install frontend dependencies and start it on dev mode. ```sh yarn dev ``` Now all assets built inside package vendor folder will be symlinked to target app public vendor folder. Then point to http://localhost:3000/lighthouse-dashboard/ ## Reference model

Roadmap

• [ ] Sumary for operations per clients.
• [ ] UI navigation with anchor href when clicks on type return.
• [ ] Add option to guard dashboard.
• [ ] Add option for retention period.

Credits

Developed by Robson Tenório and contributors.

This work is highly inspired on Apollo Studio and powered by:

• Laravel.
• Lighthouse GraphQL.
• InertiaJS.
• Vuetify.