[api] Added Scoped Throttling #34 #81

ManishShah120 · 2020-12-26T16:34:37Z

closses #34

ManishShah120 · 2020-12-26T16:35:59Z

@nemesisdesign, @atb00ker have a look 🤔

coveralls · 2020-12-26T16:53:51Z

Coverage decreased (-0.01%) to 99.329% when pulling b9207f5 on ManishShah120:issues/34-Add-scoped_throttling into b130a44 on openwisp:master.

atb00ker

2 initial comments:

tests/openwisp2/settings.py

openwisp_ipam/api/views.py

tests/openwisp2/settings.py

openwisp_ipam/apps.py

ManishShah120 · 2021-01-06T21:59:21Z

@nemesisdesign , @atb00ker

nemesifier · 2021-01-07T03:38:04Z

tests/openwisp2/settings.py

@@ -85,6 +85,7 @@
 STATIC_URL = '/static/'
 EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
 OPENWISP_USERS_AUTH_API = True
+OPENWISP_IPAM_API = True


let's avoid this setting, some features of the API is used by the admin as well so it doesn't make sense to turn it off

nemesifier · 2021-01-07T03:38:13Z

openwisp_ipam/apps.py

@@ -9,7 +10,13 @@ class OpenWispIpamConfig(ApiAppConfig):
    name = 'openwisp_ipam'
    verbose_name = 'IPAM'

+    API_ENABLED = getattr(settings, 'OPENWISP_IPAM_API')


simply set this to True

ManishShah120 · 2021-01-07T07:32:27Z

@nemesisdesign I have done the changes as requested have a look.

nemesifier

Thanks @ManishShah120 👍

nemesifier

I realized something important.
We're not documenting how to change the default throttling settings.
Can it be done without having to modify the code of openwisp-ipam? I mean just by adding something in settings.py. Can you double check this please and let me know?
I think I'll have to open an issue for fw-upgrader too since it should be done there too.

PS: for the commit message, use this:

[feature] Added throttling of API requests #34

See https://www.conventionalcommits.org/.

ManishShah120 · 2021-01-07T14:35:44Z

I realized something important.
We're not documenting how to change the default throttling settings.
Can it be done without having to modify the code of openwisp-ipam? I mean just by adding something in settings.py. Can you double check this please and let me know?

Okay, @nemesisdesign I'll check and see if it can be done and let you know.

I think I'll have to open an issue for fw-upgrader too since it should be done there too.

Yeah, I guess so

ManishShah120 · 2021-01-08T21:20:54Z

I realized something important.
We're not documenting how to change the default throttling settings.
Can it be done without having to modify the code of openwisp-ipam? I mean just by adding something in settings.py. Can you double check this please and let me know?
I think I'll have to open an issue for fw-upgrader too since it should be done there too.

Hey, @nemesisdesign I confirmed in other openwisp modules and found no sign of documentation related to changing of default throttling settings, So it will be a good idea to introduce in it.

And about the modification of the default throttling settings, yes it can be done but in that case, we will need to move this portion of the code from apps.py

REST_FRAMEWORK_SETTINGS = {
    'DEFAULT_THROTTLE_RATES': {
         'ipam': default_or_test('400/hour', None)},
}

to settings.py file, or if there is any other way possible please let me know. I'll try to learn and do it.

atb00ker · 2021-01-09T13:03:39Z

to settings.py file, or if there is any other way possible please let me know. I'll try to learn and do it.

This method looks good to me! 😄

nemesifier

@ManishShah120 question:

if you leave the code as is
then add the setting REST_FRAMEWORK_SETTINGS in settings.py as you described (just without using default_or_test which is not meant to be used during configuration)

Does the override work?

ManishShah120 · 2021-01-11T07:30:34Z

Yes, @nemesisdesign, It does override's the previous codes implemented in apps.py and takes effect whatever value is provided in the settings.py file and if we comment out this REST_FRAMEWORK from settings.py then again it takes effect whatever is implemented in apps.py file.

nemesifier

Yes, @nemesisdesign, It does override's the previous codes implemented in apps.py and takes effect whatever value is provided in the settings.py file and if we comment out this REST_FRAMEWORK from settings.py then again it takes effect whatever is implemented in apps.py file.

Ok @ManishShah120, thanks for double checking, please can you add a few lines in the README that explain how to override the throttling settings?

ManishShah120 · 2021-01-12T08:12:27Z

@nemesisdesign , Is this Okay.

closes openwisp#34

atb00ker

Quick look, LGTM! 😄

nemesifier

Great work @ManishShah120 👍

ManishShah120 force-pushed the issues/34-Add-scoped_throttling branch from 047a4e4 to 4cc0d13 Compare December 26, 2020 16:50

atb00ker reviewed Dec 30, 2020

View reviewed changes

tests/openwisp2/settings.py Outdated Show resolved Hide resolved

openwisp_ipam/api/views.py Outdated Show resolved Hide resolved

nemesifier reviewed Dec 30, 2020

View reviewed changes

tests/openwisp2/settings.py Outdated Show resolved Hide resolved

openwisp_ipam/apps.py Outdated Show resolved Hide resolved

nemesifier added this to In progress in OpenWISP Priorities for next releases via automation Dec 30, 2020

ManishShah120 force-pushed the issues/34-Add-scoped_throttling branch 2 times, most recently from e560c02 to 4d6e446 Compare January 6, 2021 21:52

nemesifier requested changes Jan 7, 2021

View reviewed changes

ManishShah120 force-pushed the issues/34-Add-scoped_throttling branch from 4d6e446 to 55cc03f Compare January 7, 2021 07:25

ManishShah120 requested a review from nemesifier January 7, 2021 10:45

nemesifier approved these changes Jan 7, 2021

View reviewed changes

OpenWISP Priorities for next releases automation moved this from In progress to Reviewer approved Jan 7, 2021

OpenWISP Priorities for next releases automation moved this from Reviewer approved to In progress Jan 7, 2021

nemesifier requested changes Jan 7, 2021

View reviewed changes

ManishShah120 force-pushed the issues/34-Add-scoped_throttling branch from 55cc03f to 8376c9a Compare January 7, 2021 18:44

ManishShah120 requested a review from nemesifier January 10, 2021 13:28

nemesifier reviewed Jan 11, 2021

View reviewed changes

ManishShah120 requested a review from nemesifier January 11, 2021 07:31

nemesifier requested changes Jan 12, 2021

View reviewed changes

ManishShah120 force-pushed the issues/34-Add-scoped_throttling branch from 8376c9a to 043a06d Compare January 12, 2021 08:06

ManishShah120 requested a review from nemesifier January 12, 2021 08:12

[feature] Added throttling of API requests openwisp#34

b9207f5

closes openwisp#34

ManishShah120 force-pushed the issues/34-Add-scoped_throttling branch from 043a06d to b9207f5 Compare January 12, 2021 08:34

atb00ker reviewed Jan 12, 2021

View reviewed changes

[docs] Improved API throttling docs

4bc7735

OpenWISP Priorities for next releases automation moved this from In progress to Reviewer approved Jan 13, 2021

nemesifier approved these changes Jan 13, 2021

View reviewed changes

nemesifier merged commit ac9f346 into openwisp:master Jan 13, 2021

OpenWISP Priorities for next releases automation moved this from Reviewer approved to Done Jan 13, 2021

nemesifier assigned ManishShah120 Jan 13, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[api] Added Scoped Throttling #34 #81

[api] Added Scoped Throttling #34 #81

ManishShah120 commented Dec 26, 2020 •

edited

Loading

ManishShah120 commented Dec 26, 2020 •

edited

Loading

coveralls commented Dec 26, 2020 •

edited

Loading

atb00ker left a comment

ManishShah120 commented Jan 6, 2021

nemesifier Jan 7, 2021

ManishShah120 Jan 7, 2021

nemesifier Jan 7, 2021

ManishShah120 Jan 7, 2021

ManishShah120 commented Jan 7, 2021

nemesifier left a comment

nemesifier left a comment

ManishShah120 commented Jan 7, 2021

ManishShah120 commented Jan 8, 2021

atb00ker commented Jan 9, 2021

nemesifier left a comment

ManishShah120 commented Jan 11, 2021

nemesifier left a comment

ManishShah120 commented Jan 12, 2021

atb00ker left a comment •

edited

Loading

nemesifier left a comment

[api] Added Scoped Throttling #34 #81

[api] Added Scoped Throttling #34 #81

Conversation

ManishShah120 commented Dec 26, 2020 • edited Loading

ManishShah120 commented Dec 26, 2020 • edited Loading

coveralls commented Dec 26, 2020 • edited Loading

atb00ker left a comment

Choose a reason for hiding this comment

ManishShah120 commented Jan 6, 2021

nemesifier Jan 7, 2021

Choose a reason for hiding this comment

ManishShah120 Jan 7, 2021

Choose a reason for hiding this comment

nemesifier Jan 7, 2021

Choose a reason for hiding this comment

ManishShah120 Jan 7, 2021

Choose a reason for hiding this comment

ManishShah120 commented Jan 7, 2021

nemesifier left a comment

Choose a reason for hiding this comment

nemesifier left a comment

Choose a reason for hiding this comment

ManishShah120 commented Jan 7, 2021

ManishShah120 commented Jan 8, 2021

atb00ker commented Jan 9, 2021

nemesifier left a comment

Choose a reason for hiding this comment

ManishShah120 commented Jan 11, 2021

nemesifier left a comment

Choose a reason for hiding this comment

ManishShah120 commented Jan 12, 2021

atb00ker left a comment • edited Loading

Choose a reason for hiding this comment

nemesifier left a comment

Choose a reason for hiding this comment

ManishShah120 commented Dec 26, 2020 •

edited

Loading

ManishShah120 commented Dec 26, 2020 •

edited

Loading

coveralls commented Dec 26, 2020 •

edited

Loading

atb00ker left a comment •

edited

Loading