Remove SetNameValuePair by marcaaron · Pull Request #16396 · Expensify/App

marcaaron · 2023-03-22T16:39:32Z

Details

This has to be tested together with https://github.com/Expensify/Web-Expensify/pull/36868 and we must wait until it is deployed to merge this PR

Fixed Issues (Related To)

https://github.com/Expensify/Expensify/issues/208281

Tests

Sign into the app with a new account that has never logged in before
Verify the welcome action appears
Close the app or refresh the page
Verify the welcome action does not appear again

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as tests

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 / Chrome
- iOS / native
- iOS / 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 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 correct English and 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 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 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

MelvinBot · 2023-03-22T16:39:39Z

Looks like you modified deprecatedAPI.js! To be clear, you should not be adding any code to this file.

Instead, all new API commands should use API.js, and follow our guidelines for writing new API commands.

Unsure if your change is okay? Drop a note in #expensify-open-source!

MelvinBot · 2023-03-24T14:28:24Z

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

marcaaron · 2023-03-29T15:26:25Z

Holding on a Web-E deploy, but can be reviewed.

marcaaron · 2023-03-29T15:27:17Z

@techievivek maybe you would like to review this one as well since you got puller beared on https://github.com/Expensify/Web-Expensify/pull/36868 ?

joelbettner · 2023-03-29T16:15:39Z

- * @param {String} [onyxKeyName]
- */
-function set(name, value, onyxKeyName) {
-    DeprecatedAPI.SetNameValuePair({name, value: _.isObject(value) ? JSON.stringify(value) : value});


Was this really ONLY used to remove the CONST.NVP.IS_FIRST_TIME_NEW_EXPENSIFY_USER nvp??

at this point, yes. It had many usages that were gradually removed over the course of the API refactors.

joelbettner · 2023-03-29T16:16:56Z

    },
    NVP: {
-        IS_FIRST_TIME_NEW_EXPENSIFY_USER: 'isFirstTimeNewExpensifyUser',
        BLOCKED_FROM_CONCIERGE: 'private_blockedFromConcierge',


Were/are these set with something other than NameValuePair.set?

If you are asking about BLOCKED_FROM_CONCIERGE it's a private NVP that is read-only from the front end.

I see that all other deprecated NVP constants keep remaining. Should we also keep IS_FIRST_TIME_NEW_EXPENSIFY_USER here? or remove entire NVP: {}?
Just asking for consistency.

I'm not sure which ones you're referring to exactly. But several are still in use - we just do not set them directly via a single API command like we have done in the past.

I am referring to this one:

App/src/CONST.js

Lines 545 to 560 in 4efde84

NVP: {

IS_FIRST_TIME_NEW_EXPENSIFY_USER: 'isFirstTimeNewExpensifyUser',

BLOCKED_FROM_CONCIERGE: 'private_blockedFromConcierge',

PAYPAL_ME_ADDRESS: 'expensify_payPalMeAddress',

PRIORITY_MODE: 'priorityMode',

TIMEZONE: 'timeZone',

FREE_PLAN_BANK_ACCOUNT_ID: 'expensify_freePlanBankAccountID',

ACH_DATA_THROTTLED: 'expensify_ACHData_throttled',

FAILED_BANK_ACCOUNT_VALIDATIONS_PREFIX: 'private_failedBankValidations_',

PLAID_THROTTLED: 'private_throttledHistory_openPlaidBankAccountSelector',

PREFERRED_LOCALE: 'preferredLocale',

KYC_MIGRATION: 'expensify_migration_2020_04_28_RunKycVerifications',

PREFERRED_EMOJI_SKIN_TONE: 'expensify_preferredEmojiSkinTone',

FREQUENTLY_USED_EMOJIS: 'expensify_frequentlyUsedEmojis',

PUSH_NOTIFICATIONS_ENABLED: 'pushNotificationsEnabled',

},

I confirmed that these are not used anywhere.

IS_FIRST_TIME_NEW_EXPENSIFY_USER was only the last one used here:

App/src/libs/actions/Welcome.js

Line 110 in 4efde84

NameValuePair.set(CONST.NVP.IS_FIRST_TIME_NEW_EXPENSIFY_USER, false, ONYXKEYS.NVP_IS_FIRST_TIME_NEW_EXPENSIFY_USER);

Oh! Nice, I will get rid of it then. Nice catch!

marcaaron · 2023-03-31T16:55:13Z

Tagging in @0xmiroslav to help with a review and testing. The linked API PR is still not made it to production.

0xmiroslav

Close the app or refresh the page

Verify the welcome action does not appear again

~~@marcaaron this is failing to me. Still shows even after logout and login. This doesn't happen on main~~
Edit: Sorry I forgot to enable "Use Staging Server".

Screen.Recording.2023-04-03.at.12.52.26.PM.mov

0xmiroslav · 2023-04-03T13:27:29Z

@marcaaron also please pull latest main

…dAPITests

marcaaron · 2023-04-03T18:19:40Z

Updated.

0xmiroslav · 2023-04-03T19:14:33Z

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 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 correct English and 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 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

Mobile Web - Safari

msafari.mp4

Desktop

desktop.mov

desktop2.mov

iOS

Android

0xmiroslav

Looks good, tests well!

#16396 (comment) is just for cleanup, not a blocker.

0xmiroslav

Thanks

marcaaron · 2023-04-04T16:38:01Z

This is off hold now @joelbettner can you please final review this?

joelbettner · 2023-04-06T17:47:11Z

Sorry, I've been OOO. Reviewing now.

joelbettner

👍 Looks good! @rushatgabhane all yours.

marcaaron · 2023-04-06T17:56:05Z

Actually @rushatgabhane was not assigned for a review so I am merging this. Thanks everyone!

OSBotify · 2023-04-06T18:00:04Z

✋ 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-04-07T23:02:31Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.2.97-0 🚀

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

OSBotify · 2023-04-10T18:28:05Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.2.97-2 🚀

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

marcaaron added 5 commits March 19, 2023 08:23

Remove NameValuePair

b03b01c

Remove deprecatedAPI from SessionTest

5e6c1be

clean up tests

1b1870d

remove imports

9dd4f49

move middlewares

2db7769

marcaaron self-assigned this Mar 22, 2023

marcaaron added 2 commits March 24, 2023 09:36

we dont need any of this?

388bf0e

fix style

696addd

marcaaron changed the title ~~Remove SetNameValuePair~~ [HOLD Web-Expensify] Remove SetNameValuePair Mar 24, 2023

ignore this for now

564a04c

marcaaron marked this pull request as ready for review March 24, 2023 14:27

marcaaron requested a review from a team as a code owner March 24, 2023 14:27

melvin-bot Bot requested review from joelbettner and removed request for a team March 24, 2023 14:28

joelbettner reviewed Mar 29, 2023

View reviewed changes

marcaaron requested a review from 0xmiroslav March 31, 2023 16:54

marcaaron mentioned this pull request Mar 31, 2023

[Hold for payment 2023-04-17] Remove SetNameValuePair #16821

Closed

0xmiroslav suggested changes Apr 3, 2023

View reviewed changes

Comment thread src/libs/API.js Outdated

Comment thread src/libs/API.js Outdated

marcaaron added 2 commits April 3, 2023 08:16

Merge remote-tracking branch 'origin' into marcaaron-cleanupDeprecate…

c68669c

…dAPITests

fix up some comments for consistency

aa13c71

marcaaron requested review from 0xmiroslav and joelbettner April 3, 2023 18:19

0xmiroslav previously approved these changes Apr 3, 2023

View reviewed changes

Remove CONST.NVP

1f0c520

marcaaron dismissed 0xmiroslav’s stale review via 1f0c520 April 3, 2023 19:19

0xmiroslav approved these changes Apr 3, 2023

View reviewed changes

marcaaron changed the title ~~[HOLD Web-Expensify] Remove SetNameValuePair~~ Remove SetNameValuePair Apr 4, 2023

joelbettner approved these changes Apr 6, 2023

View reviewed changes

marcaaron merged commit 871b079 into main Apr 6, 2023

marcaaron deleted the marcaaron-cleanupDeprecatedAPITests branch April 6, 2023 17:56

OSBotify mentioned this pull request Apr 7, 2023

Deploy Checklist: New Expensify 2023-04-07 #17160

Closed

23 tasks

	NVP: {
	IS_FIRST_TIME_NEW_EXPENSIFY_USER: 'isFirstTimeNewExpensifyUser',
	BLOCKED_FROM_CONCIERGE: 'private_blockedFromConcierge',
	PAYPAL_ME_ADDRESS: 'expensify_payPalMeAddress',
	PRIORITY_MODE: 'priorityMode',
	TIMEZONE: 'timeZone',
	FREE_PLAN_BANK_ACCOUNT_ID: 'expensify_freePlanBankAccountID',
	ACH_DATA_THROTTLED: 'expensify_ACHData_throttled',
	FAILED_BANK_ACCOUNT_VALIDATIONS_PREFIX: 'private_failedBankValidations_',
	PLAID_THROTTLED: 'private_throttledHistory_openPlaidBankAccountSelector',
	PREFERRED_LOCALE: 'preferredLocale',
	KYC_MIGRATION: 'expensify_migration_2020_04_28_RunKycVerifications',
	PREFERRED_EMOJI_SKIN_TONE: 'expensify_preferredEmojiSkinTone',
	FREQUENTLY_USED_EMOJIS: 'expensify_frequentlyUsedEmojis',
	PUSH_NOTIFICATIONS_ENABLED: 'pushNotificationsEnabled',
	},

Conversation

marcaaron commented Mar 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues (Related To)

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

MelvinBot commented Mar 22, 2023

Uh oh!

MelvinBot commented Mar 24, 2023

Uh oh!

marcaaron commented Mar 29, 2023

Uh oh!

marcaaron commented Mar 29, 2023

Uh oh!

joelbettner Mar 29, 2023

Choose a reason for hiding this comment

Uh oh!

marcaaron Mar 29, 2023

Choose a reason for hiding this comment

Uh oh!

joelbettner Mar 29, 2023

Choose a reason for hiding this comment

Uh oh!

marcaaron Mar 29, 2023

Choose a reason for hiding this comment

Uh oh!

0xmiroslav Apr 3, 2023

Choose a reason for hiding this comment

Uh oh!

marcaaron Apr 3, 2023

Choose a reason for hiding this comment

Uh oh!

0xmiroslav Apr 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

marcaaron Apr 3, 2023

Choose a reason for hiding this comment

Uh oh!

marcaaron commented Mar 31, 2023

Uh oh!

0xmiroslav left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

0xmiroslav commented Apr 3, 2023

Uh oh!

marcaaron commented Apr 3, 2023

Uh oh!

0xmiroslav commented Apr 3, 2023

Reviewer Checklist

Screenshots/Videos

Uh oh!

0xmiroslav left a comment

Choose a reason for hiding this comment

Uh oh!

0xmiroslav left a comment

Choose a reason for hiding this comment

Uh oh!

marcaaron commented Apr 4, 2023

Uh oh!

joelbettner commented Apr 6, 2023

Uh oh!

joelbettner left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

marcaaron commented Apr 6, 2023

Uh oh!

OSBotify commented Apr 6, 2023

Uh oh!

OSBotify commented Apr 7, 2023

Uh oh!

marcaaron commented Mar 22, 2023 •

edited

Loading

0xmiroslav Apr 3, 2023 •

edited

Loading

0xmiroslav left a comment •

edited

Loading

joelbettner left a comment •

edited

Loading