chore: removed old DatabaseManager from Catalog Next

Signed-off-by: blam <ben@blam.sh>

Co-authored-by: Johan Haals <johan.haals@gmail.com>
Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com>

plugins/catalog-backend/src/next/DefaultLocationStore.test.ts

@@ -15,7 +15,7 @@
  */
 import { TestDatabaseId, TestDatabases } from '@backstage/backend-test-utils';
 import { v4 as uuid } from 'uuid';
-import { DatabaseManager } from './database/DatabaseManager';
+import { applyDatabaseMigrations } from './database/migrations';
 import { DefaultLocationStore } from './DefaultLocationStore';
 
 describe('DefaultLocationStore', () => {
@@ -25,7 +25,7 @@ describe('DefaultLocationStore', () => {
 
   async function createLocationStore(databaseId: TestDatabaseId) {
     const knex = await databases.init(databaseId);
-    await DatabaseManager.createDatabase(knex);
+    await applyDatabaseMigrations(knex);
     const connection = { applyMutation: jest.fn() };
     const store = new DefaultLocationStore(knex);
     await store.connect(connection);

plugins/catalog-backend/src/next/DefaultRefreshService.test.ts

@@ -19,7 +19,7 @@ import { TestDatabaseId, TestDatabases } from '@backstage/backend-test-utils';
 import { createHash } from 'crypto';
 import { Knex } from 'knex';
 import { Logger } from 'winston';
-import { DatabaseManager } from './database/DatabaseManager';
+import { applyDatabaseMigrations } from './database/migrations';
 import { DefaultProcessingDatabase } from './database/DefaultProcessingDatabase';
 import {
   DbRefreshStateReferencesRow,
@@ -44,7 +44,7 @@ describe('Refresh integration', () => {
     logger: Logger = defaultLogger,
   ) {
     const knex = await databases.init(databaseId);
-    await DatabaseManager.createDatabase(knex);
+    await applyDatabaseMigrations(knex);
     return {
       knex,
       db: new DefaultProcessingDatabase({

plugins/catalog-backend/src/next/NextCatalogBuilder.ts

@@ -14,11 +14,7 @@
  * limitations under the License.
  */
 
-import {
-  PluginDatabaseManager,
-  resolvePackagePath,
-  UrlReader,
-} from '@backstage/backend-common';
+import { PluginDatabaseManager, UrlReader } from '@backstage/backend-common';
 import {
   DefaultNamespaceEntityPolicy,
   EntityPolicies,
@@ -70,6 +66,7 @@ import {
 } from '../next/types';
 import { ConfigLocationEntityProvider } from './ConfigLocationEntityProvider';
 import { DefaultProcessingDatabase } from './database/DefaultProcessingDatabase';
+import { applyDatabaseMigrations } from './database/migrations';
 import { DefaultCatalogProcessingEngine } from './DefaultCatalogProcessingEngine';
 import { DefaultLocationService } from './DefaultLocationService';
 import { DefaultLocationStore } from './DefaultLocationStore';
@@ -304,12 +301,7 @@ export class NextCatalogBuilder {
     const parser = this.parser || defaultEntityDataParser;
 
     const dbClient = await database.getClient();
-    await dbClient.migrate.latest({
-      directory: resolvePackagePath(
-        '@backstage/plugin-catalog-backend',
-        'migrations',
-      ),
-    });
+    await applyDatabaseMigrations(dbClient);
 
     const db = new CommonDatabase(dbClient, logger);
 

plugins/catalog-backend/src/next/NextEntitiesCatalog.test.ts

@@ -18,7 +18,7 @@ import { TestDatabaseId, TestDatabases } from '@backstage/backend-test-utils';
 import { Entity, stringifyEntityRef } from '@backstage/catalog-model';
 import { Knex } from 'knex';
 import { v4 as uuid } from 'uuid';
-import { DatabaseManager } from './database/DatabaseManager';
+import { applyDatabaseMigrations } from './database/migrations';
 import {
   DbFinalEntitiesRow,
   DbRefreshStateReferencesRow,
@@ -33,7 +33,7 @@ describe('NextEntitiesCatalog', () => {
 
   async function createDatabase(databaseId: TestDatabaseId) {
     const knex = await databases.init(databaseId);
-    await DatabaseManager.createDatabase(knex);
+    await applyDatabaseMigrations(knex);
     return { knex };
   }
 

plugins/catalog-backend/src/next/database/DatabaseManager.ts

@@ -1,98 +0,0 @@
-/*
- * Copyright 2020 The Backstage Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import { getVoidLogger, resolvePackagePath } from '@backstage/backend-common';
-import knexFactory, { Knex } from 'knex';
-import { v4 as uuid } from 'uuid';
-import { Logger } from 'winston';
-import { CommonDatabase, Database } from '../../legacy';
-
-export type CreateDatabaseOptions = {
-  logger: Logger;
-};
-
-const defaultOptions: CreateDatabaseOptions = {
-  logger: getVoidLogger(),
-};
-
-export class DatabaseManager {
-  public static async createDatabase(
-    knex: Knex,
-    options: Partial<CreateDatabaseOptions> = {},
-  ): Promise<Database> {
-    const migrationsDir = resolvePackagePath(
-      '@backstage/plugin-catalog-backend',
-      'migrations',
-    );
-
-    await knex.migrate.latest({
-      directory: migrationsDir,
-    });
-    const { logger } = { ...defaultOptions, ...options };
-    return new CommonDatabase(knex, logger);
-  }
-
-  public static async createInMemoryDatabase(): Promise<Database> {
-    const knex = await this.createInMemoryDatabaseConnection();
-    return await this.createDatabase(knex);
-  }
-
-  public static async createInMemoryDatabaseConnection(): Promise<Knex> {
-    const knex = knexFactory({
-      client: 'sqlite3',
-      connection: ':memory:',
-      useNullAsDefault: true,
-    });
-
-    knex.client.pool.on('createSuccess', (_eventId: any, resource: any) => {
-      resource.run('PRAGMA foreign_keys = ON', () => {});
-    });
-
-    return knex;
-  }
-
-  public static async createTestDatabase(): Promise<Database> {
-    const knex = await this.createTestDatabaseConnection();
-    return await this.createDatabase(knex);
-  }
-
-  public static async createTestDatabaseConnection(): Promise<Knex> {
-    const config: Knex.Config<any> = {
-      client: 'sqlite3',
-      connection: ':memory:',
-      useNullAsDefault: true,
-    };
-
-    let knex = knexFactory(config);
-    if (typeof config.connection !== 'string') {
-      const tempDbName = `d${uuid().replace(/-/g, '')}`;
-      await knex.raw(`CREATE DATABASE ${tempDbName};`);
-      knex = knexFactory({
-        ...config,
-        connection: {
-          ...config.connection,
-          database: tempDbName,
-        },
-      });
-    }
-
-    knex.client.pool.on('createSuccess', (_eventId: any, resource: any) => {
-      resource.run('PRAGMA foreign_keys = ON', () => {});
-    });
-
-    return knex;
-  }
-}

plugins/catalog-backend/src/next/database/DefaultProcessingDatabase.test.ts

@@ -21,7 +21,7 @@ import { Knex } from 'knex';
 import * as uuid from 'uuid';
 import { Logger } from 'winston';
 import { DateTime } from 'luxon';
-import { DatabaseManager } from './DatabaseManager';
+import { applyDatabaseMigrations } from './migrations';
 import { DefaultProcessingDatabase } from './DefaultProcessingDatabase';
 import {
   DbRefreshStateReferencesRow,
@@ -43,7 +43,7 @@ describe('Default Processing Database', () => {
     logger: Logger = defaultLogger,
   ) {
     const knex = await databases.init(databaseId);
-    await DatabaseManager.createDatabase(knex);
+    await applyDatabaseMigrations(knex);
     return {
       knex,
       db: new DefaultProcessingDatabase({

plugins/catalog-backend/src/next/database/migrations.ts

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2020 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { resolvePackagePath } from '@backstage/backend-common';
+import { Knex } from 'knex';
+
+export async function applyDatabaseMigrations(knex: Knex): Promise<void> {
+  const migrationsDir = resolvePackagePath(
+    '@backstage/plugin-catalog-backend',
+    'migrations',
+  );
+
+  await knex.migrate.latest({
+    directory: migrationsDir,
+  });
+}

plugins/catalog-backend/src/next/stitching/Stitcher.test.ts

@@ -17,7 +17,7 @@
 import { getVoidLogger } from '@backstage/backend-common';
 import { TestDatabases } from '@backstage/backend-test-utils';
 import { Entity } from '@backstage/catalog-model';
-import { DatabaseManager } from '../database/DatabaseManager';
+import { applyDatabaseMigrations } from '../database/migrations';
 import {
   DbFinalEntitiesRow,
   DbRefreshStateReferencesRow,
@@ -37,7 +37,7 @@ describe('Stitcher', () => {
     'runs the happy path for %p',
     async databaseId => {
       const db = await databases.init(databaseId);
-      await DatabaseManager.createDatabase(db);
+      await applyDatabaseMigrations(db);
 
       const stitcher = new Stitcher(db, logger);
       let entities: DbFinalEntitiesRow[];