[feature] Added REST API for wifisession and wificlients #374 #382

Aryamanz29 · 2022-05-27T11:37:06Z

Blockers

[chores] Use SeleniumTestMixin from openwisp-utils #517

Closes #374

Peek.2022-05-27.16-24.mp4

GIF/Demo

Checks:

I have manually tested the proposed changes
I have updated the documentation (e.g. README.rst)

coveralls · 2022-05-27T11:45:29Z

Coverage: 98.943% (+0.03%) from 98.909% when pulling 95fa60a on Aryamanz29:issue-374/wifi-client-session-rest-api into 15977c7 on openwisp:master.

Aryamanz29 · 2022-05-27T11:59:01Z

I need your review (when you're free) @pandafy @nemesisdesign. This will let me know that I'm going on the right direction with this PR or not 😄

nemesifier

Looks good, please add at least one test for each endpoint.

README.rst

nemesifier

I found some problems during testing.

Multitenancy test gave error

I tried logging in with a non superuser to test multitenancy but when I tried opening the wifi session list API endpoint I got this exception:

FieldError at /api/v1/monitoring/wifi-session/
Cannot resolve keyword 'organization' into field. Choices are: device, device_id, id, interface_name, modified, ssid, start_time, stop_time, wifi_client, wifi_client_id

The same happens for the wifi-client endpoint. Please test this on your end and look at the implementation of the multitenancy in other API endpoints, refer to https://github.com/openwisp/openwisp-users#organization_field and the other DRF utilities provided in OpenWISP Users.

Filters invalid name

Do you know why there's this "[invalid name]" here?

Browsable API selects for foreign keys

The wifi session API endpoint shows a select for "device" and "wifi client", however, these selects will be huge on production systems, slowing down the response time in the browsable API or even causing it to fail with a timeout error. For this reason, can you find a way to display this field using only the primary key?

See https://www.django-rest-framework.org/topics/browsable-api/#handling-choicefield-with-large-numbers-of-items for more info.

openwisp_monitoring/device/api/serializers.py

Aryamanz29 · 2022-06-01T13:17:15Z

pandafy

Good work @Aryamanz29! This PR is coming along well.

Other requested changes

It is possible to create WifiSession with device_id from another organization. This is undesired. Add a failing test for this.
Add tests for REST API filters

openwisp_monitoring/device/api/views.py

openwisp_monitoring/device/api/serializers.py

openwisp_monitoring/device/tests/test_api.py

openwisp_monitoring/device/api/serializers.py

openwisp_monitoring/device/tests/test_api.py

README.rst

pandafy

I would add dedicated tests for multi-tenancy for each model:

test_wifi_clients_multi_tenancy
test_wifi_session_multi_tenancy
And test each operation (GET, POST, PUT, PATCH) within a subtest in these test cases.

openwisp_monitoring/device/api/serializers.py

openwisp_monitoring/device/tests/test_api.py

Closes openwisp#374

- Added nested serializer. - Used select_related() to enhance API performance. - Added missing fields like modified, created, device_name, org_name etc.

… input - Fixed browsable API selects for foreign keys, Changed select field to input. - Fixed browsable API [Invalid name] attribute bug, Explicitly provided label for related model.

- Fixed multitenancy test error. - Added use of available API filter in README.

- Changed ordering in WifiClient class Meta to prevent DRF "UnorderedObjectListWarning: Pagination may yield inconsistent results with an unordered object_list"

- Improved tests. - Mentioned device_group in the README. - Added extra_kwargs in WifiSessionCreateUpdateSerializer.

- Chaneged device_organization filter to organization_slug filter. - Removed unused filters from README.

- Added comparison (gt, gte, lt, lte) for filtering with time. - Added tests for API filters.

…n 2.x Pinned urllib3 to version 1.x More Info: https://urllib3.readthedocs.io/en/latest/v2-migration-guide.html psf/requests@2ad18e0

…i session endpoint As per to code review: openwisp#382 (comment) - Removed wifi client endpoints. - Exposed only list wifi session endpoint. - Updated tests and docs.

…i session endpoint As per the code review: openwisp#382 (comment) - Removed wifi client endpoints. - Exposed only list wifi session endpoint. - Updated tests and docs.

… views of the admin view - Improved list and detail api response (similar to admin). - Added api tests.

- Improved existing api tests.

Aryamanz29 · 2023-05-25T10:46:47Z

`Updates`

Below is a comparison between the WiFi session admin (list and detail view) and the WiFi session API (detail and list view):

@nemesisdesign Now, I have a question regarding how we should include WiFi client field information in the API response. Should we use a nested serializer (as demonstrated in the API detail view) or should we directly add the client serializer fields (as displayed in the API list) to the response?

- `ValidatedModelSerializer` and `FilterSerializerByOrgManaged` is not required for read-only API views.

nemesifier

@Aryamanz29 the nested serialzier solution looks nice and clean!

nemesifier requested changes May 27, 2022

View reviewed changes

README.rst Outdated Show resolved Hide resolved

nemesifier requested changes May 30, 2022

View reviewed changes

openwisp_monitoring/device/api/serializers.py Outdated Show resolved Hide resolved

openwisp_monitoring/device/api/serializers.py Outdated Show resolved Hide resolved

Aryamanz29 force-pushed the issue-374/wifi-client-session-rest-api branch 4 times, most recently from 268f065 to 40845bb Compare June 2, 2022 20:45

pandafy requested changes Jun 7, 2022

View reviewed changes

Aryamanz29 force-pushed the issue-374/wifi-client-session-rest-api branch from 433d6ca to 3074fea Compare June 9, 2022 15:19

Aryamanz29 marked this pull request as ready for review June 10, 2022 17:04

Aryamanz29 self-assigned this Jun 10, 2022

Aryamanz29 added this to the OpenWISP Monitoring 1.1.0 Release milestone Jun 10, 2022

Aryamanz29 added the enhancement New feature or request label Jun 10, 2022

pandafy requested changes Jun 13, 2022

View reviewed changes

openwisp_monitoring/device/api/serializers.py Outdated Show resolved Hide resolved

openwisp_monitoring/device/tests/test_api.py Outdated Show resolved Hide resolved

openwisp_monitoring/device/tests/test_api.py Outdated Show resolved Hide resolved

Aryamanz29 added 12 commits June 14, 2022 13:26

[feature] Added REST API for wifisession and wificlients openwisp#374

195e1ff

Closes openwisp#374

[requested-changes] Added nested serializers for wificlient

a774fda

- Added nested serializer. - Used select_related() to enhance API performance. - Added missing fields like modified, created, device_name, org_name etc.

[requested-changes] Fixed [invalid name] bug & Changed API selects to…

e7ad5a7

… input - Fixed browsable API selects for foreign keys, Changed select field to input. - Fixed browsable API [Invalid name] attribute bug, Explicitly provided label for related model.

[requested-changes] Fixed cannot resolve keyword 'organization'

98da222

- Fixed multitenancy test error. - Added use of available API filter in README.

[docs] Minor format change

fa093f5

[tests] Added tests for wifisession endpoint

14ba0f2

[tests] Added tests for wificlient endpoint

366c950

- Changed ordering in WifiClient class Meta to prevent DRF "UnorderedObjectListWarning: Pagination may yield inconsistent results with an unordered object_list"

[requested-changes] Improved tests & removed redundant filters

aab488b

- Improved tests. - Mentioned device_group in the README. - Added extra_kwargs in WifiSessionCreateUpdateSerializer.

[requested-changes] Changed device_org to org_slug filter

71b7eb7

- Chaneged device_organization filter to organization_slug filter. - Removed unused filters from README.

[requested-changes] Change time filters & added filter tests

bc68c6a

- Added comparison (gt, gte, lt, lte) for filtering with time. - Added tests for API filters.

[docs] Minor changes

96f78a9

[fix] Fixed creation of Wifisession with device_id from different org

385d69c

Aryamanz29 force-pushed the issue-374/wifi-client-session-rest-api branch from eb9d404 to 385d69c Compare June 14, 2022 07:57

Merge branch 'master' into issue-374/wifi-client-session-rest-api

cdf00bb

Aryamanz29 force-pushed the issue-374/wifi-client-session-rest-api branch from a36e71c to cdf00bb Compare March 13, 2023 12:38

Aryamanz29 added 2 commits May 8, 2023 14:33

Merge branch 'master' into issue-374/wifi-client-session-rest-api

6a00efa

[ci/fix] Fixed CI build failure caused by urllib3 migration to versio…

49fd283

…n 2.x Pinned urllib3 to version 1.x More Info: https://urllib3.readthedocs.io/en/latest/v2-migration-guide.html psf/requests@2ad18e0

Aryamanz29 force-pushed the issue-374/wifi-client-session-rest-api branch from 475c786 to 51af136 Compare May 8, 2023 10:50

[req-changes] Removed wifi client endpoints and exposed only list wif…

1c673f0

…i session endpoint As per the code review: openwisp#382 (comment) - Removed wifi client endpoints. - Exposed only list wifi session endpoint. - Updated tests and docs.

Aryamanz29 force-pushed the issue-374/wifi-client-session-rest-api branch from 51af136 to 1c673f0 Compare May 8, 2023 11:00

[req-changes] Updated endpoint to look similar to the list and detail…

5301a53

… views of the admin view - Improved list and detail api response (similar to admin). - Added api tests.

Aryamanz29 force-pushed the issue-374/wifi-client-session-rest-api branch from cfcec98 to 5301a53 Compare May 24, 2023 13:01

Aryamanz29 added 4 commits May 24, 2023 22:41

Merge branch 'master' into issue-374/wifi-client-session-rest-api

14a3cf6

[qa] Fixed conflicting migrations

58983b4

[tests] Added wifi session multitenancy tests

2d9ed02

- Improved existing api tests.

[change] Included WiFi 6/5/4 client capability in API response

b134caa

Aryamanz29 force-pushed the issue-374/wifi-client-session-rest-api branch 2 times, most recently from 029ea5e to 5f03f3a Compare May 25, 2023 08:12

Aryamanz29 requested a review from nemesifier May 25, 2023 10:49

Aryamanz29 force-pushed the issue-374/wifi-client-session-rest-api branch from 5f03f3a to 9832b80 Compare May 25, 2023 10:59

[docs] Improved wifi session available filters section

15260e2

- `ValidatedModelSerializer` and `FilterSerializerByOrgManaged` is not required for read-only API views.

Aryamanz29 force-pushed the issue-374/wifi-client-session-rest-api branch from 9832b80 to 15260e2 Compare May 25, 2023 11:14

Merge branch 'master' into issue-374/wifi-client-session-rest-api

325aa85

nemesifier reviewed May 25, 2023

View reviewed changes

[req-change] Use nested client serializer for list and detail API views

c497070

Aryamanz29 requested a review from nemesifier May 26, 2023 09:42

nemesifier approved these changes May 29, 2023

View reviewed changes

nemesifier merged commit 5dd00cc into openwisp:master May 29, 2023
9 checks passed

Aryamanz29 deleted the issue-374/wifi-client-session-rest-api branch May 30, 2023 03:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[feature] Added REST API for wifisession and wificlients #374 #382

[feature] Added REST API for wifisession and wificlients #374 #382

Aryamanz29 commented May 27, 2022 •

edited

Loading

coveralls commented May 27, 2022 •

edited

Loading

Aryamanz29 commented May 27, 2022

nemesifier left a comment

nemesifier left a comment

Aryamanz29 commented Jun 1, 2022 •

edited

Loading

pandafy left a comment •

edited by Aryamanz29

Loading

pandafy left a comment

Aryamanz29 commented May 25, 2023

nemesifier left a comment

[feature] Added REST API for wifisession and wificlients #374 #382

[feature] Added REST API for wifisession and wificlients #374 #382

Conversation

Aryamanz29 commented May 27, 2022 • edited Loading

GIF/Demo

coveralls commented May 27, 2022 • edited Loading

Aryamanz29 commented May 27, 2022

nemesifier left a comment

Choose a reason for hiding this comment

nemesifier left a comment

Choose a reason for hiding this comment

Multitenancy test gave error

Filters invalid name

Browsable API selects for foreign keys

Aryamanz29 commented Jun 1, 2022 • edited Loading

Todo :

pandafy left a comment • edited by Aryamanz29 Loading

Choose a reason for hiding this comment

pandafy left a comment

Choose a reason for hiding this comment

Aryamanz29 commented May 25, 2023

Updates

nemesifier left a comment

Choose a reason for hiding this comment

Aryamanz29 commented May 27, 2022 •

edited

Loading

coveralls commented May 27, 2022 •

edited

Loading

Aryamanz29 commented Jun 1, 2022 •

edited

Loading

pandafy left a comment •

edited by Aryamanz29

Loading

`Updates`