Skip to content

refactor: remove rsc from apis#3392

Merged
ogzhanolguncu merged 2 commits intomainfrom
remove-rsc-from-apis
Jun 24, 2025
Merged

refactor: remove rsc from apis#3392
ogzhanolguncu merged 2 commits intomainfrom
remove-rsc-from-apis

Conversation

@ogzhanolguncu
Copy link
Contributor

@ogzhanolguncu ogzhanolguncu commented Jun 18, 2025

What does this PR do?

This PR removes RSC from /apis, and uses the same tRPC endpoint that we use to fetch side bar API list. So we are getting rid of one redundant db call.

Fixes # (issue)

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

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

  • Verify that /apis work as before.

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

    • Introduced loading skeletons for API cards and metric stats to enhance the visual experience during data fetching.
  • Refactor

    • Shifted API list fetching and pagination to the client side, enabling dynamic loading and improved error handling.
    • Updated the API list interface to support infinite scrolling with a "Load more" button.
    • Enhanced empty state messages for clearer feedback when no APIs or search results are found.
    • Replaced the previous navigation and grid components with a streamlined layout and updated controls.
  • Chores

    • Removed unused server-side data fetching and authentication logic, making the APIs overview page fully client-rendered.

@changeset-bot
Copy link

changeset-bot bot commented Jun 18, 2025

⚠️ No Changeset found

Latest commit: 3fd6402

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 18, 2025

📝 Walkthrough

Walkthrough

The API overview page and its components were refactored to move all data fetching and navigation logic to the client side. Server-side data fetching and the Navigation component were removed. The main list now uses infinite client-side queries, improved loading skeletons, and updated UI structure with the Navbar component.

Changes

File(s) Change Summary
apps/dashboard/app/(app)/apis/_components/api-list-client.tsx Refactored to fetch API data client-side using infinite queries; removed initialData prop; updated error/loading/empty logic.
apps/dashboard/app/(app)/apis/_components/api-list-grid.tsx Refactored to rely on external props for pagination/loading; removed internal state and data fetching logic.
apps/dashboard/app/(app)/apis/_components/skeleton.tsx Added skeleton loading components for charts, metric stats, and API cards.
apps/dashboard/app/(app)/apis/navigation.tsx Deleted the Navigation component and its related logic.
apps/dashboard/app/(app)/apis/page.tsx Converted to a client component; removed all server-side data fetching and redirects; replaced navigation with Navbar.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ApisOverviewPage
    participant ApiListClient
    participant trpc.api.overview.query.useInfiniteQuery

    User->>ApisOverviewPage: Loads API overview page
    ApisOverviewPage->>ApiListClient: Renders component
    ApiListClient->>trpc.api.overview.query.useInfiniteQuery: Fetch API overview data (paginated)
    trpc.api.overview.query.useInfiniteQuery-->>ApiListClient: Returns pages of API data
    ApiListClient->>User: Shows loading skeletons, API list, or empty state
    User->>ApiListClient: Clicks "Load more"
    ApiListClient->>trpc.api.overview.query.useInfiniteQuery: Fetch next page
    trpc.api.overview.query.useInfiniteQuery-->>ApiListClient: Returns next page
    ApiListClient->>User: Updates API list display
Loading

Possibly related PRs

Suggested labels

🕹️ oss.gg

Suggested reviewers

  • perkinsjr
  • mcstepp
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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
Copy link

vercel bot commented Jun 18, 2025

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 Jun 24, 2025 1:34pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
engineering ⬜️ Ignored (Inspect) Visit Preview Jun 24, 2025 1:34pm

@github-actions
Copy link
Contributor

github-actions bot commented Jun 18, 2025

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

@ogzhanolguncu ogzhanolguncu marked this pull request as ready for review June 18, 2025 13:50
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: 6

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 79665cf and d821fc5.

📒 Files selected for processing (5)
  • apps/dashboard/app/(app)/apis/_components/api-list-client.tsx (1 hunks)
  • apps/dashboard/app/(app)/apis/_components/api-list-grid.tsx (2 hunks)
  • apps/dashboard/app/(app)/apis/_components/skeleton.tsx (1 hunks)
  • apps/dashboard/app/(app)/apis/navigation.tsx (0 hunks)
  • apps/dashboard/app/(app)/apis/page.tsx (1 hunks)
💤 Files with no reviewable changes (1)
  • apps/dashboard/app/(app)/apis/navigation.tsx
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Test Packages / Test ./internal/clickhouse
🔇 Additional comments (2)
apps/dashboard/app/(app)/apis/_components/api-list-grid.tsx (1)

1-68: I couldn’t locate any references using the --type flags. Let’s try a straight grep across all files:

#!/bin/bash
# Search for any usage or import of ApiListGrid in the repo
rg -n "ApiListGrid"
apps/dashboard/app/(app)/apis/_components/api-list-client.tsx (1)

51-54: Redirect on query error may be wrong destination

router.push("/new") routes to the global /new, which seems unrelated to APIs and might break contextual navigation.
Should this be /apis?new=true (to open the create-API modal) or another path?

@mcstepp mcstepp self-assigned this Jun 24, 2025
Copy link
Collaborator

@mcstepp mcstepp left a comment

Choose a reason for hiding this comment

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

👍

nice and smol

Copy link
Contributor Author

@mcstepp so should James need to see this?

Copy link
Contributor Author

I mean review

Copy link
Member

Why would I need to review this?

Copy link
Contributor Author

production stuff should be review by 2 people

Copy link
Member

2 person reviews don't go into our flow until SOC2 auditing starts... And then it will be enforced in GH

Copy link
Contributor Author

aaaah shit sry

Copy link
Member

🙂

Copy link
Contributor Author

I mean you can still see it don't hold yourself 🤣

@ogzhanolguncu ogzhanolguncu added this pull request to the merge queue Jun 24, 2025
Copy link
Member

LGTM :blob-thumbs-up:

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

♻️ Duplicate comments (1)
apps/dashboard/app/(app)/apis/_components/api-list-client.tsx (1)

83-85: Counter display is misleading during search

When searching, showing "Showing X of Y APIs" is confusing because it implies pagination when search results are displayed in full. The counter should be adapted for search context.

-<div className="text-center text-sm text-accent-11">
-  Showing {apiList.length} of {apisData?.pages[0]?.total || 0} APIs
-</div>
+<div className="text-center text-sm text-accent-11">
+  {isSearching 
+    ? `${apiList.length} results found`
+    : `Showing ${apiList.length} of ${apisData?.pages[0]?.total || 0} APIs`
+  }
+</div>
📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d821fc5 and 3fd6402.

📒 Files selected for processing (1)
  • apps/dashboard/app/(app)/apis/_components/api-list-client.tsx (1 hunks)
🔇 Additional comments (3)
apps/dashboard/app/(app)/apis/_components/api-list-client.tsx (3)

69-69: Good fix: skeleton count now matches fetch limit

The skeleton count now uses DEFAULT_LIMIT instead of a hardcoded value, ensuring the loading state matches the expected data size and preventing visual jumps.


87-87: Load more button correctly respects search state

The "Load more" button now properly checks !isSearching condition, preventing pagination during search operations as intended.


50-54: ```shell
#!/bin/bash

Preview the contents of the top of the /new page to verify its purpose

head -n 100 apps/dashboard/app/new/page.tsx


</details>

</blockquote></details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

Comment on lines +46 to +48
useEffect(() => {
setApiList(allApis);
}, [allApis]);
Copy link
Contributor

Choose a reason for hiding this comment

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

🧹 Nitpick (assertive)

Consider potential state synchronization conflicts

The useEffect synchronizes allApis (server data) to apiList (local state), but search operations modify apiList directly. If new server data arrives while searching, the search results would be overwritten.

While this may not be a practical issue due to search disabling pagination, consider a more explicit state management pattern to avoid potential conflicts.

// Consider using derived state instead of synchronization:
-const [apiList, setApiList] = useState(allApis);
-
-useEffect(() => {
-  setApiList(allApis);
-}, [allApis]);
+const [searchResults, setSearchResults] = useState<typeof allApis>([]);
+const [isSearching, setIsSearching] = useState(false);
+
+const displayedApis = isSearching ? searchResults : allApis;

Committable suggestion skipped: line range outside the PR's diff.

🤖 Prompt for AI Agents
In apps/dashboard/app/(app)/apis/_components/api-list-client.tsx around lines 46
to 48, the useEffect hook directly sets apiList state from allApis, but since
apiList is also modified by search operations, incoming updates to allApis can
overwrite search results. To fix this, separate the source data (allApis) from
the filtered or displayed data (apiList) by maintaining distinct states or use
memoized derived state for search results, ensuring that updates to allApis do
not overwrite user-driven changes like search filtering.

Merged via the queue into main with commit 17edcd8 Jun 24, 2025
31 checks passed
@ogzhanolguncu ogzhanolguncu deleted the remove-rsc-from-apis branch June 24, 2025 13:40
@coderabbitai coderabbitai bot mentioned this pull request Sep 23, 2025
18 tasks
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.

3 participants