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

Update to subscription cookie #1053

Merged
merged 6 commits into from
Nov 1, 2024
Merged

Update to subscription cookie #1053

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
39ffea3
Restrict cookie domain
miasma13 Oct 31, 2024
f8ef18d
Update the logic to use empty value cookie instead of deleting one
miasma13 Oct 31, 2024
310ea11
Add new feature flag
miasma13 Oct 31, 2024
3b196ce
Support enabling and disabling SubscriptionCookieManager to operate
miasma13 Oct 31, 2024
37de1b6
Change how the notifications are handled
miasma13 Oct 31, 2024
9506581
Fix tests
miasma13 Oct 31, 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
1 change: 1 addition & 0 deletions Sources/BrowserServicesKit/PrivacyConfig/Features/PrivacyFeature.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,7 @@ public enum PrivacyProSubfeature: String, Equatable, PrivacySubfeature {
case isLaunchedOverride
case isLaunchedOverrideStripe
case useUnifiedFeedback
case setAccessTokenCookieForSubscriptionDomains
}

public enum SslCertificatesSubfeature: String, PrivacySubfeature {
Expand Down
83 changes: 51 additions & 32 deletions Sources/Subscription/SubscriptionCookie/SubscriptionCookieManager.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ import os.log

public protocol SubscriptionCookieManaging {
init(subscriptionManager: SubscriptionManager, currentCookieStore: @MainActor @escaping () -> HTTPCookieStore?, eventMapping: EventMapping<SubscriptionCookieManagerEvent>)
func enableSettingSubscriptionCookie()
func disableSettingSubscriptionCookie() async

func refreshSubscriptionCookie() async
func resetLastRefreshDate()

Expand All @@ -30,7 +33,7 @@ public protocol SubscriptionCookieManaging {

public final class SubscriptionCookieManager: SubscriptionCookieManaging {

public static let cookieDomain = ".duckduckgo.com"
public static let cookieDomain = "subscriptions.duckduckgo.com"
public static let cookieName = "privacy_pro_access_token"

private static let defaultRefreshTimeInterval: TimeInterval = .hours(4)
Expand All @@ -41,6 +44,7 @@ public final class SubscriptionCookieManager: SubscriptionCookieManaging {

public private(set) var lastRefreshDate: Date?
private let refreshTimeInterval: TimeInterval
private var isSettingSubscriptionCookieEnabled: Bool = false

convenience nonisolated public required init(subscriptionManager: SubscriptionManager,
currentCookieStore: @MainActor @escaping () -> HTTPCookieStore?,
Expand All @@ -60,17 +64,28 @@ public final class SubscriptionCookieManager: SubscriptionCookieManaging {
self.eventMapping = eventMapping
self.refreshTimeInterval = refreshTimeInterval

registerForSubscriptionAccountManagerEvents()
}

private func registerForSubscriptionAccountManagerEvents() {
NotificationCenter.default.addObserver(self, selector: #selector(handleAccountDidSignIn), name: .accountDidSignIn, object: nil)
NotificationCenter.default.addObserver(self, selector: #selector(handleAccountDidSignOut), name: .accountDidSignOut, object: nil)
}

public func enableSettingSubscriptionCookie() {
isSettingSubscriptionCookieEnabled = true
}

public func disableSettingSubscriptionCookie() async {
isSettingSubscriptionCookieEnabled = false
if let cookieStore = await currentCookieStore(),
let cookie = await cookieStore.fetchCurrentSubscriptionCookie() {
await cookieStore.deleteCookie(cookie)
}
}

@objc private func handleAccountDidSignIn() {
Task {
guard let cookieStore = await currentCookieStore() else { return }
guard isSettingSubscriptionCookieEnabled,
let cookieStore = await currentCookieStore()
else { return }

guard let accessToken = subscriptionManager.accountManager.accessToken else {
Logger.subscription.error("[SubscriptionCookieManager] Handle .accountDidSignIn - can't set the cookie, token is missing")
eventMapping.fire(.errorHandlingAccountDidSignInTokenIsMissing)
Expand All @@ -89,47 +104,47 @@ public final class SubscriptionCookieManager: SubscriptionCookieManaging {

@objc private func handleAccountDidSignOut() {
Task {
guard let cookieStore = await currentCookieStore() else { return }
guard let subscriptionCookie = await cookieStore.fetchCurrentSubscriptionCookie() else {
Logger.subscription.error("[SubscriptionCookieManager] Handle .accountDidSignOut - can't delete the cookie, cookie is missing")
eventMapping.fire(.errorHandlingAccountDidSignOutCookieIsMissing)
return
}
guard isSettingSubscriptionCookieEnabled,
let cookieStore = await currentCookieStore()
else { return }
Logger.subscription.info("[SubscriptionCookieManager] Handle .accountDidSignOut - deleting cookie")
await cookieStore.deleteCookie(subscriptionCookie)
updateLastRefreshDateToNow()

do {
try await cookieStore.setEmptySubscriptionCookie()
updateLastRefreshDateToNow()
} catch {
eventMapping.fire(.failedToSetSubscriptionCookie)
}
}
}

public func refreshSubscriptionCookie() async {
guard shouldRefreshSubscriptionCookie() else { return }
guard let cookieStore = await currentCookieStore() else { return }
guard isSettingSubscriptionCookieEnabled,
shouldRefreshSubscriptionCookie(),
let cookieStore = await currentCookieStore() else { return }

Logger.subscription.info("[SubscriptionCookieManager] Refresh subscription cookie")
updateLastRefreshDateToNow()

let accessToken: String? = subscriptionManager.accountManager.accessToken
let subscriptionCookie = await cookieStore.fetchCurrentSubscriptionCookie()

if let accessToken {
if subscriptionCookie == nil || subscriptionCookie?.value != accessToken {
Logger.subscription.info("[SubscriptionCookieManager] Refresh: No cookie or one with different value")
do {
let noCookieOrWithUnexpectedValue = (accessToken ?? "") != subscriptionCookie?.value

do {
if noCookieOrWithUnexpectedValue {
Logger.subscription.info("[SubscriptionCookieManager] Refresh: No cookie or one with unexpected value")

if let accessToken {
try await cookieStore.setSubscriptionCookie(for: accessToken)
eventMapping.fire(.subscriptionCookieRefreshedWithUpdate)
} catch {
eventMapping.fire(.failedToSetSubscriptionCookie)
eventMapping.fire(.subscriptionCookieRefreshedWithAccessToken)
} else {
try await cookieStore.setEmptySubscriptionCookie()
eventMapping.fire(.subscriptionCookieRefreshedWithEmptyValue)
}
} else {
Logger.subscription.info("[SubscriptionCookieManager] Refresh: Cookie exists and is up to date")
return
}
} else {
if let subscriptionCookie {
Logger.subscription.info("[SubscriptionCookieManager] Refresh: No access token but old cookie exists, deleting it")
await cookieStore.deleteCookie(subscriptionCookie)
eventMapping.fire(.subscriptionCookieRefreshedWithDelete)
}
} catch {
eventMapping.fire(.failedToSetSubscriptionCookie)
}
}

Expand Down Expand Up @@ -161,6 +176,10 @@ private extension HTTPCookieStore {
await allCookies().first { $0.domain == SubscriptionCookieManager.cookieDomain && $0.name == SubscriptionCookieManager.cookieName }
}

func setEmptySubscriptionCookie() async throws {
try await setSubscriptionCookie(for: "")
}

func setSubscriptionCookie(for token: String) async throws {
guard let cookie = HTTPCookie(properties: [
.domain: SubscriptionCookieManager.cookieDomain,
Expand Down
5 changes: 2 additions & 3 deletions Sources/Subscription/SubscriptionCookie/SubscriptionCookieManagerEvent.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,9 @@ import Foundation

public enum SubscriptionCookieManagerEvent {
case errorHandlingAccountDidSignInTokenIsMissing
case errorHandlingAccountDidSignOutCookieIsMissing

case subscriptionCookieRefreshedWithUpdate
case subscriptionCookieRefreshedWithDelete
case subscriptionCookieRefreshedWithAccessToken
case subscriptionCookieRefreshedWithEmptyValue

case failedToSetSubscriptionCookie
}
2 changes: 2 additions & 0 deletions Sources/SubscriptionTestingUtilities/SubscriptionCookie/SubscriptionCookieManagerMock.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ public final class SubscriptionCookieManagerMock: SubscriptionCookieManaging {

}

public func enableSettingSubscriptionCookie() { }
public func disableSettingSubscriptionCookie() async { }
public func refreshSubscriptionCookie() async { }
public func resetLastRefreshDate() { }
}
Expand Down
20 changes: 15 additions & 5 deletions Tests/SubscriptionTests/SubscriptionCookie/SubscriptionCookieManagerTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ final class SubscriptionCookieManagerTests: XCTestCase {
accountManager.accessToken = Constants.accessToken

// When
subscriptionCookieManager.enableSettingSubscriptionCookie()
NotificationCenter.default.post(name: .accountDidSignIn, object: self, userInfo: nil)
try await Task.sleep(seconds: 0.1)

Expand All @@ -88,11 +89,12 @@ final class SubscriptionCookieManagerTests: XCTestCase {
await ensureSubscriptionCookieIsInTheCookieStore()

// When
subscriptionCookieManager.enableSettingSubscriptionCookie()
NotificationCenter.default.post(name: .accountDidSignOut, object: self, userInfo: nil)
try await Task.sleep(seconds: 0.1)

// Then
await checkSubscriptionCookieIsNotPresent()
await checkSubscriptionCookieIsHasEmptyValue()
}

func testRefreshWhenSignedInButCookieIsMissing() async throws {
Expand All @@ -101,6 +103,7 @@ final class SubscriptionCookieManagerTests: XCTestCase {
await ensureNoSubscriptionCookieInTheCookieStore()

// When
subscriptionCookieManager.enableSettingSubscriptionCookie()
await subscriptionCookieManager.refreshSubscriptionCookie()
try await Task.sleep(seconds: 0.1)

Expand All @@ -114,11 +117,12 @@ final class SubscriptionCookieManagerTests: XCTestCase {
await ensureSubscriptionCookieIsInTheCookieStore()

// When
subscriptionCookieManager.enableSettingSubscriptionCookie()
await subscriptionCookieManager.refreshSubscriptionCookie()
try await Task.sleep(seconds: 0.1)

// Then
await checkSubscriptionCookieIsNotPresent()
await checkSubscriptionCookieIsHasEmptyValue()
}

func testRefreshNotTriggeredTwiceWithinSetRefreshInterval() async throws {
Expand All @@ -127,6 +131,7 @@ final class SubscriptionCookieManagerTests: XCTestCase {
let secondRefreshDate: Date?

// When
subscriptionCookieManager.enableSettingSubscriptionCookie()
await subscriptionCookieManager.refreshSubscriptionCookie()
firstRefreshDate = subscriptionCookieManager.lastRefreshDate

Expand All @@ -145,6 +150,7 @@ final class SubscriptionCookieManagerTests: XCTestCase {
let secondRefreshDate: Date?

// When
subscriptionCookieManager.enableSettingSubscriptionCookie()
await subscriptionCookieManager.refreshSubscriptionCookie()
firstRefreshDate = subscriptionCookieManager.lastRefreshDate

Expand Down Expand Up @@ -186,9 +192,12 @@ final class SubscriptionCookieManagerTests: XCTestCase {
XCTAssertEqual(subscriptionCookie.value, Constants.accessToken)
}

private func checkSubscriptionCookieIsNotPresent() async {
let cookie = await cookieStore.fetchSubscriptionCookie()
XCTAssertNil(cookie)
private func checkSubscriptionCookieIsHasEmptyValue() async {
guard let subscriptionCookie = await cookieStore.fetchSubscriptionCookie() else {
XCTFail("No subscription cookie in the store")
return
}
XCTAssertEqual(subscriptionCookie.value, "")
}

}
Expand All @@ -213,6 +222,7 @@ class MockHTTPCookieStore: HTTPCookieStore {
}

func setCookie(_ cookie: HTTPCookie) async {
cookies.removeAll { $0.domain == cookie.domain }
cookies.append(cookie)
}

Expand Down
Loading