[VO-258] feat: Allow to send logs my email after clicking on a deep link #1137
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Ldoppea
force-pushed
the
feat/send_logs
branch
from
d8aa81d
to
0858f0c
Compare
Ldoppea
changed the title
I think it may be needed before releasing.
Currently, GPS Memory messages are logged to a cozy-minilog logger AND to react-native-background-geolocation logger. So it should. In the next weeks, I will try to not send them to Sentry, but I want to keep them in the console for debugging purpose. |
|
Can't wait to see it in production. Will be very useful. |
Ldoppea
force-pushed
the
feat/send_logs
branch
from
0858f0c
to
f121a8b
Compare
|
I added a new commit to this PR: f121a8b This ones makes the feature "opt-in" and the user now needs to click a UL to enable login into files. Also I found a bug on iOS when the app is connected. If for some reason the splashscreen is hidden while the email pane is opened, then the splashscreen plugin will hide the email pane instead (because it blindly hides the topmost view) I'll have to find a workaround for this, either by showing an In theory the The sendLogFilesByEmail method shows a MFMAilComposeViewController and then resolves |
Ldoppea
force-pushed
the
feat/send_logs
branch
2 times, most recently
from
bbd0686
to
94c371e
Compare
|
This PR is ready for review, I fixed previous issue by patching react-native-file-logger package in 9157df2 |
Ldoppea
force-pushed
the
feat/send_logs
branch
2 times, most recently
from
2a561f2
to
ef264df
Compare
4 tasks
acezard
approved these changes
Feb 21, 2024
Ldoppea
force-pushed
the
feat/send_logs
branch
from
a73aa6c
to
f66f8e5
Compare
This package is needed by the following commits to ease debugging by allowing the user to send their app's log by email
By default `react-native-file-logger` will redirect all logs to a file
in the app's cache directory
Daily rolling is enabled and the max file size is 5 files (5 days) of
1MB
We want to decrease the log level to `Info` so all the app's logs are
redirected
Finally `${now} [${level}]` is added before all log in the resulting
file
In order to allow sending logs whatever if the app is logged or not, or even when the app is stuck on SplashScreen, the easiest way to trigger sending logs is to use deep links By implementing this, user can now click on `cozy://sendlogs` or `https://links.mycozy.cloud/flagship/sendlogs` links to trigger the OS send email intent pre-filled with log files and Cozy's support email This method is not the most user friendly but it has the advantage to be resilient to UI bugs We may want to find a more user friendly method in the future and keep this one for exceptional cases (or internal ones)
In previous commits we implemented a File logger that would intercept all console logs and write them in a file We want this feature to be opt-in in order to respect user's privacy The user can now click on `cozy://enableLogs` or `https://links.mycozy.cloud/flagship/enableLogs` links to activate the File logger interception They can also click on `cozy://disableLogs` or `https://links.mycozy.cloud/flagship/disableLogs` links to deactivate the File logger interception. This action also delete existing log files Also when the user clicks on the `sendLogs` link, an error message is now displayed if the logs are disabled
In the following commit we will need to wait for the iOS email to be sent Current `react-native-file-logger` implementation calls the iOS Mail composer and then directly calls the `resolve()` method Instead we want to wait for the email to be sent and then call `resolve()` from the `didFinishWithResult` method To make this possible we need to store a pointer to the `resolve` and the `reject` methods. This will allow us to call those pointers from the `didFinishWithResult` method
On iOS, the `FileLogger.sendLogFilesByEmail()` method shows the `MFMailComposeViewController` on top of the app UI Because we call this when receiving an Universal Link clicked outside of the app, this means that the Mail composer will be called when the app gets the focus back. The result is that the Mail composer may temporarily be displayed on top of the SplashScreen This is problematic due to the way `react-native-bootsplash` works on iOS When calling `hideSplashScreen` this module will try to hide the topmost UIViewController. This means that if the Mail composer is displayed on top of the SplashScreen, then `hideSplashScreen` will hide the Mail composer instead of the SplashScreen To prevent this we want to be sure that the SplashScreen won't be hidden until the Mail composer is closed. This can be done by displaying a named SplashScreen before calling `FileLogger.sendLogFilesByEmail()`, then the SplashScreen will be kept on screen even if `hideSplashScreen` is called for the lock screen or the global SplashScreen In the future we may want to also fix the `react-native-bootsplash` behaviour Note that this problem does not occur on Android because an external intent is called and also because the `react-native-bootsplash` implementation is more robust on this OS
Ldoppea
force-pushed
the
feat/send_logs
branch
from
f66f8e5
to
f2c5bcb
Compare
Ldoppea
added a commit
that referenced
this pull request
Feb 29, 2024
In #1137 we implemented a new File logger mechanism Unfortunately this has a side effect on react-native-background-geolocation which has a logger mechanism based on the same library and fails to work if we enable our new File logger A solution is investigated in BeTomorrow/react-native-file-logger#64 but until then we want to disable the feature so we can continue publishing the app Related PR: #1137 Related Issue: BeTomorrow/react-native-file-logger#64
Ldoppea
added a commit
that referenced
this pull request
Feb 29, 2024
In #1137 we implemented a new File logger mechanism Unfortunately this has a side effect on react-native-background-geolocation which has a logger mechanism based on the same library and fails to work if we enable our new File logger A solution is investigated in BeTomorrow/react-native-file-logger#64 but until then we want to disable the feature so we can continue publishing the app Related PR: #1137 Related Issue: BeTomorrow/react-native-file-logger#64
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In order to allow sending logs whatever if the app is logged or not, or even when the app is stuck on SplashScreen, the easiest way to trigger sending logs is to use deep links
By implementing this, user can now click on
cozy://enablelogsorhttps://links.mycozy.cloud/flagship/enablelogslinks to tell the app to start recording logs into a local fileThey can then click on
cozy://sendlogsorhttps://links.mycozy.cloud/flagship/sendlogslinks to trigger the OS send email intent pre-filled with log files and Cozy's support emailFinally then can click on
cozy://disablelogsorhttps://links.mycozy.cloud/flagship/disablelogslinks to tell the app to stop recording logsThis method is not the most user friendly but it has the advantage to be resilient to UI bugs
We may want to find a more user friendly method in the future and keep this one for exceptional cases (or internal ones)
This feature is based on the react-native-file-logger plugin, that does not need to be configured with cozy-minilog as it captures all console calls and redirect them to a file
By default
react-native-file-loggerwill redirect all logs to a file in the app's cache directoryDaily rolling is enabled and the max file size is 5 files of 1MB
We want to decrease the log level to
Infoso all the app's logs are redirectedFinally
${now} [${level}]is added before all log in the resulting fileTODO:
hideSplashscreen()calls to hide the email paneImprovement ideas: