feat: 🎸 Add migration check to delete index DB when updating (#2241)

* feat: 🎸 Add migration check to delete index DB when updating

✅ Closes: https://hashicorp.atlassian.net/browse/ICU-13223

addons/api/addon-test-support/helpers/indexed-db.js

@@ -20,9 +20,9 @@
  * @param hooks
  */
 export function setupIndexedDb(hooks) {
-  hooks.beforeEach(function () {
+  hooks.beforeEach(async function () {
     const indexedDb = this.owner.lookup('service:indexed-db');
-    indexedDb.setup(`test-indexed-db-${Date.now()}`);
+    await indexedDb.setup(`test-indexed-db-${Date.now()}`);
   });
 
   hooks.afterEach(async function () {

addons/api/addon/services/indexed-db.js

@@ -97,23 +97,42 @@ const unconvertFields = (result, object, schema, serializer) => {
 
 /**
  * Service to encapsulate the IndexedDB implementation. To use this service, call
- * `setup` from the application root and
+ * `setup` from the application root. This will create the database and the necessary indexes.
+ *
+ * Make sure to increment the version number of the database whenever the indexes change.
+ * This will delete the old database and create a new one with the new indexes.
  */
 export default class IndexedDbService extends Service {
   // =attributes
   #db;
+  #version = 2;
+
   get db() {
     return this.#db;
   }
 
-  setup(dbName) {
+  async setup(dbName) {
     // Don't run setup again if we already have one or if we didn't get a name
     if (this.#db || !dbName) {
       return;
     }
 
+    const doesDbExist = await Dexie.exists(dbName);
+
+    // If the database already exists, open the database and
+    // check if the version is a lower version than the current one
+    if (doesDbExist) {
+      const dbVerifier = new Dexie(dbName);
+      await dbVerifier.open();
+      if (dbVerifier.verno < this.#version) {
+        await dbVerifier.delete();
+      } else {
+        dbVerifier.close();
+      }
+    }
+
     this.#db = new Dexie(dbName);
-    this.#db.version(2).stores(modelIndexes);
+    this.#db.version(this.#version).stores(modelIndexes);
   }
 
   /**

ui/admin/app/controllers/scopes/scope/authenticate/method/index.js

@@ -47,7 +47,6 @@ export default class ScopesScopeAuthenticateMethodIndexController extends Contro
           requestCookies,
           { scope, authMethod },
         );
-        this.router.transitionTo('index');
         break;
       case TYPE_AUTH_METHOD_OIDC:
         await this.startOIDCAuthentication(authenticatorName, {

ui/admin/app/routes/application.js

@@ -73,7 +73,7 @@ export default class ApplicationRoute extends Route {
       const userId = this.session.data?.authenticated?.user_id;
       const hostUrl = this.window.location.host;
       if (userId && hostUrl) {
-        this.indexedDb.setup(formatDbName(userId, hostUrl));
+        await this.indexedDb.setup(formatDbName(userId, hostUrl));
       }
     }
   }

ui/admin/app/services/session.js

@@ -15,13 +15,15 @@ export default class SessionService extends BaseSessionService {
    * Extend ember simple auth's handleAuthentication method
    * so we can hook in and setup the DB after a successful authentication
    */
-  handleAuthentication() {
-    super.handleAuthentication(...arguments);
-
+  async handleAuthentication() {
     const userId = this.data?.authenticated?.user_id;
-    const hostUrl = this.window.location.host;
+    const hostUrl = this.window.location?.host;
     if (userId && hostUrl) {
-      this.indexedDb.setup(formatDbName(userId, hostUrl));
+      await this.indexedDb.setup(formatDbName(userId, hostUrl));
     }
+
+    // We let ember-simple-auth handle transitioning back to the index after authentication.
+    // This route can be configured in our environment config.
+    super.handleAuthentication(...arguments);
   }
 }

ui/admin/tests/unit/controllers/scopes/scope/authenticate/method/index-test.js

@@ -5,7 +5,7 @@
 
 import { module, test } from 'qunit';
 import { setupTest } from 'ember-qunit';
-import { currentURL, visit, waitUntil } from '@ember/test-helpers';
+import { visit } from '@ember/test-helpers';
 import setupMirage from 'ember-cli-mirage/test-support/setup-mirage';
 import { setupIndexedDb } from 'api/test-support/helpers/indexed-db';
 import { authenticateSession } from 'ember-simple-auth/test-support';
@@ -55,10 +55,6 @@ module(
       urls.authenticate = `scopes/global/authenticate/${instances.authMethod}`;
     });
 
-    test('it exists', function (assert) {
-      assert.ok(controller);
-    });
-
     test('authenticate action saves login information and redirects to correct page', async function (assert) {
       await visit(urls.authenticate);
       const identification = 'admin123';
@@ -76,11 +72,9 @@ module(
         identification,
         password: 'password',
       });
-      await waitUntil(() => currentURL() === urls.globalScope);
       const { authenticator: authAfter, username: usernameAfter } =
         session.data.authenticated;
 
-      assert.strictEqual(currentURL(), urls.globalScope);
       assert.strictEqual(
         authAfter,
         `authenticator:${instances.authMethod.type}`,