Skip to content

Refactor plyr#422

Merged
ArgoZhang merged 4 commits intomasterfrom
refactor-plyr
Apr 29, 2025
Merged

Refactor plyr#422
ArgoZhang merged 4 commits intomasterfrom
refactor-plyr

Conversation

@ArgoZhang
Copy link
Copy Markdown
Member

@ArgoZhang ArgoZhang commented Apr 29, 2025

Link issues

fixes #421

Summary By Copilot

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Add support for client-side player event callbacks in the Player component.

Enhancements:

  • Introduce the OnEvent parameter to receive notifications for player events (e.g., play, pause, ended, fullscreen).
  • Refactor JavaScript event handling logic.

Chores:

  • Reorganize JavaScript helper functions.

@bb-auto bb-auto Bot added the enhancement New feature or request label Apr 29, 2025
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented Apr 29, 2025

Reviewer's Guide by Sourcery

This pull request refactors the Plyr player component, primarily focusing on improving event handling by introducing a .NET event callback and restructuring the JavaScript code to manage event listeners and player lifecycle methods.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Implement .NET event callback for player events.
  • Added OnEvent parameter in C#.
  • Added [JSInvokable] method to receive JS events.
  • Added data attribute to control JS event firing.
  • Created JS functions to handle and dispatch events.
  • Integrated event handling setup into player initialization in JS.
  • Pass .NET method name to JS init function to enable callbacks.
src/components/BootstrapBlazor.Player/Player.razor.cs
src/components/BootstrapBlazor.Player/Player.razor
src/components/BootstrapBlazor.Player/Player.razor.js
Restructure JavaScript player utility functions.
  • Relocated functions for reloading, setting poster, and disposing.
  • Removed a helper function for executing operations on the player instance.
  • Updated utility functions to access player data directly.
src/components/BootstrapBlazor.Player/Player.razor.js

Assessment against linked issues

Issue Objective Addressed Explanation
#421 Add an OnEvent callback to the Player component.

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto Bot added this to the v9.2.0 milestone Apr 29, 2025
Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The JavaScript check for the data-bb-event attribute seems redundant, as the C# TriggerEvent method already handles whether the OnEvent callback should be invoked.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟡 Complexity: 1 issue found
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread src/components/BootstrapBlazor.Player/Player.razor.js
Comment thread src/components/BootstrapBlazor.Player/Player.razor.js
delete options.source;
if (hls) {
if (source.length > 0) {
const src = source[0].src;
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (code-quality): Prefer object destructuring when accessing and using properties. (use-object-destructuring)

Suggested change
const src = source[0].src;
const {src} = source[0];


ExplanationObject destructuring can often remove an unnecessary temporary reference, as well as making your code more succinct.

From the Airbnb Javascript Style Guide

@ArgoZhang ArgoZhang merged commit 833f3cc into master Apr 29, 2025
1 check passed
@ArgoZhang ArgoZhang deleted the refactor-plyr branch April 29, 2025 06:20
@ArgoZhang ArgoZhang restored the refactor-plyr branch April 29, 2025 06:21
ArgoZhang added a commit that referenced this pull request Apr 29, 2025
@ArgoZhang ArgoZhang deleted the refactor-plyr branch April 29, 2025 06:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(Player): add OnEvent callback

1 participant