Skip to content

[No QA]Method to generate default workspace name#10563

Merged
MonilBhavsar merged 10 commits into
mainfrom
justice-default-workspace-name
Aug 31, 2022
Merged

[No QA]Method to generate default workspace name#10563
MonilBhavsar merged 10 commits into
mainfrom
justice-default-workspace-name

Conversation

@Justicea83

@Justicea83 Justicea83 commented Aug 25, 2022

Copy link
Copy Markdown
Contributor

Details

Fixed Issues

$https://github.com/Expensify/Expensify/issues/224684

Tests

  • Tests will be addressed in a separate PR

PR Review Checklist

PR Reviewer Checklist

The Contributor+ will copy/paste it into a new comment and complete it after the author checklist is completed

  • 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 verified tests pass on all platforms & I tested again on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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 */
    • Any functional components have the displayName property
    • 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 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

QA Steps

  • N/A

Screenshots

N/A

Web

N/A

Mobile Web

N/A

Desktop

N/A

iOS

N/A

Android

N/A

@Justicea83 Justicea83 self-assigned this Aug 25, 2022
@Justicea83 Justicea83 marked this pull request as ready for review August 25, 2022 12:56
@Justicea83 Justicea83 requested a review from a team as a code owner August 25, 2022 12:56
@melvin-bot melvin-bot Bot requested review from MonilBhavsar and removed request for a team August 25, 2022 12:56
@thienlnam thienlnam self-requested a review August 25, 2022 16:18

@thienlnam thienlnam left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking solid - we are missing a check for multiples though

For example, if you already have a policy name
My Group Workspace, creating another default one should be My Group Workspace 1

Comment thread tests/unit/PolicyTest.js Outdated
@Justicea83 Justicea83 requested a review from thienlnam August 26, 2022 10:56
@Justicea83

Copy link
Copy Markdown
Contributor Author

Updated and awaiting another review

Comment thread src/libs/actions/Policy.js Outdated
Comment thread src/libs/actions/Policy.js Outdated
Comment thread src/libs/actions/Policy.js Outdated
Comment thread src/libs/actions/Policy.js Outdated
Comment thread src/libs/actions/Policy.js Outdated
Comment thread src/libs/actions/Policy.js
Comment thread tests/unit/PolicyTest.js Outdated
@@ -1,104 +1,65 @@
import * as Policy from '../../src/libs/actions/Policy';

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you not just create a variable here called allPolicies that would have the policy details that it would grab from? Haven't tried this yet so not sure though

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This wouldn't work. I went ahead and added a second parameter to the method, which is passed down from the tests

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There should be a way to mock local variables in jest from this brief google search - maybe setting this.allPolicies or window.allPolicies?

We don't want to adjust the code just so that we can pass testing parameters through it

@Justicea83 Justicea83 requested a review from thienlnam August 30, 2022 12:55

@thienlnam thienlnam left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it's too difficult to add tests right now, we can create a separate PR later that adds them back

Comment thread src/libs/actions/Policy.js Outdated
* @param {Array} polices
* @returns {String}
*/
function generateDefaultWorkspaceName(email, polices = null) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, the preference is that we don't need to pass any parameters at all. This makes it so that wherever we call this method we need to connect to onyx to get all policies and the session email

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Comment thread src/libs/actions/Policy.js Outdated
Comment on lines +780 to +785
let userPolicies = null;
if (!polices) {
userPolicies = allPolicies;
} else {
userPolicies = polices;
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, we don't want this code since it is just specific to tests

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Comment thread src/libs/actions/Policy.js
Comment thread src/libs/actions/Policy.js Outdated
Comment thread tests/unit/PolicyTest.js Outdated
@@ -1,104 +1,65 @@
import * as Policy from '../../src/libs/actions/Policy';

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There should be a way to mock local variables in jest from this brief google search - maybe setting this.allPolicies or window.allPolicies?

We don't want to adjust the code just so that we can pass testing parameters through it

@thienlnam thienlnam left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything else looks good, did you merge main?

Comment thread src/libs/actions/Policy.js Outdated
Comment on lines +755 to +763
/**
* Checks if we have any errors stored within the POLICY_MEMBER_LIST. Determines whether we should show a red brick road error or not
* Data structure: {email: {role:'bla', errors: []}, email2: {role:'bla', errors: [{1231312313: 'Unable to do X'}]}, ...}
* @param {Object} policyMemberList
* @returns {Boolean}
*/
function hasPolicyMemberError(policyMemberList) {
return _.some(policyMemberList, member => !_.isEmpty(member.errors));
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How are these showing as your new changes? 😮

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because there was a merge conflict

@thienlnam thienlnam left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should actually be removing those changes since it does not exist in that file on main anymore

@thienlnam

Copy link
Copy Markdown
Contributor

cc @MonilBhavsar could we please get a review here?

@MonilBhavsar MonilBhavsar merged commit 8c7f8b9 into main Aug 31, 2022
@MonilBhavsar MonilBhavsar deleted the justice-default-workspace-name branch August 31, 2022 08:17
@OSBotify

Copy link
Copy Markdown
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

* @param {String} value
* @returns {String}
*/
function capitalizeFirstLetter(value) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does not really feel like this function belongs here.. more importantly, this function already exists: https://github.com/Expensify/expensify-common/blob/main/lib/str.js#L327 -- please change the code to use that instead 🙇

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was this updated?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR was created to remove the out of place method

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by @MonilBhavsar in version: 1.1.95-0 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants