[CP Staging] Update submit function in initial report field value #48109

cretadn22 · 2024-08-27T18:00:25Z

Details

Fixed Issues

$ #48106
PROPOSAL: #48106 (comment)

Tests

QA Steps

Verify that no errors appear in the JS console

Offline tests

QA Steps

Go to workspace settings > Report fields.
Add a Text report field and a List report field
Go to Text report field
Add initial value
Verify that the initial value is updated
Update initial value with the old value
Nothing happens
Go to List report field
Add initial value
Verify that the initial value is updated
Update initial value with the old value
The initial value should be empty

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

Android: mWeb Chrome

Screen102.mov

iOS: Native

Screen103.mov

iOS: mWeb Safari

Screen101.mov

MacOS: Chrome / Safari

Screen100.mov

MacOS: Desktop

Screen99.mov

melvin-bot · 2024-08-27T18:00:30Z

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

ishpaul777 · 2024-08-27T18:08:08Z

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 build failing consistently.. Sorry

Android: mWeb Chrome

Record_2024-08-28-20-48-56.mp4

iOS: Native

Screen.Recording.2024-08-28.at.8.58.17.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-08-28.at.8.20.32.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-08-28.at.8.13.20.PM.mov

MacOS: Desktop

Screen.Recording.2024-08-28.at.9.17.12.PM.mov

ishpaul777 · 2024-08-27T18:11:13Z

@cretadn22 There are lint issues

src/pages/workspace/reportFields/ReportFieldsInitialValuePage.tsx

ishpaul777 · 2024-08-27T18:44:35Z

@cretadn22 Can we just compare WorkspaceReportFieldUtils.getReportFieldInitialValue(reportField) at both places instead of large diffs

https://expensify.slack.com/archives/C01GTK53T8Q/p1724783279187499?thread_ts=1724777021.614639&cid=C01GTK53T8Q

const submitForm = useCallback(
        (values: FormOnyxValues<typeof ONYXKEYS.FORMS.WORKSPACE_REPORT_FIELDS_FORM>) => {
            if (currentInitialValue === values.initialValue) {
                Navigation.goBack();
                return;
            }
            ReportField.updateReportFieldInitialValue(policyID, reportFieldID, values.initialValue);
            Navigation.goBack();
        },
        [policyID, reportFieldID, currentInitialValue],
    );

chiragsalian · 2024-08-27T18:44:57Z

@cretadn22, question why does the PR have a number of changes. From the proposal i thought the direction was to just change this line in submitForm

ReportField.updateReportFieldInitialValue(policyID, reportFieldID, initialValue === values.initialValue ? '' : values.initialValue);

to,

ReportField.updateReportFieldInitialValue(policyID, reportFieldID, WorkspaceReportFieldUtils.getReportFieldInitialValue(reportField) === values.initialValue ? '' : values.initialValue);

does that change alone not suffice?

cretadn22 · 2024-08-27T18:49:22Z

@chiragsalian @ishpaul777 I’ve identified another issue: in the Text report field, if we save the old value, it gets removed. I mentioned this in my proposal.

When the new value is similar to the old value, handle the updates as follows:

Text type: No action required.
List type: Update the initial value to an empty string.

ishpaul777 · 2024-08-27T18:55:15Z

Ahh got it just early return in that case ?

const submitForm = useCallback(
        (values: FormOnyxValues<typeof ONYXKEYS.FORMS.WORKSPACE_REPORT_FIELDS_FORM>) => {
            if (currentInitialValue === values.initialValue) {
                Navigation.goBack();
                return;
            }
            ReportField.updateReportFieldInitialValue(policyID, reportFieldID, values.initialValue);
            Navigation.goBack();
        },
        [policyID, reportFieldID, currentInitialValue],
    );

cretadn22 · 2024-08-27T19:03:22Z

@ishpaul777 For List types, we need to remove the old value.

When the new value is similar to the old value, handle the updates as follows:
Text type: No action required.
List type: Update the initial value to an empty string.

ishpaul777 · 2024-08-27T19:06:51Z

it does that already isn't ?

Screen.Recording.2024-08-28.at.12.34.28.AM.mov

ishpaul777 · 2024-08-27T19:17:08Z

@cretadn22 Am i missing something

cretadn22 · 2024-08-27T19:28:33Z

@ishpaul777 Please check my comment: #48109 (comment)

ishpaul777 · 2024-08-27T19:31:27Z

Sorry @cretadn22, I still cannot spot the need for modifying submitListValueUpdate function it seems to be working correctly as it is..

ishpaul777 · 2024-08-27T20:11:45Z

@cretadn22 gentle bump, do you mind recording after/before video if i am missing something ?

chiragsalian · 2024-08-27T20:23:29Z

When the new value is similar to the old value, handle the updates as follows:
Text type: No action required.
List type: Update the initial value to an empty string.

Ah thanks for sharing. Yes i see how my code suggestion alone would be incorrect.

Ahh got it just early return in that case

Yeah that LGTM. Im also confused by @cretadn22 replies.
With more detail @ishpaul777 is suggesting, (I DRY'd it a bit)

const currentInitialValue = WorkspaceReportFieldUtils.getReportFieldInitialValue(reportField);

const submitForm = useCallback(
    (values: FormOnyxValues<typeof ONYXKEYS.FORMS.WORKSPACE_REPORT_FIELDS_FORM>) => {
        if (currentInitialValue !== values.initialValue) {
            ReportField.updateReportFieldInitialValue(policyID, reportFieldID, values.initialValue);
        }
        Navigation.goBack();
    },
    [policyID, reportFieldID, currentInitialValue],
);

const submitListValueUpdate = (value: string) => {
    ReportField.updateReportFieldInitialValue(policyID, reportFieldID, initialValue === value ? '' : value);
    Navigation.goBack();
};

So list submit calls submitListValueUpdate
and text submit calls submitForm (we could update that to be submitTextValueUpdate to make it more verbose).

With those changes. This condition should be satisfied right,

When the new value is similar to the old value, handle the updates as follows:
Text type: No action required.
List type: Update the initial value to an empty string.

Can you let us know where it falls short with an example?

ishpaul777 · 2024-08-28T14:13:04Z

Gentle bump @cretadn22

cretadn22 · 2024-08-28T14:22:48Z

@ishpaul777 Sorry for any confusion earlier. I'm making an update now.

cretadn22 · 2024-08-28T14:31:14Z

@ishpaul777 @chiragsalian Earlier, I intended to combine the two submit functions into a single function. Sorry if it caused any confusion.

ishpaul777 · 2024-08-28T14:38:43Z

Lint error @cretadn22

ishpaul777 · 2024-08-28T14:41:45Z

Also please merge main

ishpaul777 · 2024-08-28T15:20:32Z

gentle bump @cretadn22

src/pages/workspace/reportFields/ReportFieldsInitialValuePage.tsx

Co-authored-by: Ishpaul Singh <104348397+ishpaul777@users.noreply.github.com>

cretadn22 · 2024-08-28T15:38:09Z

I'm here, @ishpaul777. Is there anything else that needs addressing?

chiragsalian

nice

[CP Staging] Update submit function in initial report field value (cherry picked from commit 5368e47) (CP triggered by chiragsalian)

OSBotify · 2024-08-28T17:15:02Z

✋ 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-08-28T17:42:42Z

🚀 Cherry-picked to staging by https://github.com/chiragsalian in version: 9.0.25-12 🚀

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

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

cretadn22 requested a review from a team as a code owner August 27, 2024 18:00

melvin-bot bot requested review from ishpaul777 and removed request for a team August 27, 2024 18:00

cretadn22 changed the title ~~Update submit function~~ Update submit function in initial report field value Aug 27, 2024

ishpaul777 reviewed Aug 27, 2024

View reviewed changes

src/pages/workspace/reportFields/ReportFieldsInitialValuePage.tsx Outdated Show resolved Hide resolved

mountiny assigned cretadn22 Aug 28, 2024

mountiny changed the title ~~Update submit function in initial report field value~~ [CP Staging] Update submit function in initial report field value Aug 28, 2024

update submit function in initial value

7e0703c

cretadn22 force-pushed the handle-same-value-submit branch from ad21147 to 7e0703c Compare August 28, 2024 14:29

ishpaul777 reviewed Aug 28, 2024

View reviewed changes

src/pages/workspace/reportFields/ReportFieldsInitialValuePage.tsx Outdated Show resolved Hide resolved

Update ReportFieldsInitialValuePage.tsx

0884b96

Co-authored-by: Ishpaul Singh <104348397+ishpaul777@users.noreply.github.com>

update main

f1b9361

ishpaul777 approved these changes Aug 28, 2024

View reviewed changes

melvin-bot bot requested a review from chiragsalian August 28, 2024 15:48

chiragsalian approved these changes Aug 28, 2024

View reviewed changes

chiragsalian merged commit 5368e47 into Expensify:main Aug 28, 2024
16 checks passed

OSBotify pushed a commit that referenced this pull request Aug 28, 2024

Merge pull request #48109 from cretadn22/handle-same-value-submit

16cc37f

[CP Staging] Update submit function in initial report field value (cherry picked from commit 5368e47) (CP triggered by chiragsalian)

github-actions bot added the CP Staging marks PRs that have been CP'd to staging label Aug 28, 2024

github-actions bot mentioned this pull request Aug 28, 2024

Deploy Checklist: New Expensify 2024-08-26 #48035

Closed

puneetlath mentioned this pull request Aug 28, 2024

Deploy Checklist: New Expensify 2024-08-28 #48221

Closed

93 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CP Staging] Update submit function in initial report field value #48109

[CP Staging] Update submit function in initial report field value #48109

cretadn22 commented Aug 27, 2024 •

edited

Loading

melvin-bot bot commented Aug 27, 2024

ishpaul777 commented Aug 27, 2024 •

edited

Loading

ishpaul777 commented Aug 27, 2024

ishpaul777 commented Aug 27, 2024 •

edited

Loading

chiragsalian commented Aug 27, 2024

cretadn22 commented Aug 27, 2024

ishpaul777 commented Aug 27, 2024 •

edited

Loading

cretadn22 commented Aug 27, 2024

ishpaul777 commented Aug 27, 2024

ishpaul777 commented Aug 27, 2024

cretadn22 commented Aug 27, 2024

ishpaul777 commented Aug 27, 2024 •

edited

Loading

ishpaul777 commented Aug 27, 2024

chiragsalian commented Aug 27, 2024

ishpaul777 commented Aug 28, 2024

cretadn22 commented Aug 28, 2024

cretadn22 commented Aug 28, 2024

ishpaul777 commented Aug 28, 2024

ishpaul777 commented Aug 28, 2024

ishpaul777 commented Aug 28, 2024

cretadn22 commented Aug 28, 2024

chiragsalian left a comment

OSBotify commented Aug 28, 2024

OSBotify commented Aug 28, 2024

[CP Staging] Update submit function in initial report field value #48109

[CP Staging] Update submit function in initial report field value #48109

Conversation

cretadn22 commented Aug 27, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 27, 2024

ishpaul777 commented Aug 27, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

ishpaul777 commented Aug 27, 2024

ishpaul777 commented Aug 27, 2024 • edited Loading

chiragsalian commented Aug 27, 2024

cretadn22 commented Aug 27, 2024

ishpaul777 commented Aug 27, 2024 • edited Loading

cretadn22 commented Aug 27, 2024

ishpaul777 commented Aug 27, 2024

ishpaul777 commented Aug 27, 2024

cretadn22 commented Aug 27, 2024

ishpaul777 commented Aug 27, 2024 • edited Loading

ishpaul777 commented Aug 27, 2024

chiragsalian commented Aug 27, 2024

ishpaul777 commented Aug 28, 2024

cretadn22 commented Aug 28, 2024

cretadn22 commented Aug 28, 2024

ishpaul777 commented Aug 28, 2024

ishpaul777 commented Aug 28, 2024

ishpaul777 commented Aug 28, 2024

cretadn22 commented Aug 28, 2024

chiragsalian left a comment

Choose a reason for hiding this comment

OSBotify commented Aug 28, 2024

OSBotify commented Aug 28, 2024

cretadn22 commented Aug 27, 2024 •

edited

Loading

ishpaul777 commented Aug 27, 2024 •

edited

Loading

ishpaul777 commented Aug 27, 2024 •

edited

Loading

ishpaul777 commented Aug 27, 2024 •

edited

Loading

ishpaul777 commented Aug 27, 2024 •

edited

Loading