Migrate realms config from old account data key to new one

Author: lukemelia

packages/host/app/services/matrix-sdk-loader.ts

@@ -99,6 +99,7 @@ export type ExtendedClient = Pick<
   | 'setRoomName'
   | 'startClient'
   | 'getAccountDataFromServer'
+  | 'setAccountData'
 > & {
   requestEmailToken(
     type: 'registration' | 'threepid',

packages/host/app/services/matrix-service.ts

@@ -45,6 +45,7 @@ import {
   APP_BOXEL_MESSAGE_MSGTYPE,
   APP_BOXEL_REALM_SERVER_EVENT_MSGTYPE,
   APP_BOXEL_REALMS_EVENT_TYPE,
+  LEGACY_APP_BOXEL_REALMS_EVENT_TYPE,
 } from '@cardstack/runtime-common/matrix-constants';
 
 import {
@@ -411,6 +412,34 @@ export default class MatrixService extends Service {
         let accountDataContent = await this._client.getAccountDataFromServer<{
           realms: string[];
         }>(APP_BOXEL_REALMS_EVENT_TYPE);
+        // TODO: remove this once we've migrated all users
+        // TEMPORARY MIGRATION CODE
+        if (!accountDataContent?.realms?.length) {
+          console.log(
+            'You currently have no realms set, checking your old realms',
+          );
+          try {
+            accountDataContent = await this._client.getAccountDataFromServer<{
+              realms: string[];
+            }>(LEGACY_APP_BOXEL_REALMS_EVENT_TYPE);
+          } catch (e) {
+            // throws if nothing at this key
+          }
+          if (accountDataContent?.realms) {
+            console.log('Migrating your old realms to the new format');
+            await this._client.setAccountData(APP_BOXEL_REALMS_EVENT_TYPE, {
+              realms: accountDataContent.realms,
+            });
+            console.log('Removing your old realms data');
+            await this._client.setAccountData(
+              LEGACY_APP_BOXEL_REALMS_EVENT_TYPE,
+              {},
+            );
+          } else {
+            console.log('No old realms found');
+          }
+        }
+        // END OF TEMPORARY MIGRATION CODE
         await this.realmServer.setAvailableRealmURLs(
           accountDataContent?.realms ?? [],
         );

packages/host/tests/helpers/mock-matrix/_client.ts

@@ -7,6 +7,7 @@ import { baseRealm, unixTime } from '@cardstack/runtime-common';
 import {
   APP_BOXEL_ROOM_SKILLS_EVENT_TYPE,
   APP_BOXEL_REALMS_EVENT_TYPE,
+  LEGACY_APP_BOXEL_REALMS_EVENT_TYPE,
 } from '@cardstack/runtime-common/matrix-constants';
 
 import type { ExtendedClient } from '@cardstack/host/services/matrix-sdk-loader';
@@ -114,8 +115,17 @@ export class MockClient implements ExtendedClient {
     throw new Error('Method not implemented.');
   }
 
-  setAccountData<T>(_type: string, _data: T): Promise<{}> {
-    throw new Error('Method not implemented.');
+  setAccountData<T>(type: string, data: T): Promise<{}> {
+    if (type === APP_BOXEL_REALMS_EVENT_TYPE) {
+      this.sdkOpts.activeRealms = (data as any).realms;
+    } else if (type === LEGACY_APP_BOXEL_REALMS_EVENT_TYPE) {
+      // nothing to do
+    } else {
+      throw new Error(
+        'Support for updating this event type in account data is not yet implemented in this mock.',
+      );
+    }
+    return Promise.resolve({});
   }
 
   getAccountData<T>(_type: string): Promise<T> {

packages/matrix/helpers/matrix-constants.ts

@@ -6,3 +6,4 @@ export const APP_BOXEL_COMMAND_RESULT_MSGTYPE = 'app.boxel.commandResult';
 export const APP_BOXEL_REALM_SERVER_EVENT_MSGTYPE =
   'app.boxel.realm-server-event';
 export const APP_BOXEL_REALMS_EVENT_TYPE = 'app.boxel.realms';
+export const LEGACY_APP_BOXEL_REALMS_EVENT_TYPE = 'com.cardstack.boxel.realms';

packages/matrix/tests/realm-urls.spec.ts

@@ -4,17 +4,27 @@ import {
   synapseStop,
   type SynapseInstance,
   registerUser,
+  getAccountData,
   updateAccountData,
   updateUser,
 } from '../docker/synapse';
 import { smtpStart, smtpStop } from '../docker/smtp4dev';
-import { login, registerRealmUsers, setupUserSubscribed } from '../helpers';
-import { APP_BOXEL_REALMS_EVENT_TYPE } from '@cardstack/runtime-common/matrix-constants';
+import {
+  login,
+  logout,
+  registerRealmUsers,
+  setupUserSubscribed,
+} from '../helpers';
+
 import {
   appURL,
   startServer as startRealmServer,
   type IsolatedRealmServer,
 } from '../helpers/isolated-realm-server';
+import {
+  APP_BOXEL_REALMS_EVENT_TYPE,
+  LEGACY_APP_BOXEL_REALMS_EVENT_TYPE,
+} from '../helpers/matrix-constants';
 
 test.describe('Realm URLs in Matrix account data', () => {
   let synapse: SynapseInstance;
@@ -90,4 +100,38 @@ test.describe('Realm URLs in Matrix account data', () => {
       ),
     ).toHaveText('private');
   });
+
+  test('deprecated account data key is supported by auto-migrating user to new key', async ({
+    page,
+  }) => {
+    await login(page, 'user1', 'pass', { url: appURL });
+    await updateAccountData(
+      '@user1:localhost',
+      user.accessToken,
+      LEGACY_APP_BOXEL_REALMS_EVENT_TYPE,
+      JSON.stringify({
+        realms: ['http://localhost:4205/user1/personal/'],
+      }),
+    );
+    await logout(page);
+    await login(page, 'user1', 'pass', { url: appURL });
+
+    await page.locator('[data-test-workspace-chooser-toggle]').click();
+
+    await page
+      .locator('[data-test-workspace-chooser]')
+      .waitFor({ state: 'visible' });
+
+    expect(
+      page.locator('[data-test-workspace-list] [data-test-workspace]'),
+    ).toHaveCount(1);
+    let realms = await getAccountData<{ realms: string[] } | undefined>(
+      '@user1:localhost',
+      user.accessToken,
+      APP_BOXEL_REALMS_EVENT_TYPE,
+    );
+    expect(realms).toEqual({
+      realms: ['http://localhost:4205/user1/personal/'],
+    });
+  });
 });

packages/runtime-common/matrix-constants.ts

@@ -7,3 +7,4 @@ export const APP_BOXEL_REALM_SERVER_EVENT_MSGTYPE =
   'app.boxel.realm-server-event';
 export const APP_BOXEL_ROOM_SKILLS_EVENT_TYPE = 'app.boxel.room.skills';
 export const APP_BOXEL_REALMS_EVENT_TYPE = 'app.boxel.realms';
+export const LEGACY_APP_BOXEL_REALMS_EVENT_TYPE = 'com.cardstack.boxel.realms';