feat: IDE tab list search view #34759
Conversation
…o ide-tab-list-search-view
…o ide-tab-list-search-view
…o ide-tab-list-search-view
WalkthroughThe changes introduced a new search feature to the overflow list view in the editor pane of the client application. This involves adding search functionality to components, updating dependencies, and refactoring the rendering logic to display search results. Additionally, a new design-system version is updated, and test cases for the new search functionality are included. Changes
Assessment against linked issues
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
github-actions
bot
added
IDE Navigation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
app/client/yarn.lockis excluded by!**/yarn.lock,!**/*.lock
Files selected for processing (7)
- app/client/package.json (1 hunks)
- app/client/src/ce/constants/messages.ts (1 hunks)
- app/client/src/pages/Editor/IDE/EditorPane/JS/List.tsx (6 hunks)
- app/client/src/pages/Editor/IDE/EditorPane/Query/List.tsx (5 hunks)
- app/client/src/pages/Editor/IDE/EditorPane/components/AddAndSearchbar.tsx (1 hunks)
- app/client/src/pages/Editor/IDE/EditorPane/fuzzySearchInFiles.test.ts (1 hunks)
- app/client/src/pages/Editor/IDE/EditorPane/utils.ts (1 hunks)
Files skipped from review due to trivial changes (2)
- app/client/package.json
- app/client/src/ce/constants/messages.ts
Additional comments not posted (12)
app/client/src/pages/Editor/IDE/EditorPane/components/AddAndSearchbar.tsx (2)
10-25: LGTM!The component logic is correct and adheres to best practices.
1-8: Ensure all imported components are used.The
ButtonandSearchInputcomponents from the design system are used, but theFlexcomponent should be checked for usage.Verification successful
All imported components are used.
The
Flexcomponent is utilized in the file, so there are no issues with unused imports.
Flexcomponent usage:
<Flex alignItems="center" flexDirection="row" gap="spaces-3" px="spaces-3">Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify usage of Flex component in AddAndSearchbar.tsx # Test: Ensure that the Flex component is actually used in the file. rg --type tsx 'Flex' app/client/src/pages/Editor/IDE/EditorPane/components/AddAndSearchbar.tsxLength of output: 122
Script:
#!/bin/bash # Description: Verify usage of Flex component in AddAndSearchbar.tsx # Test: Ensure that the Flex component is actually used in the file. rg 'Flex' app/client/src/pages/Editor/IDE/EditorPane/components/AddAndSearchbar.tsxLength of output: 234
app/client/src/pages/Editor/IDE/EditorPane/utils.ts (2)
1-12: Ensure all imported types are used.The
EditorSegmentListtype from selectors is used. The FUSE_OPTIONS are correctly defined for fuzzy search.
14-30: LGTM!The function logic is correct and adheres to best practices.
app/client/src/pages/Editor/IDE/EditorPane/fuzzySearchInFiles.test.ts (2)
1-20: Ensure all imported constants are used.The
PluginTypeconstant from entities is used. The sample data is correctly defined for testing.
22-47: LGTM!The test cases provide sufficient coverage and are correctly defined.
app/client/src/pages/Editor/IDE/EditorPane/Query/List.tsx (2)
Line range hint
1-22:
Ensure all imported hooks and selectors are used.The imported hooks and selectors are used correctly. The component defines local state and uses selectors to fetch data.
Line range hint
26-110:
LGTM!The search functionality is correctly implemented and the rendering logic is updated accordingly.
app/client/src/pages/Editor/IDE/EditorPane/JS/List.tsx (4)
37-39: State and search functionality look good.The addition of
searchTermstate andonSearchfunction is appropriate for the search functionality. The use offuzzySearchInFilesto filter files based on the search term is correct.Also applies to: 47-48, 56-58
69-75: Rendering search bar looks good.The use of
AddAndSearchbarcomponent to render the search bar is appropriate.
Line range hint
89-126:
Rendering search results looks good.The use of
localFilesarray to render search results and the message for no search results are appropriate.
1-3: Imports look good, but verify the removal ofButton.The new imports for
useState,AddAndSearchbar, andfuzzySearchInFilesare necessary for the new search functionality. Ensure that theButtonimport removal is consistent with the summary.Also applies to: 21-23
Verification successful
Verification successful:
Buttonimport removed.The
Buttonimport has been successfully removed fromapp/client/src/pages/Editor/IDE/EditorPane/JS/List.tsx, as verified by the absence of this import in the search results.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the removal of `Button` import. # Test: Search for `Button` import. Expect: No occurrences of `Button` import. rg --type-add 'tsx' --type 'tsx' 'import { Button } from'Length of output: 169
Script:
#!/bin/bash # Description: Verify the removal of `Button` import. # Test: Search for `Button` import. Expect: No occurrences of `Button` import. rg --type-add 'tsx' --type 'tsx' 'import { Button } from'Length of output: 169
Script:
#!/bin/bash # Description: Verify the removal of `Button` import. # Test: Search for `Button` import. Expect: No occurrences of `Button` import. rg --type-add 'tsx' --type 'tsx' 'import { Button } from'Length of output: 169
Script:
#!/bin/bash # Description: Verify the removal of `Button` import. # Test: Search for `Button` import. Expect: No occurrences of `Button` import. grep -r 'import { Button } from' .Length of output: 7385
albinAppsmith
added
ok-to-test
…o ide-tab-list-search-view
albinAppsmith
added
ok-to-test
| <SearchInput onChange={onSearch} size="sm" /> | ||
| {hasAddPermission ? ( | ||
| <Button | ||
| className="t--add-item !min-w-[24px]" |
There was a problem hiding this comment.
Use data-testid for t--add-item instead of className.
There was a problem hiding this comment.
Will take this up in a separate PR since this change is not introduced by this PR rather this is a change in location. Also, this update will cause updates in some cypress files as well.
…o ide-tab-list-search-view
albinAppsmith
requested review from
ApekshaBhosale and
sagar-qa007
as code owners
albinAppsmith
added
ok-to-test
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- app/client/cypress/support/Pages/JSEditor.ts (1 hunks)
Additional context used
Path-based instructions (1)
app/client/cypress/support/Pages/JSEditor.ts (1)
Pattern
app/client/cypress/**/**.*: Follow best practices for Cypress code and e2e automation.
Avoid using cy.wait in code.
Avoid using cy.pause in code.
Use variables for locators, not strings.
Usedata-*attributes for selectors; avoid Xpaths and CSS attributes.
Avoid selectors like.btn.submitorbutton[type=submit].
Perform logins via API withLoginFromAPI.
Only interact with controlled sites/servers.
Ensure tests can run withit.onlyand are independent.
Usebefore,beforeEach,after,afterEachcorrectly; clean state before tests.
Check new specs for flakiness by running them 10 times on CI.
Use multiple assertions; don't treat Cypress as unit tests.
Use constants for strings.
Include datasource operations inbeforehooks.
Additional comments not posted (2)
app/client/cypress/support/Pages/JSEditor.ts (2)
108-108: LGTM! The method callPageLeftPane.switchToAddNew()is correctly integrated.This change replaces the old method of clicking directly on the new JS object element and improves the clarity and maintainability of the code.
109-109: LGTM! The old code is appropriately commented out.Commenting out the old direct click method helps maintain the context and provides a fallback if needed.
| }, | ||
| ]; | ||
|
|
||
| describe("fuzzySearchInFiles", () => { |
There was a problem hiding this comment.
Please add more description scenario name.
There was a problem hiding this comment.
Updated it blocks with better descriptions.
…o ide-tab-list-search-view
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- app/client/src/pages/Editor/IDE/EditorPane/fuzzySearchInFiles.test.ts (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- app/client/src/pages/Editor/IDE/EditorPane/fuzzySearchInFiles.test.ts
| const canCreateActions = getHasCreateActionPermission( | ||
| isFeatureEnabled, | ||
| pagePermissions, | ||
| ); | ||
|
|
||
| const { openAddJS } = useJSAdd(); | ||
|
|
||
| const onSearch = (str: string) => { |
There was a problem hiding this comment.
Just a bit of nitpicking, typically onSearch is a naming convention used for events, while handlers are prefixed with handle, e.g. handleSearch.
…o ide-tab-list-search-view
albinAppsmith
added
ok-to-test
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
app/client/yarn.lockis excluded by!**/yarn.lock,!**/*.lock
Files selected for processing (3)
- app/client/package.json (1 hunks)
- app/client/src/pages/Editor/IDE/EditorPane/JS/List.tsx (6 hunks)
- app/client/src/pages/Editor/IDE/EditorPane/Query/List.tsx (5 hunks)
Files skipped from review as they are similar to previous changes (3)
- app/client/package.json
- app/client/src/pages/Editor/IDE/EditorPane/JS/List.tsx
- app/client/src/pages/Editor/IDE/EditorPane/Query/List.tsx
Description
This PR adds search functionality to the overflow list of tabs.
Fixes #34293
Automation
/ok-to-test tags="@tag.All"
🔍 Cypress test results
Tip
🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/9855000354
Commit: ff0355b
Cypress dashboard.
Tags:
@tag.AllSpec:
Tue, 09 Jul 2024 11:01:02 UTC
Communication
Should the DevRel and Marketing teams inform users about this change?
Summary by CodeRabbit
New Features
Bug Fixes
Tests
Refactor