Skip to content

[TS migration] Migrate 'Sidebar' page to TypeScript#36847

Merged
AndrewGable merged 39 commits into
Expensify:mainfrom
kubabutkiewicz:ts-migration/Sidebar
Mar 14, 2024
Merged

[TS migration] Migrate 'Sidebar' page to TypeScript#36847
AndrewGable merged 39 commits into
Expensify:mainfrom
kubabutkiewicz:ts-migration/Sidebar

Conversation

@kubabutkiewicz

@kubabutkiewicz kubabutkiewicz commented Feb 20, 2024

Copy link
Copy Markdown
Contributor

Details

Fixed Issues

$ #25220
PROPOSAL: N/A

Tests

  1. Login in app
  2. Click through items in Sidebar
  3. Verify that every report gets open
  4. Longpress on mobile or click with right mouse button on reports in Sidebar
  5. Verify that context menu gets open
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Login in app
  2. Click through items in Sidebar
  3. Verify that every report gets open
  4. Longpress on mobile or click with right mouse button on reports in Sidebar
  5. Verify that context menu gets open
  • 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 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 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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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.mp4
Android: mWeb Chrome
mchrome.mp4
iOS: Native
ios.mp4
iOS: mWeb Safari
msafari.14.30.19.mp4
MacOS: Chrome / Safari
web.mp4
MacOS: Desktop
desktop.mp4

Comment thread src/pages/home/sidebar/SidebarLinksData.tsx Outdated
Comment thread src/pages/home/sidebar/AvatarWithOptionalStatus.tsx Outdated
Comment thread src/pages/home/sidebar/AvatarWithOptionalStatus.tsx Outdated
Comment thread src/pages/home/sidebar/BottomTabBarFloatingActionButton/index.tsx
Comment thread src/pages/home/sidebar/SidebarLinks.tsx Outdated
Comment thread src/pages/home/sidebar/SidebarLinks.tsx Outdated
Comment thread src/components/LHNOptionsList/types.ts Outdated
},
}),
)(FloatingActionButtonAndPopoverWithRef);
const policySelector = (policy: OnyxEntry<OnyxTypes.Policy>) =>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add return type and reuse it

Comment thread src/pages/home/sidebar/SidebarScreen/FloatingActionButtonAndPopover.tsx Outdated
Comment thread src/pages/home/sidebar/SidebarScreen/FloatingActionButtonAndPopover.tsx Outdated
Comment thread src/pages/home/sidebar/SidebarScreen/FloatingActionButtonAndPopover.tsx Outdated
Comment thread src/libs/SidebarUtils.ts Outdated
Comment thread src/libs/SidebarUtils.ts Outdated
Comment thread src/pages/home/sidebar/SidebarLinksData.tsx Outdated
Comment thread src/pages/home/sidebar/SidebarLinksData.tsx Outdated
Comment thread src/libs/SidebarUtils.ts Outdated
Comment thread src/pages/home/sidebar/SidebarLinksData.tsx Outdated
Comment thread src/pages/home/sidebar/SidebarLinksData.tsx Outdated
const reportIDs = SidebarUtils.getOrderedReportIDs(
null,
chatReports,
chatReports as OnyxEntry<Record<string, OnyxTypes.Report>>,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, let's try at least 😅

chatReports: {
key: ONYXKEYS.COLLECTION.REPORT,
selector: chatReportSelector,
// This assertion is needed because the selector in withOnyx expects that the return type will be the same as type in ONYXKEYS but for collection keys the selector is executed for each collection item. This is a bug in withOnyx typings that we don't have a solution yet, when useOnyx hook is introduced it will be fixed.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There was a recent PR in onyx, maybe it resolved the issue here?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes @kubabutkiewicz The Onyx PR was merged and is available on main, let's remove the comments and apply that code I suggested to you

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will do that :)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@blazejkustra @fabioh8010 its adjusted , you can recheck

@paultsimura paultsimura left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM ✔️

Comment thread tests/utils/LHNTestUtils.tsx Outdated
bottom: 0,
}}
isSmallScreenWidth={false}
// @ts-expect-error - normally this comes from withCurrentReportID hoc , but here we are just mocking this

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// @ts-expect-error - normally this comes from withCurrentReportID hoc , but here we are just mocking this
// @ts-expect-error - normally this comes from withCurrentReportID hoc, but here we are just mocking this

@melvin-bot

melvin-bot Bot commented Mar 11, 2024

Copy link
Copy Markdown

We did not find an internal engineer to review this PR, trying to assign a random engineer to #25220 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

@melvin-bot
melvin-bot Bot requested a review from AndrewGable March 11, 2024 20:19
@AndrewGable

Copy link
Copy Markdown
Contributor

Conflicts

@AndrewGable

Copy link
Copy Markdown
Contributor

More conflicts

Comment thread src/libs/SidebarUtils.ts Outdated
@@ -127,13 +126,16 @@ function getOrderedReportIDs(
// However, this code needs to be very performant to handle thousands of reports, so in the interest of speed, we're just going to disable this lint rule and add
// the reportDisplayName property to the report object directly.
// eslint-disable-next-line no-param-reassign

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we remove this line?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bump on this question

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry I missed that we cant remove that because in this line we are reassigning the function parameter, if we want to do that we will need to refactor this function, but also there is a comment which is explaining why we are it was done

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The next line is if (report) {, right? Seems like two lines down we have the same disable?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah you are right this one is not needed it was a leftover after some debugging and didnt see that, thanks !

Comment thread src/pages/home/sidebar/SidebarScreen/FloatingActionButtonAndPopover.tsx Outdated
@AndrewGable
AndrewGable merged commit c4c8dd9 into Expensify:main Mar 14, 2024
@melvin-bot melvin-bot Bot added the Emergency label Mar 14, 2024
@melvin-bot

melvin-bot Bot commented Mar 14, 2024

Copy link
Copy Markdown

@AndrewGable looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@AndrewGable

Copy link
Copy Markdown
Contributor

🤔 - Tests were passing

@OSBotify

Copy link
Copy Markdown
Contributor

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

(reportActions &&
Object.values(reportActions).map((reportAction) => {
const {reportActionID, actionName, errors = [], originalMessage} = reportAction;
const decision = reportAction.message?.[0].moderationDecision?.decision;

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi team, I got this error when pulling the latest main. I tried to sign-out then sign-in couldn't solve the error. It's related to this line. Do you mind checking it? Thanks

Screenshot 2024-03-15 at 07 17 02

@kubabutkiewicz

Copy link
Copy Markdown
Contributor Author

@hoangzinh I will fix that, are there any steps to reproduce ?

@hoangzinh

Copy link
Copy Markdown
Contributor

@kubabutkiewicz I'm unsure, I just logged in App then App crashed. Maybe not all the reportAction have a message prop?

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/AndrewGable in version: 1.4.53-0 🚀

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

@AndrewGable

Copy link
Copy Markdown
Contributor

This was reverted because of the above error, can we try again?

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.4.53-2 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants