Skip to content

Conversation

ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Aug 6, 2025

Link issues

fixes #6562

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 a new OPC DA sample page and integrate a mock or real OPC DA server registration based on the operating system.

New Features:

  • Register the real OPC DA server on Windows and a mock implementation on non-Windows platforms in the service collection.
  • Add a new "OpcDa" demo page with UI and logic for connecting, reading tag values, and subscribing to data changes.
  • Introduce a new menu entry pointing to the OPC DA sample.

Documentation:

  • Provide Razor and C# sample components demonstrating OPC DA usage.
  • Add localization entries and documentation configuration for the OPC DA sample.

@bb-auto bb-auto bot added the documentation Improvements or additions to documentation label Aug 6, 2025
@bb-auto bb-auto bot added this to the 9.9.0 milestone Aug 6, 2025
Copy link
Contributor

sourcery-ai bot commented Aug 6, 2025

Reviewer's Guide

Introduce a new OPC DA sample by registering a real or mock server in the DI container based on OS, adding a demo menu entry with localization and documentation, and providing a Razor component showcasing connect, read, and subscription workflows

Class diagram for OpcDa sample component and server registration

classDiagram
    class OpcDa {
        - IOpcDaServer OpcDaServer
        - string _serverName
        - string Tag1
        - string Tag2
        - string Tag3
        - string Tag4
        - string _tagValue1
        - string _tagValue2
        - string _tagValue3
        - string _tagValue4
        - IOpcSubscription _subscription
        - bool _subscribed
        + OnConnect()
        + OnDisConnect()
        + OnRead()
        + OnCreateSubscription()
        + OnCancelSubscription()
        + UpdateValues(List<OpcReadItem>)
    }
    class IOpcDaServer {
        + Connect(serverName)
        + Disconnect()
        + Read(tags)
        + CreateSubscription(name, interval, active)
        + CancelSubscription(subscription)
        + IsConnected
    }
    class IOpcSubscription {
        + AddItems(tags)
        + DataChanged
    }
    class OpcReadItem {
        + Value
    }
    OpcDa --> IOpcDaServer
    OpcDa --> IOpcSubscription
    IOpcSubscription --> OpcReadItem
Loading

File-Level Changes

Change Details Files
Conditional OPC DA server registration via DI
  • Add using for OPC DA namespace
  • Register real server on Windows or mock server otherwise
ServiceCollectionExtensions.cs
Menu, localization, and documentation entries for OPC DA sample
  • Insert new demo menu item
  • Add localized strings in en-US and zh-CN JSONs
  • Add sample entry to docs.json
MenusLocalizerExtensions.cs
en-US.json
zh-CN.json
docs.json
Sample component for OPC DA operations with UI
  • Create Razor markup for connect/read/subscribe demo
  • Implement component logic (connect, read, subscription handlers)
  • Update project file to include new sample files
OpcDa.razor
OpcDa.razor.cs
BootstrapBlazor.Server.csproj

Assessment against linked issues

Issue Objective Addressed Explanation
#6562 Add sample code for MockOpcDaServer to the documentation or sample components.

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

@ArgoZhang ArgoZhang merged commit 1ef4d91 into main Aug 6, 2025
4 checks passed
@ArgoZhang ArgoZhang deleted the refactor-ua branch August 6, 2025 10:10
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 and they look great!

Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `src/BootstrapBlazor.Server/Components/Samples/OpcDa.razor.cs:55` </location>
<code_context>
+        var values = OpcDaServer.Read(Tag1, Tag2);
+        _tagValue1 = values.ElementAt(0).Value?.ToString();
+
+        var v = (int)values.ElementAt(1).Value! / 100d;
+        _tagValue2 = v.ToString(CultureInfo.InvariantCulture);
+    }
</code_context>

<issue_to_address>
Potential InvalidCastException if Value is not int.

Casting values.ElementAt(1).Value to int without checking its type can cause a runtime exception if the value is not an int. Use a type check or safe conversion to prevent this.
</issue_to_address>

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.

var values = OpcDaServer.Read(Tag1, Tag2);
_tagValue1 = values.ElementAt(0).Value?.ToString();

var v = (int)values.ElementAt(1).Value! / 100d;
Copy link
Contributor

Choose a reason for hiding this comment

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

issue (bug_risk): Potential InvalidCastException if Value is not int.

Casting values.ElementAt(1).Value to int without checking its type can cause a runtime exception if the value is not an int. Use a type check or safe conversion to prevent this.

Copy link

codecov bot commented Aug 6, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (22e67cf) to head (b822d00).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6563   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          719       719           
  Lines        31560     31560           
  Branches      4450      4450           
=========================================
  Hits         31560     31560           
Flag Coverage Δ
BB 100.00% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc(OpcDa): add MockOpcDaServer sample code
1 participant