Convenient & secure logging during development & release in Swift 3, 4 & 5

Not that this is actually bothering me as I much rather use the tail method in iTerm, but this is still a bug: as stated in the title, colors are not showing in the Xcode console. Instead I get the following:

[2015-12-16 10:25:20.787] AppDelegate.application(_:didFinishLaunchingWithOptions:):103 g0,0,255;DEBUG[;: something to debug [2015-12-16 10:25:20.790] AppDelegate.application(_:didFinishLaunchingWithOptions:):104 g0,255,0;INFO[;: a nice information [2015-12-16 10:25:20.791] AppDelegate.application(_:didFinishLaunchingWithOptions:):105 g255,255,0;WARNING[;: oh no, that won’t be good [2015-12-16 10:25:20.791] AppDelegate.application(_:didFinishLaunchingWithOptions:):106 g255,0,0;ERROR[;: ouch, an error did occur! [2015-12-16 10:25:20.792] AppDelegate.application(_:didFinishLaunchingWithOptions:):109 g200,200,200;VERBOSE[;: 123 [2015-12-16 10:25:20.792] AppDelegate.application(_:didFinishLaunchingWithOptions:):110 g0,255,0;INFO[;: -123.45678 [2015-12-16 10:25:20.792] AppDelegate.application(_:didFinishLaunchingWithOptions:):111 g255,255,0;WARNING[;: 2015-12-16 09:25:20 +0000 [2015-12-16 10:25:20.792] AppDelegate.application(_:didFinishLaunchingWithOptions:):112 g255,0,0;ERROR[;: ["I", "like", "logs!"] [2015-12-16 10:25:20.835] AppDelegate.application(_:didFinishLaunchingWithOptions:):113 g255,0,0;ERROR[;: ["address": "7 Beaver Lodge", "name": "Mr Beaver"]

OSX version: el Capitan XCode version: 7.2

And thanks for a wonderful tool that rocks my world!

First of, thanks for the amazing package 😄! Now, installing SwiftyBeaver using the Swift Package manager, as is shown within README fails when invoked through the command line. However, if the project is compiled from within Xcode everything works as expected.

The steps to reproduce this are fairly simple:

1. Use Xcode 12.1 (12A7403),
2. Create a new Swift App,
3. Add SwiftyBeaver using the Swift Package Manager,
4. Do the following in the @main - that's the only thing I changed in the whole code generated.

import SwiftUI
import SwiftyBeaver

let log = SwiftyBeaver.self
let console = ConsoleDestination()  // log to Xcode Console

@main
struct testpackageApp: App {
    let persistenceController = PersistenceController.shared

    var body: some Scene {
        WindowGroup {
            ContentView()
              .environment(\.managedObjectContext, persistenceController.container.viewContext).onAppear {
                log.addDestination(console)
                
                log.info("an example to show it has loaded")
              }
        }
    }
}

If I compile within Xcode IDE (even the use of the simulator) everything works as expected; should I go to the command line and type in the directory of the project xcodebuild then it fails with:

/Users/andylamp/Desktop/testpackage/testpackage/testpackageApp.swift:10:8: error: no such module 'SwiftyBeaver'
import SwiftyBeaver
       ^

** BUILD FAILED **

Removing SwiftyBeaver and adding another dependency seems to not generate the same issue (I tried with Alamofire).

Hope this helps to resolve the issue!

In response to @skreutzberger

Like any other tool, it is up to the developer to ensure that keys are securely stored inside an application or are downloaded from a trusted source during runtime. Also that all has nothing to do with GDPR. Changing the encryption to asymmetric does not make sense since the developer wants to decrypt the logs. There are many other logging frameworks out there in the market so feel free to pick one which fits you better.

I think you misunderstand how encryption works. Just like with HTTPS, asymmetric encryption does not prevent decrypting the logs by the developer. The developer would hold the private key and the app would have an embedded public key (or an API key which downloads the public key at runtime). This does relate to GDPR since SwiftyBeaver stores data on it's servers and advertises end-to-end encryption. The data stored by SwiftyBeaver has been breached since the private keys are not stored securely. It is akin to setting a password for your email account and then posting the password on Twitter. The email account is no longer secure if the password is publicly available. It is not the responsibility, nor could it be the expectation, of any developer using the SwiftyBeaver service to manually review the encryption algorithm used. It is SwiftyBeaver's responsibility to properly encrypt the data and ensure that no breaches occur (as one has).

In response to:

it is up to the developer to ensure that keys are securely stored inside an application or are downloaded from a trusted source during runtime

There is no possible way to securely download the key since the key is a symmetric key and used for every log. Any mechanism for providing the key to the client to send logs will inherently expose the key to that person to decrypt not just their own logs, but any logs encrypted with that key. The README demonstrates knowledge of this by stating:

On purpose we do not provide a web UI for you because it would require us to store your encryption key on our servers.

Only you can see the logging and device data which is sent from your users' devices. Our servers just see encrypted data and do not know your decryption key.

If it's insecure to store the key on your servers then certainly it is WILDLY INSECURE AND AN ABSOLUTE JOKE OF SECURITY to advertise the encryption key PUBLICLY for all to see in an app binary. This is willful negligence on the part of SwiftyBeaver and must be rectified immediately to avoid penalties under the GDPR which can result in fines up to 10M euros.

I want to have an interface and wrap swiftyBeaver behind the implementation, but when logging the filename and function name used are the once in the implementation class rather than the service logging. How can i make swiftyBeaver log the filename and function name of the service doing the logging?

Currently SwiftyBeaver supports Xcode Console & file as logging destinations.

What should be the next destination?

P.S.: Maybe the destinations should be renamed to beaver lodge - you know, where he brings the logs to :house:

I did have a quick look at the source code and it looks like you're using URLSessionDataTask POST, which is unfortunately broken in Swift foundation implementation https://lists.swift.org/pipermail/swift-corelibs-dev/Week-of-Mon-20160905/000926.html - It assigns an empty request body. It'll be reportedly fixed in Swift 3.1.

I had experienced the exact same bug and ended up using Vapor's HTTP module for networking instead https://github.com/petrpavlik/PusherNotificationsSwift.

@krzysztofzablocki has a new Xcode plugin for clickable filenames in logs krzysztofzablocki/KZLinkedConsole, and AppCode has that feature too. They use the format filename:line so it would be cool to collaborate and have a default format that has clickable links for those using them.

I'm using version 1.7.0 of SwiftyBeaver and have not changed versions or made any changes to my apps message formatting recently. Yet in my last release my user's started getting the following crash.

My message formatting string looks like this.

static func setup() {
        let console = ConsoleDestination()
        console.format = "$DHH:mm:ss.SSS$d $C$L$c $N.$F:$l - $M"
        LogUtils.logger.removeAllDestinations()
        LogUtils.logger.addDestination(console)
    }

Guys, is this possible? My app provides advanced access to the /Dcouments application folder, and Realm, for example, allows to choose which file name should be used. SwiftyBeaver uses file names without leading dot, so it will be visible for app's users.

What do you suggest to hide your files from user's eyes?

to avoid print() issues..

About half the time I am seeing ZERO output in my debugger for stuff going to the console.

I think there are issues with using Swift 'print' outside of the mainq.

This change just forces the ConsoleDestionation to use the mainq as it's queue.
This seems to have gotten rid of my 'where are my console logs' problem.

Also allows people to define their own custom queues for their own Destinations.

` private struct PKCS7 {

func add(bytes: [UInt8], blockSize: Int) -> [UInt8] {
    let padding = UInt8(blockSize - (bytes.count % blockSize))
    var withPadding = bytes
    if padding == 0 { 
        // If the original data is a multiple of N bytes, then an extra block of bytes with value N is added.
        for _ in 0..<blockSize {
            withPadding.append(contentsOf: [UInt8(blockSize)])
        }
    } else {
        // The value of each added byte is the number of bytes that are added
        for _ in 0..<padding {
            withPadding.append(contentsOf: [UInt8(padding)])
        }
    }
    return withPadding
}

`

padding will never be 0... therefore 'if padding == 0' will never be executed.

For zero-length input additional block will be added