Skip to content

chore: pass allowImpersonation flag to /v2/keys/use #7303

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

Conversation

arcoraven
Copy link
Contributor

@arcoraven arcoraven commented Jun 8, 2025

[SDK] Feature: Add support for staff impersonation in API requests

Notes for the reviewer

This PR adds support for staff impersonation in API requests by:

  1. Adding an allowImpersonation flag to CoreServiceConfig to enable staff members to read data for troubleshooting
  2. Updating the TeamAndProjectResponse type to include impersonation details
  3. Modifying the fetchTeamAndProject function to pass the impersonation flag in URL parameters

How to test

Verify that when allowImpersonation is set to true, the parameter is correctly passed to the API request.

Summary by CodeRabbit

  • New Features
    • Added support for allowing staff members to impersonate users for troubleshooting purposes, when enabled.
  • Enhancements
    • Improved team and project data responses to include information about staff impersonation when applicable.

PR-Codex overview

This PR introduces a new feature that allows staff members to impersonate users for troubleshooting purposes by adding an allowImpersonation option to the authentication server. It updates the API response to include impersonation details.

Detailed summary

  • Added allowImpersonation option in CoreServiceConfig.
  • Updated TeamAndProjectResponse to include impersonatedBy object.
  • Modified fetchTeamAndProject function to handle allowImpersonation and set it in the URL query parameters.

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

Copy link

vercel bot commented Jun 8, 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 Jun 8, 2025 10:06am
4 Skipped Deployments
Name Status Preview Comments Updated (UTC)
docs-v2 ⬜️ Skipped (Inspect) Jun 8, 2025 10:06am
login ⬜️ Skipped (Inspect) Jun 8, 2025 10:06am
thirdweb_playground ⬜️ Skipped (Inspect) Jun 8, 2025 10:06am
wallet-ui ⬜️ Skipped (Inspect) Jun 8, 2025 10:06am

@vercel vercel bot temporarily deployed to Preview – login June 8, 2025 09:18 Inactive
@vercel vercel bot temporarily deployed to Preview – docs-v2 June 8, 2025 09:18 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui June 8, 2025 09:18 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground June 8, 2025 09:18 Inactive
Copy link

changeset-bot bot commented Jun 8, 2025

🦋 Changeset detected

Latest commit: f866874

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@thirdweb-dev/service-utils Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Contributor

coderabbitai bot commented Jun 8, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The changes extend the CoreServiceConfig type with an optional allowImpersonation flag, update the TeamAndProjectResponse type to refine the project property and add an impersonatedBy field, and modify the fetchTeamAndProject function to include the allowImpersonation parameter in API requests when enabled.

Changes

File(s) Change Summary
packages/service-utils/src/core/api.ts Added allowImpersonation to CoreServiceConfig, updated TeamAndProjectResponse type, and enhanced fetchTeamAndProject to handle impersonation logic.
.changeset/whole-ends-like.md Added changeset metadata for patch version update and chore description related to passing allowImpersonation flag.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant fetchTeamAndProject
    participant API

    Caller->>fetchTeamAndProject: Call with authData, config (may include allowImpersonation)
    fetchTeamAndProject->>fetchTeamAndProject: Extract allowImpersonation from config
    alt allowImpersonation is true
        fetchTeamAndProject->>API: GET /team-and-project?allowImpersonation=true
    else allowImpersonation is false or undefined
        fetchTeamAndProject->>API: GET /team-and-project
    end
    API-->>fetchTeamAndProject: Respond with TeamAndProjectResponse (may include impersonatedBy)
    fetchTeamAndProject-->>Caller: Return ApiResponse
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 11fe40d and f866874.

📒 Files selected for processing (1)
  • packages/service-utils/src/core/api.ts (3 hunks)
✨ 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 June 8, 2025 09:18
@arcoraven arcoraven requested a review from a team as a code owner June 8, 2025 09:18
Copy link

codecov bot commented Jun 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.57%. Comparing base (b3e42f7) to head (f866874).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #7303   +/-   ##
=======================================
  Coverage   55.57%   55.57%           
=======================================
  Files         909      909           
  Lines       58673    58673           
  Branches     4158     4158           
=======================================
  Hits        32607    32607           
  Misses      25959    25959           
  Partials      107      107           
Flag Coverage Δ
packages 55.57% <ø> (ø)
🚀 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 Jun 8, 2025

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
thirdweb (esm) 62.57 KB (0%) 1.3 s (0%) 188 ms (+127.12% 🔺) 1.5 s
thirdweb (cjs) 345.55 KB (0%) 7 s (0%) 617 ms (+0.98% 🔺) 7.6 s
thirdweb (minimal + tree-shaking) 5.7 KB (0%) 114 ms (0%) 60 ms (+790.8% 🔺) 174 ms
thirdweb/chains (tree-shaking) 531 B (0%) 11 ms (0%) 18 ms (+627.25% 🔺) 29 ms
thirdweb/react (minimal + tree-shaking) 19.56 KB (0%) 392 ms (0%) 78 ms (+734.87% 🔺) 469 ms

@arcoraven arcoraven force-pushed the ph/06-08-chore_pass_allowimpersonation_flag_to__v2_keys_use branch from 9decd2d to 11fe40d Compare June 8, 2025 09:47
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground June 8, 2025 09:58 Inactive
@vercel vercel bot temporarily deployed to Preview – docs-v2 June 8, 2025 09:58 Inactive
@vercel vercel bot temporarily deployed to Preview – login June 8, 2025 09:58 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui June 8, 2025 09:58 Inactive
@arcoraven arcoraven merged commit 6378f37 into main Jun 8, 2025
18 of 20 checks passed
@arcoraven arcoraven deleted the ph/06-08-chore_pass_allowimpersonation_flag_to__v2_keys_use branch June 8, 2025 09:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant