fix: synchronize with typeorm_metadata table only if needed (typeorm#9175)

julianpoemp · pleerock · web-flow · commit cdabaa30287d · 2022-09-20T17:27:42.000+05:00
* fix: create typeorm metadata table before migration, if not exists Creating a view in a migration results in an error: `QueryFailedError: relation "typeorm_metadata" does not exist` (see typeorm#9173). This fix creates the table before a migration runs. Closes: typeorm#9173 * refactor: use function from RdbmsSchemaBuilder to create typeorm_metadata table * test: add test for fix issue typeorm#9173 * test: replace describe.only() with describe() * refactor: apply suggestions from review * refactor: add syncWithMetadata param to createView function * style: run npm format * removed only test * test: add missing syncWithMetaData parameter in create-view.ts Co-authored-by: Umed Khudoiberdiev <pleerock.me@gmail.com>
diff --git a/src/driver/aurora-mysql/AuroraMysqlQueryRunner.ts b/src/driver/aurora-mysql/AuroraMysqlQueryRunner.ts
@@ -404,13 +404,18 @@ export class AuroraMysqlQueryRunner
     /**
      * Creates a new view.
      */
-    async createView(view: View): Promise<void> {
+    async createView(
+        view: View,
+        syncWithMetadata: boolean = false,
+    ): Promise<void> {
         const upQueries: Query[] = []
         const downQueries: Query[] = []
         upQueries.push(this.createViewSql(view))
-        upQueries.push(await this.insertViewDefinitionSql(view))
+        if (syncWithMetadata)
+            upQueries.push(await this.insertViewDefinitionSql(view))
         downQueries.push(this.dropViewSql(view))
-        downQueries.push(await this.deleteViewDefinitionSql(view))
+        if (syncWithMetadata)
+            downQueries.push(await this.deleteViewDefinitionSql(view))
         await this.executeQueries(upQueries, downQueries)
     }
 
diff --git a/src/driver/cockroachdb/CockroachQueryRunner.ts b/src/driver/cockroachdb/CockroachQueryRunner.ts
@@ -678,13 +678,18 @@ export class CockroachQueryRunner
     /**
      * Creates a new view.
      */
-    async createView(view: View): Promise<void> {
+    async createView(
+        view: View,
+        syncWithMetadata: boolean = false,
+    ): Promise<void> {
         const upQueries: Query[] = []
         const downQueries: Query[] = []
         upQueries.push(this.createViewSql(view))
-        upQueries.push(await this.insertViewDefinitionSql(view))
+        if (syncWithMetadata)
+            upQueries.push(await this.insertViewDefinitionSql(view))
         downQueries.push(this.dropViewSql(view))
-        downQueries.push(await this.deleteViewDefinitionSql(view))
+        if (syncWithMetadata)
+            downQueries.push(await this.deleteViewDefinitionSql(view))
         await this.executeQueries(upQueries, downQueries)
     }
 
diff --git a/src/driver/mysql/MysqlQueryRunner.ts b/src/driver/mysql/MysqlQueryRunner.ts
@@ -529,13 +529,18 @@ export class MysqlQueryRunner extends BaseQueryRunner implements QueryRunner {
     /**
      * Creates a new view.
      */
-    async createView(view: View): Promise<void> {
+    async createView(
+        view: View,
+        syncWithMetadata: boolean = false,
+    ): Promise<void> {
         const upQueries: Query[] = []
         const downQueries: Query[] = []
         upQueries.push(this.createViewSql(view))
-        upQueries.push(await this.insertViewDefinitionSql(view))
+        if (syncWithMetadata)
+            upQueries.push(await this.insertViewDefinitionSql(view))
         downQueries.push(this.dropViewSql(view))
-        downQueries.push(await this.deleteViewDefinitionSql(view))
+        if (syncWithMetadata)
+            downQueries.push(await this.deleteViewDefinitionSql(view))
         await this.executeQueries(upQueries, downQueries)
     }
 
diff --git a/src/driver/oracle/OracleQueryRunner.ts b/src/driver/oracle/OracleQueryRunner.ts
@@ -594,13 +594,17 @@ export class OracleQueryRunner extends BaseQueryRunner implements QueryRunner {
     /**
      * Creates a new view.
      */
-    async createView(view: View): Promise<void> {
+    async createView(
+        view: View,
+        syncWithMetadata: boolean = false,
+    ): Promise<void> {
         const upQueries: Query[] = []
         const downQueries: Query[] = []
         upQueries.push(this.createViewSql(view))
-        upQueries.push(this.insertViewDefinitionSql(view))
+        if (syncWithMetadata) upQueries.push(this.insertViewDefinitionSql(view))
         downQueries.push(this.dropViewSql(view))
-        downQueries.push(this.deleteViewDefinitionSql(view))
+        if (syncWithMetadata)
+            downQueries.push(this.deleteViewDefinitionSql(view))
         await this.executeQueries(upQueries, downQueries)
     }
 
diff --git a/src/driver/postgres/PostgresQueryRunner.ts b/src/driver/postgres/PostgresQueryRunner.ts
@@ -647,13 +647,18 @@ export class PostgresQueryRunner
     /**
      * Creates a new view.
      */
-    async createView(view: View): Promise<void> {
+    async createView(
+        view: View,
+        syncWithMetadata: boolean = false,
+    ): Promise<void> {
         const upQueries: Query[] = []
         const downQueries: Query[] = []
         upQueries.push(this.createViewSql(view))
-        upQueries.push(await this.insertViewDefinitionSql(view))
+        if (syncWithMetadata)
+            upQueries.push(await this.insertViewDefinitionSql(view))
         downQueries.push(this.dropViewSql(view))
-        downQueries.push(await this.deleteViewDefinitionSql(view))
+        if (syncWithMetadata)
+            downQueries.push(await this.deleteViewDefinitionSql(view))
         await this.executeQueries(upQueries, downQueries)
     }
 
diff --git a/src/driver/sap/SapQueryRunner.ts b/src/driver/sap/SapQueryRunner.ts
@@ -549,13 +549,18 @@ export class SapQueryRunner extends BaseQueryRunner implements QueryRunner {
     /**
      * Creates a new view.
      */
-    async createView(view: View): Promise<void> {
+    async createView(
+        view: View,
+        syncWithMetadata: boolean = false,
+    ): Promise<void> {
         const upQueries: Query[] = []
         const downQueries: Query[] = []
         upQueries.push(this.createViewSql(view))
-        upQueries.push(await this.insertViewDefinitionSql(view))
+        if (syncWithMetadata)
+            upQueries.push(await this.insertViewDefinitionSql(view))
         downQueries.push(this.dropViewSql(view))
-        downQueries.push(await this.deleteViewDefinitionSql(view))
+        if (syncWithMetadata)
+            downQueries.push(await this.deleteViewDefinitionSql(view))
         await this.executeQueries(upQueries, downQueries)
     }
 
diff --git a/src/driver/sqlite-abstract/AbstractSqliteQueryRunner.ts b/src/driver/sqlite-abstract/AbstractSqliteQueryRunner.ts
@@ -398,13 +398,17 @@ export abstract class AbstractSqliteQueryRunner
     /**
      * Creates a new view.
      */
-    async createView(view: View): Promise<void> {
+    async createView(
+        view: View,
+        syncWithMetadata: boolean = false,
+    ): Promise<void> {
         const upQueries: Query[] = []
         const downQueries: Query[] = []
         upQueries.push(this.createViewSql(view))
-        upQueries.push(this.insertViewDefinitionSql(view))
+        if (syncWithMetadata) upQueries.push(this.insertViewDefinitionSql(view))
         downQueries.push(this.dropViewSql(view))
-        downQueries.push(this.deleteViewDefinitionSql(view))
+        if (syncWithMetadata)
+            downQueries.push(this.deleteViewDefinitionSql(view))
         await this.executeQueries(upQueries, downQueries)
     }
 
diff --git a/src/driver/sqlserver/SqlServerQueryRunner.ts b/src/driver/sqlserver/SqlServerQueryRunner.ts
@@ -721,13 +721,18 @@ export class SqlServerQueryRunner
     /**
      * Creates a new view.
      */
-    async createView(view: View): Promise<void> {
+    async createView(
+        view: View,
+        syncWithMetadata: boolean = false,
+    ): Promise<void> {
         const upQueries: Query[] = []
         const downQueries: Query[] = []
         upQueries.push(this.createViewSql(view))
-        upQueries.push(await this.insertViewDefinitionSql(view))
+        if (syncWithMetadata)
+            upQueries.push(await this.insertViewDefinitionSql(view))
         downQueries.push(this.dropViewSql(view))
-        downQueries.push(await this.deleteViewDefinitionSql(view))
+        if (syncWithMetadata)
+            downQueries.push(await this.deleteViewDefinitionSql(view))
         await this.executeQueries(upQueries, downQueries)
     }
 
diff --git a/src/migration/MigrationExecutor.ts b/src/migration/MigrationExecutor.ts
@@ -73,6 +73,13 @@ export class MigrationExecutor {
     public async executeMigration(migration: Migration): Promise<Migration> {
         return this.withQueryRunner(async (queryRunner) => {
             await this.createMigrationsTableIfNotExist(queryRunner)
+
+            // create typeorm_metadata table if it's not created yet
+            const schemaBuilder = this.connection.driver.createSchemaBuilder()
+            if (InstanceChecker.isRdbmsSchemaBuilder(schemaBuilder)) {
+                await schemaBuilder.createMetadataTableIfNecessary(queryRunner)
+            }
+
             await queryRunner.beforeMigration()
             await (migration.instance as any).up(queryRunner)
             await queryRunner.afterMigration()
@@ -144,6 +151,7 @@ export class MigrationExecutor {
             this.queryRunner || this.connection.createQueryRunner()
         // create migrations table if its not created yet
         await this.createMigrationsTableIfNotExist(queryRunner)
+
         // get all migrations that are executed and saved in the database
         const executedMigrations = await this.loadExecutedMigrations(
             queryRunner,
@@ -181,12 +189,11 @@ export class MigrationExecutor {
     async executePendingMigrations(): Promise<Migration[]> {
         const queryRunner =
             this.queryRunner || this.connection.createQueryRunner()
-        // create migrations table if its not created yet
+        // create migrations table if it's not created yet
         await this.createMigrationsTableIfNotExist(queryRunner)
 
-        // create the typeorm_metadata table if necessary
+        // create the typeorm_metadata table if it's not created yet
         const schemaBuilder = this.connection.driver.createSchemaBuilder()
-
         if (InstanceChecker.isRdbmsSchemaBuilder(schemaBuilder)) {
             await schemaBuilder.createMetadataTableIfNecessary(queryRunner)
         }
@@ -336,9 +343,15 @@ export class MigrationExecutor {
         const queryRunner =
             this.queryRunner || this.connection.createQueryRunner()
 
-        // create migrations table if its not created yet
+        // create migrations table if it's not created yet
         await this.createMigrationsTableIfNotExist(queryRunner)
 
+        // create typeorm_metadata table if it's not created yet
+        const schemaBuilder = this.connection.driver.createSchemaBuilder()
+        if (InstanceChecker.isRdbmsSchemaBuilder(schemaBuilder)) {
+            await schemaBuilder.createMetadataTableIfNecessary(queryRunner)
+        }
+
         // get all migrations that are executed and saved in the database
         const executedMigrations = await this.loadExecutedMigrations(
             queryRunner,
diff --git a/src/query-runner/QueryRunner.ts b/src/query-runner/QueryRunner.ts
@@ -252,7 +252,11 @@ export interface QueryRunner {
     /**
      * Creates a new view.
      */
-    createView(view: View, oldView?: View): Promise<void>
+    createView(
+        view: View,
+        syncWithMetadata?: boolean,
+        oldView?: View,
+    ): Promise<void>
 
     /**
      * Drops a view.
diff --git a/src/schema-builder/RdbmsSchemaBuilder.ts b/src/schema-builder/RdbmsSchemaBuilder.ts
@@ -568,7 +568,7 @@ export class RdbmsSchemaBuilder implements SchemaBuilder {
 
             // create a new view and sync it in the database
             const view = View.create(metadata, this.connection.driver)
-            await this.queryRunner.createView(view)
+            await this.queryRunner.createView(view, true)
             this.queryRunner.loadedViews.push(view)
         }
     }
diff --git a/test/functional/query-runner/create-view.ts b/test/functional/query-runner/create-view.ts
@@ -29,7 +29,7 @@ describe("query runner > create view", () => {
                     name: "new_post_view",
                     expression: `SELECT * from "post"`,
                 })
-                await queryRunner.createView(view)
+                await queryRunner.createView(view, true)
 
                 let postView = await queryRunner.getView("new_post_view")
                 expect(postView).to.be.exist
@@ -52,7 +52,7 @@ describe("query runner > create view", () => {
                     expression: `SELECT * from "post"`,
                     materialized: true,
                 })
-                await queryRunner.createView(view)
+                await queryRunner.createView(view, true)
 
                 let postMatView = await queryRunner.getView(
                     "new_post_materialized_view",
diff --git a/test/github-issues/9173/issue-9173.ts b/test/github-issues/9173/issue-9173.ts
@@ -0,0 +1,66 @@
+import "reflect-metadata"
+import {
+    closeTestingConnections,
+    createTestingConnections,
+    reloadTestingDatabases,
+} from "../../utils/test-utils"
+import { DataSource, Table } from "../../../src"
+import { View } from "../../../src/schema-builder/view/View"
+import { expect } from "chai"
+
+describe("github issues > #9173 missing typeorm_metadata", () => {
+    let connections: DataSource[]
+    before(
+        async () =>
+            (connections = await createTestingConnections({
+                entities: [__dirname + "/entity/*{.js,.ts}"],
+                schemaCreate: true,
+                dropSchema: true,
+                enabledDrivers: [
+                    "sqlite",
+                    "mysql",
+                    "postgres",
+                    "better-sqlite3",
+                ],
+            })),
+    )
+    beforeEach(() => reloadTestingDatabases(connections))
+    after(() => closeTestingConnections(connections))
+
+    it("should create a view without view entity", async () => {
+        for (const connection of connections) {
+            await connection.runMigrations({
+                transaction: "all",
+            })
+            await connection.createQueryRunner().createTable(
+                new Table({
+                    name: "test_table",
+                    columns: [
+                        {
+                            name: "id",
+                            type: "integer",
+                            isGenerated: true,
+                            isPrimary: true,
+                            generationStrategy: "increment",
+                        },
+                        {
+                            name: "name",
+                            type: "text",
+                        },
+                    ],
+                }),
+            )
+
+            // create a test view
+            await connection.createQueryRunner().createView(
+                new View({
+                    name: "test_view",
+                    expression: "SELECT * FROM test_table",
+                }),
+            )
+
+            const view = await connection.query("SELECT * FROM test_view")
+            expect(view).to.be.exist
+        }
+    })
+})
