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

Fix: Hold reason not bold #39452

Merged
merged 10 commits into from
May 28, 2024
Merged

Fix: Hold reason not bold #39452

merged 10 commits into from
May 28, 2024

Conversation

dragnoir
Copy link
Contributor

@dragnoir dragnoir commented Apr 2, 2024

Details

This PR fixes the held requests reason that appears bolded briefly after holding the request.

Fixed Issues

$ #40408
PROPOSAL: #40408 (comment)

Tests

  1. Create an IOU in a chat
  2. Put it on hold
  3. Verify that the hold reason message is not in bold format.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Create an IOU in a chat
  2. Put it on hold
  3. Verify that the hold reason message is not in bold format.
  • 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
20240522_101140.mp4
Android: mWeb Chrome
20240522_091228.mp4
iOS: Native
20240522_091129.mp4
iOS: mWeb Safari
20240522_091029.mp4
MacOS: Chrome / Safari
20240522_090420.mp4
MacOS: Desktop
20240522_090555.mp4

@dragnoir dragnoir requested a review from a team as a code owner April 2, 2024 22:11
@melvin-bot melvin-bot bot requested review from hoangzinh and removed request for a team April 2, 2024 22:11
Copy link

melvin-bot bot commented Apr 2, 2024

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

@@ -5171,7 +5172,7 @@ function putOnHold(transactionID: string, comment: string, reportID: string) {
'HoldRequest',
{
transactionID,
comment,
parsedComment,
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
parsedComment,
comment: parsedComment,

@dragnoir have you checked if API calls success or failed with your change in this line?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed, thank you @hoangzinh

@hoangzinh
Copy link
Contributor

@dragnoir could you help to test again if it works on your end?

@dragnoir
Copy link
Contributor Author

dragnoir commented Apr 4, 2024

do you get an error with API?

@hoangzinh
Copy link
Contributor

ah nope, but looks like BE returns a plain text instead of markdown

@dragnoir
Copy link
Contributor Author

dragnoir commented Apr 4, 2024

Old unread messages will render as text, you need to create new hold messages with the updates on this PR.

@hoangzinh
Copy link
Contributor

@dragnoir I know. So did you mean you tested it again and it still works on your end? If yes could you share recording again on Web? Thanks

@dragnoir
Copy link
Contributor Author

dragnoir commented Apr 5, 2024

@hoangzinh something different from the backend was not happening when I created the PR.

The message displays as HTML for a bit then changes to normal text.

@hoangzinh
Copy link
Contributor

@dragnoir could you help to take a screenshot of API response? We might need help from @robertjchen to take a look at it again.

@dragnoir
Copy link
Contributor Author

dragnoir commented Apr 6, 2024

The HTML sent to Onyx is <em>italic</em> but the backend turn just italic

image

image

@hoangzinh
Copy link
Contributor

@robertjchen Moreover, the action name is reverted to "ADDCOMMENT" again. Could you please take a look at this when you have time? Thanks

@robertjchen
Copy link
Contributor

Hi all, as a quick update- we had to revert the action name back to ADDCOMMENT due to some backend design considerations, as it introduced some regressions.

Given this situation, let's update the frontend to use ADDCOMMENT as well- would that make things easier here? 🙏

@hoangzinh
Copy link
Contributor

We can for action name @robertjchen. Btw, how about the message payload? Base on comment here #39452 (comment), BE returns a plain text instead of HTML formatted.

@robertjchen
Copy link
Contributor

robertjchen commented Apr 8, 2024

The backend does not/cannot process or apply any styling to the message, only the frontend can do this 🤔

If markdown is used in the raw message sent to the backend, does it come back properly formatted (after frontend processing)?

@hoangzinh
Copy link
Contributor

hoangzinh commented Apr 8, 2024

If markdown is used in the raw message sent to the backend, does it come back properly formatted (after frontend processing)?

It doesn't but if FE sends a formatted message to BE, BE should return the same as well (at least for action name "ADDCOMMENT")

Screen.Recording.2024-04-08.at.17.45.53.mov

@dragnoir
Copy link
Contributor Author

@robertjchen what do you think?

@robertjchen
Copy link
Contributor

Hm, so that would seem like this would be a backend issue- the formatting is being stripped out before it is returned to the frontend?

@dragnoir
Copy link
Contributor Author

dragnoir commented Apr 15, 2024

@robertjchen We are sending from the front end a message like that
==> italic
but the backend turns a value like that:

message:{
  HTML: "italic",
  TEXT: "italic",
  TYPE: "comment"
}

if you can fix it so it turns:

message:{
  HTML: "<em>italic</em>",
  TEXT: "italic",
  TYPE: "comment"
}

And the actionName: should be HOLDCOMMENT not ADDCOMMENT

@robertjchen
Copy link
Contributor

but the backend turns a value like that:

Is the formatting being stripped on the frontend or backend? 🤔 The backend has no ability to restore any formatting so it would be good to determine where this is happening, as I'm not sure what should be changed on the backend at the moment.

And the actionName: should be HOLDCOMMENT not ADDCOMMENT

Due to some compatibility issues we are using ADDCOMMENT moving forward.

@dragnoir dragnoir reopened this Apr 18, 2024
@dragnoir
Copy link
Contributor Author

@robertjchen I updated the code based on your comment

Please check the video, same issue always.

20240418_131124.mp4

As you can see, when the function putOnHold send <em>lllllllooooo</em> with API.write
but the backend turn just lllllllooooo

image

@hoangzinh what do you think?

@hoangzinh
Copy link
Contributor

@dragnoir could you help to screenshot the request body? I think it would help @robertjchen debug on BE side

@dragnoir
Copy link
Contributor Author

@robertjchen here's the request body. The UI is sending <em>italic<em>

{
    "accountID": 15911514,
    "accounts": {
        "15911514": {
            "lastUpdateID": 263749108,
            "previousUpdateID": 263748720,
            "updateIDs": [
                263749106,
                263749107,
                263749108
            ]
        }
    },
    "authToken": "5D7E81CEC8C618AC09B8550DAFAEF8F4B1E0F12C78FEF305AD2731C58BAE89A2003A0C17A9963A78804FC2132C5E6F3E6DFDEA879CF82E4F3AB7E6742209E44540D5DF2EE21CA7F74B4374BE80E2966E51B0FF7FE3F8BAD98DF96F3CB9288344F48A7B88E74B02B6DE8C36A2A16D315B12C84176D82C769FC4A1B42D20A9D2AAF48DC83704949423A346C729D1FF0E8600762B132682CDEF53A81E59D71DAA196908614CE5F9BDAB4F41A9FF6ED776858141A3FB16B4F28D940B8D2C8384332BAD5B9E21BE80892AEB03096AAA48A6FCF3A76DF56691AC5F6243C3A9079FF7AA04193CC73A93289B3327C6E6CD497D42841ABCB4A3546B264D32003E7385428E581A116A3EE167173F2F8D262F676F110B60F3B15ECA8EF50411F4B4C7C5609162C3A846AD17DBB87D1CE9EFD85B5C8C18A5D57F231428A905D0C4717095DC5DE1DADE65D1B8D2CDC63618778F43AB9AF5E01D4B44EDF736A12539BB17EDFE99",
    "email": "mosaixel.org@gmail.com",
    "fetchableOnyxUpdates": [
        "263749106",
        "263749107",
        "263749108"
    ],
    "onyxUpdates": {
        "263749106": [
            {
                "key": "report_7461782389439403",
                "onyxMethod": "merge",
                "value": {
                    "lastActorAccountID": 15911514,
                    "lastMessageText": "",
                    "lastVisibleActionCreated": "2024-04-18 17:00:04.418",
                    "reportID": "7461782389439403"
                }
            },
            {
                "key": "reportActions_7461782389439403",
                "onyxMethod": "merge",
                "value": {
                    "5210771277106534177": {
                        "actionName": "HOLD",
                        "actorAccountID": 15911514,
                        "avatar": "https:\/\/d1wpcgnaa73g0y.cloudfront.net\/6bae9da33ba6673355d9368dcec5181cf5409cf7_128.jpeg",
                        "created": "2024-04-18 17:00:04.418",
                        "lastModified": "2024-04-18 17:00:04.418",
                        "message": [
                            {
                                "html": "",
                                "text": "",
                                "type": "COMMENT"
                            }
                        ],
                        "originalMessage": {
                            "accountID": 15911514,
                            "date": "2024-04-18 17:00:04",
                            "lastModified": "2024-04-18 17:00:04.418",
                            "message": "italic"
                        },
                        "person": [
                            {
                                "text": "Rachid L.",
                                "type": "TEXT"
                            }
                        ],
                        "previousReportActionID": "1859069962268695973",
                        "reportActionID": "5210771277106534177",
                        "shouldShow": true
                    }
                }
            }
        ],
        "263749107": [
            {
                "key": "report_7461782389439403",
                "onyxMethod": "merge",
                "value": {
                    "lastActorAccountID": 15911514,
                    "lastMessageText": "italic",
                    "lastVisibleActionCreated": "2024-04-18 17:00:04.419",
                    "reportID": "7461782389439403"
                }
            },
            {
                "key": "reportActions_7461782389439403",
                "onyxMethod": "merge",
                "shouldShowPushNotification": true,
                "value": {
                    "9174517809151477469": {
                        "actionName": "ADDCOMMENT",
                        "actorAccountID": 15911514,
                        "avatar": "https:\/\/d1wpcgnaa73g0y.cloudfront.net\/6bae9da33ba6673355d9368dcec5181cf5409cf7_128.jpeg",
                        "created": "2024-04-18 17:00:04.419",
                        "lastModified": "2024-04-18 17:00:04.419",
                        "message": [
                            {
                                "html": "italic",
                                "text": "italic",
                                "type": "COMMENT"
                            }
                        ],
                        "originalMessage": {
                            "html": "italic",
                            "lastModified": "2024-04-18 17:00:04.419"
                        },
                        "person": [
                            {
                                "text": "Rachid L.",
                                "type": "TEXT"
                            }
                        ],
                        "previousReportActionID": "5210771277106534177",
                        "reportActionID": "9174517809151477469",
                        "shouldShow": true
                    }
                }
            }
        ],
        "263749108": [
            {
                "key": "transactions_244319724081443296",
                "onyxMethod": "merge",
                "value": {
                    "comment": {
                        "hold": "5210771277106534177"
                    }
                }
            },
            {
                "key": "report_6646960247708600",
                "onyxMethod": "merge",
                "value": {
                    "avatarUrl": null,
                    "chatReportID": "6694510361629708",
                    "chatType": "",
                    "currency": "TND",
                    "description": "",
                    "fieldList": null,
                    "hasOutstandingChildRequest": false,
                    "hasParentAccess": true,
                    "invoiceReceiver": null,
                    "iouReportID": null,
                    "isCancelledIOU": false,
                    "isDeletedParentAction": null,
                    "isOwnPolicyExpenseChat": false,
                    "isPinned": false,
                    "isWaitingOnBankAccount": false,
                    "lastActionType": "IOU",
                    "lastActorAccountID": "15911514",
                    "lastMentionedTime": null,
                    "lastMessageHtml": "",
                    "lastMessageText": "",
                    "lastReadSequenceNumber": 0,
                    "lastReadTime": "2024-04-15 11:47:39.413",
                    "lastVisibleActionCreated": "2024-04-15 11:47:31.452",
                    "lastVisibleActionLastModified": "2024-04-15 11:47:31.452",
                    "managerID": 15911514,
                    "nonReimbursableTotal": 0,
                    "notificationPreference": "always",
                    "oldPolicyName": "",
                    "ownerAccountID": 15911514,
                    "parentReportActionID": "8363121392860620561",
                    "parentReportID": "6694510361629708",
                    "participantAccountIDs": [
                        15911514
                    ],
                    "participants": {
                        "15911514": {
                            "hidden": false
                        }
                    },
                    "policyAvatar": null,
                    "policyID": "2E2EED6C353ED0E9",
                    "policyName": null,
                    "reportID": "6646960247708600",
                    "reportName": "Expense Report #6646960247708600",
                    "stateNum": 1,
                    "statusNum": 1,
                    "submitterPayPalMeAddress": "",
                    "total": -4958,
                    "type": "expense",
                    "unheldTotal": -1552,
                    "visibility": null,
                    "visibleChatMemberAccountIDs": [
                        15911514
                    ],
                    "welcomeMessage": "",
                    "writeCapability": "all"
                }
            }
        ]
    },
    "httpCode": 200,
    "jsonCode": 200,
    "authResponseMessage": "200 OK",
    "requestID": "8766357e989a41b9-MRS",
    "onyxData": [
        {
            "key": "report_7461782389439403",
            "onyxMethod": "merge",
            "value": {
                "lastActorAccountID": 15911514,
                "lastMessageText": "",
                "lastVisibleActionCreated": "2024-04-18 17:00:04.418",
                "reportID": "7461782389439403"
            }
        },
        {
            "key": "reportActions_7461782389439403",
            "onyxMethod": "merge",
            "value": {
                "5210771277106534177": {
                    "actionName": "HOLD",
                    "actorAccountID": 15911514,
                    "avatar": "https:\/\/d1wpcgnaa73g0y.cloudfront.net\/6bae9da33ba6673355d9368dcec5181cf5409cf7_128.jpeg",
                    "created": "2024-04-18 17:00:04.418",
                    "lastModified": "2024-04-18 17:00:04.418",
                    "message": [
                        {
                            "html": "",
                            "text": "",
                            "type": "COMMENT"
                        }
                    ],
                    "originalMessage": {
                        "accountID": 15911514,
                        "date": "2024-04-18 17:00:04",
                        "lastModified": "2024-04-18 17:00:04.418",
                        "message": "italic"
                    },
                    "person": [
                        {
                            "text": "Rachid L.",
                            "type": "TEXT"
                        }
                    ],
                    "previousReportActionID": "1859069962268695973",
                    "reportActionID": "5210771277106534177",
                    "shouldShow": true
                }
            }
        },
        {
            "key": "report_7461782389439403",
            "onyxMethod": "merge",
            "value": {
                "lastActorAccountID": 15911514,
                "lastMessageText": "italic",
                "lastVisibleActionCreated": "2024-04-18 17:00:04.419",
                "reportID": "7461782389439403"
            }
        },
        {
            "key": "reportActions_7461782389439403",
            "onyxMethod": "merge",
            "shouldShowPushNotification": true,
            "value": {
                "9174517809151477469": {
                    "actionName": "ADDCOMMENT",
                    "actorAccountID": 15911514,
                    "avatar": "https:\/\/d1wpcgnaa73g0y.cloudfront.net\/6bae9da33ba6673355d9368dcec5181cf5409cf7_128.jpeg",
                    "created": "2024-04-18 17:00:04.419",
                    "lastModified": "2024-04-18 17:00:04.419",
                    "message": [
                        {
                            "html": "italic",
                            "text": "italic",
                            "type": "COMMENT"
                        }
                    ],
                    "originalMessage": {
                        "html": "italic",
                        "lastModified": "2024-04-18 17:00:04.419"
                    },
                    "person": [
                        {
                            "text": "Rachid L.",
                            "type": "TEXT"
                        }
                    ],
                    "previousReportActionID": "5210771277106534177",
                    "reportActionID": "9174517809151477469",
                    "shouldShow": true
                }
            }
        },
        {
            "key": "transactions_244319724081443296",
            "onyxMethod": "merge",
            "value": {
                "comment": {
                    "hold": "5210771277106534177"
                }
            }
        },
        {
            "key": "report_6646960247708600",
            "onyxMethod": "merge",
            "value": {
                "avatarUrl": null,
                "chatReportID": "6694510361629708",
                "chatType": "",
                "currency": "TND",
                "description": "",
                "fieldList": null,
                "hasOutstandingChildRequest": false,
                "hasParentAccess": true,
                "invoiceReceiver": null,
                "iouReportID": null,
                "isCancelledIOU": false,
                "isDeletedParentAction": null,
                "isOwnPolicyExpenseChat": false,
                "isPinned": false,
                "isWaitingOnBankAccount": false,
                "lastActionType": "IOU",
                "lastActorAccountID": "15911514",
                "lastMentionedTime": null,
                "lastMessageHtml": "",
                "lastMessageText": "",
                "lastReadSequenceNumber": 0,
                "lastReadTime": "2024-04-15 11:47:39.413",
                "lastVisibleActionCreated": "2024-04-15 11:47:31.452",
                "lastVisibleActionLastModified": "2024-04-15 11:47:31.452",
                "managerID": 15911514,
                "nonReimbursableTotal": 0,
                "notificationPreference": "always",
                "oldPolicyName": "",
                "ownerAccountID": 15911514,
                "parentReportActionID": "8363121392860620561",
                "parentReportID": "6694510361629708",
                "participantAccountIDs": [
                    15911514
                ],
                "participants": {
                    "15911514": {
                        "hidden": false
                    }
                },
                "policyAvatar": null,
                "policyID": "2E2EED6C353ED0E9",
                "policyName": null,
                "reportID": "6646960247708600",
                "reportName": "Expense Report #6646960247708600",
                "stateNum": 1,
                "statusNum": 1,
                "submitterPayPalMeAddress": "",
                "total": -4958,
                "type": "expense",
                "unheldTotal": -1552,
                "visibility": null,
                "visibleChatMemberAccountIDs": [
                    15911514
                ],
                "welcomeMessage": "",
                "writeCapability": "all"
            }
        }
    ],
    "previousUpdateID": 263748720,
    "lastUpdateID": 263749108
}

@hoangzinh
Copy link
Contributor

@dragnoir I think above comment is a response body not request body. 🤔

@hoangzinh
Copy link
Contributor

@dragnoir please let me know when the PR to fix bold style is ready for review

@dragnoir
Copy link
Contributor Author

@hoangzinh bold style fixed and removed the HTML rendering

@dragnoir dragnoir changed the title Fix: Hold comment render as HTML Fix: Hold reason not bold May 21, 2024
@dragnoir dragnoir requested a review from hoangzinh May 22, 2024 09:12
src/pages/home/report/ReportActionItemMessage.tsx Outdated Show resolved Hide resolved
src/libs/ReportUtils.ts Outdated Show resolved Hide resolved
@dragnoir dragnoir requested a review from hoangzinh May 23, 2024 10:12
@@ -4503,7 +4503,7 @@ function buildOptimisticHoldReportActionComment(comment: string, created = DateU
actorAccountID: currentUserAccountID,
message: [
{
type: CONST.REPORT.MESSAGE.TYPE.TEXT,
type: CONST.REPORT.MESSAGE.TYPE.COMMENT,
style: 'normal',
Copy link
Contributor

Choose a reason for hiding this comment

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

Usually type COMMENT will have
{
type:
text:
html:
}

For example

App/src/libs/ReportUtils.ts

Lines 4101 to 4104 in aa9bbcf

html: message,
text: message,
isEdited: false,
type: CONST.REPORT.MESSAGE.TYPE.COMMENT,

Can you remove style and add html prop here? Thanks

@trjExpensify
Copy link
Contributor

@dragnoir can you address that small comment and then we can have this reviewed by the internal team. Thanks!

@dragnoir dragnoir requested a review from hoangzinh May 27, 2024 09:00
@hoangzinh
Copy link
Contributor

hoangzinh commented May 27, 2024

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
Screen.Recording.2024-05-27.at.23.32.00.android.mov
Android: mWeb Chrome
Screen.Recording.2024-05-27.at.20.31.44.android.chrome.mov
iOS: Native
Screen.Recording.2024-05-27.at.22.40.49.ios.mov
iOS: mWeb Safari
Screen.Recording.2024-05-27.at.22.38.47.ios.safari.mov
MacOS: Chrome / Safari
Screen.Recording.2024-05-27.at.20.05.56.web.mov
MacOS: Desktop
Screen.Recording.2024-05-27.at.20.12.45.desktop.mov

@hoangzinh
Copy link
Contributor

@dragnoir overall looks good. Could you help to update Test steps to reflect what we are testing in this PR? (hold reason is not bold). Thanks

@dragnoir
Copy link
Contributor Author

@dragnoir overall looks good. Could you help to update Test steps to reflect what we are testing in this PR? (hold reason is not bold). Thanks

done. Thank you

@melvin-bot melvin-bot bot requested a review from techievivek May 27, 2024 16:36
@robertjchen robertjchen removed the request for review from techievivek May 28, 2024 03:21
@robertjchen robertjchen merged commit fe1e16a into Expensify:main May 28, 2024
16 of 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.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/robertjchen in version: 1.4.77-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.77-11 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.77-11 🚀

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.

7 participants