Skip to content

Remove unused account usage API and interface #7117

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

Merged
merged 1 commit into from
May 21, 2025

Conversation

jnsdls
Copy link
Member

@jnsdls jnsdls commented May 21, 2025

Blocks: thirdweb-dev/api-server#1669

Remove Unused UsageBillableByService Interface and Refactor Usage Component

This PR removes the deprecated UsageBillableByService interface and the getAccountUsage function, which are no longer needed. The Usage component has been updated to use data directly from the team object instead of the previously fetched account usage data.

Key changes:

  • Removed UsageBillableByService interface from useApi.ts
  • Deleted the getAccountUsage.ts file which is no longer needed
  • Updated the Usage component to use team.capabilities for rate limit information
  • Simplified the page component by removing the accountUsage dependency

These changes streamline the codebase by removing redundant code and using data that's already available through the team object.

Summary by CodeRabbit

  • Refactor

    • Simplified the usage overview by removing reliance on separate usage data and using team capabilities data directly.
    • Streamlined internal logic for fetching and displaying usage information.
  • Chores

    • Removed unused code and data structures related to usage metrics.

No visible changes to the user interface or features are introduced.

Copy link

vercel bot commented May 21, 2025

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

Name Status Preview Comments Updated (UTC)
thirdweb-www ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 21, 2025 9:34pm
4 Skipped Deployments
Name Status Preview Comments Updated (UTC)
docs-v2 ⬜️ Skipped (Inspect) May 21, 2025 9:34pm
login ⬜️ Skipped (Inspect) May 21, 2025 9:34pm
thirdweb_playground ⬜️ Skipped (Inspect) May 21, 2025 9:34pm
wallet-ui ⬜️ Skipped (Inspect) May 21, 2025 9:34pm

@vercel vercel bot temporarily deployed to Preview – wallet-ui May 21, 2025 21:26 Inactive
@vercel vercel bot temporarily deployed to Preview – docs-v2 May 21, 2025 21:26 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground May 21, 2025 21:26 Inactive
@vercel vercel bot temporarily deployed to Preview – login May 21, 2025 21:26 Inactive
Copy link

coderabbitai bot commented May 21, 2025

Walkthrough

The changes remove interfaces related to usage data structures, delete a function for fetching account usage from an API, and refactor components to eliminate reliance on the removed usage data. The affected React component now directly accesses rate limit data from team capabilities, and related imports, props, and logic are updated accordingly.

Changes

File(s) Change Summary
apps/dashboard/src/@3rdweb-sdk/react/hooks/useApi.ts Removed the UsageStorage and UsageBillableByService interfaces.
apps/dashboard/src/app/(app)/team/[team_slug]/(team)/~/usage/getAccountUsage.ts Deleted the file containing the getAccountUsage async function.
apps/dashboard/src/app/(app)/team/[team_slug]/(team)/~/usage/overview/components/Usage.tsx Removed the usage prop from the Usage component and all related logic; now uses team.capabilities directly.
apps/dashboard/src/app/(app)/team/[team_slug]/(team)/~/usage/page.tsx Removed import and usage of getAccountUsage; updated data fetching and component usage accordingly.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PageComponent
    participant TeamCapabilities
    participant UsageComponent

    User->>PageComponent: Request usage overview page
    PageComponent->>TeamCapabilities: Fetch team capabilities, subscriptions, projects, RPC usage
    PageComponent->>UsageComponent: Render Usage (with team.capabilities)
    UsageComponent->>TeamCapabilities: Access rate limit data directly
    UsageComponent-->>PageComponent: Rendered output
    PageComponent-->>User: Return rendered page
Loading

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4b9a506 and b6afc90.

📒 Files selected for processing (4)
  • apps/dashboard/src/@3rdweb-sdk/react/hooks/useApi.ts (0 hunks)
  • apps/dashboard/src/app/(app)/team/[team_slug]/(team)/~/usage/getAccountUsage.ts (0 hunks)
  • apps/dashboard/src/app/(app)/team/[team_slug]/(team)/~/usage/overview/components/Usage.tsx (3 hunks)
  • apps/dashboard/src/app/(app)/team/[team_slug]/(team)/~/usage/page.tsx (2 hunks)
💤 Files with no reviewable changes (2)
  • apps/dashboard/src/@3rdweb-sdk/react/hooks/useApi.ts
  • apps/dashboard/src/app/(app)/team/[team_slug]/(team)/~/usage/getAccountUsage.ts
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Unit Tests
  • GitHub Check: Lint Packages
  • GitHub Check: Size
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (8)
apps/dashboard/src/app/(app)/team/[team_slug]/(team)/~/usage/page.tsx (3)

33-47: Properly removed accountUsage from Promise.all

The removal of getAccountUsage from the Promise.all call is correctly implemented, reducing the number of API calls from four to three. This change aligns with the PR objective of removing the unused account usage API.


49-55: Simplified conditional check

The conditional check has been properly updated to only verify the presence of subscriptions rather than both accountUsage and subscriptions. This change maintains the error handling while adapting to the removal of the account usage API.


62-76: Successfully removed usage prop from the Usage component

The Usage component is now rendered without the usage prop, which is consistent with the component's updated prop requirements. This change completes the refactoring by ensuring that the removed API data is no longer passed to downstream components.

apps/dashboard/src/app/(app)/team/[team_slug]/(team)/~/usage/overview/components/Usage.tsx (5)

7-7: Import statement properly updated

The import statement has been updated to reflect the removal of the UsageBillableByService type, which is no longer needed after removing the account usage API.


36-43: Component parameters correctly updated

The usage parameter has been properly removed from the component destructuring, aligning with the changes to the UsageProps type and the removal of the account usage API.


49-56: Gateway metrics now rely on team capabilities

The gatewayMetrics calculation has been refactored to use team.capabilities.storage.upload.rateLimit directly instead of data from the previously passed usage prop. This change maintains functionality while eliminating the dependency on the removed API.


133-133: RPC request description updated to use team capabilities

The description for RPC requests now correctly references team.capabilities.rpc.rateLimit to display the rate limit information, maintaining consistency with the other capability-based data access changes in this component.


17-29: UsageProps type definition updated

The UsageProps type definition has been correctly updated to remove the usage prop, aligning with the removal of the account usage API and interface.

✨ Finishing Touches
  • 📝 Generate Docstrings

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

Copy link
Member Author

jnsdls commented May 21, 2025


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • merge-queue - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@github-actions github-actions bot added the Dashboard Involves changes to the Dashboard. label May 21, 2025
@jnsdls jnsdls marked this pull request as ready for review May 21, 2025 21:27
@jnsdls jnsdls requested review from a team as code owners May 21, 2025 21:27
Copy link

codecov bot commented May 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.60%. Comparing base (4b9a506) to head (b6afc90).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #7117   +/-   ##
=======================================
  Coverage   55.60%   55.60%           
=======================================
  Files         901      901           
  Lines       58121    58121           
  Branches     4067     4067           
=======================================
  Hits        32320    32320           
  Misses      25696    25696           
  Partials      105      105           
Flag Coverage Δ
packages 55.60% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
thirdweb (esm) 56.57 KB (0%) 1.2 s (0%) 208 ms (+106.66% 🔺) 1.4 s
thirdweb (cjs) 309.52 KB (0%) 6.2 s (0%) 824 ms (-6.98% 🔽) 7.1 s
thirdweb (minimal + tree-shaking) 5.69 KB (0%) 114 ms (0%) 72 ms (+1017.38% 🔺) 186 ms
thirdweb/chains (tree-shaking) 531 B (0%) 11 ms (0%) 19 ms (+667.21% 🔺) 30 ms
thirdweb/react (minimal + tree-shaking) 19.5 KB (0%) 390 ms (0%) 98 ms (+470.88% 🔺) 488 ms

@jnsdls jnsdls merged commit 6c3a8d3 into main May 21, 2025
27 checks passed
@jnsdls jnsdls deleted the Remove_unused_account_usage_API_and_interface branch May 21, 2025 23:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Dashboard Involves changes to the Dashboard.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant