Make migrations object required

Signed-off-by: Marcus Eide <eide@spotify.com>

packages/backend-common/src/database/DatabaseManager.test.ts

@@ -63,7 +63,7 @@ describe('DatabaseManager', () => {
       const database = DatabaseManager.fromConfig(config);
       const client = database.forPlugin('test');
 
-      expect(client.migrations?.apply).toBe(true);
+      expect(client.migrations.apply).toBe(true);
     });
 
     it('handles migrations options', () => {
@@ -73,7 +73,7 @@ describe('DatabaseManager', () => {
       });
       const client = database.forPlugin('test');
 
-      expect(client.migrations?.apply).toBe(false);
+      expect(client.migrations.apply).toBe(false);
     });
   });
 

packages/backend-common/src/database/DatabaseManager.ts

@@ -37,7 +37,7 @@ function pluginPath(pluginId: string): string {
 }
 
 type Options = {
-  migrations?: PluginDatabaseManager['migrations'];
+  migrations: PluginDatabaseManager['migrations'];
 };
 
 /** @public */
@@ -78,15 +78,15 @@ export class DatabaseManager {
    */
   forPlugin(pluginId: string): PluginDatabaseManager {
     const _this = this;
-    const defaultMigrationOptions = {
-      apply: true,
-    };
 
     return {
       getClient(): Promise<Knex> {
         return _this.getDatabase(pluginId);
       },
-      migrations: _this.options?.migrations ?? defaultMigrationOptions,
+      migrations: {
+        apply: true,
+        ..._this.options?.migrations,
+      },
     };
   }
 

packages/backend-common/src/database/types.ts

@@ -32,9 +32,9 @@ export interface PluginDatabaseManager {
   getClient(): Promise<Knex>;
 
   /**
-   * This optional property is used to control the behavior of database migrations.
+   * This property is used to control the behavior of database migrations.
    */
-  migrations?: {
+  migrations: {
     /**
      * apply can be used to determine if database migrations
      * should be performed.

packages/backend-tasks/src/tasks/TaskScheduler.test.ts

@@ -33,6 +33,7 @@ describe('TaskScheduler', () => {
     const databaseManager: Partial<DatabaseManager> = {
       forPlugin: () => ({
         getClient: async () => knex,
+        migrations: { apply: true },
       }),
     };
     return databaseManager as DatabaseManager;

plugins/auth-backend/src/service/standaloneServer.ts

@@ -56,6 +56,7 @@ export async function startStandaloneServer(
       async getClient() {
         return database;
       },
+      migrations: { apply: true },
     },
     discovery,
   });

plugins/bazaar-backend/src/service/standaloneServer.ts

@@ -52,7 +52,7 @@ export async function startStandaloneServer(
 
   const router = await createRouter({
     logger,
-    database: { getClient: async () => db },
+    database: { getClient: async () => db, migrations: { apply: true } },
     config: config,
   });
 

plugins/catalog-backend/src/legacy/service/CatalogBuilder.test.ts

@@ -49,7 +49,7 @@ describe('CatalogBuilder', () => {
   };
   const env: CatalogEnvironment = {
     logger: getVoidLogger(),
-    database: { getClient: async () => db },
+    database: { getClient: async () => db, migrations: { apply: true } },
     config: new ConfigReader({}),
     reader,
   };

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

@@ -336,7 +336,7 @@ export class NextCatalogBuilder {
     const parser = this.parser || defaultEntityDataParser;
 
     const dbClient = await database.getClient();
-    if (database.migrations?.apply) {
+    if (database.migrations.apply) {
       logger.info('Performing database migration');
       await applyDatabaseMigrations(dbClient);
     }

plugins/catalog-backend/src/service/standaloneServer.ts

@@ -46,7 +46,7 @@ export async function startStandaloneServer(
   logger.debug('Creating application...');
   const builder = new CatalogBuilder({
     logger,
-    database: { getClient: () => db },
+    database: { getClient: () => db, migrations: { apply: true } },
     config,
     reader,
   });

plugins/code-coverage-backend/src/service/standaloneServer.ts

@@ -54,7 +54,7 @@ export async function startStandaloneServer(
 
   logger.debug('Starting application server...');
   const router = await createRouter({
-    database: { getClient: async () => db },
+    database: { getClient: async () => db, migrations: { apply: true } },
     config,
     discovery: SingleHostDiscovery.fromConfig(config),
     urlReader: UrlReaders.default({ logger, config }),

plugins/tech-insights-backend/src/service/router.test.ts

@@ -53,6 +53,7 @@ describe('Tech Insights router tests', () => {
             },
           }) as unknown as Promise<Knex>;
         },
+        migrations: { apply: true },
       },
       logger: getVoidLogger(),
       factRetrievers: [],