[PM-5979] Refactor EnvironmentService (#8040)

Refactor environment service to emit a single observable. This required significant changes to how the environment service behaves and tackles much of the tech debt planned for it.

libs/common/src/platform/abstractions/environment.service.ts

@@ -14,64 +14,119 @@ export type Urls = {
   scim?: string;
 };
 
-export type PayPalConfig = {
-  businessId?: string;
-  buttonAction?: string;
-};
-
+/**
+ * A subset of available regions, additional regions can be loaded through configuration.
+ */
 export enum Region {
   US = "US",
   EU = "EU",
   SelfHosted = "Self-hosted",
 }
 
-export enum RegionDomain {
-  US = "bitwarden.com",
-  EU = "bitwarden.eu",
-  USQA = "bitwarden.pw",
+/**
+ * The possible cloud regions.
+ */
+export type CloudRegion = Exclude<Region, Region.SelfHosted>;
+
+export type RegionConfig = {
+  // Beware this isn't completely true, it's actually a string for custom environments,
+  // which are currently only supported in web where it doesn't matter.
+  key: Region;
+  domain: string;
+  urls: Urls;
+};
+
+/**
+ * The Environment interface represents a server environment.
+ *
+ * It provides methods to retrieve the URLs of the different services.
+ */
+export interface Environment {
+  /**
+   * Retrieve the current region.
+   */
+  getRegion(): Region;
+  /**
+   * Retrieve the urls, should only be used when configuring the environment.
+   */
+  getUrls(): Urls;
+
+  /**
+   * Identify if the region is a cloud environment.
+   *
+   * @returns true if the environment is a cloud environment, false otherwise.
+   */
+  isCloud(): boolean;
+
+  getApiUrl(): string;
+  getEventsUrl(): string;
+  getIconsUrl(): string;
+  getIdentityUrl(): string;
+
+  /**
+   * @deprecated This is currently only used by the CLI. This functionality should be extracted since
+   * the CLI relies on changing environment mid-login.
+   *
+   * @remarks
+   * Expect this to be null unless the CLI has explicitly set it during the login flow.
+   */
+  getKeyConnectorUrl(): string | null;
+  getNotificationsUrl(): string;
+  getScimUrl(): string;
+  getSendUrl(): string;
+  getWebVaultUrl(): string;
+
+  /**
+   * Get a friendly hostname for the environment.
+   *
+   * - For self-hosted this is the web vault url without protocol prefix.
+   * - For cloud environments it's the domain key.
+   */
+  getHostname(): string;
+
+  // Not sure why we provide this, evaluate if we can remove it.
+  hasBaseUrl(): boolean;
 }
 
+/**
+ * The environment service. Provides access to set the current environment urls and region.
+ */
 export abstract class EnvironmentService {
-  urls: Observable<void>;
-  usUrls: Urls;
-  euUrls: Urls;
-  selectedRegion?: Region;
-  initialized = true;
+  abstract environment$: Observable<Environment>;
+  abstract cloudWebVaultUrl$: Observable<string>;
 
-  hasBaseUrl: () => boolean;
-  getNotificationsUrl: () => string;
-  getWebVaultUrl: () => string;
   /**
-   * Retrieves the URL of the cloud web vault app.
+   * Retrieve all the available regions for environment selectors.
    *
-   * @returns {string} The URL of the cloud web vault app.
-   * @remarks Use this method only in views exclusive to self-host instances.
+   * This currently relies on compile time provided constants, and will not change at runtime.
+   * Expect all builds to include production environments, QA builds to also include QA
+   * environments and dev builds to include localhost.
    */
-  getCloudWebVaultUrl: () => string;
+  abstract availableRegions(): RegionConfig[];
+
+  /**
+   * Set the global environment.
+   */
+  abstract setEnvironment(region: Region, urls?: Urls): Promise<Urls>;
+
+  /**
+   * Seed the environment state for a given user based on the global environment.
+   *
+   * @remarks
+   * Expected to be called only by the StateService when adding a new account.
+   */
+  abstract seedUserEnvironment(userId: UserId): Promise<void>;
+
   /**
    * Sets the URL of the cloud web vault app based on the region parameter.
    *
-   * @param {Region} region - The region of the cloud web vault app.
+   * @param userId - The user id to set the cloud web vault app URL for. If null or undefined the global environment is set.
+   * @param region - The region of the cloud web vault app.
    */
-  setCloudWebVaultUrl: (region: Region) => void;
+  abstract setCloudRegion(userId: UserId, region: Region): Promise<void>;
 
   /**
-   * Seed the environment for a given user based on the globally set defaults.
+   * Get the environment from state. Useful if you need to get the environment for another user.
    */
-  seedUserEnvironment: (userId: UserId) => Promise<void>;
-
-  getSendUrl: () => string;
-  getIconsUrl: () => string;
-  getApiUrl: () => string;
-  getIdentityUrl: () => string;
-  getEventsUrl: () => string;
-  getKeyConnectorUrl: () => string;
-  getScimUrl: () => string;
-  setUrlsFromStorage: () => Promise<void>;
-  setUrls: (urls: Urls) => Promise<Urls>;
-  getHost: (userId?: string) => Promise<string>;
-  setRegion: (region: Region) => Promise<void>;
-  getUrls: () => Urls;
-  isCloud: () => boolean;
-  isEmpty: () => boolean;
+  abstract getEnvironment(userId?: string): Promise<Environment | undefined>;
 }