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

feat: added support for TTL in response headers #219

Merged
merged 1 commit into from
Nov 24, 2024

Conversation

TeKrop
Copy link
Owner

@TeKrop TeKrop commented Nov 24, 2024

Summary by Sourcery

Add support for TTL in response headers to indicate cache duration and refactor the Dockerfile to use OpenResty instead of Nginx for enhanced Lua script integration.

New Features:

  • Introduce support for TTL in response headers to indicate cache duration.

Enhancements:

  • Refactor the Dockerfile to use OpenResty instead of Nginx for better integration with Lua scripts.

Build:

  • Switch the base image in the Dockerfile from Nginx to OpenResty to support Lua scripting.

Documentation:

  • Update documentation to reflect the use of OpenResty instead of Nginx.

@TeKrop TeKrop added the enhancement New feature or request label Nov 24, 2024
@TeKrop TeKrop self-assigned this Nov 24, 2024
Copy link
Contributor

sourcery-ai bot commented Nov 24, 2024

Reviewer's Guide by Sourcery

This PR implements TTL support in response headers by switching from nginx to OpenResty and adding TTL headers to API responses. The implementation involves both infrastructure changes (Docker/nginx) and application code modifications to expose cache TTL values.

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

File-Level Changes

Change Details Files
Switched from nginx to OpenResty as the reverse proxy
  • Updated base Docker image to OpenResty Alpine
  • Removed manual nginx and redis module compilation
  • Updated entrypoint script to use OpenResty commands
  • Added template for Lua script handling
build/nginx/Dockerfile
build/nginx/entrypoint.sh
build/nginx/redis_handler.lua.template
build/nginx/nginx.conf
Added TTL header support in API responses
  • Added cache_ttl_header configuration setting
  • Added TTL header to success response schema
  • Modified AbstractController to include TTL in response headers
  • Updated retry-after header to use configuration setting
app/config.py
app/helpers.py
app/controllers.py
app/overfast_client.py
Updated route handlers to support response headers
  • Added Response parameter to all route handlers
  • Updated controller instantiations to pass response object
  • Added success_responses to route decorators
app/players/router.py
app/gamemodes/router.py
app/heroes/router.py
app/maps/router.py
app/roles/router.py

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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

sonarcloud bot commented Nov 24, 2024

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 adding documentation about the OpenResty/nginx configuration structure since nginx.conf was removed
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 24df519 into main Nov 24, 2024
3 checks passed
@TeKrop TeKrop deleted the feature/nginx-redis-ttl branch November 24, 2024 19:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant