[#16935] Workspace creation with Policy Draft info #29256

gedu · 2023-10-11T06:43:35Z

Details

Created 2 new keys to save Policy and PolicyMembers information, PolicyDraft and PolicyMembersDraft. Those keys are filled with basic Policy information just for fast navigation to the Workspace Init Page, where those drafts are removed and the Policy data are saved and a request is made.

Fixed Issues

$ #16935
PROPOSAL: #16935 (comment)

Tests

Verify that no errors appear in the JS console

Click on the User Avatar
Go to Workspace
Click on New Workspace Button

Offline tests

Click on the User Avatar
Go to Workspace
Click on New Workspace Button
When is back to online, the workspace should work normally

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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 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 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

Android: Native

createWorkspace_android.mp4

Android: mWeb Chrome

createWorkspace_androidWeb.mp4

iOS: Native

createWorkspace_iphone.mp4

iOS: mWeb Safari

createWorkspace_iphoneWeb.mp4

MacOS: Chrome / Safari

createWorkspace_chrome.mp4

createWorkspace_safari.mp4

MacOS: Desktop

createWorkspace_desktop.mp4

gedu · 2023-10-11T09:17:10Z

src/pages/workspace/WorkspacesListPage.js

@@ -194,7 +192,7 @@ function WorkspacesListPage({policies, allPolicyMembers, reimbursementAccount, u
                    accessibilityLabel={translate('workspace.new.newWorkspace')}
                    success
                    text={translate('workspace.new.newWorkspace')}
-                    onPress={() => App.createWorkspaceAndNavigateToIt('', false, '', false, !isSmallScreenWidth)}
+                    onPress={() => App.createWorkspaceWithPolicyDraftAndNavigateToIt()}


I can't just do

onPress={App.createWorkspaceWithPolicyDraftAndNavigateToIt}

because the onPress send a button event, and that object is passed and it breaks the calls

src/pages/workspace/withPolicyAndFullscreenLoading.js

rezkiy37

Left comments.

src/libs/actions/App.js

src/libs/actions/Policy.js

src/pages/workspace/WorkspaceInitialPage.js

src/pages/workspace/withPolicyAndFullscreenLoading.js

melvin-bot · 2023-10-12T07:37:41Z

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

s77rt · 2023-10-12T20:14:20Z

src/libs/actions/App.js

@@ -336,6 +336,40 @@ function createWorkspaceAndNavigateToIt(policyOwnerEmail = '', makeMeAdmin = fal
        .then(endSignOnTransition);
 }

+/**
+ * Create a new Draft workspace and navigate to it


Suggested change

* Create a new Draft workspace and navigate to it

* Create a new draft workspace and navigate to it

s77rt · 2023-10-12T20:31:31Z

src/pages/workspace/WorkspaceInitialPage.js

+            return;
+        }
+
+        App.savePolicyDraftByNewWorkspace(props.policyDraft.id, props.policyDraft.name, '', false, '', !isSmallScreenWidth);


Suggested change

App.savePolicyDraftByNewWorkspace(props.policyDraft.id, props.policyDraft.name, '', false, '', !isSmallScreenWidth);

App.savePolicyDraftByNewWorkspace(props.policyDraft.id, props.policyDraft.name, '', false);

s77rt · 2023-10-12T20:42:02Z

src/libs/actions/Policy.js

+                {
+                    onyxMethod: Onyx.METHOD.SET,
+                    key: `${ONYXKEYS.COLLECTION.POLICY_DRAFTS}${policyID}`,
+                    value: null,
+                },
+                {
+                    onyxMethod: Onyx.METHOD.SET,
+                    key: `${ONYXKEYS.COLLECTION.POLICY_MEMBERS}${policyID}`,
+                    value: null,
+                },


I think updates are done in order. It seems safer to clear the draft policy at last.

s77rt · 2023-10-13T02:17:35Z

This is causing a crash if we try to access the admin/announce room offline

Screen.Recording.2023-10-13.at.3.09.35.AM.mov

gedu · 2023-10-13T08:57:29Z

This is causing a crash if we try to access the admin/announce room offline

@s77rt can you send me the steps, I'm not able to reproduce it.

I just pushed, there was a typo, I wasn't deleting the POLICY_MEMBERS_DRAFTS

s77rt · 2023-10-13T18:08:56Z

I can't reproduce the bug now. Seems working fine. Probably related to the typo

s77rt · 2023-10-13T18:14:39Z

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 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 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 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

mweb-chrome.mov

Mobile Web - Safari

mweb-safari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

s77rt · 2023-10-13T18:15:44Z

@gedu Great work! Day & night UX difference. Thanks!

marcochavezf

LGTM, thank you guys!

OSBotify · 2023-10-16T18:58:19Z

✋ 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-10-16T21:47:39Z

🚀 Deployed to staging by https://github.com/marcochavezf in version: 1.3.85-0 🚀

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

OSBotify · 2023-10-17T23:12:24Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.85-4 🚀

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

OSBotify · 2023-10-17T23:58:27Z

🚀 Deployed to staging by https://github.com/marcochavezf in version: 1.3.86-0 🚀

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

OSBotify · 2023-10-18T23:55:57Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.86-5 🚀

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

fedirjh · 2023-10-23T10:49:14Z

src/pages/workspace/WorkspacesListPage.js

@@ -194,7 +192,7 @@ function WorkspacesListPage({policies, allPolicyMembers, reimbursementAccount, u
                    accessibilityLabel={translate('workspace.new.newWorkspace')}
                    success
                    text={translate('workspace.new.newWorkspace')}
-                    onPress={() => App.createWorkspaceAndNavigateToIt('', false, '', false, !isSmallScreenWidth)}


@gedu Shouldn't we update all instances of createWorkspaceAndNavigateToIt ? Or is it intentionally updated only for this specific case? The lack of updating other occurrences has resulted in inconsistency. For example, when creating a new workspace from the global menu, it still navigates to the workspace #admins room.

Good point, I think we do not need this in the other flows either.

Transition from Workspace list to Init screen using Policy Draft info

92a6c1e

gedu changed the title ~~Transition from Workspace list to Init screen using Policy Draft info~~ [#16935] Workspace creation with Policy Draft info Oct 11, 2023

removed unused variables

fdef0d7

gedu commented Oct 11, 2023

View reviewed changes

src/pages/workspace/withPolicyAndFullscreenLoading.js Outdated Show resolved Hide resolved

rezkiy37 suggested changes Oct 11, 2023

View reviewed changes

updated by comments

11b9490

rezkiy37 approved these changes Oct 11, 2023

View reviewed changes

Rephrase comment

3228ac5

gedu marked this pull request as ready for review October 12, 2023 07:37

gedu requested a review from a team as a code owner October 12, 2023 07:37

melvin-bot bot requested review from s77rt and removed request for a team October 12, 2023 07:37

s77rt suggested changes Oct 13, 2023

View reviewed changes

Fixed comments

8fdbc4e

s77rt approved these changes Oct 13, 2023

View reviewed changes

melvin-bot bot requested a review from marcochavezf October 13, 2023 18:15

marcochavezf approved these changes Oct 16, 2023

View reviewed changes

marcochavezf merged commit e213f7e into Expensify:main Oct 16, 2023
12 checks passed

OSBotify mentioned this pull request Oct 16, 2023

Deploy Checklist: New Expensify 2023-10-16 #29717

Closed

melvin-bot bot mentioned this pull request Oct 17, 2023

[HOLD for payment 2023-10-24] [$2000] There is a delay of 1-2 seconds when a new workspace is created in the Android app. #16935

Closed

6 tasks

OSBotify mentioned this pull request Oct 17, 2023

Deploy Checklist: New Expensify 2023-10-17 #29837

Closed

fedirjh reviewed Oct 23, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[#16935] Workspace creation with Policy Draft info #29256

[#16935] Workspace creation with Policy Draft info #29256

gedu commented Oct 11, 2023 •

edited

Loading

gedu Oct 11, 2023

rezkiy37 left a comment

melvin-bot bot commented Oct 12, 2023

s77rt Oct 12, 2023

s77rt Oct 12, 2023

s77rt Oct 12, 2023

s77rt commented Oct 13, 2023

gedu commented Oct 13, 2023

s77rt commented Oct 13, 2023

s77rt commented Oct 13, 2023

s77rt commented Oct 13, 2023

marcochavezf left a comment

OSBotify commented Oct 16, 2023

OSBotify commented Oct 16, 2023

OSBotify commented Oct 17, 2023

OSBotify commented Oct 17, 2023

OSBotify commented Oct 18, 2023

fedirjh Oct 23, 2023

mountiny Oct 23, 2023

	* Create a new Draft workspace and navigate to it
	* Create a new draft workspace and navigate to it

	App.savePolicyDraftByNewWorkspace(props.policyDraft.id, props.policyDraft.name, '', false, '', !isSmallScreenWidth);
	App.savePolicyDraftByNewWorkspace(props.policyDraft.id, props.policyDraft.name, '', false);

[#16935] Workspace creation with Policy Draft info #29256

[#16935] Workspace creation with Policy Draft info #29256

Conversation

gedu commented Oct 11, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

gedu Oct 11, 2023

Choose a reason for hiding this comment

rezkiy37 left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Oct 12, 2023

s77rt Oct 12, 2023

Choose a reason for hiding this comment

s77rt Oct 12, 2023

Choose a reason for hiding this comment

s77rt Oct 12, 2023

Choose a reason for hiding this comment

s77rt commented Oct 13, 2023

gedu commented Oct 13, 2023

s77rt commented Oct 13, 2023

s77rt commented Oct 13, 2023

Reviewer Checklist

Screenshots/Videos

s77rt commented Oct 13, 2023

marcochavezf left a comment

Choose a reason for hiding this comment

OSBotify commented Oct 16, 2023

OSBotify commented Oct 16, 2023

OSBotify commented Oct 17, 2023

OSBotify commented Oct 17, 2023

OSBotify commented Oct 18, 2023

fedirjh Oct 23, 2023

Choose a reason for hiding this comment

mountiny Oct 23, 2023

Choose a reason for hiding this comment

gedu commented Oct 11, 2023 •

edited

Loading