[PM-3503] Add AnonAddy self-hosted server URL support (#1498)

Author: andrebispo5

BitwardenShared/Core/Platform/Models/Enum/FeatureFlag.swift

@@ -8,6 +8,9 @@ enum FeatureFlag: String, CaseIterable, Codable {
     /// A feature flag to enable/disable account deprovisioning.
     case accountDeprovisioning = "pm-10308-account-deprovisioning"
 
+    /// A feature flag to enable/disable the ability to add a custom domain for anonAddy users.
+    case anonAddySelfHostAlias = "anon-addy-self-host-alias"
+
     /// A feature flag to enable/disable the app review prompt.
     case appReviewPrompt = "app-review-prompt"
 
@@ -133,6 +136,7 @@ enum FeatureFlag: String, CaseIterable, Codable {
              .testLocalInitialStringFlag:
             false
         case .accountDeprovisioning,
+             .anonAddySelfHostAlias,
              .appReviewPrompt,
              .cipherKeyEncryption,
              .cxpExportMobile,

BitwardenShared/Core/Platform/Models/Enum/FeatureFlagTests.swift

@@ -19,6 +19,7 @@ final class FeatureFlagTests: BitwardenTestCase {
 
     /// `getter:isRemotelyConfigured` returns the correct value for each flag.
     func test_isRemotelyConfigured() {
+        XCTAssertTrue(FeatureFlag.anonAddySelfHostAlias.isRemotelyConfigured)
         XCTAssertTrue(FeatureFlag.appReviewPrompt.isRemotelyConfigured)
         XCTAssertTrue(FeatureFlag.cipherKeyEncryption.isRemotelyConfigured)
         XCTAssertTrue(FeatureFlag.cxpExportMobile.isRemotelyConfigured)

BitwardenShared/Core/Tools/Models/Domain/UsernameGenerationOptions.swift

@@ -10,6 +10,9 @@ struct UsernameGenerationOptions: Codable, Equatable {
     /// The domain name used to generate a forwarded email alias with addy.io.
     var anonAddyDomainName: String?
 
+    /// The base URL for the addy.io api.
+    var anonAddyBaseUrl: String?
+
     /// Whether to capitalize the random word.
     var capitalizeRandomWordUsername: Bool?
 

BitwardenShared/Core/Tools/Models/Domain/UsernameGenerationOptionsTests.swift

@@ -11,6 +11,7 @@ class UsernameGenerationOptionsTests: BitwardenTestCase {
         {
           "anonAddyApiAccessToken": "ADDYIO_API_TOKEN",
           "anonAddyDomainName": "bitwarden.com",
+          "anonAddyBaseUrl": "bitwarden.com",
           "capitalizeRandomWordUsername": true,
           "catchAllEmailDomain": "bitwarden.com",
           "catchAllEmailType": 0,
@@ -34,6 +35,7 @@ class UsernameGenerationOptionsTests: BitwardenTestCase {
             UsernameGenerationOptions(
                 anonAddyApiAccessToken: "ADDYIO_API_TOKEN",
                 anonAddyDomainName: "bitwarden.com",
+                anonAddyBaseUrl: "bitwarden.com",
                 capitalizeRandomWordUsername: true,
                 catchAllEmailDomain: "bitwarden.com",
                 catchAllEmailType: .random,

BitwardenShared/UI/Platform/Application/Support/Localizations/en.lproj/Localizable.strings

@@ -1167,3 +1167,4 @@
 "ExpiresToday" = "Expires today";
 "ExpiresInXDays" = "Expires in %1$@ days";
 "DateRangeXToY" = "%1$@ to %2$@";
+"SelfHostServerURL" = "Self-host server URL";

BitwardenShared/UI/Tools/Generator/Generator/GeneratorProcessor.swift

@@ -82,6 +82,7 @@ final class GeneratorProcessor: StateProcessor<GeneratorState, GeneratorAction,
     override func perform(_ effect: GeneratorEffect) async {
         switch effect {
         case .appeared:
+            await loadAddyIOFeatureFlag()
             await reloadGeneratorOptions()
             await generateValue(shouldSavePassword: true)
             await checkLearnGeneratorActionCardEligibility()
@@ -192,6 +193,13 @@ final class GeneratorProcessor: StateProcessor<GeneratorState, GeneratorAction,
 
     // MARK: Private
 
+    /// Checks if the Addy.io feature flag is enabled and updates the state accordingly.
+    ///
+    private func loadAddyIOFeatureFlag() async {
+        state.usernameState.addyIOSelfHostServerUrlEnabled = await services.configService
+            .getFeatureFlag(.anonAddySelfHostAlias)
+    }
+
     /// Checks the eligibility of the generator Login action card.
     ///
     private func checkLearnGeneratorActionCardEligibility() async {

BitwardenShared/UI/Tools/Generator/Generator/GeneratorProcessorTests.swift

@@ -485,6 +485,15 @@ class GeneratorProcessorTests: BitwardenTestCase { // swiftlint:disable:this typ
         XCTAssertFalse(subject.state.isLearnGeneratorActionCardEligible)
     }
 
+    /// `perform(:)` with `.appeared` should set the `addyIOSelfHostServerUrlEnabled` to
+    /// feature flag `anonAddySelfHostAlias` value.
+    @MainActor
+    func test_perform_checkAddyIOFeatureFlag_true() async {
+        configService.featureFlagsBool[.anonAddySelfHostAlias] = true
+        await subject.perform(.appeared)
+        XCTAssertTrue(subject.state.usernameState.addyIOSelfHostServerUrlEnabled)
+    }
+
     /// `receive(_:)` with `.copyGeneratedValØue` copies the generated password to the system
     /// pasteboard and shows a toast.
     @MainActor

BitwardenShared/UI/Tools/Generator/Generator/GeneratorState+UsernameState.swift

@@ -15,6 +15,9 @@ extension GeneratorState {
 
         // MARK: Properties
 
+        /// A flag indicating if the addy IO selfhost is enabled.
+        var addyIOSelfHostServerUrlEnabled = false
+
         /// An optional website host used to generate usernames (either plus addressed or catch all).
         var emailWebsite: String?
 
@@ -37,6 +40,9 @@ extension GeneratorState {
         /// The domain name used to generate a forwarded email alias with addy.io.
         var addyIODomainName: String = ""
 
+        /// The base URL for the addy.io api.
+        var addyIOSelfHostServerUrl: String = ""
+
         /// The DuckDuckGo API key used to generate a forwarded email alias.
         var duckDuckGoAPIKey: String = ""
 
@@ -93,6 +99,7 @@ extension GeneratorState {
             // Forwarded Email Properties
             addyIOAPIAccessToken = options.anonAddyApiAccessToken ?? addyIOAPIAccessToken
             addyIODomainName = options.anonAddyDomainName ?? addyIODomainName
+            addyIOSelfHostServerUrl = options.anonAddyBaseUrl ?? addyIOSelfHostServerUrl
             duckDuckGoAPIKey = options.duckDuckGoApiKey ?? duckDuckGoAPIKey
             fastmailAPIKey = options.fastMailApiKey ?? fastmailAPIKey
             firefoxRelayAPIAccessToken = options.firefoxRelayApiAccessToken ?? firefoxRelayAPIAccessToken
@@ -162,6 +169,7 @@ extension GeneratorState.UsernameState {
         UsernameGenerationOptions(
             anonAddyApiAccessToken: addyIOAPIAccessToken.nilIfEmpty,
             anonAddyDomainName: addyIODomainName.nilIfEmpty,
+            anonAddyBaseUrl: addyIOSelfHostServerUrl.nilIfEmpty,
             capitalizeRandomWordUsername: capitalize,
             catchAllEmailDomain: domain.nilIfEmpty,
             catchAllEmailType: catchAllEmailType,
@@ -221,7 +229,7 @@ extension GeneratorState.UsernameState {
             ForwarderServiceType.addyIo(
                 apiToken: addyIOAPIAccessToken,
                 domain: addyIODomainName,
-                baseUrl: "https://app.addy.io"
+                baseUrl: addyIOSelfHostServerUrl.nilIfEmpty ?? "https://app.addy.io"
             )
         case .duckDuckGo:
             ForwarderServiceType.duckDuckGo(token: duckDuckGoAPIKey)

BitwardenShared/UI/Tools/Generator/Generator/GeneratorState.swift

@@ -413,6 +413,15 @@ extension GeneratorState {
                         title: Localizations.domainNameRequiredParenthesis
                     ),
                 ])
+                if usernameState.addyIOSelfHostServerUrlEnabled {
+                    fields.append(contentsOf: [
+                        textField(
+                            accessibilityId: "AnonAddySelfHosteUrlEntry",
+                            keyPath: \.usernameState.addyIOSelfHostServerUrl,
+                            title: Localizations.selfHostServerURL
+                        ),
+                    ])
+                }
             case .duckDuckGo:
                 fields.append(
                     textField(

BitwardenShared/UI/Tools/Generator/Generator/GeneratorStateTests.swift

@@ -100,6 +100,7 @@ class GeneratorStateTests: BitwardenTestCase { // swiftlint:disable:this type_bo
         subject.generatorType = .username
         subject.usernameState.usernameGeneratorType = .forwardedEmail
         subject.usernameState.forwardedEmailService = .addyIO
+        subject.usernameState.addyIOSelfHostServerUrlEnabled = true
 
         assertInlineSnapshot(of: dumpFormSections(subject.formSections), as: .lines) {
             """
@@ -115,6 +116,7 @@ class GeneratorStateTests: BitwardenTestCase { // swiftlint:disable:this type_bo
                 Options: addy.io, DuckDuckGo, Fastmail, Firefox Relay, ForwardEmail, SimpleLogin
               Text: API access token Value: (empty)
               Text: Domain name (required) Value: (empty)
+              Text: Self-host server URL Value: (empty)
             """
         }
     }
@@ -551,6 +553,9 @@ class GeneratorStateTests: BitwardenTestCase { // swiftlint:disable:this type_bo
         subject.addyIOAPIAccessToken = "token"
         XCTAssertTrue(subject.canGenerateUsername)
 
+        subject.addyIOSelfHostServerUrl = "bitwarden.com"
+        XCTAssertTrue(subject.canGenerateUsername)
+
         subject.forwardedEmailService = .duckDuckGo
         XCTAssertFalse(subject.canGenerateUsername)
         subject.duckDuckGoAPIKey = "apiKey"
@@ -587,6 +592,19 @@ class GeneratorStateTests: BitwardenTestCase { // swiftlint:disable:this type_bo
         XCTAssertEqual(subject.plusAddressedEmailType, .random)
     }
 
+    /// `usernameState.update(with:)` sets addy io base url if exists.
+    func test_usernameState_updateWithOptions_addyIOBaseUrl() {
+        var subject = GeneratorState().usernameState
+        subject.update(with: UsernameGenerationOptions(anonAddyBaseUrl: "bitwarden.com"))
+
+        XCTAssertEqual(subject.usernameGenerationOptions.anonAddyBaseUrl, "bitwarden.com")
+
+        subject.addyIOSelfHostServerUrl = "bitwarden2.com"
+        subject.update(with: UsernameGenerationOptions())
+
+        XCTAssertEqual(subject.usernameGenerationOptions.anonAddyBaseUrl, "bitwarden2.com")
+    }
+
     /// `usernameState.update(with:)` sets the email type to website if an email website exists.
     func test_usernameState_updateWithOptions_website() {
         var subject = GeneratorState().usernameState