Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented May 2, 2025

Link issues

fixes #5937

Summary By Copilot

This pull request includes a version update in the project file and adds a new utility function for drawing images on a canvas in the JavaScript module. Below are the details:

Project Version Update:

JavaScript Utility Enhancement:

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 a new utility function for drawing images on canvas with proper device pixel ratio scaling

New Features:

  • Added a drawImage method in utility.js to handle canvas image drawing with device pixel ratio support

Chores:

  • Updated project version from 9.6.1-beta01 to 9.6.1-beta02

@ArgoZhang ArgoZhang requested a review from Copilot May 2, 2025 03:00
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented May 2, 2025

Reviewer's Guide

This pull request introduces a new JavaScript utility function drawImage to render an image onto a canvas element, accounting for device pixel ratio for correct scaling. It also increments the project version.

File-Level Changes

Change Details Files
Added a drawImage utility function.
  • Created a new JavaScript function drawImage that accepts a canvas, image, and dimensions.
  • Set canvas width and height attributes based on dimensions and devicePixelRatio.
  • Set canvas CSS width and height styles.
  • Scaled the 2D drawing context using devicePixelRatio.
  • Drew the provided image onto the scaled canvas context at position (0, 0).
src/BootstrapBlazor/wwwroot/modules/utility.js
Updated project version.
  • Incremented the project version number from 9.6.1-beta01 to 9.6.1-beta02 (as indicated in the PR description, diff not fully shown).
src/BootstrapBlazor/BootstrapBlazor.csproj

Assessment against linked issues

Issue Objective Addressed Explanation
#5937 Add a drawImage method to the JavaScript utility module.

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. 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 the enhancement New feature or request label May 2, 2025
@bb-auto bb-auto bot added this to the v9.6.0 milestone May 2, 2025
@ArgoZhang ArgoZhang merged commit 0e5d5d4 into main May 2, 2025
4 checks passed
@ArgoZhang ArgoZhang deleted the feat-canvas branch May 2, 2025 03:01
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the project version and introduces a new JavaScript utility function to draw an image on a canvas with proper scaling for device pixel ratios.

  • Updated project version in BootstrapBlazor.csproj
  • Added the drawImage function in utility.js
Files not reviewed (1)
  • src/BootstrapBlazor/BootstrapBlazor.csproj: Language not supported

canvas.height = offsetHeight * devicePixelRatio;
canvas.style.width = `${offsetWidth}px`;
canvas.style.height = `${offsetHeight}px`;
const context = canvas.getContext('2d');
Copy link

Copilot AI May 2, 2025

Choose a reason for hiding this comment

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

Consider verifying that canvas.getContext('2d') returns a valid context object before applying transformations and drawing the image.

Suggested change
const context = canvas.getContext('2d');
const context = canvas.getContext('2d');
if (!context) {
console.error("Failed to get 2D context from canvas.");
return;
}

Copilot uses AI. Check for mistakes.
Comment on lines +880 to +885
canvas.width = offsetWidth * devicePixelRatio;
canvas.height = offsetHeight * devicePixelRatio;
canvas.style.width = `${offsetWidth}px`;
canvas.style.height = `${offsetHeight}px`;
const context = canvas.getContext('2d');
context.scale(devicePixelRatio, devicePixelRatio);
Copy link

Copilot AI May 2, 2025

Choose a reason for hiding this comment

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

[nitpick] Consider assigning window.devicePixelRatio to a local variable if used multiple times for improved clarity and potential performance benefits.

Suggested change
canvas.width = offsetWidth * devicePixelRatio;
canvas.height = offsetHeight * devicePixelRatio;
canvas.style.width = `${offsetWidth}px`;
canvas.style.height = `${offsetHeight}px`;
const context = canvas.getContext('2d');
context.scale(devicePixelRatio, devicePixelRatio);
const pixelRatio = window.devicePixelRatio;
canvas.width = offsetWidth * pixelRatio;
canvas.height = offsetHeight * pixelRatio;
canvas.style.width = `${offsetWidth}px`;
canvas.style.height = `${offsetHeight}px`;
const context = canvas.getContext('2d');
context.scale(pixelRatio, pixelRatio);

Copilot uses AI. Check for mistakes.
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:

  • The drawImage function could be made more flexible by accepting an existing canvas context instead of retrieving it internally.
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.

Comment on lines +884 to +886
const context = canvas.getContext('2d');
context.scale(devicePixelRatio, devicePixelRatio);
context.drawImage(image, 0, 0, offsetWidth, offsetHeight);
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion: Handle potential null from getContext('2d').

Verify canvas.getContext('2d') returns a non-null context before scaling or drawing the image.

Suggested change
const context = canvas.getContext('2d');
context.scale(devicePixelRatio, devicePixelRatio);
context.drawImage(image, 0, 0, offsetWidth, offsetHeight);
const context = canvas.getContext('2d');
if (context) {
context.scale(devicePixelRatio, devicePixelRatio);
context.drawImage(image, 0, 0, offsetWidth, offsetHeight);
} else {
console.error('2D context not available on canvas.');
}

@codecov
Copy link

codecov bot commented May 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (9e542ab) to head (81bacf8).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5938   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          665       665           
  Lines        30485     30485           
  Branches      4345      4345           
=========================================
  Hits         30485     30485           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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(Utility): add drawImage method

2 participants