feat: API for search entities #29203

abhvsn · 2023-11-29T08:41:48Z

Description

As per updated homepage experience search functionality will be handled by server and will be applicable for all the entities present on homepage.

Request format:

curl --location 'https://dev.appsmith.com/api/v1/search-entities?keyword=test&page=0&size=10&entities={comma separated entity names e.g.Application,Workspace}' \
--header 'Cookie: SESSION={logged_in_user's_session_cookie}'

Note: We will be running a couple of experiment to optimise the search, with this PR we have implemented basic search with contains functionality and index is applied on the searchable fields. Mongo does offer text-search functionality based on tokenisation which may tackle the incorrect spellings scenario. But as the searches are for names we have avoided that route for now as language tokenisation was not providing the expected results which basic search was able to.

Design handoff:
https://app.zeplin.io/project/653f7de4c1d563203f817bce/screen/653f7eea5d02e7233ede382c

PR fixes following issue(s)

Fixes #28793

Type of change

New feature (non-breaking change which adds functionality)

Testing

How Has This Been Tested?

Manual
JUnit
Jest
Cypress

Test Plan

Add Testsmith test cases links that relate to this PR

Issues raised during DP testing

Link issues raised during DP testing for better visiblity and tracking (copy link from comments dropped on this PR)

Checklist:

Dev activity

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
PR is being merged under a feature flag

QA activity:

Speedbreak features have been covered
Test plan covers all impacted features and areas of interest
Test plan has been peer reviewed by project stakeholders and other QA members
Manually tested functionality on DP
We had an implementation alignment call with stakeholders post QA Round 2
Cypress test cases have been added and approved by SDET/manual QA
Added Test Plan Approved label after Cypress tests were reviewed
Added Test Plan Approved label after JUnit tests were reviewed

Summary by CodeRabbit

New Features
- Introduced a new search functionality that allows users to find and sort applications and workspaces.
- Added the ability to view recently used applications in a sorted order.
Improvements
- Enhanced the application sorting mechanism to prioritize recently used items.
- Streamlined the process of checking if an application is connected to Git.
Bug Fixes
- Fixed an issue where the list of applications was not updating correctly for recently used items.
Deprecated Features
- Marked the getAllApplicationsForHome method as deprecated.
Tests
- Added new test cases to ensure the reliability of the search and sorting features.

…ement addition and removal of ids for created and leave workspace API

… git

coderabbitai · 2023-12-05T08:57:28Z

Walkthrough

The changes involve the implementation of new classes and methods to support search functionality and recently used entities tracking for an updated homepage experience. This includes new controllers, DTOs, helpers, migrations, and services, as well as modifications to existing classes to integrate these features. Deprecated methods are marked, and new tests are added to ensure the functionality works as expected.

Changes

File Path	Change Summary
`com.appsmith.server.controllers...SearchEntityController`, `com.appsmith.server.controllers.ce...SearchEntityControllerCE`	Added new controllers for search entity functionality.
`com.appsmith.server.dtos...RecentlyUsedEntityDTO`, `SearchEntityDTO`, `com.appsmith.server.dtos.ce...RecentlyUsedEntityCE_DTO`, `SearchEntityCE_DTO`	Added new DTOs for recently used entities and search entities.
`com.appsmith.server.helpers.ce...DomainSorter`	Added a new helper class for domain sorting.
`com.appsmith.server.migrations.db.ce...Migration036AddRecentlyUsedEntitiesForUserData`, `Migration037AddCompoundIndexForNameAndDeletedAt`	Added new migration classes for user data and indexing.
`com.appsmith.server.searchentities...SearchEntitySolution`, `SearchEntitySolutionCE`, `SearchEntitySolutionCEImpl`, `SearchEntitySolutionImpl`, `SearchEntityHelper`	Added new classes for search entity solutions and helpers.
`com.appsmith.server.services...ApplicationServiceCE`, `ApplicationServiceCEImpl`, `ApplicationServiceImpl`, `ApplicationPageServiceCEImpl`, `ApplicationServiceCECompatibleImpl`, `UserDataService`	Modified services to integrate search and recently used entities functionality.
`com.appsmith.server.controllers.ce...ApplicationControllerCE`	Deprecated a method and added a new method for finding applications by workspace ID and recently used order.
`com.appsmith.server.services.ce...UserWorkspaceServiceUnitTest`	Added new test methods for user workspace service.
`com.appsmith.server.services.ce...ApplicationServiceCETest`	Added new test methods for application service.
`com.appsmith.server.searchentities...SearchEntitySolutionTest`	Added new test methods for search entity solution.

Assessment against linked issues

Objective	Addressed	Explanation
API for search functionality for updated homepage experience (#28793)	✅	The changes include the addition of new search-related classes, methods, and tests, which align with the objective of providing an API for search functionality on the updated homepage.

Tips

Chat with CodeRabbit Bot (`@coderabbitai`)

If you reply to a review comment from CodeRabbit, the bot will automatically respond.
To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
Note: Review comments are made on code diffs or files, not on the PR overview.
Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
The JSON schema for the configuration file is available here.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

abhvsn · 2023-12-05T09:03:24Z

/ok-to-test

...appsmith-server/src/main/java/com/appsmith/server/searchentities/SearchEntitySolutionCE.java

...smith-server/src/main/java/com/appsmith/server/services/ce/ApplicationPageServiceCEImpl.java

app/server/appsmith-server/src/test/java/com/appsmith/server/helpers/ce/DomainSorterTest.java

...ava/com/appsmith/server/migrations/db/ce/Migration036AddRecentlyUsedEntitiesForUserData.java

...va/com/appsmith/server/migrations/db/ce/Migration037AddCompoundIndexForNameAndDeletedAt.java

.../appsmith-server/src/main/java/com/appsmith/server/controllers/ce/WorkspaceControllerCE.java

app/server/appsmith-server/src/main/java/com/appsmith/server/services/BaseService.java

...psmith-server/src/test/java/com/appsmith/server/searchentities/SearchEntitySolutionTest.java

.../appsmith-server/src/test/java/com/appsmith/server/services/ce/ApplicationServiceCETest.java

abhvsn · 2023-12-06T21:19:59Z

/ok-to-test

github-actions · 2023-12-06T21:20:21Z

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/7120393839.
Workflow: Appsmith External Integration Test Workflow.
Tags: ``.

coderabbitai · 2023-12-06T21:21:17Z

...server/appsmith-server/src/main/java/com/appsmith/server/services/ce/WorkspaceServiceCE.java

+    Flux<Workspace> filterByEntityFields(
+            List<String> searchableEntityFields,
+            String searchString,
+            Pageable pageable,
+            Sort sort,
+            AclPermission permission);


The new method filterByEntityFields lacks documentation. Adding Javadoc comments would help maintainers and other developers understand the purpose, usage, and behavior of this method.

github-actions · 2023-12-06T22:19:58Z

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/7120393839.
Commit: ``.
Cypress dashboard url: Click here!
All cypress tests have passed 🎉🎉🎉

nayan-rafiq

LGTM

abhvsn added 12 commits November 17, 2023 01:22

feat: API to fetch workspaces for homepage

4a27a58

test: Add testcases

169fc5c

Merge branch 'release' into feat/add-workspece-homepage-api

b64713c

Add testcases for domain sorter class

98bfa7b

Create basic skeleton with API contract

88eae0e

feat(RecentlyUsedEntityDTO): Introduce RecentlyUsedEntityDTO and impl…

257bd61

…ement addition and removal of ids for created and leave workspace API

test: Add testcases

40f175e

Merge branch 'release' into feat/add-get-applications-for-homepage-api

2a267ef

Add testcases for updating the entities

3beeae6

Merge branch 'release' into feat/add-get-applications-for-homepage-api

4962ab9

feat: Add migration to track recently used entities for user data

042df3d

feat: Add search entity functionality for homepage

c62ee13

github-actions bot added the Enhancement New feature or request label Nov 29, 2023

feat: Add entity selector option to enhance search functionality

4eb0876

abhvsn changed the base branch from release to feat/add-get-applications-for-homepage-api November 29, 2023 09:48

abhvsn added 6 commits December 4, 2023 10:59

chore: Add indexing comment for search field method

fbedec8

Merge branch 'release' into feat/search-api-homepage

8d8dd6e

feat: Add SearchEntityHelper and its test cases

0a80de2

test: Add testcases and fix get default application when connected to…

2f9ea02

… git

feat: Trim the search string before fetching results from DB

34ff3cf

Merge branch 'release' into feat/search-api-homepage

86c6462

abhvsn changed the base branch from feat/add-get-applications-for-homepage-api to release December 5, 2023 06:52

abhvsn changed the base branch from release to feat/add-get-applications-for-homepage-api December 5, 2023 06:52

abhvsn changed the base branch from feat/add-get-applications-for-homepage-api to release December 5, 2023 06:53

abhvsn marked this pull request as ready for review December 5, 2023 08:57

abhvsn requested review from AnaghHegde and nayan-rafiq as code owners December 5, 2023 08:57

chore: Resolve merge conflicts with release

5a6c1bb

github-actions bot added the Backend This marks the issue or pull request to reference server code label Dec 5, 2023

github-actions bot added Billing & Licensing Product Issues pertaining to licensing, billing and usage across self serve and enterprise customers Homepage Experience V2 labels Dec 5, 2023

coderabbitai bot reviewed Dec 5, 2023

View reviewed changes

abhvsn changed the base branch from release to feat/add-get-applications-for-homepage-api December 6, 2023 08:20

abhvsn changed the base branch from feat/add-get-applications-for-homepage-api to release December 6, 2023 08:21

abhvsn added 3 commits December 6, 2023 13:52

Merge branch 'release' into feat/search-api-homepage

f86074a

chore: Resolve merge conflicts with release

fb606c2

refactor method name

aadb679

coderabbitai bot reviewed Dec 6, 2023

View reviewed changes

abhvsn added the skip-testPlan label Dec 7, 2023

nayan-rafiq approved these changes Dec 7, 2023

View reviewed changes

Aishwarya-U-R merged commit 441795c into release Dec 8, 2023
23 of 24 checks passed

Aishwarya-U-R deleted the feat/search-api-homepage branch December 8, 2023 05:49

abhvsn mentioned this pull request Dec 13, 2023

[Task]: Add search functionality for packages #29589

Open

1 task

deepikaappsmith mentioned this pull request Feb 1, 2024

[Task]: Add search functionality for workflows #30843

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: API for search entities #29203

feat: API for search entities #29203

abhvsn commented Nov 29, 2023 •

edited

Loading

coderabbitai bot commented Dec 5, 2023 •

edited

Loading

Walkthrough

Changes

Assessment against linked issues

Chat with CodeRabbit Bot (`@coderabbitai`)

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

abhvsn commented Dec 5, 2023

abhvsn commented Dec 6, 2023

github-actions bot commented Dec 6, 2023

coderabbitai bot Dec 6, 2023

github-actions bot commented Dec 6, 2023

nayan-rafiq left a comment

feat: API for search entities #29203

feat: API for search entities #29203

Conversation

abhvsn commented Nov 29, 2023 • edited Loading

Description

PR fixes following issue(s)

Type of change

Testing

How Has This Been Tested?

Test Plan

Issues raised during DP testing

Checklist:

Dev activity

QA activity:

Summary by CodeRabbit

coderabbitai bot commented Dec 5, 2023 • edited Loading

Walkthrough

Changes

Assessment against linked issues

Chat with CodeRabbit Bot (@coderabbitai)

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

abhvsn commented Dec 5, 2023

abhvsn commented Dec 6, 2023

github-actions bot commented Dec 6, 2023

coderabbitai bot Dec 6, 2023

Choose a reason for hiding this comment

github-actions bot commented Dec 6, 2023

nayan-rafiq left a comment

Choose a reason for hiding this comment

abhvsn commented Nov 29, 2023 •

edited

Loading

coderabbitai bot commented Dec 5, 2023 •

edited

Loading

Chat with CodeRabbit Bot (`@coderabbitai`)

CodeRabbit Configration File (`.coderabbit.yaml`)