Allow the services that are configured by secrets to be disabled. (#3961)

* Make the map tiler key optional. * Make the bug report URL optional. * Make the sentry URL optional. * Make the analytics configuration optional and handle consent taking Sentry into account. * Stop prompting users to report crashes when Sentry is disabled.
2026-11-03 16:10:20 +00:00 · 2025-04-01 09:24:12 +01:00
parent 36903bf3fb
commit 5e50823223
71 changed files with 321 additions and 134 deletions
@@ -24,17 +24,21 @@ enum AnalyticsSettingsScreenViewAction {
 struct AnalyticsSettingsScreenStrings {
    let sectionFooter: AttributedString
    
-    init(termsURL: URL) {
+    init(termsURL: URL?) {
        let content = AttributedString(L10n.screenAnalyticsPromptHelpUsImprove)
        
-        // Create the 'read terms' with a placeholder.
-        let linkPlaceholder = "{link}"
-        var readTerms = AttributedString(L10n.screenAnalyticsSettingsReadTerms(linkPlaceholder))
-        var linkString = AttributedString(L10n.screenAnalyticsSettingsReadTermsContentLink)
-        linkString.link = termsURL
-        linkString.bold()
-        readTerms.replace(linkPlaceholder, with: linkString)
-        
-        sectionFooter = content + "\n\n" + readTerms
+        if let termsURL {
+            // Create the 'read terms' with a placeholder.
+            let linkPlaceholder = "{link}"
+            var readTerms = AttributedString(L10n.screenAnalyticsSettingsReadTerms(linkPlaceholder))
+            var linkString = AttributedString(L10n.screenAnalyticsSettingsReadTermsContentLink)
+            linkString.link = termsURL
+            linkString.bold()
+            readTerms.replace(linkPlaceholder, with: linkString)
+            
+            sectionFooter = content + "\n\n" + readTerms
+        } else {
+            sectionFooter = content
+        }
    }
 }
@@ -16,7 +16,7 @@ class AnalyticsSettingsScreenViewModel: AnalyticsSettingsScreenViewModelType, An
    init(appSettings: AppSettings, analytics: AnalyticsService) {
        self.analytics = analytics
        
-        let strings = AnalyticsSettingsScreenStrings(termsURL: appSettings.analyticsConfiguration.termsURL)
+        let strings = AnalyticsSettingsScreenStrings(termsURL: appSettings.analyticsTermsURL)
        let bindings = AnalyticsSettingsScreenViewStateBindings(enableAnalytics: analytics.isEnabled)
        let state = AnalyticsSettingsScreenViewState(strings: strings, bindings: bindings)
        
@@ -11,6 +11,7 @@ import SwiftUI
 struct SettingsScreenCoordinatorParameters {
    let userSession: UserSessionProtocol
    let appSettings: AppSettings
+    let isBugReportServiceEnabled: Bool
 }

 enum SettingsScreenCoordinatorAction {
@@ -43,7 +44,9 @@ final class SettingsScreenCoordinator: CoordinatorProtocol {
    // MARK: - Setup
    
    init(parameters: SettingsScreenCoordinatorParameters) {
-        viewModel = SettingsScreenViewModel(userSession: parameters.userSession)
+        viewModel = SettingsScreenViewModel(userSession: parameters.userSession,
+                                            appSettings: parameters.appSettings,
+                                            isBugReportServiceEnabled: parameters.isBugReportServiceEnabled)
        
        viewModel.actions
            .sink { [weak self] action in
@@ -44,6 +44,9 @@ struct SettingsScreenViewState: BindableState {
    var showSecuritySectionBadge = false
    
    var showBlockedUsers = false
+    let showAnalyticsSettings: Bool
+    
+    let isBugReportServiceEnabled: Bool
    
    var bindings = SettingsScreenViewStateBindings()
 }
@@ -17,11 +17,13 @@ class SettingsScreenViewModel: SettingsScreenViewModelType, SettingsScreenViewMo
        actionsSubject.eraseToAnyPublisher()
    }
    
-    init(userSession: UserSessionProtocol) {
+    init(userSession: UserSessionProtocol, appSettings: AppSettings, isBugReportServiceEnabled: Bool) {
        super.init(initialViewState: .init(deviceID: userSession.clientProxy.deviceID,
                                           userID: userSession.clientProxy.userID,
                                           showAccountDeactivation: userSession.clientProxy.canDeactivateAccount,
-                                           showDeveloperOptions: AppSettings.isDevelopmentBuild),
+                                           showDeveloperOptions: AppSettings.isDevelopmentBuild,
+                                           showAnalyticsSettings: appSettings.canPromptForAnalytics,
+                                           isBugReportServiceEnabled: isBugReportServiceEnabled),
                   mediaProvider: userSession.mediaProvider)
        
        userSession.clientProxy.userAvatarURLPublisher
@@ -140,19 +140,23 @@ struct SettingsScreen: View {
                    })
                    .accessibilityIdentifier(A11yIdentifiers.settingsScreen.about)
            
-            ListRow(label: .default(title: L10n.commonReportAProblem,
-                                    icon: \.chatProblem),
-                    kind: .navigationLink {
-                        context.send(viewAction: .reportBug)
-                    })
-                    .accessibilityIdentifier(A11yIdentifiers.settingsScreen.reportBug)
+            if context.viewState.isBugReportServiceEnabled {
+                ListRow(label: .default(title: L10n.commonReportAProblem,
+                                        icon: \.chatProblem),
+                        kind: .navigationLink {
+                            context.send(viewAction: .reportBug)
+                        })
+                        .accessibilityIdentifier(A11yIdentifiers.settingsScreen.reportBug)
+            }
            
-            ListRow(label: .default(title: L10n.commonAnalytics,
-                                    icon: \.chart),
-                    kind: .navigationLink {
-                        context.send(viewAction: .analytics)
-                    })
-                    .accessibilityIdentifier(A11yIdentifiers.settingsScreen.analytics)
+            if context.viewState.showAnalyticsSettings {
+                ListRow(label: .default(title: L10n.commonAnalytics,
+                                        icon: \.chart),
+                        kind: .navigationLink {
+                            context.send(viewAction: .analytics)
+                        })
+                        .accessibilityIdentifier(A11yIdentifiers.settingsScreen.analytics)
+            }
            
            ListRow(label: .default(title: L10n.commonAdvancedSettings,
                                    icon: \.settings),
@@ -230,18 +234,32 @@ struct SettingsScreen: View {
 // MARK: - Previews

 struct SettingsScreen_Previews: PreviewProvider, TestablePreview {
-    static let viewModel = {
-        let userSession = UserSessionMock(.init(clientProxy: ClientProxyMock(.init(userID: "@userid:example.com",
-                                                                                   deviceID: "AAAAAAAAAAA"))))
-        return SettingsScreenViewModel(userSession: userSession)
-    }()
+    static let viewModel = makeViewModel()
+    static let bugReportDisabledViewModel = makeViewModel(isBugReportServiceEnabled: false)
    
    static var previews: some View {
        NavigationStack {
            SettingsScreen(context: viewModel.context)
-                .snapshotPreferences(expect: viewModel.context.$viewState.map { state in
-                    state.accountSessionsListURL != nil
-                })
        }
+        .snapshotPreferences(expect: viewModel.context.$viewState.map { state in
+            state.accountSessionsListURL != nil
+        })
+        .previewDisplayName("Default")
+        
+        NavigationStack {
+            SettingsScreen(context: bugReportDisabledViewModel.context)
+        }
+        .snapshotPreferences(expect: bugReportDisabledViewModel.context.$viewState.map { state in
+            state.accountSessionsListURL != nil
+        })
+        .previewDisplayName("Bug report disabled")
+    }
+    
+    static func makeViewModel(isBugReportServiceEnabled: Bool = true) -> SettingsScreenViewModel {
+        let userSession = UserSessionMock(.init(clientProxy: ClientProxyMock(.init(userID: "@userid:example.com",
+                                                                                   deviceID: "AAAAAAAAAAA"))))
+        return SettingsScreenViewModel(userSession: userSession,
+                                       appSettings: ServiceLocator.shared.settings,
+                                       isBugReportServiceEnabled: isBugReportServiceEnabled)
    }
 }