Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Nov 16, 2024

update javascript check modal first shown

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号

Description

fixes #4675
fixes #4658

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

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

Enhancements:

  • Refactor the modal dialog JavaScript to improve the check for when the modal is first shown by using requestAnimationFrame for better performance.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Nov 16, 2024

Reviewer's Guide by Sourcery

The PR improves the modal dialog initialization by implementing a more robust check for element dimensions using requestAnimationFrame. This ensures that the modal's position is calculated correctly after the element is fully rendered.

Sequence diagram for modal dialog initialization

sequenceDiagram
    participant User
    participant ModalDialog
    User->>ModalDialog: Open modal
    ModalDialog->>ModalDialog: Check if 'is-draggable-center'
    alt is-draggable-center
        ModalDialog->>ModalDialog: requestAnimationFrame(check)
        loop until offsetWidth > 0
            ModalDialog->>ModalDialog: Check offsetWidth
        end
        ModalDialog->>ModalDialog: update(el)
    end
Loading

Updated class diagram for ModalDialog JavaScript

classDiagram
    class ModalDialog {
        +init(id)
        +dispose(id)
    }
    class update {
        +update(el)
    }
    ModalDialog --> update : uses
    note for update "Handles element dimension checks and updates styles"
Loading

File-Level Changes

Change Details Files
Refactored modal dialog initialization to handle element dimension checks more reliably
  • Extracted position calculation logic into a separate 'update' function
  • Implemented a recursive requestAnimationFrame check to ensure element dimensions are available
  • Added safety check for element width before applying position calculations
src/BootstrapBlazor/Components/Modal/ModalDialog.razor.js

Assessment against linked issues

Issue Objective Addressed Explanation
#4675 Update the JavaScript check for modal dialog's first shown state to handle initial dimensions correctly

Possibly linked issues


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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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 the enhancement New feature or request label Nov 16, 2024
@bb-auto bb-auto bot added this to the v9.0.0 milestone Nov 16, 2024
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Nov 16, 2024
Copy link
Contributor

@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 code attempts to clear an interval (clearInterval(dialog.handler)) but there's no corresponding setInterval call. This appears to be leftover code that should be removed.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 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.

@codecov
Copy link

codecov bot commented Nov 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (9a09c24) to head (1c06d31).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4676   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          620       620           
  Lines        27427     27427           
  Branches      3928      3928           
=========================================
  Hits         27427     27427           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ArgoZhang
Copy link
Member Author

@sourcery-ai review

@ArgoZhang
Copy link
Member Author

@agree

Copy link
Contributor

@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:

  • Consider adding a timeout or maximum retry count to the requestAnimationFrame loop to prevent potential infinite recursion if the element never becomes visible.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 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.

@ArgoZhang ArgoZhang merged commit 56ef57c into main Nov 16, 2024
5 checks passed
@ArgoZhang ArgoZhang deleted the fix-dialog branch November 16, 2024 07:56
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

2 participants