Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create CreateCategoryPage #37704

Merged
merged 27 commits into from
Mar 6, 2024
Merged

Conversation

luacmartins
Copy link
Contributor

@luacmartins luacmartins commented Mar 4, 2024

Details

Adds the ability to create categories

Fixed Issues

$ #35710

Tests

  1. As a Collect policy admin, navigate to Settings > Workspace > Categories
  2. Verify that you can see the Add category button at the top of the screen
  3. Press the button and verify that the RHP opens up with a text input for Category name
  4. Press Save without any name and verify that you see an error
  5. Enter a category name and press Save
  6. Verify that the category is created and you can see it in the list
  • Verify that no errors appear in the JS console

Offline tests

  1. As a Collect policy admin, navigate to Settings > Workspace > Categories
  2. Go offline
  3. Press the Add category button
  4. Enter a category name and press Save
  5. Verify that the category is created and you can see it in the list with 50% opacity
  6. Go back online
  7. Verify that the category is no longer with 50% opacity

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: 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 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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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
chrome.mov
iOS: Native
ios.mov
iOS: mWeb Safari
safari.mov
MacOS: Chrome / Safari
safari.mov
MacOS: Desktop
desktop.mov

@luacmartins luacmartins self-assigned this Mar 4, 2024
@luacmartins luacmartins marked this pull request as ready for review March 5, 2024 18:34
@luacmartins luacmartins requested a review from a team as a code owner March 5, 2024 18:34
@melvin-bot melvin-bot bot requested review from mananjadhav and removed request for a team March 5, 2024 18:34
Copy link

melvin-bot bot commented Mar 5, 2024

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

@luacmartins
Copy link
Contributor Author

@Expensify/design

@shawnborton
Copy link
Contributor

When we land in the "Add category" page (RHP), I think the input should auto-focus:

CleanShot 2024-03-05 at 13 38 40@2x

@shawnborton
Copy link
Contributor

Why doesn't more of the page scroll? I think I would expect almost everything besides the page header to scroll here... perhaps even the buttons should be scrolling.

CleanShot 2024-03-05 at 13 39 27@2x

@luacmartins
Copy link
Contributor Author

luacmartins commented Mar 5, 2024

Added autofocus.

Why doesn't more of the page scroll? I think I would expect almost everything besides the page header to scroll here... perhaps even the buttons should be scrolling.

@shawnborton Not sure if we ever discussed what's scrollable here. I'd say that we should tackle that as a separate issue since the scope of this PR is to add the Create category functionality and we're not changing the current scrolling behavior we have on main. I can create an issue for it if you'd like.

Copy link

melvin-bot bot commented Mar 5, 2024

@youssef-lr 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]

@youssef-lr
Copy link
Contributor

youssef-lr commented Mar 6, 2024

@luacmartins a minor polish item, new categories are always added to the bottom optimistically and are not sorted alphabetically, while the backend sends them sorted. I think we should match the backend behavior no?

Screen.Recording.2024-03-06.at.17.53.56.mov

Co-authored-by: Youssef Lourayad <youssef@expensify.com>
@luacmartins
Copy link
Contributor Author

@youssef-lr we have a new pattern that will add the cateegory, scroll and highlight it, but that will be implemented as part of #35717 for members and then we'll use the same solution for categories

@luacmartins
Copy link
Contributor Author

@youssef-lr updated!

@youssef-lr
Copy link
Contributor

we have a new pattern that will add the cateegory, scroll and highlight it

Oh so it's intentional that we'll not sort them and just add it to the bottom? even though after a refresh it will move?

@youssef-lr
Copy link
Contributor

youssef-lr commented Mar 6, 2024

@luacmartins FWIW I think it's a simple fix to just add .sort((a, b) => localeCompare(a.name, b.name)) here if we still want them sorted (if the list is long, we can still scroll to their position while they're still sorted and not necessarily in the bottom, later on when we implement that pattern). I won't block on this though.

Screenshot 2024-03-06 at 18 30 13

@luacmartins
Copy link
Contributor Author

Ah lol I never pushed the change 😓 Ok pushed the change with useCallback and your sorting suggestion too

youssef-lr
youssef-lr previously approved these changes Mar 6, 2024
Copy link
Contributor

@youssef-lr youssef-lr left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for the changes!

youssef-lr
youssef-lr previously approved these changes Mar 6, 2024
@luacmartins luacmartins merged commit bc655ed into main Mar 6, 2024
16 checks passed
@luacmartins luacmartins deleted the cmartins-CreateWorkspaceCategoriesPage branch March 6, 2024 18:08
@OSBotify
Copy link
Contributor

OSBotify commented Mar 6, 2024

✋ 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
Copy link
Contributor

OSBotify commented Mar 6, 2024

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.4.48-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Mar 7, 2024

🚀 Deployed to production by https://github.com/roryabraham in version: 1.4.48-0 🚀

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

fill={theme.icon}
/>
Object.values(policyCategories ?? {})
.sort((a, b) => localeCompare(a.name, b.name))
Copy link
Contributor

Choose a reason for hiding this comment

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

(BZ checklist) for consistency with Olddot we decided to use lodashSortBy in #44922

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants