[PM-6568][PM-8820][Tech-Debt] Migrate all tools owned toasts to use CL ToastService instead of PlatformUtilsService (#9405)

* Migrate all tools owned toasts to use CL ToastService instead of PlatformUtilsService * Fix test that was missing a mock * Fix double checking file and file-content selection --------- Co-authored-by: Daniel James Smith <djsmith85@users.noreply.github.com>
2025-12-15 15:53:27 +00:00 · 2024-06-19 18:28:47 +02:00
parent 88cc37e37f
commit 8d04731633
25 changed files with 197 additions and 128 deletions
--- a/libs/angular/src/tools/generator/components/generator.component.ts
+++ b/libs/angular/src/tools/generator/components/generator.component.ts
@@ -19,6 +19,7 @@ import {
  UsernameGeneratorOptions,
 } from "@bitwarden/common/tools/generator/username";
 import { EmailForwarderOptions } from "@bitwarden/common/tools/models/domain/email-forwarder-options";
+import { ToastService } from "@bitwarden/components";

@Directive()
 export class GeneratorComponent implements OnInit, OnDestroy {
@@ -67,6 +68,7 @@ export class GeneratorComponent implements OnInit, OnDestroy {
    protected route: ActivatedRoute,
    protected ngZone: NgZone,
    private win: Window,
+    protected toastService: ToastService,
  ) {
    this.typeOptions = [
      { name: i18nService.t("password"), value: "password" },
@@ -317,11 +319,14 @@ export class GeneratorComponent implements OnInit, OnDestroy {
      password ? this.password : this.username,
      copyOptions,
    );
-    this.platformUtilsService.showToast(
-      "info",
-      null,
-      this.i18nService.t("valueCopied", this.i18nService.t(password ? "password" : "username")),
-    );
+    this.toastService.showToast({
+      variant: "info",
+      title: null,
+      message: this.i18nService.t(
+        "valueCopied",
+        this.i18nService.t(password ? "password" : "username"),
+      ),
+    });
  }

  select() {
--- a/libs/angular/src/tools/generator/components/password-generator-history.component.ts
+++ b/libs/angular/src/tools/generator/components/password-generator-history.component.ts
@@ -6,6 +6,7 @@ import {
  GeneratedPasswordHistory,
  PasswordGenerationServiceAbstraction,
 } from "@bitwarden/common/tools/generator/password";
+import { ToastService } from "@bitwarden/components";

@Directive()
 export class PasswordGeneratorHistoryComponent implements OnInit {
@@ -16,6 +17,7 @@ export class PasswordGeneratorHistoryComponent implements OnInit {
    protected platformUtilsService: PlatformUtilsService,
    protected i18nService: I18nService,
    private win: Window,
+    protected toastService: ToastService,
  ) {}

  async ngOnInit() {
@@ -29,10 +31,10 @@ export class PasswordGeneratorHistoryComponent implements OnInit {
  copy(password: string) {
    const copyOptions = this.win != null ? { window: this.win } : null;
    this.platformUtilsService.copyToClipboard(password, copyOptions);
-    this.platformUtilsService.showToast(
-      "info",
-      null,
-      this.i18nService.t("valueCopied", this.i18nService.t("password")),
-    );
+    this.toastService.showToast({
+      variant: "info",
+      title: null,
+      message: this.i18nService.t("valueCopied", this.i18nService.t("password")),
+    });
  }
 }
--- a/libs/angular/src/tools/send/add-edit.component.ts
+++ b/libs/angular/src/tools/send/add-edit.component.ts
@@ -22,7 +22,7 @@ import { SendTextView } from "@bitwarden/common/tools/send/models/view/send-text
 import { SendView } from "@bitwarden/common/tools/send/models/view/send.view";
 import { SendApiService } from "@bitwarden/common/tools/send/services/send-api.service.abstraction";
 import { SendService } from "@bitwarden/common/tools/send/services/send.service.abstraction";
-import { DialogService } from "@bitwarden/components";
+import { DialogService, ToastService } from "@bitwarden/components";

 // Value = hours
 enum DatePreset {
@@ -120,6 +120,7 @@ export class AddEditComponent implements OnInit, OnDestroy {
    protected formBuilder: FormBuilder,
    protected billingAccountProfileStateService: BillingAccountProfileStateService,
    protected accountService: AccountService,
+    protected toastService: ToastService,
  ) {
    this.typeOptions = [
      { name: i18nService.t("sendTypeFile"), value: SendType.File, premium: true },
@@ -269,11 +270,11 @@ export class AddEditComponent implements OnInit, OnDestroy {
    this.formGroup.markAllAsTouched();

    if (this.disableSend) {
-      this.platformUtilsService.showToast(
-        "error",
-        this.i18nService.t("errorOccurred"),
-        this.i18nService.t("sendDisabledWarning"),
-      );
+      this.toastService.showToast({
+        variant: "error",
+        title: this.i18nService.t("errorOccurred"),
+        message: this.i18nService.t("sendDisabledWarning"),
+      });
      return false;
    }

@@ -289,11 +290,11 @@ export class AddEditComponent implements OnInit, OnDestroy {
    this.send.type = this.type;

    if (Utils.isNullOrWhitespace(this.send.name)) {
-      this.platformUtilsService.showToast(
-        "error",
-        this.i18nService.t("errorOccurred"),
-        this.i18nService.t("nameRequired"),
-      );
+      this.toastService.showToast({
+        variant: "error",
+        title: this.i18nService.t("errorOccurred"),
+        message: this.i18nService.t("nameRequired"),
+      });
      return false;
    }

@@ -302,22 +303,22 @@ export class AddEditComponent implements OnInit, OnDestroy {
      const fileEl = document.getElementById("file") as HTMLInputElement;
      const files = fileEl.files;
      if (files == null || files.length === 0) {
-        this.platformUtilsService.showToast(
-          "error",
-          this.i18nService.t("errorOccurred"),
-          this.i18nService.t("selectFile"),
-        );
+        this.toastService.showToast({
+          variant: "error",
+          title: this.i18nService.t("errorOccurred"),
+          message: this.i18nService.t("selectFile"),
+        });
        return;
      }

      file = files[0];
      if (files[0].size > 524288000) {
        // 500 MB
-        this.platformUtilsService.showToast(
-          "error",
-          this.i18nService.t("errorOccurred"),
-          this.i18nService.t("maxFileSize"),
-        );
+        this.toastService.showToast({
+          variant: "error",
+          title: this.i18nService.t("errorOccurred"),
+          message: this.i18nService.t("maxFileSize"),
+        });
        return;
      }
    }
@@ -340,11 +341,11 @@ export class AddEditComponent implements OnInit, OnDestroy {
        await this.handleCopyLinkToClipboard();
        return;
      }
-      this.platformUtilsService.showToast(
-        "success",
-        null,
-        this.i18nService.t(this.editMode ? "editedSend" : "createdSend"),
-      );
+      this.toastService.showToast({
+        variant: "success",
+        title: null,
+        message: this.i18nService.t(this.editMode ? "editedSend" : "createdSend"),
+      });
    });
    try {
      await this.formPromise;
@@ -377,7 +378,11 @@ export class AddEditComponent implements OnInit, OnDestroy {
    try {
      this.deletePromise = this.sendApiService.delete(this.send.id);
      await this.deletePromise;
-      this.platformUtilsService.showToast("success", null, this.i18nService.t("deletedSend"));
+      this.toastService.showToast({
+        variant: "success",
+        title: null,
+        message: this.i18nService.t("deletedSend"),
+      });
      await this.load();
      this.onDeletedSend.emit(this.send);
      return true;
@@ -470,11 +475,11 @@ export class AddEditComponent implements OnInit, OnDestroy {
  private async handleCopyLinkToClipboard() {
    const copySuccess = await this.copyLinkToClipboard(this.link);
    if (copySuccess ?? true) {
-      this.platformUtilsService.showToast(
-        "success",
-        null,
-        this.i18nService.t(this.editMode ? "editedSend" : "createdSend"),
-      );
+      this.toastService.showToast({
+        variant: "success",
+        title: null,
+        message: this.i18nService.t(this.editMode ? "editedSend" : "createdSend"),
+      });
    } else {
      await this.dialogService.openSimpleDialog({
        title: "",
--- a/libs/angular/src/tools/send/send.component.ts
+++ b/libs/angular/src/tools/send/send.component.ts
@@ -20,7 +20,7 @@ import { SendType } from "@bitwarden/common/tools/send/enums/send-type";
 import { SendView } from "@bitwarden/common/tools/send/models/view/send.view";
 import { SendApiService } from "@bitwarden/common/tools/send/services/send-api.service.abstraction";
 import { SendService } from "@bitwarden/common/tools/send/services/send.service.abstraction";
-import { DialogService } from "@bitwarden/components";
+import { DialogService, ToastService } from "@bitwarden/components";

@Directive()
 export class SendComponent implements OnInit, OnDestroy {
@@ -76,6 +76,7 @@ export class SendComponent implements OnInit, OnDestroy {
    private logService: LogService,
    protected sendApiService: SendApiService,
    protected dialogService: DialogService,
+    protected toastService: ToastService,
  ) {}

  async ngOnInit() {
@@ -186,7 +187,11 @@ export class SendComponent implements OnInit, OnDestroy {
        this.onSuccessfulRemovePassword();
      } else {
        // Default actions
-        this.platformUtilsService.showToast("success", null, this.i18nService.t("removedPassword"));
+        this.toastService.showToast({
+          variant: "success",
+          title: null,
+          message: this.i18nService.t("removedPassword"),
+        });
        await this.load();
      }
    } catch (e) {
@@ -220,7 +225,11 @@ export class SendComponent implements OnInit, OnDestroy {
        this.onSuccessfulDelete();
      } else {
        // Default actions
-        this.platformUtilsService.showToast("success", null, this.i18nService.t("deletedSend"));
+        this.toastService.showToast({
+          variant: "success",
+          title: null,
+          message: this.i18nService.t("deletedSend"),
+        });
        await this.refresh();
      }
    } catch (e) {
@@ -234,11 +243,11 @@ export class SendComponent implements OnInit, OnDestroy {
    const env = await firstValueFrom(this.environmentService.environment$);
    const link = env.getSendUrl() + s.accessId + "/" + s.urlB64Key;
    this.platformUtilsService.copyToClipboard(link);
-    this.platformUtilsService.showToast(
-      "success",
-      null,
-      this.i18nService.t("valueCopied", this.i18nService.t("sendLink")),
-    );
+    this.toastService.showToast({
+      variant: "success",
+      title: null,
+      message: this.i18nService.t("valueCopied", this.i18nService.t("sendLink")),
+    });
  }

  searchTextChanged() {
--- a/libs/importer/src/components/import.component.ts
+++ b/libs/importer/src/components/import.component.ts
@@ -48,6 +48,7 @@ import {
  IconButtonModule,
  RadioButtonModule,
  SelectModule,
+  ToastService,
 } from "@bitwarden/components";

 import { ImportOption, ImportResult, ImportType } from "../models";
@@ -191,6 +192,7 @@ export class ImportComponent implements OnInit, OnDestroy {
    @Inject(ImportCollectionServiceAbstraction)
    @Optional()
    protected importCollectionService: ImportCollectionServiceAbstraction,
+    protected toastService: ToastService,
  ) {}

  protected get importBlockedByPolicy(): boolean {
@@ -336,22 +338,22 @@ export class ImportComponent implements OnInit, OnDestroy {
    );

    if (importer === null) {
-      this.platformUtilsService.showToast(
-        "error",
-        this.i18nService.t("errorOccurred"),
-        this.i18nService.t("selectFormat"),
-      );
+      this.toastService.showToast({
+        variant: "error",
+        title: this.i18nService.t("errorOccurred"),
+        message: this.i18nService.t("selectFormat"),
+      });
      return;
    }

    const importContents = await this.setImportContents();

    if (importContents == null || importContents === "") {
-      this.platformUtilsService.showToast(
-        "error",
-        this.i18nService.t("errorOccurred"),
-        this.i18nService.t("selectFile"),
-      );
+      this.toastService.showToast({
+        variant: "error",
+        title: this.i18nService.t("errorOccurred"),
+        message: this.i18nService.t("selectFile"),
+      });
      return;
    }

@@ -502,11 +504,11 @@ export class ImportComponent implements OnInit, OnDestroy {
    }

    if (this.importBlockedByPolicy && this.organizationId == null) {
-      this.platformUtilsService.showToast(
-        "error",
-        null,
-        this.i18nService.t("personalOwnershipPolicyInEffectImports"),
-      );
+      this.toastService.showToast({
+        variant: "error",
+        title: null,
+        message: this.i18nService.t("personalOwnershipPolicyInEffectImports"),
+      });
      return false;
    }

@@ -517,14 +519,6 @@ export class ImportComponent implements OnInit, OnDestroy {
    const fileEl = document.getElementById("import_input_file") as HTMLInputElement;
    const files = fileEl.files;
    let fileContents = this.formGroup.controls.fileContents.value;
-    if ((files == null || files.length === 0) && (fileContents == null || fileContents === "")) {
-      this.platformUtilsService.showToast(
-        "error",
-        this.i18nService.t("errorOccurred"),
-        this.i18nService.t("selectFile"),
-      );
-      return;
-    }

    if (files != null && files.length > 0) {
      try {
--- a/libs/tools/export/vault-export/vault-export-ui/src/components/export.component.ts
+++ b/libs/tools/export/vault-export/vault-export-ui/src/components/export.component.ts
@@ -15,7 +15,6 @@ import { EventType } from "@bitwarden/common/enums";
 import { FileDownloadService } from "@bitwarden/common/platform/abstractions/file-download/file-download.service";
 import { I18nService } from "@bitwarden/common/platform/abstractions/i18n.service";
 import { LogService } from "@bitwarden/common/platform/abstractions/log.service";
-import { PlatformUtilsService } from "@bitwarden/common/platform/abstractions/platform-utils.service";
 import { Utils } from "@bitwarden/common/platform/misc/utils";
 import { EncryptedExportType } from "@bitwarden/common/tools/enums/encrypted-export-type.enum";
 import {
@@ -28,6 +27,7 @@ import {
  IconButtonModule,
  RadioButtonModule,
  SelectModule,
+  ToastService,
 } from "@bitwarden/components";
 import { VaultExportServiceAbstraction } from "@bitwarden/vault-export-core";

@@ -123,7 +123,7 @@ export class ExportComponent implements OnInit, OnDestroy {

  constructor(
    protected i18nService: I18nService,
-    protected platformUtilsService: PlatformUtilsService,
+    protected toastService: ToastService,
    protected exportService: VaultExportServiceAbstraction,
    protected eventCollectionService: EventCollectionService,
    private policyService: PolicyService,
@@ -222,11 +222,11 @@ export class ExportComponent implements OnInit, OnDestroy {

  submit = async () => {
    if (this.isFileEncryptedExport && this.filePassword != this.confirmFilePassword) {
-      this.platformUtilsService.showToast(
-        "error",
-        this.i18nService.t("errorOccurred"),
-        this.i18nService.t("filePasswordAndConfirmFilePasswordDoNotMatch"),
-      );
+      this.toastService.showToast({
+        variant: "error",
+        title: this.i18nService.t("errorOccurred"),
+        message: this.i18nService.t("filePasswordAndConfirmFilePasswordDoNotMatch"),
+      });
      return;
    }

@@ -236,11 +236,11 @@ export class ExportComponent implements OnInit, OnDestroy {
    }

    if (this.disabledByPolicy) {
-      this.platformUtilsService.showToast(
-        "error",
-        null,
-        this.i18nService.t("personalVaultExportPolicyInEffect"),
-      );
+      this.toastService.showToast({
+        variant: "error",
+        title: null,
+        message: this.i18nService.t("personalVaultExportPolicyInEffect"),
+      });
      return;
    }