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: disable throttling for priveleged users #763

Merged
merged 1 commit into from
Feb 11, 2025

Conversation

iloveagent57
Copy link
Contributor

Introduces a setting PRIVELEGED_USER_IDS, such that any user id in the list is exempt from throttling limits.

Testing considerations

  1. In your private.py file, include your requesting user id in the mentioned list.
  2. export MYJWT=[your JWT value]
  3. Execute the python below.
import requests
import os
import time

def make_request(do_print=False):
    endpoint = 'http://localhost:18170/api/v1/subscriptions/[sub-plan-uuid]'
    headers = {
        'Authorization': f"JWT {os.environ['MYJWT']}",
    }
    response = requests.get(endpoint, headers=headers)
    response.raise_for_status()
    if do_print:
        print(response.json())

def loop_requests(max_seconds=10):
    count = 0
    start_time = time.time()
    while True:
        now = time.time()
        if (now - start_time) >= max_seconds:
            break
        make_request()
        count += 1

    print('Total count was:', count, 'over', max_seconds, 'seconds.')

if __name__ == '__main__':
    loop_requests(20)
  • Include instructions for any required manual tests, and any manual testing that has
    already been performed.
  • Include unit and a11y tests as appropriate
  • Consider performance issues.
  • Check that Database migrations are backwards-compatible

Post-review

Squash commits into discrete sets of changes

Introduces a setting PRIVELEGED_USER_IDS, such that any user
id in the list is exempt from throttling limits.
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 11, 2025
@openedx-webhooks
Copy link

Thanks for the pull request, @iloveagent57!

This repository is currently maintained by @openedx/2u-enterprise.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.


Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

def allow_request(self, request, view):
user = request.user

if user and user.is_authenticated and user.id in settings.PRIVELEGED_USER_IDS:
Copy link
Member

@adamstankiewicz adamstankiewicz Feb 11, 2025

Choose a reason for hiding this comment

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

[question] Will settings.PRIVELEGED_USER_IDS be configured using license-manager's local User.id, or is the hope to configure the lms_user_id associated with these privileged users?

Copy link
Member

Choose a reason for hiding this comment

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

Answered in Slack: local User.id

@iloveagent57 iloveagent57 merged commit 3d880fc into master Feb 11, 2025
5 checks passed
@iloveagent57 iloveagent57 deleted the aed/priveleged-user-throttling branch February 11, 2025 15:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants