Skip to content

fix: show error for tag when create expense#57370

Merged
dangrous merged 15 commits intoExpensify:mainfrom
nkdengineer:fix/56646
Mar 19, 2025
Merged

fix: show error for tag when create expense#57370
dangrous merged 15 commits intoExpensify:mainfrom
nkdengineer:fix/56646

Conversation

@nkdengineer
Copy link
Contributor

@nkdengineer nkdengineer commented Feb 25, 2025

Explanation of Change

Fixed Issues

$ #56646
PROPOSAL: #56646 (comment)

Tests

  1. Go to workspace settings
  2. Create a new category with max characters
  3. Members must categorise all expenses toggle on
  4. Try to create an expense with category selected ( select category with max characters)
  5. Tap create expense
  6. Verify that: with max characters category selected there is no error
  7. Do the same with tags and verify that: with max characters tag selected there is no error
  • Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."
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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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.mov
Android: mWeb Chrome
android-mweb.mov
iOS: Native
ios-mweb.mov
iOS: mWeb Safari
ios-mweb.mov
MacOS: Chrome / Safari
web-resize.mp4
MacOS: Desktop
desktop.mov

@nkdengineer nkdengineer marked this pull request as ready for review February 25, 2025 16:25
@nkdengineer nkdengineer requested a review from a team as a code owner February 25, 2025 16:25
@melvin-bot melvin-bot bot requested review from eVoloshchak and removed request for a team February 25, 2025 16:25
@melvin-bot
Copy link

melvin-bot bot commented Feb 25, 2025

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

Copy link
Contributor

@eVoloshchak eVoloshchak left a comment

Choose a reason for hiding this comment

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

Aha, after re-testing this flow, I now understand the first part of your proposal. There is a different character limit when creating a tag name (CATEGORY_NAME_LIMIT: 256) and when creating an expense (API_TRANSACTION_CATEGORY_MAX_LENGTH: 255), and the same is true for tags. This isn't correct, let's indeed fix this. We can remove CATEGORY_NAME_LIMIT and use API_TRANSACTION_CATEGORY_MAX_LENGTH in CategoryForm (and the same for tags)

This, in turn, would mean the QA will not be able to trigger an error when creating an expense, or am I missing something?

@nkdengineer
Copy link
Contributor Author

@eVoloshchak i updated the code change and steps. Please check again

@eVoloshchak
Copy link
Contributor

Thanks!
I think we still need the invalidTagLength error handler in MoneyRequestConfirmationList's "confirm" method (it won't be required under normal circumstances as users can't create a tag/category with invalid length), but it's still useful for tags that were created before and might have a longer name

@nkdengineer
Copy link
Contributor Author

@eVoloshchak I tried with tag length 256, and it is still valid with createExpense API. hmm should we add limit to tag here?

@eVoloshchak
Copy link
Contributor

hmm should we add limit to tag here?

Yes, let's still add it, the same as we do for categories (the logic from the initial version of this PR). If we're setting a limit on the input, I think it's reasonable to check for it on expense creation too for consistency, even if there is no check for it on the backend (we might add it though, I'll raise a discussion in a bit)

@nkdengineer
Copy link
Contributor Author

@eVoloshchak i updated

@nkdengineer
Copy link
Contributor Author

@eVoloshchak I think we should not change to function in this case.

  1. With error messages like this, our app still uses hardcoded translation strings.
  2. In MoneyRequestConfirmationList component, we handle error by state here and with no params in TranslationPaths. If we change it to a function, it will break here.

const [formError, debouncedFormError, setFormError] = useDebouncedState<TranslationPaths | ''>('');

setFormError('iou.error.invalidCategoryLength');

@eVoloshchak
Copy link
Contributor

With error messages like this, our app still uses hardcoded translation strings.

I don't completely agree with this, many error messages don't (for instance, characterLimit/characterLimitExceedCounter)
And it remains a better approach, so if it costs nothing, we might implement it. The problem is, it will cost a fair bit of time

In MoneyRequestConfirmationList component, we handle error by state here and with no params in TranslationPaths. If we change it to a function, it will break here.

That is true. This can be resolved, but is not worth it at all. Proceeding

@eVoloshchak
Copy link
Contributor

eVoloshchak commented Mar 4, 2025

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • 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 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.ts 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • 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.2025-03-13.at.22.18.23.mov
Android: mWeb Chrome
Screen.Recording.2025-03-13.at.22.15.27.mov
iOS: Native
Screen.Recording.2025-03-13.at.22.10.22.mov
iOS: mWeb Safari
Screen.Recording.2025-03-13.at.22.14.06.mov
MacOS: Chrome / Safari
Screen.Recording.2025-03-13.at.22.07.20.mov
MacOS: Desktop
Screen.Recording.2025-03-13.at.22.08.32.mov

Copy link
Contributor

@eVoloshchak eVoloshchak left a comment

Choose a reason for hiding this comment

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

@nkdengineer, the code looks good!

There are a couple of things that could be improved in the PR author checklist:

  • The test steps only include testing for error handling for categories, but not for tags. Could you please add the steps to test this for tags too?
  • The last testing step is "Verify that: with max characters category selected there is no error", but all screenshots in Screenshots/Videos section contain a page with "Tag name exceeds the limit" error

@nkdengineer
Copy link
Contributor Author

thanks @eVoloshchak, i updated the steps and all the screenshots

Copy link
Contributor

@eVoloshchak eVoloshchak left a comment

Choose a reason for hiding this comment

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

@nkdengineer, could you resolve the conflicts here please? The code and the checklist are looking good, will do the last sweep of tests tomorrow

@nkdengineer
Copy link
Contributor Author

@eVoloshchak i resolved

Copy link
Contributor

@eVoloshchak eVoloshchak left a comment

Choose a reason for hiding this comment

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

There's an inconsistency between creating categories and tags:

  • For categories, you cannot enter a name longer than 255
  • For tags, you can enter a tag name of any length, but it will show an error (character limit exceeded)
Screen.Recording.2025-03-11.at.12.28.38.mov

Another issue is that you can create a tag with a name length of 256, but when submitting an expense, you get an error saying it should be 255 max

Screen.Recording.2025-03-11.at.12.29.42.mov

@nkdengineer
Copy link
Contributor Author

There's an inconsistency between creating categories and tags:
Another issue is that you can create a tag with a name length of 256, but when submitting an expense, you get an error saying it should be 255 max

@eVoloshchak I fixed

Copy link
Contributor

@eVoloshchak eVoloshchak left a comment

Choose a reason for hiding this comment

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

LGTM!

@melvin-bot melvin-bot bot requested a review from dangrous March 13, 2025 21:21
Copy link
Contributor

@dangrous dangrous left a comment

Choose a reason for hiding this comment

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

Code looks good, but did we confirm the Spanish translations in #expensify-open-source? Asking because they are different from the message about categories, and I'm guessing they should be essentially the same. If not, could we do that please? Thanks!

@eVoloshchak
Copy link
Contributor

Good point, asking for confirmation here: https://expensify.slack.com/archives/C01GTK53T8Q/p1741975219191719

nkdengineer and others added 3 commits March 18, 2025 14:52
@nkdengineer
Copy link
Contributor Author

@eVoloshchak i updated, please check again

@dangrous dangrous merged commit e6f0355 into Expensify:main Mar 19, 2025
17 checks passed
@OSBotify
Copy link
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.

@github-actions
Copy link
Contributor

🚀 Deployed to staging by https://github.com/dangrous in version: 9.1.16-0 🚀

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

@izarutskaya
Copy link

@nkdengineer QA found issue #58816

@dangrous
Copy link
Contributor

Is there another place we needed to update the constant? re: #58816

@github-actions
Copy link
Contributor

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

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

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.

6 participants