Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented May 6, 2025

Link issues

fixes #5974

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 Multi-Factor Authentication (MFA) sample code and tutorial pages to the BootstrapBlazor project

New Features:

  • Implemented MFA tutorial pages with login, two-factor authentication, and authenticator app flows

Enhancements:

  • Updated MainLayout to use dynamic asset URL retrieval

Documentation:

  • Added new navigation menu item for MFA tutorials

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented May 6, 2025

Reviewer's Guide

This pull request introduces a Multi-Factor Authentication (MFA) sample by adding new Razor components (Login.razor, TwoFactor.razor, TwoFactorApp.razor) that demonstrate an MFA process, styled using accompanying CSS files. The implementation includes adding a navigation link to this MFA tutorial within TutorialsNavMenu.razor.cs, with necessary localization. A minor refactoring in MainLayout.razor updates an image's source URL to use a helper method.

Sequence Diagram for Two-Factor App Verification

sequenceDiagram
    actor User
    participant TwoFactorApp
    participant TotpService
    participant ToastService

    User->>TwoFactorApp: Enters OTP code
    User->>TwoFactorApp: Clicks "Sign in" button
    TwoFactorApp->>TotpService: Verify(code)
    alt Verification Success
        TotpService-->>TwoFactorApp: true
        TwoFactorApp->>ToastService: Success("Sign In", "Login success...")
        ToastService-->>User: Show Success Toast
    else Verification Failure
        TotpService-->>TwoFactorApp: false
        TwoFactorApp->>ToastService: Error("Sign In", "Login failed.")
        ToastService-->>User: Show Error Toast
    end
Loading

Class Diagram for New MFA Components

classDiagram
    direction LR
    class Login {
      +NavigationManager NavigationManager
      +OnSubmit()
    }
    note for Login "Navigates to /tutorials/mfa/two-factor"

    class TwoFactor {
      +IOptionsMonitor<WebsiteOptions> WebsiteOption
    }
    note for TwoFactor "Displays MFA options, links to /tutorials/mfa/two-factor/app"

    class TwoFactorApp {
      +ITotpService TotpService
      +ToastService ToastService
      -string _code
      +OnVerify()
    }
    note for TwoFactorApp "Verifies OTP code using TotpService"

    Login ..> NavigationManager : Uses
    TwoFactor ..> IOptionsMonitor : Uses
    TwoFactorApp ..> ITotpService : Uses
    TwoFactorApp ..> ToastService : Uses
Loading

File-Level Changes

Change Details Files
Implemented MFA sample pages and navigation.
  • Created Razor components for MFA login, 2FA prompt, and 2FA app verification.
  • Added dedicated CSS styles for the new MFA sample pages.
  • Added a navigation link to the MFA tutorial in the side menu.
  • Included localization for the 'MFA' tutorial item.
src/BootstrapBlazor.Server/Components/Layout/TutorialsNavMenu.razor.cs
src/BootstrapBlazor.Server/Components/Samples/Tutorials/MFA/Login.razor
src/BootstrapBlazor.Server/Components/Samples/Tutorials/MFA/Login.razor.css
src/BootstrapBlazor.Server/Components/Samples/Tutorials/MFA/TwoFactor.razor
src/BootstrapBlazor.Server/Components/Samples/Tutorials/MFA/TwoFactor.razor.css
src/BootstrapBlazor.Server/Components/Samples/Tutorials/MFA/TwoFactorApp.razor
src/BootstrapBlazor.Server/Components/Samples/Tutorials/MFA/TwoFactorApp.razor.css
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json
Refactored image asset URL in main layout.
  • Updated the logo image source to use the GetAssetUrl helper method.
src/BootstrapBlazor.Server/Components/Layout/MainLayout.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#5974 Add sample code for MFA component.

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 documentation Improvements or additions to documentation label May 6, 2025
@bb-auto bb-auto bot added this to the v9.6.0 milestone May 6, 2025
@ArgoZhang ArgoZhang merged commit 384fd9d into main May 6, 2025
4 checks passed
@ArgoZhang ArgoZhang deleted the refactor-mfa branch May 6, 2025 07:24
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 sample login page uses hardcoded credentials; consider clarifying in the code or UI that these are for demonstration purposes.
  • Consider consolidating common CSS styles, such as .bb-sign-body and .bb-sign-callout, across the new MFA pages to improve maintainability.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟡 Security: 1 issue found
  • 🟢 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 May 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (496004b) to head (cca0cce).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5975   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          670       670           
  Lines        30606     30606           
  Branches      4352      4352           
=========================================
  Hits         30606     30606           

☔ 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(MFA): add MFA sample code

2 participants