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: vxeGrid default sort data no effect in first query #5141

Merged
merged 2 commits into from
Dec 15, 2024

Conversation

mynetfan
Copy link
Collaborator

@mynetfan mynetfan commented Dec 15, 2024

Description

修复VxeGrid的defaultSort在第一次请求时不起作用的问题

fix #5125

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
  • Run the tests with pnpm test.
  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
  • 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
  • Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

  • New Features

    • Added sorting capabilities to the mock data response.
    • Enhanced grid configuration to support sortable columns for category, color, productName, and price.
    • Introduced server-side sorting with default sorting on the category field in descending order.
  • Bug Fixes

    • Improved initialization process for the grid's proxy configuration.
  • Documentation

    • Updated comments to reflect changes in form configuration handling.

@mynetfan mynetfan requested review from anncwb, vince292007 and a team as code owners December 15, 2024 04:33
Copy link

changeset-bot bot commented Dec 15, 2024

⚠️ No Changeset found

Latest commit: 552c3d9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Dec 15, 2024

Warning

Rate limit exceeded

@mynetfan has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 7 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between aa8003e and 552c3d9.

📒 Files selected for processing (1)
  • packages/effects/plugins/src/vxe-table/use-vxe-grid.vue (1 hunks)

Walkthrough

The pull request introduces sorting capabilities to the VbenVxeGrid component across multiple files. In the backend mock API (apps/backend-mock/api/table/list.ts), a new sorting mechanism is implemented to handle sortBy and sortOrder parameters. The use-vxe-grid.vue component is updated to improve grid initialization, and the remote.vue example demonstrates the implementation of sortable columns with server-side sorting configuration.

Changes

File Change Summary
apps/backend-mock/api/table/list.ts Added sorting logic for mock data response, supporting sortBy and sortOrder parameters
packages/effects/plugins/src/vxe-table/use-vxe-grid.vue Updated grid initialization process, replaced props.api.reload() with props.api.grid.commitProxy('_init')
playground/src/views/examples/vxe-table/remote.vue Added sortable: true to columns, updated proxyConfig and sortConfig to enable server-side sorting

Sequence Diagram

sequenceDiagram
    participant Client
    participant Grid
    participant API
    Client->>Grid: Configure sortable columns
    Client->>Grid: Trigger sort
    Grid->>API: Send sort parameters
    API->>API: Sort data
    API-->>Grid: Return sorted data
    Grid->>Client: Display sorted data
Loading

Assessment against linked issues

Objective Addressed Explanation
Fix default sort not working [#5125]
Ensure sort parameters are sent on first load

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • anncwb
  • vince292007

Poem

🐰 Sorting magic, data's delight,
Columns dance with algorithmic might,
VxeGrid leaps, with order so clear,
Rows rearranged without a fear,
Rabbit's code brings sorting's sweet song! 🎉


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. (Beta)
  • @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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

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: 1

🧹 Nitpick comments (1)
apps/backend-mock/api/table/list.ts (1)

48-69: Consider optimizing the sorting implementation.

While the current implementation is functional, consider these improvements:

  1. Use a type-safe approach for sortBy field validation
  2. Consider caching sorted results for frequently used sort combinations
-  if (sortBy && Reflect.has(listData[0], sortBy as string)) {
+  const validSortFields = ['category', 'color', 'productName', 'price'] as const;
+  type ValidSortField = typeof validSortFields[number];
+  
+  if (sortBy && validSortFields.includes(sortBy as ValidSortField)) {
     listData.sort((a, b) => {
-      if (sortOrder === 'asc') {
-        if (sortBy === 'price') {
-          return (
-            Number.parseFloat(a[sortBy as string]) -
-            Number.parseFloat(b[sortBy as string])
-          );
-        } else {
-          return a[sortBy as string] > b[sortBy as string] ? 1 : -1;
-        }
-      } else {
-        if (sortBy === 'price') {
-          return (
-            Number.parseFloat(b[sortBy as string]) -
-            Number.parseFloat(a[sortBy as string])
-          );
-        } else {
-          return a[sortBy as string] < b[sortBy as string] ? 1 : -1;
-        }
-      }
+      const field = sortBy as ValidSortField;
+      const multiplier = sortOrder === 'asc' ? 1 : -1;
+      
+      if (field === 'price') {
+        return multiplier * (Number.parseFloat(a[field]) - Number.parseFloat(b[field]));
+      }
+      
+      return multiplier * a[field].localeCompare(b[field]);
     });
   }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 698daf4 and aa8003e.

📒 Files selected for processing (3)
  • apps/backend-mock/api/table/list.ts (1 hunks)
  • packages/effects/plugins/src/vxe-table/use-vxe-grid.vue (1 hunks)
  • playground/src/views/examples/vxe-table/remote.vue (1 hunks)
🔇 Additional comments (3)
playground/src/views/examples/vxe-table/remote.vue (2)

28-31: LGTM: Column configuration for sorting is properly implemented.

The sortable property is correctly added to the relevant columns, enabling sorting functionality.


39-44: Verify sort parameter handling across the application.

The sort configuration and proxy setup look correct. However, we should verify:

  1. The backend API correctly processes these sort parameters
  2. The default sort on 'category' field works as expected

Also applies to: 48-52

✅ Verification successful

Let me gather more information about the API implementation to verify the sort parameter handling.


Based on the analysis of the code, I can now provide a final response:

Sort parameter handling is correctly implemented across the application

The verification shows that:

  1. The backend API (apps/backend-mock/api/table/list.ts) properly handles both sortBy and sortOrder parameters with correct type checking and sorting logic, including special handling for numeric fields like 'price'.
  2. The sort configuration is consistently implemented in the table components, with multiple sortable columns defined in both remote and basic table examples.
  3. The default sort on 'category' field is uniquely configured in the remote table component and doesn't conflict with other implementations.
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify sort parameter handling across components

# Check if other grid instances also implement sorting
rg -A 2 "sortable: true" 

# Check if other components use similar sort configuration
rg -A 2 "defaultSort.*category"

# Check if the API endpoint handles these parameters consistently
rg -A 2 "sortBy.*sortOrder"

Length of output: 1800


Script:

#!/bin/bash
# Check the API implementation details
cat apps/backend-mock/api/table/list.ts

# Check if there are any other API endpoints using similar sort parameters
rg -g "*.ts" -A 5 "sortOrder.*desc|asc"

# Check for any test files related to sorting
fd -e test.ts -e spec.ts -X cat

Length of output: 65677

apps/backend-mock/api/table/list.ts (1)

46-47: LGTM: Safe data handling with structuredClone.

Good practice using structuredClone to avoid modifying the original data.

packages/effects/plugins/src/vxe-table/use-vxe-grid.vue Outdated Show resolved Hide resolved
@mynetfan mynetfan merged commit bedf199 into vbenjs:main Dec 15, 2024
13 checks passed
@mynetfan mynetfan deleted the fix/grid-first-load branch December 15, 2024 04:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: VbenVxeGrid default sort not working
1 participant