Add Report Field Menu Items #33392

allroundexperts · 2023-12-21T05:25:48Z

Details

This PR adds custom report fields to the expense reports.

In order to test this, make sure that the reportFields beta is turned on from frontend.

Fixed Issues

$ #32762
PROPOSAL: N/A

Tests

Open any expense report.
Execute the following in console, replacing the policyID with the policyID of the policy the opened report is attached to:

Onyx.set('policyReportFields_47FB5109E0654E15', {
    text_title: {
        "defaultValue": "{report:type} #{report:reportID}",
        "fieldID": "text_title",
        "name": "Title",
        "orderWeight": 0,
        "type": "formula",

    },
    field_id_TEST: {
        "defaultValue": null,
        "fieldID": "field_id_TEST",
        "name": "Tax Code",
        "orderWeight": 1,
        "type": "text",
    },
    field_id_ANOTHER_ONE: {

        "defaultValue": "option A",
        "fieldID": "field_id_ANOTHER_ONE",
        "name": "Project",
        "orderWeight": 2,
        "type": "dropdown",
     	"values": ["option1", "option2", "option3"]
    },
    field_id_DATE_FIELD: {
        "defaultValue": "2023-11-19",
        "fieldID": "field_id_DATE_FIELD",
        "name": "Effective Date",
        "orderWeight": 3,
        "type": "date",
    }
})

Verify that the custom fields show up.
Verify that the fields are sorted correctly.
Verify that the fields show correct name & default values.

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Open any expense report.
Execute the following in console, replacing the policyID with the policyID of the policy the opened report is attached to:

Onyx.set('policyReportFields_47FB5109E0654E15', {
    text_title: {
        "defaultValue": "{report:type} #{report:reportID}",
        "fieldID": "text_title",
        "name": "Title",
        "orderWeight": 0,
        "type": "formula",

    },
    field_id_TEST: {
        "defaultValue": null,
        "fieldID": "field_id_TEST",
        "name": "Tax Code",
        "orderWeight": 1,
        "type": "text",
    },
    field_id_ANOTHER_ONE: {

        "defaultValue": "option A",
        "fieldID": "field_id_ANOTHER_ONE",
        "name": "Project",
        "orderWeight": 2,
        "type": "dropdown",
     	"values": ["option1", "option2", "option3"]
    },
    field_id_DATE_FIELD: {
        "defaultValue": "2023-11-19",
        "fieldID": "field_id_DATE_FIELD",
        "name": "Effective Date",
        "orderWeight": 3,
        "type": "date",
    }
})

Verify that the custom fields show up.
Verify that the fields are sorted correctly.
Verify that the fields show correct name & default values.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2023-12-21.at.9.53.43.AM.mov

MacOS: Desktop

melvin-bot · 2023-12-21T05:25:53Z

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

getusha · 2023-12-21T16:16:48Z

src/components/ReportActionItem/MoneyReportView.tsx

I am not sure if this intentional but there is a PR to migrate this to TS already #33255, not sure if it will conflict.

I actually copied it from there. It was required in order to create this PR. Will clean it up once that is merged!

getusha · 2023-12-21T16:19:43Z

src/libs/ReportUtils.ts

+        return value;
+    }
+
+    return value.replaceAll(/{report:([a-zA-Z]+)}/g, (match, property) => {


Lets add this regex here

App/src/CONST.ts

Line 1342 in 8970aa3

REGEX: {

and use it from there

getusha · 2023-12-25T12:25:08Z

@allroundexperts we have Lint failing and a conflict.

allroundexperts · 2024-01-04T15:27:53Z

Hi @getusha!

Can you please prioritise the review here?

getusha · 2024-01-04T16:32:20Z

BUG: opening split request crashes the app

Go to any workspace and split bill
Press on the request

Screen.Recording.2024-01-04.at.7.30.09.PM.mov

allroundexperts · 2024-01-05T07:14:55Z

BUG: opening split request crashes the app

@getusha Seems to work fine on my end.

Screen.Recording.2024-01-05.at.12.12.48.PM.mov

Can you please share a complete video?

getusha · 2024-01-05T20:40:02Z

@allroundexperts you have to click on it

Screen.Recording.2024-01-05.at.11.39.14.PM.mov

allroundexperts · 2024-01-05T21:28:18Z

@getusha Fixed!

getusha · 2024-01-05T21:32:14Z

Reviewer Checklist

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

getusha · 2024-01-05T21:49:34Z

@allroundexperts i took a policy id from the workspace onyx value and replaced it yet nothing happens, i think i am doing it wrong.

allroundexperts · 2024-01-07T19:44:56Z

@allroundexperts i took a policy id from the workspace onyx value and replaced it yet nothing happens, i think i am doing it wrong.

@getusha You don't have to take a random policy ID. Create an IOU report and get the policy id of that report.

allroundexperts · 2024-01-07T20:47:30Z

Also, you need to make sure that canUseReportFields beta is turned on in Permissions.ts file.

getusha · 2024-01-08T16:45:55Z

@allroundexperts am i doing anything wrong? please check this.

Screen.Recording.2024-01-08.at.7.41.29.PM.mov

allroundexperts · 2024-01-08T19:43:02Z

@allroundexperts am i doing anything wrong? please check this.

Screen.Recording.2024-01-08.at.7.41.29.PM.mov

@getusha You should look for the fields in the expense report. In the video, you have opened a single request of a expense report. Report fields are mean't for an expense report.

getusha · 2024-01-08T20:00:17Z

I see it now thanks! currently we can't change the values, is this something that's planned to implement later?

getusha · 2024-01-08T20:00:31Z

Lets also fix conflicts.

allroundexperts · 2024-01-08T20:10:17Z

I see it now thanks! currently we can't change the values, is this something that's planned to implement later?

Yep. It's part of an upcoming ticket.

melvin-bot · 2024-01-09T12:06:38Z

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

marcochavezf

LGTM! Just a minor change

marcochavezf · 2024-01-09T20:01:33Z

src/libs/ReportUtils.ts

@@ -4316,6 +4316,21 @@ function navigateToPrivateNotes(report: Report, session: Session) {
    Navigation.navigate(ROUTES.PRIVATE_NOTES_LIST.getRoute(report.reportID));
 }

+function getReportFieldTitle(report: OnyxEntry<Report>, reportField: PolicyReportField) {


Can we include a comment to explain the purpose and the expected output?

Thanks! Can we also add the return type?

I think the return type will be only string, right?

Yep. Added.

thienlnam · 2024-01-10T03:09:33Z

src/libs/ReportUtils.ts

+    return value.replaceAll(CONST.REGEX.REPORT_FIELD_TITLE, (match, property) => {
+        if (report && property in report) {
+            return report[property as keyof Report]?.toString() ?? match;
+        }
+        return match;
+    });
+}


We can test this out - but I'm not sure if we can generate the formula optimistically like this. Probably some fields but we'll need to get the current result from the backend

Are you suggesting that I should remove it?

We can test this out - but we will have to think about a better way to handle formula titles offline if they are required because there are some formula items that cannot be generated on the FE. Something to bring back into a slack discussion

marcochavezf

LGTM

OSBotify · 2024-01-15T19:10:04Z

✋ 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 · 2024-01-18T03:12:50Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.26-2 🚀

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

allroundexperts added 2 commits December 21, 2023 08:33

Merge branch 'main' into ts-migration-MoneyReportView

10a1fe3

feat: add report field menu items

8810934

allroundexperts requested a review from a team as a code owner December 21, 2023 05:25

melvin-bot bot requested review from getusha and removed request for a team December 21, 2023 05:25

allroundexperts mentioned this pull request Dec 21, 2023

[HOLD for payment 2024-01-25] Add reportField menu items in the Expense Report View #32762

Closed

getusha reviewed Dec 21, 2023

View reviewed changes

getusha suggested changes Dec 21, 2023

View reviewed changes

allroundexperts added 2 commits January 2, 2024 11:44

Merge branch 'main' into feat-32762

398dc7a

fix: lint issues

0b7592d

allroundexperts requested a review from getusha January 2, 2024 07:30

Merge branch 'main' into feat-32762

e50465e

fix: use policy report fields array

26b8460

fix: merge with main

ca98ca3

getusha approved these changes Jan 9, 2024

View reviewed changes

melvin-bot bot requested a review from marcochavezf January 9, 2024 12:35

marcochavezf requested changes Jan 9, 2024

View reviewed changes

thienlnam reviewed Jan 10, 2024

View reviewed changes

allroundexperts requested a review from marcochavezf January 10, 2024 19:34

allroundexperts added 2 commits January 11, 2024 00:36

add comment for getReportFieldTitle function

9375d64

feat: add report type to getReportFieldTitle fn

2327a35

marcochavezf approved these changes Jan 15, 2024

View reviewed changes

marcochavezf merged commit a459786 into Expensify:main Jan 15, 2024
16 checks passed

github-actions bot mentioned this pull request Jan 17, 2024

Deploy Checklist: New Expensify 2024-01-17 #34621

Closed

58 tasks

paultsimura mentioned this pull request Jan 17, 2024

Web - Title row in expense report is clickable but does not open any editor #34643

Closed

6 tasks

lanitochka17 mentioned this pull request Jan 17, 2024

[$500] Web - Response error when running code in console #34690

Closed

6 tasks

m-natarajan mentioned this pull request Apr 29, 2024

App crashes after pasting a bunch of text from a gdoc into the compose box and navigating to the bottom #41227

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Report Field Menu Items #33392

Add Report Field Menu Items #33392

allroundexperts commented Dec 21, 2023 •

edited

Loading

melvin-bot bot commented Dec 21, 2023

getusha Dec 21, 2023

allroundexperts Dec 21, 2023

getusha Dec 21, 2023

allroundexperts Jan 2, 2024

getusha commented Dec 25, 2023

allroundexperts commented Jan 4, 2024

getusha commented Jan 4, 2024

allroundexperts commented Jan 5, 2024

getusha commented Jan 5, 2024

allroundexperts commented Jan 5, 2024

getusha commented Jan 5, 2024 •

edited

Loading

getusha commented Jan 5, 2024

allroundexperts commented Jan 7, 2024

allroundexperts commented Jan 7, 2024 •

edited

Loading

getusha commented Jan 8, 2024

allroundexperts commented Jan 8, 2024

getusha commented Jan 8, 2024

getusha commented Jan 8, 2024

allroundexperts commented Jan 8, 2024

melvin-bot bot commented Jan 9, 2024

marcochavezf left a comment

marcochavezf Jan 9, 2024

allroundexperts Jan 10, 2024

marcochavezf Jan 11, 2024

marcochavezf Jan 12, 2024

allroundexperts Jan 14, 2024

thienlnam Jan 10, 2024

allroundexperts Jan 10, 2024

thienlnam Jan 11, 2024 •

edited

Loading

marcochavezf left a comment

OSBotify commented Jan 15, 2024

OSBotify commented Jan 18, 2024

Add Report Field Menu Items #33392

Add Report Field Menu Items #33392

Conversation

allroundexperts commented Dec 21, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 21, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

getusha commented Dec 25, 2023

allroundexperts commented Jan 4, 2024

getusha commented Jan 4, 2024

allroundexperts commented Jan 5, 2024

getusha commented Jan 5, 2024

allroundexperts commented Jan 5, 2024

getusha commented Jan 5, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

getusha commented Jan 5, 2024

allroundexperts commented Jan 7, 2024

allroundexperts commented Jan 7, 2024 • edited Loading

getusha commented Jan 8, 2024

allroundexperts commented Jan 8, 2024

getusha commented Jan 8, 2024

getusha commented Jan 8, 2024

allroundexperts commented Jan 8, 2024

melvin-bot bot commented Jan 9, 2024

marcochavezf left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thienlnam Jan 11, 2024 • edited Loading

Choose a reason for hiding this comment

marcochavezf left a comment

Choose a reason for hiding this comment

OSBotify commented Jan 15, 2024

OSBotify commented Jan 18, 2024

allroundexperts commented Dec 21, 2023 •

edited

Loading

getusha commented Jan 5, 2024 •

edited

Loading

allroundexperts commented Jan 7, 2024 •

edited

Loading

thienlnam Jan 11, 2024 •

edited

Loading