Replace global variables #47076

BrtqKr · 2024-08-08T13:44:10Z

Fixed role undefined case on room members invite
Moved the search state persist to the onyx
Removed unnecessary persistence on workspace invite and auth

Details

Fixed Issues

$ #47783
PROPOSAL: https://swmansion.slack.com/archives/C05LX9D6E07/p1723130121950609

Tests

Everything is related to the RHP screens, that contain user search - the behaviour should be identical to the current state of the app, that is:

Both screens have to share the input state after the navigation action
Screens need to have a clear state after interrupting the flow and reopening it

The changes have been applied to both room members and room participants flows.

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

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

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

blazejkustra

Couple minor comments, other than that - great refactor 😄

blazejkustra · 2024-08-08T14:56:37Z

src/ROUTES.ts

@@ -355,7 +355,10 @@ const ROUTES = {
    },
    ROOM_INVITE: {
        route: 'r/:reportID/invite/:role?',
-        getRoute: (reportID: string, role?: string) => `r/${reportID}/invite/${role}` as const,
+        getRoute: (reportID: string, role?: string) => {
+            const route = role ? (`r/${reportID}/invite/${role}` as const) : (`r/${reportID}/invite` as const);


How about a shorter version?

Suggested change

const route = role ? (`r/${reportID}/invite/${role}` as const) : (`r/${reportID}/invite` as const);

getRoute: (reportID: string, role?: string) => `r/${reportID}/invite${role ? `/${role}`: ''}` as const,

@BrtqKr Could you please help to detail which problem here?

Fixed role undefined case on room members invite

when someone didn't have a role inside of a report we ended up with /undefined inside of the url. It just seems like someone forgot to put a proper fallback in there

@BrtqKr With previous code, we added a fallback value is empty string. Why shouldn't use ?? operator?

Not sure what you meant exactly, but two explanations:
1.
getRoute: (reportID: string, role?: string) =>r/${reportID}/invite/${role} as const,

In the previous version, skipping the role meant getting undefined, which was getting stringified, which resulted in for example
r/151422415264937/invite/undefined in the url.

?? operator works only as a fallback for null and undefined and in this case we want to include empty string in the same group to remove slash for this scenario

blazejkustra · 2024-08-08T14:56:57Z

src/libs/Navigation/AppNavigator/AuthScreens.tsx

@@ -174,8 +173,6 @@ const modalScreenListeners = {
        Modal.setModalVisibility(false);
    },
    beforeRemove: () => {
-        // Clear search input (WorkspaceInvitePage) when modal is closed
-        SearchInputManager.searchInput = '';


Shouldn't we clear it here?

No, because we've removed the usage of persist on that page. Apparently navigation patterns have changed and this is no longer necessary.

blazejkustra · 2024-08-08T14:57:16Z

src/libs/actions/RoomMembersUserSearchPhrase.ts

+    Onyx.merge(ONYXKEYS.ROOM_MEMBERS_USER_SEARCH_PHRASE, value);
+}
+
+export {clearUserSearchPhrase as clearUserSearchValue, updateUserSearchPhrase};


Suggested change

export {clearUserSearchPhrase as clearUserSearchValue, updateUserSearchPhrase};

export {clearUserSearchPhrase, updateUserSearchPhrase};

leftover, sorry

blazejkustra · 2024-08-08T14:57:44Z

src/libs/actions/RoomMembersUserSearchPhrase.ts

+import ONYXKEYS from '@src/ONYXKEYS';
+
+function clearUserSearchPhrase() {
+    Onyx.set(ONYXKEYS.ROOM_MEMBERS_USER_SEARCH_PHRASE, '');


Let's use merge here as well

…-variables

melvin-bot · 2024-08-26T11:01:15Z

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

DylanDylann · 2024-08-27T05:26:05Z

@BrtqKr Minor question #47076 (comment) and please resolve conflict

DylanDylann · 2024-08-28T02:43:49Z

@BrtqKr Friendly bump

blazejkustra · 2024-08-28T07:32:22Z

@DylanDylann Bartek got sick 😢 He will get back to it later this week or in the upcoming week

…-variables

DylanDylann · 2024-08-28T09:26:13Z

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-08-28.at.17.52.50.mov

Android: mWeb Chrome

Screen.Recording.2024-08-28.at.17.53.29.mov

iOS: Native

Screen.Recording.2024-08-28.at.17.51.47.mov

iOS: mWeb Safari

Screen.Recording.2024-08-28.at.17.52.24.mov

MacOS: Chrome / Safari

Screen.Recording.2024-08-28.at.17.42.50.mov

MacOS: Desktop

Screen.Recording.2024-08-28.at.17.50.29.mov

DylanDylann · 2024-08-29T09:25:28Z

@grgia All yours

DylanDylann · 2024-09-05T10:04:30Z

@BrtqKr Conflict

…-variables

BrtqKr · 2024-09-05T10:46:35Z

@grgia, I think this should be done 🙏

grgia · 2024-09-09T16:17:53Z

@BrtqKr we can merge once conflicts are fixed! Thanks for your patience, I was OOO

…-variables

BrtqKr · 2024-09-10T11:17:12Z

Ok, I needed to adjust RoomParticipants after changes from the main, but it seems to be working as expected

grgia · 2024-09-10T17:04:55Z

bump for rereview after changes @DylanDylann

DylanDylann · 2024-09-11T08:56:36Z

The new change in ReportParticipantsPage and InviteReportParticipantsPage look good

@grgia All yours

OSBotify · 2024-09-11T09:14:01Z

✋ 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-09-12T21:18:38Z

🚀 Deployed to production by https://github.com/luacmartins in version: 9.0.33-4 🚀

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

BrtqKr added 7 commits August 8, 2024 11:25

fix undefined role route

5a175d9

move search state to onyx wip

0d3cc6e

apply onyx search persist to the members flow

75654cf

cleanup

f06810d

remove persist from workspace invite page

d6df1ba

cleanup

30ff249

cleanup

a311867

blazejkustra approved these changes Aug 8, 2024

View reviewed changes

review fixes

ba8b960

grgia mentioned this pull request Aug 21, 2024

[$250] Polish - Search Term Clean Up for User Invite #47783

Closed

Merge remote-tracking branch 'origin/main' into brtqkr/repalce-global…

07a3dce

…-variables

BrtqKr marked this pull request as ready for review August 26, 2024 11:01

BrtqKr requested a review from a team as a code owner August 26, 2024 11:01

melvin-bot bot requested review from DylanDylann and removed request for a team August 26, 2024 11:01

BrtqKr added 2 commits August 28, 2024 10:43

Merge remote-tracking branch 'origin/main' into brtqkr/repalce-global…

aff91e1

…-variables

cleanup

86db79c

DylanDylann approved these changes Aug 28, 2024

View reviewed changes

melvin-bot bot requested a review from grgia August 28, 2024 10:55

Merge remote-tracking branch 'origin/main' into brtqkr/repalce-global…

902e65c

…-variables

grgia previously approved these changes Sep 9, 2024

View reviewed changes

Merge remote-tracking branch 'origin/main' into brtqkr/repalce-global…

043056c

…-variables

BrtqKr dismissed grgia’s stale review via 043056c September 10, 2024 08:57

replace search input manager for the updated screens

dd11582

BrtqKr requested a review from grgia September 10, 2024 11:17

grgia approved these changes Sep 10, 2024

View reviewed changes

grgia requested a review from DylanDylann September 10, 2024 17:04

DylanDylann approved these changes Sep 11, 2024

View reviewed changes

melvin-bot bot requested a review from grgia September 11, 2024 08:56

grgia approved these changes Sep 11, 2024

View reviewed changes

grgia merged commit f29f18a into Expensify:main Sep 11, 2024
19 checks passed

github-actions bot mentioned this pull request Sep 11, 2024

Deploy Checklist: New Expensify 2024-09-11 #49025

Closed

49 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace global variables #47076

Replace global variables #47076

BrtqKr commented Aug 8, 2024 •

edited

Loading

blazejkustra left a comment

blazejkustra Aug 8, 2024

DylanDylann Aug 27, 2024

BrtqKr Aug 28, 2024 •

edited

Loading

DylanDylann Aug 28, 2024

BrtqKr Aug 28, 2024 •

edited

Loading

blazejkustra Aug 8, 2024

BrtqKr Aug 8, 2024

blazejkustra Aug 8, 2024

BrtqKr Aug 8, 2024

blazejkustra Aug 8, 2024

melvin-bot bot commented Aug 26, 2024

DylanDylann commented Aug 27, 2024

DylanDylann commented Aug 28, 2024

blazejkustra commented Aug 28, 2024

DylanDylann commented Aug 28, 2024 •

edited

Loading

DylanDylann commented Aug 29, 2024

DylanDylann commented Sep 5, 2024

BrtqKr commented Sep 5, 2024

grgia commented Sep 9, 2024

BrtqKr commented Sep 10, 2024

grgia commented Sep 10, 2024

DylanDylann commented Sep 11, 2024 •

edited

Loading

OSBotify commented Sep 11, 2024

OSBotify commented Sep 12, 2024

	const route = role ? (`r/${reportID}/invite/${role}` as const) : (`r/${reportID}/invite` as const);
	getRoute: (reportID: string, role?: string) => `r/${reportID}/invite${role ? `/${role}`: ''}` as const,

	export {clearUserSearchPhrase as clearUserSearchValue, updateUserSearchPhrase};
	export {clearUserSearchPhrase, updateUserSearchPhrase};

Replace global variables #47076

Replace global variables #47076

Conversation

BrtqKr commented Aug 8, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

blazejkustra left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BrtqKr Aug 28, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BrtqKr Aug 28, 2024 • edited Loading

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

melvin-bot bot commented Aug 26, 2024

DylanDylann commented Aug 27, 2024

DylanDylann commented Aug 28, 2024

blazejkustra commented Aug 28, 2024

DylanDylann commented Aug 28, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

DylanDylann commented Aug 29, 2024

DylanDylann commented Sep 5, 2024

BrtqKr commented Sep 5, 2024

grgia commented Sep 9, 2024

BrtqKr commented Sep 10, 2024

grgia commented Sep 10, 2024

DylanDylann commented Sep 11, 2024 • edited Loading

OSBotify commented Sep 11, 2024

OSBotify commented Sep 12, 2024

BrtqKr commented Aug 8, 2024 •

edited

Loading

BrtqKr Aug 28, 2024 •

edited

Loading

BrtqKr Aug 28, 2024 •

edited

Loading

DylanDylann commented Aug 28, 2024 •

edited

Loading

DylanDylann commented Sep 11, 2024 •

edited

Loading