Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Undo defaults values for onyx ids PureReportActionItem #55536

Conversation

kubabutkiewicz
Copy link
Contributor

@kubabutkiewicz kubabutkiewicz commented Jan 21, 2025

Explanation of Change

Fixed Issues

$ #55745
PROPOSAL:

Tests

  1. Login to app

  2. Go to some chat

  3. Send a message

  4. Open context menu

  5. Add emoji

  6. Open context menu

  7. Create a thread

  8. Open context menu

  9. Delete message

  10. Open context menu

  11. Edit message

  12. Login to app

  13. Go to some workspace chat

  14. Submit an manual expense

  15. Go again to some workspace chat

  16. Send a Distance expense

  17. Go again to workspace chat

  18. Send a scan

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."
Same as tests

  • 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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 ![image](https://github.com/user-attachments/assets/d27b6aa7-70f5-4a6c-90b1-8d84dc0d2bcb)
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari ![image](https://github.com/user-attachments/assets/6267edb9-7a8d-4378-ac82-54024e2eed5c)
MacOS: Desktop ![image](https://github.com/user-attachments/assets/8be91da0-0651-406d-bbf7-aeb05767b4ef)

Copy link
Contributor

@fabioh8010 fabioh8010 left a comment

Choose a reason for hiding this comment

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

You have some lint errors

src/components/ReportActionItem/TaskView.tsx Show resolved Hide resolved
@@ -109,26 +110,26 @@ function ReservationView({reservation}: ReservationViewProps) {
);
}

const renderItem = ({item}: {item: TripReservationUtils.ReservationData}) => <ReservationView reservation={item.reservation} />;
const renderItem = ({item}: {item: ReservationData}) => <ReservationView reservation={item.reservation} />;
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
const renderItem = ({item}: {item: ReservationData}) => <ReservationView reservation={item.reservation} />;
const renderItem = ({item}: ListRenderItemInfo<ReservationData>) => <ReservationView reservation={item.reservation} />;

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This doesnt look right
The type from FlatList looks like that
image
And when I am changing to whcih you suggested seems to be completely different shape so it will not work well

src/libs/actions/Report.ts Outdated Show resolved Hide resolved
src/libs/actions/Report.ts Outdated Show resolved Hide resolved
@@ -507,7 +555,7 @@ function PureReportActionItem({
const contextValue = useMemo(
() => ({
anchor: popoverAnchorRef.current,
report: {...report, reportID: report?.reportID ?? ''},
report: report?.reportID ? {...report, reportID: report?.reportID} : undefined,
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's make sure about this, looks like a dangerous change 👀

Copy link
Contributor Author

Choose a reason for hiding this comment

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

hmm actually shouldn't we just do report: {...report} ? since if there is a report there's also reportID right? there is no way that we have a report without reportID @fabioh8010

report: OnyxTypes.Report;
action: OnyxTypes.ReportAction;
};
contextValue: ShowContextMenuContextProps;
Copy link
Contributor

Choose a reason for hiding this comment

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

Why was this changed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Because of the change above https://github.com/Expensify/App/pull/55536/files/84d6eb5c1c2932b042ad1b3cde8ffbf5bd0d73ec#diff-a7f41a67ae98f78eb397d452128d1a83b5b142976e61efe2302e52853604cf3a

I also checked it passed just undefined to PureReportActionItem and worked fine will do couple more tests to make sure 100%

Copy link
Contributor

Choose a reason for hiding this comment

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

But can we not make this change? It looks like a regression magnet to me.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think we still should do it I trace how report is passed here and its always comes from Onyx so its possible that report here will be undefined as we removed defaults in PureReportActionItem so previous type was wrong

@kubabutkiewicz kubabutkiewicz changed the title Undo defaults values for onyx ids PureReportActionItem [No QA] Undo defaults values for onyx ids PureReportActionItem Jan 22, 2025
@kubabutkiewicz kubabutkiewicz marked this pull request as ready for review January 22, 2025 13:21
@kubabutkiewicz kubabutkiewicz requested a review from a team as a code owner January 22, 2025 13:21
@melvin-bot melvin-bot bot requested review from paultsimura and removed request for a team January 22, 2025 13:21
Copy link

melvin-bot bot commented Jan 22, 2025

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

@fabioh8010
Copy link
Contributor

@kubabutkiewicz Let's remove [No QA] label and add tests/screenshots to this PR

@kubabutkiewicz kubabutkiewicz changed the title [No QA] Undo defaults values for onyx ids PureReportActionItem Undo defaults values for onyx ids PureReportActionItem Jan 22, 2025
@paultsimura
Copy link
Contributor

@kubabutkiewicz please resolve conflicts 🙏

@@ -60,9 +60,9 @@ function MentionReportRenderer({style, tnode, TDefaultRenderer, ...defaultRender
const [reports] = useOnyx(ONYXKEYS.COLLECTION.REPORT);

const currentReportID = useCurrentReportID();
const currentReportIDValue = currentReportIDContext || currentReportID?.currentReportID;
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like this can be removed

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think we should leave it if currentReportIDContext would be '' the ?? operator wont work and will assign to currentReportIDValue '' but if we use || it will correctly assign currentReportID?.currentReportID. And by default in MentionReportContext currentReportID is ''

Copy link
Contributor

Choose a reason for hiding this comment

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

I meant the // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing only, because my linter didn't throw any warning with it removed.

Looks like it was just slow, let's keep it then.

src/components/ReportActionItem/MoneyRequestAction.tsx Outdated Show resolved Hide resolved
src/components/ReportActionItem/MoneyRequestAction.tsx Outdated Show resolved Hide resolved
src/libs/actions/Policy/Member.ts Outdated Show resolved Hide resolved
src/libs/actions/Policy/Member.ts Outdated Show resolved Hide resolved
@@ -1743,7 +1751,7 @@ function handleUserDeletedLinksInHtml(newCommentText: string, originalCommentMar
}

/** Saves a new message for a comment. Marks the comment as edited, which will be reflected in the UI. */
function editReportComment(reportID: string, originalReportAction: OnyxEntry<ReportAction>, textForNewComment: string, videoAttributeCache?: Record<string, string>) {
function editReportComment(reportID: string | undefined, originalReportAction: OnyxEntry<ReportAction>, textForNewComment: string, videoAttributeCache?: Record<string, string>) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Why not return early if !reportID here and in the functions below?

Copy link
Contributor Author

@kubabutkiewicz kubabutkiewicz Jan 23, 2025

Choose a reason for hiding this comment

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

When I do this the the TS will complain about this

const parameters: UpdateCommentParams = {
        reportID: originalReportID,
        reportComment: htmlForNewComment,
        reportActionID,
    };

as originalReportID is of type string | undefined and UpdateCommentParams expect reportID will be of type string but when I do this

if (!originalReportID || !originalReportAction) {
        return;
    }

everything looks good

src/libs/actions/Report.ts Outdated Show resolved Hide resolved
report: OnyxTypes.Report;
action: OnyxTypes.ReportAction;
};
contextValue: ShowContextMenuContextProps;
Copy link
Contributor

Choose a reason for hiding this comment

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

But can we not make this change? It looks like a regression magnet to me.

@kubabutkiewicz
Copy link
Contributor Author

Ok @paultsimura I think all comments are resolved/answered
about this #55536 (comment) I removed early returns and changed getRoute types to accept string | undefined and when we will navigate to route like r/undefined it will automatically handle showing NotFoundPage

@paultsimura
Copy link
Contributor

Thanks, giving it another 👀 soon!

src/libs/actions/Policy/Member.ts Outdated Show resolved Hide resolved
src/libs/actions/Policy/Member.ts Outdated Show resolved Hide resolved
@paultsimura
Copy link
Contributor

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 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.ts 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • 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.webm
Android: mWeb Chrome
Chrome.webm
iOS: Native
iOS: mWeb Safari
Simulator.Screen.Recording.-.iPhone.15.Pro.-.2025-01-24.at.13.38.40.mp4
MacOS: Chrome / Safari
Screen.Recording.2025-01-24.at.13.32.58.mov
MacOS: Desktop
Screen.Recording.2025-01-24.at.13.35.56.mov

@paultsimura
Copy link
Contributor

@kubabutkiewicz let's fix the conflicts one last time and we're g2g ✔️

@kubabutkiewicz
Copy link
Contributor Author

@paultsimura conflicts resolved

Copy link
Contributor

@paultsimura paultsimura left a comment

Choose a reason for hiding this comment

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

LGTM ✔️

@melvin-bot melvin-bot bot requested a review from neil-marcellini January 24, 2025 16:19
Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Thanks for all the hard work. I have some requests.

src/pages/home/report/ReportActionItemCreated.tsx Outdated Show resolved Hide resolved
src/pages/home/report/ReportActionItemMessage.tsx Outdated Show resolved Hide resolved
src/libs/actions/Report.ts Show resolved Hide resolved
src/libs/actions/Task.ts Show resolved Hide resolved
<MenuItemWithTopDescription
shouldRenderAsHTML
description={translate('task.description')}
title={report.description ?? ''}
onPress={() => Navigation.navigate(ROUTES.REPORT_DESCRIPTION.getRoute(report.reportID, Navigation.getReportRHPActiveRoute()))}
title={report?.description ?? ''}
Copy link
Contributor

Choose a reason for hiding this comment

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

This should not be defaulted

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Are we sure about that? the new rule is only for IDs

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah right good point

src/ROUTES.ts Outdated Show resolved Hide resolved
@kubabutkiewicz
Copy link
Contributor Author

@neil-marcellini I resolved comments from you, you can recheck!

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Good to go. Thanks for the updates.

@neil-marcellini neil-marcellini merged commit b4e662c into Expensify:main Jan 27, 2025
17 checks passed
@OSBotify
Copy link
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.

Copy link
Contributor

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 9.0.90-0 🚀

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

Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.90-6 🚀

platform result
🤖 android 🤖 true ❌
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 failure ❌
🍎🔄 iOS HybridApp 🍎🔄 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.

5 participants