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 issue in credentials modal to properly update value #1866

Merged

Conversation

basuabhirup
Copy link
Collaborator

Fixes #1856

fix-typebot-issue-1856.mp4

Copy link

vercel bot commented Oct 28, 2024

@basuabhirup is attempting to deploy a commit to the Typebot Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

coderabbitai bot commented Oct 28, 2024

Walkthrough

The changes involve updating the UpdateForgedCredentialsModalContent component to include a refetch function from the trpc.credentials.getCredentials.useQuery hook. This addition allows the component to refresh credentials data after a successful update. The refetchCredentials function is called in the mutation's onSuccess callback to ensure the latest data is fetched. The error handling remains unchanged, and the overall structure of the component is preserved.

Changes

File Change Summary
apps/builder/src/features/forge/components/credentials/UpdateForgedCredentialsModalContent.tsx Added refetch function to refresh credentials data after a successful update in the modal component.

Assessment against linked issues

Objective Addressed Explanation
Update credentials then re-open the modal shows previous values (#1856)

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.

@baptisteArno baptisteArno merged commit e642c0c into baptisteArno:main Oct 28, 2024
1 of 5 checks passed
Copy link

@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/builder/src/features/forge/components/credentials/UpdateForgedCredentialsModalContent.tsx (1)

65-67: Consider handling potential race conditions.

The addition of refetchCredentials() after onUpdate() correctly addresses the stale data issue. However, if onUpdate() triggers a re-render, there might be a race condition between the re-render and the refetch.

Consider wrapping both calls in a single effect:

    onSuccess: () => {
-     onUpdate();
-     refetchCredentials();
+     Promise.all([
+       onUpdate(),
+       refetchCredentials()
+     ]).catch(console.error);
    },
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 6a02942 and 1428f6d.

📒 Files selected for processing (1)
  • apps/builder/src/features/forge/components/credentials/UpdateForgedCredentialsModalContent.tsx (2 hunks)
🔇 Additional comments (2)
apps/builder/src/features/forge/components/credentials/UpdateForgedCredentialsModalContent.tsx (2)

Line range hint 38-47: LGTM! Good addition of refetch functionality.

The addition of refetch from the query hook is a good practice that will help maintain data freshness.


Line range hint 38-67: Verify the fix resolves the stale data issue.

The implementation looks correct, but let's verify that the modal now shows updated values when reopened.

✅ Verification successful

Let me gather more information about the similar modal components to ensure they handle updates correctly.


The fix correctly handles stale data and is consistent with other similar implementations

The implementation in UpdateForgedCredentialsModalContent.tsx is correct and follows the same pattern used in other credential modal components in the codebase. All three components (SmtpUpdateModalContent, UpdateStripeCredentialsModalContent, and UpdateForgedCredentialsModalContent) properly:

  • Initialize state from existingCredentials using useEffect
  • Reset state only when existingCredentials changes and local state is not yet set
  • Properly handle updates with mutation callbacks
  • Refresh data after updates using appropriate refetch/callback mechanisms

The fix will resolve the stale data issue as intended.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any other components that might be caching or storing credential data
# which could interfere with this fix

echo "Searching for other credential-related state management..."
rg -l "credentials" --type ts --type tsx | xargs rg "useState.*credentials|useQuery.*credentials" -A 2

echo "Searching for other modal components that might need similar fixes..."
rg -l "Modal.*Content" --type tsx | xargs rg "getCredentials.useQuery" -A 2

Length of output: 1647


Script:

#!/bin/bash
# Check the implementation of similar modal components for potential stale data issues

echo "Checking SmtpUpdateModalContent implementation..."
cat "apps/builder/src/features/blocks/integrations/sendEmail/components/SmtpUpdateModalContent.tsx"

echo -e "\nChecking UpdateStripeCredentialsModalContent implementation..."
cat "apps/builder/src/features/blocks/inputs/payment/components/UpdateStripeCredentialsModalContent.tsx"

Length of output: 10703

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.

Update credentials then re-open the modal shows previous values
2 participants