Skip to content

fix: incorrect format of search query string #58362

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

Merged
merged 3 commits into from
Mar 27, 2025
Merged

Conversation

daledah
Copy link
Contributor

@daledah daledah commented Mar 13, 2025

Explanation of Change

Fixed Issues

$ #57696
PROPOSAL: #57696 (comment)

Tests

  1. Go to reports -> Filter
  2. Select filter for Date and Total
  3. Click save search
  4. On small screens, click bookmark icon
  5. On the saved search, click three dot menu
  6. Click rename
  7. Verify that: The name is displayed correctly with no extra spaces.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Go to reports -> Filter
  2. Select filter for Date and Total
  3. Click save search
  4. On small screens, click bookmark icon
  5. On the saved search, click three dot menu
  6. Click rename
  7. Verify that: The name is displayed correctly with no extra spaces.
  • 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
Screen.Recording.2025-03-13.at.18.05.22.mov
Android: mWeb Chrome
Screen.Recording.2025-03-13.at.20.37.53.mov
iOS: Native
Screen.Recording.2025-03-13.at.18.02.00.mov
iOS: mWeb Safari
Screen.Recording.2025-03-13.at.18.03.25.mov
MacOS: Chrome / Safari
Screen.Recording.2025-03-13.at.20.35.55.mov
MacOS: Desktop
Screen.Recording.2025-03-13.at.18.04.08.mov

@daledah daledah marked this pull request as ready for review March 13, 2025 11:35
@daledah daledah requested a review from a team as a code owner March 13, 2025 11:35
@melvin-bot melvin-bot bot requested review from dominictb and removed request for a team March 13, 2025 11:35
Copy link

melvin-bot bot commented Mar 13, 2025

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

@daledah
Copy link
Contributor Author

daledah commented Mar 13, 2025

@dominictb I'm currently experiencing 429 errors when trying to login, I'll upload the missing screenshots later when the error is gone.

@daledah
Copy link
Contributor Author

daledah commented Mar 13, 2025

All the screenshots are uploaded.


expect(result).toEqual(`${defaultQuery} from:9876,87654 to:78901 amount:15000 hello test`);
describe('buildQueryStringFromFilterFormValues', () => {
Copy link
Contributor

Choose a reason for hiding this comment

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

@daledah Can you add another test case: should filter out empty values so the query contains no redundant spaces

Copy link
Contributor

Choose a reason for hiding this comment

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

And another case: should trim redundant zero decimals from amount

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think empty values are filtered out before the logics are called, so we need to test a different function here.
Zero decimals IMO are not trimmed by default, as we use cents in currency values.

@dominictb
Copy link
Contributor

dominictb commented Mar 13, 2025

@daledah Please update the second step in your Tests to:

Select filter for `Date` and `Total``

That's enough to reproduce the issue.

@dominictb
Copy link
Contributor

Also as per OP:

The Total field should display the amount exactly as entered without any additional zeros
All filter details should have consistent spacing, including the Total field

We have just fixed the spacing bug, the additional zeros bug has not:

Screenshot 2025-03-14 at 01 19 52

@daledah
Copy link
Contributor Author

daledah commented Mar 16, 2025

@dominictb I believe it's a BE bug, when the query string is too long the BE seems to cut short the name string:

Screenshot 2025-03-16 at 21 48 38

You can see the date filters are cut off.

This behavior makes the name and query is not equal, and the following logic is not triggered:

let title = item.name;
if (title === item.query) {
const jsonQuery = buildSearchQueryJSON(item.query) ?? ({} as SearchQueryJSON);
title = buildUserReadableQueryString(jsonQuery, personalDetails, reports, taxRates, allCards, cardFeedNamesWithType);
}

So the name of the query will not be parsed to user readable values.

cc @blimpich - Is this behavior expected in the BE?

@blimpich
Copy link
Contributor

Ah yeah that does seem like a backend bug. I'm not super familiar with that part of the backend. @daledah After what action/call does the backend make the data get cut off? Is it after calling the SaveSearch command?

@daledah
Copy link
Contributor Author

daledah commented Mar 17, 2025

@blimpich Yes that's correct

@blimpich
Copy link
Contributor

cc: @lakchote since you wrote the SaveSearch command, can you confirm if this is a BE bug? We shouldn't be cutting the date filters off short correct?

@lakchote
Copy link
Contributor

cc: @lakchote since you wrote the SaveSearch command, can you confirm if this is a BE bug? We shouldn't be cutting the date filters off short correct?

To confirm if this is BE related or not, @daledah could you please give the value of the newName parameter when the API call is made?

The SaveSearch command doesn't do any processing on the name parameter, it just returns it in the response if it's specified.

@daledah
Copy link
Contributor Author

daledah commented Mar 18, 2025

@lakchote Here's the request param for SaveSearch. Note that it's on staging so extra white spaces are shown on newName

Screenshot 2025-03-18 at 14 03 37

And here's the response:

Screenshot 2025-03-18 at 14 04 35

@lakchote
Copy link
Contributor

@lakchote Here's the request param for SaveSearch. Note that it's on staging so extra white spaces are shown on newName

Thank you. This is indeed BE related.

I've created an issue and assigned myself to it.

@blimpich
Copy link
Contributor

Thank you Lucien!!

@dominictb
Copy link
Contributor

@lakchote Keep us up to date when that PR is done. Thanks!

@lakchote
Copy link
Contributor

@lakchote Keep us up to date when that PR is done. Thanks!

PR is under review.

@blimpich
Copy link
Contributor

PR was merged. Will get deployed to staging on Monday and to production on Tuesday 👍

@dominictb
Copy link
Contributor

The query name trimming issue seems resolved on staging. I'll proceed checklist and review this PR anyway.

@dominictb
Copy link
Contributor

dominictb commented Mar 25, 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

Screenshot_1743089612

Android: mWeb Chrome
Screen.Recording.2025-03-27.at.22.31.36.mov
iOS: Native
Screen.Recording.2025-03-27.at.22.26.16.mov
iOS: mWeb Safari
Screen.Recording.2025-03-27.at.22.28.05.mov
MacOS: Chrome / Safari

Screenshot 2025-03-27 at 22 24 39
Screenshot 2025-03-27 at 22 24 35

MacOS: Desktop

Screenshot 2025-03-27 at 22 25 21
Screenshot 2025-03-27 at 22 25 18

@dominictb
Copy link
Contributor

dominictb commented Mar 25, 2025

@daledah BUG: Cannot save new query name with date after & before filters:

Screen.Recording.2025-03-25.at.14.41.44.mov

@dominictb
Copy link
Contributor

BUG: I only see the fix in this PR applied to the newly created queries, not the existing ones. Can you check why?

@blimpich
Copy link
Contributor

FYI the backend fix is deployed to production now 👍

@daledah
Copy link
Contributor Author

daledah commented Mar 27, 2025

BUG: Cannot save new query name with date after & before filters:

@dominictb This bug appears on production as well:

Screen.Recording.2025-03-27.at.21.41.10.mov

BUG: I only see the fix in this PR applied to the newly created queries, not the existing ones.

We only apply the fix to before saving the search. I don't think there's any logics to modify existing saved searches other than its name at the moment, changing the filters will only create new saved search.

@dominictb
Copy link
Contributor

BUG: Cannot save new query name with date after & before filters:

Reported this bug on Slack here

Copy link
Contributor

@dominictb dominictb left a comment

Choose a reason for hiding this comment

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

Except for this existing bug here, we're all good.

🎀👀🎀

@melvin-bot melvin-bot bot requested a review from blimpich March 27, 2025 15:35
Copy link
Contributor

@blimpich blimpich left a comment

Choose a reason for hiding this comment

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

👍

@blimpich blimpich merged commit c33ce2a into Expensify:main Mar 27, 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.

Copy link
Contributor

🚀 Deployed to staging by https://github.com/blimpich in version: 9.1.21-0 🚀

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

@daledah
Copy link
Contributor Author

daledah commented Mar 31, 2025

@izarutskaya You can select only the after date and bigger and smaller total value. It should not have any errors.

Copy link
Contributor

github-actions bot commented Apr 1, 2025

🚀 Deployed to production by https://github.com/grgia in version: 9.1.21-3 🚀

platform result
🖥 desktop 🖥 success ✅
🕸 web 🕸 success ✅
🤖 android 🤖 failure ❌
🍎 iOS 🍎 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.

6 participants