chore: improving debugging for demo #202
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Enhanced the Events demo with extensive debugging capabilities to help users understand if events are working properly in both dev and production environments. **Key Improvements:** 1. **Console Debugging** - Added console.log statements to ALL event handlers - Checkpoint messages (🎯 CHECKPOINT 1, 2, 3) to track event flow - Grouped console logs with stack traces for deep debugging - Clear, emoji-prefixed messages for each event type - Component mount/unmount logging with debug instructions 2. **Visual Event Flow Tracker** - Checkpoint badges showing which events have fired - Visual indicators (✅ green for fired, ⏺️ gray for pending) - Real-time state counter for onStateChange events - Clear progression: iframe Added → Player Ready → Playing 3. **Debug Instructions Panel** - Step-by-step instructions for opening DevTools - What to look for in the console - Highlighted troubleshooting tips - Warnings about common issues 4. **Comprehensive Troubleshooting Guide** - Events not firing at all (enableJsApi, blockers) - onIframeAdded fires but onReady doesn't (timing issues) - Events work in dev but not production (CSP, domains) - onStateChange fires but convenience events don't - Systematic debugging steps (1-8) - Pro tip: Manual window message listener test 5. **Enhanced Code Examples** - Updated all code samples to include console.log patterns - Show exactly where to add debugging - Demonstrate useCallback usage to prevent loops **Why This Matters:** Users reported that events aren't displaying in both prod and dev demos. These changes provide comprehensive debugging tools to: - Quickly identify if the issue is in the component or the demo - Understand exactly where in the event flow things break - Self-diagnose common problems without opening GitHub issues - See real-time feedback both in the UI and console **Testing:** - ✅ Demo builds successfully - ✅ No TypeScript errors - ✅ All visual panels render correctly - ✅ Console messages fire on component mount Fixes issues with event visibility and provides users with the tools to debug event problems independently.
Contributor
size-limit report 📦
|
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Enhanced the Events demo with extensive debugging capabilities to help users understand if events are working properly in both dev and production environments.
Key Improvements:
Console Debugging
Visual Event Flow Tracker
Debug Instructions Panel
Comprehensive Troubleshooting Guide
Enhanced Code Examples
Why This Matters:
Users reported that events aren't displaying in both prod and dev demos. These changes provide comprehensive debugging tools to:
Testing:
Fixes issues with event visibility and provides users with the tools to debug event problems independently.