From 189ba4c340a910e127345e01b3221b6d1e7eaf77 Mon Sep 17 00:00:00 2001
From: Joe Porpeglia <josephp@spotify.com>
Date: Fri, 3 Dec 2021 15:50:09 -0500
Subject: [PATCH] Overwrite sqlite filepath per plugin

Signed-off-by: Joe Porpeglia <josephp@spotify.com>
---
 .../src/database/DatabaseManager.test.ts      |  5 ++++-
 .../src/database/DatabaseManager.ts           | 12 +++++++---
 .../src/database/connectors/sqlite3.test.ts   | 22 -------------------
 .../src/database/connectors/sqlite3.ts        | 13 -----------
 4 files changed, 13 insertions(+), 39 deletions(-)

diff --git a/packages/backend-common/src/database/DatabaseManager.test.ts b/packages/backend-common/src/database/DatabaseManager.test.ts
index bd2e7b9f71..d5271bc2b5 100644
--- a/packages/backend-common/src/database/DatabaseManager.test.ts
+++ b/packages/backend-common/src/database/DatabaseManager.test.ts
@@ -282,7 +282,10 @@ describe('DatabaseManager', () => {
       expect(baseConfig.get().client).toEqual('sqlite3');
 
       // sqlite3 uses 'filename' instead of 'database'
-      expect(overrides).toHaveProperty('connection.filename');
+      expect(overrides).toHaveProperty(
+        'connection.filename',
+        `plugin_with_different_client/${pluginId}`,
+      );
     });
 
     it('provides database client specific base from plugin connection string when client set under plugin', async () => {
diff --git a/packages/backend-common/src/database/DatabaseManager.ts b/packages/backend-common/src/database/DatabaseManager.ts
index 8e23a219ec..977516a18b 100644
--- a/packages/backend-common/src/database/DatabaseManager.ts
+++ b/packages/backend-common/src/database/DatabaseManager.ts
@@ -114,10 +114,16 @@ export class DatabaseManager {
     const connection = this.getConnectionConfig(pluginId);
 
     if (this.getClientType(pluginId).client === 'sqlite3') {
+      const sqliteFilename = (connection as Knex.Sqlite3ConnectionConfig)
+        ?.filename;
+
+      // if persisting to a file, create separate files per plugin to avoid db migration issues.
+      if (sqliteFilename !== ':memory:') {
+        return `${sqliteFilename}/${pluginId}`;
+      }
+
       // sqlite database name should fallback to ':memory:' as a special case
-      return (
-        (connection as Knex.Sqlite3ConnectionConfig)?.filename ?? ':memory:'
-      );
+      return ':memory:';
     }
 
     const databaseName = (connection as Knex.ConnectionConfig)?.database;
diff --git a/packages/backend-common/src/database/connectors/sqlite3.test.ts b/packages/backend-common/src/database/connectors/sqlite3.test.ts
index b9da19d247..cfc9f61527 100644
--- a/packages/backend-common/src/database/connectors/sqlite3.test.ts
+++ b/packages/backend-common/src/database/connectors/sqlite3.test.ts
@@ -73,28 +73,6 @@ describe('sqlite3', () => {
       });
     });
 
-    it('builds a persistent connection per database', () => {
-      expect(
-        buildSqliteDatabaseConfig(
-          createConfig({
-            filename: path.join('path', 'to', 'foo'),
-          }),
-          {
-            connection: {
-              database: 'my-database',
-            },
-          },
-        ),
-      ).toEqual({
-        client: 'sqlite3',
-        connection: {
-          filename: path.join('path', 'to', 'foo', 'my-database.sqlite'),
-          database: 'my-database',
-        },
-        useNullAsDefault: true,
-      });
-    });
-
     it('replaces the connection with an override', () => {
       expect(
         buildSqliteDatabaseConfig(createConfig(':memory:'), {
diff --git a/packages/backend-common/src/database/connectors/sqlite3.ts b/packages/backend-common/src/database/connectors/sqlite3.ts
index 3dfecd7e6b..41f80ed293 100644
--- a/packages/backend-common/src/database/connectors/sqlite3.ts
+++ b/packages/backend-common/src/database/connectors/sqlite3.ts
@@ -86,19 +86,6 @@ export function buildSqliteDatabaseConfig(
     overrides,
   );
 
-  // If we don't create an in-memory database, interpret the connection string
-  // as a directory that contains multiple sqlite files based on the database
-  // name.
-  const database = (config.connection as Knex.ConnectionConfig).database;
-  const sqliteConnection = config.connection as Knex.Sqlite3ConnectionConfig;
-
-  if (database && sqliteConnection.filename !== ':memory:') {
-    sqliteConnection.filename = path.join(
-      sqliteConnection.filename,
-      `${database}.sqlite`,
-    );
-  }
-
   return config;
 }