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

🎨 Removed deprecated body param #53

Merged
merged 1 commit into from
Jan 26, 2024
Merged

Conversation

nikhilbadyal
Copy link
Owner

No description provided.

@nikhilbadyal nikhilbadyal added the chore🧹 Code Cleanup label Jan 26, 2024
@nikhilbadyal nikhilbadyal self-assigned this Jan 26, 2024
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.

PR Type: Enhancement

PR Summary: This pull request appears to focus on updating the way search queries are prepared by removing the deprecated 'body' parameter and replacing it with a 'query' parameter that is processed through a custom JSON conversion method. The changes also include updates to the debug logging to handle non-serializable objects and adjustments to the corresponding tests to reflect the new query structure.

Decision: Comment

📝 Type: 'Enhancement' - not supported yet.
  • Sourcery currently only approves 'Typo fix' PRs.
✅ Issue addressed: this change correctly addresses the issue or implements the desired feature.
No details provided.
✅ Small diff: the diff is small enough to approve with confidence.
No details provided.

General suggestions:

  • Ensure that the new JSON conversion method is clearly named and documented to indicate its purpose and the nature of the transformation it performs on the query.
  • Consider the implications of using default=str in json.dumps for debug logging and ensure that it does not introduce any unintended side effects.
  • Review the use of variable names to prevent potential confusion, such as redefining the query variable in the debug logging section.
  • Verify that the new query handling logic is robust and handles cases where the expected 'query' key might be missing from the conversion result to prevent runtime exceptions.

Thanks for using Sourcery. We offer it for free for open source projects and would be very grateful if you could help us grow. If you like it, would you consider sharing Sourcery on your favourite social media? ✨

Share Sourcery

Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

esxport/esxport.py Show resolved Hide resolved
@nikhilbadyal nikhilbadyal force-pushed the chore/es-body-deprecate branch from 71ac209 to 596e3a0 Compare January 26, 2024 08:25
Copy link

codecov bot commented Jan 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (c16329c) 100.00% compared to head (596e3a0) 100.00%.

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #53   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           10        10           
  Lines          305       306    +1     
=========================================
+ Hits           305       306    +1     

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

@nikhilbadyal nikhilbadyal merged commit 37528e8 into main Jan 26, 2024
9 checks passed
@nikhilbadyal nikhilbadyal deleted the chore/es-body-deprecate branch January 26, 2024 08:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore🧹 Code Cleanup
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant