Skip to content

chore: update endpoint to rotate secret key #7122

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 22, 2025

Conversation

arcoraven
Copy link
Contributor

@arcoraven arcoraven commented May 22, 2025

[Dashboard] Fix: Update Secret Key Rotation API Endpoint

Notes for the reviewer

This PR updates the secret key rotation functionality to use the new team-based API endpoint structure. The rotateSecretKeyClient function now requires both teamId and projectId parameters, and the API endpoint has been updated to follow the /v1/teams/{teamId}/projects/{projectId}/rotate-secret-key pattern.

How to test

Test the secret key rotation functionality in:

  1. Project FTUX
  2. Nebula FTUX
  3. Project General Settings page

Verify that the secret key can be successfully rotated in all these locations.

Summary by CodeRabbit

  • Refactor
    • Updated secret key rotation to require both team and project identifiers for enhanced security and context.
    • Modified components to include team ID alongside project data, improving integration and user experience in project-related sections.

PR-Codex overview

This PR focuses on enhancing the handling of project and team identifiers in the NebulaFTUX, ProjectFTUX, and SecretKeySection components, as well as updating the rotateSecretKeyClient function to accept both teamId and projectId for better API interaction.

Detailed summary

  • Added teamId prop to NebulaFTUX and ProjectFTUX.
  • Updated NebulaFTUX to pass teamId to SecretKeySection.
  • Modified rotateSecretKeyClient to accept an object with teamId and projectId.
  • Changed the API call in rotateSecretKeyClient to use the new parameters.
  • Adjusted SecretKeySection to accept teamId and pass it to rotateSecretKeyClient.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Copy link

vercel bot commented May 22, 2025

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

Name Status Preview Comments Updated (UTC)
docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 22, 2025 6:37am
login ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 22, 2025 6:37am
thirdweb_playground ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 22, 2025 6:37am
thirdweb-www ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 22, 2025 6:37am
wallet-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 22, 2025 6:37am

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

changeset-bot bot commented May 22, 2025

⚠️ No Changeset found

Latest commit: 1ad109f

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

coderabbitai bot commented May 22, 2025

Walkthrough

The changes update the secret key rotation functionality to require both teamId and projectId instead of just projectId. Component props and function signatures are adjusted to pass and accept the teamId alongside existing identifiers throughout the component hierarchy and API client logic.

Changes

File(s) Change Summary
apps/dashboard/src/@3rdweb-sdk/react/hooks/useApi.ts Updated rotateSecretKeyClient to accept { teamId, projectId } instead of just projectId, and changed API endpoint and request body accordingly.
apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/components/ProjectFTUX/ProjectFTUX.tsx Modified IntegrateAPIKeySection to pass teamId along with secretKeyMasked and projectId to SecretKeySection.
apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/components/ProjectFTUX/SecretKeySection.tsx Added teamId prop to SecretKeySection. Updated call to rotateSecretKeyClient to pass { teamId, projectId } object.
apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/nebula/nebula-ftux.tsx Added teamId prop to NebulaFTUX component and passed it to SecretKeySection alongside existing props.
apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/nebula/page.tsx Passed teamId={team.id} prop to the NebulaFTUX component instance in the FTUX rendering block.
apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/settings/ProjectGeneralSettingsPage.tsx Updated rotateSecretKey callback to call rotateSecretKeyClient with { teamId, projectId } instead of just projectId.

Sequence Diagram(s)

sequenceDiagram
    participant UI_Component as UI Component (e.g., SecretKeySection)
    participant API_Client as rotateSecretKeyClient
    participant API_Server as API Server

    UI_Component->>API_Client: rotateSecretKeyClient({ teamId, projectId })
    API_Client->>API_Server: POST /v1/teams/{teamId}/projects/{projectId}/rotate-secret-key
    API_Server-->>API_Client: Response (new secret key)
    API_Client-->>UI_Component: Promise resolves with result
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 63cadf4 and 1ad109f.

📒 Files selected for processing (6)
  • apps/dashboard/src/@3rdweb-sdk/react/hooks/useApi.ts (1 hunks)
  • apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/components/ProjectFTUX/ProjectFTUX.tsx (1 hunks)
  • apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/components/ProjectFTUX/SecretKeySection.tsx (2 hunks)
  • apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/nebula/nebula-ftux.tsx (2 hunks)
  • apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/nebula/page.tsx (1 hunks)
  • apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/settings/ProjectGeneralSettingsPage.tsx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (6)
  • apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/nebula/page.tsx
  • apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/components/ProjectFTUX/ProjectFTUX.tsx
  • apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/components/ProjectFTUX/SecretKeySection.tsx
  • apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/nebula/nebula-ftux.tsx
  • apps/dashboard/src/@3rdweb-sdk/react/hooks/useApi.ts
  • apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/settings/ProjectGeneralSettingsPage.tsx
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: Unit Tests
  • GitHub Check: E2E Tests (pnpm, esbuild)
  • GitHub Check: E2E Tests (pnpm, webpack)
  • GitHub Check: E2E Tests (pnpm, vite)
  • GitHub Check: Lint Packages
  • GitHub Check: Size
  • GitHub Check: Analyze (javascript)
✨ 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
Contributor Author


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.

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

codecov bot commented May 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.58%. Comparing base (376bdb2) to head (1ad109f).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #7122   +/-   ##
=======================================
  Coverage   55.58%   55.58%           
=======================================
  Files         902      902           
  Lines       58162    58162           
  Branches     4086     4086           
=======================================
  Hits        32329    32329           
  Misses      25731    25731           
  Partials      102      102           
Flag Coverage Δ
packages 55.58% <ø> (ø)
🚀 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

github-actions bot commented May 22, 2025

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
thirdweb (esm) 56.62 KB (0%) 1.2 s (0%) 240 ms (+135.37% 🔺) 1.4 s
thirdweb (cjs) 309.13 KB (0%) 6.2 s (0%) 927 ms (+4.55% 🔺) 7.2 s
thirdweb (minimal + tree-shaking) 5.69 KB (0%) 114 ms (0%) 78 ms (+1231.97% 🔺) 192 ms
thirdweb/chains (tree-shaking) 531 B (0%) 11 ms (0%) 34 ms (+1341.93% 🔺) 44 ms
thirdweb/react (minimal + tree-shaking) 19.5 KB (0%) 390 ms (0%) 84 ms (+370.89% 🔺) 474 ms

@arcoraven arcoraven force-pushed the 05-22-chore_update_endpoint_to_rotate_secret_key branch from b400065 to 63cadf4 Compare May 22, 2025 05:54
@vercel vercel bot temporarily deployed to Preview – docs-v2 May 22, 2025 05:54 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground May 22, 2025 05:54 Inactive
@vercel vercel bot temporarily deployed to Preview – login May 22, 2025 05:54 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui May 22, 2025 05:54 Inactive
@arcoraven arcoraven added the merge-queue Adds the pull request to Graphite's merge queue. label May 22, 2025
Copy link
Contributor Author

arcoraven commented May 22, 2025

Merge activity

## [Dashboard] Fix: Update Secret Key Rotation API Endpoint

## Notes for the reviewer

This PR updates the secret key rotation functionality to use the new team-based API endpoint structure. The `rotateSecretKeyClient` function now requires both `teamId` and `projectId` parameters, and the API endpoint has been updated to follow the `/v1/teams/{teamId}/projects/{projectId}/rotate-secret-key` pattern.

## How to test

Test the secret key rotation functionality in:
1. Project FTUX
2. Nebula FTUX
3. Project General Settings page

Verify that the secret key can be successfully rotated in all these locations.

<!-- This is an auto-generated comment: release notes by coderabbit.ai -->
## Summary by CodeRabbit

- **Refactor**
  - Updated secret key rotation to require both team and project identifiers for enhanced security and context.
  - Modified components to include team ID alongside project data, improving integration and user experience in project-related sections.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

<!-- start pr-codex -->

---

## PR-Codex overview
This PR focuses on updating the handling of project and team identifiers in the `NebulaFTUX` and related components, enhancing the functionality for rotating secret keys by including the `teamId` alongside the `projectId`.

### Detailed summary
- Added `teamId` prop to the `NebulaFTUX` component.
- Passed `teamId` from `NebulaFTUX` to `SecretKeySection`.
- Updated `rotateSecretKeyClient` to accept an object with `teamId` and `projectId`.
- Modified the API call in `rotateSecretKeyClient` to use the new parameters.
- Updated the `SecretKeySection` to handle the new `teamId` prop.

> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}`

<!-- end pr-codex -->
@graphite-app graphite-app bot force-pushed the 05-22-chore_update_endpoint_to_rotate_secret_key branch from c256b5a to 1ad109f Compare May 22, 2025 06:25
@vercel vercel bot temporarily deployed to Preview – login May 22, 2025 06:25 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui May 22, 2025 06:25 Inactive
@vercel vercel bot temporarily deployed to Preview – docs-v2 May 22, 2025 06:25 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground May 22, 2025 06:25 Inactive
@graphite-app graphite-app bot merged commit 1ad109f into main May 22, 2025
24 checks passed
@graphite-app graphite-app bot removed the merge-queue Adds the pull request to Graphite's merge queue. label May 22, 2025
@graphite-app graphite-app bot deleted the 05-22-chore_update_endpoint_to_rotate_secret_key branch May 22, 2025 06:38
@vercel vercel bot temporarily deployed to Production – thirdweb_playground May 22, 2025 06:38 Inactive
@vercel vercel bot temporarily deployed to Production – wallet-ui May 22, 2025 06:38 Inactive
@vercel vercel bot temporarily deployed to Production – login May 22, 2025 06:38 Inactive
@vercel vercel bot temporarily deployed to Production – docs-v2 May 22, 2025 06:38 Inactive
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.

2 participants