Skip to content

[BWA-155] refactor: Move TimeProvider to BitwardenKit #1558

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

Merged
merged 2 commits into from
May 8, 2025
Merged
Show file tree
Hide file tree
Changes from all 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
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import BitwardenKit
import BitwardenKitMocks
import Combine
import Foundation
import TestHelpers
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import BitwardenKit
import BitwardenKitMocks
import Combine
import Foundation

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import BitwardenKit
import Foundation
import OSLog

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import BitwardenKitMocks
import XCTest

@testable import AuthenticatorShared
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import BitwardenKitMocks
import BitwardenSdk
import Foundation

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import AuthenticatorBridgeKit
import BitwardenKit
import BitwardenSdk
import Foundation

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import BitwardenKit
import Combine
import Foundation

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// swiftlint:disable file_length

import BitwardenKit
import SwiftUI

// MARK: - SearchableItemListView
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import BitwardenKitMocks
import SnapshotTesting
import SwiftUI
import ViewInspector
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import BitwardenKit
import BitwardenSdk
import SwiftUI

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import BitwardenKit
import SwiftUI

// MARK: - TOTPCountdownTimer
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import BitwardenKit
import XCTest

@testable import AuthenticatorShared
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import BitwardenKit
import SwiftUI

// MARK: - TOTPCountdownTimerView
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import BitwardenKit
import Foundation

@testable import AuthenticatorShared

class MockTimeProvider {
enum TimeConfig {
public class MockTimeProvider {
public enum TimeConfig {
case currentTime
case mockTime(Date)

Expand All @@ -17,25 +16,25 @@ class MockTimeProvider {
}
}

var timeConfig: TimeConfig
public var timeConfig: TimeConfig

init(_ timeConfig: TimeConfig) {
public init(_ timeConfig: TimeConfig) {
self.timeConfig = timeConfig
}
}

extension MockTimeProvider: Equatable {
static func == (_: MockTimeProvider, _: MockTimeProvider) -> Bool {
public static func == (_: MockTimeProvider, _: MockTimeProvider) -> Bool {
true
}
}

extension MockTimeProvider: TimeProvider {
var presentTime: Date {
public var presentTime: Date {
timeConfig.date
}

func timeSince(_ date: Date) -> TimeInterval {
public func timeSince(_ date: Date) -> TimeInterval {
presentTime.timeIntervalSince(date)
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
/// For regular builds, the `TimeProvider` should use the current time as `presentTime`.
/// When testing, this protocol allows the current time to be mocked with any `Date`.
///
protocol TimeProvider: AnyObject {
public protocol TimeProvider: AnyObject {
/// The present time expressed as a `Date`, according to the provider.
///
var presentTime: Date { get }
Expand All @@ -24,12 +24,14 @@

/// A `TimeProvider` that returns the current time whenever `presentTime` is read.
///
class CurrentTime: TimeProvider {
var presentTime: Date {
public class CurrentTime: TimeProvider {
public var presentTime: Date {
.now
}

func timeSince(_ date: Date) -> TimeInterval {
public func timeSince(_ date: Date) -> TimeInterval {

Check warning on line 32 in BitwardenKit/Core/Platform/Services/TimeProvider.swift

View check run for this annotation

Codecov / codecov/patch

BitwardenKit/Core/Platform/Services/TimeProvider.swift#L32

Added line #L32 was not covered by tests
presentTime.timeIntervalSince(date)
}

public init() {}
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,23 @@
#if DEBUG
/// A `TimeProvider` for previews.
///
class PreviewTimeProvider: TimeProvider {
public class PreviewTimeProvider: TimeProvider {
/// A fixed date to use for previews.
var fixedDate: Date
public var fixedDate: Date

var presentTime: Date {
public var presentTime: Date {
fixedDate
}

init(
public init(
fixedDate: Date = .init(
timeIntervalSinceReferenceDate: 1_695_000_011
)
) {
self.fixedDate = fixedDate
}

func timeSince(_ date: Date) -> TimeInterval {
public func timeSince(_ date: Date) -> TimeInterval {

Check warning on line 22 in BitwardenKit/UI/Platform/Application/Utilities/PreviewTimeProvider.swift

View check run for this annotation

Codecov / codecov/patch

BitwardenKit/UI/Platform/Application/Utilities/PreviewTimeProvider.swift#L22

Added line #L22 was not covered by tests
presentTime.timeIntervalSince(date)
}
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import BitwardenKit
import BitwardenKitMocks
import Combine
import Foundation

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import BitwardenKit
import Foundation
import OSLog
import UIKit
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import BitwardenKitMocks
import UniformTypeIdentifiers
import XCTest

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// swiftlint:disable:this file_name
// swiftlint:disable file_length

import BitwardenKit
import BitwardenSdk

// MARK: - DataMappingError
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// swiftlint:disable:this file_name

import BitwardenKitMocks
import BitwardenSdk
import XCTest

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import BitwardenKit
import BitwardenSdk
import Foundation

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import BitwardenKit
import BitwardenKitMocks
import BitwardenSdk
import Combine
import Foundation
Expand Down Expand Up @@ -330,43 +332,3 @@ class MockVaultRepository: VaultRepository {
vaultListGroupSubject.eraseToAnyPublisher().values
}
}

// MARK: - MockTimeProvider

class MockTimeProvider {
enum TimeConfig {
case currentTime
case mockTime(Date)

var date: Date {
switch self {
case .currentTime:
return .now
case let .mockTime(fixedDate):
return fixedDate
}
}
}

var timeConfig: TimeConfig

init(_ timeConfig: TimeConfig) {
self.timeConfig = timeConfig
}
}

extension MockTimeProvider: Equatable {
static func == (_: MockTimeProvider, _: MockTimeProvider) -> Bool {
true
}
}

extension MockTimeProvider: TimeProvider {
var presentTime: Date {
timeConfig.date
}

func timeSince(_ date: Date) -> TimeInterval {
presentTime.timeIntervalSince(date)
}
}
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import BitwardenKit
import BitwardenKitMocks
import TestHelpers
import XCTest

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import BitwardenKit
import Foundation
import OSLog

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import BitwardenKitMocks
import XCTest

@testable import BitwardenShared
Expand Down
35 changes: 0 additions & 35 deletions BitwardenShared/Core/Vault/Services/TOTP/TimeProvider.swift

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import BitwardenKitMocks
import BitwardenSdk
import Foundation

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import BitwardenKitMocks
import Combine
import Foundation

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import BitwardenKit
import SwiftUI

// MARK: - FlightRecorderLogsView
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import BitwardenKit
import BitwardenKitMocks
import SnapshotTesting
import XCTest

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import BitwardenKit
import Foundation

/// A protocol to manage TOTP code expirations for `VaultListItem`s and batch refresh calls.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import BitwardenKit

/// Protocol to create `TOTPExpirationManager`.
protocol TOTPExpirationManagerFactory {
/// Creates a `TOTPExpirationManager` passing the `onExpiration` closure.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import BitwardenKitMocks
import XCTest

@testable import BitwardenShared
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import BitwardenKit
import BitwardenSdk
import SwiftUI

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import BitwardenKitMocks
import SnapshotTesting
import XCTest

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import BitwardenKit
import SwiftUI

// MARK: - VaultGroupView
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import BitwardenKitMocks
import SnapshotTesting
import ViewInspector
import XCTest
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import BitwardenKit
import BitwardenSdk
import SwiftUI

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// swiftlint:disable file_length

import BitwardenKit
import BitwardenSdk
import SwiftUI

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import BitwardenKitMocks
import BitwardenSdk
import SnapshotTesting
import SwiftUI
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import BitwardenKit
import BitwardenSdk
import SwiftUI

Expand Down
Loading
Loading