Allow custom log handling (2)

[benthillerkus]

This is just #830 but squashed & rebased to master and with most of the provided feedback addressed. I didn't rename setSendLogsToDart to setLogger yet though, because even if my name was pretty clunky it was at least accurate to what's happening.

[chipweinberger]

using setLogger instead of setSendLogsToDart is because it is the matching native code for the setLogger call.

When you ctrl-f the code base for setLogger, you'll see all the code you need to see.

[chipweinberger]

this pr looks much nicer.

[chipweinberger]

• "[FBP] [%@]" please keep it as "[FBP-iOS]", "[FBP-macOS]". no need to change the format.
• please keep case "setOptions": and case "setLogLevel": in the same order. I'm very used to this order and dont want it to change. maybe in some other PR.
• the readme explanation for setLogger is much too long. this is a simple, optional feature. It should be very short in the readme.
• FlutterBluePlus.setLogLevel(kDebugMode ? LogLevel.verbose : LogLevel.none); do not do this. Logs should always be on in the example app. It's important people file issues on github with logs
• also, do not setLogger in the example app. This hurts perf. It's not recommended to use it. The example app should show best practices.
• Logger does not need to be a typedef. unnecessary indirection. harder to read.
• don't define stdoutLogger. unnecessary. Just print by default if no logger is set.
• in dart code _logger should be renamed _log
• I'd probably rename "logger" to logHandler". i.e. setLogHandler

Just as a design philosophy, FBP uses very few abstractions. If you want to see why, look at flutter_reactive_ble, where everything is abstracted. FBP took the opposite approach.

i.e.

void _log(...) {
    if (_logger == null) {
        print(...)
    } else {
        _logger(...)
    }
}

e..g

Use a custom log handler

Optionally handle all FBP logs yourself. i.e. send them to disk, another logging framework, etc.

// Note: setting a custom logger can impact perf
// due to increased platform channel usage
FlutterBluePlus.setLogger((message) {
    // your custom log handling code
});

[chipweinberger]

closing. It should be a minimal implementation with minimal changes.

[benthillerkus]

I was gonna impl those changes, but I couldn't really find the time for it in the last 2 weeks

[chipweinberger]

no worries. If you get around to it, feel free to do it!

I do like the idea of the PR.

By habit, I close PRs & Issues that are not "active" for awhile, as people often drop off.

[chipweinberger]

I added this in 1.34.5

FlutterBluePlus.logs