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

Allow None value for NUM_PROXIES #3409

Merged
merged 1 commit into from
Nov 29, 2023
Merged

Conversation

sarayourfriend
Copy link
Collaborator

@sarayourfriend sarayourfriend commented Nov 28, 2023

Fixes

Related to #3398

Description

NUM_PROXIES needs to be able to be None to disable the feature. I got mixed up about the behaviour of 0 value for it and thought it was the same as None, but it's drastically different. None falls back to default, but 0 tells DRF to use the remote address (IP) of the request, which in the case of requests via proxy, is always the last proxy that handled the request. If you set it to 0, then everyone is getting throttled based on the proxy they went through, meaning they're sharing throttle quotas, rather than through their individual IP.

Testing Instructions

Run the application and use ipython to verify that NUM_PROXIES defaults to None:

In [1]: from conf.settings import rest_framework
In [2]: rest_framework.REST_FRAMEWORK
Out[2]: 
{'DEFAULT_AUTHENTICATION_CLASSES': ('oauth2_provider.contrib.rest_framework.OAuth2Authentication',),
 'DEFAULT_VERSIONING_CLASS': 'rest_framework.versioning.URLPathVersioning',
 'DEFAULT_RENDERER_CLASSES': ('rest_framework.renderers.JSONRenderer',
  'api.utils.drf_renderer.BrowsableAPIRendererWithoutForms'),
 'DEFAULT_THROTTLE_RATES': {'anon_burst': None,
  'anon_sustained': None,
  'anon_healthcheck': None,
  'anon_thumbnail': None,
  'oauth2_client_credentials_thumbnail': None,
  'oauth2_client_credentials_sustained': None,
  'oauth2_client_credentials_burst': None,
  'enhanced_oauth2_client_credentials_sustained': None,
  'enhanced_oauth2_client_credentials_burst': None,
  'exempt_oauth2_client_credentials': None},
 'EXCEPTION_HANDLER': 'api.utils.exceptions.exception_handler',
 'DEFAULT_SCHEMA_CLASS': 'api.docs.base_docs.MediaSchema',
 'NUM_PROXIES': None}

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • [N/A] I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • [N/A] I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@sarayourfriend sarayourfriend added 🟥 priority: critical Must be addressed ASAP 🛠 goal: fix Bug fix 💻 aspect: code Concerns the software code in the repository 🧱 stack: api Related to the Django API labels Nov 28, 2023
@sarayourfriend sarayourfriend requested a review from a team as a code owner November 28, 2023 21:02
Copy link
Member

@krysal krysal left a comment

Choose a reason for hiding this comment

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

Confirmed it's None with the following commands ✅

just api/ipyhon
from rest_framework.settings import api_settings
print(api_settings.NUM_PROXIES)

It was returning 0 on main.

Copy link
Collaborator

@AetherUnbound AetherUnbound left a comment

Choose a reason for hiding this comment

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

LGTM and local commands load the setting as None appropriately!

@sarayourfriend sarayourfriend merged commit ba2e92f into main Nov 29, 2023
71 checks passed
@sarayourfriend sarayourfriend deleted the fix/allow-none-num-proxies branch November 29, 2023 06:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟥 priority: critical Must be addressed ASAP 🧱 stack: api Related to the Django API
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants