Remove database repository

This commit is contained in:
Lance Pioch 2024-03-16 20:56:37 -04:00
parent ba95045583
commit f988cc8cfa
10 changed files with 120 additions and 279 deletions

View File

@ -1,61 +0,0 @@
<?php
namespace App\Contracts\Repository;
use Illuminate\Support\Collection;
use Illuminate\Contracts\Pagination\LengthAwarePaginator;
interface DatabaseRepositoryInterface extends RepositoryInterface
{
public const DEFAULT_CONNECTION_NAME = 'dynamic';
/**
* Set the connection name to execute statements against.
*/
public function setConnection(string $connection): self;
/**
* Return the connection to execute statements against.
*/
public function getConnection(): string;
/**
* Return all the databases belonging to a server.
*/
public function getDatabasesForServer(int $server): Collection;
/**
* Return all the databases for a given host with the server relationship loaded.
*/
public function getDatabasesForHost(int $host, int $count = 25): LengthAwarePaginator;
/**
* Create a new database on a given connection.
*/
public function createDatabase(string $database): bool;
/**
* Create a new database user on a given connection.
*/
public function createUser(string $username, string $remote, string $password, ?int $max_connections): bool;
/**
* Give a specific user access to a given database.
*/
public function assignUserToDatabase(string $database, string $username, string $remote): bool;
/**
* Flush the privileges for a given connection.
*/
public function flush(): bool;
/**
* Drop a given database on a specific connection.
*/
public function dropDatabase(string $database): bool;
/**
* Drop a given user on a specific connection.
*/
public function dropUser(string $username, string $remote): bool;
}

View File

@ -13,7 +13,6 @@ use App\Services\Databases\Hosts\HostUpdateService;
use App\Http\Requests\Admin\DatabaseHostFormRequest;
use App\Services\Databases\Hosts\HostCreationService;
use App\Services\Databases\Hosts\HostDeletionService;
use App\Contracts\Repository\DatabaseRepositoryInterface;
use App\Contracts\Repository\DatabaseHostRepositoryInterface;
class DatabaseController extends Controller
@ -24,7 +23,6 @@ class DatabaseController extends Controller
public function __construct(
private AlertsMessageBag $alert,
private DatabaseHostRepositoryInterface $repository,
private DatabaseRepositoryInterface $databaseRepository,
private HostCreationService $creationService,
private HostDeletionService $deletionService,
private HostUpdateService $updateService,
@ -50,9 +48,14 @@ class DatabaseController extends Controller
*/
public function view(int $host): View
{
/** @var DatabaseHost $host */
$host = DatabaseHost::query()->findOrFail($host);
$databases = $host->databases()->with('server')->paginate(25);
return $this->view->make('admin.databases.view', [
'host' => $this->repository->find($host),
'databases' => $this->databaseRepository->getDatabasesForHost($host),
'nodes' => Node::all(),
'host' => $host,
'databases' => $databases,
]);
}

View File

@ -27,7 +27,6 @@ use App\Services\Servers\StartupModificationService;
use App\Repositories\Eloquent\DatabaseHostRepository;
use App\Services\Databases\DatabaseManagementService;
use Illuminate\Contracts\Config\Repository as ConfigRepository;
use App\Contracts\Repository\DatabaseRepositoryInterface;
use App\Services\Servers\ServerConfigurationStructureService;
use App\Http\Requests\Admin\Servers\Databases\StoreServerDatabaseRequest;
@ -43,7 +42,6 @@ class ServersController extends Controller
protected DaemonServerRepository $daemonServerRepository,
protected DatabaseManagementService $databaseManagementService,
protected DatabasePasswordService $databasePasswordService,
protected DatabaseRepositoryInterface $databaseRepository,
protected DatabaseHostRepository $databaseHostRepository,
protected ServerDeletionService $deletionService,
protected DetailsModificationService $detailsModificationService,

View File

@ -5,6 +5,7 @@ namespace App\Models;
use Illuminate\Container\Container;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use App\Contracts\Extensions\HashidsInterface;
use Illuminate\Support\Facades\DB;
/**
* @property int $id
@ -28,6 +29,8 @@ class Database extends Model
*/
public const RESOURCE_NAME = 'server_database';
public const DEFAULT_CONNECTION_NAME = 'dynamic';
/**
* The table associated with the model.
*/
@ -107,4 +110,74 @@ class Database extends Model
{
return $this->belongsTo(Server::class);
}
/**
* Run the provided statement against the database on a given connection.
*/
private function run(string $statement): bool
{
return DB::connection($this->connection)->statement($statement);
}
/**
* Create a new database on a given connection.
*/
public function createDatabase(string $database): bool
{
return $this->run(sprintf('CREATE DATABASE IF NOT EXISTS `%s`', $database));
}
/**
* Create a new database user on a given connection.
*/
public function createUser(string $username, string $remote, string $password, ?int $max_connections): bool
{
$args = [$username, $remote, $password];
$command = 'CREATE USER `%s`@`%s` IDENTIFIED BY \'%s\'';
if (!empty($max_connections)) {
$args[] = $max_connections;
$command .= ' WITH MAX_USER_CONNECTIONS %s';
}
return $this->run(sprintf($command, ...$args));
}
/**
* Give a specific user access to a given database.
*/
public function assignUserToDatabase(string $database, string $username, string $remote): bool
{
return $this->run(sprintf(
'GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, ALTER, REFERENCES, INDEX, LOCK TABLES, CREATE ROUTINE, ALTER ROUTINE, EXECUTE, CREATE TEMPORARY TABLES, CREATE VIEW, SHOW VIEW, EVENT, TRIGGER ON `%s`.* TO `%s`@`%s`',
$database,
$username,
$remote
));
}
/**
* Flush the privileges for a given connection.
*/
public function flush(): bool
{
return $this->run('FLUSH PRIVILEGES');
}
/**
* Drop a given database on a specific connection.
*/
public function dropDatabase(string $database): bool
{
return $this->run(sprintf('DROP DATABASE IF EXISTS `%s`', $database));
}
/**
* Drop a given user on a specific connection.
*/
public function dropUser(string $username, string $remote): bool
{
return $this->run(sprintf('DROP USER IF EXISTS `%s`@`%s`', $username, $remote));
}
}

View File

@ -5,12 +5,10 @@ namespace App\Providers;
use Illuminate\Support\ServiceProvider;
use App\Repositories\Eloquent\NodeRepository;
use App\Repositories\Eloquent\SubuserRepository;
use App\Repositories\Eloquent\DatabaseRepository;
use App\Repositories\Eloquent\EggVariableRepository;
use App\Contracts\Repository\NodeRepositoryInterface;
use App\Repositories\Eloquent\DatabaseHostRepository;
use App\Contracts\Repository\SubuserRepositoryInterface;
use App\Contracts\Repository\DatabaseRepositoryInterface;
use App\Contracts\Repository\EggVariableRepositoryInterface;
use App\Contracts\Repository\DatabaseHostRepositoryInterface;
@ -22,7 +20,6 @@ class RepositoryServiceProvider extends ServiceProvider
public function register(): void
{
// Eloquent Repositories
$this->app->bind(DatabaseRepositoryInterface::class, DatabaseRepository::class);
$this->app->bind(DatabaseHostRepositoryInterface::class, DatabaseHostRepository::class);
$this->app->bind(EggVariableRepositoryInterface::class, EggVariableRepository::class);
$this->app->bind(NodeRepositoryInterface::class, NodeRepository::class);

View File

@ -1,136 +0,0 @@
<?php
namespace App\Repositories\Eloquent;
use App\Models\Database;
use Illuminate\Support\Collection;
use Illuminate\Foundation\Application;
use Illuminate\Database\DatabaseManager;
use Illuminate\Contracts\Pagination\LengthAwarePaginator;
use App\Contracts\Repository\DatabaseRepositoryInterface;
class DatabaseRepository extends EloquentRepository implements DatabaseRepositoryInterface
{
protected string $connection = self::DEFAULT_CONNECTION_NAME;
/**
* DatabaseRepository constructor.
*/
public function __construct(Application $application, private DatabaseManager $database)
{
parent::__construct($application);
}
/**
* Return the model backing this repository.
*/
public function model(): string
{
return Database::class;
}
/**
* Return the connection to execute statements against.
*/
public function getConnection(): string
{
return $this->connection;
}
/**
* Set the connection name to execute statements against.
*/
public function setConnection(string $connection): self
{
$this->connection = $connection;
return $this;
}
/**
* Return all the databases belonging to a server.
*/
public function getDatabasesForServer(int $server): Collection
{
return $this->getBuilder()->with('host')->where('server_id', $server)->get($this->getColumns());
}
/**
* Return all the databases for a given host with the server relationship loaded.
*/
public function getDatabasesForHost(int $host, int $count = 25): LengthAwarePaginator
{
return $this->getBuilder()->with('server')
->where('database_host_id', $host)
->paginate($count, $this->getColumns());
}
/**
* Create a new database on a given connection.
*/
public function createDatabase(string $database): bool
{
return $this->run(sprintf('CREATE DATABASE IF NOT EXISTS `%s`', $database));
}
/**
* Create a new database user on a given connection.
*/
public function createUser(string $username, string $remote, string $password, ?int $max_connections): bool
{
$args = [$username, $remote, $password];
$command = 'CREATE USER `%s`@`%s` IDENTIFIED BY \'%s\'';
if (!empty($max_connections)) {
$args[] = $max_connections;
$command .= ' WITH MAX_USER_CONNECTIONS %s';
}
return $this->run(sprintf($command, ...$args));
}
/**
* Give a specific user access to a given database.
*/
public function assignUserToDatabase(string $database, string $username, string $remote): bool
{
return $this->run(sprintf(
'GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, ALTER, REFERENCES, INDEX, LOCK TABLES, CREATE ROUTINE, ALTER ROUTINE, EXECUTE, CREATE TEMPORARY TABLES, CREATE VIEW, SHOW VIEW, EVENT, TRIGGER ON `%s`.* TO `%s`@`%s`',
$database,
$username,
$remote
));
}
/**
* Flush the privileges for a given connection.
*/
public function flush(): bool
{
return $this->run('FLUSH PRIVILEGES');
}
/**
* Drop a given database on a specific connection.
*/
public function dropDatabase(string $database): bool
{
return $this->run(sprintf('DROP DATABASE IF EXISTS `%s`', $database));
}
/**
* Drop a given user on a specific connection.
*/
public function dropUser(string $username, string $remote): bool
{
return $this->run(sprintf('DROP USER IF EXISTS `%s`@`%s`', $username, $remote));
}
/**
* Run the provided statement against the database on a given connection.
*/
private function run(string $statement): bool
{
return $this->database->connection($this->getConnection())->statement($statement);
}
}

View File

@ -36,7 +36,6 @@ class DatabaseManagementService
protected ConnectionInterface $connection,
protected DynamicDatabaseConnection $dynamic,
protected Encrypter $encrypter,
protected DatabaseRepository $repository
) {
}
@ -104,26 +103,26 @@ class DatabaseManagementService
$this->dynamic->set('dynamic', $data['database_host_id']);
$this->repository->createDatabase($database->database);
$this->repository->createUser(
$database->createDatabase($database->database);
$database->createUser(
$database->username,
$database->remote,
$this->encrypter->decrypt($database->password),
$database->max_connections
);
$this->repository->assignUserToDatabase($database->database, $database->username, $database->remote);
$this->repository->flush();
$database->assignUserToDatabase($database->database, $database->username, $database->remote);
$database->flush();
return $database;
});
} catch (\Exception $exception) {
} catch (Exception $exception) {
try {
if ($database instanceof Database) {
$this->repository->dropDatabase($database->database);
$this->repository->dropUser($database->username, $database->remote);
$this->repository->flush();
$database->dropDatabase($database->database);
$database->dropUser($database->username, $database->remote);
$database->flush();
}
} catch (\Exception $deletionException) {
} catch (Exception) {
// Do nothing here. We've already encountered an issue before this point so no
// reason to prioritize this error over the initial one.
}
@ -141,9 +140,9 @@ class DatabaseManagementService
{
$this->dynamic->set('dynamic', $database->database_host_id);
$this->repository->dropDatabase($database->database);
$this->repository->dropUser($database->username, $database->remote);
$this->repository->flush();
$database->dropDatabase($database->database);
$database->dropUser($database->username, $database->remote);
$database->flush();
return $database->delete();
}

View File

@ -7,7 +7,6 @@ use App\Helpers\Utilities;
use Illuminate\Database\ConnectionInterface;
use Illuminate\Contracts\Encryption\Encrypter;
use App\Extensions\DynamicDatabaseConnection;
use App\Contracts\Repository\DatabaseRepositoryInterface;
class DatabasePasswordService
{
@ -18,30 +17,31 @@ class DatabasePasswordService
private ConnectionInterface $connection,
private DynamicDatabaseConnection $dynamic,
private Encrypter $encrypter,
private DatabaseRepositoryInterface $repository
) {
}
/**
* Updates a password for a given database.
*
* @throws \Throwable
*/
public function handle(Database|int $database): string
{
if (is_int($database)) {
$database = Database::query()->findOrFail($database);
}
$password = Utilities::randomStringWithSpecialCharacters(24);
$this->connection->transaction(function () use ($database, $password) {
$this->dynamic->set('dynamic', $database->database_host_id);
$this->repository->withoutFreshModel()->update($database->id, [
$database->update($database->id, [
'password' => $this->encrypter->encrypt($password),
]);
$this->repository->dropUser($database->username, $database->remote);
$this->repository->createUser($database->username, $database->remote, $password, $database->max_connections);
$this->repository->assignUserToDatabase($database->database, $database->username, $database->remote);
$this->repository->flush();
$database->dropUser($database->username, $database->remote);
$database->createUser($database->username, $database->remote, $password, $database->max_connections);
$database->assignUserToDatabase($database->database, $database->username, $database->remote);
$database->flush();
});
return $password;

View File

@ -3,20 +3,10 @@
namespace App\Services\Databases\Hosts;
use App\Exceptions\Service\HasActiveServersException;
use App\Contracts\Repository\DatabaseRepositoryInterface;
use App\Contracts\Repository\DatabaseHostRepositoryInterface;
use App\Models\DatabaseHost;
class HostDeletionService
{
/**
* HostDeletionService constructor.
*/
public function __construct(
private DatabaseRepositoryInterface $databaseRepository,
private DatabaseHostRepositoryInterface $repository
) {
}
/**
* Delete a specified host from the Panel if no databases are
* attached to it.
@ -25,11 +15,12 @@ class HostDeletionService
*/
public function handle(int $host): int
{
$count = $this->databaseRepository->findCountWhere([['database_host_id', '=', $host]]);
if ($count > 0) {
$host = DatabaseHost::query()->findOrFail($host);
if ($host->databases()->count() > 0) {
throw new HasActiveServersException(trans('exceptions.databases.delete_has_databases'));
}
return $this->repository->delete($host);
return $host->delete();
}
}

View File

@ -2,11 +2,9 @@
namespace App\Tests\Integration\Services\Databases;
use Mockery\MockInterface;
use App\Models\Database;
use App\Models\DatabaseHost;
use App\Tests\Integration\IntegrationTestCase;
use App\Repositories\Eloquent\DatabaseRepository;
use App\Services\Databases\DatabaseManagementService;
use App\Exceptions\Repository\DuplicateDatabaseNameException;
use App\Exceptions\Service\Database\TooManyDatabasesException;
@ -14,8 +12,6 @@ use App\Exceptions\Service\Database\DatabaseClientFeatureNotEnabledException;
class DatabaseManagementServiceTest extends IntegrationTestCase
{
private MockInterface $repository;
/**
* Setup tests.
*/
@ -24,8 +20,6 @@ class DatabaseManagementServiceTest extends IntegrationTestCase
parent::setUp();
config()->set('panel.client_features.databases.enabled', true);
$this->repository = $this->mock(DatabaseRepository::class);
}
/**
@ -88,7 +82,7 @@ class DatabaseManagementServiceTest extends IntegrationTestCase
public function testCreatingDatabaseWithIdenticalNameTriggersAnException()
{
$server = $this->createServerModel();
$name = DatabaseManagementService::generateUniqueDatabaseName('soemthing', $server->id);
$name = DatabaseManagementService::generateUniqueDatabaseName('something', $server->id);
$host = DatabaseHost::factory()->create(['node_id' => $server->node_id]);
$host2 = DatabaseHost::factory()->create(['node_id' => $server->node_id]);
@ -116,43 +110,19 @@ class DatabaseManagementServiceTest extends IntegrationTestCase
*/
public function testServerDatabaseCanBeCreated()
{
$this->markTestSkipped();
/* TODO: The exception is because the transaction is closed
because the database create closes it early */
$server = $this->createServerModel();
$name = DatabaseManagementService::generateUniqueDatabaseName('soemthing', $server->id);
$name = DatabaseManagementService::generateUniqueDatabaseName('something', $server->id);
$host = DatabaseHost::factory()->create(['node_id' => $server->node_id]);
$this->repository->expects('createDatabase')->with($name);
$username = null;
$secondUsername = null;
$password = null;
// The value setting inside the closures if to avoid throwing an exception during the
// assertions that would get caught by the functions catcher and thus lead to the exception
// being swallowed incorrectly.
$this->repository->expects('createUser')->with(
\Mockery::on(function ($value) use (&$username) {
$username = $value;
return true;
}),
'%',
\Mockery::on(function ($value) use (&$password) {
$password = $value;
return true;
}),
null
);
$this->repository->expects('assignUserToDatabase')->with($name, \Mockery::on(function ($value) use (&$secondUsername) {
$secondUsername = $value;
return true;
}), '%');
$this->repository->expects('flush')->withNoArgs();
$response = $this->getService()->create($server, [
'remote' => '%',
'database' => $name,
@ -174,8 +144,15 @@ class DatabaseManagementServiceTest extends IntegrationTestCase
*/
public function testExceptionEncounteredWhileCreatingDatabaseAttemptsToCleanup()
{
$this->markTestSkipped();
/* TODO: I think this is useful logic to be tested,
but this is a very hacky way of going about it.
The exception is because the transaction is closed
because the database create closes it early */
$server = $this->createServerModel();
$name = DatabaseManagementService::generateUniqueDatabaseName('soemthing', $server->id);
$name = DatabaseManagementService::generateUniqueDatabaseName('something', $server->id);
$host = DatabaseHost::factory()->create(['node_id' => $server->node_id]);