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

Improve VPN logging logic #3032

Merged
merged 7 commits into from
Jul 5, 2024
Merged

Improve VPN logging logic #3032

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3be07df
WIP
diegoreymendez Jul 3, 2024
ad8170d
Improves the VPN logging logic
diegoreymendez Jul 3, 2024
2229cef
Merges the latest from release/7.127.0
diegoreymendez Jul 3, 2024
74bf7dc
Makes some VPN logs .default instead of .info
diegoreymendez Jul 4, 2024
2f6d9d8
Updates BSK
diegoreymendez Jul 4, 2024
5b1b009
Updates BSK 164.2.0-2
diegoreymendez Jul 5, 2024
a5dc0e6
Merges the latest from main
diegoreymendez Jul 5, 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: 5 additions & 1 deletion DuckDuckGo.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,7 @@
6FE127462C2054A900EB5724 /* NewTabPageViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6FE127452C2054A900EB5724 /* NewTabPageViewController.swift */; };
6FE1274B2C20943500EB5724 /* ShortcutItemView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6FE1274A2C20943500EB5724 /* ShortcutItemView.swift */; };
6FF915822B88E07A0042AC87 /* AdAttributionFetcherTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6FF915802B88E0750042AC87 /* AdAttributionFetcherTests.swift */; };
7B0D52352C35FEAD0035A60E /* VPNLogger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7B0D52342C35FEAD0035A60E /* VPNLogger.swift */; };
7BC571202BDBB877003B0CCE /* VPNActivationDateStore.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7BC5711F2BDBB877003B0CCE /* VPNActivationDateStore.swift */; };
7BC571212BDBB977003B0CCE /* VPNActivationDateStore.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7BC5711F2BDBB877003B0CCE /* VPNActivationDateStore.swift */; };
83004E802193BB8200DA013C /* WKNavigationExtension.swift in Sources */ = {isa = PBXBuildFile; fileRef = 83004E7F2193BB8200DA013C /* WKNavigationExtension.swift */; };
Expand Down Expand Up @@ -1401,6 +1402,7 @@
6FE127452C2054A900EB5724 /* NewTabPageViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NewTabPageViewController.swift; sourceTree = "<group>"; };
6FE1274A2C20943500EB5724 /* ShortcutItemView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ShortcutItemView.swift; sourceTree = "<group>"; };
6FF915802B88E0750042AC87 /* AdAttributionFetcherTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AdAttributionFetcherTests.swift; sourceTree = "<group>"; };
7B0D52342C35FEAD0035A60E /* VPNLogger.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = VPNLogger.swift; sourceTree = "<group>"; };
7BC5711F2BDBB877003B0CCE /* VPNActivationDateStore.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = VPNActivationDateStore.swift; sourceTree = "<group>"; };
83004E7F2193BB8200DA013C /* WKNavigationExtension.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WKNavigationExtension.swift; sourceTree = "<group>"; };
83004E832193E14C00DA013C /* UIAlertControllerExtension.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; name = UIAlertControllerExtension.swift; path = ../Core/UIAlertControllerExtension.swift; sourceTree = "<group>"; };
Expand Down Expand Up @@ -4727,6 +4729,7 @@
EE3766DC2AC5940A00AAB575 /* NetworkProtection */ = {
isa = PBXGroup;
children = (
7B0D52342C35FEAD0035A60E /* VPNLogger.swift */,
EEEB80A22A421CE600386378 /* NetworkProtectionPacketTunnelProvider.swift */,
EE3766DD2AC5945500AAB575 /* NetworkProtectionUNNotificationPresenter.swift */,
);
Expand Down Expand Up @@ -6465,6 +6468,7 @@
EEEB80A32A421CE600386378 /* NetworkProtectionPacketTunnelProvider.swift in Sources */,
EE3766DE2AC5945500AAB575 /* NetworkProtectionUNNotificationPresenter.swift in Sources */,
F1FDC9362BF51E41006B1435 /* VPNSettings+Environment.swift in Sources */,
7B0D52352C35FEAD0035A60E /* VPNLogger.swift in Sources */,
BDFF03212BA3D3CF00F324C9 /* NetworkProtectionVisibilityForTunnelProvider.swift in Sources */,
EEFC6A602AC0F2F80065027D /* UserText.swift in Sources */,
7BC571212BDBB977003B0CCE /* VPNActivationDateStore.swift in Sources */,
Expand Down Expand Up @@ -9966,7 +9970,7 @@
repositoryURL = "https://github.com/DuckDuckGo/BrowserServicesKit";
requirement = {
kind = exactVersion;
version = 165.0.0;
version = 165.0.1;
};
};
9F8FE9472BAE50E50071E372 /* XCRemoteSwiftPackageReference "lottie-spm" */ = {
Expand Down
4 changes: 2 additions & 2 deletions DuckDuckGo.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/DuckDuckGo/BrowserServicesKit",
"state" : {
"revision" : "777e5ae1ab890d9ec22e069bc5dc0f0ada4b35af",
"version" : "165.0.0"
"revision" : "2df7f9d9063c9f8f8f07ccb80c95d7e35738d1ea",
"version" : "165.0.1"
}
},
{
Expand Down
24 changes: 23 additions & 1 deletion PacketTunnelProvider/NetworkProtection/NetworkProtectionPacketTunnelProvider.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ import WidgetKit
// Initial implementation for initial Network Protection tests. Will be fleshed out with https://app.asana.com/0/1203137811378537/1204630829332227/f
final class NetworkProtectionPacketTunnelProvider: PacketTunnelProvider {

private static var vpnLogger = VPNLogger()
private var cancellables = Set<AnyCancellable>()
private let accountManager: AccountManager

Expand All @@ -48,6 +49,8 @@ final class NetworkProtectionPacketTunnelProvider: PacketTunnelProvider {
withAdditionalParameters: [PixelParameters.vpnCohort: UniquePixel.cohort(from: defaults.vpnFirstEnabled)],
includedParameters: [.appVersion, .atb])
case .reportConnectionAttempt(attempt: let attempt):
vpnLogger.log(attempt)

switch attempt {
case .connecting:
DailyPixel.fireDailyAndCount(pixel: .networkProtectionEnableAttemptConnecting,
Expand All @@ -63,6 +66,8 @@ final class NetworkProtectionPacketTunnelProvider: PacketTunnelProvider {
includedParameters: [.appVersion, .atb])
}
case .reportTunnelFailure(result: let result):
vpnLogger.log(result)

switch result {
case .failureDetected:
DailyPixel.fireDailyAndCount(pixel: .networkProtectionTunnelFailureDetected, includedParameters: [.appVersion, .atb])
Expand All @@ -72,6 +77,8 @@ final class NetworkProtectionPacketTunnelProvider: PacketTunnelProvider {
defaults.updateNetworkPath(with: newPath)
}
case .reportLatency(result: let result):
vpnLogger.log(result)

switch result {
case .error:
DailyPixel.fire(pixel: .networkProtectionLatencyError, includedParameters: [.appVersion, .atb])
Expand All @@ -80,6 +87,8 @@ final class NetworkProtectionPacketTunnelProvider: PacketTunnelProvider {
DailyPixel.fireDailyAndCount(pixel: .networkProtectionLatency(quality: quality), includedParameters: [.appVersion, .atb])
}
case .rekeyAttempt(let step):
vpnLogger.log(step, named: "Rekey")

switch step {
case .begin:
DailyPixel.fireDailyAndCount(pixel: .networkProtectionRekeyAttempt)
Expand All @@ -89,6 +98,8 @@ final class NetworkProtectionPacketTunnelProvider: PacketTunnelProvider {
DailyPixel.fireDailyAndCount(pixel: .networkProtectionRekeyCompleted)
}
case .tunnelStartAttempt(let step):
vpnLogger.log(step, named: "Tunnel Start")

switch step {
case .begin:
DailyPixel.fireDailyAndCount(pixel: .networkProtectionTunnelStartAttempt)
Expand All @@ -98,6 +109,8 @@ final class NetworkProtectionPacketTunnelProvider: PacketTunnelProvider {
DailyPixel.fireDailyAndCount(pixel: .networkProtectionTunnelStartSuccess)
}
case .tunnelStopAttempt(let step):
vpnLogger.log(step, named: "Tunnel Stop")

switch step {
case .begin:
Pixel.fire(pixel: .networkProtectionTunnelStopAttempt)
Expand All @@ -107,6 +120,8 @@ final class NetworkProtectionPacketTunnelProvider: PacketTunnelProvider {
DailyPixel.fireDailyAndCount(pixel: .networkProtectionTunnelStopSuccess)
}
case .tunnelUpdateAttempt(let step):
vpnLogger.log(step, named: "Tunnel Update")

switch step {
case .begin:
DailyPixel.fireDailyAndCount(pixel: .networkProtectionTunnelUpdateAttempt)
Expand All @@ -116,6 +131,8 @@ final class NetworkProtectionPacketTunnelProvider: PacketTunnelProvider {
DailyPixel.fireDailyAndCount(pixel: .networkProtectionTunnelUpdateSuccess)
}
case .tunnelWakeAttempt(let step):
vpnLogger.log(step, named: "Tunnel Wake")

switch step {
case .begin:
Pixel.fire(pixel: .networkProtectionTunnelWakeAttempt)
Expand All @@ -125,6 +142,8 @@ final class NetworkProtectionPacketTunnelProvider: PacketTunnelProvider {
DailyPixel.fireDailyAndCount(pixel: .networkProtectionTunnelWakeSuccess)
}
case .failureRecoveryAttempt(let step):
vpnLogger.log(step)

switch step {
case .started:
DailyPixel.fireDailyAndCount(pixel: .networkProtectionFailureRecoveryStarted)
Expand All @@ -136,6 +155,8 @@ final class NetworkProtectionPacketTunnelProvider: PacketTunnelProvider {
DailyPixel.fireDailyAndCount(pixel: .networkProtectionFailureRecoveryFailed, error: error)
}
case .serverMigrationAttempt(let step):
vpnLogger.log(step, named: "Server Migration")

switch step {
case .begin:
DailyPixel.fireDailyAndCount(pixel: .networkProtectionServerMigrationAttempt)
Expand All @@ -145,6 +166,7 @@ final class NetworkProtectionPacketTunnelProvider: PacketTunnelProvider {
DailyPixel.fireDailyAndCount(pixel: .networkProtectionServerMigrationAttemptSuccess)
}
case .tunnelStartOnDemandWithoutAccessToken:
vpnLogger.logStartingWithoutAuthToken()
DailyPixel.fireDailyAndCount(pixel: .networkProtectionTunnelStartAttemptOnDemandWithoutAccessToken)
}
}
Expand Down Expand Up @@ -391,5 +413,5 @@ final class NetworkProtectionPacketTunnelProvider: PacketTunnelProvider {
}

// swiftlint:enable type_body_length

// swiftlint:disable:next file_length
#endif
108 changes: 108 additions & 0 deletions PacketTunnelProvider/NetworkProtection/VPNLogger.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
//
// VPNLogger.swift
// DuckDuckGo
//
// Copyright © 2023 DuckDuckGo. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

import Foundation
import NetworkProtection
// swiftlint:disable:next enforce_os_log_wrapper
import OSLog

/// Logger for the VPN
///
/// Since we'll want to ensure this adheres to our privacy standards, grouping the logging logic to be mostly
/// handled by a single class sounds like a good approach to be able to review what's being logged..
///
public final class VPNLogger {
public typealias AttemptStep = PacketTunnelProvider.AttemptStep
public typealias ConnectionAttempt = PacketTunnelProvider.ConnectionAttempt
public typealias LogCallback = (OSLogType, OSLogMessage) -> Void

public init() {}

public func logStartingWithoutAuthToken() {
os_log("🔴 Starting tunnel without an auth token", log: .networkProtection, type: .error)
}

public func log(_ step: AttemptStep, named name: String) {
let log = OSLog.networkProtection

switch step {
case .begin:
os_log("🔵 %{public}@ attempt begins", log: log, name)
case .failure(let error):
os_log("🔴 %{public}@ attempt failed with error: %{public}@", log: log, type: .error, name, error.localizedDescription)
case .success:
os_log("🟢 %{public}@ attempt succeeded", log: log, name)
}
}

public func log(_ step: ConnectionAttempt) {
let log = OSLog.networkProtection

switch step {
case .connecting:
os_log("🔵 Connection attempt detected", log: log)
case .failure:
os_log("🔴 Connection attempt failed", log: log, type: .error)
case .success:
os_log("🟢 Connection attempt successful", log: log)
}
}

public func log(_ step: FailureRecoveryStep) {
let log = OSLog.networkProtectionTunnelFailureMonitorLog

switch step {
case .started:
os_log("🔵 Failure Recovery attempt started", log: log)
case .failed(let error):
os_log("🔴 Failure Recovery attempt failed with error: %{public}@", log: log, type: .error, error.localizedDescription)
case .completed(let health):
switch health {
case .healthy:
os_log("🟢 Failure Recovery attempt completed", log: log)
case .unhealthy:
os_log("🔴 Failure Recovery attempt ended as unhealthy", log: log, type: .error)
}
}
}

public func log(_ step: NetworkProtectionTunnelFailureMonitor.Result) {
let log = OSLog.networkProtectionTunnelFailureMonitorLog

switch step {
case .failureDetected:
os_log("🔴 Tunnel failure detected", log: log, type: .error)
case .failureRecovered:
os_log("🟢 Tunnel failure recovered", log: log)
case .networkPathChanged:
os_log("🔵 Tunnel recovery detected path change", log: log)
}
}

public func log(_ result: NetworkProtectionLatencyMonitor.Result) {
let log = OSLog.networkProtectionLatencyMonitorLog

switch result {
case .error:
os_log("🔴 There was an error logging the latency", log: log, type: .error)
case .quality(let quality):
os_log("Connection quality is: %{public}@", log: log, quality.rawValue)
}
}
}
Loading