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: handled form using useEffect hook #2325

Conversation

ankurjaiswalofficial
Copy link

@ankurjaiswalofficial ankurjaiswalofficial commented Oct 11, 2024

What does this PR do?

Updated the delete-api file where i added the useEffect to handle mounting and unmounting of the delete api dialog .

Fixes #2316

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?
Navigate to Dashboard => API's workspace => Select an API => Go to API Settings => Click on Delete API.
Open the Delete API dialog, enter data in the input fields, close the dialog, and then reopen it.
Verify that the input fields are reset to their default (empty) state on reopening.

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
  • 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 the Delete API dialog to reset form fields and clear errors upon closing.
  • Bug Fixes

    • Corrected a minor class name issue in the Card component for improved styling.

Copy link

changeset-bot bot commented Oct 11, 2024

⚠️ No Changeset found

Latest commit: 6decb08

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

vercel bot commented Oct 11, 2024

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

Name Status Preview Comments Updated (UTC)
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 11, 2024 8:37am

Copy link
Contributor

coderabbitai bot commented Oct 11, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request involve the addition of a useEffect hook in the DeleteApi component to reset form fields and clear errors when the dialog is closed. Additionally, a minor correction was made to a class name in the Card component. These modifications ensure that the dialog resets its state properly upon reopening, enhancing the user experience.

Changes

File Path Change Summary
apps/dashboard/app/(app)/apis/[apiId]/settings/delete-api.tsx Added useEffect to reset form fields and clear errors when the dialog is closed; corrected class name from "borrder-opacity-50" to "border-opacity-50".

Assessment against linked issues

Objective Addressed Explanation
Reset input fields in API delete dialog after reopening (#2316)

Possibly related PRs

  • fix: Delete modal fixes for longer permissions #2084: The changes in the DeletePermission component involve improvements to the dialog's user interface, which may relate to the overall handling of modal dialogs, similar to the DeleteApi component's enhancements in managing form state when the dialog is closed.

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

@ankurjaiswalofficial 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 11, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

github-actions bot commented Oct 11, 2024

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

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 (1)
apps/dashboard/app/(app)/apis/[apiId]/settings/delete-api.tsx (1)

87-93: LGTM: useEffect hook implemented correctly.

The useEffect hook successfully addresses the PR objective of resetting input fields when the dialog is closed. The implementation is correct and comprehensive, resetting both form fields and clearing errors.

Consider rephrasing the comment for clarity:

- // whenever the form is opened the state changes and on unmounting the dialog the form will automatically reset 
+ // Reset form fields and clear errors when the dialog is closed

This more directly describes the hook's purpose and aligns with the PR objectives.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 0608fee and 6decb08.

📒 Files selected for processing (1)
  • apps/dashboard/app/(app)/apis/[apiId]/settings/delete-api.tsx (2 hunks)
🧰 Additional context used
🔇 Additional comments (3)
apps/dashboard/app/(app)/apis/[apiId]/settings/delete-api.tsx (3)

4-4: LGTM: Import statement updated correctly.

The addition of useEffect to the import statement is consistent with the PR objectives and the subsequent code changes. The explicit import of useState is also a good practice, as it was already being used in the component.


99-99: Good catch: Typo in class name corrected.

The typo in the CSS class name has been fixed from "borrder-opacity-50" to "border-opacity-50". This correction ensures that the intended styling is applied correctly.


Line range hint 1-193: Overall assessment: Changes successfully address the PR objectives.

The implemented changes effectively solve the issue of input fields not resetting in the API delete dialog. The useEffect hook ensures that the form is reset when the dialog is closed, aligning perfectly with the PR objectives. The code is clean, well-structured, and the minor typo fix contributes to improved code quality.

To ensure the changes work as intended, please verify the following:

  1. The dialog opens and closes correctly.
  2. Input fields are properly reset when the dialog is closed and reopened.
  3. No console errors are thrown during this process.

You can use the following script to search for any remaining instances of the typo:

This will help ensure that the typo has been completely eliminated from the codebase.

@ankurjaiswalofficial ankurjaiswalofficial changed the title handled form using useEffect hook fix: handled form using useEffect hook Oct 11, 2024
@perkinsjr
Copy link
Collaborator

@ankurjaiswalofficial please sign the CLA

@ankurjaiswalofficial
Copy link
Author

ankurjaiswalofficial commented Oct 12, 2024

@perkinsjr

I signed it now

@chronark chronark self-assigned this Oct 12, 2024
@chronark
Copy link
Collaborator

This PR is incorrectly referencing another PR, not an issue.
Regardless, the issue is currently assigned to someone else, please do not do any work unless you are assigned because we may have to reject it

@chronark chronark closed this Oct 12, 2024
@ankurjaiswalofficial ankurjaiswalofficial deleted the reset-input-fields-in-API-delete-dialog branch October 12, 2024 08:44
@ankurjaiswalofficial ankurjaiswalofficial restored the reset-input-fields-in-API-delete-dialog branch October 12, 2024 08:44
@ankurjaiswalofficial ankurjaiswalofficial deleted the reset-input-fields-in-API-delete-dialog branch October 12, 2024 08:49
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.

4 participants