feat: Add report field picker components by allroundexperts · Pull Request #34157 · Expensify/App

allroundexperts · 2024-01-09T15:46:55Z

Details

This PR adds report field picker components.

Note: Saving those fields is beyond the scope of this ticket. It will be handled in an upcoming ticket.

Fixed Issues

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",
    }
})

Enable canUseReportFields beta in Permissions.ts file.
Verify that the custom fields show up.
Click on each of the field.
Verify that correct value picker component shows up according to the designs below:

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",
    }
})

Enable canUseReportFields beta in Permissions.ts file.
Verify that the custom fields show up.
Click on each of the field.
Verify that correct value picker component shows up according to the designs below:

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-01-09.at.8.23.41.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-01-09.at.8.22.36.PM.mov

iOS: Native

Screen.Recording.2024-01-09.at.8.20.44.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-01-09.at.8.16.42.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-01-09.at.8.04.04.PM.mov

MacOS: Desktop

Screen.Recording.2024-01-09.at.8.07.09.PM.mov

melvin-bot · 2024-01-09T15:47:01Z

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

jjcoffee · 2024-01-10T16:09:03Z

@allroundexperts Are you able to resolve the failing TS checks?

jjcoffee · 2024-01-10T16:09:11Z

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-native-2024-01-22_16.08.27.mp4

Android: mWeb Chrome

android-chrome-2024-01-22_16.12.37.mp4

iOS: Native

ios-native-2024-01-22_15.41.13.mp4

iOS: mWeb Safari

ios-safari-2024-01-22_15.54.36.mp4

MacOS: Chrome / Safari

desktop-chrome-2024-01-22_15.56.04.mp4

MacOS: Desktop

desktop-app-2024-01-22_15.57.47.mp4

allroundexperts · 2024-01-10T20:06:51Z

@allroundexperts Are you able to resolve the failing TS checks?

@jjcoffee All done!

jjcoffee · 2024-01-12T13:39:12Z

@allroundexperts I get a bunch of these console warnings when opening the dropdown field:

allroundexperts · 2024-01-14T15:13:24Z

@allroundexperts I get a bunch of these console warnings when opening the dropdown field:

Fixed!

allroundexperts · 2024-01-15T19:14:46Z

Hi @jjcoffee!
Can you please review this with some priority?

Thanks!

jjcoffee · 2024-01-16T12:42:41Z

Sorry yes, on it now!

jjcoffee · 2024-01-16T13:03:11Z

@allroundexperts Shouldn't the defaultValue be selected in the dropdown? (I changed it from your example to option1 which exists in the list of options). The Recents section should also only be displayed if there are values.

allroundexperts · 2024-01-16T13:20:55Z

@allroundexperts Shouldn't the defaultValue be selected in the dropdown? (I changed it from your example to option1 which exists in the list of options). The Recents section should also only be displayed if there are values.

It should, I'll investigate why it isn't. But please continue your review and let me know if there's anything else that you find.

allroundexperts · 2024-01-16T20:28:21Z

Shouldn't the defaultValue be selected in the dropdown? (I changed it from your example to option1 which exists in the list of options). The Recents section should also only be displayed if there are values.

@jjcoffee Fixed.

jjcoffee · 2024-01-17T13:03:31Z

@allroundexperts I think it needs a new section for displaying (and highlighting) the selected item at the very top, per the mockup (see also the Category selector for money requests):

I'm also seeing that searching doesn't highlight the top result, which might be related.

Also, maybe you missed it but I mentioned that the Recent section also shouldn't show until there are values to show there. Or will that be added in the next PR?

allroundexperts · 2024-01-17T13:05:15Z

Also, maybe you missed it but I mentioned that the Recent section also shouldn't show until there are values to show there. Or will that be added in the next PR?

Recents would be handled in an upcoming PR. But, I'll look into the other issues.

allroundexperts · 2024-01-22T12:36:10Z

@jjcoffee I think we can take care of #34157 (comment) as a follow up. There are couple of PRs that are depending on this one so it would be good if we can merge this.

allroundexperts · 2024-01-22T12:36:30Z

Will you be able to complete the review today?

Co-authored-by: Joel Davies <joeld.dev@gmail.com>

jjcoffee

LGTM! The only outstanding issue is with the dropdown, which @allroundexperts has proposed to deal with in a follow up PR. The dropdown search should also highlight the topmost matching search result, I think (which is probably more or less the same fix).

melvin-bot · 2024-01-23T01:54:10Z

@thienlnam 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.

thienlnam · 2024-01-23T01:54:13Z

Perf tests known to be flakey

OSBotify · 2024-01-23T01:58:20Z

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

kavimuru · 2024-01-23T04:40:23Z

@allroundexperts could you help us with step 3:

Enable canUseReportFields beta in Permissions.ts file.

OSBotify · 2024-01-23T04:42:06Z

🚀 Deployed to staging by https://github.com/thienlnam in version: 1.4.30-0 🚀

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

thienlnam · 2024-01-23T07:23:43Z

@kavimuru All QA accounts should have all betas enabled I believe

OSBotify · 2024-01-24T07:33:39Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.30-1 🚀

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

OSBotify · 2024-01-24T07:43:29Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.30-1 🚀

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

allroundexperts · 2024-02-28T05:42:34Z

+        return [
+            {
+                title: translate('common.recents'),
+                shouldShow: true,


We should have shown this only if recent options were greater than 0. This later caused #35832

allroundexperts added 4 commits January 9, 2024 17:49

merge with main

fff6941

feat: add policy report picker fields

299df1e

fix: prettier

03c23a5

fix: key errors

74ea0d7

allroundexperts requested a review from a team as a code owner January 9, 2024 15:46

melvin-bot Bot requested review from jjcoffee and removed request for a team January 9, 2024 15:46

fix: revert canUseReportField beta

1341d40

allroundexperts mentioned this pull request Jan 9, 2024

[HOLD for payment 2024-01-31] Add report field picker component #32763

Closed

fix: lint issues

ca9ab3a

allroundexperts added 3 commits January 11, 2024 00:33

add comment for getReportFieldTitle function

ae92f62

fix: ts errors

1a2dc38

prettier

33ee5bd

allroundexperts added 2 commits January 14, 2024 19:57

Merge branch 'feat-32762' into feat-32763

b671b76

fix console error on dropdown field

399502d

Merge branch 'main' into feat-32763

2bd360f

fix: show checkmark on the selected option in the dropdown

048d69f

jjcoffee reviewed Jan 22, 2024

View reviewed changes

Comment thread src/pages/EditReportFieldDropdownPage.tsx Outdated

Update src/pages/EditReportFieldDropdownPage.tsx

cfa4cea

Co-authored-by: Joel Davies <joeld.dev@gmail.com>

jjcoffee approved these changes Jan 22, 2024

View reviewed changes

melvin-bot Bot requested a review from thienlnam January 22, 2024 15:26

thienlnam approved these changes Jan 23, 2024

View reviewed changes

thienlnam merged commit 616d75f into Expensify:main Jan 23, 2024

melvin-bot Bot added the Emergency label Jan 23, 2024

thienlnam removed the Emergency label Jan 23, 2024

github-actions Bot mentioned this pull request Jan 23, 2024

Deploy Checklist: New Expensify 2024-01-23 #34942

Closed

35 tasks

marcaaron mentioned this pull request Feb 5, 2024

[HOLD for payment 2024-04-15] [$500] Expense - Item in report list is not highlighted and list cannot be navigated with keyboard #35843

Closed

6 tasks

allroundexperts commented Feb 28, 2024

View reviewed changes

allroundexperts mentioned this pull request Feb 28, 2024

[HOLD for payment 2024-02-26] [$500] Expense - "Recent" and "All" appear in report field selection list when there is no result #35832

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

Uh oh!

Conversation

allroundexperts commented Jan 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Jan 9, 2024

Uh oh!

jjcoffee commented Jan 10, 2024

Uh oh!

jjcoffee commented Jan 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

allroundexperts commented Jan 10, 2024

Uh oh!

jjcoffee commented Jan 12, 2024

Uh oh!

allroundexperts commented Jan 14, 2024

Uh oh!

allroundexperts commented Jan 15, 2024

Uh oh!

jjcoffee commented Jan 16, 2024

Uh oh!

jjcoffee commented Jan 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

allroundexperts commented Jan 16, 2024

Uh oh!

allroundexperts commented Jan 16, 2024

Uh oh!

jjcoffee commented Jan 17, 2024

Uh oh!

allroundexperts commented Jan 17, 2024

Uh oh!

allroundexperts commented Jan 22, 2024

Uh oh!

allroundexperts commented Jan 22, 2024

Uh oh!

Uh oh!

jjcoffee left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot Bot commented Jan 23, 2024

Uh oh!

thienlnam commented Jan 23, 2024

Uh oh!

OSBotify commented Jan 23, 2024

Uh oh!

kavimuru commented Jan 23, 2024

Uh oh!

OSBotify commented Jan 23, 2024

Uh oh!

thienlnam commented Jan 23, 2024

Uh oh!

OSBotify commented Jan 24, 2024

Uh oh!

OSBotify commented Jan 24, 2024

Uh oh!

allroundexperts Feb 28, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

allroundexperts commented Jan 9, 2024 •

edited

Loading

jjcoffee commented Jan 10, 2024 •

edited

Loading

jjcoffee commented Jan 16, 2024 •

edited

Loading