Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: code split for entity search #31332

Merged
merged 2 commits into from Feb 28, 2024
Merged

Conversation

nsarupr
Copy link
Contributor

@nsarupr nsarupr commented Feb 28, 2024

Description

Code split for entity search.

  1. Move the methods to SearchEntityHelper to be readily available for re-use.
  2. Rename SearchEntitySolutionTest -> SearchEntitySolutionCETest

PR fixes following issue(s)

Fixes [Task]: Add search functionality for workflows #30843

Media

A video or a GIF is preferred. when using Loom, don’t embed because it looks like it’s a GIF. instead, just link to the video

Type of change

  • Chore (housekeeping or task changes that don't impact user perception)

Testing

How Has This Been Tested?

None, as this is just a refactor.

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

  • Refactor
    • Improved code efficiency in search functionality by centralizing the logic for creating pageable and sort objects.
  • Tests
    • Renamed a test class to better reflect its purpose.

@nsarupr nsarupr self-assigned this Feb 28, 2024
@github-actions github-actions bot added Task A simple Todo Workflows Pod For all issues related to the Workflows feature skip-changelog Adding this label to a PR prevents it from being listed in the changelog labels Feb 28, 2024
@nsarupr nsarupr requested a review from abhvsn February 28, 2024 07:09
@nsarupr nsarupr marked this pull request as ready for review February 28, 2024 07:09
Copy link
Contributor

coderabbitai bot commented Feb 28, 2024

Walkthrough

Walkthrough

The modifications enhance the codebase by centralizing the creation of Pageable and Sort objects within the SearchEntityHelper.java. This approach not only simplifies the code in SearchEntitySolutionCEImpl.java by using helper methods for object creation but also maintains consistency across the application. Additionally, a minor update is made by renaming a test class to align with the naming conventions, reflecting the changes in the implementation class.

Changes

File Path Change Summary
.../searchentities/SearchEntitySolutionCEImpl.java Refactored to use getPageable and getSort from SearchEntityHelper for object creation.
.../searchentities/helpers/SearchEntityHelper.java Added getSort and getPageable methods for Sort and Pageable object creation respectively.
.../searchentities/SearchEntitySolutionCETest.java Renamed test class from SearchEntitySolutionTest to SearchEntitySolutionCETest.

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?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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)

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

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@srix srix merged commit f715cfd into release Feb 28, 2024
20 checks passed
@srix srix deleted the chore/code-split/search-solution-1 branch February 28, 2024 08:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog Adding this label to a PR prevents it from being listed in the changelog Task A simple Todo Workflows Pod For all issues related to the Workflows feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Task]: Add search functionality for workflows
3 participants