fix: revalidate /apis after creating new API

[geraldmaboshe]

What does this PR do?

Fixes #2138

This PR addresses the issue where newly created APIs were not
immediately visible in the API root keys list.
By calling revalidate("/apis") after successful key creation, we ensure
that the list is updated including on MacOS Safari.

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?

• Test A
• Test B

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

Screen.Recording.2024-10-04.at.6.57.19.PM.mov

Summary by CodeRabbit

• New Features

  • Enhanced the Create API button to refresh the API list upon successful creation of a new API.
  • Improved handling of success notifications with asynchronous processing.

• Bug Fixes

  • Removed outdated state update method to streamline the user experience after API creation.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 5cb0203

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

[vercel]

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 4, 2024 9:03pm
planetfall	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 4, 2024 9:03pm
play	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 4, 2024 9:03pm
unkey-engineering	❌ Failed (Inspect)			Oct 4, 2024 9:03pm
workflows	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 4, 2024 9:03pm
www	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 4, 2024 9:03pm

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request modifies the CreateApiButton component in the create-api-button.tsx file. It introduces an asynchronous onSuccess callback for the create mutation, allowing the use of await to call revalidate("/apis"), which refreshes the API list after a new API is created. The previous router.refresh() call has been removed, indicating a change in state management after successful API creation.

Changes

File Path	Change Summary
apps/dashboard/app/(app)/apis/create-api-button.tsx	Updated onSuccess method to be asynchronous and added revalidate function call. Removed router.refresh().

Assessment against linked issues

Objective	Addressed	Explanation
The new root key should show up in the root keys list without requiring a refresh. (#2138)	✅

Possibly related PRs

• feat: Show keyId after creating a new key #2107: The changes in the CreateApiButton component's success handling logic may relate to the user experience improvements in displaying the keyId after creating a new key, as both involve enhancing the functionality and user interaction following a creation process.

Suggested reviewers

• mcstepp
• perkinsjr
• chronark

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[vercel]

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

A member of the Team first needs to authorize it.

[github-actions]

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

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

apps/dashboard/app/(app)/apis/create-api-button.tsx (1)

35-39: LGTM: Revalidation logic added to address the issue.

The changes effectively address the PR objective by adding revalidation after creating a new API. This should ensure that the new API appears in the list without requiring a manual refresh.

Consider removing the empty line at line 39 for better code consistency:

  async onSuccess(res) {
    toast.success("Your API has been created");

    await revalidate("/apis") 
-   
    router.push(`/apis/${res.id}`);
  },

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 600839e and 5cb0203.

📒 Files selected for processing (1)

• apps/dashboard/app/(app)/apis/create-api-button.tsx (2 hunks)

🔇 Additional comments (3)

apps/dashboard/app/(app)/apis/create-api-button.tsx (3)

2-2: LGTM: New import for revalidation.

The addition of the revalidate import is appropriate for addressing the issue of updating the API list in real-time after creating a new API.

---

35-41: LGTM: Removal of redundant refresh call.

The removal of router.refresh() is appropriate as it's been replaced by the more specific revalidate("/apis") call. This change streamlines the update process and avoids unnecessary refreshes.

---

Line range hint 1-99: Summary: Changes effectively address the issue.

The modifications to the CreateApiButton component successfully implement the required functionality to update the API list in real-time after creating a new API. The use of revalidate("/apis") should resolve the issue across all browsers, including MacOS Safari.

To ensure the changes work as expected, please run the following verification script:

This script will help confirm that the changes have been implemented correctly and that no unintended modifications were made.

✅ Verification successful

✅ Verification Successful

The changes in CreateApiButton have been correctly implemented:

• Imported and used the revalidate function from @/app/actions.
• Removed the router.refresh() method.
• Ensured the onSuccess callback is now async.

All verification tests passed, confirming that the API list updates in real-time as intended.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the implementation of revalidate function and its usage

# Test 1: Check if the revalidate function is imported and used correctly
echo "Test 1: Checking revalidate import and usage"
rg --type typescript 'import.*revalidate.*from.*@/app/actions' apps/dashboard/app/\(app\)/apis/create-api-button.tsx && rg --type typescript 'await revalidate\("/apis"\)' apps/dashboard/app/\(app\)/apis/create-api-button.tsx

# Test 2: Verify that router.refresh() has been removed
echo "Test 2: Verifying removal of router.refresh()"
! rg --type typescript 'router\.refresh\(\)' apps/dashboard/app/\(app\)/apis/create-api-button.tsx

# Test 3: Check if the onSuccess callback is now async
echo "Test 3: Checking if onSuccess is async"
rg --type typescript 'async onSuccess\(res\)' apps/dashboard/app/\(app\)/apis/create-api-button.tsx

Length of output: 711

---

Script:

#!/bin/bash
# Description: Verify the implementation of revalidate function and its usage with corrected file types

# Test 1: Check if the revalidate function is imported and used correctly
echo "Test 1: Checking revalidate import and usage"
rg --type tsx 'import.*revalidate.*from.*@/app/actions' apps/dashboard/app/\(app\)/apis/create-api-button.tsx && rg --type tsx 'await revalidate\("/apis"\)' apps/dashboard/app/\(app\)/apis/create-api-button.tsx

# Test 2: Verify that router.refresh() has been removed
echo "Test 2: Verifying removal of router.refresh()"
! rg --type tsx 'router\.refresh\(\)' apps/dashboard/app/\(app\)/apis/create-api-button.tsx

# Test 3: Check if the onSuccess callback is now async
echo "Test 3: Checking if onSuccess is async"
rg --type tsx 'async onSuccess\(res\)' apps/dashboard/app/\(app\)/apis/create-api-button.tsx

Length of output: 669

---

Script:

#!/bin/bash
# Description: Verify the implementation of revalidate function and its usage without relying on file type

# Test 1: Check if the revalidate function is imported and used correctly
echo "Test 1: Checking revalidate import and usage"
rg 'import.*revalidate.*from.*@/app/actions' apps/dashboard/app/\(app\)/apis/create-api-button.tsx && rg 'await revalidate\("/apis"\)' apps/dashboard/app/\(app\)/apis/create-api-button.tsx

# Test 2: Verify that router.refresh() has been removed
echo "Test 2: Verifying removal of router.refresh()"
! rg 'router\.refresh\(\)' apps/dashboard/app/\(app\)/apis/create-api-button.tsx

# Test 3: Check if the onSuccess callback is now async
echo "Test 3: Checking if onSuccess is async"
rg 'async onSuccess\(res\)' apps/dashboard/app/\(app\)/apis/create-api-button.tsx

Length of output: 745

[oss-gg]

Awarding geraldmaboshe: 50 points 🕹️ Well done! Check out your new contribution on oss.gg/geraldmaboshe