keejef
/
session-ios
mirror of https://github.com/oxen-io/session-ios
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fixed a couple of bugs and logging tweaks

Browse Source 
• Refactored the remaining `SNLog` calls
• Added support for a 'customSuffix' to the log categories (similar to the 'customPrefix' it allows category name manipulation whilst keeping the existing log level settings)
• Improved logging in the PN extension
• Fixed an issue where the PN extension would end up with duplicate logs every time a new PN was received
• Fixed an issue where the PN extension would needlessly dispatch it's setup to the main thread
• Fixed an issue where the PN extension would try to read from the database after suspending it
• Fixed an issue where the PN extension could try to complete on a non-main thread (eg. db threads) which _might_ cause odd behaviours
pull/1061/head
Morgan Pretty 4 weeks ago
parent cba6729618
commit a080d67618
71 changed files with 368 additions and 212 deletions
Show Stats Download Patch File Download Diff File

8
Session/Calls/Call Management/SessionCall.swift
Unescape Escape View File

@ -275,10 +275,10 @@ public final class SessionCall: CurrentCallProtocol, WebRTCSessionDelegate {
receiveCompletion: { [weak self] result in
switch result {
case .finished:
SNLog("[Calls] Offer message sent")
Log.info(.calls, "Offer message sent")
self?.updateCallDetailedStatus?("Sending Connection Candidates")
case .failure(let error):
SNLog("[Calls] Error initializing call after 5 retries: \(error), ending call...")
Log.error(.calls, "Error initializing call after 5 retries: \(error), ending call...")
self?.handleCallInitializationFailed()
}
}
@ -291,14 +291,14 @@ public final class SessionCall: CurrentCallProtocol, WebRTCSessionDelegate {
hasStartedConnecting = true
if let sdp = remoteSDP {
SNLog("[Calls] Got remote sdp already")
Log.info(.calls, "Got remote sdp already")
self.updateCallDetailedStatus?("Answering Call")
webRTCSession.handleRemoteSDP(sdp, from: sessionId) // This sends an answer message internally
}
}
func answerSessionCallInBackground() {
SNLog("[Calls] Answering call in background")
Log.info(.calls, "Answering call in background")
self.answerSessionCall()
}

2
Session/Calls/Call Management/SessionCallManager.swift
Unescape Escape View File

@ -144,7 +144,7 @@ public final class SessionCallManager: NSObject, CallManagerProtocol {
}
func handleCallEnded() {
SNLog("[Calls] Call ended.")
Log.info(.calls, "Call ended.")
WebRTCSession.current = nil
dependencies[defaults: .appGroup, key: .isCallOngoing] = false
dependencies[defaults: .appGroup, key: .lastCallPreOffer] = nil

12
Session/Conversations/ConversationVC+Interaction.swift
Unescape Escape View File

@ -344,7 +344,7 @@ extension ConversationVC:
Permissions.requestMicrophonePermissionIfNeeded(using: viewModel.dependencies)
if Permissions.microphone != .granted {
SNLog("Proceeding without microphone access. Any recorded video will be silent.")
Log.warn(.conversation, "Proceeding without microphone access. Any recorded video will be silent.")
}
let sendMediaNavController = SendMediaNavigationController.showingCameraFirst(
@ -1107,7 +1107,7 @@ extension ConversationVC:
guard
let originalFilePath: String = mediaView.attachment.originalFilePath(using: viewModel.dependencies),
viewModel.dependencies[singleton: .fileManager].fileExists(atPath: originalFilePath)
else { return SNLog("Missing video file") }
else { return Log.warn(.conversation, "Missing video file") }
/// When playing media we need to change the AVAudioSession to 'playback' mode so the device "silent mode"
/// doesn't prevent video audio from playing
@ -2337,7 +2337,7 @@ extension ConversationVC:
self.audioRecorder = audioRecorder
}
catch {
SNLog("Couldn't start audio recording due to error: \(error).")
Log.error(.conversation, "Couldn't start audio recording due to error: \(error).")
return cancelVoiceMessageRecording()
}
@ -2353,7 +2353,7 @@ extension ConversationVC:
guard successfullyPrepared && startedRecording else {
SNLog(successfullyPrepared ? "Couldn't record audio." : "Couldn't prepare audio recorder.")
Log.error(.conversation, (successfullyPrepared ? "Couldn't record audio." : "Couldn't prepare audio recorder."))
// Dispatch to the next run loop to avoid
DispatchQueue.main.async {
@ -2412,7 +2412,9 @@ extension ConversationVC:
let dataSourceOrNil = DataSourcePath(fileUrl: audioRecorder.url, sourceFilename: nil, shouldDeleteOnDeinit: true, using: viewModel.dependencies)
self.audioRecorder = nil
guard let dataSource = dataSourceOrNil else { return SNLog("Couldn't load recorded data.") }
guard let dataSource = dataSourceOrNil else {
return Log.error(.conversation, "Couldn't load recorded data.")
}
// Create attachment
let fileName = ("messageVoice".localized() as NSString)

2
Session/Conversations/ConversationVC.swift
Unescape Escape View File

@ -2139,7 +2139,7 @@ final class ConversationVC: BaseVC, LibSessionRespondingViewController, Conversa
return nil
default:
SNLog("[ConversationVC] Warning: Processing unhandled cell type when marking as read, this could result in intermittent failures")
Log.warn(.conversation, "Processing unhandled cell type when marking as read, this could result in intermittent failures")
return nil
}
})

10
Session/Conversations/ConversationViewModel.swift
Unescape Escape View File

@ -11,6 +11,14 @@ import SessionMessagingKit
import SessionUtilitiesKit
import SessionUIKit
// MARK: - Log.Category
public extension Log.Category {
static let conversation: Log.Category = .create("Conversation", defaultLevel: .info)
}
// MARK: - ConversationViewModel
public class ConversationViewModel: OWSAudioPlayerDelegate, NavigatableStateHolder {
public typealias SectionModel = ArraySection<Section, MessageViewModel>
@ -361,7 +369,7 @@ public class ConversationViewModel: OWSAudioPlayerDelegate, NavigatableStateHold
}
}
.removeDuplicates()
.handleEvents(didFail: { SNLog("[ConversationViewModel] Observation failed with error: \($0)") })
.handleEvents(didFail: { Log.error(.conversation, "Observation failed with error: \($0)") })
}
public func updateThreadData(_ updatedData: SessionThreadViewModel) {

10
Session/Home/GlobalSearch/GlobalSearchViewController.swift
Unescape Escape View File

@ -8,6 +8,14 @@ import SessionMessagingKit
import SessionUtilitiesKit
import SignalUtilitiesKit
// MARK: - Log.Category
private extension Log.Category {
static let cat: Log.Category = .create("GlobalSearch", defaultLevel: .warn)
}
// MARK: - GlobalSearchViewController
class GlobalSearchViewController: BaseVC, LibSessionRespondingViewController, UITableViewDelegate, UITableViewDataSource {
fileprivate typealias SectionModel = ArraySection<SearchSection, SessionThreadViewModel>
@ -287,7 +295,7 @@ class GlobalSearchViewController: BaseVC, LibSessionRespondingViewController, UI
catch {
// Don't log the 'interrupt' error as that's just the user typing too fast
if (error as? DatabaseError)?.resultCode != DatabaseError.SQLITE_INTERRUPT {
SNLog("[GlobalSearch] Failed to find results due to error: \(error)")
Log.error(.cat, "Failed to find results due to error: \(error)")
}
return .failure(error)

10
Session/Home/HomeViewModel.swift
Unescape Escape View File

@ -7,6 +7,14 @@ import SignalUtilitiesKit
import SessionMessagingKit
import SessionUtilitiesKit
// MARK: - Log.Category
private extension Log.Category {
static let cat: Log.Category = .create("HomeViewModel", defaultLevel: .warn)
}
// MARK: - HomeViewModel
public class HomeViewModel: NavigatableStateHolder {
public let navigatableState: NavigatableState = NavigatableState()
@ -227,7 +235,7 @@ public class HomeViewModel: NavigatableStateHolder {
try HomeViewModel.retrieveState(db, using: dependencies)
}
.removeDuplicates()
.handleEvents(didFail: { SNLog("[HomeViewModel] Observation failed with error: \($0)") })
.handleEvents(didFail: { Log.error(.cat, "Observation failed with error: \($0)") })
private static func retrieveState(
_ db: Database,

4
Session/Media Viewing & Editing/ImagePickerController.swift
Unescape Escape View File

@ -483,7 +483,7 @@ class ImagePickerGridController: UICollectionViewController, PhotoLibraryDelegat
}
guard let asset: PHAsset = photoCollectionContents.asset(at: indexPath.item) else {
SNLog("Failed to select cell for asset at \(indexPath.item)")
Log.error(.media, "Failed to select cell for asset at \(indexPath.item)")
delegate.imagePicker(self, failedToRetrieveAssetAt: indexPath.item, forCount: photoCollectionContents.assetCount)
return
}
@ -529,7 +529,7 @@ class ImagePickerGridController: UICollectionViewController, PhotoLibraryDelegat
let cell: PhotoGridViewCell = collectionView.dequeue(type: PhotoGridViewCell.self, for: indexPath)
guard let assetItem: PhotoPickerAssetItem = photoCollectionContents.assetItem(at: indexPath.item, photoMediaSize: photoMediaSize) else {
SNLog("Failed to style cell for asset at \(indexPath.item)")
Log.error(.media, "Failed to style cell for asset at \(indexPath.item)")
return cell
}

6
Session/Media Viewing & Editing/MediaDetailViewController.swift
Unescape Escape View File

@ -92,7 +92,7 @@ class MediaDetailViewController: OWSViewController, UIScrollViewDelegate {
updateUICallback()
},
failure: {
SNLog("Could not load media.")
Log.error(.media, "Could not load media.")
}
)
}
@ -175,7 +175,7 @@ class MediaDetailViewController: OWSViewController, UIScrollViewDelegate {
let viewSize: CGSize = self.scrollView.bounds.size
guard imageSize.width > 0 && imageSize.height > 0 else {
SNLog("Invalid image dimensions (\(imageSize.width), \(imageSize.height))")
Log.error(.media, "Invalid image dimensions (\(imageSize.width), \(imageSize.height))")
return
}
@ -350,7 +350,7 @@ class MediaDetailViewController: OWSViewController, UIScrollViewDelegate {
guard
let originalFilePath: String = self.galleryItem.attachment.originalFilePath(using: dependencies),
dependencies[singleton: .fileManager].fileExists(atPath: originalFilePath)
else { return SNLog("Missing video file") }
else { return Log.error(.media, "Missing video file") }
let videoUrl: URL = URL(fileURLWithPath: originalFilePath)
let player: AVPlayer = AVPlayer(url: videoUrl)

2
Session/Media Viewing & Editing/MediaGalleryViewModel.swift
Unescape Escape View File

@ -395,7 +395,7 @@ public class MediaGalleryViewModel {
.fetchAll(db)
}
.removeDuplicates()
.handleEvents(didFail: { SNLog("[MediaGalleryViewModel] Observation failed with error: \($0)") })
.handleEvents(didFail: { Log.error(.media, "Gallery observation failed with error: \($0)") })
}
@discardableResult public func loadAndCacheAlbumData(for interactionId: Int64, in threadId: String) -> [Item] {

2
Session/Notifications/NotificationPresenter.swift
Unescape Escape View File

@ -137,7 +137,7 @@ public class NotificationPresenter: NSObject, UNUserNotificationCenterDelegate,
}
guard notificationBody != nil || notificationTitle != nil else {
SNLog("AppNotifications error: No notification content")
Log.info("AppNotifications error: No notification content")
return
}

10
Session/Settings/HelpViewModel.swift
Unescape Escape View File

@ -8,6 +8,14 @@ import SessionUIKit
import SessionMessagingKit
import SessionUtilitiesKit
// MARK: - Log.Category
private extension Log.Category {
static let version: Log.Category = .create("Version", defaultLevel: .info)
}
// MARK: - HelpViewModel
class HelpViewModel: SessionTableViewModel, NavigatableStateHolder, ObservableTableSource {
typealias TableItem = Section
@ -204,7 +212,7 @@ class HelpViewModel: SessionTableViewModel, NavigatableStateHolder, ObservableTa
using dependencies: Dependencies,
onShareComplete: (() -> ())? = nil
) {
Log.info("[Version] \(dependencies[cache: .appVersion].versionInfo)")
Log.info(.version, "\(dependencies[cache: .appVersion].versionInfo)")
Log.flush()
guard

16
Session/Shared/QRCodeScanningViewController.swift
Unescape Escape View File

@ -5,10 +5,20 @@ import AVFoundation
import SessionUIKit
import SessionUtilitiesKit
// MARK: - Log.Category
private extension Log.Category {
static let cat: Log.Category = .create("QRCode", defaultLevel: .warn)
}
// MARK: - QRScannerDelegate
protocol QRScannerDelegate: AnyObject {
func controller(_ controller: QRCodeScanningViewController, didDetectQRCodeWith string: String, onSuccess: (() -> ())?, onError: (() -> ())?)
}
// MARK: - QRCodeScanningViewController
class QRCodeScanningViewController: UIViewController, AVCaptureMetadataOutputObjectsDelegate {
public weak var scanDelegate: QRScannerDelegate?
@ -123,7 +133,7 @@ class QRCodeScanningViewController: UIViewController, AVCaptureMetadataOutputObj
let device: AVCaptureDevice = maybeDevice,
let input: AVCaptureInput = try? AVCaptureDeviceInput(device: device)
else {
return SNLog("Failed to retrieve the device for enabling the QRCode scanning camera")
return Log.error(.cat, "Failed to retrieve the device for enabling the QRCode scanning camera")
}
// Image output
@ -141,11 +151,11 @@ class QRCodeScanningViewController: UIViewController, AVCaptureMetadataOutputObj
if capture.canAddOutput(metadataOutput) { capture.addOutput(metadataOutput) }
guard !capture.inputs.isEmpty && capture.outputs.count == 2 else {
return SNLog("Failed to attach the input/output to the capture session")
return Log.error(.cat, "Failed to attach the input/output to the capture session")
}
guard metadataOutput.availableMetadataObjectTypes.contains(.qr) else {
return SNLog("The output is unable to process QR codes")
return Log.error(.cat, "The output is unable to process QR codes")
}
// Specify that we want to capture QR Codes (Needs to be done after being added

16
Session/Shared/SessionTableViewController.swift
Unescape Escape View File

@ -9,10 +9,20 @@ import SessionUtilitiesKit
import SessionMessagingKit
import SignalUtilitiesKit
// MARK: - Log.Category
private extension Log.Category {
static let cat: Log.Category = .create("SessionTableViewController", defaultLevel: .info)
}
// MARK: - SessionViewModelAccessible
protocol SessionViewModelAccessible {
var viewModelType: AnyObject.Type { get }
}
// MARK: - SessionTableViewController
class SessionTableViewController<ViewModel>: BaseVC, UITableViewDataSource, UITableViewDelegate, SessionViewModelAccessible where ViewModel: (SessionTableViewModel & ObservableTableSource) {
typealias Section = ViewModel.Section
typealias TableItem = ViewModel.TableItem
@ -235,11 +245,11 @@ class SessionTableViewController<ViewModel>: BaseVC, UITableViewDataSource, UITa
// If we got an error then try to restart the stream once, otherwise log the error
guard self?.dataStreamJustFailed == false else {
SNLog("Unable to recover database stream in '\(title)' settings with error: \(error)")
Log.error(.cat, "Unable to recover database stream in '\(title)' settings with error: \(error)")
return
}
SNLog("Atempting recovery for database stream in '\(title)' settings with error: \(error)")
Log.info(.cat, "Atempting recovery for database stream in '\(title)' settings with error: \(error)")
self?.dataStreamJustFailed = true
self?.startObservingChanges(didReturnFromBackground: didReturnFromBackground)
@ -467,7 +477,7 @@ class SessionTableViewController<ViewModel>: BaseVC, UITableViewDataSource, UITa
cell.update(with: threadInfo.id, using: viewModel.dependencies)
default:
SNLog("[SessionTableViewController] Got invalid combination of cellType: \(viewModel.cellType) and tableData: \(SessionCell.Info<TableItem>.self)")
Log.error(.cat, "[SessionTableViewController] Got invalid combination of cellType: \(viewModel.cellType) and tableData: \(SessionCell.Info<TableItem>.self)")
}
return cell

14
Session/Shared/Types/ObservableTableSource.swift
Unescape Escape View File

@ -6,6 +6,14 @@ import Combine
import DifferenceKit
import SessionUtilitiesKit
// MARK: - Log.Category
private extension Log.Category {
static func cat(_ viewModel: Any) -> Log.Category {
return .create("ObservableTableSource", customSuffix: "-\(type(of: viewModel))", defaultLevel: .warn)
}
}
// MARK: - ObservableTableSource
public protocol ObservableTableSource: AnyObject, SectionedTableData {
@ -203,11 +211,10 @@ public enum ObservationBuilder {
scheduling: dependencies[singleton: .scheduler],
onError: { error in
let log: String = [
"[\(type(of: viewModel))]", // stringlint:ignore
"Observation failed with error:", // stringlint:ignore
"\(error)" // stringlint:ignore
].joined(separator: " ")
SNLog(log)
Log.error(.cat(viewModel), log)
subject.send(completion: Subscribers.Completion.failure(error))
},
onChange: { subject.send($0) }
@ -259,11 +266,10 @@ public enum ObservationBuilder {
scheduling: dependencies[singleton: .scheduler],
onError: { error in
let log: String = [
"[\(type(of: viewModel))]", // stringlint:ignore
"Observation failed with error:", // stringlint:ignore
"\(error)" // stringlint:ignore
].joined(separator: " ")
SNLog(log)
Log.error(.cat(viewModel), log)
subject.send(completion: Subscribers.Completion.failure(error))
},
onChange: { subject.send($0) }

2
SessionMessagingKit/Database/Models/Attachment.swift
Unescape Escape View File

@ -476,7 +476,7 @@ extension Attachment {
return try builder.build()
}
catch {
SNLog("Couldn't construct attachment proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct attachment proto from: \(self).")
return nil
}
}

2
SessionMessagingKit/Database/Models/Profile.swift
Unescape Escape View File

@ -187,7 +187,7 @@ public extension Profile {
return try dataMessageProto.build()
}
catch {
SNLog("Couldn't construct profile proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct profile proto from: \(self).")
return nil
}
}

6
SessionMessagingKit/Jobs/CheckForAppUpdatesJob.swift
Unescape Escape View File

@ -72,9 +72,11 @@ public enum CheckForAppUpdatesJob: JobExecutor {
},
receiveValue: { _, versionInfo in
switch versionInfo.prerelease {
case .none: Log.info(.cat, "Latest version: \(versionInfo.version)")
case .none:
Log.info(.cat, "Latest version: \(versionInfo.version) (Current: \(dependencies[cache: .appVersion].versionInfo))")
case .some(let prerelease):
Log.info(.cat, "Latest version: \(versionInfo.version), pre-release version: \(prerelease.version)")
Log.info(.cat, "Latest version: \(versionInfo.version), pre-release version: \(prerelease.version) (Current: \(dependencies[cache: .appVersion].versionInfo))")
}
}
)

6
SessionMessagingKit/LibSession/Config Handling/LibSession+ConvoInfoVolatile.swift
Unescape Escape View File

@ -141,7 +141,7 @@ internal extension LibSession {
try validChanges.forEach { threadInfo in
guard var cThreadId: [CChar] = threadInfo.threadId.cString(using: .utf8) else {
SNLog("Unable to upsert contact volatile info to LibSession: \(LibSessionError.invalidCConversion)")
Log.error(.libSession, "Unable to upsert contact volatile info to LibSession: \(LibSessionError.invalidCConversion)")
throw LibSessionError.invalidCConversion
}
@ -200,7 +200,7 @@ internal extension LibSession {
var cRoomToken: [CChar] = threadInfo.openGroupUrlInfo?.roomToken.cString(using: .utf8),
var cPubkey: [UInt8] = threadInfo.openGroupUrlInfo.map({ Array(Data(hex: $0.publicKey)) })
else {
SNLog("Unable to create community conversation when updating last read timestamp due to missing URL info")
Log.error(.libSession, "Unable to create community conversation when updating last read timestamp due to missing URL info")
return
}
@ -747,7 +747,7 @@ public extension LibSession {
)
}
else {
SNLog("Ignoring unknown conversation type when iterating through volatile conversation info update")
Log.error(.libSession, "Ignoring unknown conversation type when iterating through volatile conversation info update")
}
convo_info_volatile_iterator_advance(convoIterator)

2
SessionMessagingKit/LibSession/Config Handling/LibSession+UserGroups.swift
Unescape Escape View File

@ -722,7 +722,7 @@ internal extension LibSession {
var cBaseUrl: [CChar] = community.urlInfo.server.cString(using: .utf8),
var cRoom: [CChar] = community.urlInfo.roomToken.cString(using: .utf8)
else {
SNLog("Unable to upsert community conversation to LibSession: \(LibSessionError.invalidCConversion)")
Log.error(.libSession, "Unable to upsert community conversation to LibSession: \(LibSessionError.invalidCConversion)")
throw LibSessionError.invalidCConversion
}

14
SessionMessagingKit/LibSession/LibSession+SessionMessagingKit.swift
Unescape Escape View File

@ -205,13 +205,13 @@ public extension LibSession {
// MARK: - State Management
public func loadState(_ db: Database) {
public func loadState(_ db: Database, requestId: String?) {
// Ensure we have the ed25519 key and that we haven't already loaded the state before
// we continue
guard
configStore.isEmpty,
let ed25519KeyPair: KeyPair = Identity.fetchUserEd25519KeyPair(db)
else { return Log.warn(.libSession, "Ignoring loadState due to existing state") }
else { return Log.warn(.libSession, "Ignoring loadState\(requestId.map { " for \($0)" } ?? "") due to existing state") }
// Retrieve the existing dumps from the database
let existingDumps: [ConfigDump] = ((try? ConfigDump.fetchSet(db)) ?? [])
@ -258,7 +258,7 @@ public extension LibSession {
userSessionId: userSessionId,
userEd25519KeyPair: ed25519KeyPair
)
Log.info(.libSession, "Completed loadState")
Log.info(.libSession, "Completed loadState\(requestId.map { " for \($0)" } ?? "")")
}
public func loadDefaultStatesFor(
@ -894,7 +894,7 @@ public protocol LibSessionCacheType: LibSessionImmutableCacheType, MutableCacheT
// MARK: - State Management
func loadState(_ db: Database)
func loadState(_ db: Database, requestId: String?)
func loadDefaultStatesFor(
userConfigVariants: Set<ConfigDump.Variant>,
groups: [ClosedGroup],
@ -974,6 +974,10 @@ public extension LibSessionCacheType {
func withCustomBehaviour(_ behaviour: LibSession.CacheBehaviour, for sessionId: SessionId, change: @escaping () throws -> ()) throws {
try withCustomBehaviour(behaviour, for: sessionId, variant: nil, change: change)
}
func loadState(_ db: Database) {
loadState(db, requestId: nil)
}
}
private final class NoopLibSessionCache: LibSessionCacheType {
@ -987,7 +991,7 @@ private final class NoopLibSessionCache: LibSessionCacheType {
// MARK: - State Management
func loadState(_ db: Database) {}
func loadState(_ db: Database, requestId: String?) {}
func loadDefaultStatesFor(
userConfigVariants: Set<ConfigDump.Variant>,
groups: [ClosedGroup],

2
SessionMessagingKit/Messages/Control Messages/CallMessage.swift
Unescape Escape View File

@ -201,7 +201,7 @@ public final class CallMessage: ControlMessage {
return try contentProto.build()
}
catch {
SNLog("Couldn't construct call message proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct call message proto from: \(self).")
return nil
}
}

8
SessionMessagingKit/Messages/Control Messages/ClosedGroupControlMessage.swift
Unescape Escape View File

@ -176,7 +176,7 @@ public final class ClosedGroupControlMessage: ControlMessage {
do {
return try result.build()
} catch {
SNLog("Couldn't construct key pair wrapper proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct key pair wrapper proto from: \(self).")
return nil
}
}
@ -298,7 +298,7 @@ public final class ClosedGroupControlMessage: ControlMessage {
public override func toProto(_ db: Database, threadId: String) -> SNProtoContent? {
guard let kind = kind else {
SNLog("Couldn't construct closed group update proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct closed group update proto from: \(self).")
return nil
}
do {
@ -312,7 +312,7 @@ public final class ClosedGroupControlMessage: ControlMessage {
do {
closedGroupControlMessage.setEncryptionKeyPair(try encryptionKeyPairAsProto.build())
} catch {
SNLog("Couldn't construct closed group update proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct closed group update proto from: \(self).")
return nil
}
closedGroupControlMessage.setMembers(members)
@ -346,7 +346,7 @@ public final class ClosedGroupControlMessage: ControlMessage {
contentProto.setDataMessage(try dataMessageProto.build())
return try contentProto.build()
} catch {
SNLog("Couldn't construct closed group update proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct closed group update proto from: \(self).")
return nil
}
}

4
SessionMessagingKit/Messages/Control Messages/DataExtractionNotification.swift
Unescape Escape View File

@ -85,7 +85,7 @@ public final class DataExtractionNotification: ControlMessage {
public override func toProto(_ db: Database, threadId: String) -> SNProtoContent? {
guard let kind = kind else {
SNLog("Couldn't construct data extraction notification proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct data extraction notification proto from: \(self).")
return nil
}
do {
@ -104,7 +104,7 @@ public final class DataExtractionNotification: ControlMessage {
setDisappearingMessagesConfigurationIfNeeded(on: contentProto)
return try contentProto.build()
} catch {
SNLog("Couldn't construct data extraction notification proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct data extraction notification proto from: \(self).")
return nil
}
}

2
SessionMessagingKit/Messages/Control Messages/ExpirationTimerUpdate.swift
Unescape Escape View File

@ -64,7 +64,7 @@ public final class ExpirationTimerUpdate: ControlMessage {
contentProto.setDataMessage(try dataMessageProto.build())
return try contentProto.build()
} catch {
SNLog("Couldn't construct expiration timer update proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct expiration timer update proto from: \(self).")
return nil
}
}

2
SessionMessagingKit/Messages/Control Messages/Group Update Messages/GroupUpdateDeleteMemberContentMessage.swift
Unescape Escape View File

@ -141,7 +141,7 @@ public final class GroupUpdateDeleteMemberContentMessage: ControlMessage {
contentProto.setDataMessage(try dataMessage.build())
return try contentProto.build()
} catch {
SNLog("Couldn't construct data extraction notification proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct data extraction notification proto from: \(self).")
return nil
}
}

2
SessionMessagingKit/Messages/Control Messages/Group Update Messages/GroupUpdateInfoChangeMessage.swift
Unescape Escape View File

@ -167,7 +167,7 @@ public final class GroupUpdateInfoChangeMessage: ControlMessage {
contentProto.setDataMessage(try dataMessage.build())
return try contentProto.build()
} catch {
SNLog("Couldn't construct data extraction notification proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct data extraction notification proto from: \(self).")
return nil
}
}

2
SessionMessagingKit/Messages/Control Messages/Group Update Messages/GroupUpdateInviteMessage.swift
Unescape Escape View File

@ -170,7 +170,7 @@ public final class GroupUpdateInviteMessage: ControlMessage {
contentProto.setDataMessage(try dataMessage.build())
return try contentProto.build()
} catch {
SNLog("Couldn't construct data extraction notification proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct data extraction notification proto from: \(self).")
return nil
}
}

2
SessionMessagingKit/Messages/Control Messages/Group Update Messages/GroupUpdateInviteResponseMessage.swift
Unescape Escape View File

@ -87,7 +87,7 @@ public final class GroupUpdateInviteResponseMessage: ControlMessage {
contentProto.setDataMessage(try dataMessage.build())
return try contentProto.build()
} catch {
SNLog("Couldn't construct data extraction notification proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct data extraction notification proto from: \(self).")
return nil
}
}

2
SessionMessagingKit/Messages/Control Messages/Group Update Messages/GroupUpdateMemberChangeMessage.swift
Unescape Escape View File

@ -162,7 +162,7 @@ public final class GroupUpdateMemberChangeMessage: ControlMessage {
contentProto.setDataMessage(try dataMessage.build())
return try contentProto.build()
} catch {
SNLog("Couldn't construct data extraction notification proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct data extraction notification proto from: \(self).")
return nil
}
}

2
SessionMessagingKit/Messages/Control Messages/Group Update Messages/GroupUpdateMemberLeftMessage.swift
Unescape Escape View File

@ -43,7 +43,7 @@ public final class GroupUpdateMemberLeftMessage: ControlMessage {
contentProto.setDataMessage(try dataMessage.build())
return try contentProto.build()
} catch {
SNLog("Couldn't construct data extraction notification proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct data extraction notification proto from: \(self).")
return nil
}
}

2
SessionMessagingKit/Messages/Control Messages/Group Update Messages/GroupUpdateMemberLeftNotificationMessage.swift
Unescape Escape View File

@ -43,7 +43,7 @@ public final class GroupUpdateMemberLeftNotificationMessage: ControlMessage {
contentProto.setDataMessage(try dataMessage.build())
return try contentProto.build()
} catch {
SNLog("Couldn't construct data extraction notification proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct data extraction notification proto from: \(self).")
return nil
}
}

2
SessionMessagingKit/Messages/Control Messages/Group Update Messages/GroupUpdatePromoteMessage.swift
Unescape Escape View File

@ -95,7 +95,7 @@ public final class GroupUpdatePromoteMessage: ControlMessage {
contentProto.setDataMessage(try dataMessage.build())
return try contentProto.build()
} catch {
SNLog("Couldn't construct data extraction notification proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct data extraction notification proto from: \(self).")
return nil
}
}

2
SessionMessagingKit/Messages/Control Messages/MessageRequestResponse.swift
Unescape Escape View File

@ -77,7 +77,7 @@ public final class MessageRequestResponse: ControlMessage {
contentProto.setMessageRequestResponse(try messageRequestResponseProto.build())
return try contentProto.build()
} catch {
SNLog("Couldn't construct unsend request proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct unsend request proto from: \(self).")
return nil
}
}

4
SessionMessagingKit/Messages/Control Messages/ReadReceipt.swift
Unescape Escape View File

@ -56,7 +56,7 @@ public final class ReadReceipt: ControlMessage {
public override func toProto(_ db: Database, threadId: String) -> SNProtoContent? {
guard let timestamps = timestamps else {
SNLog("Couldn't construct read receipt proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct read receipt proto from: \(self).")
return nil
}
let receiptProto = SNProtoReceiptMessage.builder(type: .read)
@ -69,7 +69,7 @@ public final class ReadReceipt: ControlMessage {
setDisappearingMessagesConfigurationIfNeeded(on: contentProto)
return try contentProto.build()
} catch {
SNLog("Couldn't construct read receipt proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct read receipt proto from: \(self).")
return nil
}
}

4
SessionMessagingKit/Messages/Control Messages/TypingIndicator.swift
Unescape Escape View File

@ -84,7 +84,7 @@ public final class TypingIndicator: ControlMessage {
public override func toProto(_ db: Database, threadId: String) -> SNProtoContent? {
guard let timestampMs = sentTimestampMs, let kind = kind else {
SNLog("Couldn't construct typing indicator proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct typing indicator proto from: \(self).")
return nil
}
let typingIndicatorProto = SNProtoTypingMessage.builder(timestamp: timestampMs, action: kind.toProto())
@ -94,7 +94,7 @@ public final class TypingIndicator: ControlMessage {
contentProto.setTypingMessage(try typingIndicatorProto.build())
return try contentProto.build()
} catch {
SNLog("Couldn't construct typing indicator proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct typing indicator proto from: \(self).")
return nil
}
}

4
SessionMessagingKit/Messages/Control Messages/UnsendRequest.swift
Unescape Escape View File

@ -63,7 +63,7 @@ public final class UnsendRequest: ControlMessage {
public override func toProto(_ db: Database, threadId: String) -> SNProtoContent? {
guard let timestamp = timestamp, let author = author else {
SNLog("Couldn't construct unsend request proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct unsend request proto from: \(self).")
return nil
}
let unsendRequestProto = SNProtoUnsendRequest.builder(timestamp: timestamp, author: author)
@ -75,7 +75,7 @@ public final class UnsendRequest: ControlMessage {
setDisappearingMessagesConfigurationIfNeeded(on: contentProto)
return try contentProto.build()
} catch {
SNLog("Couldn't construct unsend request proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct unsend request proto from: \(self).")
return nil
}
}

4
SessionMessagingKit/Messages/Visible Messages/VisibleMessage+LinkPreview.swift
Unescape Escape View File

@ -36,7 +36,7 @@ public extension VisibleMessage {
public func toProto(_ db: Database) -> SNProtoDataMessagePreview? {
guard let url = url else {
SNLog("Couldn't construct link preview proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct link preview proto from: \(self).")
return nil
}
let linkPreviewProto = SNProtoDataMessagePreview.builder(url: url)
@ -53,7 +53,7 @@ public extension VisibleMessage {
do {
return try linkPreviewProto.build()
} catch {
SNLog("Couldn't construct link preview proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct link preview proto from: \(self).")
return nil
}
}

4
SessionMessagingKit/Messages/Visible Messages/VisibleMessage+OpenGroupInvitation.swift
Unescape Escape View File

@ -27,14 +27,14 @@ public extension VisibleMessage {
public func toProto() -> SNProtoDataMessageOpenGroupInvitation? {
guard let url = url, let name = name else {
SNLog("Couldn't construct open group invitation proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct open group invitation proto from: \(self).")
return nil
}
let openGroupInvitationProto = SNProtoDataMessageOpenGroupInvitation.builder(url: url, name: name)
do {
return try openGroupInvitationProto.build()
} catch {
SNLog("Couldn't construct open group invitation proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct open group invitation proto from: \(self).")
return nil
}
}

6
SessionMessagingKit/Messages/Visible Messages/VisibleMessage+Profile.swift
Unescape Escape View File

@ -69,7 +69,7 @@ public extension VisibleMessage {
let dataMessageProtoBuilder = try? toProtoBuilder(),
let result = try? dataMessageProtoBuilder.build()
else {
SNLog("Couldn't construct profile proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct profile proto from: \(self).")
return nil
}
@ -93,7 +93,7 @@ public extension VisibleMessage {
public func toProto(isApproved: Bool) -> SNProtoMessageRequestResponse? {
guard let displayName = displayName else {
SNLog("Couldn't construct profile proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct profile proto from: \(self).")
return nil
}
let messageRequestResponseProto = SNProtoMessageRequestResponse.builder(
@ -110,7 +110,7 @@ public extension VisibleMessage {
messageRequestResponseProto.setProfile(try profileProto.build())
return try messageRequestResponseProto.build()
} catch {
SNLog("Couldn't construct profile proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct profile proto from: \(self).")
return nil
}
}

8
SessionMessagingKit/Messages/Visible Messages/VisibleMessage+Quote.swift
Unescape Escape View File

@ -40,7 +40,7 @@ public extension VisibleMessage {
public func toProto(_ db: Database) -> SNProtoDataMessageQuote? {
guard let timestamp = timestamp, let publicKey = publicKey else {
SNLog("Couldn't construct quote proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct quote proto from: \(self).")
return nil
}
let quoteProto = SNProtoDataMessageQuote.builder(id: timestamp, author: publicKey)
@ -49,7 +49,7 @@ public extension VisibleMessage {
do {
return try quoteProto.build()
} catch {
SNLog("Couldn't construct quote proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct quote proto from: \(self).")
return nil
}
}
@ -70,13 +70,13 @@ public extension VisibleMessage {
quotedAttachmentProto.setContentType(attachment.contentType)
if let fileName = attachment.sourceFilename { quotedAttachmentProto.setFileName(fileName) }
guard let attachmentProto = attachment.buildProto() else {
return SNLog("Ignoring invalid attachment for quoted message.")
return Log.warn(.messageSender, "Ignoring invalid attachment for quoted message.")
}
quotedAttachmentProto.setThumbnail(attachmentProto)
do {
try quoteProto.addAttachments(quotedAttachmentProto.build())
} catch {
SNLog("Couldn't construct quoted attachment proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct quoted attachment proto from: \(self).")
}
}

2
SessionMessagingKit/Messages/Visible Messages/VisibleMessage+Reaction.swift
Unescape Escape View File

@ -86,7 +86,7 @@ public extension VisibleMessage {
do {
return try reactionProto.build()
} catch {
SNLog("Couldn't construct quote proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct quote proto from: \(self).")
return nil
}
}

2
SessionMessagingKit/Messages/Visible Messages/VisibleMessage.swift
Unescape Escape View File

@ -202,7 +202,7 @@ public final class VisibleMessage: Message {
proto.setDataMessage(try dataMessage.build())
return try proto.build()
} catch {
SNLog("Couldn't construct visible message proto from: \(self).")
Log.warn(.messageSender, "Couldn't construct visible message proto from: \(self).")
return nil
}
}

2
SessionMessagingKit/Sending & Receiving/Message Handling/MessageReceiver+Calls.swift
Unescape Escape View File

@ -94,7 +94,7 @@ extension MessageReceiver {
guard db[.areCallsEnabled] && Permissions.microphone == .granted else {
let state: CallMessage.MessageInfo.State = (db[.areCallsEnabled] ? .permissionDeniedMicrophone : .permissionDenied)
SNLog("[MessageReceiver+Calls] Microphone permission is \(AVAudioSession.sharedInstance().recordPermission)")
Log.info(.calls, "Microphone permission is \(AVAudioSession.sharedInstance().recordPermission)")
if let interaction: Interaction = try MessageReceiver.insertCallInfoMessage(db, for: message, state: state, using: dependencies) {
let thread: SessionThread = try SessionThread.upsert(

28
SessionMessagingKit/Sending & Receiving/Message Handling/MessageReceiver+LegacyClosedGroups.swift
Unescape Escape View File

@ -109,7 +109,7 @@ extension MessageReceiver {
!ClosedGroupKeyPair
.filter(ClosedGroupKeyPair.Columns.threadKeyPairHash == newKeyPair.threadKeyPairHash)
.isNotEmpty(db)
else { return SNLog("Ignoring outdated NEW legacy group message due to more recent config state") }
else { return Log.info(.messageReceiver, "Ignoring outdated NEW legacy group message due to more recent config state") }
try newKeyPair.insert(db)
return
@ -298,14 +298,14 @@ extension MessageReceiver {
let legacyGroupId: String = (explicitGroupPublicKey?.toHexString() ?? threadId)
guard let userKeyPair: KeyPair = Identity.fetchUserKeyPair(db) else {
return SNLog("Couldn't find user X25519 key pair.")
return Log.error(.messageReceiver, "Couldn't find user X25519 key pair.")
}
guard let closedGroup: ClosedGroup = try? ClosedGroup.fetchOne(db, id: legacyGroupId) else {
return SNLog("Ignoring closed group encryption key pair for nonexistent group.")
return Log.warn(.messageReceiver, "Ignoring closed group encryption key pair for nonexistent group.")
}
guard let groupAdmins: [GroupMember] = try? closedGroup.admins.fetchAll(db) else { return }
guard let sender: String = message.sender, groupAdmins.contains(where: { $0.profileId == sender }) else {
return SNLog("Ignoring closed group encryption key pair from non-admin.")
return Log.info(.messageReceiver, "Ignoring closed group encryption key pair from non-admin.")
}
// Find our wrapper and decrypt it if possible
let userPublicKey: String = SessionId(.standard, publicKey: userKeyPair.publicKey).hexString
@ -325,18 +325,14 @@ extension MessageReceiver {
)
).plaintext
}
catch {
return SNLog("Couldn't decrypt closed group encryption key pair.")
}
catch { return Log.error(.messageReceiver, "Couldn't decrypt closed group encryption key pair.") }
// Parse it
let proto: SNProtoKeyPair
do {
proto = try SNProtoKeyPair.parseData(plaintext)
}
catch {
return SNLog("Couldn't parse closed group encryption key pair.")
}
catch { return Log.error(.messageReceiver, "Couldn't parse closed group encryption key pair.") }
do {
let keyPair: ClosedGroupKeyPair = ClosedGroupKeyPair(
@ -357,13 +353,13 @@ extension MessageReceiver {
}
catch {
if case DatabaseError.SQLITE_CONSTRAINT_UNIQUE = error {
return SNLog("Ignoring duplicate closed group encryption key pair.")
return Log.info(.messageReceiver, "Ignoring duplicate closed group encryption key pair.")
}
throw error
}
SNLog("Received a new closed group encryption key pair.")
Log.info(.messageReceiver, "Received a new closed group encryption key pair.")
}
private static func handleClosedGroupNameChanged(
@ -542,7 +538,7 @@ extension MessageReceiver {
allMembers
.filter({ $0.role == .admin })
.contains(where: { $0.profileId == sender })
else { return SNLog("Ignoring invalid closed group update.") }
else { return Log.warn(.messageReceiver, "Ignoring invalid closed group update.") }
// Update libSession
try? LibSession.update(
@ -682,7 +678,7 @@ extension MessageReceiver {
) throws {
guard let sender: String = message.sender else { return }
guard let closedGroup: ClosedGroup = try? ClosedGroup.fetchOne(db, id: threadId) else {
return SNLog("Ignoring group update for nonexistent group.")
return Log.warn(.messageReceiver, "Ignoring group update for nonexistent group.")
}
let timestampMs: Int64 = (
@ -699,14 +695,14 @@ extension MessageReceiver {
case .legacyGroup:
// Check that the message isn't from before the group was created
guard Double(message.sentTimestampMs ?? 0) > closedGroup.formationTimestamp else {
return SNLog("Ignoring legacy group update from before thread was created.")
return Log.warn(.messageReceiver, "Ignoring legacy group update from before thread was created.")
}
// If these values are missing then we probably won't be able to validly handle the message
guard
let allMembers: [GroupMember] = try? closedGroup.allMembers.fetchAll(db),
allMembers.contains(where: { $0.profileId == sender })
else { return SNLog("Ignoring legacy group update from non-member.") }
else { return Log.warn(.messageReceiver, "Ignoring legacy group update from non-member.") }
try legacyGroupChanges(sender, closedGroup, allMembers)

2
SessionMessagingKit/Sending & Receiving/Message Handling/MessageReceiver+TypingIndicators.swift
Unescape Escape View File

@ -47,7 +47,7 @@ extension MessageReceiver {
dependencies[singleton: .typingIndicators].didStopTyping(db, threadId: threadId, direction: .incoming)
default:
SNLog("Unknown TypingIndicator Kind ignored")
Log.warn(.messageReceiver, "Unknown TypingIndicator Kind ignored")
return
}
}

2
SessionMessagingKit/Sending & Receiving/Message Handling/MessageReceiver+VisibleMessages.swift
Unescape Escape View File

@ -115,7 +115,7 @@ extension MessageReceiver {
)
case .group:
SNLog("Ignoring message with invalid sender.")
Log.info(.messageReceiver, "Ignoring message with invalid sender.")
throw MessageReceiverError.invalidSender
}
}()

12
SessionMessagingKit/Sending & Receiving/Message Handling/MessageSender+LegacyClosedGroups.swift
Unescape Escape View File

@ -319,7 +319,7 @@ extension MessageSender {
// Get the group, check preconditions & prepare
guard (try? SessionThread.exists(db, id: legacyGroupSessionId)) == true else {
SNLog("Can't update nonexistent closed group.")
Log.warn(.messageSender, "Can't update nonexistent closed group.")
throw MessageSenderError.noThread
}
guard let closedGroup: ClosedGroup = try? ClosedGroup.fetchOne(db, id: legacyGroupSessionId) else {
@ -555,12 +555,12 @@ extension MessageSender {
using dependencies: Dependencies
) -> AnyPublisher<Void, Error> {
guard !removedMembers.contains(userSessionId.hexString) else {
SNLog("Invalid closed group update.")
Log.warn(.messageSender, "Invalid closed group update.")
return Fail(error: MessageSenderError.invalidClosedGroupUpdate)
.eraseToAnyPublisher()
}
guard allGroupMembers.contains(where: { $0.role == .admin && $0.profileId == userSessionId.hexString }) else {
SNLog("Only an admin can remove members from a group.")
Log.warn(.messageSender, "Only an admin can remove members from a group.")
return Fail(error: MessageSenderError.invalidClosedGroupUpdate)
.eraseToAnyPublisher()
}
@ -645,7 +645,7 @@ extension MessageSender {
using dependencies: Dependencies
) {
guard let thread: SessionThread = try? SessionThread.fetchOne(db, id: groupPublicKey) else {
return SNLog("Couldn't send key pair for nonexistent closed group.")
return Log.warn(.messageSender, "Couldn't send key pair for nonexistent closed group.")
}
guard let closedGroup: ClosedGroup = try? thread.closedGroup.fetchOne(db) else {
return
@ -654,7 +654,7 @@ extension MessageSender {
return
}
guard allGroupMembers.contains(where: { $0.role == .standard && $0.profileId == publicKey }) else {
return SNLog("Refusing to send latest encryption key pair to non-member.")
return Log.error(.messageSender, "Refusing to send latest encryption key pair to non-member.")
}
// Get the latest encryption key pair
@ -692,7 +692,7 @@ extension MessageSender {
)
)
SNLog("Sending latest encryption key pair to: \(publicKey).")
Log.info(.messageSender, "Sending latest encryption key pair to: \(publicKey).")
try MessageSender.send(
db,
message: ClosedGroupControlMessage(

4
SessionMessagingKit/Sending & Receiving/Notifications/PushNotificationAPI.swift
Unescape Escape View File

@ -492,7 +492,7 @@ public enum PushNotificationAPI {
let notification: BencodeResponse<NotificationMetadata> = try? BencodeDecoder(using: dependencies)
.decode(BencodeResponse<NotificationMetadata>.self, from: decryptedData)
else {
SNLog("Failed to decrypt or decode notification")
Log.error(.cat, "Failed to decrypt or decode notification")
return (nil, .invalid, .failure)
}
@ -506,7 +506,7 @@ public enum PushNotificationAPI {
notification.info.dataLength == notificationData.count,
!notificationData.isEmpty
else {
SNLog("Get notification data failed")
Log.error(.cat, "Get notification data failed")
return (nil, notification.info, .failureNoContent)
}

8
SessionMessagingKit/Utilities/Data+Utilities.swift
Unescape Escape View File

@ -3,6 +3,12 @@
import Foundation
import SessionUtilitiesKit
// MARK: - Log.Category
private extension Log.Category {
static let cat: Log.Category = .create("Data", defaultLevel: .warn)
}
// MARK: - Decoding
public extension Data {
@ -18,7 +24,7 @@ public extension Data {
break
}
else if bytes[targetIndex] != 0x00 {
SNLog("Failed to remove padding, returning unstripped padding");
Log.error(.cat, "Failed to remove padding, returning unstripped padding");
return self
}
}

6
SessionMessagingKit/Utilities/MessageWrapper.swift
Unescape Escape View File

@ -58,7 +58,7 @@ public enum MessageWrapper {
builder.setContent(content)
return try builder.build()
} catch let error {
SNLog("Failed to wrap message in envelope: \(error).")
Log.error(.messageSender, "Failed to wrap message in envelope: \(error).")
throw Error.failedToWrapMessageInEnvelope
}
}
@ -71,7 +71,7 @@ public enum MessageWrapper {
messageBuilder.setRequest(try requestBuilder.build())
return try messageBuilder.build()
} catch let error {
SNLog("Failed to wrap envelope in web socket message: \(error).")
Log.error(.messageSender, "Failed to wrap envelope in web socket message: \(error).")
throw Error.failedToWrapEnvelopeInWebSocketMessage
}
}
@ -90,7 +90,7 @@ public enum MessageWrapper {
}()
return try SNProtoEnvelope.parseData(envelopeData)
} catch let error {
SNLog("Failed to unwrap data: \(error).")
Log.error(.messageSender, "Failed to unwrap data: \(error).")
throw Error.failedToUnwrapData
}
}

10
SessionMessagingKit/Utilities/Preferences+Sound.swift
Unescape Escape View File

@ -6,6 +6,14 @@ import GRDB
import DifferenceKit
import SessionUtilitiesKit
// MARK: - Log.Category
private extension Log.Category {
static let cat: Log.Category = .create("Preferences.Sound", defaultLevel: .warn)
}
// MARK: - Preferences
public extension Preferences {
enum Sound: Int, Codable, DatabaseValueConvertible, EnumIntSetting, Differentiable {
public static var defaultiOSIncomingRingtone: Sound = .opening
@ -153,7 +161,7 @@ public extension Preferences {
public func notificationSound(isQuiet: Bool) -> UNNotificationSound {
guard let filename: String = filename(quiet: isQuiet) else {
SNLog("[Preferences.Sound] filename was unexpectedly nil")
Log.warn(.cat, "Filename was unexpectedly nil")
return UNNotificationSound.default
}

2
SessionMessagingKit/Utilities/SNProtoEnvelope+Conversion.swift
Unescape Escape View File

@ -7,7 +7,7 @@ import SessionUtilitiesKit
public extension SNProtoEnvelope {
static func from(_ message: SnodeReceivedMessage) -> SNProtoEnvelope? {
guard let result = try? MessageWrapper.unwrap(data: message.data) else {
SNLog("Failed to unwrap data for message: \(String(reflecting: message)).")
Log.error(.messageReceiver, "Failed to unwrap data for message: \(String(reflecting: message)).")
return nil
}

5
SessionMessagingKitTests/_TestUtilities/MockLibSessionCache.swift
Unescape Escape View File

@ -13,7 +13,10 @@ class MockLibSessionCache: Mock<LibSessionCacheType>, LibSessionCacheType {
// MARK: - State Management
func loadState(_ db: Database) { mockNoReturn(untrackedArgs: [db]) }
func loadState(_ db: Database, requestId: String?) {
mockNoReturn(args: [requestId], untrackedArgs: [db])
}
func loadDefaultStatesFor(
userConfigVariants: Set<ConfigDump.Variant>,
groups: [ClosedGroup],

137
SessionNotificationServiceExtension/NotificationServiceExtension.swift
Unescape Escape View File

@ -12,11 +12,18 @@ import SessionSnodeKit
import SignalUtilitiesKit
import SessionUtilitiesKit
// MARK: - Log.Category
private extension Log.Category {
static let cat: Log.Category = .create("NotificationServiceExtension", defaultLevel: .info)
}
// MARK: - NotificationServiceExtension
public final class NotificationServiceExtension: UNNotificationServiceExtension {
// Called via the OS so create a default 'Dependencies' instance
private var dependencies: Dependencies = Dependencies.createEmpty()
private var startTime: CFTimeInterval = 0
private var fallbackRunId: String = "N/A" // stringlint:ignore
private var contentHandler: ((UNNotificationContent) -> Void)?
private var request: UNNotificationRequest?
@ThreadSafe private var hasCompleted: Bool = false
@ -32,9 +39,7 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
// MARK: Did receive a remote push notification request
override public func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
let runId: String = UUID().uuidString
self.startTime = CACurrentMediaTime()
self.fallbackRunId = runId
self.contentHandler = contentHandler
self.request = request
@ -47,14 +52,14 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
// Abort if the main app is running
guard !dependencies[defaults: .appGroup, key: .isMainAppActive] else {
return self.completeSilenty(.ignoreDueToMainAppRunning, runId: runId)
return self.completeSilenty(.ignoreDueToMainAppRunning, requestId: request.identifier)
}
guard let notificationContent = request.content.mutableCopy() as? UNMutableNotificationContent else {
return self.completeSilenty(.ignoreDueToNoContentFromApple, runId: runId)
return self.completeSilenty(.ignoreDueToNoContentFromApple, requestId: request.identifier)
}
Log.info("didReceive called with runId: \(runId).")
Log.info(.cat, "didReceive called with requestId: \(request.identifier).")
/// Create the context if we don't have it (needed before _any_ interaction with the database)
if !dependencies[singleton: .appContext].isValid {
@ -65,14 +70,12 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
}
/// Actually perform the setup
DispatchQueue.main.sync {
self.performSetup(runId: runId) { [weak self] in
self?.handleNotification(notificationContent, runId: runId)
}
self.performSetup(requestId: request.identifier) { [weak self] in
self?.handleNotification(notificationContent, requestId: request.identifier)
}
}
private func handleNotification(_ notificationContent: UNMutableNotificationContent, runId: String) {
private func handleNotification(_ notificationContent: UNMutableNotificationContent, requestId: String) {
let (maybeData, metadata, result) = PushNotificationAPI.processNotification(
notificationContent: notificationContent,
using: dependencies
@ -92,21 +95,21 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
threadVariant: nil,
threadDisplayName: nil,
resolution: .errorProcessing(result),
runId: runId
requestId: requestId
)
case (.success, _), (.legacySuccess, _), (.failure, _):
return self.completeSilenty(.errorProcessing(result), runId: runId)
return self.completeSilenty(.errorProcessing(result), requestId: requestId)
// Just log if the notification was too long (a ~2k message should be able to fit so
// these will most commonly be call or config messages)
case (.successTooLong, _):
return self.completeSilenty(.ignoreDueToContentSize(metadata), runId: runId)
return self.completeSilenty(.ignoreDueToContentSize(metadata), requestId: requestId)
case (.failureNoContent, _): return self.completeSilenty(.errorNoContent(metadata), runId: runId)
case (.legacyFailure, _): return self.completeSilenty(.errorNoContentLegacy, runId: runId)
case (.failureNoContent, _): return self.completeSilenty(.errorNoContent(metadata), requestId: requestId)
case (.legacyFailure, _): return self.completeSilenty(.errorNoContentLegacy, requestId: requestId)
case (.legacyForceSilent, _):
return self.completeSilenty(.ignoreDueToNonLegacyGroupLegacyNotification, runId: runId)
return self.completeSilenty(.ignoreDueToNonLegacyGroupLegacyNotification, requestId: requestId)
}
}
@ -242,7 +245,7 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
using: dependencies
)
return self?.handleSuccessForIncomingCall(db, for: callMessage, runId: runId)
return self?.handleSuccessForIncomingCall(db, for: callMessage, requestId: requestId)
}
// Perform any required post-handling logic
@ -294,8 +297,8 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
}
db.afterNextTransaction(
onCommit: { _ in self?.completeSilenty(.success(metadata), runId: runId) },
onRollback: { _ in self?.completeSilenty(.errorTransactionFailure, runId: runId) }
onCommit: { _ in self?.completeSilenty(.success(metadata), requestId: requestId) },
onRollback: { _ in self?.completeSilenty(.errorTransactionFailure, requestId: requestId) }
)
}
catch {
@ -307,23 +310,23 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
DispatchQueue.main.async {
switch (error, processedThreadVariant, metadata.namespace.isConfigNamespace) {
case (MessageReceiverError.noGroupKeyPair, _, _):
self?.completeSilenty(.errorLegacyGroupKeysMissing, runId: runId)
self?.completeSilenty(.errorLegacyGroupKeysMissing, requestId: requestId)
case (MessageReceiverError.outdatedMessage, _, _):
self?.completeSilenty(.ignoreDueToOutdatedMessage, runId: runId)
self?.completeSilenty(.ignoreDueToOutdatedMessage, requestId: requestId)
case (MessageReceiverError.ignorableMessage, _, _):
self?.completeSilenty(.ignoreDueToRequiresNoNotification, runId: runId)
self?.completeSilenty(.ignoreDueToRequiresNoNotification, requestId: requestId)
case (MessageReceiverError.duplicateMessage, _, _),
(MessageReceiverError.duplicateControlMessage, _, _),
(MessageReceiverError.duplicateMessageNewSnode, _, _):
self?.completeSilenty(.ignoreDueToDuplicateMessage, runId: runId)
self?.completeSilenty(.ignoreDueToDuplicateMessage, requestId: requestId)
/// If it was a `decryptionFailed` error, but it was for a config namespace then just fail silently (don't
/// want to show the fallback notification in this case)
case (MessageReceiverError.decryptionFailed, _, true):
self?.completeSilenty(.errorMessageHandling(.decryptionFailed), runId: runId)
self?.completeSilenty(.errorMessageHandling(.decryptionFailed), requestId: requestId)
/// If it was a `decryptionFailed` error for a group conversation and the group doesn't exist or
/// doesn't have auth info (ie. group destroyed or member kicked), then just fail silently (don't want
@ -336,7 +339,7 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
group.authData != nil
)
else {
self?.completeSilenty(.errorMessageHandling(.decryptionFailed), runId: runId)
self?.completeSilenty(.errorMessageHandling(.decryptionFailed), requestId: requestId)
return
}
@ -347,7 +350,7 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
threadVariant: processedThreadVariant,
threadDisplayName: threadDisplayName,
resolution: .errorMessageHandling(.decryptionFailed),
runId: runId
requestId: requestId
)
case (let msgError as MessageReceiverError, _, _):
@ -357,7 +360,7 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
threadVariant: processedThreadVariant,
threadDisplayName: threadDisplayName,
resolution: .errorMessageHandling(msgError),
runId: runId
requestId: requestId
)
default:
@ -367,7 +370,7 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
threadVariant: processedThreadVariant,
threadDisplayName: threadDisplayName,
resolution: .errorOther(error),
runId: runId
requestId: requestId
)
}
}
@ -384,12 +387,13 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
// MARK: Setup
private func performSetup(runId: String, completion: @escaping () -> Void) {
Log.info("Performing setup for runId: \(runId).")
private func performSetup(requestId: String, completion: @escaping () -> Void) {
Log.info(.cat, "Performing setup for requestId: \(requestId).")
dependencies.warmCache(cache: .appVersion)
AppSetup.setupEnvironment(
requestId: requestId,
appSpecificBlock: { [dependencies] in
// stringlint:ignore_start
Log.setup(with: Logger(
@ -416,12 +420,12 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
},
migrationsCompletion: { [weak self, dependencies] result in
switch result {
case .failure(let error): self?.completeSilenty(.errorDatabaseMigrations(error), runId: runId)
case .failure(let error): self?.completeSilenty(.errorDatabaseMigrations(error), requestId: requestId)
case .success:
DispatchQueue.main.async {
// Ensure storage is actually valid
guard dependencies[singleton: .storage].isValid else {
self?.completeSilenty(.errorDatabaseInvalid, runId: runId)
self?.completeSilenty(.errorDatabaseInvalid, requestId: requestId)
return
}
@ -431,7 +435,7 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
// so it is possible that could change in the future. If it does, do nothing
// and don't disturb the user. Messages will be processed when they open the app.
guard dependencies[singleton: .storage, key: .isReadyForAppExtensions] else {
self?.completeSilenty(.errorNotReadyForExtensions, runId: runId)
self?.completeSilenty(.errorNotReadyForExtensions, requestId: requestId)
return
}
@ -454,10 +458,18 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
override public func serviceExtensionTimeWillExpire() {
// Called just before the extension will be terminated by the system.
// Use this as an opportunity to deliver your "best attempt" at modified content, otherwise the original push payload will be used.
completeSilenty(.errorTimeout, runId: fallbackRunId)
completeSilenty(.errorTimeout, requestId: (request?.identifier ?? "N/A")) // stringlint:ignore
}
private func completeSilenty(_ resolution: NotificationResolution, runId: String) {
private func completeSilenty(_ resolution: NotificationResolution, requestId: String) {
// This can be called from within database threads so to prevent blocking and weird
// behaviours make sure to send it to the main thread instead
guard Thread.isMainThread else {
return DispatchQueue.main.async { [weak self] in
self?.completeSilenty(resolution, requestId: requestId)
}
}
// Ensure we only run this once
guard _hasCompleted.performUpdateAndMap({ (true, $0) }) == false else { return }
@ -474,8 +486,9 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
}
let duration: CFTimeInterval = (CACurrentMediaTime() - startTime)
Log.custom(resolution.logLevel, [], "\(resolution) after \(.seconds(duration), unit: .ms), runId: \(runId).")
Log.custom(resolution.logLevel, [.cat], "\(resolution) after \(.seconds(duration), unit: .ms), requestId: \(requestId).")
Log.flush()
Log.reset()
self.contentHandler!(silentContent)
}
@ -483,7 +496,7 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
private func handleSuccessForIncomingCall(
_ db: Database,
for callMessage: CallMessage,
runId: String
requestId: String
) {
if #available(iOSApplicationExtension 14.5, *), Preferences.isCallKitSupported {
guard let caller: String = callMessage.sender, let timestamp = callMessage.sentTimestampMs else { return }
@ -499,14 +512,14 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
CXProvider.reportNewIncomingVoIPPushPayload(payload) { error in
if let error = error {
Log.error("Failed to notify main app of call message: \(error).")
Log.error(.cat, "Failed to notify main app of call message: \(error).")
dependencies[singleton: .storage].read { db in
self?.handleFailureForVoIP(db, for: callMessage, runId: runId)
self?.handleFailureForVoIP(db, for: callMessage, requestId: requestId)
}
}
else {
dependencies[defaults: .appGroup, key: .lastCallPreOffer] = Date()
self?.completeSilenty(.successCall, runId: runId)
self?.completeSilenty(.successCall, requestId: requestId)
}
}
}
@ -517,11 +530,11 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
)
}
else {
self.handleFailureForVoIP(db, for: callMessage, runId: runId)
self.handleFailureForVoIP(db, for: callMessage, requestId: requestId)
}
}
private func handleFailureForVoIP(_ db: Database, for callMessage: CallMessage, runId: String) {
private func handleFailureForVoIP(_ db: Database, for callMessage: CallMessage, requestId: String) {
let notificationContent = UNMutableNotificationContent()
notificationContent.userInfo = [ NotificationServiceExtension.isFromRemoteKey : true ]
notificationContent.title = Constants.app_name
@ -545,16 +558,16 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
UNUserNotificationCenter.current().add(request) { error in
if let error = error {
Log.error("Failed to add notification request due to error: \(error).")
Log.error(.cat, "Failed to add notification request for requestId: \(requestId) due to error: \(error).")
}
semaphore.signal()
}
semaphore.wait()
Log.info("Add remote notification request.")
Log.info(.cat, "Add remote notification request for requestId: \(requestId).")
db.afterNextTransaction(
onCommit: { [weak self] _ in self?.completeSilenty(.errorCallFailure, runId: runId) },
onRollback: { [weak self] _ in self?.completeSilenty(.errorTransactionFailure, runId: runId) }
onCommit: { [weak self] _ in self?.completeSilenty(.errorCallFailure, requestId: requestId) },
onRollback: { [weak self] _ in self?.completeSilenty(.errorTransactionFailure, requestId: requestId) }
)
}
@ -564,24 +577,42 @@ public final class NotificationServiceExtension: UNNotificationServiceExtension
threadVariant: SessionThread.Variant?,
threadDisplayName: String?,
resolution: NotificationResolution,
runId: String
requestId: String
) {
// This can be called from within database threads so to prevent blocking and weird
// behaviours make sure to send it to the main thread instead
guard Thread.isMainThread else {
return DispatchQueue.main.async { [weak self] in
self?.handleFailure(
for: content,
metadata: metadata,
threadVariant: threadVariant,
threadDisplayName: threadDisplayName,
resolution: resolution,
requestId: requestId
)
}
}
let duration: CFTimeInterval = (CACurrentMediaTime() - startTime)
Log.error("\(resolution) after \(.seconds(duration), unit: .ms), showing generic failure message for message from namespace: \(metadata.namespace), runId: \(runId).")
Log.flush()
let previewType: Preferences.NotificationPreviewType = dependencies[singleton: .storage, key: .preferencesNotificationPreviewType]
.defaulting(to: .nameAndPreview)
Log.error(.cat, "\(resolution) after \(.seconds(duration), unit: .ms), showing generic failure message for message from namespace: \(metadata.namespace), requestId: \(requestId).")
/// Now we are done with the database, we should suspend it
if !dependencies[defaults: .appGroup, key: .isMainAppActive] {
dependencies[singleton: .storage].suspendDatabaseAccess()
}
/// Clear the logger
Log.flush()
Log.reset()
content.title = Constants.app_name
content.userInfo = [ NotificationServiceExtension.isFromRemoteKey: true ]
/// If it's a notification for a group conversation, the notification preferences are right and we have a name for the group
/// then we should include it in the notification content
let previewType: Preferences.NotificationPreviewType = dependencies[singleton: .storage, key: .preferencesNotificationPreviewType]
.defaulting(to: .nameAndPreview)
switch (threadVariant, previewType, threadDisplayName) {
case (.group, .nameAndPreview, .some(let name)), (.group, .nameNoPreview, .some(let name)),
(.legacyGroup, .nameAndPreview, .some(let name)), (.legacyGroup, .nameNoPreview, .some(let name)):

4
SessionSnodeKit/Models/DeleteAllBeforeResponse.swift
Unescape Escape View File

@ -28,10 +28,10 @@ extension DeleteAllBeforeResponse: ValidatableResponse {
result[next.key] = false
if let reason: String = next.value.reason, let statusCode: Int = next.value.code {
SNLog("Couldn't delete data from: \(next.key) due to error: \(reason) (\(statusCode)).")
Log.warn(.validator(self), "Couldn't delete data from: \(next.key) due to error: \(reason) (\(statusCode)).")
}
else {
SNLog("Couldn't delete data from: \(next.key).")
Log.warn(.validator(self), "Couldn't delete data from: \(next.key).")
}
return
}

4
SessionSnodeKit/Models/DeleteAllMessagesResponse.swift
Unescape Escape View File

@ -70,10 +70,10 @@ extension DeleteAllMessagesResponse: ValidatableResponse {
result[next.key] = false
if let reason: String = next.value.reason, let statusCode: Int = next.value.code {
SNLog("Couldn't delete data from: \(next.key) due to error: \(reason) (\(statusCode)).")
Log.warn(.validator(self), "Couldn't delete data from: \(next.key) due to error: \(reason) (\(statusCode)).")
}
else {
SNLog("Couldn't delete data from: \(next.key).")
Log.warn(.validator(self), "Couldn't delete data from: \(next.key).")
}
return
}

4
SessionSnodeKit/Models/RevokeSubaccountResponse.swift
Unescape Escape View File

@ -26,10 +26,10 @@ extension RevokeSubaccountResponse: ValidatableResponse {
let encodedSignature: Data = Data(base64Encoded: signatureBase64)
else {
if let reason: String = next.value.reason, let statusCode: Int = next.value.code {
SNLog("Couldn't revoke subaccount from: \(next.key) due to error: \(reason) (\(statusCode)).")
Log.warn(.validator(self), "Couldn't revoke subaccount from: \(next.key) due to error: \(reason) (\(statusCode)).")
}
else {
SNLog("Couldn't revoke subaccount from: \(next.key).")
Log.warn(.validator(self), "Couldn't revoke subaccount from: \(next.key).")
}
return
}

4
SessionSnodeKit/Models/SendMessageResponse.swift
Unescape Escape View File

@ -105,10 +105,10 @@ extension SendMessagesResponse: ValidatableResponse {
result[next.key] = false
if let reason: String = next.value.reason, let statusCode: Int = next.value.code {
SNLog("Couldn't store message on: \(next.key) due to error: \(reason) (\(statusCode)).")
Log.warn(.validator(self), "Couldn't store message on: \(next.key) due to error: \(reason) (\(statusCode)).")
}
else {
SNLog("Couldn't store message on: \(next.key).")
Log.warn(.validator(self), "Couldn't store message on: \(next.key).")
}
return
}

2
SessionSnodeKit/Models/SnodeReceivedMessage.swift
Unescape Escape View File

@ -22,7 +22,7 @@ public struct SnodeReceivedMessage: CustomDebugStringConvertible {
rawMessage: GetMessagesResponse.RawMessage
) {
guard let data: Data = Data(base64Encoded: rawMessage.base64EncodedDataString) else {
SNLog("Failed to decode data for message: \(rawMessage).")
Log.error(.network, "Failed to decode data for message: \(rawMessage).")
return nil
}

4
SessionSnodeKit/Models/UnrevokeSubaccountResponse.swift
Unescape Escape View File

@ -26,10 +26,10 @@ extension UnrevokeSubaccountResponse: ValidatableResponse {
let encodedSignature: Data = Data(base64Encoded: signatureBase64)
else {
if let reason: String = next.value.reason, let statusCode: Int = next.value.code {
SNLog("Couldn't revoke subaccount from: \(next.key) due to error: \(reason) (\(statusCode)).")
Log.warn(.validator(self), "Couldn't revoke subaccount from: \(next.key) due to error: \(reason) (\(statusCode)).")
}
else {
SNLog("Couldn't revoke subaccount from: \(next.key).")
Log.warn(.validator(self), "Couldn't revoke subaccount from: \(next.key).")
}
return
}

4
SessionSnodeKit/Models/UpdateExpiryAllResponse.swift
Unescape Escape View File

@ -70,10 +70,10 @@ extension UpdateExpiryAllResponse: ValidatableResponse {
result[next.key] = []
if let reason: String = next.value.reason, let statusCode: Int = next.value.code {
SNLog("Couldn't update expiry from: \(next.key) due to error: \(reason) (\(statusCode)).")
Log.warn(.validator(self), "Couldn't update expiry from: \(next.key) due to error: \(reason) (\(statusCode)).")
}
else {
SNLog("Couldn't update expiry from: \(next.key).")
Log.warn(.validator(self), "Couldn't update expiry from: \(next.key).")
}
return
}

4
SessionSnodeKit/Models/UpdateExpiryResponse.swift
Unescape Escape View File

@ -72,10 +72,10 @@ extension UpdateExpiryResponse: ValidatableResponse {
result[next.key] = UpdateExpiryResponseResult(changed: [:], unchanged: [:], didError: true)
if let reason: String = next.value.reason, let statusCode: Int = next.value.code {
SNLog("Couldn't update expiry from: \(next.key) due to error: \(reason) (\(statusCode)).")
Log.warn(.validator(self), "Couldn't update expiry from: \(next.key) due to error: \(reason) (\(statusCode)).")
}
else {
SNLog("Couldn't update expiry from: \(next.key).")
Log.warn(.validator(self), "Couldn't update expiry from: \(next.key).")
}
return
}

2
SessionSnodeKit/Types/PreparedRequest.swift
Unescape Escape View File

@ -415,7 +415,7 @@ extension Network.PreparedRequest: ErasedPreparedRequest {
public func encodeForBatchRequest(to encoder: Encoder) throws {
switch batchRequestVariant {
case .unsupported:
SNLog("Attempted to encode unsupported request type \(endpointName) as a batch subrequest")
Log.critical("Attempted to encode unsupported request type \(endpointName) as a batch subrequest")
case .sogs:
var container: KeyedEncodingContainer<Network.BatchRequest.Child.CodingKeys> = encoder.container(keyedBy: Network.BatchRequest.Child.CodingKeys.self)

10
SessionSnodeKit/Types/ValidatableResponse.swift
Unescape Escape View File

@ -3,6 +3,16 @@
import Foundation
import SessionUtilitiesKit
// MARK: - Log.Category
internal extension Log.Category {
static func validator(_ response: Any) -> Log.Category {
return .create("ResponseValidator", customSuffix: "-\(type(of: response))", defaultLevel: .warn)
}
}
// MARK: - ValidatableResponse
internal protocol ValidatableResponse {
associatedtype ValidationData
associatedtype ValidationResponse

2
SessionUtilitiesKit/Database/Models/Identity.swift
Unescape Escape View File

@ -143,7 +143,7 @@ public extension Identity {
]
// stringlint:ignore_stop
SNLog("Failed to retrieve keys for mnemonic generation (\(dbStates.joined(separator: ", ")))")
Log.critical("Failed to retrieve keys for mnemonic generation (\(dbStates.joined(separator: ", ")))")
throw StorageError.objectNotFound
}

2
SessionUtilitiesKit/Database/Types/PagedDatabaseObserver.swift
Unescape Escape View File

@ -498,7 +498,7 @@ public class PagedDatabaseObserver<ObservedTable, T>: TransactionObserver where
let currentPageInfo: PagedData.PageInfo = self.pageInfo
if case .initialPageAround(_) = target, currentPageInfo.currentCount > 0 {
SNLog("Unable to load initialPageAround if there is already data")
Log.warn(.cat, "Unable to load initialPageAround if there is already data")
return
}

51
SessionUtilitiesKit/General/Logging.swift
Unescape Escape View File

@ -55,23 +55,26 @@ public enum Log {
public struct Category: Hashable {
public let rawValue: String
fileprivate let customPrefix: String
fileprivate let customSuffix: String
public let defaultLevel: Log.Level
fileprivate static let identifierPrefix: String = "logLevel-"
fileprivate var identifier: String { "\(Category.identifierPrefix)\(rawValue)" }
private init(rawValue: String, customPrefix: String, defaultLevel: Log.Level) {
private init(rawValue: String, customPrefix: String, customSuffix: String, defaultLevel: Log.Level) {
/// If we've already registered this category then assume the original has the correct `defaultLevel` and only
/// modify the `customPrefix` value
switch AllLoggingCategories.existingCategory(for: rawValue) {
case .some(let existingCategory):
self.rawValue = existingCategory.rawValue
self.customPrefix = customPrefix
self.customSuffix = customSuffix
self.defaultLevel = existingCategory.defaultLevel
case .none:
self.rawValue = rawValue
self.customPrefix = customPrefix
self.customSuffix = customSuffix
self.defaultLevel = defaultLevel
AllLoggingCategories.register(category: self)
@ -84,16 +87,27 @@ public enum Log {
self.init(
rawValue: identifier.substring(from: Category.identifierPrefix.count),
customPrefix: "",
customSuffix: "",
defaultLevel: .default
)
}
public init(rawValue: String, customPrefix: String = "") {
self.init(rawValue: rawValue, customPrefix: customPrefix, defaultLevel: .default)
public init(rawValue: String, customPrefix: String = "", customSuffix: String = "") {
self.init(rawValue: rawValue, customPrefix: customPrefix, customSuffix: customSuffix, defaultLevel: .default)
}
@discardableResult public static func create(_ rawValue: String, customPrefix: String = "", defaultLevel: Log.Level) -> Log.Category {
return Log.Category(rawValue: rawValue, customPrefix: customPrefix, defaultLevel: defaultLevel)
@discardableResult public static func create(
_ rawValue: String,
customPrefix: String = "",
customSuffix: String = "",
defaultLevel: Log.Level
) -> Log.Category {
return Log.Category(
rawValue: rawValue,
customPrefix: customPrefix,
customSuffix: customSuffix,
defaultLevel: defaultLevel
)
}
}
@ -167,6 +181,10 @@ public enum Log {
DDLog.flushLog()
}
public static func reset() {
Log._logger.set(to: nil)
}
// MARK: - Log Functions
fileprivate static func empty() {
@ -187,6 +205,7 @@ public enum Log {
}
}
// FIXME: Would be nice to properly require a category for all logs
public static func verbose(
_ msg: String,
file: StaticString = #file,
@ -366,7 +385,6 @@ public enum Log {
public class Logger {
private let dependencies: Dependencies
private let primaryPrefix: String
private let forceNSLog: Bool
@ThreadSafeObject private var systemLoggers: [String: SystemLoggerType] = [:]
fileprivate let fileLogger: DDFileLogger
@ThreadSafe fileprivate var isSuspended: Bool = true
@ -375,12 +393,10 @@ public class Logger {
public init(
primaryPrefix: String,
customDirectory: String? = nil,
forceNSLog: Bool = false,
using dependencies: Dependencies
) {
self.dependencies = dependencies
self.primaryPrefix = primaryPrefix
self.forceNSLog = forceNSLog
switch customDirectory {
case .none: self.fileLogger = DDFileLogger()
@ -409,6 +425,12 @@ public class Logger {
self.loadExtensionLogsAndResumeLogging()
}
deinit {
// Need to ensure we remove the `fileLogger` from `DDLog` otherwise we will get duplicate
// log entries
DDLog.remove(fileLogger)
}
// MARK: - Functions
fileprivate func setPendingLogsRetriever(_ callback: @escaping () -> [Log.LogInfo]) {
@ -565,7 +587,13 @@ public class Logger {
(DispatchQueue.isDBWriteQueue ? "DBWrite" : nil)
]
.compactMap { $0 }
.appending(contentsOf: categories.map { "\($0.customPrefix)\($0.rawValue)" })
.appending(
contentsOf: categories
/// No point doubling up but we want to allow categories which match the `primaryPrefix` so that we
/// have a mechanism for providing a different "default" log level for a specific target
.filter { $0.rawValue != primaryPrefix }
.map { "\($0.customPrefix)\($0.rawValue)\($0.customSuffix)" }
)
.joined(separator: ", ")
return "[\(prefixes)] "
@ -769,8 +797,3 @@ public struct AllLoggingCategories: FeatureOption {
public var title: String = "AllLoggingCategories"
public let subtitle: String? = nil
}
// FIXME: Remove this once everything has been updated to use the new `Log.x()` methods.
public func SNLog(_ message: String, forceNSLog: Bool = false) {
Log.info(message)
}

28
SessionUtilitiesKit/Media/MediaUtils.swift
Unescape Escape View File

@ -3,10 +3,20 @@
import UIKit
import AVFoundation
// MARK: - Log.Category
public extension Log.Category {
static let media: Log.Category = .create("MediaUtils", defaultLevel: .warn)
}
// MARK: - MediaError
public enum MediaError: Error {
case failure(description: String)
}
// MARK: - MediaUtils
public enum MediaUtils {
public static var maxFileSizeAnimatedImage: UInt { SNUtilitiesKit.maxFileSize }
public static var maxFileSizeImage: UInt { SNUtilitiesKit.maxFileSize }
@ -19,7 +29,7 @@ public enum MediaUtils {
public static let maxVideoDimensions: CGFloat = 3 * 1024
public static func thumbnail(forImageAtPath path: String, maxDimension: CGFloat, type: String, using dependencies: Dependencies) throws -> UIImage {
SNLog("thumbnailing image: \(path)")
Log.verbose(.media, "Thumbnailing image: \(path)")
guard dependencies[singleton: .fileManager].fileExists(atPath: path) else {
throw MediaError.failure(description: "Media file missing.")
@ -37,7 +47,7 @@ public enum MediaUtils {
}
public static func thumbnail(forVideoAtPath path: String, maxDimension: CGFloat, using dependencies: Dependencies) throws -> UIImage {
SNLog("thumbnailing video: \(path)")
Log.verbose(.media, "Thumbnailing video: \(path)")
guard isVideoOfValidContentTypeAndSize(path: path, using: dependencies) else {
throw MediaError.failure(description: "Media file has missing or invalid length.")
@ -61,7 +71,7 @@ public enum MediaUtils {
public static func isValidVideo(path: String, using dependencies: Dependencies) -> Bool {
guard isVideoOfValidContentTypeAndSize(path: path, using: dependencies) else {
SNLog("Media file has missing or invalid length.")
Log.error(.media, "Media file has missing or invalid length.")
return false
}
@ -72,21 +82,21 @@ public enum MediaUtils {
private static func isVideoOfValidContentTypeAndSize(path: String, using dependencies: Dependencies) -> Bool {
guard dependencies[singleton: .fileManager].fileExists(atPath: path) else {
SNLog("Media file missing.")
Log.error(.media, "Media file missing.")
return false
}
let fileExtension = URL(fileURLWithPath: path).pathExtension
guard let contentType: String = UTType.sessionMimeType(for: fileExtension) else {
SNLog("Media file has unknown content type.")
Log.error(.media, "Media file has unknown content type.")
return false
}
guard UTType.isVideo(contentType) else {
SNLog("Media file has invalid content type.")
Log.error(.media, "Media file has invalid content type.")
return false
}
guard let fileSize: UInt64 = dependencies[singleton: .fileManager].fileSize(of: path) else {
SNLog("Media file has unknown length.")
Log.error(.media, "Media file has unknown length.")
return false
}
return UInt(fileSize) <= SNUtilitiesKit.maxFileSize
@ -100,11 +110,11 @@ public enum MediaUtils {
maxTrackSize.height = max(maxTrackSize.height, trackSize.height)
}
if maxTrackSize.width < 1.0 || maxTrackSize.height < 1.0 {
SNLog("Invalid video size: \(maxTrackSize)")
Log.error(.media, "Invalid video size: \(maxTrackSize)")
return false
}
if maxTrackSize.width > maxVideoDimensions || maxTrackSize.height > maxVideoDimensions {
SNLog("Invalid video dimensions: \(maxTrackSize)")
Log.error(.media, "Invalid video dimensions: \(maxTrackSize)")
return false
}
return true

2
SignalUtilitiesKit/Media Viewing & Editing/Attachment Approval/AttachmentPrepViewController.swift
Unescape Escape View File

@ -242,7 +242,7 @@ public class AttachmentPrepViewController: OWSViewController {
}
@objc public func playButtonTapped() {
guard let fileUrl: URL = attachment.dataUrl else { return SNLog("Missing video file") }
guard let fileUrl: URL = attachment.dataUrl else { return Log.error(.media, "Missing video file") }
let player: AVPlayer = AVPlayer(url: fileUrl)
let viewController: AVPlayerViewController = AVPlayerViewController()

7
SignalUtilitiesKit/Utilities/AppSetup.swift
Unescape Escape View File

@ -9,6 +9,7 @@ import SessionUtilitiesKit
public enum AppSetup {
public static func setupEnvironment(
requestId: String? = nil,
additionalMigrationTargets: [MigratableTarget.Type] = [],
appSpecificBlock: (() -> ())? = nil,
migrationProgressChanged: ((CGFloat, TimeInterval) -> ())? = nil,
@ -37,9 +38,10 @@ public enum AppSetup {
proximityMonitoringManager: OWSProximityMonitoringManagerImpl(using: dependencies),
windowManager: OWSWindowManager(default: ())
)
appSpecificBlock?()
appSpecificBlock?()
runPostSetupMigrations(
requestId: requestId,
backgroundTask: backgroundTask,
additionalMigrationTargets: additionalMigrationTargets,
migrationProgressChanged: migrationProgressChanged,
@ -53,6 +55,7 @@ public enum AppSetup {
}
public static func runPostSetupMigrations(
requestId: String? = nil,
backgroundTask: SessionBackgroundTask? = nil,
additionalMigrationTargets: [MigratableTarget.Type] = [],
migrationProgressChanged: ((CGFloat, TimeInterval) -> ())? = nil,
@ -90,7 +93,7 @@ public enum AppSetup {
userSessionId: userSessionId,
using: dependencies
)
cache.loadState(db)
cache.loadState(db, requestId: requestId)
dependencies.set(cache: .libSession, to: cache)
}

Write Preview
Loading…
Cancel
Save