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: Replaced clear button with reset filters button #2703

Merged
merged 7 commits into from
Dec 5, 2024

Conversation

BadriVishalPadhy
Copy link
Contributor

@BadriVishalPadhy BadriVishalPadhy commented Dec 4, 2024

What does this PR do?

replaced Clear-button with reset-filters-button because the clear button function and reset-filters-button function is same .Also clear button was only clearing one item but now resets all.

Fixes #2394

If there is not an issue for this, please create one first. This is used to tracking purposes and also helps use understand why this PR exists

Type of change

  • [ x] Bug fix (non-breaking change which fixes an issue)
  • Chore (refactoring code, technical debt, workflow improvements)
  • [ x] Enhancement (small improvements)
  • [x ] New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • [ x] This change requires a documentation update

How should this be tested?

  • Test A
  • Test B

Checklist

Required

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

Appreciated

Screen.Recording.2024-12-04.at.19.36.04.mov
  • 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 functionality of the Filters component for better clarity and usability.
  • Bug Fixes
    • Removed the filter reset link when no logs are found, simplifying the user interface.
  • Improvements
    • Streamlined the filter reset process and refined state management for a smoother user experience.

Copy link

changeset-bot bot commented Dec 4, 2024

⚠️ No Changeset found

Latest commit: b590ef4

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 4, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces modifications to the Filters component in filter.tsx, specifically renaming the "Clear" button to "Reset Filters" and enhancing its functionality to reset various states. Additionally, the AuditPage component in page.tsx has had a link removed that allowed users to reset filters when no logs were found. These changes aim to improve the clarity and functionality of the filter mechanism within the application.

Changes

File Path Change Summary
apps/dashboard/app/(app)/ratelimits/[namespaceId]/logs/filter.tsx Renamed "Clear" button to "Reset Filters"; updated onClick logic to reset states and handle success state more explicitly.
apps/dashboard/app/(app)/ratelimits/[namespaceId]/logs/page.tsx Removed link for resetting filters when no logs are found; UI simplified but no new functionality introduced.

Assessment against linked issues

Objective Addressed Explanation
The Reset Filters button should clear filters without redirecting (2394)

Possibly related PRs

Suggested labels

hacktoberfest

Suggested reviewers

  • mcstepp
  • perkinsjr
  • chronark

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 30f1e81 and a3f39db.

📒 Files selected for processing (1)
  • apps/dashboard/app/(app)/ratelimits/[namespaceId]/logs/page.tsx (0 hunks)
💤 Files with no reviewable changes (1)
  • apps/dashboard/app/(app)/ratelimits/[namespaceId]/logs/page.tsx

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 Dec 4, 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 Dec 5, 2024 11:48am
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 5, 2024 11:48am
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 5, 2024 11:48am
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 5, 2024 11:48am

Copy link

vercel bot commented Dec 4, 2024

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

A member of the Team first needs to authorize it.

Copy link
Contributor

github-actions bot commented Dec 4, 2024

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

@BadriVishalPadhy BadriVishalPadhy changed the title fixes/replaced-Clear-button-with-reset-filters-button fix : replaced-Clear-button-with-reset-filters-button Dec 4, 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: 2

🧹 Outside diff range and nitpick comments (1)
apps/dashboard/app/(app)/ratelimits/[namespaceId]/logs/filter.tsx (1)

Line range hint 31-201: Consider unifying filter state management

The current implementation manages each filter's visibility and value separately, which could lead to maintenance challenges as more filters are added. Consider implementing a more unified approach to filter state management.

Some suggestions:

  1. Create a single filter configuration object
  2. Implement a generic filter visibility toggle
  3. Use a reducer pattern for filter state management

Example approach:

type FilterState = {
  identifier: { visible: boolean; value: string[] };
  success: { visible: boolean; value: boolean | null };
  timeRange: { visible: boolean; after: Date | null; before: Date | null };
};

type FilterAction = 
  | { type: 'RESET_ALL' }
  | { type: 'TOGGLE_VISIBILITY'; filter: keyof FilterState }
  | { type: 'UPDATE_VALUE'; filter: keyof FilterState; value: any };
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 53c3ff9 and 7503e47.

📒 Files selected for processing (2)
  • apps/dashboard/app/(app)/ratelimits/[namespaceId]/logs/filter.tsx (1 hunks)
  • apps/dashboard/app/(app)/ratelimits/[namespaceId]/logs/page.tsx (1 hunks)
🔇 Additional comments (2)
apps/dashboard/app/(app)/ratelimits/[namespaceId]/logs/page.tsx (1)

139-139: LGTM: Removal of redirect link fixes issue #2394

The removal of the filter reset link resolves the incorrect redirection to "/audit" page and consolidates the reset functionality to the "Reset Filters" button, providing a more consistent user experience.

apps/dashboard/app/(app)/ratelimits/[namespaceId]/logs/filter.tsx (1)

119-119: LGTM: Button label accurately describes its action

The "Reset Filters" label better communicates the button's functionality of resetting all filters, improving user understanding.

@BadriVishalPadhy BadriVishalPadhy changed the title fix : replaced-Clear-button-with-reset-filters-button fix : replaced Clear button with reset filters button Dec 4, 2024
@BadriVishalPadhy BadriVishalPadhy changed the title fix : replaced Clear button with reset filters button fix : Replaced clear button with reset filters button Dec 4, 2024
@BadriVishalPadhy BadriVishalPadhy changed the title fix : Replaced clear button with reset filters button -fix : Replaced clear button with reset filters button Dec 4, 2024
@BadriVishalPadhy BadriVishalPadhy changed the title -fix : Replaced clear button with reset filters button fix:Replaced clear button with reset filters button Dec 4, 2024
@BadriVishalPadhy BadriVishalPadhy changed the title fix:Replaced clear button with reset filters button fix: Replaced clear button with reset filters button Dec 4, 2024
@BadriVishalPadhy
Copy link
Contributor Author

Hey @chronark do check this

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)
apps/dashboard/app/(app)/ratelimits/[namespaceId]/logs/filter.tsx (2)

Line range hint 149-149: Remove unnecessary empty startTransition calls

There are still empty startTransition calls that serve no purpose and should be removed.

Apply these changes:

  1. Remove empty startTransition after setIdentifier:
 setIdentifier(v);
-startTransition(() => {});
  1. Remove empty startTransition after setSuccess:
 setSuccess(v === "true");
-startTransition(() => {});

Also applies to: 182-182


111-119: Extract reset logic into a reusable function

The reset logic is duplicated across multiple button handlers. Consider extracting it into a reusable function for better maintainability and consistency.

Create a handler function like this:

const handleResetFilters = (filterType?: 'all' | 'success' | 'timeRange') => {
  startTransition(() => {
    if (filterType === 'all' || !filterType) {
      setIdentifierVisible(false);
      setSuccessVisible(false);
      setSuccess(null);
      setTimeRangeVisible(false);
      setIdentifier(null);
      setAfter(null);
      setBefore(null);
      setLocalTime("");
    } else if (filterType === 'success') {
      setSuccessVisible(false);
      setSuccess(null);
    } else if (filterType === 'timeRange') {
      setTimeRangeVisible(false);
      setAfter(null);
      setBefore(null);
      setLocalTime("");
    }
  });
};

Then use it in the button handlers:

// Reset all filters
onClick={() => handleResetFilters()}

// Reset success filter
onClick={() => handleResetFilters('success')}

// Reset time range filter
onClick={() => handleResetFilters('timeRange')}

Also applies to: 182-186, 215-220

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7503e47 and 30f1e81.

📒 Files selected for processing (1)
  • apps/dashboard/app/(app)/ratelimits/[namespaceId]/logs/filter.tsx (1 hunks)
🔇 Additional comments (2)
apps/dashboard/app/(app)/ratelimits/[namespaceId]/logs/filter.tsx (2)

111-122: Implementation successfully addresses PR objectives

The changes effectively solve the original issue by:

  1. Preventing redirection to "/audit" page
  2. Providing comprehensive filter reset functionality
  3. Using clearer "Reset Filters" button text for better UX

111-119: ⚠️ Potential issue

Add missing localTime state reset

The reset functionality should also clear the localTime state for complete consistency. While the implementation properly resets most states, it misses the localTime state which is used to display the time range information.

Apply this diff to include the localTime reset:

 startTransition(() => {
   setIdentifierVisible(false);
   setSuccessVisible(false);
   setSuccess(null);
   setTimeRangeVisible(false);
   setIdentifier(null);
   setAfter(null);
   setBefore(null);
+  setLocalTime("");
 });

Likely invalid or redundant comment.

@BadriVishalPadhy
Copy link
Contributor Author

@ogzhanolguncu check

@ogzhanolguncu
Copy link
Contributor

Looks and works great.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reset Filters button on /ratelimits/:id/logs redirects to /audit page
2 participants