Skip to content

Conversation

cnlangzi
Copy link
Member

@cnlangzi cnlangzi commented Feb 11, 2025

Changed

  • !feat(form): Moved out Binder/Validator to reduce 3rd dependencies in the core class library

Fixed

Added

Tests

Tasks to complete before merging PR:

  • Ensure unit tests are passing. If not run make unit-test to check for any regressions 📋
  • Ensure lint tests are passing. if not run make lint to check for any issues
  • Ensure codecov/patch is passing for changes.

Summary by Sourcery

Move the Binder and Validator components to a separate package to reduce third-party dependencies in the core library.

New Features:

  • Introduce a new form package that contains the Binder and Validator components.

Enhancements:

  • Reduce third-party dependencies in the core class library by moving the Binder and Validator out of it.

Copy link

sourcery-ai bot commented Feb 11, 2025

Reviewer's Guide by Sourcery

This PR refactors the binder and validator functionality by relocating them to an external package (ext/form) to reduce 3rd party dependencies in the core class library. Along with this move, corresponding changes have been made to tests, context handling, and documentation to align with the new structure.

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

File-Level Changes

Change Details Files
Relocated Binder/Validator functionality from the core library to the external package (ext/form).
  • Moved binder.go and validate.go files to the ext/form directory.
  • Adjusted package imports to reflect the new location.
binder.go
validate.go
Updated test implementations and handler functions to use the external package changes.
  • Updated binder_test.go to use xun.New with WithMux, reflecting the shift from core New.
  • Changed function parameter signatures from the local Context type to xun.Context.
  • Replaced local ErrCancelled with xun.ErrCancelled.
  • Introduced TLS client configuration in binder_test.go for testing purposes.
binder_test.go
Enhanced core context handling by integrating jsoniter for JSON processing.
  • Updated context.go to import and use jsoniter for JSON operations.
context.go
Updated documentation to reflect the changes in binder location.
  • Modified README.md to call form.BindForm instead of xun.BindForm, aligning with the new package structure.
README.md

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

Copy link

@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 @cnlangzi - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider renaming the ext/form package to just form to better reflect its purpose and usage.
  • Update the README.md to reflect the new location of the BindForm function.
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.

Copy link

deepsource-io bot commented Feb 11, 2025

Here's the code health analysis summary for commits 7b7455d..4c85ea0. View details on DeepSource ↗.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource Go LogoGo✅ SuccessView Check ↗

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

Copy link

codecov bot commented Feb 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.97%. Comparing base (7b7455d) to head (4c85ea0).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #41      +/-   ##
==========================================
- Coverage   92.10%   91.97%   -0.14%     
==========================================
  Files          43       43              
  Lines        1647     1644       -3     
==========================================
- Hits         1517     1512       -5     
- Misses         91       97       +6     
+ Partials       39       35       -4     
Flag Coverage Δ
Unit-Tests 91.97% <100.00%> (-0.14%) ⬇️

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.

@cnlangzi cnlangzi merged commit a4888e7 into main Feb 11, 2025
6 of 7 checks passed
@cnlangzi cnlangzi deleted the feat/form branch February 11, 2025 12:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant