Limit tag list to 500 items by rezkiy37 · Pull Request #31447 · Expensify/App

rezkiy37 · 2023-11-16T14:46:59Z

Details

The PR introduces a new feature for limiting a maximum count of tags. There is a requirement that a solution should be reusable.
Also, added periods to at the end of sentences - requirement.

Fixed Issues

$ #31218
PROPOSAL: N/A

Tests

Note: before testing you should have a workspace with 501 tags at least. I can add you to my own with 10k+ tags.

Long list of tags

Start the money request flow.
Open the tags page.
Verify that the "All" section has maximum 500 tags.
Verify that when exists more than 500 tags, there is "Show more" button.
Verify that on click on the button, it load 500 more tags.
Verify that on search, it works the same.
Verify that on each enter to the search bar, it resets the pagination.

Short (<= 500 and <= 8) list of tags

Start the money request flow.
Open the tags page.
Verify that there is not the "Show more" button.
Verify that it works the same as in the production.

Verify that no errors appear in the JS console

Offline tests

Same as "Tests".

QA Steps

Same as "Tests".

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android.mp4

Android: mWeb Chrome

Android.Chrome.mp4

iOS: Native

IOS.mp4

iOS: mWeb Safari

IOS.Safari.mp4

MacOS: Chrome / Safari

Chrome.mp4

MacOS: Desktop

Desktop.mp4

…ture/31218-limit-tags

This reverts commit 8e0ab70.

src/components/ShowMore/index.js

…ture/31218-limit-tags

melvin-bot · 2023-11-17T17:30:56Z

@dannymcclain @rushatgabhane One of you needs to 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]

rushatgabhane · 2023-11-20T03:35:05Z

src/components/OptionsSelector/BaseOptionsSelector.js

+    /**
+     * Calculates all exactly visible options of sections.
+     */
+    get allVisibleOptionsCount() {


get
This is new syntax. was there a discussion on it's usage?

We shouldn't use new code patterns without getting a buy-in from most of the team because it can reduce readability.

Got you, I will update it to methods.

Done - 059a302.

rushatgabhane

Looks good, left a few questions. Thank you 🙇

rushatgabhane · 2023-11-20T03:38:55Z

src/components/OptionsSelector/BaseOptionsSelector.js

+    get allVisibleOptionsCount() {
+        let count = 0;
+
+        _.forEach(this.sections, (section) => {


did you mean this.props.sections?

i can't find sections being defined anywhere in the class. Is it the get syntax binding it to the class?

Suggested change

_.forEach(this.sections, (section) => {

_.forEach(this.props.sections, (section) => {

Yes, it is the get syntax. I will update it in order of removing the get.

Done - 059a302.

rushatgabhane · 2023-11-20T03:39:20Z

src/components/OptionsSelector/BaseOptionsSelector.js

                optionHoveredStyle={this.props.optionHoveredStyle}
                onSelectRow={this.props.onSelectRow ? this.selectRow : undefined}
-                sections={this.props.sections}
+                sections={this.sections}


Same - #31447 (comment).

Done - 059a302.

rushatgabhane · 2023-11-20T03:53:38Z

src/components/TagPicker/tagPickerPropTypes.js

    /** Should show the selected option that is disabled? */
    shouldShowDisabledAndSelectedOption: PropTypes.bool,
+
+    /** Safe area insets required for mobile devices margins */


I think we can modify this comment to explain why and how we should use this required prop.
I would have suggested something but I don't understand this prop 😅

It is simple insets from safe area. It is a common RN feature. Anyway, I will try to describe comments.

Done - 19ff8d8.

dannymcclain · 2023-11-20T13:28:36Z

@rezkiy37 would you mind adding me to your 10,000-tag workspace?

rezkiy37 · 2023-11-20T14:49:55Z

@dannymcclain, sure. Please send me your login (email).

…ture/31218-limit-tags

dannymcclain

Please note that I am reviewing this from a design standpoint. Technical reviews should still be done by those qualified to do them (aka not me). It's looking good!

…ture/31218-limit-tags

rezkiy37 · 2023-11-21T13:59:04Z

@rushatgabhane, the PR is ready for re-review

puneetlath · 2023-11-21T16:21:20Z

src/CONST.ts

        LINK: 'https://join.my.expensify.com',
    },
+
+    MAX_COUNT_OF_TAGS: 500,


I think we should set this max for anything that uses this optionList component - categories, tags, etc. Not just tags.

So, you mean to set this limit by default? Right now it works like a property we can pass.

That's what I was thinking yeah. Though I'm not sure all the places this component is used, so it'd be good to sanity-check that it makes sense.

I can find all places and will post it here.

So, @puneetlath, the component is BaseOptionsSelector and being used for 8 cases: Category Picker, Tag Picker, Money Request participant, Split Bill participant, Search, Start Chat. Task Assign, Task Share.

Screenshoots

Obviously, I've tried to test the limitation. Actually, I like how it works for all cases.
Note: for this video I've changed the limitation to 10 items per page. You can also set any value.

Example.mp4

Added a commit - b08423a.

cc @rushatgabhane

And it'll be nice that any field that uses the options selector in the future, will automatically have this "show more" button built in. I don't even think we need to make it a prop. We could just make it a feature of that component. If in the future someone wants to make it configurable, then they can add it as a prop.

Exactly, agree.

So, updating... Thank you for quick feedback 😉

Done - 96c23a4.

I love the consistency in behavior across all these screens! 🙌

Looks like we are all aligned, so waiting on the review. @rushatgabhane, your turn 😉

rushatgabhane · 2023-11-21T19:55:09Z

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

Android: Native

Android: mWeb Chrome

iOS: Native

8e96d538-effc-4580-b637-3f81268d4c9d.mp4

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2023-11-22.at.01.38.40.mov

MacOS: Desktop

…ture/31218-limit-tags

puneetlath

Great job with this! Just a handful of comments. Not so much about the code, but mostly about the comments and making the code more understandable.

src/CONST.ts

src/components/OptionsSelector/BaseOptionsSelector.js

src/components/ShowMore/index.js

src/components/OptionsSelector/BaseOptionsSelector.js

OSBotify · 2023-11-27T19:29:06Z

✋ 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-11-30T12:15:12Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.5-7 🚀

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

c3024 · 2024-01-29T18:01:28Z

src/components/MoneyRequestConfirmationList.js

-                    <View style={[styles.shortTermsHorizontalRule, styles.flex1, styles.ml0]} />
-                </View>
+                <ShowMoreButton
+                    containerStyle={styles.mt1}


Bottom margin missed here which caused #33758

rezkiy37 added 12 commits November 14, 2023 15:05

add a limit const

c570773

implement a limit

8e0ab70

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fea…

f12d261

…ture/31218-limit-tags

Revert "implement a limit"

a5c9de5

This reverts commit 8e0ab70.

Create ShowMore component

5d07521

add strings

c8928e7

add ability to pass footer to OptionsList

653deac

integrate pagination for OptionsSelector

b95cf0e

rename a const

a820d4e

integrate inserts for TagPicker and enable pagination

ffd144e

reuse ShowMore

82c9f1c

allow pass container style for ShowMore

a1a62c7

koko57 reviewed Nov 16, 2023

View reviewed changes

src/components/ShowMore/index.js Outdated Show resolved Hide resolved

rezkiy37 added 5 commits November 17, 2023 16:09

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fea…

0bcc5a9

…ture/31218-limit-tags

add periods

09e72c7

remove empty lines

e2d780d

calculate all visible options

19ca4ac

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fea…

2cde176

…ture/31218-limit-tags

rezkiy37 mentioned this pull request Nov 17, 2023

[HOLD for payment 2023-12-07] [Wave 6: Tags] Limit tag list to 500 items #31218

Closed

rezkiy37 marked this pull request as ready for review November 17, 2023 17:30

rezkiy37 requested a review from a team as a code owner November 17, 2023 17:30

melvin-bot bot requested review from dannymcclain and rushatgabhane and removed request for a team November 17, 2023 17:30

rushatgabhane reviewed Nov 20, 2023

View reviewed changes

rushatgabhane suggested changes Nov 20, 2023

View reviewed changes

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fea…

c29740a

…ture/31218-limit-tags

dannymcclain previously approved these changes Nov 20, 2023

View reviewed changes

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fea…

1de984d

…ture/31218-limit-tags

rezkiy37 dismissed dannymcclain’s stale review via 1de984d November 21, 2023 09:18

puneetlath reviewed Nov 21, 2023

View reviewed changes

rezkiy37 added 5 commits November 22, 2023 16:59

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fea…

0f794ec

…ture/31218-limit-tags

integrate limitation generally

b08423a

fix component did update

9520db9

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fea…

3234a9b

…ture/31218-limit-tags

convert to built in feature

96c23a4

rushatgabhane approved these changes Nov 24, 2023

View reviewed changes

melvin-bot bot requested a review from puneetlath November 24, 2023 07:35

puneetlath requested changes Nov 24, 2023

View reviewed changes

rezkiy37 added 4 commits November 25, 2023 14:50

rename const

f99086a

minor updates BaseOptionsSelector

49154ff

rename ShowMoreButton

b4d1537

clarify comments

1080ca0

rezkiy37 requested a review from puneetlath November 25, 2023 14:08

puneetlath requested changes Nov 27, 2023

View reviewed changes

src/components/OptionsSelector/BaseOptionsSelector.js Outdated Show resolved Hide resolved

clarify comment

c4f1f63

rezkiy37 requested a review from puneetlath November 27, 2023 19:14

puneetlath approved these changes Nov 27, 2023

View reviewed changes

puneetlath merged commit c00b840 into Expensify:main Nov 27, 2023

github-actions bot mentioned this pull request Nov 29, 2023

Deploy Checklist: New Expensify 2023-11-29 #32175

Closed

55 tasks

Pujan92 mentioned this pull request Jan 18, 2024

[$500] Tag - "Show more" button does not expand the list when clicked on #34761

Closed

6 tasks

c3024 reviewed Jan 29, 2024

View reviewed changes

c3024 mentioned this pull request Jan 29, 2024

[HOLD for payment 2024-01-24] [$500] Split bill - No bottom margin for "Show more" button on IOU details page #33758

Closed

6 tasks

	_.forEach(this.sections, (section) => {
	_.forEach(this.props.sections, (section) => {

Conversation

rezkiy37 commented Nov 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Long list of tags

Short (<= 500 and <= 8) list of tags

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

Uh oh!

melvin-bot bot commented Nov 17, 2023

Uh oh!

rushatgabhane Nov 20, 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rushatgabhane left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dannymcclain commented Nov 20, 2023

Uh oh!

rezkiy37 commented Nov 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dannymcclain left a comment

Choose a reason for hiding this comment

Uh oh!

rezkiy37 commented Nov 21, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rezkiy37 Nov 22, 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rushatgabhane commented Nov 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

rezkiy37 commented Nov 16, 2023 •

edited

Loading

rushatgabhane Nov 20, 2023 •

edited

Loading

rezkiy37 commented Nov 20, 2023 •

edited

Loading

rezkiy37 Nov 22, 2023 •

edited

Loading

rushatgabhane commented Nov 21, 2023 •

edited

Loading