Skip to content

feat(AjaxService): add ToJson parameter #5441

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Feb 25, 2025
Merged

feat(AjaxService): add ToJson parameter #5441

merged 7 commits into from
Feb 25, 2025

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Feb 25, 2025

add ToJson parameter

Summary of the changes (Less than 80 chars)

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

Description

fixes #5440

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

Added a ToJson parameter to the AjaxService to allow users to specify whether the response should be serialized as JSON.

New Features:

  • Added a ToJson parameter to the AjaxService to control whether the response is serialized as JSON.

Bug Fixes:

Enhancements:

  • The AjaxService now allows users to specify whether the response should be serialized as JSON, providing more flexibility in handling different types of responses.

@bb-auto bb-auto bot added the enhancement New feature or request label Feb 25, 2025
Copy link
Contributor

sourcery-ai bot commented Feb 25, 2025

Reviewer's Guide by Sourcery

This pull request introduces a ToJson parameter to the Ajax service, allowing users to control whether the response is automatically parsed as JSON. This enhancement provides more flexibility when interacting with APIs that return non-JSON responses.

Sequence diagram for AjaxService with ToJson parameter

sequenceDiagram
    participant Browser
    participant AjaxService
    participant Server

    Browser->>AjaxService: Call ajax(option) with ToJson
    AjaxService->>Server: fetch(url, init)
    Server-->>AjaxService: Response (JSON or other)
    alt ToJson is true
        AjaxService->>AjaxService: Parse response as JSON
    end
    AjaxService-->>Browser: Result (JSON or other)
Loading

File-Level Changes

Change Details Files
Added a ToJson parameter to the Ajax service to control whether the response is automatically parsed as JSON.
  • Added a toJson property to the options object in the ajax.js file, defaulting to true.
  • Modified the ajax function in ajax.js to conditionally parse the response as JSON based on the toJson option.
  • Added a ToJson property to the AjaxOption class in AjaxOption.cs.
  • Added a test case for the ToJson property in AjaxTest.cs.
src/BootstrapBlazor/wwwroot/modules/ajax.js
src/BootstrapBlazor/Components/Ajax/AjaxOption.cs
test/UnitTest/Components/AjaxTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5440 Add a ToJson parameter to the Ajax service.

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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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.3.0 milestone Feb 25, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Feb 25, 2025
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 javascript code has a typo: opitons should be options.
  • Consider using a consistent naming scheme (either option or options) throughout the javascript code.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟡 Testing: 1 issue found
  • 🟢 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.

Copy link

codecov bot commented Feb 25, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.97%. Comparing base (69179e7) to head (ecfa811).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5441   +/-   ##
=======================================
  Coverage   99.97%   99.97%           
=======================================
  Files         646      646           
  Lines       29349    29350    +1     
  Branches     4129     4129           
=======================================
+ Hits        29342    29343    +1     
  Misses          7        7           

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

@ArgoZhang
Copy link
Collaborator Author

@sourcery-ai review

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 renaming ToJson to ParseResponseAsJson for better clarity.
  • The javascript fetch body should be null when the method is not POST.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟡 Testing: 1 issue found
  • 🟢 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 1333636 into main Feb 25, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-ajax branch February 25, 2025 11:54
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(AjaxService): add ToJson parameter
1 participant