Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

VPN: Specific TunnelController start failure reporting #2714

Merged
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 28 additions & 11 deletions DuckDuckGo/NetworkProtectionTunnelController.swift
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,24 @@ final class NetworkProtectionTunnelController: TunnelController {

// MARK: - Starting & Stopping the VPN

enum StartError: LocalizedError {
case connectionStatusInvalid
enum StartError: LocalizedError, CustomNSError {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sweet!

case simulateControllerFailureError
case loadFromPreferencesFailed(Error)
case saveToPreferencesFailed(Error)
case startVPNFailed(Error)
case fetchAuthTokenFailed(Error)

public static let errorDomain = "com.duckduckgo.NetworkProtectionTunnelController.StartError.domain"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a note that I believe you can omit this, and the system will fill it in with a nice string.


public var errorCode: Int {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great to have explicit codes. Thanks :)

switch self {
case .simulateControllerFailureError: 0
case .loadFromPreferencesFailed: 1
case .saveToPreferencesFailed: 2
case .startVPNFailed: 3
case .fetchAuthTokenFailed: 4
}
}
}

init() {
Expand Down Expand Up @@ -147,7 +162,11 @@ final class NetworkProtectionTunnelController: TunnelController {
}

options["activationAttemptId"] = UUID().uuidString as NSString
options["authToken"] = try tokenStore.fetchToken() as NSString?
do {
options["authToken"] = try tokenStore.fetchToken() as NSString?
} catch {
throw StartError.fetchAuthTokenFailed(error)
}
options[NetworkProtectionOptionKey.selectedEnvironment] = VPNSettings(defaults: .networkProtectionGroupDefaults)
.selectedEnvironment.rawValue as NSString

Expand All @@ -161,7 +180,7 @@ final class NetworkProtectionTunnelController: TunnelController {
}
} catch {
Pixel.fire(pixel: .networkProtectionActivationRequestFailed, error: error)
throw error
throw StartError.startVPNFailed(error)
}
}

Expand Down Expand Up @@ -203,26 +222,24 @@ final class NetworkProtectionTunnelController: TunnelController {

private func setupAndSave(_ tunnelManager: NETunnelProviderManager) async throws {
setup(tunnelManager)
try await tunnelManager.saveToPreferences()
try await tunnelManager.loadFromPreferences()
try await tunnelManager.saveToPreferences()
try await saveToPreferences(tunnelManager)
try await loadFromPreferences(tunnelManager)
try await saveToPreferences(tunnelManager)
}

private func saveToPreferences(_ tunnelManager: NETunnelProviderManager) async throws {
do {
try await tunnelManager.saveToPreferences()
} catch {
Pixel.fire(pixel: .networkProtectionFailedToSaveToPreferences, error: error)
throw error
throw StartError.saveToPreferencesFailed(error)
}
}

private func loadFromPreferences(_ tunnelManager: NETunnelProviderManager) async throws {
do {
try await tunnelManager.loadFromPreferences()
} catch {
Pixel.fire(pixel: .networkProtectionFailedToLoadFromPreferences, error: error)
throw error
throw StartError.loadFromPreferencesFailed(error)
}
}

Expand Down
Loading