Feature/152 Add show and hide buttons for commentator box controls

[BucketRaphi]

Feature/Enhancement Pull Request

Feature

Adds #152 feature
Closes #152

Description

• Adds buttons to show, hide, and temporarily show commentator box on score box overlay
• Removes show interval input from dashboard sidebar, not needed

Affected Component(s)

• Frontend (Angular Control Panel)
• Overlays (new or enhanced)
• Backend (ASP.NET Core)
• Database/Migrations
• Documentation

Feature Details

User-Facing Changes

The streamer now has finer control that allows them to show and hide the commentator box on the score box component

Technical Implementation

• Added a new SignalR hub meant to only send events to all clients
• Refactored display functionality in commentator box

Related

• Feature request issue: [FEATURE] Add buttons for showing / hiding commentator box #152

Testing

Test Scenarios

1. Test if commentator box gets shown
2. Test if commentator box gets hidden
3. Test if commentator box gets shown for x amount of time

How to Test

1. Open dashboard and overlay/score-box
2. Click on button that triggers the event to show commentator box
3. Check if commentator box gets shown on overlay
4. Click on button that triggers the event to hide commentator box
5. Check if commentator box gets hidden on overlay
6. Set hide delay interval input to x amount of time
7. Click on button that trigger the event to show commentator box temporarily
8. Check if commentator box gets shown, and then disappears after x amount of time

Files Changed

New Files

• Frontend/control-panel/src/app/services/signalr-events.ts
• Frontend/control-panel/src/app/services/signalr-events.spec.ts
• Backend/DSB.StreamBackend/Hubs/IEventClient.cs
• Backend/DSB.StreamBackend/Hubs/EventHub.cs

Modified Files

• Frontend/control-panel/src/app/overlay/commentator-box/commentator-box.ts
• Frontend/control-panel/src/app/overlay/commentator-box/commentator-box.html
• Frontend/control-panel/src/app/overlay/commentator-box/commentator-box.scss
• Frontend/control-panel/src/app/overlay/score-box/score-box.ts
• Frontend/control-panel/src/app/overlay/score-box/score-box.html
• Frontend/control-panel/src/app/overlay/score-box/score-box.scss
• Frontend/control-panel/src/app/layouts/sidebar/sidebar.ts
• Frontend/control-panel/src/app/layouts/sidebar/sidebar.html
• Frontend/control-panel/src/app/layouts/sidebar/sidebar.scss
• Frontend/control-panel/src/app/services/signalr.spec.ts
• Backend/DSB.StreamBackend/Program.cs

Backward Compatibility

• Feature is fully backward compatible
• Breaking changes: Major changes to commentator box and sidebar layout

Documentation

• README updated
• Inline code comments added
• API documentation updated (if applicable)
• Deployment notes added (if needed)

Checklist

• Feature is complete and tested
• Code follows repository conventions
• Documentation is up to date
• No breaking changes (or documented)
• Tests pass
• No new console errors or warnings

[BucketRaphi]

NoMerge because a database migrations needs to be made to remove an unused property, and because docs still need to be updated

[github-actions]

Label "NoMerge" not applied. Merging enabled.

[github-actions]

Label "NoMerge" on Pull Request. Merging blocked.

[Hazeolation]

Label refreshed for flow

[Hazeolation]

@BucketRaphi NoMerge condition met?

[BucketRaphi]

@BucketRaphi NoMerge condition met?

Still NoMerge imo because we need to sort out why DB migrations didn't create columns for the Socials and CommBox Time Data

[Hazeolation]

Merge Conflicts