Search parser grammar update #47328

289Adam289 · 2024-08-13T14:05:47Z

Details

Fixed Issues

$#47095
$#46993
PROPOSAL:

Tests

visit route /search/filters
test keyword and other filters
confirm whether navigation behaves correctly
confirm whether right query is sent

Verify that no errors appear in the JS console

Offline tests

QA Steps

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 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.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 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.
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

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-08-14.at.13.09.18.mp4

MacOS: Desktop

desktop.mp4

SzymczakJ

LGTM

melvin-bot · 2024-08-14T11:12:38Z

@ikevin127 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 · 2024-08-14T16:36:48Z

src/libs/SearchParser/searchParser.peggy

+     const keywords = allFilters.filter((filter) => filter.left === "keyword" || filter.right?.left === "keyword")
+     const nonKeywords = allFilters.filter((filter) => filter.left !== "keyword" && filter.right?.left !== "keyword")
+     if(!nonKeywords.length){
+     	return keywords.reduce((result, filter) => buildFilter("or", result, filter))
+     }
+     if(!keywords.length){
+     	return nonKeywords.reduce((result, filter) => buildFilter("and", result, filter))
+     }
+
+     return buildFilter("and", keywords.reduce((result, filter) => buildFilter("or", result, filter)), nonKeywords.reduce((result, filter) => buildFilter("and", result, filter)))
+


I wonder if we could implement this as part of a rule, instead of plain JS. Anyways, NAB for now.

ikevin127 · 2024-08-14T19:55:21Z

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 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.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(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.
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.webm

Android: mWeb Chrome

android-mweb.webm

iOS: Native

ios.mp4

iOS: mWeb Safari

ios-mweb.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

ikevin127 · 2024-08-15T01:33:56Z

@289Adam289 I checked out the PR branch, ran npm ci for a clean install and I am not able to test the PR because on the Search page, any of the tabs display blank page on the central pane:

web.mov

Not sure what causes this, the data is there, it's just not being displayed for some reason. Looks like something weird is happening with the URL when clicking on Expenses again after the initial search page load (this happens on staging as well though 🤔), I'm assuming this might be related to the search parser changes❔

Note: I made sure to check this with StrictMode off as well and it still happens, only on this PR.
If this happens only on my side, maybe we could have somebody else pull the branch to check if this is happening 🤔

luacmartins · 2024-08-15T01:43:04Z

@ikevin127 I'm away from my computer so I can't test right now. Do you see any console errors? If the parser is failing it should output an error to the console

luacmartins · 2024-08-15T01:44:06Z

Ah maybe it's because we update the API to send the type as expense instead of transaction/report and this branch is not up to date with main to handle the expense type

ikevin127 · 2024-08-15T01:56:47Z

Do you see any console errors? If the parser is failing it should output an error to the console

❌ No console errors or warnings that are not on staging as well.

My thinking was to suggest a sync w/ main as well, to make sure we're up to date 👍

Ah maybe it's because we update the API to send the type as expense instead of transaction/report and this branch is not up to date with main to handle the expense type

Wouldn't this mean that staging would be broken as well ? 🤔

289Adam289 · 2024-08-19T07:46:00Z

I think it's working now

luacmartins · 2024-08-19T13:24:28Z

Nice! @ikevin127 ready for you to test this again.

ikevin127

LGTM 🚀 tests well -> issue was fixed ✅

luacmartins

LGTM

melvin-bot · 2024-08-20T13:47:29Z

Congrats, that’s your 5th PR merged! 🎉 Do you know about the ContributorPlus role? It’s an opportunity to earn more in the Expensify Open Source community. Keep up the great work - thanks!

OSBotify · 2024-08-20T14:06:39Z

✋ 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 · 2024-08-20T22:58:40Z

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

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

OSBotify · 2024-08-22T17:12:04Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 9.0.23-0 🚀

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

289Adam289 added 2 commits August 13, 2024 13:57

Add semicolon to grammr and impprove ast

703cf32

fix typoes

39f5d26

289Adam289 mentioned this pull request Aug 14, 2024

[HOLD for payment 2024-08-29] [Search v2.1] Adding semicolon to search filter leads to page not found #46993

Closed

SzymczakJ approved these changes Aug 14, 2024

View reviewed changes

289Adam289 marked this pull request as ready for review August 14, 2024 11:12

289Adam289 requested a review from a team as a code owner August 14, 2024 11:12

melvin-bot bot requested review from ikevin127 and removed request for a team August 14, 2024 11:12

289Adam289 mentioned this pull request Aug 14, 2024

[HOLD for payment 2024-08-29] [$250] [Search v2.1] Update search parser grammar to handle special characters #47095

Closed

luacmartins self-requested a review August 14, 2024 14:16

luacmartins approved these changes Aug 14, 2024

View reviewed changes

Merge branch 'main' into 289Adam289/47095-search-parser-grammar-update

6939837

This comment was marked as outdated.

Sign in to view

ikevin127 approved these changes Aug 19, 2024

View reviewed changes

melvin-bot bot requested a review from luacmartins August 19, 2024 23:23

luacmartins approved these changes Aug 20, 2024

View reviewed changes

luacmartins merged commit ccec331 into Expensify:main Aug 20, 2024
16 checks passed

github-actions bot mentioned this pull request Aug 20, 2024

Deploy Checklist: New Expensify 2024-08-20 #47760

Closed

38 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Search parser grammar update #47328

Search parser grammar update #47328

289Adam289 commented Aug 13, 2024 •

edited

Loading

SzymczakJ left a comment

melvin-bot bot commented Aug 14, 2024

luacmartins Aug 14, 2024

ikevin127 commented Aug 14, 2024 •

edited

Loading

ikevin127 commented Aug 15, 2024 •

edited

Loading

luacmartins commented Aug 15, 2024

luacmartins commented Aug 15, 2024

ikevin127 commented Aug 15, 2024 •

edited

Loading

289Adam289 commented Aug 19, 2024

luacmartins commented Aug 19, 2024

This comment was marked as outdated.

ikevin127 left a comment

luacmartins left a comment

melvin-bot bot commented Aug 20, 2024

OSBotify commented Aug 20, 2024

OSBotify commented Aug 20, 2024

OSBotify commented Aug 22, 2024

Search parser grammar update #47328

Search parser grammar update #47328

Conversation

289Adam289 commented Aug 13, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

SzymczakJ left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Aug 14, 2024

luacmartins Aug 14, 2024

Choose a reason for hiding this comment

ikevin127 commented Aug 14, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

ikevin127 commented Aug 15, 2024 • edited Loading

luacmartins commented Aug 15, 2024

luacmartins commented Aug 15, 2024

ikevin127 commented Aug 15, 2024 • edited Loading

289Adam289 commented Aug 19, 2024

luacmartins commented Aug 19, 2024

This comment was marked as outdated.

ikevin127 left a comment

Choose a reason for hiding this comment

luacmartins left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Aug 20, 2024

OSBotify commented Aug 20, 2024

OSBotify commented Aug 20, 2024

OSBotify commented Aug 22, 2024

289Adam289 commented Aug 13, 2024 •

edited

Loading

ikevin127 commented Aug 14, 2024 •

edited

Loading

ikevin127 commented Aug 15, 2024 •

edited

Loading

ikevin127 commented Aug 15, 2024 •

edited

Loading