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

Crash report cohort ID support for iOS #3692

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 6 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
5 changes: 5 additions & 0 deletions Core/PixelEvent.swift
Original file line number Diff line number Diff line change
Expand Up @@ -505,6 +505,9 @@ extension Pixel {
case dbCrashDetected
case crashOnCrashHandlersSetUp

case crashReportCRCIDMissing // crashreporting_crcid-missing
case crashReportingSubmissionFailed // crashreporting_submission-failed
Copy link
Contributor

Choose a reason for hiding this comment

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

We can omit the comments here for consistency, since the value below will contain the raw name.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for catching this, it some leftover note taking from when I was working it all out :) I’ve removed from both iOS and macOS clients and will push shortly.


case dbMigrationError
case dbRemovalError
case dbDestroyError
Expand Down Expand Up @@ -1367,6 +1370,8 @@ extension Pixel.Event {
// MARK: debug pixels

case .dbCrashDetected: return "m_d_crash"
case .crashReportCRCIDMissing: return "crashreporting_crcid-missing"
case .crashReportingSubmissionFailed: return "crashreporting_submission-failed"
case .crashOnCrashHandlersSetUp: return "m_d_crash_on_handlers_setup"
case .dbMigrationError: return "m_d_dbme"
case .dbRemovalError: return "m_d_dbre"
Expand Down
4 changes: 4 additions & 0 deletions DuckDuckGo.xcodeproj/project.pbxproj
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,7 @@
37FCAABC2992F592000E420A /* MultilineScrollableTextFix.swift in Sources */ = {isa = PBXBuildFile; fileRef = 37FCAABB2992F592000E420A /* MultilineScrollableTextFix.swift */; };
37FCAAC029930E26000E420A /* FailedAssertionView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 37FCAABF29930E26000E420A /* FailedAssertionView.swift */; };
37FD780F2A29E28B00B36DB1 /* SyncErrorHandler.swift in Sources */ = {isa = PBXBuildFile; fileRef = 37FD780E2A29E28B00B36DB1 /* SyncErrorHandler.swift */; };
46DD3D5A2D0A29F600F33D49 /* CrashReportSenderExtensions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 46DD3D592D0A29F400F33D49 /* CrashReportSenderExtensions.swift */; };
4B0295192537BC6700E00CEF /* ConfigurationDebugViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4B0295182537BC6700E00CEF /* ConfigurationDebugViewController.swift */; };
4B0F3F502B9BFF2100392892 /* NetworkProtectionFAQView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4B0F3F4F2B9BFF2100392892 /* NetworkProtectionFAQView.swift */; };
4B274F602AFEAECC003F0745 /* NetworkProtectionWidgetRefreshModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4B274F5F2AFEAECC003F0745 /* NetworkProtectionWidgetRefreshModel.swift */; };
Expand Down Expand Up @@ -1577,6 +1578,7 @@
37FCAABF29930E26000E420A /* FailedAssertionView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FailedAssertionView.swift; sourceTree = "<group>"; };
37FCAACB2993149A000E420A /* Waitlist */ = {isa = PBXFileReference; lastKnownFileType = wrapper; path = Waitlist; sourceTree = "<group>"; };
37FD780E2A29E28B00B36DB1 /* SyncErrorHandler.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SyncErrorHandler.swift; sourceTree = "<group>"; };
46DD3D592D0A29F400F33D49 /* CrashReportSenderExtensions.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CrashReportSenderExtensions.swift; sourceTree = "<group>"; };
4B0295182537BC6700E00CEF /* ConfigurationDebugViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ConfigurationDebugViewController.swift; sourceTree = "<group>"; };
4B0F3F4F2B9BFF2100392892 /* NetworkProtectionFAQView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NetworkProtectionFAQView.swift; sourceTree = "<group>"; };
4B274F5F2AFEAECC003F0745 /* NetworkProtectionWidgetRefreshModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NetworkProtectionWidgetRefreshModel.swift; sourceTree = "<group>"; };
Expand Down Expand Up @@ -3783,6 +3785,7 @@
37CF915E2BB4735F00BADCAE /* Crashes */ = {
isa = PBXGroup;
children = (
46DD3D592D0A29F400F33D49 /* CrashReportSenderExtensions.swift */,
37CF915F2BB4737300BADCAE /* CrashCollectionOnboarding.swift */,
37CF91612BB474AA00BADCAE /* CrashCollectionOnboardingView.swift */,
37CF91632BB4A82A00BADCAE /* CrashCollectionOnboardingViewModel.swift */,
Expand Down Expand Up @@ -8109,6 +8112,7 @@
BDF8D0022C1B87F4003E3B27 /* NetworkProtectionDNSSettingsViewModel.swift in Sources */,
9838059F2228208E00385F1A /* PositiveFeedbackViewController.swift in Sources */,
8590CB67268A2E520089F6BF /* RootDebugViewController.swift in Sources */,
46DD3D5A2D0A29F600F33D49 /* CrashReportSenderExtensions.swift in Sources */,
1DEAADEA2BA4539800E25A97 /* SettingsAppearanceView.swift in Sources */,
B623C1C22862CA9E0043013E /* DownloadSession.swift in Sources */,
9F7CFF7F2C8A94F70012833E /* OnboardingView+AddressBarPositionContent.swift in Sources */,
Expand Down
4 changes: 3 additions & 1 deletion DuckDuckGo/AppDelegate.swift
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,9 @@ import os.log
private var syncStateCancellable: AnyCancellable?
private var isSyncInProgressCancellable: AnyCancellable?

private let crashCollection = CrashCollection(platform: .iOS)
private let crashCollection = CrashCollection(crashReportSender: CrashReportSender(platform: .iOS,
pixelEvents: CrashReportSender.pixelEvents),
crashCollectionStorage: UserDefaults())
private var crashReportUploaderOnboarding: CrashCollectionOnboarding?

private var autofillPixelReporter: AutofillPixelReporter?
Expand Down
2 changes: 1 addition & 1 deletion DuckDuckGo/AppUserDefaults.swift
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ public class AppUserDefaults: AppSettings {

static let crashCollectionOptInStatus = "com.duckduckgo.ios.crashCollectionOptInStatus"
static let crashCollectionShouldRevertOptedInStatusTrigger = "com.duckduckgo.ios.crashCollectionShouldRevertOptedInStatusTrigger"

static let duckPlayerMode = "com.duckduckgo.ios.duckPlayerMode"
static let duckPlayerAskModeOverlayHidden = "com.duckduckgo.ios.duckPlayerAskModeOverlayHidden"
static let duckPlayerOpenInNewTab = "com.duckduckgo.ios.duckPlayerOpenInNewTab"
Expand Down
3 changes: 3 additions & 0 deletions DuckDuckGo/CrashCollectionOnboarding.swift
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,12 @@ final class CrashCollectionOnboarding: NSObject {
func presentOnboardingIfNeeded(for payloads: [Data], from viewController: UIViewController, sendReport: @escaping () -> Void) {
let isCurrentlyPresenting = viewController.presentedViewController != nil

// Note: DO NOT TURN THIS ON until updated screens for the opt-in prompt and screen for reviewing the kinds of data
// we collect are updated (project coming soon)
if featureFlagger.isFeatureOn(.crashReportOptInStatusResetting) {
if appSettings.crashCollectionOptInStatus == .optedIn &&
appSettings.crashCollectionShouldRevertOptedInStatusTrigger < crashCollectionShouldRevertOptedInStatusTriggerTargetValue {

appSettings.crashCollectionOptInStatus = .undetermined
appSettings.crashCollectionShouldRevertOptedInStatusTrigger = crashCollectionShouldRevertOptedInStatusTriggerTargetValue
}
Expand Down
6 changes: 6 additions & 0 deletions DuckDuckGo/CrashCollectionOnboardingViewModel.swift
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

import Foundation
import SwiftUI
import Crashes

final class CrashCollectionOnboardingViewModel: ObservableObject {

Expand Down Expand Up @@ -106,6 +107,11 @@ final class CrashCollectionOnboardingViewModel: ObservableObject {
}
set {
appSettings.crashCollectionOptInStatus = newValue
if appSettings.crashCollectionOptInStatus == .optedOut {
let crashCollection = CrashCollection.init(crashReportSender: CrashReportSender(platform: .iOS,
pixelEvents: CrashReportSender.pixelEvents))
crashCollection.clearCRCID()
}
}
}
}
40 changes: 40 additions & 0 deletions DuckDuckGo/CrashReportSenderExtensions.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
//
// CrashReportSenderExtensions.swift
// DuckDuckGo
//
// Copyright © 2024 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 Crashes
import Common
import Core

extension CrashReportSender {

static let pixelEvents: EventMapping<CrashReportSenderError> = .init { event, _, _, _ in
switch event {
case CrashReportSenderError.crcidMissing:
Pixel.fire(pixel: .crashReportCRCIDMissing)

case CrashReportSenderError.submissionFailed(let error):
if let error {
Pixel.fire(pixel: .crashReportingSubmissionFailed,
withAdditionalParameters: ["HTTPStatusCode": "\(error.statusCode)"])
} else {
Pixel.fire(pixel: .crashReportingSubmissionFailed)
}
}
}
}
5 changes: 5 additions & 0 deletions DuckDuckGo/SettingsViewModel.swift
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import Common
import Combine
import SyncUI
import DuckPlayer
import Crashes

import Subscription
import NetworkProtection
Expand Down Expand Up @@ -353,6 +354,10 @@ final class SettingsViewModel: ObservableObject {
Binding<Bool>(
get: { self.state.crashCollectionOptInStatus == .optedIn },
set: {
if self.appSettings.crashCollectionOptInStatus == .optedIn && $0 == false {
let crashCollection = CrashCollection(crashReportSender: CrashReportSender(platform: .iOS, pixelEvents: CrashReportSender.pixelEvents))
crashCollection.clearCRCID()
}
self.appSettings.crashCollectionOptInStatus = $0 ? .optedIn : .optedOut
self.state.crashCollectionOptInStatus = $0 ? .optedIn : .optedOut
}
Expand Down
1 change: 0 additions & 1 deletion DuckDuckGoTests/AppSettingsMock.swift
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,6 @@ class AppSettingsMock: AppSettings {
var autoconsentEnabled = true

var crashCollectionOptInStatus: CrashCollectionOptInStatus = .undetermined

var crashCollectionShouldRevertOptedInStatusTrigger: Int = 0

var newTabPageSectionsEnabled: Bool = false
Expand Down