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: Sort Permissions #2165

Merged
merged 1 commit into from
Oct 3, 2024

Conversation

Vardhaman619
Copy link
Contributor

@Vardhaman619 Vardhaman619 commented Oct 3, 2024

What does this PR do?

This PR addresses the issue of permission tables not being sorted correctly. Currently, the user interface displays permission entries in an inconsistent order, making it difficult for users to locate specific permissions quickly. This update ensures that the permission tables are sorted alphabetically by permission name, improving user experience and accessibility.

Fixes #2157
Issue #2157

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Chore (refactoring code, technical debt, workflow improvements)
  • Enhancement (small improvements)
  • 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

How should this be tested?

To verify the changes, please follow these steps:

  • Navigate to the Authorization -> Permissions.
  • Create multiple permissions
  • Ensure that the permissions are displayed in alphabetical order.
  • Test with a variety of permissions to ensure consistent sorting.
  • Verify that no additional functionality has been disrupted by this change.

Checklist

Required

  • Filled out the "How to test" section in this PR
  • Read Contributing Guide
  • Self-reviewed my own code
  • Commented on my code in hard-to-understand areas
  • Ran pnpm build
  • Ran pnpm fmt
  • Checked for warnings, there are none
  • [ X] Removed all console.logs
  • Merged the latest changes from main onto my branch with git pull origin main
  • My changes don't cause any responsiveness issues

Appreciated

  • If a UI change was made: Added a screen recording or screenshots to this PR
  • Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

  • New Features

    • Enhanced permissions retrieval by adding ascending order sorting based on permission names in the RolesPage component.
  • Bug Fixes

    • Continued filtering of soft-deleted permissions ensures accurate display without affecting existing functionality.

Copy link

changeset-bot bot commented Oct 3, 2024

⚠️ No Changeset found

Latest commit: 5ed6146

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 Oct 3, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request focus on the RolesPage component within the apps/dashboard/app/(app)/authorization/permissions/page.tsx file. The modifications include updating the import statement to include the asc function and adding an orderBy clause to the query for fetching permissions. This ensures that permissions are sorted by their name property in ascending order, while maintaining the existing filtering and rendering logic.

Changes

File Path Change Summary
apps/dashboard/app/(app)/authorization/permissions/page.tsx - Updated import to include asc function.
- Added orderBy:[asc(permissions.name)] to sort permissions.

Assessment against linked issues

Objective Addressed Explanation
Permissions should be sorted by name (#2157)

Possibly related PRs

Suggested reviewers

  • chronark
  • perkinsjr
  • mcstepp

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

vercel bot commented Oct 3, 2024

@Vardhaman619 is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

@CLAassistant
Copy link

CLAassistant commented Oct 3, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

github-actions bot commented Oct 3, 2024

Thank you for following the naming conventions for pull request titles! 🙏

@perkinsjr perkinsjr changed the title fix:sort permissions fix: sort permissions Oct 3, 2024
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

🧹 Outside diff range and nitpick comments (1)
apps/dashboard/app/(app)/authorization/permissions/page.tsx (1)

5-5: Overall: Effective implementation of permission sorting

The changes successfully address the PR objective by implementing alphabetical sorting of permissions. The implementation is clean and localized to the permissions page.

As a potential enhancement, consider making the sorting direction (ascending/descending) configurable. This could provide more flexibility for users who might prefer a different sorting order.

Here's a suggestion to make the sorting direction configurable:

  1. Add a new state variable to track the sorting direction:
const [sortDirection, setSortDirection] = useState<'asc' | 'desc'>('asc');
  1. Modify the query to use the state variable:
orderBy: [sortDirection === 'asc' ? asc(permissions.name) : desc(permissions.name)],
  1. Add a UI element (e.g., a button) to toggle the sort direction:
<Button onClick={() => setSortDirection(prev => prev === 'asc' ? 'desc' : 'asc')}>
  Toggle Sort Direction
</Button>

This enhancement would provide users with more control over how permissions are displayed.

Also applies to: 22-22

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 697aaa3 and 5ed6146.

📒 Files selected for processing (1)
  • apps/dashboard/app/(app)/authorization/permissions/page.tsx (2 hunks)
🔇 Additional comments (1)
apps/dashboard/app/(app)/authorization/permissions/page.tsx (1)

5-5: LGTM: Import modification for sorting

The addition of asc to the import statement is appropriate for implementing the sorting functionality required by the PR objectives.

Copy link

vercel bot commented Oct 3, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 3, 2024 4:04pm
planetfall ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 3, 2024 4:04pm
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 3, 2024 4:04pm
workflows ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 3, 2024 4:04pm
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 3, 2024 4:04pm

Copy link
Collaborator

@perkinsjr perkinsjr left a comment

Choose a reason for hiding this comment

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

Looks good to me.

Thanks

@perkinsjr perkinsjr merged commit 713e831 into unkeyed:main Oct 3, 2024
25 of 29 checks passed
mcstepp pushed a commit that referenced this pull request Oct 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[🕹️] Permission tables not being sorted
3 participants