Fix #62: Unnecessary SQL statement for comment on column in PgSQL

src/lib/migrations/MigrationRecordBuilder.php

@@ -69,15 +69,15 @@ public function __construct(Schema $dbSchema)
 
     /**
      * @param string                     $tableAlias
-     * @param array|\yii\db\ColumnSchema $columns
+     * @param array|ColumnSchema $columns
      * @return string
      * @throws \yii\base\InvalidConfigException
      */
     public function createTable(string $tableAlias, array $columns):string
     {
         $codeColumns = [];
         foreach ($columns as $columnName => $cebeDbColumnSchema) {
-            if (!empty($cebeDbColumnSchema->xDbType) && is_string($cebeDbColumnSchema->xDbType)) {
+            if (static::isXDbTypePresent($cebeDbColumnSchema)) {
                 $name = static::quote($columnName);
                 $codeColumns[] = $name.' '.$this->columnToCode($tableAlias, $cebeDbColumnSchema, false)->getCode();
             } else {
@@ -393,4 +393,9 @@ public function renameColumn(string $table, string $fromColumn, string $toColumn
     {
         return sprintf(self::RENAME_COLUMN, $table, $fromColumn, $toColumn);
     }
+
+    public static function isXDbTypePresent(ColumnSchema $columnSchema): bool
+    {
+        return (!empty($columnSchema->xDbType) && is_string($columnSchema->xDbType));
+    }
 }

src/lib/migrations/PostgresMigrationBuilder.php

@@ -286,9 +286,12 @@ public function handleCommentsMigration()
     {
         $tableAlias = $this->model->getTableAlias();
         foreach ($this->newColumns as $column) {
+            /** @var ColumnSchema $column */
             if ($column->comment) {
-                $this->migration
-                    ->addUpCode($this->recordBuilder->addCommentOnColumn($tableAlias, $column->name, $column->comment));
+                if (MigrationRecordBuilder::isXDbTypePresent($column)) {
+                    $this->migration
+                        ->addUpCode($this->recordBuilder->addCommentOnColumn($tableAlias, $column->name, $column->comment));
+                }
             }
         }
     }

tests/specs/blog/migrations_pgsql_db/m200000_000002_create_table_blog_posts.php

@@ -21,8 +21,6 @@ public function safeUp()
         $this->createIndex('blog_posts_slug_key', '{{%blog_posts}}', 'slug', true);
         $this->addForeignKey('fk_blog_posts_category_id_categories_id', '{{%blog_posts}}', 'category_id', '{{%categories}}', 'id');
         $this->addForeignKey('fk_blog_posts_created_by_id_users_id', '{{%blog_posts}}', 'created_by_id', '{{%users}}', 'id');
-        $this->addCommentOnColumn('{{%blog_posts}}', 'category_id', 'Category of posts');
-        $this->addCommentOnColumn('{{%blog_posts}}', 'created_by_id', 'The User');
     }
 
     public function safeDown()

tests/specs/blog/migrations_pgsql_db/m200000_000004_create_table_post_comments.php

@@ -17,8 +17,6 @@ public function safeUp()
         ]);
         $this->addForeignKey('fk_post_comments_post_id_blog_posts_uid', '{{%post_comments}}', 'post_id', '{{%blog_posts}}', 'uid');
         $this->addForeignKey('fk_post_comments_author_id_users_id', '{{%post_comments}}', 'author_id', '{{%users}}', 'id');
-        $this->addCommentOnColumn('{{%post_comments}}', 'post_id', 'A blog post (uid used as pk for test purposes)');
-        $this->addCommentOnColumn('{{%post_comments}}', 'author_id', 'The User');
     }
 
     public function safeDown()

tests/specs/issue_fix/60_description_of_a_property_in_spec_must_correspond_to_db_table_column_comment/pgsql/migrations_pgsql_db/m200000_000001_create_table_fruits.php

@@ -12,7 +12,6 @@ public function safeUp()
             'name' => $this->text()->null()->defaultValue(null)->comment('desc with \' quote'),
             0 => '"description" double precision NULL DEFAULT NULL',
         ]);
-        $this->addCommentOnColumn('{{%fruits}}', 'name', 'desc with \' quote');
         $this->addCommentOnColumn('{{%fruits}}', 'description', 'desc \' 2');
     }
 

tests/specs/issue_fix/62_unnecessary_sql_statement_for_comment_on_column_in_pgsql/index.php

@@ -0,0 +1,14 @@
+<?php
+
+return [
+    'openApiPath' => '@specs/issue_fix/62_unnecessary_sql_statement_for_comment_on_column_in_pgsql/index.yml',
+    'generateUrls' => false,
+    'generateModels' => false,
+    'excludeModels' => [
+        'Error',
+    ],
+    'generateControllers' => false,
+    'generateMigrations' => true,
+    'generateModelFaker' => false, // `generateModels` must be `true` in order to use `generateModelFaker` as `true`
+];
+

tests/specs/issue_fix/62_unnecessary_sql_statement_for_comment_on_column_in_pgsql/index.yml

@@ -0,0 +1,27 @@
+openapi: 3.0.3
+x-description-is-comment: true
+info:
+  title: 'Description of a property in spec must correspond to DB TABLE COLUMN COMMENT #60'
+  version: 1.0.0
+
+components:
+  schemas:
+    Fruit:
+      type: object
+      properties:
+        id:
+          type: integer
+        name:
+          type: string
+          description: desc with ' quote
+        description:
+          type: number
+          x-db-type: double precision
+          description: desc ' 2
+
+paths:
+  '/':
+    get:
+      responses:
+        '200':
+          description: OK

tests/specs/issue_fix/62_unnecessary_sql_statement_for_comment_on_column_in_pgsql/pgsql/migrations_pgsql_db/m200000_000000_create_table_fruits.php

@@ -0,0 +1,22 @@
+<?php
+
+/**
+ * Table for Fruit
+ */
+class m200000_000000_create_table_fruits extends \yii\db\Migration
+{
+    public function safeUp()
+    {
+        $this->createTable('{{%fruits}}', [
+            'id' => $this->primaryKey(),
+            'name' => $this->text()->null()->defaultValue(null)->comment('desc with \' quote'),
+            0 => '"description" double precision NULL DEFAULT NULL',
+        ]);
+        $this->addCommentOnColumn('{{%fruits}}', 'description', 'desc \' 2');
+    }
+
+    public function safeDown()
+    {
+        $this->dropTable('{{%fruits}}');
+    }
+}

tests/specs/relations_in_faker/app/migrations_pgsql_db/m200000_000001_create_table_b123s.php

@@ -13,7 +13,6 @@ public function safeUp()
             'c123_id' => $this->integer()->null()->defaultValue(null)->comment('desc'),
         ]);
         $this->addForeignKey('fk_b123s_c123_id_c123s_id', '{{%b123s}}', 'c123_id', '{{%c123s}}', 'id');
-        $this->addCommentOnColumn('{{%b123s}}', 'c123_id', 'desc');
     }
 
     public function safeDown()

tests/specs/relations_in_faker/app/migrations_pgsql_db/m200000_000002_create_table_a123s.php

@@ -13,7 +13,6 @@ public function safeUp()
             'b123_id' => $this->integer()->null()->defaultValue(null)->comment('desc'),
         ]);
         $this->addForeignKey('fk_a123s_b123_id_b123s_id', '{{%a123s}}', 'b123_id', '{{%b123s}}', 'id');
-        $this->addCommentOnColumn('{{%a123s}}', 'b123_id', 'desc');
     }
 
     public function safeDown()

tests/specs/relations_in_faker/app/migrations_pgsql_db/m200000_000003_create_table_accounts.php

@@ -11,7 +11,6 @@ public function safeUp()
             'id' => $this->primaryKey(),
             'name' => $this->string(40)->notNull()->comment('account name'),
         ]);
-        $this->addCommentOnColumn('{{%accounts}}', 'name', 'account name');
     }
 
     public function safeDown()

tests/specs/relations_in_faker/app/migrations_pgsql_db/m200000_000005_create_table_domains.php

@@ -14,8 +14,6 @@ public function safeUp()
             0 => '"created_at" timestamp NOT NULL',
         ]);
         $this->addForeignKey('fk_domains_account_id_accounts_id', '{{%domains}}', 'account_id', '{{%accounts}}', 'id');
-        $this->addCommentOnColumn('{{%domains}}', 'name', 'domain or sub-domain name, in DNS syntax, IDN are converted');
-        $this->addCommentOnColumn('{{%domains}}', 'account_id', 'user account');
     }
 
     public function safeDown()

tests/specs/relations_in_faker/app/migrations_pgsql_db/m200000_000006_create_table_e123s.php

@@ -13,7 +13,6 @@ public function safeUp()
             'b123_id' => $this->integer()->null()->defaultValue(null)->comment('desc'),
         ]);
         $this->addForeignKey('fk_e123s_b123_id_b123s_id', '{{%e123s}}', 'b123_id', '{{%b123s}}', 'id');
-        $this->addCommentOnColumn('{{%e123s}}', 'b123_id', 'desc');
     }
 
     public function safeDown()

tests/specs/relations_in_faker/app/migrations_pgsql_db/m200000_000007_create_table_routings.php

@@ -21,9 +21,6 @@ public function safeUp()
         $this->addForeignKey('fk_routings_domain_id_domains_id', '{{%routings}}', 'domain_id', '{{%domains}}', 'id');
         $this->addForeignKey('fk_routings_d123_id_d123s_id', '{{%routings}}', 'd123_id', '{{%d123s}}', 'id');
         $this->addForeignKey('fk_routings_a123_id_a123s_id', '{{%routings}}', 'a123_id', '{{%a123s}}', 'id');
-        $this->addCommentOnColumn('{{%routings}}', 'domain_id', 'domain');
-        $this->addCommentOnColumn('{{%routings}}', 'd123_id', 'desc');
-        $this->addCommentOnColumn('{{%routings}}', 'a123_id', 'desc');
     }
 
     public function safeDown()

tests/specs/x_on_x_fk_constraint/app/migrations_pgsql_db/m200000_000001_create_table_postxes.php

@@ -19,10 +19,6 @@ public function safeUp()
         $this->addForeignKey('fk_postxes_user_2_id_userxes_id', '{{%postxes}}', 'user_2_id', '{{%userxes}}', 'id', 'SET NULL', 'CASCADE');
         $this->addForeignKey('fk_postxes_user_3_id_userxes_id', '{{%postxes}}', 'user_3_id', '{{%userxes}}', 'id', 'SET NULL');
         $this->addForeignKey('fk_postxes_user_4_id_userxes_id', '{{%postxes}}', 'user_4_id', '{{%userxes}}', 'id');
-        $this->addCommentOnColumn('{{%postxes}}', 'user_id', 'x on-x (update|delete) foreign key constraint');
-        $this->addCommentOnColumn('{{%postxes}}', 'user_2_id', 'x on-x (update|delete) foreign key constraint');
-        $this->addCommentOnColumn('{{%postxes}}', 'user_3_id', 'x on-x (update|delete) foreign key constraint');
-        $this->addCommentOnColumn('{{%postxes}}', 'user_4_id', 'x on-x (update|delete) foreign key constraint');
     }
 
     public function safeDown()

tests/unit/issues/Issue62Test.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace tests\unit\issues;
+
+use tests\DbTestCase;
+use Yii;
+use yii\helpers\FileHelper;
+
+# https://github.com/php-openapi/yii2-openapi/issues/62
+class Issue62Test extends DbTestCase
+{
+    public function testIndex()
+    {
+        $this->changeDbToPgsql();
+
+        $testFile = Yii::getAlias("@specs/issue_fix/62_unnecessary_sql_statement_for_comment_on_column_in_pgsql/index.php");
+        $this->runGenerator($testFile, 'pgsql');
+        $actualFiles = FileHelper::findFiles(Yii::getAlias('@app'), [
+            'recursive' => true,
+        ]);
+        $expectedFiles = FileHelper::findFiles(Yii::getAlias("@specs/issue_fix/62_unnecessary_sql_statement_for_comment_on_column_in_pgsql/pgsql"), [
+            'recursive' => true,
+        ]);
+        $this->checkFiles($actualFiles, $expectedFiles);
+    }
+}