Repository navigation
[HOLD for payment 2024-04-15] HIGH: [Reliability] Enable console logging with four-finger tap #38456
Description
Problem:
We've gotten very good at fixing bugs that can be reproduced in our dev environments. However, bugs we can't reproduce in dev are typically ignored -- even if they happen frequently in production. We have added better diagnostics tools via the About > Troubleshooting > Client side logging toggle. However, currently it takes you out of the context in which the bug is actually happening to enable. This means to use it you must:
- Experience the bug
- Leave that context to go to
About > Troubleshooting > Client side logging - Enable client side logging
- Go back to the original context
- Try to reproduce the bug
- Leave that context to go to
About > Troubleshooting > Client side logging - Open the console
- Save the file
- Disable client side logging
In that whole process, the logs are filled with tons and tons of extraneous lines, making it very hard to isolate the problem -- assuming you can even reproduce it.
Solution:
Margelo recently added a "four finger tap" to enable low-level performance logging:
This works great because:
- You can enable and disable right where you experiencing the problem, without needing to leave that context. This tightens up the focus on the actual problem period, avoiding extraneous sampling.
- It automatically saves the file to local storage when disabled.
Let's expand that as follows:
- Allow enabling/disabling the console log directly from the "four finger tap menu"
- Automatically save the logs to disk when disabled (in either the four-finger menu, or in the
About > Troubleshootingmenu) - Show the filename that it was saved to, along with the platform
Sharebutton to share it (this is already being used for the profile traces, so let's use it for logs as well)
Activity
quinthar commentedon Mar 17, 2024
@TMisiukiewicz hoping you can take this?
TMisiukiewicz commentedon Mar 18, 2024
@quinthar sure, I should be able to work on this later this week 👍
quinthar commentedon Mar 20, 2024
Great, so ETA Friday?
TMisiukiewicz commentedon Mar 20, 2024
@quinthar yeah, I am about to start working on that tomorrow 👍 What if the client side logging in Troubleshoot section is enabled while you access the hidden menu, should it be just enabled or both of these features should work independently?
TMisiukiewicz commentedon Mar 22, 2024
Opened a PR
quinthar commentedon Mar 23, 2024
They should both control the same console, so if it's enabled in one, it should show as enabled in the other.
[-]HIGH: Enable console logging with four-finger tap[/-][+]HIGH: [Reliability] Enable console logging with four-finger tap[/+]melvin-bot commentedon Mar 26, 2024
Triggered auto assignment to @amyevans, see https://stackoverflow.com/c/expensify/questions/7972 for more details.
s77rt commentedon Apr 4, 2024
@amyevans Can you please assign me here?
3 remaining items
[-]HIGH: [Reliability] Enable console logging with four-finger tap[/-][+][HOLD for payment 2024-04-15] HIGH: [Reliability] Enable console logging with four-finger tap[/+]melvin-bot commentedon Apr 8, 2024
Reviewinglabel has been removed, please complete the "BugZero Checklist".melvin-bot commentedon Apr 8, 2024
The solution for this issue has been 🚀 deployed to production 🚀 in version 1.4.60-13 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:
If no regressions arise, payment will be issued on 2024-04-15. 🎊
For reference, here are some details about the assignees on this issue:
melvin-bot commentedon Apr 8, 2024
BugZero Checklist: The PR adding this new feature has been merged! The following checklist (instructions) will need to be completed before the issue can be closed:
s77rt commentedon Apr 9, 2024
Regression Test Proposal
(Related https://expensify.testrail.io/index.php?/cases/view/2990265)
twisterdotcom commentedon Apr 15, 2024
Payment Summary: