Skip to content
This repository was archived by the owner on Feb 24, 2025. It is now read-only.

Commit be5aa6d

Browse files
jotaemepereirajotaemepereira
authored
DBP: Add tries to opt-out success-submit and failure pixels (#2330)
1 parent 0467ca2 commit be5aa6d

9 files changed

+172
-15
lines changed

‎LocalPackages/DataBrokerProtection/Sources/DataBrokerProtection/Database/DataBrokerProtectionDatabase.swift

+30
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ protocol DataBrokerProtectionRepository {
4040

4141
func add(_ historyEvent: HistoryEvent)
4242
func fetchLastEvent(brokerId: Int64, profileQueryId: Int64) -> HistoryEvent?
43+
func fetchScanHistoryEvents(brokerId: Int64, profileQueryId: Int64) -> [HistoryEvent]
44+
func fetchOptOutHistoryEvents(brokerId: Int64, profileQueryId: Int64, extractedProfileId: Int64) -> [HistoryEvent]
4345
func hasMatches() -> Bool
4446

4547
func fetchAttemptInformation(for extractedProfileId: Int64) -> AttemptInformation?
@@ -276,6 +278,34 @@ final class DataBrokerProtectionDatabase: DataBrokerProtectionRepository {
276278
}
277279
}
278280

281+
func fetchScanHistoryEvents(brokerId: Int64, profileQueryId: Int64) -> [HistoryEvent] {
282+
do {
283+
let vault = try self.vault ?? DataBrokerProtectionSecureVaultFactory.makeVault(errorReporter: nil)
284+
guard let scan = try vault.fetchScan(brokerId: brokerId, profileQueryId: profileQueryId) else {
285+
return [HistoryEvent]()
286+
}
287+
288+
return scan.historyEvents
289+
} catch {
290+
os_log("Database error: fetchHistoryEvents, error: %{public}@", log: .error, error.localizedDescription)
291+
return [HistoryEvent]()
292+
}
293+
}
294+
295+
func fetchOptOutHistoryEvents(brokerId: Int64, profileQueryId: Int64, extractedProfileId: Int64) -> [HistoryEvent] {
296+
do {
297+
let vault = try self.vault ?? DataBrokerProtectionSecureVaultFactory.makeVault(errorReporter: nil)
298+
guard let optOut = try vault.fetchOptOut(brokerId: brokerId, profileQueryId: profileQueryId, extractedProfileId: extractedProfileId) else {
299+
return [HistoryEvent]()
300+
}
301+
302+
return optOut.historyEvents
303+
} catch {
304+
os_log("Database error: fetchHistoryEvents, error: %{public}@", log: .error, error.localizedDescription)
305+
return [HistoryEvent]()
306+
}
307+
}
308+
279309
func hasMatches() -> Bool {
280310
do {
281311
let vault = try self.vault ?? DataBrokerProtectionSecureVaultFactory.makeVault(errorReporter: nil)

‎LocalPackages/DataBrokerProtection/Sources/DataBrokerProtection/DebugUI/DataBrokerRunCustomJSONViewModel.swift

+2-2
Original file line numberDiff line numberDiff line change
@@ -222,10 +222,10 @@ final class FakeStageDurationCalculator: StageDurationCalculator {
222222
func fireOptOutValidate() {
223223
}
224224

225-
func fireOptOutSubmitSuccess() {
225+
func fireOptOutSubmitSuccess(tries: Int) {
226226
}
227227

228-
func fireOptOutFailure() {
228+
func fireOptOutFailure(tries: Int) {
229229
}
230230

231231
func fireScanSuccess(matchesFound: Int) {

‎LocalPackages/DataBrokerProtection/Sources/DataBrokerProtection/Operations/DataBrokerProfileQueryOperationManager.swift

+7-1
Original file line numberDiff line numberDiff line change
@@ -279,6 +279,7 @@ struct DataBrokerProfileQueryOperationManager: OperationsManager {
279279
return
280280
}
281281

282+
let retriesCalculatorUseCase = OperationRetriesCalculatorUseCase()
282283
let stageDurationCalculator = DataBrokerProtectionStageDurationCalculator(dataBroker: brokerProfileQueryData.dataBroker.name, handler: pixelHandler)
283284
stageDurationCalculator.fireOptOutStart()
284285
os_log("Running opt-out operation: %{public}@", log: .dataBrokerProtection, String(describing: brokerProfileQueryData.dataBroker.name))
@@ -319,6 +320,10 @@ struct DataBrokerProfileQueryOperationManager: OperationsManager {
319320
showWebView: showWebView,
320321
shouldRunNextStep: shouldRunNextStep)
321322

323+
let tries = retriesCalculatorUseCase.calculateForOptOut(database: database, brokerId: brokerId, profileQueryId: profileQueryId, extractedProfileId: extractedProfileId)
324+
stageDurationCalculator.fireOptOutValidate()
325+
stageDurationCalculator.fireOptOutSubmitSuccess(tries: tries)
326+
322327
let updater = OperationPreferredDateUpdaterUseCase(database: database)
323328
updater.updateChildrenBrokerForParentBroker(brokerProfileQueryData.dataBroker,
324329
profileQueryId: profileQueryId)
@@ -330,7 +335,8 @@ struct DataBrokerProfileQueryOperationManager: OperationsManager {
330335
startTime: stageDurationCalculator.startTime)
331336
database.add(.init(extractedProfileId: extractedProfileId, brokerId: brokerId, profileQueryId: profileQueryId, type: .optOutRequested))
332337
} catch {
333-
stageDurationCalculator.fireOptOutFailure()
338+
let tries = retriesCalculatorUseCase.calculateForOptOut(database: database, brokerId: brokerId, profileQueryId: profileQueryId, extractedProfileId: extractedProfileId)
339+
stageDurationCalculator.fireOptOutFailure(tries: tries)
334340
handleOperationError(
335341
origin: .optOut,
336342
brokerId: brokerId,

‎LocalPackages/DataBrokerProtection/Sources/DataBrokerProtection/Operations/OperationRetriesCalculatorUseCase.swift

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
//
2+
// OperationRetriesCalculatorUseCase.swift
3+
//
4+
// Copyright © 2023 DuckDuckGo. All rights reserved.
5+
//
6+
// Licensed under the Apache License, Version 2.0 (the "License");
7+
// you may not use this file except in compliance with the License.
8+
// You may obtain a copy of the License at
9+
//
10+
// http://www.apache.org/licenses/LICENSE-2.0
11+
//
12+
// Unless required by applicable law or agreed to in writing, software
13+
// distributed under the License is distributed on an "AS IS" BASIS,
14+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
// See the License for the specific language governing permissions and
16+
// limitations under the License.
17+
//
18+
19+
import Foundation
20+
21+
struct OperationRetriesCalculatorUseCase {
22+
23+
func calculateForScan(database: DataBrokerProtectionRepository, brokerId: Int64, profileQueryId: Int64) -> Int {
24+
let events = database.fetchScanHistoryEvents(brokerId: brokerId, profileQueryId: profileQueryId)
25+
26+
return events.filter { $0.type == .scanStarted }.count
27+
}
28+
29+
func calculateForOptOut(database: DataBrokerProtectionRepository, brokerId: Int64, profileQueryId: Int64, extractedProfileId: Int64) -> Int {
30+
let events = database.fetchOptOutHistoryEvents(brokerId: brokerId, profileQueryId: profileQueryId, extractedProfileId: extractedProfileId)
31+
32+
return events.filter { $0.type == .optOutStarted }.count
33+
}
34+
}

‎LocalPackages/DataBrokerProtection/Sources/DataBrokerProtection/Operations/OptOutOperation.swift

-2
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,6 @@ final class OptOutOperation: DataBrokerOperation {
112112
await runNextAction(action)
113113
} else {
114114
await webViewHandler?.finish() // If we executed all steps we release the web view
115-
stageCalculator?.fireOptOutValidate()
116-
stageCalculator?.fireOptOutSubmitSuccess()
117115
complete(())
118116
}
119117
}

‎LocalPackages/DataBrokerProtection/Sources/DataBrokerProtection/Pixels/DataBrokerProtectionPixels.swift

+6-6
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,9 @@ public enum DataBrokerProtectionPixels {
7171
case optOutFinish(dataBroker: String, attemptId: UUID, duration: Double)
7272

7373
// Process Pixels
74-
case optOutSubmitSuccess(dataBroker: String, attemptId: UUID, duration: Double, emailPattern: String?)
74+
case optOutSubmitSuccess(dataBroker: String, attemptId: UUID, duration: Double, tries: Int, emailPattern: String?)
7575
case optOutSuccess(dataBroker: String, attemptId: UUID, duration: Double, brokerType: DataBrokerHierarchy)
76-
case optOutFailure(dataBroker: String, attemptId: UUID, duration: Double, stage: String, emailPattern: String?)
76+
case optOutFailure(dataBroker: String, attemptId: UUID, duration: Double, stage: String, tries: Int, emailPattern: String?)
7777

7878
// Backgrond Agent events
7979
case backgroundAgentStarted
@@ -227,16 +227,16 @@ extension DataBrokerProtectionPixels: PixelKitEvent {
227227
return [Consts.dataBrokerParamKey: dataBroker, Consts.attemptIdParamKey: attemptId.uuidString, Consts.durationParamKey: String(duration)]
228228
case .optOutFinish(let dataBroker, let attemptId, let duration):
229229
return [Consts.dataBrokerParamKey: dataBroker, Consts.attemptIdParamKey: attemptId.uuidString, Consts.durationParamKey: String(duration)]
230-
case .optOutSubmitSuccess(let dataBroker, let attemptId, let duration, let pattern):
231-
var params = [Consts.dataBrokerParamKey: dataBroker, Consts.attemptIdParamKey: attemptId.uuidString, Consts.durationParamKey: String(duration)]
230+
case .optOutSubmitSuccess(let dataBroker, let attemptId, let duration, let tries, let pattern):
231+
var params = [Consts.dataBrokerParamKey: dataBroker, Consts.attemptIdParamKey: attemptId.uuidString, Consts.durationParamKey: String(duration), Consts.triesKey: String(tries)]
232232
if let pattern = pattern {
233233
params[Consts.pattern] = pattern
234234
}
235235
return params
236236
case .optOutSuccess(let dataBroker, let attemptId, let duration, let type):
237237
return [Consts.dataBrokerParamKey: dataBroker, Consts.attemptIdParamKey: attemptId.uuidString, Consts.durationParamKey: String(duration), Consts.isParent: String(type.rawValue)]
238-
case .optOutFailure(let dataBroker, let attemptId, let duration, let stage, let pattern):
239-
var params = [Consts.dataBrokerParamKey: dataBroker, Consts.attemptIdParamKey: attemptId.uuidString, Consts.durationParamKey: String(duration), Consts.stageKey: stage]
238+
case .optOutFailure(let dataBroker, let attemptId, let duration, let stage, let tries, let pattern):
239+
var params = [Consts.dataBrokerParamKey: dataBroker, Consts.attemptIdParamKey: attemptId.uuidString, Consts.durationParamKey: String(duration), Consts.stageKey: stage, Consts.triesKey: String(tries)]
240240
if let pattern = pattern {
241241
params[Consts.pattern] = pattern
242242
}

‎LocalPackages/DataBrokerProtection/Sources/DataBrokerProtection/Pixels/DataBrokerProtectionStageDurationCalculator.swift

+6-4
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ protocol StageDurationCalculator {
4646
func fireOptOutEmailReceive()
4747
func fireOptOutEmailConfirm()
4848
func fireOptOutValidate()
49-
func fireOptOutSubmitSuccess()
50-
func fireOptOutFailure()
49+
func fireOptOutSubmitSuccess(tries: Int)
50+
func fireOptOutFailure(tries: Int)
5151
func fireScanSuccess(matchesFound: Int)
5252
func fireScanFailed()
5353
func fireScanError(error: Error)
@@ -129,18 +129,20 @@ final class DataBrokerProtectionStageDurationCalculator: StageDurationCalculator
129129
handler.fire(.optOutValidate(dataBroker: dataBroker, attemptId: attemptId, duration: durationSinceLastStage()))
130130
}
131131

132-
func fireOptOutSubmitSuccess() {
132+
func fireOptOutSubmitSuccess(tries: Int) {
133133
handler.fire(.optOutSubmitSuccess(dataBroker: dataBroker,
134134
attemptId: attemptId,
135135
duration: durationSinceStartTime(),
136+
tries: tries,
136137
emailPattern: emailPattern))
137138
}
138139

139-
func fireOptOutFailure() {
140+
func fireOptOutFailure(tries: Int) {
140141
handler.fire(.optOutFailure(dataBroker: dataBroker,
141142
attemptId: attemptId,
142143
duration: durationSinceStartTime(),
143144
stage: stage.rawValue,
145+
tries: tries,
144146
emailPattern: emailPattern))
145147
}
146148

‎LocalPackages/DataBrokerProtection/Tests/DataBrokerProtectionTests/DataBrokerProfileQueryOperationManagerTests.swift

+77
Original file line numberDiff line numberDiff line change
@@ -707,6 +707,83 @@ final class DataBrokerProfileQueryOperationManagerTests: XCTestCase {
707707
}
708708
}
709709

710+
func testCorrectNumberOfTriesIsFired_whenOptOutSucceeds() async {
711+
do {
712+
mockDatabase.historyEvents = [
713+
.init(brokerId: 1, profileQueryId: 1, type: .optOutStarted),
714+
.init(brokerId: 1, profileQueryId: 1, type: .error(error: .cancelled)),
715+
.init(brokerId: 1, profileQueryId: 1, type: .optOutStarted),
716+
.init(brokerId: 1, profileQueryId: 1, type: .error(error: .cancelled)),
717+
.init(brokerId: 1, profileQueryId: 1, type: .optOutStarted),
718+
]
719+
_ = try await sut.runOptOutOperation(
720+
for: .mockWithoutRemovedDate,
721+
on: mockWebOperationRunner,
722+
brokerProfileQueryData: .init(
723+
dataBroker: .mock,
724+
profileQuery: .mock,
725+
scanOperationData: .mock,
726+
optOutOperationsData: [OptOutOperationData.mock(with: .mockWithoutRemovedDate)]
727+
),
728+
database: mockDatabase,
729+
notificationCenter: .default,
730+
pixelHandler: MockDataBrokerProtectionPixelsHandler(),
731+
userNotificationService: MockUserNotification(),
732+
shouldRunNextStep: { true }
733+
)
734+
if let lastPixelFired = MockDataBrokerProtectionPixelsHandler.lastPixelsFired.last {
735+
switch lastPixelFired {
736+
case .optOutSubmitSuccess(_, _, _, let tries, _):
737+
XCTAssertEqual(tries, 3)
738+
default: XCTFail("We should be firing the opt-out submit-success pixel last")
739+
}
740+
} else {
741+
XCTFail("We should be firing the opt-out submit-success pixel")
742+
}
743+
} catch {
744+
XCTFail("Should not throw")
745+
}
746+
}
747+
748+
func testCorrectNumberOfTriesIsFired_whenOptOutFails() async {
749+
do {
750+
mockWebOperationRunner.shouldOptOutThrow = true
751+
mockDatabase.historyEvents = [
752+
.init(brokerId: 1, profileQueryId: 1, type: .optOutStarted),
753+
.init(brokerId: 1, profileQueryId: 1, type: .error(error: .cancelled)),
754+
.init(brokerId: 1, profileQueryId: 1, type: .optOutStarted),
755+
.init(brokerId: 1, profileQueryId: 1, type: .error(error: .cancelled)),
756+
.init(brokerId: 1, profileQueryId: 1, type: .optOutStarted),
757+
]
758+
_ = try await sut.runOptOutOperation(
759+
for: .mockWithoutRemovedDate,
760+
on: mockWebOperationRunner,
761+
brokerProfileQueryData: .init(
762+
dataBroker: .mock,
763+
profileQuery: .mock,
764+
scanOperationData: .mock,
765+
optOutOperationsData: [OptOutOperationData.mock(with: .mockWithoutRemovedDate)]
766+
),
767+
database: mockDatabase,
768+
notificationCenter: .default,
769+
pixelHandler: MockDataBrokerProtectionPixelsHandler(),
770+
userNotificationService: MockUserNotification(),
771+
shouldRunNextStep: { true }
772+
)
773+
XCTFail("The code above should throw")
774+
} catch {
775+
if let lastPixelFired = MockDataBrokerProtectionPixelsHandler.lastPixelsFired.last {
776+
switch lastPixelFired {
777+
case .optOutFailure(_, _, _, _, let tries, _):
778+
XCTAssertEqual(tries, 3)
779+
default: XCTFail("We should be firing the opt-out submit-success pixel last")
780+
}
781+
} else {
782+
XCTFail("We should be firing the opt-out submit-success pixel")
783+
}
784+
}
785+
}
786+
710787
// MARK: - Update operation dates tests
711788

712789
func testWhenUpdatingDatesOnOptOutAndLastEventIsError_thenWeSetPreferredRunDateWithRetryErrorDate() throws {

‎LocalPackages/DataBrokerProtection/Tests/DataBrokerProtectionTests/Mocks.swift

+10
Original file line numberDiff line numberDiff line change
@@ -658,6 +658,7 @@ final class MockDatabase: DataBrokerProtectionRepository {
658658
var brokerProfileQueryDataToReturn = [BrokerProfileQueryData]()
659659
var profile: DataBrokerProtectionProfile?
660660
var attemptInformation: AttemptInformation?
661+
var historyEvents = [HistoryEvent]()
661662

662663
lazy var callsList: [Bool] = [
663664
wasSaveProfileCalled,
@@ -759,6 +760,14 @@ final class MockDatabase: DataBrokerProtectionRepository {
759760
return lastHistoryEventToReturn
760761
}
761762

763+
func fetchScanHistoryEvents(brokerId: Int64, profileQueryId: Int64) -> [HistoryEvent] {
764+
return [HistoryEvent]()
765+
}
766+
767+
func fetchOptOutHistoryEvents(brokerId: Int64, profileQueryId: Int64, extractedProfileId: Int64) -> [HistoryEvent] {
768+
return historyEvents
769+
}
770+
762771
func hasMatches() -> Bool {
763772
false
764773
}
@@ -804,6 +813,7 @@ final class MockDatabase: DataBrokerProtectionRepository {
804813
brokerProfileQueryDataToReturn.removeAll()
805814
profile = nil
806815
attemptInformation = nil
816+
historyEvents.removeAll()
807817
}
808818
}
809819

0 commit comments

Comments
 (0)