Disable logs for staging and production native apps by kidroca · Pull Request #30875 · Expensify/App

kidroca · 2023-11-03T19:40:51Z

Details

Enhanced logging to print environment and build details for better insights.
Removed the logic that disables console logging for production webpack builds.
Implemented logic to disable console logging for native production builds, excluding error and warn logs.
Simplified the configuration structure for webpack presets and plugins.

Fixed Issues

$ #30571
PROPOSAL: #30571 (comment)

Tests

For Mobile Native Apps (Android/iOS):

Setup:
- Start the local environment:
  - Android: npm run android
  - iOS: npm run ios
- Ensure DEV mode is activated:
  1. Access the dev menu by pressing D in the terminal running the metro server.
  2. Navigate to Settings in the dev menu and ensure "JS DEV Mode" is checked.
Observe Debug Logs:
- Conduct any action (e.g., opening a report). The terminal running the metro server should display extensive debug information.
Test Non-DEV Mode:
- Deactivate DEV mode and refresh the app by pressing r in the terminal running the metro server.
- In this state, the JS code is bundled for production and will not display logs. For instance, opening a report won't produce Onyx debug details.

For Web / mWeb / Desktop:

Local Environment Check:
- For verification:
  - Web: Run npm run web
  - Desktop: Run npm run desktop
- Access browser developer tools (typically F12).
- Open a report and verify that debug logs are appearing in the console.
Production Builds Check:
- Execute npm run build and review the generated output in the dist directory.
  1. Access dist/main-{hash}.js. Searching for console.debug should yield more than 30 matches.
- As an alternative, either:
  - Build and initiate the desktop app, OR
  - Launch a local server showcasing the production website. Examine the browser developer tools as described in the first point.

Backend check

Ensure logs are still being sent to the backend.

Monitor Network Activity:
- Watch the device's network activity for requests directed at: https://www.expensify.com/api?command=Log.
Backend Logs Verification (For Authorized Personnel):
- If you have access rights to the backend logs, verify the logs directly on the backend.

Offline tests

N/A: The changes are exclusive to the build process.

QA Steps

Examine any noticeable performance enhancements on iOS or Android platforms.

PR Author Checklist

Screenshots/Videos

Android: Native

Dev with debug logs

Prod no debug logs

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

kidroca · 2023-11-03T19:52:02Z

I've included these logs, because I've found out that when we're building the production web release, the environment output is development, which is why the webpack configuration above never used the env.production path

kidroca · 2023-11-03T19:59:19Z

The env.production path were never engaged for web builds. The reason being, NODE_ENV isn't defined before initiating the build process.

I'm omitting the 'transform-remove-console' plugin. Our intent is to retain console logs for web/desktop in production builds.

In essence, this modification aligns the dev and prod configurations, making them the same, hence the presented code change.

melvin-bot · 2023-11-03T20:02:12Z

@robertKozik Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

But do keep error and warn logs

…pack builds

kidroca · 2023-11-03T20:13:11Z

+    env: {
+        production: {
+            plugins: ['transform-remove-console', {exclude: ['error', 'warn']}],
+        },
+    },


I think we should preserve, the error and warn logs, because they aren't used frequently to impact the UX

That's why I've opted to keep them (exclude them from removal) here

ospfranco · 2023-11-03T20:25:57Z

How is the app reporting errors and crashes? Usually, the library of choice has a way to not completely disable logs but rather buffer them and choose a transport. By transport, you can then choose console output or Sentry or w/e.

kidroca · 2023-11-04T15:14:42Z

How is the app reporting errors and crashes? Usually, the library of choice has a way to not completely disable logs but rather buffer them and choose a transport. By transport, you can then choose console output or Sentry or w/e.

I believe the current setup uses Firebase Crashlytics to capture crashes and errors

As for log transport, Expensify employs its proprietary logging library that transmits logs to the backend. In this PR, our primary objective is to cease the echoing of these logs on the client device without affecting the backend transmission.

robertKozik · 2023-11-06T21:54:24Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

mountiny

Thanks for the changes

OSBotify · 2023-11-07T12:05:43Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-11-08T08:31:18Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.96-6 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2023-11-09T22:46:46Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.96-15 🚀

platform	result
🤖 android 🤖	failure ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2023-11-10T16:02:57Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.98-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

roryabraham · 2023-11-14T00:22:02Z

Asked about QA in slack

kidroca · 2023-11-14T08:10:56Z

Asked about QA in slack

This PR is focused on performance optimization and doesn't introduce new features or bug fixes. Therefore, it might not require the usual QA procedures. However, I suggest the following:

Standard Regression Testing: To ensure no existing functionalities are affected.
Performance Check: If possible, a comparison against staging/prod on mobile native platforms to observe any performance improvements.

I'm not familiar with the QA process, so if this approach isn't suitable or if performance gains aren't easily measurable, I understand that a standard QA might not be applicable here.

mountiny · 2023-11-14T12:53:08Z

The QA can be done in production too, we just need to check if there are no logs in server from the native apps.

mountiny · 2023-11-14T13:29:28Z

I think I have confirmed this works in staging, I did not log any push notifications received since this was deployed https://www.expensify.com/_devportal/tools/logSearch/#sort=asc&size=10000&query=blob%3A%22%5BPushNotification%5D%20push%20notification%20received%22%20AND%20email%3A%22vit%40expensify.com%22%20AND%20timestamp%3A%5B2023-11-09T00%3A00%20TO%202023-11-15T23%3A59%5D

OSBotify · 2023-11-14T21:56:24Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.98-5 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

kidroca commented Nov 3, 2023

View reviewed changes

kidroca marked this pull request as ready for review November 3, 2023 20:02

kidroca requested a review from a team as a code owner November 3, 2023 20:02

melvin-bot Bot requested review from robertKozik and removed request for a team November 3, 2023 20:02

kidroca added 3 commits November 3, 2023 22:04

babel.config - disable console logging on native prod builds

73beb39

But do keep error and warn logs

babel.config - don't try to disable console logging on production web…

7f6ef19

…pack builds

babel.config - print some env and build info for more insights

9579930

kidroca force-pushed the kidroca/chore/prod-no-console branch from 12c9100 to 9579930 Compare November 3, 2023 20:04

kidroca commented Nov 3, 2023

View reviewed changes

mountiny assigned kidroca Nov 5, 2023

mountiny added the InternalQA This pull request required internal QA label Nov 5, 2023

robertKozik approved these changes Nov 6, 2023

View reviewed changes

melvin-bot Bot requested a review from mountiny November 6, 2023 22:03

mountiny approved these changes Nov 7, 2023

View reviewed changes

mountiny merged commit af8999b into Expensify:main Nov 7, 2023

kidroca deleted the kidroca/chore/prod-no-console branch November 7, 2023 15:03

kidroca mentioned this pull request Nov 7, 2023

[No QA] Fix babel.config metro plugins syntax #31008

Merged

59 tasks

OSBotify mentioned this pull request Nov 8, 2023

Deploy Checklist: New Expensify 2023-11-06 #30929

Closed

OSBotify mentioned this pull request Nov 10, 2023

Deploy Checklist: New Expensify 2023-11-10 #31187

Closed

Conversation

kidroca commented Nov 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

For Mobile Native Apps (Android/iOS):

For Web / mWeb / Desktop:

Backend check

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Dev with debug logs

Prod no debug logs

Uh oh!

kidroca Nov 3, 2023

Choose a reason for hiding this comment

Uh oh!

kidroca Nov 3, 2023

Choose a reason for hiding this comment

Uh oh!

melvin-bot Bot commented Nov 3, 2023

Uh oh!

kidroca Nov 3, 2023

Choose a reason for hiding this comment

Uh oh!

ospfranco commented Nov 3, 2023

Uh oh!

kidroca commented Nov 4, 2023

Uh oh!

robertKozik commented Nov 6, 2023

Reviewer Checklist

Screenshots/Videos

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Nov 7, 2023

Uh oh!

OSBotify commented Nov 8, 2023

Uh oh!

OSBotify commented Nov 9, 2023

Uh oh!

OSBotify commented Nov 10, 2023

Uh oh!

roryabraham commented Nov 14, 2023

Uh oh!

kidroca commented Nov 14, 2023

Uh oh!

mountiny commented Nov 14, 2023

Uh oh!

mountiny commented Nov 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

OSBotify commented Nov 14, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

kidroca commented Nov 3, 2023 •

edited

Loading

mountiny commented Nov 14, 2023 •

edited

Loading