Skip to content

feat(Ajax): support form post data #5862

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Apr 23, 2025
Merged

feat(Ajax): support form post data #5862

merged 2 commits into from
Apr 23, 2025

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Apr 23, 2025 •
edited by sourcery-ai bot
Loading

Link issues

fixes #5861

Summary By Copilot

This pull request includes a version update for the BootstrapBlazor package and enhancements to the ajax.js module to improve flexibility in handling HTTP requests. The most important changes are grouped below:

Version Update:

Enhancements to ajax.js:

  • src/BootstrapBlazor/wwwroot/modules/ajax.js: Added a default Content-Type header (application/json; charset=utf-8) to the headers object in the option parameter. This ensures consistent handling of JSON payloads.
  • src/BootstrapBlazor/wwwroot/modules/ajax.js: Enhanced the ajax function to dynamically adjust the Content-Type header and serialize the request body accordingly. If the Content-Type is application/x-www-form-urlencoded, data is converted using URLSearchParams; otherwise, it is serialized as JSON.

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

Enhance Ajax module to support flexible form data handling and improve request configuration

New Features:

  • Add support for different content types in Ajax requests, including form-urlencoded and JSON payloads

Bug Fixes:

  • Resolve inconsistent content type handling in Ajax requests

Enhancements:

  • Improve Ajax request handling by dynamically adjusting Content-Type header
  • Add default Content-Type header to ensure consistent request configuration

@bb-auto bb-auto bot added the enhancement New feature or request label Apr 23, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Apr 23, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request updates the BootstrapBlazor package version and enhances the ajax.js module to support form post data. The ajax.js changes include setting a default Content-Type header and dynamically adjusting the request body serialization based on the specified Content-Type.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Updated the package version of the BootstrapBlazor project.
  • Incremented the version number from 9.5.9 to 9.5.10.
 src/BootstrapBlazor/BootstrapBlazor.csproj
Enhanced the ajax.js module to support form post data and provide more flexible content type handling.
  • Added a default 'Content-Type' header of 'application/json; charset=utf-8' to the headers object.
  • Dynamically adjusted the request body serialization based on the 'Content-Type' header.
  • Serialized data to 'application/x-www-form-urlencoded' format using URLSearchParams when the content type is set to 'application/x-www-form-urlencoded'.
  • Serialized data to JSON format when the content type is not 'application/x-www-form-urlencoded'.
 src/BootstrapBlazor/wwwroot/modules/ajax.js

Assessment against linked issues

Issue Objective Addressed Explanation
#5861 Support sending form data via POST requests using the Ajax functionality. ✅
#5861 Ensure the correct Content-Type header is set for different types of data (JSON and form-urlencoded). ✅
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.5.0 milestone Apr 23, 2025
sourcery-ai[bot]
sourcery-ai bot approved these changes Apr 23, 2025
View reviewed changes
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 comment explaining why the default Content-Type is being set.
  • The logic for setting the Content-Type header feels a bit scattered; could it be consolidated?
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 ad7cafc into main Apr 23, 2025
4 checks passed
@ArgoZhang ArgoZhang deleted the refactor-fetch branch April 23, 2025 05:25
@codecov
Copy link

codecov bot commented Apr 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (358e500) to head (b304e7d).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff            @@
##              main     #5862   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          661       661           
  Lines        30404     30404           
  Branches      4319      4319           
=========================================
  Hits         30404     30404

☔ 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

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] approved these changes

Assignees

@ArgoZhang ArgoZhang

Labels

enhancement New feature or request

Projects

None yet

Milestone

v9.5.0

Development

Successfully merging this pull request may close these issues.

feat(Ajax): support form post data

2 participants

@ArgoZhang