Add `feed` syntax key #57454

JakubKorytko · 2025-02-26T07:28:51Z

Explanation of Change

Fixed Issues

$ #56855
PROPOSAL: N/A

Tests

Click on the search anywhere in the application.
Type in feed: followed by existing card feed (workspace or domain).
After accepting the search, verify that:
1. Display name of the feed is visible in the search input.
2. Query in the URL and request sent to the server contains key feed: fundID_bank.

Click on the advanced search filters anywhere in the application.
Select any feed in theCard row.
Check step 3 in the test above.
Deselect any card from the selected feed and verify that the list of cards is stored in the query instead of the feed.

Offline tests

N/A

QA Steps

Same as tests

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

iOS: Native

iOS.mov

iOS: mWeb Safari

MacOS: Chrome / Safari

Web.mov

MacOS: Desktop

Desktop.mov

Kicu

Good job. There are things that we can improve here, because the code surrounding cards is already pretty complex, so I think it's worth taking another look.

Also congratz for trying to write some tests 👍

General comment about commiting project.pbxproj: if you have not changed anything in package.json, did not update any dependencies and/or pods - just app code, then do not commit changes to this file - just discard them.

Kicu · 2025-02-26T15:06:24Z

src/types/form/SearchAdvancedFiltersForm.ts

@@ -43,6 +43,7 @@ const FILTER_KEYS = {
    FROM: 'from',
    TO: 'to',
    IN: 'in',
+    FEED: 'feed',


this is super tiny nitpick but can you move this right below line 33, so that it is kinda "grouped" together with CARD_ID

Kicu · 2025-02-26T15:15:44Z

tests/unit/cardFeedsTests.ts

+import {getCardFeedNames, getSelectedCardsFromFeeds} from '@pages/Search/SearchAdvancedFiltersPage/SearchFiltersCardPage';
+import type {WorkspaceCardsList} from '@src/types/onyx';
+
+/* eslint-disable @typescript-eslint/naming-convention */


why do we need this disable?

Kicu · 2025-02-26T15:21:32Z

src/pages/Search/SearchAdvancedFiltersPage/SearchFiltersCardPage.tsx

@@ -23,11 +25,9 @@ import ROUTES from '@src/ROUTES';
 import type {Card, CardList, CompanyCardFeed, PersonalDetailsList, WorkspaceCardsList} from '@src/types/onyx';
 import {isEmptyObject} from '@src/types/utils/EmptyObject';

-type CardFilterItem = Partial<OptionData> & AdditionalCardProps & {isCardFeed?: boolean; correspondingCards?: string[]};
+type CardFilterItem = Partial<OptionData> & AdditionalCardProps & {isCardFeed?: boolean; correspondingCards?: string[]; keyForFeed: string};


why not more simple name like: cardFeedKey?

Kicu · 2025-02-26T15:21:47Z

src/pages/Search/SearchAdvancedFiltersPage/SearchFiltersCardPage.tsx

@@ -63,6 +63,7 @@ function createIndividualCardFilterItem(card: Card, personalDetailsList: Persona
            icon,
        },
        isCardFeed: false,
+        keyForFeed: '',


Suggested change

keyForFeed: '',

cardFeedKey: '',

Kicu · 2025-02-26T15:23:21Z

src/pages/Search/SearchAdvancedFiltersPage/SearchFiltersCardPage.tsx

+    workspaceCardFeeds: Record<string, WorkspaceCardsList | undefined>,
+    domainFeedsData: Record<string, DomainFeedData>,
+    propsTranslate?: LocaleContextProps['translate'],
+): Record<string, CardFeedData> {


Suggested change

): Record<string, CardFeedData> {

): {

If return types are not required, then we don't write them explicitly. TS can infer return types 99% of the time.

Kicu · 2025-02-27T07:42:23Z

src/components/Search/SearchRouter/buildSubstitutionsMap.ts

        ) {
-            const displayValue = getFilterDisplayValue(filterKey, filterValue, personalDetails, reports, cardList);
+            const displayValue = getFilterDisplayValue(filterKey, filterValue, personalDetails, reports, cardList, cardFeedNames);


please add 1 test case to buildSubstitutionsMap tests that will cover cardFeedNames

Kicu · 2025-02-27T07:44:23Z

src/libs/CardUtils.ts

@@ -69,6 +69,29 @@ function isCorporateCard(cardID: number) {
    return !!allCards[cardID];
 }

+/**
+ * @param cardID


if there is no extra description to @param then please remove it.

This code used to be JS only, so IMO all the empty @param XXX are leftovers from JS.

Kicu · 2025-02-27T07:44:43Z

src/libs/CardUtils.ts

+    if (cardID.split('_').at(0) !== 'cards') {
+        return `cards_${cardID}`;
+    }
+    return cardID;


double check if these 2 functions can be improved

Kicu · 2025-02-27T07:47:14Z

src/pages/Search/AdvancedSearchFilters.tsx

-        : undefined;
+    const cardIdsFilter = filters[CONST.SEARCH.SYNTAX_FILTER_KEYS.CARD_ID] ?? [];
+    const feedFilter = filters[CONST.SEARCH.SYNTAX_FILTER_KEYS.FEED] ?? [];
+    const groupedCards: Record<string, WorkspaceCardsList> = {};


It is hard to understand just from name groupedCards what is the purpose of this const. Can we come up with a better name?

Kicu · 2025-02-27T07:48:36Z

src/pages/Search/AdvancedSearchFilters.tsx

@@ -453,6 +469,10 @@ function AdvancedSearchFilters() {
        .map((section) => {
            return section
                .map((key) => {
+                    // visually feeds resist into cards so they cannot be pressed directly and are not redirecting anywhere


This sentence sounds very strange, please update this comment

JakubKorytko added 10 commits February 20, 2025 13:00

Add feed syntax to SearchParser lib

e872958

Create keyForFeed key for feed query

86e92a2

Store only the feed in query if feed is selected

501d1cf

Convert text to autocompleteID & vice-versa

159244f

Remove 'cards_' part from feed syntax key

bcdfe7b

Display proper feed name in AdvancedSearchFilters

4711093

Add logic for domain cards

d897b00

Add loader for card filters page

c72972b

Improve domain cards logic

9221ae0

Add test for Card Feeds convertion

1497b84

Kicu suggested changes Feb 27, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `feed` syntax key #57454

Add `feed` syntax key #57454

JakubKorytko commented Feb 26, 2025

Kicu left a comment

Kicu Feb 26, 2025

Kicu Feb 26, 2025

Kicu Feb 26, 2025

Kicu Feb 26, 2025

Kicu Feb 26, 2025

Kicu Feb 27, 2025

Kicu Feb 27, 2025

Kicu Feb 27, 2025

Kicu Feb 27, 2025

Kicu Feb 27, 2025

Add feed syntax key #57454

Are you sure you want to change the base?

Add feed syntax key #57454

Conversation

JakubKorytko commented Feb 26, 2025

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Kicu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Add `feed` syntax key #57454

Add `feed` syntax key #57454