Skip to content
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

fix: remove slices dependency to better support Go 1.20 #497

Merged
merged 1 commit into from
Jul 10, 2024

Conversation

danielgtaylor
Copy link
Owner

@danielgtaylor danielgtaylor commented Jul 10, 2024

This removes the slices package dependency which was added to Go in 1.21. This can all be cleaned up once we require Go 1.21 as the minimum version, but for now we'll support the last two releases just like the Go team does.

Fixes #472.

Summary by CodeRabbit

  • Refactor
    • Improved efficiency of method checks in Mux struct.
    • Enhanced MimeTypeValidator and MultipartFormFiles for better performance and error handling.

Copy link

coderabbitai bot commented Jul 10, 2024

Walkthrough

The recent code changes focused on enhancing the maintainability and compatibility of the humaflow package. The primary update involved refactoring utility functions in flow.go and improving error handling in formdata.go by replacing methods incompatible with Go versions under 1.22. Additionally, the required Go version in the installation tutorial was updated to reflect these changes.

Changes

Files Change Summary
.../adapters/humaflow/flow/flow.go Refactored slices.Contains to slicesIndex and slicesContains for method checks in Handle and ServeHTTP.
.../formdata.go Removed slices import and refactored error handling and data validation to ensure compatibility with Go 1.22.

Assessment against linked issues

Objective (Issue #) Addressed Explanation
Update min Go version to 1.22 (#472)

Poem

Amidst the code where bugs once lurk,
With care and craft, we put in the work.
A contains we'd shift to something new,
Now Go 1.22 fits right through.
We're hopping forward, clear and bright,
In Huma's flow, we see the light.
🎉✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

codecov bot commented Jul 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.85%. Comparing base (6d80377) to head (ca97cdc).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #497   +/-   ##
=======================================
  Coverage   92.84%   92.85%           
=======================================
  Files          22       22           
  Lines        3788     3791    +3     
=======================================
+ Hits         3517     3520    +3     
  Misses        227      227           
  Partials       44       44           

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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6d80377 and ca97cdc.

Files selected for processing (2)
  • adapters/humaflow/flow/flow.go (3 hunks)
  • formdata.go (3 hunks)
Additional comments not posted (6)
formdata.go (2)

57-72: LGTM! Efficiently replaces slices.ContainsFunc.

The loop correctly checks for various MIME types. This ensures compatibility with Go 1.20.


183-184: LGTM! Correctly replaces slices.Concat with append.

The use of append ensures errors are accumulated properly, maintaining compatibility with Go 1.20.

adapters/humaflow/flow/flow.go (4)

70-79: LGTM! Efficiently implements slicesIndex.

The function correctly returns the index of the first occurrence of an element or -1 if not found.


81-84: LGTM! Efficiently implements slicesContains.

The function correctly uses slicesIndex to check for the presence of an element.


131-133: LGTM! Correct use of slicesContains.

The method correctly checks for http.MethodGet and automatically includes http.MethodHead.


194-195: LGTM! Correct use of slicesContains.

The method correctly checks and appends allowed methods using slicesContains.

@danielgtaylor danielgtaylor merged commit b8be41a into main Jul 10, 2024
5 checks passed
@danielgtaylor danielgtaylor deleted the go-1.20-slices-fix branch July 10, 2024 05:43
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