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.
This commit is contained in:
Doug
2025-04-01 09:24:12 +01:00
committed by GitHub
parent 36903bf3fb
commit 5e50823223
71 changed files with 321 additions and 134 deletions
@@ -9,12 +9,8 @@ import Foundation
/// A type that represents how to set up the analytics module in the app.
struct AnalyticsConfiguration {
/// Whether or not analytics should be enabled.
let isEnabled: Bool
/// The host to use for PostHog analytics.
let host: String
/// The public key for submitting analytics.
let apiKey: String
/// The URL to open with more information about analytics terms.
let termsURL: URL
}
@@ -39,7 +39,7 @@ class AnalyticsService {
/// Whether to show the user the analytics opt in prompt.
var shouldShowAnalyticsPrompt: Bool {
// Only show the prompt once, and when analytics are enabled in BuildSettings.
appSettings.analyticsConsentState == .unknown && appSettings.analyticsConfiguration.isEnabled
appSettings.analyticsConsentState == .unknown && appSettings.canPromptForAnalytics
}
var isEnabled: Bool {
@@ -65,9 +65,9 @@ class AnalyticsService {
/// Starts the analytics client if the user has opted in, otherwise does nothing.
func startIfEnabled() {
guard isEnabled, !client.isRunning else { return }
guard isEnabled, !client.isRunning, let configuration = appSettings.analyticsConfiguration else { return }
client.start(analyticsConfiguration: appSettings.analyticsConfiguration)
client.start(analyticsConfiguration: configuration)
// Sanity check in case something went wrong.
guard client.isRunning else { return }
@@ -9,8 +9,6 @@ import PostHog
extension PostHogConfig {
static func standard(analyticsConfiguration: AnalyticsConfiguration) -> PostHogConfig? {
guard analyticsConfiguration.isEnabled else { return nil }
let postHogConfiguration = PostHogConfig(apiKey: analyticsConfiguration.apiKey, host: analyticsConfiguration.host)
// We capture screens manually
postHogConfiguration.captureScreenViews = false
@@ -12,8 +12,8 @@ import Sentry
import UIKit
class BugReportService: NSObject, BugReportServiceProtocol {
private let baseURL: URL
private let applicationId: String
private let baseURL: URL?
private let applicationID: String
private let sdkGitSHA: String
private let maxUploadSize: Int
private let session: URLSession
@@ -23,16 +23,17 @@ class BugReportService: NSObject, BugReportServiceProtocol {
private let progressSubject = PassthroughSubject<Double, Never>()
private var cancellables = Set<AnyCancellable>()
var isEnabled: Bool { baseURL != nil }
var lastCrashEventID: String?
init(withBaseURL baseURL: URL,
applicationId: String,
init(baseURL: URL?,
applicationID: String,
sdkGitSHA: String,
maxUploadSize: Int,
session: URLSession = .shared,
appHooks: AppHooks) {
self.baseURL = baseURL
self.applicationId = applicationId
self.applicationID = applicationID
self.sdkGitSHA = sdkGitSHA
self.maxUploadSize = maxUploadSize
self.session = session
@@ -49,6 +50,10 @@ class BugReportService: NSObject, BugReportServiceProtocol {
// swiftlint:disable:next cyclomatic_complexity
func submitBugReport(_ bugReport: BugReport,
progressListener: CurrentValueSubject<Double, Never>) async -> Result<SubmitBugReportResponse, BugReportServiceError> {
guard let baseURL else {
fatalError("No bug report URL set, the screen should not be shown in this case.")
}
let bugReport = appHooks.bugReportHook.update(bugReport)
var params = [
@@ -153,7 +158,7 @@ class BugReportService: NSObject, BugReportServiceProtocol {
let (localTime, utcTime) = localAndUTCTime(for: Date())
return [
MultipartFormData(key: "user_agent", type: .text(value: "iOS")),
MultipartFormData(key: "app", type: .text(value: applicationId)),
MultipartFormData(key: "app", type: .text(value: applicationID)),
MultipartFormData(key: "version", type: .text(value: InfoPlistReader.main.bundleShortVersionString)),
MultipartFormData(key: "build", type: .text(value: InfoPlistReader.main.bundleVersion)),
MultipartFormData(key: "sdk_sha", type: .text(value: sdkGitSHA)),
@@ -44,6 +44,7 @@ enum BugReportServiceError: LocalizedError {
// sourcery: AutoMockable
protocol BugReportServiceProtocol: AnyObject {
var isEnabled: Bool { get }
var crashedLastRun: Bool { get }
var lastCrashEventID: String? { get set }