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

fix(web): Sort by title for generic list and team list #17226

Merged
merged 2 commits into from
Dec 13, 2024

Conversation

RunarVestmann
Copy link
Member

@RunarVestmann RunarVestmann commented Dec 13, 2024

Sort by title for generic list and team list

What

Why

This feature was present previously, here I am adding it in again

Screenshots / Gifs

Before

Screenshot 2024-12-13 at 11 12 58

After

Screenshot 2024-12-13 at 11 13 16

Checklist:

  • I have performed a self-review of my own code
  • 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
  • Formatting passes locally with my changes
  • I have rebased against main before asking for a review

Summary by CodeRabbit

  • New Features
    • Enhanced sorting functionality for lists, ensuring items with equal values are sorted by title in ascending order.
  • Bug Fixes
    • Updated sorting logic for grants and vacancies to improve consistency and clarity.

@RunarVestmann RunarVestmann added the automerge Merge this PR as soon as all checks pass label Dec 13, 2024
@RunarVestmann RunarVestmann requested review from a team as code owners December 13, 2024 11:13
Copy link
Contributor

coderabbitai bot commented Dec 13, 2024

Walkthrough

The pull request modifies the CmsElasticsearchService class in cms.elasticsearch.service.ts by updating the sorting mechanisms in the getListItems, getGrants, and getVacancies methods. The changes ensure that items with equal values are sorted by title in ascending order after the primary sort criteria. Additionally, the type of the sort variable in getListItems has been refined for clarity, and comments have been added to improve code readability.

Changes

File Path Change Summary
libs/cms/src/lib/cms.elasticsearch.service.ts Updated sorting logic in getListItems, getGrants, and getVacancies methods; modified sort type in getListItems from `('_score'

Possibly related PRs

  • fix(web): Fix query for generic and team member lists #17115: This PR modifies the CmsElasticsearchService class in cms.elasticsearch.service.ts, specifically enhancing the query functionality and sorting logic, which aligns with the changes made in the main PR regarding sorting in the getListItems, getGrants, and getVacancies methods.

Suggested reviewers

  • mannipje

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>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • 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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Experiment)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
libs/cms/src/lib/cms.elasticsearch.service.ts (2)

528-535: LGTM! The sorting implementation correctly restores the title sorting feature.

The implementation properly sorts items first by release date (descending) and then by title (ascending) for items with equal release dates, which aligns with the PR objective to reintroduce the title sorting feature.

Consider extracting the sort configuration into a constant to improve reusability:

+const DEFAULT_LIST_SORT: sortRule[] = [
+  {
+    [SortField.RELEASE_DATE]: {
+      order: SortDirection.DESC,
+    },
+  },
+  { 'title.sort': { order: SortDirection.ASC } },
+];

-    const sort: sortRule[] = [
-      {
-        [SortField.RELEASE_DATE]: {
-          order: SortDirection.DESC,
-        },
-      },
-      { 'title.sort': { order: SortDirection.ASC } },
-    ]
+    const sort = DEFAULT_LIST_SORT;

534-535: Enhance the comment to cover both sorting criteria.

The comment could be more comprehensive by mentioning both sorting criteria.

-      // Sort items with equal values by ascending title order
+      // Sort items by release date (DESC), then by title (ASC) for items with equal dates
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3719969 and c8c540c.

📒 Files selected for processing (1)
  • libs/cms/src/lib/cms.elasticsearch.service.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
libs/cms/src/lib/cms.elasticsearch.service.ts (1)

Pattern libs/**/*: "Confirm that the code adheres to the following:

  • Reusability of components and hooks across different NextJS apps.
  • TypeScript usage for defining props and exporting types.
  • Effective tree-shaking and bundling practices."

Copy link

codecov bot commented Dec 13, 2024

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 35.75%. Comparing base (3719969) to head (c8c540c).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
libs/cms/src/lib/cms.elasticsearch.service.ts 0.00% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main   #17226   +/-   ##
=======================================
  Coverage   35.75%   35.75%           
=======================================
  Files        6935     6935           
  Lines      148113   148113           
  Branches    42233    42233           
=======================================
  Hits        52953    52953           
  Misses      95160    95160           
Flag Coverage Δ
api 3.33% <ø> (ø)
api-domains-auth-admin 48.49% <ø> (ø)
api-domains-communications 39.39% <0.00%> (ø)
application-system-api 38.75% <0.00%> (+<0.01%) ⬆️
application-template-api-modules 27.82% <0.00%> (ø)
cms 0.39% <0.00%> (ø)
cms-translations 38.72% <0.00%> (ø)
judicial-system-api 20.16% <ø> (ø)
judicial-system-backend 55.83% <0.00%> (ø)
services-user-notification 46.52% <0.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
libs/cms/src/lib/cms.elasticsearch.service.ts 2.89% <0.00%> (ø)

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3719969...c8c540c. Read the comment docs.

@datadog-island-is
Copy link

Datadog Report

All test runs 158c29e 🔗

10 Total Test Services: 0 Failed, 9 Passed
➡️ Test Sessions change in coverage: 28 no change

Test Services
This report shows up to 10 services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
api 0 0 0 4 0 3.05s 1 no change Link
api-domains-auth-admin 0 0 0 18 0 13.96s 1 no change Link
api-domains-communications 0 0 0 5 0 36.47s 1 no change Link
api-domains-license-service 0 0 0 0 0 608.58ms 1 no change Link
application-system-api 0 0 0 46 0 2m 21.27s 1 no change Link
application-template-api-modules 0 0 0 118 0 2m 37.19s 1 no change Link
cms-translations 0 0 0 3 0 26.73s 1 no change Link
judicial-system-api 0 0 0 61 0 6.98s 1 no change Link
judicial-system-backend 0 0 0 21152 0 21m 54.25s 1 no change Link
services-user-notification 0 0 0 51 0 1m 33.17s 1 no change Link

@kodiakhq kodiakhq bot merged commit 5a13f96 into main Dec 13, 2024
65 checks passed
@kodiakhq kodiakhq bot deleted the fix/web-sort-by-title-in-lists branch December 13, 2024 11:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants