fix: save terms of service checkbox in draft #18479

allroundexperts · 2023-05-05T14:26:19Z

Details

This PR fixes the condition which set the value of terms of service checkbox inside the draft state.

Fixed Issues

$ #16885
PROPOSAL: #16885 (comment)

Tests

Go to Settings > Workspace > Connect Bank Account.
Click on "Continue with Setup."(Enter all record if you have not)
Uncheck the Step 1 checkbox and go back.
Click on "Continue with Setup" again.

Verify that the checkbox remains unchecked.

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Go to Settings > Workspace > Connect Bank Account.
Click on "Continue with Setup."(Enter all record if you have not)
Uncheck the Step 1 checkbox and go back.
Click on "Continue with Setup" again.

Verify that the checkbox remains unchecked.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-05-05.at.6.56.33.PM.mov

Mobile Web - Chrome

Screen.Recording.2023-05-05.at.7.06.44.PM.mov

Mobile Web - Safari

Screen.Recording.2023-05-05.at.7.04.27.PM.mov

Desktop

Screen.Recording.2023-05-05.at.7.02.18.PM.mov

iOS

Screen.Recording.2023-05-05.at.7.19.04.PM.mov

Android

Screen.Recording.2023-05-05.at.7.17.30.PM.mov

melvin-bot · 2023-05-05T14:26:23Z

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

melvin-bot · 2023-05-05T14:26:24Z

@pecanoro @aimane-chnaif One of you needs to 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 · 2023-05-08T10:39:29Z

src/components/CheckboxWithLabel.js

+        if (!_.isUndefined(props.value)) {
+            this.isChecked = props.value;
+        } else if (!_.isUndefined(props.defaultValue)) {
+            this.isChecked = props.defaultValue;
+        } else {
+            this.isChecked = props.isChecked;
+        }


_.find() is more dry code?

Sorry, what do you mean?

this.isChecked = _.find([props.value, props.defaultValue, props.isChecked], value => _.isBoolean(value));

Ah, this works. But I chose the if conditions because I thought it is more easier to understand what we are trying to achieve. But I'm happy to change it if you disagree.

If you agree with my suggestion, let's apply that and add comment above. Comment is needed either way so that others don't do same mistake in the future.

Sounds good!

@aimane-chnaif Fixed.

aimane-chnaif · 2023-05-08T11:56:47Z

src/components/Form.js

+
+            // We need to pick the first value that is strictly a boolean
+            // https://github.com/Expensify/App/issues/16885
+            const defaultValue = _.find([this.props.draftValues[inputID], child.props.defaultValue], value => _.isBoolean(value));


We can't use _.isBoolean here. Text input values are string.

Nice catch @aimane-chnaif. Pushed with the revert.

aimane-chnaif · 2023-05-08T12:02:15Z

src/components/Form.js

+            let defaultValue;
+
+            if (!_.isUndefined(this.props.draftValues[inputID])) {
+                defaultValue = this.props.draftValues[inputID];
+            } else if (!_.isUndefined(child.props.defaultValue)) {
+                defaultValue = child.props.defaultValue;
+            }


Let's say draftValue is null, defaultValue is 'xyz' in text input!
old logic returns 'xyz'
new logic returns null

We should not change current text input logic but only checkbox logic.
Will this work?

if (_.isBoolean(this.props.draftValues[inputID])) { defaultValue = this.props.draftValues[inputID]; } else { defaultValue = this.props.draftValues[inputID] || child.props.defaultValue; }

This might work but I think its not very easy to understand / readable. Although, we can add a comment, but I think this can be improved. I can see lodash 4.0 has a isNil method which checks for null and undefined. But we're at a older version and can't use it.

We're actually using underscore in this file. I'll see if it has something like nil

Another case: '' || 'xyz'

Hm... You're spot on. I'll make the changes that you suggested.

Can you check what _isEmpty returns for null, undefined, '', 0, false/true?

console.log(isBlank(null)); -> true console.log(isBlank(undefined)); -> true console.log(isBlank('')); -> true console.log(isBlank(false)); -> false console.log(isEmpty(null)); -> true console.log(isEmpty(undefined)); -> true console.log(isEmpty('')); -> true console.log(isEmpty(false)); -> true

isBlank is available in underscore.string only :)

aimane-chnaif · 2023-05-08T12:29:25Z

src/components/Form.js

-            const defaultValue = this.props.draftValues[inputID] || child.props.defaultValue;
+            let defaultValue;
+
+            if (_.isBoolean(this.props.draftValues[inputID])) {


Let's add comment what's this for. And link to issue comment (not issue).
Same above

aimane-chnaif · 2023-05-08T14:40:10Z

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 / Chrome
- iOS / native
- iOS / 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(themeColors.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 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

Web

web.mov

Mobile Web - Chrome

mchrome.mov

Mobile Web - Safari

msafari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

aimane-chnaif

LGTM 🎉
@pecanoro all yours!

pecanoro

Did you test that the form component is still working fine? I tested adding a bank account and it should be fine, but making sure that you both tested it as well?

src/components/CheckboxWithLabel.js

aimane-chnaif · 2023-05-09T10:48:37Z

Did you test that the form component is still working fine? I tested adding a bank account and it should be fine, but making sure that you both tested it as well?

yes I tested already

Co-authored-by: Rocio Perez-Cano <[email protected]>

aimane-chnaif

👍

OSBotify · 2023-05-09T11:26:46Z

✋ 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 · 2023-05-11T02:43:57Z

🚀 Deployed to staging by https://github.com/pecanoro in version: 1.3.13-0 🚀

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

OSBotify · 2023-05-15T08:25:12Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.13-5 🚀

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

fix: save tos checkbox in draft

486da3d

allroundexperts requested a review from a team as a code owner May 5, 2023 14:26

melvin-bot bot removed the request for review from a team May 5, 2023 14:26

melvin-bot bot requested review from aimane-chnaif and pecanoro May 5, 2023 14:26

allroundexperts mentioned this pull request May 5, 2023

[HOLD for payment 2023-05-22] [$1000] When connecting a bank account, the terms of service checkbox doesn't save the draft state as everything else. #16885

Closed

6 tasks

aimane-chnaif reviewed May 8, 2023

View reviewed changes

allroundexperts requested a review from aimane-chnaif May 8, 2023 11:50

aimane-chnaif reviewed May 8, 2023

View reviewed changes

allroundexperts force-pushed the fix-16885 branch from 03cfe25 to 83cc3f0 Compare May 8, 2023 11:59

aimane-chnaif reviewed May 8, 2023

View reviewed changes

allroundexperts force-pushed the fix-16885 branch from 83cc3f0 to 33cce20 Compare May 8, 2023 12:21

aimane-chnaif reviewed May 8, 2023

View reviewed changes

allroundexperts force-pushed the fix-16885 branch from 33cce20 to a28caab Compare May 8, 2023 12:29

fix: replace if statements with _find function

eafde7e

allroundexperts force-pushed the fix-16885 branch from a28caab to eafde7e Compare May 8, 2023 12:31

aimane-chnaif previously approved these changes May 8, 2023

View reviewed changes

pecanoro requested changes May 9, 2023

View reviewed changes

src/components/CheckboxWithLabel.js Outdated Show resolved Hide resolved

Update src/components/CheckboxWithLabel.js

29fe0e2

Co-authored-by: Rocio Perez-Cano <[email protected]>

allroundexperts dismissed aimane-chnaif’s stale review via 29fe0e2 May 9, 2023 10:49

aimane-chnaif approved these changes May 9, 2023

View reviewed changes

pecanoro approved these changes May 9, 2023

View reviewed changes

pecanoro merged commit d47561e into Expensify:main May 9, 2023

OSBotify mentioned this pull request May 11, 2023

Deploy Checklist: New Expensify 2023-05-11 #18764

Closed

51 tasks

aimane-chnaif mentioned this pull request May 22, 2023

Clean up CheckboxWithLabel refactor #8682

Merged

89 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: save terms of service checkbox in draft #18479

fix: save terms of service checkbox in draft #18479

allroundexperts commented May 5, 2023

melvin-bot bot commented May 5, 2023

melvin-bot bot commented May 5, 2023

aimane-chnaif May 8, 2023

allroundexperts May 8, 2023

aimane-chnaif May 8, 2023

allroundexperts May 8, 2023

aimane-chnaif May 8, 2023

allroundexperts May 8, 2023

allroundexperts May 8, 2023

aimane-chnaif May 8, 2023

allroundexperts May 8, 2023

aimane-chnaif May 8, 2023

aimane-chnaif May 8, 2023

allroundexperts May 8, 2023

allroundexperts May 8, 2023

aimane-chnaif May 8, 2023

allroundexperts May 8, 2023

aimane-chnaif May 8, 2023

allroundexperts May 8, 2023

allroundexperts May 8, 2023

aimane-chnaif May 8, 2023

allroundexperts May 8, 2023

aimane-chnaif commented May 8, 2023

aimane-chnaif left a comment

pecanoro left a comment

aimane-chnaif commented May 9, 2023

aimane-chnaif left a comment

OSBotify commented May 9, 2023

OSBotify commented May 11, 2023

OSBotify commented May 15, 2023

fix: save terms of service checkbox in draft #18479

fix: save terms of service checkbox in draft #18479

Conversation

allroundexperts commented May 5, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 5, 2023

melvin-bot bot commented May 5, 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

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

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

aimane-chnaif commented May 8, 2023

Reviewer Checklist

Screenshots/Videos

aimane-chnaif left a comment

Choose a reason for hiding this comment

pecanoro left a comment

Choose a reason for hiding this comment

aimane-chnaif commented May 9, 2023

aimane-chnaif left a comment

Choose a reason for hiding this comment

OSBotify commented May 9, 2023

OSBotify commented May 11, 2023

OSBotify commented May 15, 2023