Migrate OrganizationService to StateProvider (#7895)

libs/common/src/state-migrations/migrate.ts

@@ -35,6 +35,7 @@ import { AvatarColorMigrator } from "./migrations/37-move-avatar-color-to-state-
 import { TokenServiceStateProviderMigrator } from "./migrations/38-migrate-token-svc-to-state-provider";
 import { MoveBillingAccountProfileMigrator } from "./migrations/39-move-billing-account-profile-to-state-providers";
 import { RemoveEverBeenUnlockedMigrator } from "./migrations/4-remove-ever-been-unlocked";
+import { OrganizationMigrator } from "./migrations/40-move-organization-state-to-state-provider";
 import { AddKeyTypeToOrgKeysMigrator } from "./migrations/5-add-key-type-to-org-keys";
 import { RemoveLegacyEtmKeyMigrator } from "./migrations/6-remove-legacy-etm-key";
 import { MoveBiometricAutoPromptToAccount } from "./migrations/7-move-biometric-auto-prompt-to-account";
@@ -43,7 +44,7 @@ import { MoveBrowserSettingsToGlobal } from "./migrations/9-move-browser-setting
 import { MinVersionMigrator } from "./migrations/min-version";
 
 export const MIN_VERSION = 3;
-export const CURRENT_VERSION = 39;
+export const CURRENT_VERSION = 40;
 export type MinVersion = typeof MIN_VERSION;
 
 export function createMigrationBuilder() {
@@ -84,7 +85,8 @@ export function createMigrationBuilder() {
     .with(VaultSettingsKeyMigrator, 35, 36)
     .with(AvatarColorMigrator, 36, 37)
     .with(TokenServiceStateProviderMigrator, 37, 38)
-    .with(MoveBillingAccountProfileMigrator, 38, CURRENT_VERSION);
+    .with(MoveBillingAccountProfileMigrator, 38, 39)
+    .with(OrganizationMigrator, 39, CURRENT_VERSION);
 }
 
 export async function currentVersion(

libs/common/src/state-migrations/migrations/40-move-organization-state-to-state-provider.spec.ts

@@ -0,0 +1,183 @@
+import { any, MockProxy } from "jest-mock-extended";
+
+import { MigrationHelper } from "../migration-helper";
+import { mockMigrationHelper } from "../migration-helper.spec";
+
+import { OrganizationMigrator } from "./40-move-organization-state-to-state-provider";
+
+const testDate = new Date();
+function exampleOrganization1() {
+  return JSON.stringify({
+    id: "id",
+    name: "name",
+    status: 0,
+    type: 0,
+    enabled: false,
+    usePolicies: false,
+    useGroups: false,
+    useDirectory: false,
+    useEvents: false,
+    useTotp: false,
+    use2fa: false,
+    useApi: false,
+    useSso: false,
+    useKeyConnector: false,
+    useScim: false,
+    useCustomPermissions: false,
+    useResetPassword: false,
+    useSecretsManager: false,
+    usePasswordManager: false,
+    useActivateAutofillPolicy: false,
+    selfHost: false,
+    usersGetPremium: false,
+    seats: 0,
+    maxCollections: 0,
+    ssoBound: false,
+    identifier: "identifier",
+    resetPasswordEnrolled: false,
+    userId: "userId",
+    hasPublicAndPrivateKeys: false,
+    providerId: "providerId",
+    providerName: "providerName",
+    isProviderUser: false,
+    isMember: false,
+    familySponsorshipFriendlyName: "fsfn",
+    familySponsorshipAvailable: false,
+    planProductType: 0,
+    keyConnectorEnabled: false,
+    keyConnectorUrl: "kcu",
+    accessSecretsManager: false,
+    limitCollectionCreationDeletion: false,
+    allowAdminAccessToAllCollectionItems: false,
+    flexibleCollections: false,
+    familySponsorshipLastSyncDate: testDate,
+  });
+}
+
+function exampleJSON() {
+  return {
+    global: {
+      otherStuff: "otherStuff1",
+    },
+    authenticatedAccounts: ["user-1", "user-2"],
+    "user-1": {
+      data: {
+        organizations: {
+          "organization-id-1": exampleOrganization1(),
+          "organization-id-2": {
+            // ...
+          },
+        },
+        otherStuff: "overStuff2",
+      },
+      otherStuff: "otherStuff3",
+    },
+    "user-2": {
+      data: {
+        otherStuff: "otherStuff4",
+      },
+      otherStuff: "otherStuff5",
+    },
+  };
+}
+
+function rollbackJSON() {
+  return {
+    "user_user-1_organizations_organizations": {
+      "organization-id-1": exampleOrganization1(),
+      "organization-id-2": {
+        // ...
+      },
+    },
+    "user_user-2_organizations_organizations": null as any,
+    global: {
+      otherStuff: "otherStuff1",
+    },
+    authenticatedAccounts: ["user-1", "user-2"],
+    "user-1": {
+      data: {
+        otherStuff: "overStuff2",
+      },
+      otherStuff: "otherStuff3",
+    },
+    "user-2": {
+      data: {
+        otherStuff: "otherStuff4",
+      },
+      otherStuff: "otherStuff5",
+    },
+  };
+}
+
+describe("OrganizationMigrator", () => {
+  let helper: MockProxy<MigrationHelper>;
+  let sut: OrganizationMigrator;
+  const keyDefinitionLike = {
+    key: "organizations",
+    stateDefinition: {
+      name: "organizations",
+    },
+  };
+
+  describe("migrate", () => {
+    beforeEach(() => {
+      helper = mockMigrationHelper(exampleJSON(), 40);
+      sut = new OrganizationMigrator(39, 40);
+    });
+
+    it("should remove organizations from all accounts", async () => {
+      await sut.migrate(helper);
+      expect(helper.set).toHaveBeenCalledWith("user-1", {
+        data: {
+          otherStuff: "overStuff2",
+        },
+        otherStuff: "otherStuff3",
+      });
+    });
+
+    it("should set organizations value for each account", async () => {
+      await sut.migrate(helper);
+
+      expect(helper.setToUser).toHaveBeenCalledWith("user-1", keyDefinitionLike, {
+        "organization-id-1": exampleOrganization1(),
+        "organization-id-2": {
+          // ...
+        },
+      });
+    });
+  });
+
+  describe("rollback", () => {
+    beforeEach(() => {
+      helper = mockMigrationHelper(rollbackJSON(), 40);
+      sut = new OrganizationMigrator(39, 40);
+    });
+
+    it.each(["user-1", "user-2"])("should null out new values", async (userId) => {
+      await sut.rollback(helper);
+      expect(helper.setToUser).toHaveBeenCalledWith(userId, keyDefinitionLike, null);
+    });
+
+    it("should add explicit value back to accounts", async () => {
+      await sut.rollback(helper);
+
+      expect(helper.set).toHaveBeenCalledWith("user-1", {
+        data: {
+          organizations: {
+            "organization-id-1": exampleOrganization1(),
+            "organization-id-2": {
+              // ...
+            },
+          },
+          otherStuff: "overStuff2",
+        },
+        otherStuff: "otherStuff3",
+      });
+    });
+
+    it("should not try to restore values to missing accounts", async () => {
+      await sut.rollback(helper);
+      expect(helper.set).not.toHaveBeenCalledWith("user-3", any());
+    });
+  });
+});

libs/common/src/state-migrations/migrations/40-move-organization-state-to-state-provider.ts

@@ -0,0 +1,148 @@
+import { Jsonify } from "type-fest";
+
+import { KeyDefinitionLike, MigrationHelper } from "../migration-helper";
+import { Migrator } from "../migrator";
+
+// Local declarations of `OrganizationData` and the types of it's properties.
+// Duplicated to remain frozen in time when migration occurs.
+enum OrganizationUserStatusType {
+  Invited = 0,
+  Accepted = 1,
+  Confirmed = 2,
+  Revoked = -1,
+}
+
+enum OrganizationUserType {
+  Owner = 0,
+  Admin = 1,
+  User = 2,
+  Manager = 3,
+  Custom = 4,
+}
+
+type PermissionsApi = {
+  accessEventLogs: boolean;
+  accessImportExport: boolean;
+  accessReports: boolean;
+  createNewCollections: boolean;
+  editAnyCollection: boolean;
+  deleteAnyCollection: boolean;
+  editAssignedCollections: boolean;
+  deleteAssignedCollections: boolean;
+  manageCiphers: boolean;
+  manageGroups: boolean;
+  manageSso: boolean;
+  managePolicies: boolean;
+  manageUsers: boolean;
+  manageResetPassword: boolean;
+  manageScim: boolean;
+};
+
+enum ProviderType {
+  Msp = 0,
+  Reseller = 1,
+}
+
+enum ProductType {
+  Free = 0,
+  Families = 1,
+  Teams = 2,
+  Enterprise = 3,
+  TeamsStarter = 4,
+}
+
+type OrganizationData = {
+  id: string;
+  name: string;
+  status: OrganizationUserStatusType;
+  type: OrganizationUserType;
+  enabled: boolean;
+  usePolicies: boolean;
+  useGroups: boolean;
+  useDirectory: boolean;
+  useEvents: boolean;
+  useTotp: boolean;
+  use2fa: boolean;
+  useApi: boolean;
+  useSso: boolean;
+  useKeyConnector: boolean;
+  useScim: boolean;
+  useCustomPermissions: boolean;
+  useResetPassword: boolean;
+  useSecretsManager: boolean;
+  usePasswordManager: boolean;
+  useActivateAutofillPolicy: boolean;
+  selfHost: boolean;
+  usersGetPremium: boolean;
+  seats: number;
+  maxCollections: number;
+  maxStorageGb?: number;
+  ssoBound: boolean;
+  identifier: string;
+  permissions: PermissionsApi;
+  resetPasswordEnrolled: boolean;
+  userId: string;
+  hasPublicAndPrivateKeys: boolean;
+  providerId: string;
+  providerName: string;
+  providerType?: ProviderType;
+  isProviderUser: boolean;
+  isMember: boolean;
+  familySponsorshipFriendlyName: string;
+  familySponsorshipAvailable: boolean;
+  planProductType: ProductType;
+  keyConnectorEnabled: boolean;
+  keyConnectorUrl: string;
+  familySponsorshipLastSyncDate?: Date;
+  familySponsorshipValidUntil?: Date;
+  familySponsorshipToDelete?: boolean;
+  accessSecretsManager: boolean;
+  limitCollectionCreationDeletion: boolean;
+  allowAdminAccessToAllCollectionItems: boolean;
+  flexibleCollections: boolean;
+};
+
+type ExpectedAccountType = {
+  data?: {
+    organizations?: Record<string, Jsonify<OrganizationData>>;
+  };
+};
+
+const USER_ORGANIZATIONS: KeyDefinitionLike = {
+  key: "organizations",
+  stateDefinition: {
+    name: "organizations",
+  },
+};
+
+export class OrganizationMigrator extends Migrator<39, 40> {
+  async migrate(helper: MigrationHelper): Promise<void> {
+    const accounts = await helper.getAccounts<ExpectedAccountType>();
+    async function migrateAccount(userId: string, account: ExpectedAccountType): Promise<void> {
+      const value = account?.data?.organizations;
+      if (value != null) {
+        await helper.setToUser(userId, USER_ORGANIZATIONS, value);
+        delete account.data.organizations;
+        await helper.set(userId, account);
+      }
+    }
+
+    await Promise.all(accounts.map(({ userId, account }) => migrateAccount(userId, account)));
+  }
+
+  async rollback(helper: MigrationHelper): Promise<void> {
+    const accounts = await helper.getAccounts<ExpectedAccountType>();
+    async function rollbackAccount(userId: string, account: ExpectedAccountType): Promise<void> {
+      const value = await helper.getFromUser(userId, USER_ORGANIZATIONS);
+      if (account) {
+        account.data = Object.assign(account.data ?? {}, {
+          organizations: value,
+        });
+        await helper.set(userId, account);
+      }
+      await helper.setToUser(userId, USER_ORGANIZATIONS, null);
+    }
+
+    await Promise.all(accounts.map(({ userId, account }) => rollbackAccount(userId, account)));
+  }
+}