Merge pull request #636 from acelaya-forks/feature/postgres-schema-support

Feature/postgres schema support
2024-11-22 08:56:42 -06:00 · 2020-01-29 11:02:23 +01:00 · 2020-01-29 11:02:23 +01:00 · e18187f04e
commit e18187f04e
parent a737eed5c5 bd2f488e2c
10 changed files with 185 additions and 163 deletions
--- a/composer.json
+++ b/composer.json
@ -47,7 +47,7 @@
        "phly/phly-event-dispatcher": "^1.0",
        "predis/predis": "^1.1",
        "pugx/shortid-php": "^0.5",
-        "shlinkio/shlink-common": "^2.6.0",
+        "shlinkio/shlink-common": "^2.7.0",
        "shlinkio/shlink-event-dispatcher": "^1.3",
        "shlinkio/shlink-installer": "^4.0.1",
        "shlinkio/shlink-ip-geolocation": "^1.3.1",
--- a/config/autoload/entity-manager.global.php
+++ b/config/autoload/entity-manager.global.php
@ -9,6 +9,7 @@ return [
    'entity_manager' => [
        'orm' => [
            'proxies_dir' => 'data/proxies',
+            'load_mappings_using_functional_style' => true,
        ],
        'connection' => [
            'user' => '',
--- a/module/Core/config/entities-mappings/Shlinkio.Shlink.Core.Entity.Domain.php
+++ b/module/Core/config/entities-mappings/Shlinkio.Shlink.Core.Entity.Domain.php
@ -6,20 +6,21 @@ namespace Shlinkio\Shlink\Core;

 use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\Mapping\Builder\ClassMetadataBuilder;
-use Doctrine\ORM\Mapping\ClassMetadata; // @codingStandardsIgnoreLine
+use Doctrine\ORM\Mapping\ClassMetadata;

-/** @var $metadata ClassMetadata */ // @codingStandardsIgnoreLine
-$builder = new ClassMetadataBuilder($metadata);
+return static function (ClassMetadata $metadata, array $emConfig): void {
+    $builder = new ClassMetadataBuilder($metadata);

-$builder->setTable('domains');
+    $builder->setTable(determineTableName('domains', $emConfig));

-$builder->createField('id', Types::BIGINT)
-        ->columnName('id')
-        ->makePrimaryKey()
-        ->generatedValue('IDENTITY')
-        ->option('unsigned', true)
-        ->build();
+    $builder->createField('id', Types::BIGINT)
+            ->columnName('id')
+            ->makePrimaryKey()
+            ->generatedValue('IDENTITY')
+            ->option('unsigned', true)
+            ->build();

-$builder->createField('authority', Types::STRING)
-        ->unique()
-        ->build();
+    $builder->createField('authority', Types::STRING)
+            ->unique()
+            ->build();
+};
--- a/module/Core/config/entities-mappings/Shlinkio.Shlink.Core.Entity.ShortUrl.php
+++ b/module/Core/config/entities-mappings/Shlinkio.Shlink.Core.Entity.ShortUrl.php
@ -6,65 +6,66 @@ namespace Shlinkio\Shlink\Core;

 use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\Mapping\Builder\ClassMetadataBuilder;
-use Doctrine\ORM\Mapping\ClassMetadata; // @codingStandardsIgnoreLine
+use Doctrine\ORM\Mapping\ClassMetadata;
 use Shlinkio\Shlink\Common\Doctrine\Type\ChronosDateTimeType;

-/** @var $metadata ClassMetadata */ // @codingStandardsIgnoreLine
-$builder = new ClassMetadataBuilder($metadata);
+return static function (ClassMetadata $metadata, array $emConfig): void {
+    $builder = new ClassMetadataBuilder($metadata);

-$builder->setTable('short_urls')
-        ->setCustomRepositoryClass(Repository\ShortUrlRepository::class);
+    $builder->setTable(determineTableName('short_urls', $emConfig))
+            ->setCustomRepositoryClass(Repository\ShortUrlRepository::class);

-$builder->createField('id', Types::BIGINT)
-        ->columnName('id')
-        ->makePrimaryKey()
-        ->generatedValue('IDENTITY')
-        ->option('unsigned', true)
-        ->build();
+    $builder->createField('id', Types::BIGINT)
+            ->columnName('id')
+            ->makePrimaryKey()
+            ->generatedValue('IDENTITY')
+            ->option('unsigned', true)
+            ->build();

-$builder->createField('longUrl', Types::STRING)
-        ->columnName('original_url')
-        ->length(2048)
-        ->build();
+    $builder->createField('longUrl', Types::STRING)
+            ->columnName('original_url')
+            ->length(2048)
+            ->build();

-$builder->createField('shortCode', Types::STRING)
-        ->columnName('short_code')
-        ->length(255)
-        ->build();
+    $builder->createField('shortCode', Types::STRING)
+            ->columnName('short_code')
+            ->length(255)
+            ->build();

-$builder->createField('dateCreated', ChronosDateTimeType::CHRONOS_DATETIME)
-        ->columnName('date_created')
-        ->build();
+    $builder->createField('dateCreated', ChronosDateTimeType::CHRONOS_DATETIME)
+            ->columnName('date_created')
+            ->build();

-$builder->createField('validSince', ChronosDateTimeType::CHRONOS_DATETIME)
-        ->columnName('valid_since')
-        ->nullable()
-        ->build();
+    $builder->createField('validSince', ChronosDateTimeType::CHRONOS_DATETIME)
+            ->columnName('valid_since')
+            ->nullable()
+            ->build();

-$builder->createField('validUntil', ChronosDateTimeType::CHRONOS_DATETIME)
-        ->columnName('valid_until')
-        ->nullable()
-        ->build();
+    $builder->createField('validUntil', ChronosDateTimeType::CHRONOS_DATETIME)
+            ->columnName('valid_until')
+            ->nullable()
+            ->build();

-$builder->createField('maxVisits', Types::INTEGER)
-        ->columnName('max_visits')
-        ->nullable()
-        ->build();
+    $builder->createField('maxVisits', Types::INTEGER)
+            ->columnName('max_visits')
+            ->nullable()
+            ->build();

-$builder->createOneToMany('visits', Entity\Visit::class)
-        ->mappedBy('shortUrl')
-        ->fetchExtraLazy()
-        ->build();
+    $builder->createOneToMany('visits', Entity\Visit::class)
+            ->mappedBy('shortUrl')
+            ->fetchExtraLazy()
+            ->build();

-$builder->createManyToMany('tags', Entity\Tag::class)
-        ->setJoinTable('short_urls_in_tags')
-        ->addInverseJoinColumn('tag_id', 'id', true, false, 'CASCADE')
-        ->addJoinColumn('short_url_id', 'id', true, false, 'CASCADE')
-        ->build();
+    $builder->createManyToMany('tags', Entity\Tag::class)
+            ->setJoinTable(determineTableName('short_urls_in_tags', $emConfig))
+            ->addInverseJoinColumn('tag_id', 'id', true, false, 'CASCADE')
+            ->addJoinColumn('short_url_id', 'id', true, false, 'CASCADE')
+            ->build();

-$builder->createManyToOne('domain', Entity\Domain::class)
-        ->addJoinColumn('domain_id', 'id', true, false, 'RESTRICT')
-        ->cascadePersist()
-        ->build();
+    $builder->createManyToOne('domain', Entity\Domain::class)
+            ->addJoinColumn('domain_id', 'id', true, false, 'RESTRICT')
+            ->cascadePersist()
+            ->build();

-$builder->addUniqueConstraint(['short_code', 'domain_id'], 'unique_short_code_plus_domain');
+    $builder->addUniqueConstraint(['short_code', 'domain_id'], 'unique_short_code_plus_domain');
+};
--- a/module/Core/config/entities-mappings/Shlinkio.Shlink.Core.Entity.Tag.php
+++ b/module/Core/config/entities-mappings/Shlinkio.Shlink.Core.Entity.Tag.php
@ -6,21 +6,22 @@ namespace Shlinkio\Shlink\Core;

 use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\Mapping\Builder\ClassMetadataBuilder;
-use Doctrine\ORM\Mapping\ClassMetadata; // @codingStandardsIgnoreLine
+use Doctrine\ORM\Mapping\ClassMetadata;

-/** @var $metadata ClassMetadata */ // @codingStandardsIgnoreLine
-$builder = new ClassMetadataBuilder($metadata);
+return static function (ClassMetadata $metadata, array $emConfig): void {
+    $builder = new ClassMetadataBuilder($metadata);

-$builder->setTable('tags')
-        ->setCustomRepositoryClass(Repository\TagRepository::class);
+    $builder->setTable(determineTableName('tags', $emConfig))
+            ->setCustomRepositoryClass(Repository\TagRepository::class);

-$builder->createField('id', Types::BIGINT)
-        ->columnName('id')
-        ->makePrimaryKey()
-        ->generatedValue('IDENTITY')
-        ->option('unsigned', true)
-        ->build();
+    $builder->createField('id', Types::BIGINT)
+            ->columnName('id')
+            ->makePrimaryKey()
+            ->generatedValue('IDENTITY')
+            ->option('unsigned', true)
+            ->build();

-$builder->createField('name', Types::STRING)
-        ->unique()
-        ->build();
+    $builder->createField('name', Types::STRING)
+            ->unique()
+            ->build();
+};
--- a/module/Core/config/entities-mappings/Shlinkio.Shlink.Core.Entity.Visit.php
+++ b/module/Core/config/entities-mappings/Shlinkio.Shlink.Core.Entity.Visit.php
@ -6,49 +6,50 @@ namespace Shlinkio\Shlink\Core;

 use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\Mapping\Builder\ClassMetadataBuilder;
-use Doctrine\ORM\Mapping\ClassMetadata; // @codingStandardsIgnoreLine
+use Doctrine\ORM\Mapping\ClassMetadata;
 use Shlinkio\Shlink\Common\Doctrine\Type\ChronosDateTimeType;
 use Shlinkio\Shlink\Core\Model\Visitor;

-/** @var $metadata ClassMetadata */ // @codingStandardsIgnoreLine
-$builder = new ClassMetadataBuilder($metadata);
+return static function (ClassMetadata $metadata, array $emConfig): void {
+    $builder = new ClassMetadataBuilder($metadata);

-$builder->setTable('visits')
-        ->setCustomRepositoryClass(Repository\VisitRepository::class);
+    $builder->setTable(determineTableName('visits', $emConfig))
+            ->setCustomRepositoryClass(Repository\VisitRepository::class);

-$builder->createField('id', Types::BIGINT)
-        ->columnName('id')
-        ->makePrimaryKey()
-        ->generatedValue('IDENTITY')
-        ->option('unsigned', true)
-        ->build();
+    $builder->createField('id', Types::BIGINT)
+            ->columnName('id')
+            ->makePrimaryKey()
+            ->generatedValue('IDENTITY')
+            ->option('unsigned', true)
+            ->build();

-$builder->createField('referer', Types::STRING)
-        ->nullable()
-        ->length(Visitor::REFERER_MAX_LENGTH)
-        ->build();
+    $builder->createField('referer', Types::STRING)
+            ->nullable()
+            ->length(Visitor::REFERER_MAX_LENGTH)
+            ->build();

-$builder->createField('date', ChronosDateTimeType::CHRONOS_DATETIME)
-        ->columnName('`date`')
-        ->build();
+    $builder->createField('date', ChronosDateTimeType::CHRONOS_DATETIME)
+            ->columnName('`date`')
+            ->build();

-$builder->createField('remoteAddr', Types::STRING)
-        ->columnName('remote_addr')
-        ->length(Visitor::REMOTE_ADDRESS_MAX_LENGTH)
-        ->nullable()
-        ->build();
+    $builder->createField('remoteAddr', Types::STRING)
+            ->columnName('remote_addr')
+            ->length(Visitor::REMOTE_ADDRESS_MAX_LENGTH)
+            ->nullable()
+            ->build();

-$builder->createField('userAgent', Types::STRING)
-        ->columnName('user_agent')
-        ->length(Visitor::USER_AGENT_MAX_LENGTH)
-        ->nullable()
-        ->build();
+    $builder->createField('userAgent', Types::STRING)
+            ->columnName('user_agent')
+            ->length(Visitor::USER_AGENT_MAX_LENGTH)
+            ->nullable()
+            ->build();

-$builder->createManyToOne('shortUrl', Entity\ShortUrl::class)
-        ->addJoinColumn('short_url_id', 'id', false, false, 'CASCADE')
-        ->build();
+    $builder->createManyToOne('shortUrl', Entity\ShortUrl::class)
+            ->addJoinColumn('short_url_id', 'id', false, false, 'CASCADE')
+            ->build();

-$builder->createManyToOne('visitLocation', Entity\VisitLocation::class)
-        ->addJoinColumn('visit_location_id', 'id', true, false, 'Set NULL')
-        ->cascadePersist()
-        ->build();
+    $builder->createManyToOne('visitLocation', Entity\VisitLocation::class)
+            ->addJoinColumn('visit_location_id', 'id', true, false, 'Set NULL')
+            ->cascadePersist()
+            ->build();
+};
--- a/module/Core/config/entities-mappings/Shlinkio.Shlink.Core.Entity.VisitLocation.php
+++ b/module/Core/config/entities-mappings/Shlinkio.Shlink.Core.Entity.VisitLocation.php
@ -6,41 +6,42 @@ namespace Shlinkio\Shlink\Core;

 use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\Mapping\Builder\ClassMetadataBuilder;
-use Doctrine\ORM\Mapping\ClassMetadata; // @codingStandardsIgnoreLine
+use Doctrine\ORM\Mapping\ClassMetadata;

-/** @var $metadata ClassMetadata */ // @codingStandardsIgnoreLine
-$builder = new ClassMetadataBuilder($metadata);
+return static function (ClassMetadata $metadata, array $emConfig): void {
+    $builder = new ClassMetadataBuilder($metadata);

-$builder->setTable('visit_locations');
+    $builder->setTable(determineTableName('visit_locations', $emConfig));

-$builder->createField('id', Types::BIGINT)
-        ->columnName('id')
-        ->makePrimaryKey()
-        ->generatedValue('IDENTITY')
-        ->option('unsigned', true)
-        ->build();
-
-$columns = [
-    'country_code' => 'countryCode',
-    'country_name' => 'countryName',
-    'region_name' => 'regionName',
-    'city_name' => 'cityName',
-    'timezone' => 'timezone',
-];
-
-foreach ($columns as $columnName => $fieldName) {
-    $builder->createField($fieldName, Types::STRING)
-            ->columnName($columnName)
-            ->nullable()
+    $builder->createField('id', Types::BIGINT)
+            ->columnName('id')
+            ->makePrimaryKey()
+            ->generatedValue('IDENTITY')
+            ->option('unsigned', true)
            ->build();
-}

-$builder->createField('latitude', Types::FLOAT)
-        ->columnName('lat')
-        ->nullable(false)
-        ->build();
+    $columns = [
+        'country_code' => 'countryCode',
+        'country_name' => 'countryName',
+        'region_name' => 'regionName',
+        'city_name' => 'cityName',
+        'timezone' => 'timezone',
+    ];

-$builder->createField('longitude', Types::FLOAT)
-        ->columnName('lon')
-        ->nullable(false)
-        ->build();
+    foreach ($columns as $columnName => $fieldName) {
+        $builder->createField($fieldName, Types::STRING)
+                ->columnName($columnName)
+                ->nullable()
+                ->build();
+    }
+
+    $builder->createField('latitude', Types::FLOAT)
+            ->columnName('lat')
+            ->nullable(false)
+            ->build();
+
+    $builder->createField('longitude', Types::FLOAT)
+            ->columnName('lon')
+            ->nullable(false)
+            ->build();
+};
--- a/module/Core/functions/functions.php
+++ b/module/Core/functions/functions.php
@ -8,6 +8,8 @@ use Cake\Chronos\Chronos;
 use DateTimeInterface;
 use PUGX\Shortid\Factory as ShortIdFactory;

+use function sprintf;
+
 function generateRandomShortCode(int $length = 5): string
 {
    static $shortIdFactory;
@ -39,3 +41,15 @@ function parseDateField($date): ?Chronos

    return Chronos::parse($date);
 }
+
+function determineTableName(string $tableName, array $emConfig = []): string
+{
+    $schema = $emConfig['connection']['schema'] ?? null;
+//    $tablePrefix = $emConfig['connection']['table_prefix'] ?? null; // TODO
+
+    if ($schema === null) {
+        return $tableName;
+    }
+
+    return sprintf('%s.%s', $schema, $tableName);
+}
--- a/module/Rest/config/entities-mappings/Shlinkio.Shlink.Rest.Entity.ApiKey.php
+++ b/module/Rest/config/entities-mappings/Shlinkio.Shlink.Rest.Entity.ApiKey.php
@ -6,29 +6,32 @@ namespace Shlinkio\Shlink\Rest;

 use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\Mapping\Builder\ClassMetadataBuilder;
-use Doctrine\ORM\Mapping\ClassMetadata; // @codingStandardsIgnoreLine
+use Doctrine\ORM\Mapping\ClassMetadata;
 use Shlinkio\Shlink\Common\Doctrine\Type\ChronosDateTimeType;

-/** @var $metadata ClassMetadata */ // @codingStandardsIgnoreLine
-$builder = new ClassMetadataBuilder($metadata);
+use function Shlinkio\Shlink\Core\determineTableName;

-$builder->setTable('api_keys');
+return static function (ClassMetadata $metadata, array $emConfig): void {
+    $builder = new ClassMetadataBuilder($metadata);

-$builder->createField('id', Types::BIGINT)
-        ->makePrimaryKey()
-        ->generatedValue('IDENTITY')
-        ->option('unsigned', true)
-        ->build();
+    $builder->setTable(determineTableName('api_keys', $emConfig));

-$builder->createField('key', Types::STRING)
-        ->columnName('`key`')
-        ->unique()
-        ->build();
+    $builder->createField('id', Types::BIGINT)
+            ->makePrimaryKey()
+            ->generatedValue('IDENTITY')
+            ->option('unsigned', true)
+            ->build();

-$builder->createField('expirationDate', ChronosDateTimeType::CHRONOS_DATETIME)
-        ->columnName('expiration_date')
-        ->nullable()
-        ->build();
+    $builder->createField('key', Types::STRING)
+            ->columnName('`key`')
+            ->unique()
+            ->build();

-$builder->createField('enabled', Types::BOOLEAN)
-        ->build();
+    $builder->createField('expirationDate', ChronosDateTimeType::CHRONOS_DATETIME)
+            ->columnName('expiration_date')
+            ->nullable()
+            ->build();
+
+    $builder->createField('enabled', Types::BOOLEAN)
+            ->build();
+};
--- a/phpstan.neon
+++ b/phpstan.neon
@ -2,6 +2,5 @@ parameters:
 	checkMissingIterableValueType: false
 	checkGenericClassInNonGenericObjectType: false
 	ignoreErrors:
-		- '#Undefined variable: \$metadata#'
 		- '#AbstractQuery::setParameters()#'
 		- '#mustRun()#'