1183695 - Save sync logs on disk

Status: RESOLVED FIXED

(Firefox for iOS :: Sync, defect)

Description

[Richard Newman [:rnewman]]

The short-term part of Bug 1182350.

Comment 1

[Richard Newman [:rnewman]]

Steph, wanna steal this?

This'll be a little bit of XCGLogger rewiring as we start and end a sync in Profile.swift, flushing to a file in a directory.

Comment 2

[Stephan Leroux [:sleroux]]

Yup I can take this. Looks like XCGLogger already handles writing logs to disk so we can just add the file logger alongside the console logger and we should be good to go.

Comment 3

[Stephan Leroux [:sleroux]]

Do we want to write all console log messages to disk or are we only looking for logging performing in Profile.swift?

Comment 4

[Richard Newman [:rnewman]]

Everything in Sync, Storage, FxA, Profile.

Probably that means introducing two loggers -- one for browserish things, and one for storageish things.

Comment 5

[Richard Newman [:rnewman]]

An easy first step is to log everything to disk, of course :)

Comment 6

[Stephan Leroux [:sleroux]]

Attachment: PR https://github.com/mozilla/firefox-ios/pull/862

I've started with a generic app logger that will log everything to an app.log file for now.

Comment 7

[Richard Newman [:rnewman]]

Comment on attachment 8643226 [details] [review]
PR https://github.com/mozilla/firefox-ios/pull/862

Two comments on the PR.

Comment 8

[Mark Finkle (:mfinkle) (use needinfo?)]

Are we cleaning up the logs at some point?

Comment 9

[Richard Newman [:rnewman]]

See comment about log rolling. The current PR doesn't keep logs for longer than the last browser lifespan, so there's nothing to clean up.

Comment 10

[Stephan Leroux [:sleroux]]

Attachment: PR https://github.com/mozilla/firefox-ios/pull/862

Wrote patch to use rolling logger for sync logs and separate loggers for browser/keychain logging.

Comment 11

[Stephan Leroux [:sleroux]]

Still needs tests and adjustments

Comment 12

[Stephan Leroux [:sleroux]]

I've updated the PR to include the better way of getting folder size and nit fixes: https://github.com/mozilla/firefox-ios/commit/d456246a2b8a4a11ccbf82c4c35b79cf4c7ddef5

Comment 13

[Stephan Leroux [:sleroux]]

I've contacted Nikolai about the licensing and he's fine with licensing it under MPL2.0:

https://github.com/NikolaiRuhe/NRFoundation/issues/2

> Hi Stephan!
> I hereby grant you the right to use and redistribute my code from NRFileManager using MPL2.0.
> Is that OK for your purpose?
> Hope I could help :)

Comment 14

[Stephan Leroux [:sleroux]]

Comment on attachment 8644486 [details] [review]
PR https://github.com/mozilla/firefox-ios/pull/862

I've updated the NSFileManager license and added some tests for the RollingFileLogger class:

https://github.com/mozilla/firefox-ios/pull/862/files#diff-a5f77d1d36c08d00638614cfc3f5ed05R9

Comment 15

[Richard Newman [:rnewman]]

bafb839