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(encoding): forcing ascii chars in app response body #227

Merged
merged 1 commit into from
Feb 2, 2025

Conversation

TeKrop
Copy link
Owner

@TeKrop TeKrop commented Feb 2, 2025

Summary by Sourcery

Enforce ASCII encoding for all JSON responses in the application.

Bug Fixes:

  • Fixed an encoding issue where non-ASCII characters could appear in the JSON response body.

Enhancements:

  • Updated the application to use a custom JSONResponse class that enforces ASCII encoding.

@TeKrop TeKrop added the bug Something isn't working label Feb 2, 2025
@TeKrop TeKrop self-assigned this Feb 2, 2025
@TeKrop TeKrop linked an issue Feb 2, 2025 that may be closed by this pull request
Copy link
Contributor

sourcery-ai bot commented Feb 2, 2025

Reviewer's Guide by Sourcery

The pull request enforces ASCII encoding in the application's JSON responses to prevent encoding issues. It introduces a custom JSONResponse class that ensures all responses are encoded using ASCII. Additionally, the project version has been updated.

Sequence diagram showing the JSON response encoding flow

sequenceDiagram
    participant C as Client
    participant A as API
    participant J as ASCIIJSONResponse
    C->>A: HTTP Request
    A->>J: Process Response
    J->>J: Encode content as ASCII
    Note over J: ensure_ascii=True
    J-->>A: Return encoded bytes
    A-->>C: Send ASCII-encoded JSON response
Loading

Class diagram showing the new ASCIIJSONResponse class

classDiagram
    class JSONResponse {
        +render(content: Any) bytes
    }
    class ASCIIJSONResponse {
        +render(content: Any) bytes
    }
    JSONResponse <|-- ASCIIJSONResponse
    note for ASCIIJSONResponse "Enforces ASCII encoding in JSON responses"
Loading

File-Level Changes

Change Details Files
Implemented a custom JSON response class to enforce ASCII encoding.
  • Created a new ASCIIJSONResponse class inheriting from JSONResponse.
  • Overrode the render method to enforce ASCII encoding using ensure_ascii=True.
  • Set the default response class to ASCIIJSONResponse in the FastAPI app.
  • Updated the exception handler to use ASCIIJSONResponse.
app/main.py
Updated the project version.
  • Incremented the project version from 3.9.0 to 3.9.1.
pyproject.toml

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

sonarqubecloud bot commented Feb 2, 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 @TeKrop - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider keeping UTF-8 encoding instead of forcing ASCII. ASCII encoding may cause issues with international characters and modern web applications generally expect proper Unicode support. If there's a specific reason for requiring ASCII, consider documenting it in the PR description.
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.

@TeKrop TeKrop merged commit f0f4aab into main Feb 2, 2025
4 checks passed
@TeKrop TeKrop deleted the 226-uncached-responses-badly-handle-utf-8-characters branch February 2, 2025 20:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Uncached responses badly handle UTF-8 characters
1 participant