[PM-17148] Remove banner and state, migrate state (#14882)

* remove banner and state, migrate state

* add migration, bump version

apps/web/src/app/admin-console/organizations/layouts/organization-layout.component.html

@@ -139,22 +139,6 @@
   </app-side-nav>
 
   <ng-container *ngIf="organization$ | async as organization">
-    <bit-banner
-      *ngIf="showAccountDeprovisioningBanner$ | async"
-      (onClose)="bannerService.hideBanner(organization)"
-      class="-tw-m-6 tw-flex tw-flex-col tw-pb-6"
-    >
-      {{ "accountDeprovisioningNotification" | i18n }}
-      <a
-        href="https://bitwarden.com/help/claimed-accounts"
-        bitLink
-        linkType="contrast"
-        target="_blank"
-        rel="noreferrer"
-      >
-        {{ "learnMore" | i18n }}
-      </a>
-    </bit-banner>
     <bit-banner
       *ngIf="organization.isProviderUser"
       [showClose]="false"

apps/web/src/app/admin-console/organizations/layouts/organization-layout.component.ts

@@ -23,7 +23,6 @@ import { Organization } from "@bitwarden/common/admin-console/models/domain/orga
 import { AccountService } from "@bitwarden/common/auth/abstractions/account.service";
 import { getUserId } from "@bitwarden/common/auth/services/account.service";
 import { OrganizationBillingServiceAbstraction } from "@bitwarden/common/billing/abstractions";
-import { ProductTierType } from "@bitwarden/common/billing/enums";
 import { FeatureFlag } from "@bitwarden/common/enums/feature-flag.enum";
 import { ConfigService } from "@bitwarden/common/platform/abstractions/config/config.service";
 import { PlatformUtilsService } from "@bitwarden/common/platform/abstractions/platform-utils.service";
@@ -35,8 +34,6 @@ import { OrgSwitcherComponent } from "../../../layouts/org-switcher/org-switcher
 import { WebLayoutModule } from "../../../layouts/web-layout.module";
 import { AdminConsoleLogo } from "../../icons/admin-console-logo";
 
-import { AccountDeprovisioningBannerService } from "./services/account-deprovisioning-banner.service";
-
 @Component({
   selector: "app-organization-layout",
   templateUrl: "organization-layout.component.html",
@@ -65,7 +62,6 @@ export class OrganizationLayoutComponent implements OnInit {
   organizationIsUnmanaged$: Observable<boolean>;
   enterpriseOrganization$: Observable<boolean>;
 
-  showAccountDeprovisioningBanner$: Observable<boolean>;
   protected isBreadcrumbEventLogsEnabled$: Observable<boolean>;
   protected showSponsoredFamiliesDropdown$: Observable<boolean>;
   protected canShowPoliciesTab$: Observable<boolean>;
@@ -77,7 +73,6 @@ export class OrganizationLayoutComponent implements OnInit {
     private configService: ConfigService,
     private policyService: PolicyService,
     private providerService: ProviderService,
-    protected bannerService: AccountDeprovisioningBannerService,
     private accountService: AccountService,
     private freeFamiliesPolicyService: FreeFamiliesPolicyService,
     private organizationBillingService: OrganizationBillingServiceAbstraction,
@@ -100,20 +95,6 @@ export class OrganizationLayoutComponent implements OnInit {
     this.showSponsoredFamiliesDropdown$ =
       this.freeFamiliesPolicyService.showSponsoredFamiliesDropdown$(this.organization$);
 
-    this.showAccountDeprovisioningBanner$ = combineLatest([
-      this.bannerService.showBanner$,
-      this.configService.getFeatureFlag$(FeatureFlag.AccountDeprovisioningBanner),
-      this.organization$,
-    ]).pipe(
-      map(
-        ([dismissedOrgs, featureFlagEnabled, organization]) =>
-          organization.productTierType === ProductTierType.Enterprise &&
-          organization.isAdmin &&
-          !dismissedOrgs?.includes(organization.id) &&
-          featureFlagEnabled,
-      ),
-    );
-
     this.canAccessExport$ = this.organization$.pipe(map((org) => org.canAccessExport));
 
     this.showPaymentAndHistory$ = this.organization$.pipe(

apps/web/src/app/admin-console/organizations/layouts/services/account-deprovisioning-banner.service.spec.ts

@@ -1,75 +0,0 @@
-import { firstValueFrom } from "rxjs";
-
-import { Organization } from "@bitwarden/common/admin-console/models/domain/organization";
-import { Utils } from "@bitwarden/common/platform/misc/utils";
-import {
-  FakeAccountService,
-  FakeStateProvider,
-  mockAccountServiceWith,
-} from "@bitwarden/common/spec";
-import { UserId } from "@bitwarden/common/types/guid";
-
-import { AccountDeprovisioningBannerService } from "./account-deprovisioning-banner.service";
-
-describe("Account Deprovisioning Banner Service", () => {
-  const userId = Utils.newGuid() as UserId;
-  let accountService: FakeAccountService;
-  let stateProvider: FakeStateProvider;
-  let bannerService: AccountDeprovisioningBannerService;
-
-  beforeEach(async () => {
-    accountService = mockAccountServiceWith(userId);
-    stateProvider = new FakeStateProvider(accountService);
-    bannerService = new AccountDeprovisioningBannerService(stateProvider);
-  });
-
-  it("updates state with single org", async () => {
-    const fakeOrg = new Organization();
-    fakeOrg.id = "123";
-
-    await bannerService.hideBanner(fakeOrg);
-    const state = await firstValueFrom(bannerService.showBanner$);
-
-    expect(state).toEqual([fakeOrg.id]);
-  });
-
-  it("updates state with multiple orgs", async () => {
-    const fakeOrg1 = new Organization();
-    fakeOrg1.id = "123";
-    const fakeOrg2 = new Organization();
-    fakeOrg2.id = "234";
-    const fakeOrg3 = new Organization();
-    fakeOrg3.id = "987";
-
-    await bannerService.hideBanner(fakeOrg1);
-    await bannerService.hideBanner(fakeOrg2);
-    await bannerService.hideBanner(fakeOrg3);
-
-    const state = await firstValueFrom(bannerService.showBanner$);
-
-    expect(state).toContain(fakeOrg1.id);
-    expect(state).toContain(fakeOrg2.id);
-    expect(state).toContain(fakeOrg3.id);
-  });
-
-  it("does not add the same org id multiple times", async () => {
-    const fakeOrg = new Organization();
-    fakeOrg.id = "123";
-
-    await bannerService.hideBanner(fakeOrg);
-    await bannerService.hideBanner(fakeOrg);
-
-    const state = await firstValueFrom(bannerService.showBanner$);
-
-    expect(state).toEqual([fakeOrg.id]);
-  });
-
-  it("does not add null to the state", async () => {
-    await bannerService.hideBanner(null as unknown as Organization);
-    await bannerService.hideBanner(undefined as unknown as Organization);
-
-    const state = await firstValueFrom(bannerService.showBanner$);
-
-    expect(state).toBeNull();
-  });
-});

apps/web/src/app/admin-console/organizations/layouts/services/account-deprovisioning-banner.service.ts

@@ -1,40 +0,0 @@
-import { Injectable } from "@angular/core";
-
-import { Organization } from "@bitwarden/common/admin-console/models/domain/organization";
-import {
-  ACCOUNT_DEPROVISIONING_BANNER_DISK,
-  StateProvider,
-  UserKeyDefinition,
-} from "@bitwarden/common/platform/state";
-
-export const SHOW_BANNER_KEY = new UserKeyDefinition<string[]>(
-  ACCOUNT_DEPROVISIONING_BANNER_DISK,
-  "accountDeprovisioningBanner",
-  {
-    deserializer: (b) => b,
-    clearOn: [],
-  },
-);
-
-@Injectable({ providedIn: "root" })
-export class AccountDeprovisioningBannerService {
-  private _showBanner = this.stateProvider.getActive(SHOW_BANNER_KEY);
-
-  showBanner$ = this._showBanner.state$;
-
-  constructor(private stateProvider: StateProvider) {}
-
-  async hideBanner(organization: Organization) {
-    await this._showBanner.update((state) => {
-      if (!organization) {
-        return state;
-      }
-      if (!state) {
-        return [organization.id];
-      } else if (!state.includes(organization.id)) {
-        return [...state, organization.id];
-      }
-      return state;
-    });
-  }
-}

libs/common/src/enums/feature-flag.enum.ts

@@ -12,7 +12,6 @@ import { ServerConfig } from "../platform/abstractions/config/server-config";
 export enum FeatureFlag {
   /* Admin Console Team */
   LimitItemDeletion = "pm-15493-restrict-item-deletion-to-can-manage-permission",
-  AccountDeprovisioningBanner = "pm-17120-account-deprovisioning-admin-console-banner",
   SeparateCustomRolePermissions = "pm-19917-separate-custom-role-permissions",
 
   /* Auth */
@@ -82,7 +81,6 @@ const FALSE = false as boolean;
 export const DefaultFeatureFlagValue = {
   /* Admin Console Team */
   [FeatureFlag.LimitItemDeletion]: FALSE,
-  [FeatureFlag.AccountDeprovisioningBanner]: FALSE,
   [FeatureFlag.SeparateCustomRolePermissions]: FALSE,
 
   /* Autofill */

libs/common/src/platform/state/state-definitions.ts

@@ -29,13 +29,6 @@ export const ORGANIZATION_MANAGEMENT_PREFERENCES_DISK = new StateDefinition(
     web: "disk-local",
   },
 );
-export const ACCOUNT_DEPROVISIONING_BANNER_DISK = new StateDefinition(
-  "showAccountDeprovisioningBanner",
-  "disk",
-  {
-    web: "disk-local",
-  },
-);
 export const DELETE_MANAGED_USER_WARNING = new StateDefinition(
   "showDeleteManagedUserWarning",
   "disk",

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

@@ -70,12 +70,13 @@ import { MigrateIncorrectFolderKey } from "./migrations/69-migrate-incorrect-fol
 import { MoveBiometricAutoPromptToAccount } from "./migrations/7-move-biometric-auto-prompt-to-account";
 import { RemoveAcBannersDismissed } from "./migrations/70-remove-ac-banner-dismissed";
 import { RemoveNewCustomizationOptionsCalloutDismissed } from "./migrations/71-remove-new-customization-options-callout-dismissed";
+import { RemoveAccountDeprovisioningBannerDismissed } from "./migrations/72-remove-account-deprovisioning-banner-dismissed";
 import { MoveStateVersionMigrator } from "./migrations/8-move-state-version";
 import { MoveBrowserSettingsToGlobal } from "./migrations/9-move-browser-settings-to-global";
 import { MinVersionMigrator } from "./migrations/min-version";
 
 export const MIN_VERSION = 3;
-export const CURRENT_VERSION = 71;
+export const CURRENT_VERSION = 72;
 export type MinVersion = typeof MIN_VERSION;
 
 export function createMigrationBuilder() {
@@ -148,7 +149,8 @@ export function createMigrationBuilder() {
     .with(MoveLastSyncDate, 67, 68)
     .with(MigrateIncorrectFolderKey, 68, 69)
     .with(RemoveAcBannersDismissed, 69, 70)
-    .with(RemoveNewCustomizationOptionsCalloutDismissed, 70, CURRENT_VERSION);
+    .with(RemoveNewCustomizationOptionsCalloutDismissed, 70, 71)
+    .with(RemoveAccountDeprovisioningBannerDismissed, 71, CURRENT_VERSION);
 }
 
 export async function currentVersion(

libs/common/src/state-migrations/migrations/72-remove-account-deprovisioning-banner-dismissed.spec.ts

@@ -0,0 +1,50 @@
+import { runMigrator } from "../migration-helper.spec";
+import { IRREVERSIBLE } from "../migrator";
+
+import { RemoveAccountDeprovisioningBannerDismissed } from "./72-remove-account-deprovisioning-banner-dismissed";
+
+describe("RemoveAcBannersDismissed", () => {
+  const sut = new RemoveAccountDeprovisioningBannerDismissed(71, 72);
+
+  describe("migrate", () => {
+    it("deletes account deprovisioning banner from all users", async () => {
+      const output = await runMigrator(sut, {
+        global_account_accounts: {
+          user1: {
+            email: "user1@email.com",
+            name: "User 1",
+            emailVerified: true,
+          },
+          user2: {
+            email: "user2@email.com",
+            name: "User 2",
+            emailVerified: true,
+          },
+        },
+        user_user1_accountDeprovisioningBanner_showAccountDeprovisioningBanner: true,
+        user_user2_accountDeprovisioningBanner_showAccountDeprovisioningBanner: true,
+      });
+
+      expect(output).toEqual({
+        global_account_accounts: {
+          user1: {
+            email: "user1@email.com",
+            name: "User 1",
+            emailVerified: true,
+          },
+          user2: {
+            email: "user2@email.com",
+            name: "User 2",
+            emailVerified: true,
+          },
+        },
+      });
+    });
+  });
+
+  describe("rollback", () => {
+    it("is irreversible", async () => {
+      await expect(runMigrator(sut, {}, "rollback")).rejects.toThrow(IRREVERSIBLE);
+    });
+  });
+});

libs/common/src/state-migrations/migrations/72-remove-account-deprovisioning-banner-dismissed.ts

@@ -0,0 +1,23 @@
+import { KeyDefinitionLike, MigrationHelper } from "../migration-helper";
+import { IRREVERSIBLE, Migrator } from "../migrator";
+
+export const SHOW_BANNER_KEY: KeyDefinitionLike = {
+  key: "showAccountDeprovisioningBanner",
+  stateDefinition: { name: "accountDeprovisioningBanner" },
+};
+
+export class RemoveAccountDeprovisioningBannerDismissed extends Migrator<71, 72> {
+  async migrate(helper: MigrationHelper): Promise<void> {
+    await Promise.all(
+      (await helper.getAccounts()).map(async ({ userId }) => {
+        if (helper.getFromUser(userId, SHOW_BANNER_KEY) != null) {
+          await helper.removeFromUser(userId, SHOW_BANNER_KEY);
+        }
+      }),
+    );
+  }
+
+  async rollback(helper: MigrationHelper): Promise<void> {
+    throw IRREVERSIBLE;
+  }
+}