Implement the policy report field edit flow #44730

rezkiy37 · 2024-07-02T13:06:41Z

Details

The PR introduces a new flow to edit a report field.

Fixed Issues

$ #43685
PROPOSAL: N/A

Tests

Note: the feature works only on the staging server for now.
Note: the feature is under the beta (reportFieldsFeature).

Text type

Create a text-type report field.
Click on the newly added row.
Edit the initial value.
Click on "Save".
Verify that the report field has been updated correctly.

Date type

The user cannot edit this type of report field.

List type

Create a list-type report field.
Click on the newly added row.
Edit the initial value when list values are added.
Verify that the report field has been updated correctly.
Click on "List values".
The user can enable, disable, rename, and delete a list value.
Verify that all these scenarios work properly.
Verify that the initial value contains only existing and enabled list values.

Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android.mp4

Android: mWeb Chrome

Chrome.mp4

iOS: Native

IOS.mp4

iOS: mWeb Safari

IOS.Safari.mp4

MacOS: Chrome / Safari

Chrome.mp4

MacOS: Desktop

Desktop.mp4

melvin-bot · 2024-07-02T13:06:45Z

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

…ture/43685-report-fields-edit-flow

…/github.com/rezkiy37/Expensify into feature/43685-report-fields-edit-flow

…ture/43685-report-fields-edit-flow

melvin-bot · 2024-07-08T12:30:26Z

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

mountiny · 2024-07-08T19:44:11Z

@rushatgabhane can you prioritize this one please?

rushatgabhane · 2024-07-09T03:48: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 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-07-09.at.06.56.10.mov

Android: mWeb Chrome

iOS: Native

Screen.Recording.2024-07-09.at.06.55.49.mov

iOS: mWeb Safari

Screen.Recording.2024-07-09.at.06.51.46.mov

MacOS: Chrome / Safari

MacOS: Desktop

rushatgabhane

Code LGTM and tests well

src/libs/API/parameters/CreateWorkspaceReportFieldListValueParams.ts

mountiny

Couple of NABs

src/libs/actions/Policy/ReportField.ts

mountiny

Thanks

OSBotify · 2024-07-09T16:25:23Z

✋ 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-07-10T11:20:14Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.6-0 🚀

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

OSBotify · 2024-07-10T11:37:28Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.6-0 🚀

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

OSBotify · 2024-07-11T10:17:43Z

🚀 Cherry-picked to staging by https://github.com/Julesssss in version: 9.0.6-1 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2024-07-11T10:37:19Z

🚀 Cherry-picked to staging by https://github.com/Julesssss in version: 9.0.6-1 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2024-07-15T20:24:32Z

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.6-8 🚀

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

OSBotify · 2024-07-17T00:19:58Z

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.7-8 🚀

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

rezkiy37 added 6 commits July 2, 2024 15:04

create bare NamePage

56b504f

create bare TypePage

e943bf6

create bare InitialValuePage

dd40132

create EditReportFieldPage

af0cec5

connect screens to navigation

cddeaf9

create bare setters

7631cca

rezkiy37 added 23 commits July 2, 2024 17:31

remove name and type editing pages

143964f

use reportFieldID

ce74ea8

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fea…

56a31ea

…ture/43685-report-fields-edit-flow

Merge branch 'feature/43684-report-fields-creating-flow-4' of https:/…

71a92cd

…/github.com/rezkiy37/Expensify into feature/43685-report-fields-edit-flow

restrict initial value fore date type

7c95c6d

create InitialListValuePicker

ab2b1b0

add route to type

1d60889

convert ReportFieldsInitialListValuePicker as a input picker

861bd0c

integrate InitialValuePage

cd47a6e

integrate initial value state

75dc491

improve initial value form submitting

9c96dce

connect reportField values of policy

694414a

integrate values based on props

44eaf49

Merge branch 'feature/43684-report-fields-creating-flow-4' of https:/…

3500726

…/github.com/rezkiy37/Expensify into feature/43685-report-fields-edit-flow

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fea…

23748f1

…ture/43685-report-fields-edit-flow

rename create report field page

26b8885

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fea…

b942422

…ture/43685-report-fields-edit-flow

fix values getting

2a97b7d

rename initial value page

6562d40

rename value settings page

a3e9e98

rename report field edit page

c6a0795

create bare report field updates

980bc8e

create tests for updateReportFieldInitialValue

8841b35

rezkiy37 changed the title ~~[WIP] Implement the policy report field edit flow~~ Implement the policy report field edit flow Jul 8, 2024

rezkiy37 marked this pull request as ready for review July 8, 2024 12:30

rezkiy37 requested a review from a team as a code owner July 8, 2024 12:30

melvin-bot bot requested review from shubham1206agra and removed request for a team July 8, 2024 12:30

rezkiy37 mentioned this pull request Jul 8, 2024

[$250] [Report Fields] [External] Implement the policy report field edit flow #43685

Closed

rushatgabhane approved these changes Jul 9, 2024

View reviewed changes

melvin-bot bot requested a review from mountiny July 9, 2024 04:00

shubham1206agra reviewed Jul 9, 2024

View reviewed changes

src/libs/API/parameters/CreateWorkspaceReportFieldListValueParams.ts Show resolved Hide resolved

mountiny assigned rezkiy37 Jul 9, 2024

mountiny previously approved these changes Jul 9, 2024

View reviewed changes

src/libs/actions/Policy/ReportField.ts Outdated Show resolved Hide resolved

src/libs/actions/Policy/ReportField.ts Outdated Show resolved Hide resolved

rezkiy37 added 2 commits July 9, 2024 17:48

tweak comment

b18736a

fix type usage

e724077

rezkiy37 dismissed mountiny’s stale review via e724077 July 9, 2024 15:50

rezkiy37 requested a review from mountiny July 9, 2024 15:51

mountiny approved these changes Jul 9, 2024

View reviewed changes

mountiny merged commit e6804ca into Expensify:main Jul 9, 2024
17 checks passed

github-actions bot mentioned this pull request Jul 10, 2024

Deploy Checklist: New Expensify 2024-07-10 #45144

Closed

izarutskaya mentioned this pull request Jul 10, 2024

Report fields - List value disappears after deleting offline #45166

Closed

6 tasks

lanitochka17 mentioned this pull request Jul 10, 2024

Report fields - List editor shows Initial value when there is no list value #45169

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement the policy report field edit flow #44730

Implement the policy report field edit flow #44730

rezkiy37 commented Jul 2, 2024 •

edited

Loading

melvin-bot bot commented Jul 2, 2024

melvin-bot bot commented Jul 8, 2024

mountiny commented Jul 8, 2024

rushatgabhane commented Jul 9, 2024 •

edited

Loading

rushatgabhane left a comment

mountiny left a comment

mountiny left a comment

OSBotify commented Jul 9, 2024

OSBotify commented Jul 10, 2024

OSBotify commented Jul 10, 2024

OSBotify commented Jul 11, 2024

OSBotify commented Jul 11, 2024

OSBotify commented Jul 15, 2024

OSBotify commented Jul 17, 2024

Implement the policy report field edit flow #44730

Implement the policy report field edit flow #44730

Conversation

rezkiy37 commented Jul 2, 2024 • edited Loading

Details

Fixed Issues

Tests

Text type

Date type

List type

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 2, 2024

melvin-bot bot commented Jul 8, 2024

mountiny commented Jul 8, 2024

rushatgabhane commented Jul 9, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

rushatgabhane left a comment

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Jul 9, 2024

OSBotify commented Jul 10, 2024

OSBotify commented Jul 10, 2024

OSBotify commented Jul 11, 2024

OSBotify commented Jul 11, 2024

OSBotify commented Jul 15, 2024

OSBotify commented Jul 17, 2024

rezkiy37 commented Jul 2, 2024 •

edited

Loading

rushatgabhane commented Jul 9, 2024 •

edited

Loading