Refactor and rename for consistency

Author: marickvantuil

README.md

@@ -122,15 +122,16 @@ Also, the dashboard has not been tested with high throughput queues.
 
 To make use of it, enable it through the `.env` file:
 
-  ```
-  CLOUD_TASKS_MONITOR_ENABLED=true
-  CLOUD_TASKS_MONITOR_ENABLED=MySecretLoginPasswordPleaseChangeThis
+  ```dotenv
+  STACKKIT_CLOUD_TASKS_DASHBOARD_ENABLED=true
+  STACKKIT_CLOUD_TASKS_DASHBOARD_PASSWORD=MySecretLoginPasswordPleaseChangeThis
   ```
 
-Then publish its assets:
+Then publish its assets and migrations:
 
-  ```
+  ```php
   php artisan vendor:publish --tag=cloud-tasks
+  php artisan migrate
   ```
 </details>
 <details>
@@ -140,15 +141,13 @@ Then publish its assets:
 Set the `GOOGLE_APPLICATION_CREDENTIALS` environment variable with a path to the credentials file.
 
 More info: https://cloud.google.com/docs/authentication/production
-</details>
-<details>
-  <summary>Service Account Roles</summary>
 
 If you're not using your master service account (which has all abilities), you must add the following roles to make it works:
 1. App Engine Viewer
 2. Cloud Tasks Enqueuer
 3. Cloud Tasks Viewer
-4. Service Account User
+4. Cloud Tasks Task Deleter
+5. Service Account User
 </details>
 <details>
   <summary>Configuring the queue</summary>

config/cloud-tasks.php

@@ -3,8 +3,8 @@
 declare(strict_types=1);
 
 return [
-    'monitor' => [
-        'enabled' => env('CLOUD_TASKS_MONITOR_ENABLED', false),
-        'password' => env('CLOUD_TASKS_MONITOR_PASSWORD', '$2a$12$q3pRT5jjjjPlTSaGhoy.gupULnK.5lQEiquK5RVaWbGw9nYRy7gwi') // MyPassword1!
+    'dashboard' => [
+        'enabled' => env('STACKKIT_CLOUD_TASKS_DASHBOARD_ENABLED', false),
+        'password' => env('STACKKIT_CLOUD_TASKS_DASHBOARD_PASSWORD', 'MyPassword1!')
     ],
 ];

phpunit.xml

@@ -13,7 +13,7 @@
             <file>./tests/ConfigTest.php</file>
             <file>./tests/TaskHandlerTest.php</file>
             <file>./tests/CloudTasksApiTest.php</file>
-            <file>./tests/CloudTasksMonitoringTest.php</file>
+            <file>./tests/CloudTasksDashboardTest.php</file>
         </testsuite>
     </testsuites>
     <php>

src/CloudTasks.php

@@ -32,22 +32,22 @@ public static function check($request)
     }
 
     /**
-     * Determine if the monitor is enabled.
+     * Determine if the dashboard is enabled.
      *
      * @return bool
      */
-    public static function monitorEnabled(): bool
+    public static function dashboardEnabled(): bool
     {
-        return config('cloud-tasks.monitor.enabled') === true;
+        return config('cloud-tasks.dashboard.enabled') === true;
     }
 
     /**
-     * Determine if the monitor is disabled.
+     * Determine if the dashboard is disabled.
      *
      * @return bool
      */
-    public static function monitorDisabled(): bool
+    public static function dashboardDisabled(): bool
     {
-        return self::monitorEnabled() === false;
+        return self::dashboardEnabled() === false;
     }
 }

src/CloudTasksApiController.php

@@ -7,21 +7,20 @@
 use Illuminate\Support\Carbon;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\DB;
-use Illuminate\Support\Facades\Hash;
 use Stackkit\LaravelGoogleCloudTasksQueue\Entities\StatRow;
 use const STR_PAD_LEFT;
 
 class CloudTasksApiController
 {
     public function login(): ?string
     {
-        $password = config('cloud-tasks.monitor.password');
+        $password = config('cloud-tasks.dashboard.password');
 
         if (!is_string($password)) {
             return null;
         }
 
-        $validPassword = Hash::check(request('password'), $password);
+        $validPassword = hash_equals($password, request('password'));
 
         if (!$validPassword) {
             return null;
@@ -35,7 +34,7 @@ public function dashboard(): array
         $dbDriver = config('database.connections.' . config('database.default') . '.driver');
 
         if (!in_array($dbDriver, ['mysql', 'pgsql'])) {
-            throw new Exception('Unsupported database driver for Cloud Tasks monitoring.');
+            throw new Exception('Unsupported database driver for Cloud Tasks dashboard.');
         }
 
         $groupBy = [

src/CloudTasksServiceProvider.php

@@ -24,7 +24,7 @@ public function boot(QueueManager $queue, Router $router): void
         $this->registerAssets();
         $this->registerMigrations();
         $this->registerRoutes($router);
-        $this->registerMonitoring();
+        $this->registerDashboard();
     }
 
     private function registerClient(): void
@@ -55,7 +55,7 @@ private function registerConfig(): void
 
     private function registerViews(): void
     {
-        if (CloudTasks::monitorDisabled()) {
+        if (CloudTasks::dashboardDisabled()) {
             // Larastan needs this view registered to check the service provider correctly.
             // return;
         }
@@ -65,7 +65,7 @@ private function registerViews(): void
 
     private function registerAssets(): void
     {
-        if (CloudTasks::monitorDisabled()) {
+        if (CloudTasks::dashboardDisabled()) {
             return;
         }
 
@@ -76,7 +76,7 @@ private function registerAssets(): void
 
     private function registerMigrations(): void
     {
-        if (CloudTasks::monitorDisabled()) {
+        if (CloudTasks::dashboardDisabled()) {
             return;
         }
 
@@ -89,7 +89,7 @@ private function registerRoutes(Router $router): void
     {
         $router->post('handle-task', [TaskHandler::class, 'handle'])->name('cloud-tasks.handle-task');
 
-        if (config('cloud-tasks.monitor.enabled') === false) {
+        if (CloudTasks::dashboardDisabled()) {
             return;
         }
 
@@ -116,14 +116,14 @@ private function registerRoutes(Router $router): void
         });
     }
 
-    private function registerMonitoring(): void
+    private function registerDashboard(): void
     {
         app('events')->listen(TaskCreated::class, function (TaskCreated $event) {
-            if (CloudTasks::monitorDisabled()) {
+            if (CloudTasks::dashboardDisabled()) {
                 return;
             }
 
-            MonitoringService::make()->addToMonitor($event->queue, $event->task);
+            DashboardService::make()->add($event->queue, $event->task);
         });
 
         app('events')->listen(JobFailed::class, function (JobFailed $event) {
@@ -140,39 +140,39 @@ private function registerMonitoring(): void
         });
 
         app('events')->listen(JobProcessing::class, function (JobProcessing $event) {
-            if (!CloudTasks::monitorEnabled()) {
+            if (!CloudTasks::dashboardEnabled()) {
                 return;
             }
 
             if ($event->job instanceof CloudTasksJob) {
-                MonitoringService::make()->markAsRunning($event->job->uuid());
+                DashboardService::make()->markAsRunning($event->job->uuid());
             }
         });
 
         app('events')->listen(JobProcessed::class, function (JobProcessed $event) {
-            if (!CloudTasks::monitorEnabled()) {
+            if (!CloudTasks::dashboardEnabled()) {
                 return;
             }
 
             if ($event->job instanceof CloudTasksJob) {
-                MonitoringService::make()->markAsSuccessful($event->job->uuid());
+                DashboardService::make()->markAsSuccessful($event->job->uuid());
             }
         });
 
         app('events')->listen(JobExceptionOccurred::class, function (JobExceptionOccurred $event) {
-            if (!CloudTasks::monitorEnabled()) {
+            if (!CloudTasks::dashboardEnabled()) {
                 return;
             }
 
-            MonitoringService::make()->markAsError($event);
+            DashboardService::make()->markAsError($event);
         });
 
         app('events')->listen(JobFailed::class, function ($event) {
-            if (!CloudTasks::monitorEnabled()) {
+            if (!CloudTasks::dashboardEnabled()) {
                 return;
             }
 
-            MonitoringService::make()->markAsFailed($event);
+            DashboardService::make()->markAsFailed($event);
         });
     }
 }

src/MonitoringService.php renamed to src/DashboardService.php

@@ -11,11 +11,11 @@
 use Illuminate\Support\Facades\DB;
 use function Safe\json_decode;
 
-class MonitoringService
+class DashboardService
 {
-    public static function make(): MonitoringService
+    public static function make(): DashboardService
     {
-        return new MonitoringService();
+        return new DashboardService();
     }
 
     private function getTaskBody(Task $task): string
@@ -29,7 +29,7 @@ private function getTaskBody(Task $task): string
         return $httpRequest->getBody();
     }
 
-    public function addToMonitor(string $queue, Task $task): void
+    public function add(string $queue, Task $task): void
     {
         $metadata = new TaskMetadata();
         $metadata->payload = $this->getTaskBody($task);

tests/CloudTasksMonitoringTest.php renamed to tests/CloudTasksDashboardTest.php

@@ -6,15 +6,13 @@
 use Illuminate\Routing\Route;
 use Illuminate\Routing\Router;
 use Illuminate\Support\Carbon;
-use Illuminate\Support\Facades\Schema;
 use Stackkit\LaravelGoogleCloudTasksQueue\CloudTasksApi;
-use Stackkit\LaravelGoogleCloudTasksQueue\CloudTasksServiceProvider;
 use Stackkit\LaravelGoogleCloudTasksQueue\OpenIdVerificator;
 use Stackkit\LaravelGoogleCloudTasksQueue\StackkitCloudTask;
 use Tests\Support\FailingJob;
 use Tests\Support\SimpleJob;
 
-class CloudTasksMonitoringTest extends TestCase
+class CloudTasksDashboardTest extends TestCase
 {
     /**
      * @test
@@ -243,7 +241,7 @@ public function it_returns_info_about_a_specific_task()
     /**
      * @test
      */
-    public function when_a_job_is_dispatched_it_will_be_added_to_the_monitor()
+    public function when_a_job_is_dispatched_it_will_be_added_to_the_dashboard()
     {
         // Arrange
         CloudTasksApi::fake();
@@ -267,11 +265,11 @@ public function when_a_job_is_dispatched_it_will_be_added_to_the_monitor()
     /**
      * @test
      */
-    public function when_monitoring_is_disabled_jobs_will_not_be_added_to_the_monitor()
+    public function when_dashboard_is_disabled_jobs_will_not_be_added_to_the_dashboard()
     {
         // Arrange
         CloudTasksApi::fake();
-        config()->set('cloud-tasks.monitor.enabled', false);
+        config()->set('cloud-tasks.dashboard.enabled', false);
 
         // Act
         $this->dispatch(new SimpleJob());
@@ -308,7 +306,7 @@ public function when_a_job_is_scheduled_it_will_be_added_as_such()
     /**
      * @test
      */
-    public function when_a_job_is_running_it_will_be_updated_in_the_monitor()
+    public function when_a_job_is_running_it_will_be_updated_in_the_dashboard()
     {
         // Arrange
         \Illuminate\Support\Carbon::setTestNow(now());
@@ -334,7 +332,7 @@ public function when_a_job_is_running_it_will_be_updated_in_the_monitor()
     /**
      * @test
      */
-    public function when_a_job_is_successful_it_will_be_updated_in_the_monitor()
+    public function when_a_job_is_successful_it_will_be_updated_in_the_dashboard()
     {
         // Arrange
         \Illuminate\Support\Carbon::setTestNow(now());
@@ -360,7 +358,7 @@ public function when_a_job_is_successful_it_will_be_updated_in_the_monitor()
     /**
      * @test
      */
-    public function when_a_job_errors_it_will_be_updated_in_the_monitor()
+    public function when_a_job_errors_it_will_be_updated_in_the_dashboard()
     {
         // Arrange
         \Illuminate\Support\Carbon::setTestNow(now());
@@ -387,7 +385,7 @@ public function when_a_job_errors_it_will_be_updated_in_the_monitor()
     /**
      * @test
      */
-    public function when_a_job_fails_it_will_be_updated_in_the_monitor()
+    public function when_a_job_fails_it_will_be_updated_in_the_dashboard()
     {
         // Arrange
         \Illuminate\Support\Carbon::setTestNow(now());
@@ -422,7 +420,7 @@ public function when_a_job_fails_it_will_be_updated_in_the_monitor()
     public function test_publish()
     {
         // Arrange
-        config()->set('cloud-tasks.monitor.enabled', true);
+        config()->set('cloud-tasks.dashboard.enabled', true);
 
         // Act & Assert
         $expectedPublishBase = dirname(__DIR__);
@@ -436,7 +434,7 @@ public function test_publish()
     /**
      * @test
      */
-    public function when_monitoring_is_enabled_it_adds_the_necessary_routes()
+    public function when_dashboard_is_enabled_it_adds_the_necessary_routes()
     {
         // Act
         $routes = app(Router::class)->getRoutes();
@@ -452,23 +450,23 @@ public function when_monitoring_is_enabled_it_adds_the_necessary_routes()
     /**
      * @test
      */
-    public function when_monitoring_is_enabled_it_adds_the_necessary_migrations()
+    public function when_dashboard_is_enabled_it_adds_the_necessary_migrations()
     {
         $this->assertTrue(in_array(dirname(__DIR__) . '/src/../migrations', app('migrator')->paths()));
     }
 
     /**
      * @test
      */
-    public function when_monitoring_is_disabled_it_adds_the_necessary_migrations()
+    public function when_dashboard_is_disabled_it_adds_the_necessary_migrations()
     {
         $this->assertEmpty(app('migrator')->paths());
     }
 
     /**
      * @test
      */
-    public function when_monitoring_is_disabled_it_does_not_add_the_monitor_routes()
+    public function when_dashboard_is_disabled_it_does_not_add_the_dashboard_routes()
     {
         // Act
         $routes = app(Router::class)->getRoutes();
@@ -484,7 +482,7 @@ public function when_monitoring_is_disabled_it_does_not_add_the_monitor_routes()
     /**
      * @test
      */
-    public function monitoring_is_password_protected()
+    public function dashboard_is_password_protected()
     {
         // Arrange
         $this->defaultHeaders['Authorization'] = '';
@@ -533,7 +531,7 @@ public function there_is_a_login_endpoint()
     {
         // Arrange
         Carbon::setTestNow($now = now());
-        config()->set('cloud-tasks.monitor.password', bcrypt('test123'));
+        config()->set('cloud-tasks.dashboard.password', 'test123');
 
         // Act
         $invalidPassword = $this->postJson('/cloud-tasks-api/login', ['password' => 'hey']);