Enable feature flag configuration for Tchap X

tchapgouv · Dec 9, 2024 · 30d376b · 30d376b
1 parent 2e2252f
commit 30d376b
Show file tree

Hide file tree

Showing 2 changed files with 113 additions and 0 deletions.
diff --git a/TchapX/main/Sources/Other/TchapFeatureFlag.swift b/TchapX/main/Sources/Other/TchapFeatureFlag.swift
@@ -0,0 +1,85 @@
+//
+// TchapFeatureFlag.swift
+// TchapX
+//
+// Created by Nicolas Buquet on 09/12/2024.
+// Copyright © 2024 Tchap. All rights reserved.
+//
+
+import Foundation
+
+struct TchapFeatureFlag {
+    let allowedInstances: [Instance]
+
+    func isActivated(for homeServer: String) -> Bool {
+        // Return false if no instance suppports the feature.
+        if allowedInstances.isEmpty {
+            return false
+        }
+
+        // Return true if all instances support the feature.
+        // Can be used for feature that takes place before login (like ProConnect login option).
+        if allowedInstances.contains(.all) {
+            return true
+        }
+
+        // Example of homeServer for authenticiation: `matrix.agent.dinum.tchap.gouv.fr`
+        // We must remove the `matrix.` prefix.
+        let homeServerPrefixes = ["matrix.", "https://matrix."]
+        var sanitizedHomeServer = Substring(homeServer)
+        homeServerPrefixes.forEach {
+            if sanitizedHomeServer.hasPrefix($0) {
+                sanitizedHomeServer = sanitizedHomeServer.dropFirst($0.count)
+            }
+        }
+
+        // Verifiy that the instance is known.
+        // Return false if the instance is not a known instance.
+        guard let instance = Instance(rawValue: String(sanitizedHomeServer)) else {
+            return false
+        }
+
+        // Return true if current session homeServer is listed in the instances supporting the feature.
+        return allowedInstances.contains(instance)
+    }
+}
+
+extension TchapFeatureFlag {
+    enum Instance: String {
+        case externe = "agent.externe.tchap.gouv.fr"
+        case collectivites = "agent.collectivites.tchap.gouv.fr"
+        case agent = "agent.tchap.gouv.fr"
+        case elysee = "agent.elysee.tchap.gouv.fr"
+        case pm = "agent.pm.tchap.gouv.fr"
+        case ssi = "agent.ssi.tchap.gouv.fr"
+        case finances = "agent.finances.tchap.gouv.fr"
+        case social = "agent.social.tchap.gouv.fr"
+        case interieur = "agent.interieur.tchap.gouv.fr"
+        case agriculture = "agent.agriculture.tchap.gouv.fr"
+        case justice = "agent.justice.tchap.gouv.fr"
+        case diplomatie = "agent.diplomatie.tchap.gouv.fr"
+        case intradef = "agent.intradef.tchap.gouv.fr"
+        case dinum = "agent.dinum.tchap.gouv.fr"
+        case culture = "agent.culture.tchap.gouv.fr"
+        case devDurable = "agent.dev-durable.tchap.gouv.fr"
+        case education = "agent.education.tchap.gouv.fr"
+        case all // To allow a feature for any instance
+
+        var homeServer: String? { rawValue }
+    }
+}
+
+extension TchapFeatureFlag {
+    enum Configuration { // Use empty Enum rather than empty Struct. (Linter advice)
+        #if IS_TCHAP_PRODUCTION
+        static let certificatePinning = TchapFeatureFlag(allowedInstances: [.agriculture, .agent])
+        static let proConnectAuthentication = TchapFeatureFlag(allowedInstances: [])
+        #elseif IS_TCHAP_STAGING
+        static let certificatePinning = TchapFeatureFlag(allowedInstances: [.agriculture, .agent])
+        static let proConnectAuthentication = TchapFeatureFlag(allowedInstances: [])
+        #elseif IS_TCHAP_DEVELOPMENT
+        static let certificatePinning = TchapFeatureFlag(allowedInstances: [.agriculture, .agent])
+        static let proConnectAuthentication = TchapFeatureFlag(allowedInstances: [])
+        #endif
+    }
+}
diff --git a/TchapX/main/UnitTests/Sources/TchapFeatureFlagTests.swift b/TchapX/main/UnitTests/Sources/TchapFeatureFlagTests.swift
@@ -0,0 +1,28 @@
+//
+//  TchapFeatureFlagTests.swift
+//  IntegrationTests
+//
+//  Created by Nicolas Buquet on 09/12/2024.
+//  Copyright © 2024 Tchap. All rights reserved.
+//
+
+import XCTest
+
+@testable import TchapX_Development
+
+final class TchapFeatureFlagTests: XCTestCase {
+    func testFeatureFlags() {
+        // Test for success
+        XCTAssertTrue(TchapFeatureFlag(allowedInstances: [.agent]).isActivated(for: TchapFeatureFlag.Instance.agent.homeServer!))
+        XCTAssertTrue(TchapFeatureFlag(allowedInstances: [.agent, .agriculture, .culture]).isActivated(for: TchapFeatureFlag.Instance.culture.homeServer!))
+        XCTAssertTrue(TchapFeatureFlag(allowedInstances: [.all]).isActivated(for: TchapFeatureFlag.Instance.culture.homeServer!))
+        XCTAssertTrue(TchapFeatureFlag(allowedInstances: [.agent, .all]).isActivated(for: TchapFeatureFlag.Instance.culture.homeServer!))
+        XCTAssertTrue(TchapFeatureFlag(allowedInstances: [.agent]).isActivated(for: "matrix.agent.tchap.gouv.fr"))
+        XCTAssertTrue(TchapFeatureFlag(allowedInstances: [.agent]).isActivated(for: "https://matrix.agent.tchap.gouv.fr"))
+        // Test for failure
+        XCTAssertFalse(TchapFeatureFlag(allowedInstances: [.agent]).isActivated(for: TchapFeatureFlag.Instance.agriculture.homeServer!))
+        XCTAssertFalse(TchapFeatureFlag(allowedInstances: [.agent]).isActivated(for: ""))
+        XCTAssertFalse(TchapFeatureFlag(allowedInstances: []).isActivated(for: TchapFeatureFlag.Instance.agent.homeServer!))
+        XCTAssertFalse(TchapFeatureFlag(allowedInstances: [.agent]).isActivated(for: "http://matrix.agent.tchap.gouv.fr"))
+    }
+}