Skip to content
This repository has been archived by the owner on May 10, 2024. It is now read-only.

No Bug: Add Log handler and debug menu for JitsiSDK logs. #8644

Merged
merged 4 commits into from
Jan 16, 2024
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
2 changes: 1 addition & 1 deletion Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -448,7 +448,7 @@ if isNativeTalkEnabled {
package.dependencies.append(.package(name: "JitsiMeet", path: "ThirdParty/JitsiMeet"))
package.products.append(.library(name: "BraveTalk", targets: ["BraveTalk"]))
package.targets.append(contentsOf: [
.target(name: "BraveTalk", dependencies: ["Shared", "JitsiMeet"]),
.target(name: "BraveTalk", dependencies: ["Shared", "JitsiMeet"], plugins: ["LoggerPlugin"]),
.testTarget(name: "BraveTalkTests", dependencies: ["BraveTalk", "Shared"]),
])
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
// Copyright 2024 The Brave Authors. All rights reserved.
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

import UIKit
import os.log
import OSLog
import SnapKit

public class BraveTalkLogsViewController: UIViewController {

private var logsTextView = UITextView()

public override func viewDidLoad() {
super.viewDidLoad()

logsTextView.isEditable = false
view.addSubview(logsTextView)
logsTextView.snp.makeConstraints {
$0.edges.equalToSuperview()
}

logsTextView.text = getLogs()

let shareButton = UIBarButtonItem(barButtonSystemItem: .action, target: self, action: #selector(shareLogs))
navigationItem.rightBarButtonItem = shareButton
}

@objc private func shareLogs() {
do {
let fileURL = try createTemporaryLogFile()
let activityViewController = UIActivityViewController(activityItems: [fileURL], applicationActivities: nil)
present(activityViewController, animated: true)
} catch {
Logger.module.error("Error while creating the log file: \(error.localizedDescription, privacy: .public)")
}
}

private func createTemporaryLogFile() throws -> URL {
let logsString = getLogs()
let temporaryDirectoryURL = FileManager.default.temporaryDirectory
let logFileURL = temporaryDirectoryURL.appendingPathComponent("Logs.txt")

try logsString.write(to: logFileURL, atomically: true, encoding: .utf8)
return logFileURL
}

private func getLogs() -> String {
do {
let store = try OSLogStore(scope: .currentProcessIdentifier)

return try store
.getEntries()
.compactMap { $0 as? OSLogEntryLog }
.filter { $0.category == "BraveTalk" && $0.subsystem == Bundle.main.bundleIdentifier }
.map { "[\($0.date.formatted())] \($0.composedMessage)" }
.joined(separator: "\n")
} catch {
Logger.module.error("\(error.localizedDescription, privacy: .public)")
}

return ""
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -861,6 +861,11 @@ class SettingsViewController: TableViewController {
selection: { [unowned self] in
self.navigationController?.pushViewController(VPNLogsViewController(), animated: true)
}, accessory: .disclosureIndicator, cellClass: MultilineValue1Cell.self),
Row(
text: "Brave Talk Logs",
selection: { [unowned self] in
self.navigationController?.pushViewController(BraveTalkLogsViewController(), animated: true)
}, accessory: .disclosureIndicator, cellClass: MultilineValue1Cell.self),
Row(
text: "Retention Preferences Debug Menu",
selection: { [unowned self] in
Expand Down
6 changes: 5 additions & 1 deletion Sources/BraveTalk/BraveTalkJitsiCoordinator.swift
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@ import JitsiMeetSDK
return true
}

public init() {}
public init() {
if !AppConstants.buildChannel.isPublic {
JitsiMeetLogger.add(BraveTalkJitsiLogHandler())
kylehickinson marked this conversation as resolved.
Show resolved Hide resolved
}
}

public enum AppLifetimeEvent {
case didFinishLaunching(options: [UIApplication.LaunchOptionsKey: Any] = [:])
Expand Down
32 changes: 32 additions & 0 deletions Sources/BraveTalk/BraveTalkJitsiLogHandler.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
// Copyright 2024 The Brave Authors. All rights reserved.
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

import Foundation
import Shared
import JitsiMeetSDK
import os.log

class BraveTalkJitsiLogHandler: JitsiMeetBaseLogHandler {

override func logVerbose(_ msg: String!) {
Logger.module.debug("[verbose]: \(msg, privacy: .public)")
}

override func logDebug(_ msg: String!) {
Logger.module.debug("\(msg, privacy: .public)")
}

override func logInfo(_ msg: String!) {
Logger.module.info("\(msg, privacy: .public)")
}

override func logWarn(_ msg: String!) {
Logger.module.warning("\(msg, privacy: .public)")
}

override func logError(_ msg: String!) {
Logger.module.error("\(msg, privacy: .public)")
}
}