Skip to content

Add webhook testing functionality to dashboard #7173

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

Conversation

AmineAfia
Copy link
Contributor

@AmineAfia AmineAfia commented May 27, 2025


PR-Codex overview

This PR enhances the webhook testing functionality in the dashboard by exporting the testWebhook function, integrating it into the WebhooksTable component, and creating a custom hook useTestWebhook for managing testing states and results.

Detailed summary

  • Changed testWebhook function to be exported from webhooks.ts.
  • Added PlayIcon import in WebhooksTable.tsx.
  • Integrated useTestWebhook hook in WebhooksTable.tsx to manage testing state.
  • Implemented handleTestWebhook function for testing webhooks.
  • Updated action buttons in WebhooksTable.tsx to include a test button.
  • Created useTestWebhook hook in useTestWebhook.ts to handle webhook testing logic and results.

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

Summary by CodeRabbit

  • New Features
    • Added the ability to test webhooks directly from the webhooks table with a "Test" button, providing immediate feedback and status indicators during testing.
  • User Interface
    • Enhanced the actions column in the webhooks table for improved layout and usability, including real-time spinner icons and error notifications during webhook testing.

Copy link
Contributor Author

AmineAfia commented May 27, 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.

Copy link

changeset-bot bot commented May 27, 2025

⚠️ No Changeset found

Latest commit: c420099

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 vercel bot temporarily deployed to Preview – thirdweb_playground May 27, 2025 18:06 Inactive
@vercel vercel bot temporarily deployed to Preview – login May 27, 2025 18:06 Inactive
Copy link

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

Copy link
Contributor

coderabbitai bot commented May 27, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

A new webhook testing feature is added to the WebhooksTable component. This includes a custom React hook, useTestWebhook, that manages the state and execution of webhook endpoint tests. The WebhooksTable UI now provides a "Test" button for each webhook, enabling users to trigger and observe the status of webhook tests asynchronously.

Changes

File(s) Change Summary
.../webhooks/components/WebhooksTable.tsx Integrated useTestWebhook hook, added handleTestWebhook function, and introduced a "Test" button to the UI.
.../webhooks/hooks/useTestWebhook.ts Added new useTestWebhook hook to manage webhook test execution, state, and feedback.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant WebhooksTable
    participant useTestWebhook
    participant API

    User->>WebhooksTable: Clicks "Test" button
    WebhooksTable->>useTestWebhook: testWebhookEndpoint(url, type, id)
    useTestWebhook->>API: testWebhook(url, type, clientId)
    API-->>useTestWebhook: Returns success or error
    useTestWebhook-->>WebhooksTable: Updates isTestingMap and testResults
    WebhooksTable-->>User: Updates UI (spinner, toast notification)
Loading

🪧 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 vercel bot temporarily deployed to Preview – wallet-ui May 27, 2025 18:06 Inactive
@vercel vercel bot temporarily deployed to Preview – docs-v2 May 27, 2025 18:06 Inactive
@github-actions github-actions bot added the Dashboard Involves changes to the Dashboard. label May 27, 2025
Copy link

codecov bot commented May 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.66%. Comparing base (dcb412f) to head (c420099).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #7173   +/-   ##
=======================================
  Coverage   55.66%   55.66%           
=======================================
  Files         904      904           
  Lines       58400    58400           
  Branches     4116     4116           
=======================================
  Hits        32510    32510           
  Misses      25784    25784           
  Partials      106      106           
Flag Coverage Δ
packages 55.66% <ø> (ø)
🚀 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 27, 2025

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
thirdweb (esm) 61.75 KB (0%) 1.3 s (0%) 259 ms (+130.07% 🔺) 1.5 s
thirdweb (cjs) 344.4 KB (0%) 6.9 s (0%) 958 ms (+6.69% 🔺) 7.9 s
thirdweb (minimal + tree-shaking) 5.69 KB (0%) 114 ms (0%) 100 ms (+996.7% 🔺) 214 ms
thirdweb/chains (tree-shaking) 531 B (0%) 11 ms (0%) 37 ms (+1226.26% 🔺) 48 ms
thirdweb/react (minimal + tree-shaking) 19.54 KB (0%) 391 ms (0%) 84 ms (+330.48% 🔺) 475 ms

graphite-app bot pushed a commit that referenced this pull request May 28, 2025
<!--

## title your PR with this format: "[SDK/Dashboard/Portal] Feature/Fix: Concise title for the changes"

If you did not copy the branch name from Linear, paste the issue tag here (format is TEAM-0000):

## Notes for the reviewer

Anything important to call out? Be sure to also clarify these in your comments.

## How to test

Unit tests, playground, etc.

-->

<!-- start pr-codex -->

---

## PR-Codex overview
This PR enhances the webhook functionality by exporting the `testWebhook` function, integrating a testing feature in the `WebhooksTable`, and adding a custom hook `useTestWebhook` to manage webhook testing states and results.

### Detailed summary
- Changed `testWebhook` from a local function to an exported function.
- Added `PlayIcon` import to `WebhooksTable.tsx`.
- Integrated `useTestWebhook` hook in `WebhooksTable` for testing webhooks.
- Implemented `handleTestWebhook` function to test webhooks and handle results.
- Updated the action buttons in the `WebhooksTable` to include a test button with loading state.
- Created `useTestWebhook` hook to manage testing states and results, including error handling and toast notifications.

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

<!-- end pr-codex -->

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

## Summary by CodeRabbit

- **New Features**
  - Added the ability to test webhooks directly from the webhooks table with a "Test" button, providing immediate feedback and status indicators during testing.
- **User Interface**
  - Enhanced the actions column in the webhooks table for improved layout and usability, including real-time spinner icons and error notifications during webhook testing.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
@graphite-app graphite-app bot force-pushed the Add_webhook_testing_functionality_to_dashboard branch from 148c493 to b1e702d Compare May 28, 2025 21:21
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground May 28, 2025 21:21 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui May 28, 2025 21:21 Inactive
@vercel vercel bot temporarily deployed to Preview – docs-v2 May 28, 2025 21:21 Inactive
@vercel vercel bot temporarily deployed to Preview – login May 28, 2025 21:21 Inactive
@AmineAfia AmineAfia force-pushed the Add_webhooks_page_to_project_dashboard branch from ce3008e to adf9cc1 Compare May 28, 2025 21:54
@AmineAfia AmineAfia force-pushed the Add_webhook_testing_functionality_to_dashboard branch from b1e702d to 9058e67 Compare May 28, 2025 21:54
<!--

## title your PR with this format: "[SDK/Dashboard/Portal] Feature/Fix: Concise title for the changes"

If you did not copy the branch name from Linear, paste the issue tag here (format is TEAM-0000):

## Notes for the reviewer

Anything important to call out? Be sure to also clarify these in your comments.

## How to test

Unit tests, playground, etc.

-->

<!-- start pr-codex -->

---

## PR-Codex overview
This PR enhances the webhook testing functionality in the dashboard application by exporting the `testWebhook` function, adding a testing feature in the `WebhooksTable`, and creating a custom hook `useTestWebhook` to manage the testing state and results.

### Detailed summary
- Changed `testWebhook` from a local function to an exported function in `webhooks.ts`.
- Imported `PlayIcon` in `WebhooksTable.tsx` and added it to the UI.
- Implemented `handleTestWebhook` function to test webhooks and display results.
- Created `useTestWebhook` hook to manage testing state and results.
- Added error handling and success notifications for webhook testing.

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

<!-- end pr-codex -->

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

## Summary by CodeRabbit

- **New Features**
  - Added the ability to test webhooks directly from the webhooks table with a "Test" button, providing immediate feedback and status indicators during testing.
- **User Interface**
  - Enhanced the actions column in the webhooks table for improved layout and usability, including real-time spinner icons and error notifications during webhook testing.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
@graphite-app graphite-app bot force-pushed the Add_webhooks_page_to_project_dashboard branch from adf9cc1 to dcb412f Compare May 28, 2025 22:02
@graphite-app graphite-app bot force-pushed the Add_webhook_testing_functionality_to_dashboard branch from 9058e67 to c420099 Compare May 28, 2025 22:03
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground May 28, 2025 22:03 Inactive
@vercel vercel bot temporarily deployed to Preview – login May 28, 2025 22:03 Inactive
@vercel vercel bot temporarily deployed to Preview – docs-v2 May 28, 2025 22:03 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui May 28, 2025 22:03 Inactive
Base automatically changed from Add_webhooks_page_to_project_dashboard to main May 28, 2025 22:10
@graphite-app graphite-app bot merged commit c420099 into main May 28, 2025
22 checks passed
@graphite-app graphite-app bot deleted the Add_webhook_testing_functionality_to_dashboard branch May 28, 2025 22:11
@vercel vercel bot temporarily deployed to Production – docs-v2 May 28, 2025 22:11 Inactive
@vercel vercel bot temporarily deployed to Production – wallet-ui May 28, 2025 22:11 Inactive
@vercel vercel bot temporarily deployed to Production – login May 28, 2025 22:11 Inactive
@vercel vercel bot temporarily deployed to Production – thirdweb_playground May 28, 2025 22:11 Inactive
@vercel vercel bot temporarily deployed to Production – thirdweb-www May 28, 2025 22:23 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