feat: add policyReportFields to the policy object directly #36553

allroundexperts · 2024-02-14T23:39:22Z

Details

This PR adds the policy report fields to the policy object itself instead of a separate policyFields_id object.

Fixed Issues

$ #36170
PROPOSAL: N/A

Tests

On a Paid workspace, in Old dot, set report fields of different types.
Open ND and create an expense report on the above workspace.
Open the expense report and make sure that canUseReportFields beta is enabled.
Verify that all the custom fields show up.
Click on each of the field.
Enter a value and save it.
Make sure that the field gets saved successfully.
For dropdown fields, verify that selecting an already selected dropdown option again deselects it.
For text fields, verify that removing the text from the input removes the field.

Verify that no errors appear in the JS console

Offline tests

Same as above. Verify that everything works in offline mode.

QA Steps

On a Paid workspace, in Old dot, set report fields of different types.
Open ND and create an expense report on the above workspace.
Open the expense report and make sure that canUseReportFields beta is enabled.
Verify that all the custom fields show up.
Click on each of the field.
Enter a value and save it.
Make sure that the field gets saved successfully.
For dropdown fields, verify that selecting an already selected dropdown option again deselects it.
For text fields, verify that removing the text from the input removes the field.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-03-20.at.5.50.33.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-03-20.at.5.49.51.PM.mov

iOS: Native

Screen.Recording.2024-03-20.at.5.48.23.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-03-20.at.5.46.56.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-03-20.at.5.42.37.PM.mov

MacOS: Desktop

Screen.Recording.2024-03-20.at.5.44.59.PM.mov

melvin-bot · 2024-03-20T13:13:15Z

@aimane-chnaif 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]

aimane-chnaif · 2024-03-20T13:14:53Z

@Expensify/contributor-plus anyone who first comment here please take over.

jjcoffee · 2024-03-20T13:17:32Z

I can!

jjcoffee · 2024-03-20T13:17:54Z

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

android-app-2024-03-20_16.14.21.mp4

Android: mWeb Chrome

android-chrome-2024-03-20_16.25.42.mp4

iOS: Native

ios-app-2024-03-20_15.51.30.mp4

iOS: mWeb Safari

ios-safari-2024-03-20_14.44.59.mp4

MacOS: Chrome / Safari

desktop-chrome-2024-03-20_15.46.57.mp4

MacOS: Desktop

desktop-app-2024-03-20_16.04.08.mp4

src/libs/ReportUtils.ts

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

jjcoffee · 2024-03-20T14:38:52Z

@allroundexperts I guess we don't support disabling dropdown options here yet? If I disable a bunch on OD it doesn't have any effect on ND.

jjcoffee · 2024-03-20T14:48:22Z

For text fields, verify that removing the text from the input removes the field.

@allroundexperts I guess this step is no longer relevant.

allroundexperts · 2024-03-20T14:50:12Z

@allroundexperts I guess we don't support disabling dropdown options here yet? If I disable a bunch on OD it doesn't have any effect on ND.

I don't remember adding it although @thienlnam can confirm.

jjcoffee · 2024-03-20T15:03:34Z

Just a note that the BE still doesn't seem to be sending pusher updates when fields are deleted in OD, so it requires signing out & back in for those changes to show.

jjcoffee · 2024-03-20T15:09:14Z

BUG: Fields that get added via pusher updates open to a not found page. Works after refresh.

chrome-pusher-2024-03-20_16.08.20.mp4

allroundexperts · 2024-03-20T15:15:17Z

@jjcoffee Can you please share the url you see at top when the not found page is seen?

allroundexperts · 2024-03-20T15:15:45Z

Looks to me like the pusher is sending back the fields without the expensify prefix.

jjcoffee · 2024-03-20T15:17:06Z

Looks to me like the pusher is sending back the fields without the expensify prefix.

@allroundexperts Bingo! /w/6D05DA21B79C2F3A/r/143260955149233/edit/policyField/6D05DA21B79C2F3A/field_id_TEST

jjcoffee · 2024-03-20T15:19:34Z

Ah actually it's the same URL that gets opened after refresh.

allroundexperts · 2024-03-20T15:22:00Z

Can you check what pusher sends back when you add a field?

jjcoffee · 2024-03-20T15:35:06Z

Looks like it only updates the fields on the policy, not the report.

"updates": [
    {
      "data": [
        {
          "key": "policy_6D05DA21B79C2F3A",
          "onyxMethod": "merge",
          "value": {
            "fieldList": {
              "field_id_TESTING_PUSHER": {
                "defaultExternalID": null,
                "defaultValue": null,
                "deletable": false,
                "disabledOptions": [],
                "externalID": null,
                "externalIDs": [],
                "fieldID": "field_id_TESTING_PUSHER",
                "isTax": false,
                "keys": [],
                "name": "Testing Pusher",
                "orderWeight": 4,
                "origin": null,
                "target": "expense",
                "type": "text",
                "value": null,
                "values": []
              }
            }
          }
        }
      ],
      "eventType": "onyxApiUpdate"
    }

allroundexperts · 2024-03-20T15:37:28Z

That's fine. The issue is that pusher is not appending expensify_ with the added field id. cc @thienlnam

jjcoffee · 2024-03-20T15:44:18Z

Ah yeah I see the policy has duplicate fields with/without the expensify prefix after refreshing.

jjcoffee

LGTM! There's just a BE fix required to the pusher updates (see this comment), but that doesn't need to block this PR.

thienlnam

Awesome - thanks for this!

OSBotify · 2024-03-20T19:13:58Z

✋ 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-03-22T16:19:18Z

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

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

OSBotify · 2024-03-27T04:48:27Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.56-8 🚀

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

aldo-expensify · 2024-04-11T19:30:40Z

src/pages/EditReportFieldPage.tsx

                fieldName={Str.UCFirst(reportField.name)}
                fieldValue={fieldValue}
-                fieldOptions={reportField.values}
+                fieldOptions={reportField.values.filter((value) => !(value in reportField.disabledOptions))}


This was not the right way to check if a value is in an array in javascript. It caused this deploy blocker: #38898

Ugh... I hate when this happens 😢. I was super sure that this won't happen again.

ahmedGaber93 · 2024-05-07T11:20:47Z

src/libs/ReportUtils.ts

+ * Get the key for a report field
+ */
+function getReportFieldKey(reportFieldId: string) {
+    return `expensify_${reportFieldId}`;


Adding expensify_ prefix to all fieldID cause a problem with the title fieldID text_title which shouldn't have this prefix, and we dealt with in #40464

aimane-chnaif · 2024-10-14T06:22:25Z

src/pages/EditReportFieldPage.tsx

                fieldName={Str.UCFirst(reportField.name)}
                fieldValue={fieldValue}
-                fieldOptions={reportField.values}
+                fieldOptions={reportField.values.filter((value) => !(value in reportField.disabledOptions))}


Here, we should have used policyField instead of reportField.
Issue: #48827

dukenv0307 · 2025-01-29T13:55:29Z

src/pages/EditReportFieldPage.tsx

        if (isReportFieldTitle) {
            ReportActions.updateReportName(report.reportID, value, report.reportName ?? '');
        } else {
-            ReportActions.updateReportField(report.reportID, {...reportField, value}, reportField);
+            ReportActions.updateReportField(report.reportID, {...reportField, value: value === '' ? null : value}, reportField);


We should check the value exist before updating the report field. Ref: #47067

add policyReportFields to the policy object directly

bb4ce47

allroundexperts mentioned this pull request Feb 14, 2024

[HOLD for payment 2024-04-03] [Report Fields] [Onyx] Move policyReportFields_ key back into the policy_ key #36170

Closed

allroundexperts added 8 commits February 15, 2024 04:47

fix: type errors

b84b0bf

merge with main

7e4ec5e

fix: ts errors

a40eef3

Merge branch 'main' into fix-36170

d59cc7f

rename report fields as field list

87fcc33

merge with main

17d96b6

use prefix for report fields

8a1164a

fix: lint errors

aa10737

bernhardoj mentioned this pull request Mar 13, 2024

Don't categorize when searching in report fields selection page #37583

Merged

50 tasks

hungvu193 mentioned this pull request Mar 14, 2024

"Not here" error message when opening report fields #38252

Closed

6 tasks

Ollyws mentioned this pull request Mar 14, 2024

Fix - Unable to unselect option in report field #37761

Closed

50 tasks

allroundexperts added 3 commits March 20, 2024 16:06

Merge branch 'main' into fix-36170

abc5bac

fix report fields

60eb052

remove un-needed changes

8ed7a10

allroundexperts marked this pull request as ready for review March 20, 2024 13:13

allroundexperts requested a review from a team as a code owner March 20, 2024 13:13

melvin-bot bot requested review from aimane-chnaif and removed request for a team March 20, 2024 13:13

jjcoffee reviewed Mar 20, 2024

View reviewed changes

src/libs/ReportUtils.ts Outdated Show resolved Hide resolved

allroundexperts and others added 2 commits March 20, 2024 19:20

Merge branch 'main' into fix-36170

d9f1a53

Update src/libs/ReportUtils.ts

1d8b72d

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

jjcoffee approved these changes Mar 20, 2024

View reviewed changes

melvin-bot bot requested a review from thienlnam March 20, 2024 15:45

allroundexperts added 2 commits March 20, 2024 23:42

Merge branch 'main' into fix-36170

d5e0198

merge fixes

fdac852

thienlnam approved these changes Mar 20, 2024

View reviewed changes

thienlnam merged commit 4891fe3 into Expensify:main Mar 20, 2024
15 checks passed

github-actions bot mentioned this pull request Mar 22, 2024

Deploy Checklist: New Expensify 2024-03-22 #38811

Closed

aldo-expensify reviewed Apr 11, 2024

View reviewed changes

aldo-expensify mentioned this pull request Apr 11, 2024

[$250] [HOLD for payment 2024-04-05] Workspace - One of the dropdown options configured in OD is missing from ND #38898

Closed

6 tasks

ahmedGaber93 reviewed May 7, 2024

View reviewed changes

ahmedGaber93 mentioned this pull request May 7, 2024

[HOLD for payment 2024-05-03] [$250] [Report fields] Hmm its not here page displayed when clicking on expense title #40464

Closed

6 tasks

aimane-chnaif reviewed Oct 14, 2024

View reviewed changes

aimane-chnaif mentioned this pull request Oct 15, 2024

Report fields and values don't get updated in Report if admin deletes them from workspace #48827

Closed

6 tasks

dukenv0307 reviewed Jan 29, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add policyReportFields to the policy object directly #36553

feat: add policyReportFields to the policy object directly #36553

allroundexperts commented Feb 14, 2024 •

edited

Loading

melvin-bot bot commented Mar 20, 2024

aimane-chnaif commented Mar 20, 2024

jjcoffee commented Mar 20, 2024

jjcoffee commented Mar 20, 2024 •

edited

Loading

jjcoffee commented Mar 20, 2024

jjcoffee commented Mar 20, 2024

allroundexperts commented Mar 20, 2024

jjcoffee commented Mar 20, 2024

jjcoffee commented Mar 20, 2024

allroundexperts commented Mar 20, 2024

allroundexperts commented Mar 20, 2024

jjcoffee commented Mar 20, 2024

jjcoffee commented Mar 20, 2024

allroundexperts commented Mar 20, 2024

jjcoffee commented Mar 20, 2024

allroundexperts commented Mar 20, 2024

jjcoffee commented Mar 20, 2024

jjcoffee left a comment

thienlnam left a comment

OSBotify commented Mar 20, 2024

OSBotify commented Mar 22, 2024

OSBotify commented Mar 27, 2024

aldo-expensify Apr 11, 2024

allroundexperts Apr 11, 2024

ahmedGaber93 May 7, 2024

aimane-chnaif Oct 14, 2024

dukenv0307 Jan 29, 2025

feat: add policyReportFields to the policy object directly #36553

feat: add policyReportFields to the policy object directly #36553

Conversation

allroundexperts commented Feb 14, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Mar 20, 2024

aimane-chnaif commented Mar 20, 2024

jjcoffee commented Mar 20, 2024

jjcoffee commented Mar 20, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

jjcoffee commented Mar 20, 2024

jjcoffee commented Mar 20, 2024

allroundexperts commented Mar 20, 2024

jjcoffee commented Mar 20, 2024

jjcoffee commented Mar 20, 2024

allroundexperts commented Mar 20, 2024

allroundexperts commented Mar 20, 2024

jjcoffee commented Mar 20, 2024

jjcoffee commented Mar 20, 2024

allroundexperts commented Mar 20, 2024

jjcoffee commented Mar 20, 2024

allroundexperts commented Mar 20, 2024

jjcoffee commented Mar 20, 2024

jjcoffee left a comment

Choose a reason for hiding this comment

thienlnam left a comment

Choose a reason for hiding this comment

OSBotify commented Mar 20, 2024

OSBotify commented Mar 22, 2024

OSBotify commented Mar 27, 2024

aldo-expensify Apr 11, 2024

Choose a reason for hiding this comment

allroundexperts Apr 11, 2024

Choose a reason for hiding this comment

ahmedGaber93 May 7, 2024

Choose a reason for hiding this comment

aimane-chnaif Oct 14, 2024

Choose a reason for hiding this comment

dukenv0307 Jan 29, 2025

Choose a reason for hiding this comment

allroundexperts commented Feb 14, 2024 •

edited

Loading

jjcoffee commented Mar 20, 2024 •

edited

Loading