Merge pull request #196 from buggregator/feature/cleanup-command

New Cleanup Commands for Database and Storage Management

Makefile

@@ -1,3 +1,5 @@
+# ====== Docker ========
+
 build:
 	if [ ! -d "runtime" ]; then \
 		mkdir runtime/configs -p; \
@@ -49,6 +51,27 @@ pull-latest:
 build-server:
 	docker compose build buggregator-server --no-cache;
 
+# ====== Database ========
+
+recreate-db:
+	rm -rf .db;
+	mkdir .db;
+	chmod 0777 -R .db;
+	bin/dolt --data-dir=.db sql -q "create database buggregator;";
+
+# ======= Runtime ========
+
+cleanup-attachments:
+	rm -rf runtime/attachments/*;
+
+cleanup-cache:
+	rm -rf runtime/cache;
+
+cleanup-snapshots:
+	rm -rf runtime/snapshots;
+
+cleanup: cleanup-attachments cleanup-cache cleanup-snapshots;
+
 # =========================
 
 bash:

app/src/Application/Bootloader/PersistenceBootloader.php

@@ -4,7 +4,9 @@
 
 namespace App\Application\Bootloader;
 
+use App\Application\Database\CleanerInterface;
 use App\Application\Persistence\DriverEnum;
+use App\Integration\CycleOrm\DatabaseCleaner;
 use App\Interfaces\Console\RegisterModulesCommand;
 use Spiral\Boot\Bootloader\Bootloader;
 use Spiral\Console\Bootloader\ConsoleBootloader;
@@ -26,6 +28,13 @@ public function defineDependencies(): array
         ];
     }
 
+    public function defineSingletons(): array
+    {
+        return [
+            CleanerInterface::class => DatabaseCleaner::class,
+        ];
+    }
+
     public function init(ConsoleBootloader $console, DriverEnum $driver): void
     {
         if ($driver === DriverEnum::Database) {

app/src/Application/Database/CleanerInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Application\Database;
+
+interface CleanerInterface
+{
+    public function clean(?string $database = null): \Generator;
+}

app/src/Integration/CycleOrm/DatabaseCleaner.php

@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Integration\CycleOrm;
+
+use App\Application\Database\CleanerInterface;
+use Cycle\Database\DatabaseProviderInterface;
+use Cycle\Migrations\Config\MigrationConfig;
+
+final readonly class DatabaseCleaner implements CleanerInterface
+{
+    public function __construct(
+        private MigrationConfig $config,
+        private DatabaseProviderInterface $provider,
+    ) {}
+
+    public function clean(?string $database = null): \Generator
+    {
+        $db = $this->provider->database($database);
+
+
+        foreach ($db->getTables() as $table) {
+            $this->disableForeignKeyConstraints($database);
+
+            // Skip the table that stores the list of executed migrations
+            if ($table->getName() === $this->config->getTable()) {
+                continue;
+            }
+
+            /**
+             * @psalm-suppress UndefinedInterfaceMethod
+             */
+            $db->getDriver()->getSchemaHandler()->eraseTable($db->table($table->getFullName())->getSchema());
+            yield $table->getName();
+
+            $this->enableForeignKeyConstraints($database);
+        }
+    }
+
+    public function disableForeignKeyConstraints(?string $database = null): void
+    {
+        $db = $this->provider->database($database);
+
+        /**
+         * @psalm-suppress UndefinedInterfaceMethod
+         */
+        $db->getDriver()->getSchemaHandler()->disableForeignKeyConstraints();
+    }
+
+    public function enableForeignKeyConstraints(?string $database = null): void
+    {
+        $db = $this->provider->database($database);
+
+        /**
+         * @psalm-suppress UndefinedInterfaceMethod
+         */
+        $db->getDriver()->getSchemaHandler()->enableForeignKeyConstraints();
+    }
+}

app/src/Interfaces/Console/CleanupCommand.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Interfaces\Console;
+
+use App\Application\Database\CleanerInterface;
+use Spiral\Boot\DirectoriesInterface;
+use Spiral\Console\Attribute\AsCommand;
+use Spiral\Console\Command;
+use Spiral\Storage\Config\StorageConfig;
+use Spiral\Storage\StorageInterface;
+
+#[AsCommand(
+    name: 'cleanup',
+    description: 'Clean database and storage data',
+)]
+final class CleanupCommand extends Command
+{
+    public function __invoke(
+        CleanerInterface $cleaner,
+        StorageInterface $storage,
+        DirectoriesInterface $dirs,
+        StorageConfig $config,
+    ): void {
+        $this->info('Cleaning database...');
+
+        foreach ($cleaner->clean() as $table) {
+            $this->writeln(\sprintf('- Table %s cleaned', $table));
+        }
+
+        $this->newLine();
+
+        $this->info('Cleaning storage...');
+        foreach ($config->getAdapters() as $bucket => $adapter) {
+            $adapter->deleteDirectory('*');
+            $this->writeln(\sprintf('- Bucket %s cleaned', $bucket));
+        }
+    }
+}