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.

Sign up for GitHub

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

Count VPN controller cancellations #2720

Merged
merged 4 commits into from
May 1, 2024
Merged

Count VPN controller cancellations #2720

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1f1b5f3
Pixel improvements
diegoreymendez Apr 29, 2024
040d73d
Rolls back cancelled pixel from internal hotfix
diegoreymendez Apr 29, 2024
987e183
Adds back the cancellation pixel
diegoreymendez Apr 29, 2024
91b9865
Update DuckDuckGo/NetworkProtection/AppTargets/BothAppTargets/Network…
diegoreymendez May 1, 2024
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
6 changes: 6 additions & 0 deletions ...DuckGo/NetworkProtection/AppAndExtensionAndAgentTargets/NetworkProtectionPixelEvent.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ enum NetworkProtectionPixelEvent: PixelKitEventV2 {

case networkProtectionControllerStartAttempt
case networkProtectionControllerStartSuccess
case networkProtectionControllerStartCancelled
case networkProtectionControllerStartFailure(_ error: Error)

case networkProtectionTunnelStartAttempt
Expand Down Expand Up @@ -122,6 +123,9 @@ enum NetworkProtectionPixelEvent: PixelKitEventV2 {
case .networkProtectionControllerStartSuccess:
return "netp_controller_start_success"

case .networkProtectionControllerStartCancelled:
return "netp_controller_start_cancelled"

case .networkProtectionControllerStartFailure:
return "netp_controller_start_failure"

Expand Down Expand Up @@ -344,6 +348,7 @@ enum NetworkProtectionPixelEvent: PixelKitEventV2 {
.networkProtectionNewUser,
.networkProtectionControllerStartAttempt,
.networkProtectionControllerStartSuccess,
.networkProtectionControllerStartCancelled,
.networkProtectionControllerStartFailure,
.networkProtectionTunnelStartAttempt,
.networkProtectionTunnelStartSuccess,
Expand Down Expand Up @@ -415,6 +420,7 @@ enum NetworkProtectionPixelEvent: PixelKitEventV2 {
.networkProtectionNewUser,
.networkProtectionControllerStartAttempt,
.networkProtectionControllerStartSuccess,
.networkProtectionControllerStartCancelled,
.networkProtectionTunnelStartAttempt,
.networkProtectionTunnelStartSuccess,
.networkProtectionTunnelStopAttempt,
Expand Down
54 changes: 49 additions & 5 deletions ...uckGo/NetworkProtection/AppTargets/BothAppTargets/NetworkProtectionTunnelController.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -448,14 +448,18 @@ final class NetworkProtectionTunnelController: TunnelController, TunnelSessionPr

// MARK: - Starting & Stopping the VPN

enum StartError: LocalizedError {
enum StartError: LocalizedError, CustomNSError {
case cancelled
case noAuthToken
case connectionStatusInvalid
case connectionAlreadyStarted
case simulateControllerFailureError
case startTunnelFailure(_ error: Error)

var errorDescription: String? {
switch self {
case .cancelled:
return nil
case .noAuthToken:
return "You need a subscription to start the VPN"
case .connectionAlreadyStarted:
Expand All @@ -473,6 +477,34 @@ final class NetworkProtectionTunnelController: TunnelController, TunnelSessionPr
#endif
case .simulateControllerFailureError:
return "Simulated a controller error as requested"
case .startTunnelFailure(let error):
return error.localizedDescription
}
}

var errorCode: Int {
switch self {
case .cancelled: return 0
// MARK: Setup errors
case .noAuthToken: return 1
case .connectionStatusInvalid: return 2
case .connectionAlreadyStarted: return 3
case .simulateControllerFailureError: return 4
// MARK: Actual connection attempt issues
case .startTunnelFailure: return 100
}
}

var errorUserInfo: [String: Any] {
switch self {
case .cancelled,
.noAuthToken,
.connectionStatusInvalid,
.connectionAlreadyStarted,
.simulateControllerFailureError:
return [:]
case .startTunnelFailure(let error):
return [NSUnderlyingErrorKey: error]
}
}
}
Expand Down Expand Up @@ -502,6 +534,8 @@ final class NetworkProtectionTunnelController: TunnelController, TunnelSessionPr
} catch {
if case NEVPNError.configurationReadWriteFailed = error {
onboardingStatusRawValue = OnboardingStatus.isOnboarding(step: .userNeedsToAllowVPNConfiguration).rawValue

throw StartError.cancelled
}

throw error
Expand All @@ -528,9 +562,15 @@ final class NetworkProtectionTunnelController: TunnelController, TunnelSessionPr
} catch {
VPNOperationErrorRecorder().recordControllerStartFailure(error)

PixelKit.fire(
NetworkProtectionPixelEvent.networkProtectionControllerStartFailure(error), frequency: .dailyAndCount, includeAppVersionParameter: true
)
if case StartError.cancelled = error {
PixelKit.fire(
NetworkProtectionPixelEvent.networkProtectionControllerStartCancelled, frequency: .dailyAndCount, includeAppVersionParameter: true
)
} else {
PixelKit.fire(
NetworkProtectionPixelEvent.networkProtectionControllerStartFailure(error), frequency: .dailyAndCount, includeAppVersionParameter: true
)
}

await stop()

Expand Down Expand Up @@ -577,7 +617,11 @@ final class NetworkProtectionTunnelController: TunnelController, TunnelSessionPr
throw StartError.simulateControllerFailureError
}

try tunnelManager.connection.startVPNTunnel(options: options)
do {
try tunnelManager.connection.startVPNTunnel(options: options)
} catch {
throw StartError.startTunnelFailure(error)
}

PixelKit.fire(
NetworkProtectionPixelEvent.networkProtectionNewUser,
Expand Down
Loading