grammar update simplifying an AST #47789

289Adam289 · 2024-08-21T13:42:20Z

Details

This pr simplifies AST by creating only one node for multi-select values e.g. category.
It also addresses #45293 (comment)

Fixed Issues

$ #45293 (partial fix)
PROPOSAL:

Tests

visit route search/filters
try filters in different combinations
confirm that filters behave correctly and that API call is correct
(to check currently unsupported features you can copy grammar to https://peggyjs.org/online.html and test it there)

Verify that no errors appear in the JS console

Offline tests

QA Steps

same steps 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 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

web.mp4

MacOS: Desktop

Kicu

I went over and took a look. I can't say much about the grammar itself. I think the most important thing is that it actually works 😅

I left comments about prettifying the file a bit

src/libs/SearchParser/searchParser.peggy

melvin-bot · 2024-08-22T12:06:49Z

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

289Adam289 · 2024-08-22T12:07:55Z

@luacmartins it's ready for review

src/libs/SearchParser/searchParser.peggy

rayane-djouah · 2024-08-23T11:05:33Z

This PR addresses #45293 (comment) and #45293 (comment), Right? Could you please add some details in the author checklist?

luacmartins

LGTM

289Adam289 · 2024-08-26T10:20:25Z

@rayane-djouah friendly bump

rayane-djouah · 2024-08-26T10:31:52Z

Will review today

rayane-djouah · 2024-08-26T22:41:19Z

Bug: multiple nodes are created for expenseType multi-select value

Screen.Recording.2024-08-26.at.11.37.35.PM.mov

rayane-djouah · 2024-08-27T17:28:54Z

@luacmartins - Is backend ready to handle multi-select values nodes?

Bug: Backend is returning empty results when I choose "cash" and "distance" expense types.

jsonQuery: {"type":"expense","status":"all","sortBy":"date","sortOrder":"desc","filters":{"operator":"eq","left":"expenseType","right":"cash,distance"},"inputQuery":"expenseType:cash,distance","hash":1033076634,"offset":0}

Screen.Recording.2024-08-27.at.6.21.45.PM.mov

rayane-djouah · 2024-08-27T17:38:59Z

The API call is correct

Screen.Recording.2024-08-27.at.3.51.36.PM.mov

luacmartins · 2024-08-27T18:49:44Z

It should be, let me take a look

luacmartins · 2024-08-27T21:08:23Z

@289Adam289 we have conflicts'

luacmartins · 2024-08-27T22:47:59Z

@rayane-djouah @289Adam289 I put up a PR to fix the API issue.

289Adam289 · 2024-09-05T15:03:58Z

I improved grammar by implementing @luacmartins suggestions and updated tests to work with new grammar. Currently:

every multi-select node has it's own array
all keywords end up in single array

luacmartins · 2024-09-05T16:15:04Z

Nice! I'll resume work on the backend to support the array structure

luacmartins

Changes LGTM. We need to hold merging this PR until the backend supports the new array syntax.

luacmartins · 2024-09-05T22:07:29Z

API PR to process arrays is in review.

luacmartins · 2024-09-05T22:09:54Z

@289Adam289 in the meantime, I noticed that selecting tags or categories with a : results in an error and a not found page is shown. This also happens on main so NAB for this PR, but it'd be great if we could solve it here while we wait for the backend changes to go live. See video below:

Screen.Recording.2024-09-05.at.4.09.19.PM.mov

luacmartins · 2024-09-05T22:52:43Z

Backend PR is merged, just waiting on deploy later today.

luacmartins · 2024-09-06T05:50:51Z

Backend PR is deployed. Let's test this again and get it merged

289Adam289 · 2024-09-06T07:48:03Z

I noticed that selecting tags or categories with a : results in an error

I'vs already solved this issue in #48312 while working on keywords sanitization.

luacmartins · 2024-09-06T14:30:40Z

Ah nice! Good to know.

luacmartins · 2024-09-06T14:31:01Z

API PR is deployed, let's continue review and hopefully get this PR merged today @rayane-djouah

rayane-djouah · 2024-09-06T21:28:08Z

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

Having problems building Android on main

Android: mWeb Chrome

Screen.Recording.2024-09-06.at.10.20.13.PM.mov

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-09-06.at.22.18.59.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-09-06.at.22.14.21.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-09-06.at.9.55.16.PM.1.mov

Screen.Recording.2024-09-06.at.9.52.55.PM.mov

MacOS: Desktop

Screen.Recording.2024-09-06.at.10.15.04.PM.mov

rayane-djouah

LGTM and tests well

OSBotify · 2024-09-06T22:24:43Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

Kicu reviewed Aug 22, 2024

View reviewed changes

src/libs/SearchParser/searchParser.peggy Outdated Show resolved Hide resolved

src/libs/SearchParser/searchParser.peggy Show resolved Hide resolved

adamgrzybowski reviewed Aug 22, 2024

View reviewed changes

src/libs/SearchParser/searchParser.peggy Outdated Show resolved Hide resolved

adamgrzybowski reviewed Aug 22, 2024

View reviewed changes

src/libs/SearchParser/searchParser.peggy Outdated Show resolved Hide resolved

289Adam289 marked this pull request as ready for review August 22, 2024 12:06

289Adam289 requested a review from a team as a code owner August 22, 2024 12:06

melvin-bot bot requested review from abdulrahuman5196 and removed request for a team August 22, 2024 12:06

luacmartins requested review from rayane-djouah and luacmartins and removed request for abdulrahuman5196 August 22, 2024 14:49

luacmartins reviewed Aug 22, 2024

View reviewed changes

src/libs/SearchParser/searchParser.peggy Outdated Show resolved Hide resolved

luacmartins previously approved these changes Aug 23, 2024

View reviewed changes

fix expenseType AST node

a925beb

289Adam289 dismissed luacmartins’s stale review via a925beb August 27, 2024 08:03

luacmartins previously approved these changes Aug 27, 2024

View reviewed changes

289Adam289 added 4 commits August 28, 2024 10:49

add policyID to grammar

652ff67

fix bug

10927ca

add comments to grammar

bb99c5e

Merge branch 'main' into 289Adam289/45293-search-grammar-simplify-AST

0c4d83d

289Adam289 added 3 commits September 5, 2024 16:42

Merge branch 'main' into 289Adam289/45293-search-grammar-simplify-AST

a3689bc

fix grammar and remove comments

1c94450

update tests

62d6a44

289Adam289 added 3 commits September 5, 2024 17:09

Merge branch 'main' into 289Adam289/45293-search-grammar-simplify-AST

a5c7018

fix merge

e7b253a

lint fix

15bb04e

This was referenced Sep 5, 2024

[$250] [Search v2.1] Search loads infinitely when search filter has tax rate in A: B name format #48407

Closed

store applied filters in onyx #48312

Merged

luacmartins self-requested a review September 5, 2024 17:23

luacmartins approved these changes Sep 5, 2024

View reviewed changes

luacmartins changed the title ~~grammar update simplifying an AST~~ [HOLD API changes] grammar update simplifying an AST Sep 5, 2024

luacmartins mentioned this pull request Sep 5, 2024

[HOLD for payment 2024-09-26] [Search v2.1] Update View payment history redirect to "Expensify, Inc" merchant filter. #44105

Closed

luacmartins changed the title ~~[HOLD API changes] grammar update simplifying an AST~~ grammar update simplifying an AST Sep 6, 2024

rayane-djouah approved these changes Sep 6, 2024

View reviewed changes

melvin-bot bot requested a review from luacmartins September 6, 2024 21:28

luacmartins approved these changes Sep 6, 2024

View reviewed changes

luacmartins merged commit f6529fd into Expensify:main Sep 6, 2024
18 of 19 checks passed

github-actions bot mentioned this pull request Sep 9, 2024

Deploy Checklist: New Expensify 2024-09-09 #48791

Closed

luacmartins mentioned this pull request Sep 11, 2024

[HOLD for payment 2024-09-17][$250] [Tracking][Search v2.1] Follow up issues #45293

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

grammar update simplifying an AST #47789

grammar update simplifying an AST #47789

289Adam289 commented Aug 21, 2024 •

edited

Loading

Kicu left a comment

melvin-bot bot commented Aug 22, 2024

289Adam289 commented Aug 22, 2024

rayane-djouah commented Aug 23, 2024

luacmartins left a comment

289Adam289 commented Aug 26, 2024

rayane-djouah commented Aug 26, 2024

rayane-djouah commented Aug 26, 2024

rayane-djouah commented Aug 27, 2024 •

edited

Loading

rayane-djouah commented Aug 27, 2024

luacmartins commented Aug 27, 2024

luacmartins commented Aug 27, 2024

luacmartins commented Aug 27, 2024

289Adam289 commented Sep 5, 2024

luacmartins commented Sep 5, 2024

luacmartins left a comment

luacmartins commented Sep 5, 2024

luacmartins commented Sep 5, 2024

luacmartins commented Sep 5, 2024

luacmartins commented Sep 6, 2024

289Adam289 commented Sep 6, 2024 •

edited

Loading

luacmartins commented Sep 6, 2024

luacmartins commented Sep 6, 2024

rayane-djouah commented Sep 6, 2024 •

edited

Loading

rayane-djouah left a comment

OSBotify commented Sep 6, 2024

grammar update simplifying an AST #47789

grammar update simplifying an AST #47789

Conversation

289Adam289 commented Aug 21, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Kicu left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Aug 22, 2024

289Adam289 commented Aug 22, 2024

rayane-djouah commented Aug 23, 2024

luacmartins left a comment

Choose a reason for hiding this comment

289Adam289 commented Aug 26, 2024

rayane-djouah commented Aug 26, 2024

rayane-djouah commented Aug 26, 2024

rayane-djouah commented Aug 27, 2024 • edited Loading

rayane-djouah commented Aug 27, 2024

luacmartins commented Aug 27, 2024

luacmartins commented Aug 27, 2024

luacmartins commented Aug 27, 2024

289Adam289 commented Sep 5, 2024

luacmartins commented Sep 5, 2024

luacmartins left a comment

Choose a reason for hiding this comment

luacmartins commented Sep 5, 2024

luacmartins commented Sep 5, 2024

luacmartins commented Sep 5, 2024

luacmartins commented Sep 6, 2024

289Adam289 commented Sep 6, 2024 • edited Loading

luacmartins commented Sep 6, 2024

luacmartins commented Sep 6, 2024

rayane-djouah commented Sep 6, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

rayane-djouah left a comment

Choose a reason for hiding this comment

OSBotify commented Sep 6, 2024

289Adam289 commented Aug 21, 2024 •

edited

Loading

rayane-djouah commented Aug 27, 2024 •

edited

Loading

289Adam289 commented Sep 6, 2024 •

edited

Loading

rayane-djouah commented Sep 6, 2024 •

edited

Loading