[PM-17120] account deprovisioning banner #13097
+171
−78
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| 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(); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| 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, | ||
|
Check warning on line 14 in apps/web/src/app/admin-console/organizations/layouts/services/account-deprovisioning-banner.service.ts
|
||
| 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; | ||
| }); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -37,25 +37,5 @@ | |
| ></bit-nav-item> | ||
| </app-side-nav> | ||
|
|
||
| <router-outlet></router-outlet> | ||
| </app-layout> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should add tests here. Abstracting this into a pure function will reduce test setup effort.