feat: add `hmmm` log level to onyx #39076

kirillzyusko · 2024-03-27T15:55:37Z

Details

Added hmmm logger to Onyx.

Fixed Issues

$ Expensify/react-native-onyx#485 (comment)
PROPOSAL: N/A

Tests

N/A

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

N/A

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (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
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
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
I verified that if a function's arguments changed that all usages have also been updated correctly
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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-03-27T15:56:06Z

@lakchote 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]

lakchote · 2024-03-27T16:40:16Z

@kirillzyusko thanks for your PR

TSC checks are failing

kirillzyusko · 2024-03-27T17:13:40Z

@lakchote it's kind of expected, because this PR relies on Expensify/react-native-onyx#524

I think the correct action would be to merge PR in Onyx, then publish a new version, and then use a new version here and merge this PR. Am I right?

lakchote · 2024-03-28T08:38:20Z

@lakchote it's kind of expected, because this PR relies on Expensify/react-native-onyx#524

I think the correct action would be to merge PR in Onyx, then publish a new version, and then use a new version here and merge this PR. Am I right?

Exactly, that'd be the way to go 👍

kirillzyusko · 2024-03-28T11:10:11Z

@lakchote I bumped, but it looks like latest version of onyx contains a lot of breaking changes in TS (so typescript check stage will fail anyway).

@marcaaron Is it a known issue? 👀

marcaaron · 2024-03-29T20:53:59Z

Hmmm... not sure about the TS checks to be honest. Maybe we can ask in the Slack channel.

There was a problem with Onyx not automatically deploying a new package version. I believe it was resolved, but maybe that is related. @roryabraham I think we just need to bump to the latest, but use the commit from here:

Expensify/react-native-onyx#522 (comment)

marcaaron · 2024-03-29T20:59:08Z

Seems like after we merge: #38114

Then you can remove the Onyx bump.

cc @mountiny - we are bumping this coming from this PR too I think. So, lots of Onyx changes in one release. Don't lose your hat !!! 🤠

mountiny · 2024-03-29T21:19:13Z

Thank you for the bump! The process now is to do a full regression testing on web and some native platform by QA on any new onyx bump. Given we havent been able to bump in a while there is a backlog and we are adding 23 version here

Regression completed there and we need to resolve/ confirm if 3 issues are related to the onyx changes or not. Its looking promising but lets wait for that PR to make it to production in case we would need to make any revert/ hotfixes in Onyx.

Also noting that the TS errors been fixed on that PR, jest units still failing I think

marcaaron · 2024-04-01T17:33:17Z

src/Expensify.tsx

@@ -40,6 +40,8 @@ Onyx.registerLogger(({level, message}) => {
    if (level === 'alert') {
        Log.alert(message);
        console.error(message);
+    } else if (level === 'hmmm') {
+        Log.hmmm(message);


I think we can get this part merged now - it will start working once the version is bumped. Can you remove the package.json stuff?

@marcaaron I reverted but now it throws expected TS compilation problem, because level definition comes from onyx and current version from main doesn't have a new type hmmm yet 🤔

Ok, I see. Then let's update the type and then we can hold this one some more.

This PR is not too critical since the default is to do an info instead of hmm so we can just fix the types then come back and bump this one again.

marcaaron · 2024-04-29T23:29:28Z

What's the latest here? This looks ready to merge to me apart from the TS checks.

lakchote · 2024-04-30T07:17:17Z

What's the latest here? This looks ready to merge to me apart from the TS checks.

I'd like the TS checks to pass, you'd like to proceed without it?

kirillzyusko · 2024-04-30T07:57:03Z

@marcaaron @lakchote I fixed TS errors 👍 Would love to see it being merged 😊

lakchote · 2024-05-01T07:01:12Z

Thank you both @marcaaron @kirillzyusko for your involvement in this!

lakchote · 2024-05-01T07:01:21Z

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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

marcaaron · 2024-05-01T18:54:19Z

I'd like the TS checks to pass, you'd like to proceed without it?

LOL, no, but I can see the confusion there. Just asking for the status update 😄

And now we are ready for merge 😂

lakchote · 2024-05-02T06:16:28Z

I'd like the TS checks to pass, you'd like to proceed without it?

LOL, no, but I can see the confusion there. Just asking for the status update 😄

And now we are ready for merge 😂

Haha yes, I was confused 😄 Now that I've read it again it was clear. Good thing we've merged this one!

OSBotify · 2024-05-07T01:37:01Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.70-5 🚀

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

kirillzyusko requested a review from a team as a code owner March 27, 2024 15:55

kirillzyusko mentioned this pull request Mar 27, 2024

chore: log error additionally Expensify/react-native-onyx#524

Merged

42 tasks

melvin-bot bot requested review from lakchote and removed request for a team March 27, 2024 15:56

mountiny changed the title ~~feat: add hmmm log level to onyx~~ [HOLD App#38114] feat: add hmmm log level to onyx Mar 29, 2024

marcaaron reviewed Apr 1, 2024

View reviewed changes

marcaaron changed the title ~~[HOLD App#38114] feat: add hmmm log level to onyx~~ feat: add hmmm log level to onyx Apr 1, 2024

feat: add hmmm log level to onyx

8f08c43

kirillzyusko force-pushed the chore/hmmm-for-onyx branch from 7324440 to 8f08c43 Compare April 30, 2024 07:52

lakchote approved these changes May 1, 2024

View reviewed changes

marcaaron merged commit 33a1522 into Expensify:main May 1, 2024
15 checks passed

github-actions bot mentioned this pull request May 2, 2024

Deploy Checklist: New Expensify 2024-05-02 #41494

Closed

60 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add `hmmm` log level to onyx #39076

feat: add `hmmm` log level to onyx #39076

kirillzyusko commented Mar 27, 2024

melvin-bot bot commented Mar 27, 2024

lakchote commented Mar 27, 2024

kirillzyusko commented Mar 27, 2024

lakchote commented Mar 28, 2024

kirillzyusko commented Mar 28, 2024

marcaaron commented Mar 29, 2024

marcaaron commented Mar 29, 2024

mountiny commented Mar 29, 2024

marcaaron Apr 1, 2024

kirillzyusko Apr 2, 2024

marcaaron Apr 2, 2024

marcaaron commented Apr 29, 2024

lakchote commented Apr 30, 2024

kirillzyusko commented Apr 30, 2024

lakchote commented May 1, 2024

lakchote commented May 1, 2024 •

edited

Loading

marcaaron commented May 1, 2024

lakchote commented May 2, 2024

OSBotify commented May 7, 2024

feat: add hmmm log level to onyx #39076

feat: add hmmm log level to onyx #39076

Conversation

kirillzyusko commented Mar 27, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Mar 27, 2024

lakchote commented Mar 27, 2024

kirillzyusko commented Mar 27, 2024

lakchote commented Mar 28, 2024

kirillzyusko commented Mar 28, 2024

marcaaron commented Mar 29, 2024

marcaaron commented Mar 29, 2024

mountiny commented Mar 29, 2024

marcaaron Apr 1, 2024

Choose a reason for hiding this comment

kirillzyusko Apr 2, 2024

Choose a reason for hiding this comment

marcaaron Apr 2, 2024

Choose a reason for hiding this comment

marcaaron commented Apr 29, 2024

lakchote commented Apr 30, 2024

kirillzyusko commented Apr 30, 2024

lakchote commented May 1, 2024

lakchote commented May 1, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

marcaaron commented May 1, 2024

lakchote commented May 2, 2024

OSBotify commented May 7, 2024

feat: add `hmmm` log level to onyx #39076

feat: add `hmmm` log level to onyx #39076

lakchote commented May 1, 2024 •

edited

Loading