Operational learning stats API #2335

sudip-khanal · 2024-12-09T06:27:29Z

Addresses

Implement API for Operational Learning statistics #2333

Changes

Add ops-learning stats api
Add unit test

Checklist

Things that should succeed before merging.

Updated/ran unit tests
Updated CHANGELOG.md

Release

If there is a version update, make sure to tag the repository with the latest version.

sudan45

Minor Changes

per/test_views.py

per/drf_views.py

susilnem

Let's Check the queries and remove duplicated queries.
mostly for country and region.

per/drf_views.py

susilnem

Let's add some filter on it

per/drf_views.py

Add validated filter

per/test_views.py

per/drf_views.py

per/test_views.py

per/drf_views.py

Rup-Narayan-Rajbanshi · 2024-12-17T10:45:52Z

per/serializers.py

+
+
+class LearningSourcesOvertimeSerializer(serializers.Serializer):
+    type = serializers.IntegerField()


@susilnem Do we return type as integer or get display name for type? If no may be we need to do type = serializers.CharField(source='get_type_display', read_only=True) to get the type name.

No, for now it's not required as it should be managed by the client side

Are we sure about this? It will be complicated for the client side to do this mapping.

source='get_type_display' can't be used here, as the object will be a dict instead of a proper object. We could use serializer_method or do the enum->label in the views.

thenav56

Looks good. Few integration required

thenav56 · 2024-12-18T05:07:21Z

per/drf_views.py

+        learning_by_sector = (
+            SectorTag.objects.filter(validated_sectors__in=queryset, title__isnull=False)
+            .annotate(count=Count("validated_sectors", distinct=True))
+            .values("title", "count")


We also need to add 'id', this will be used by client as unique key

thenav56 · 2024-12-18T05:16:42Z

per/drf_views.py

+                date=F("start_date"),
+                count=Count("appealdocument", distinct=True),
+            )
+            .values("type", "date", "count")


We also need to add 'id', this will be used by client as unique key

thenav56 · 2024-12-18T05:17:30Z

per/drf_views.py

+            source_used=Count("appeal_code__appealdocument", distinct=True),
+        )
+
+        learning_by_sector = (


Let's add _qs as postfix (learning_by_sector_qs) for all querysets variables

thenav56 · 2024-12-18T05:17:56Z

per/drf_views.py

+                region_name=F("label"),
+                count=Count("appeal__opslearning", distinct=True),
+            )
+            .values("region_name", "count")


We also need to add 'id', this will be used by client as unique key

thenav56 · 2024-12-18T05:18:02Z

per/drf_views.py

+                country_name=F("name"),
+                count=Count("appeal__opslearning", distinct=True),
+            )
+            .values("country_id", "country_name", "count")


We also need to add 'id', this will be used by client as unique key

thenav56 · 2024-12-18T05:22:34Z

per/serializers.py

+
+
+class LearningSourcesOvertimeSerializer(serializers.Serializer):
+    type = serializers.IntegerField()


Are we sure about this? It will be complicated for the client side to do this mapping.

source='get_type_display' can't be used here, as the object will be a dict instead of a proper object. We could use serializer_method or do the enum->label in the views.

thenav56 · 2024-12-18T05:25:02Z

per/factories.py

+    class Meta:
+        model = Appeal
+
+    country = factory.SubFactory(CountryFactory)


Let's not use factory.SubFactory, this will create objects without developer knowledge which can have weird confusing related to data generation, and it's effect.

thenav56 · 2024-12-18T05:25:52Z

per/factories.py

 class OpsLearningFactory(factory.django.DjangoModelFactory):
    learning = fuzzy.FuzzyText(length=50)

    class Meta:
        model = OpsLearning

+    appeal_code = factory.SubFactory(AppealFactory)
+    is_validated = fuzzy.FuzzyChoice([True, False])


Let's not use fuzzy choice for is_validated, we should manually define in the test cases as lots of endpoints depends on this

thenav56 · 2024-12-18T05:28:57Z

per/serializers.py

+    learning_by_region = LearningByRegionSerializer(many=True)
+    learning_by_country = LearningByCountrySerializer(many=True)
+    learning_by_sector = LearningBySectorSerializer(many=True)
+    sources_overtime = LearningSourcesOvertimeSerializer(many=True)


Let's explicitly define required=True for all fields

thenav56 · 2024-12-18T05:30:38Z

per/test_views.py

+        url = "/api/v2/ops-learning/stats/"
+        response = self.client.get(url)
+
+        self.assert_200(response)


If we are comparing all fields data, it will be better to just use basic dict assert instead.

assert response.data == expected_data

* Add Opslearning stats Add validated filter * Refactor ops learning stat api * Change in source over time * Add filter check for validated opslearning * fix test cases and refactor queryset * Add start date field in appeal serailizer * Change filter queryset and add label for appealtype * Define required field in serializers * Remove subfactories and id in appeal queryset --------- Co-authored-by: Sushil Tiwari <[email protected]>

sudip-khanal marked this pull request as draft December 9, 2024 06:27

sudip-khanal marked this pull request as ready for review December 9, 2024 06:36

sudip-khanal marked this pull request as draft December 9, 2024 08:06

susilnem requested review from Rup-Narayan-Rajbanshi and susilnem December 9, 2024 08:14

sudan45 requested changes Dec 10, 2024

View reviewed changes

Rup-Narayan-Rajbanshi approved these changes Dec 10, 2024

View reviewed changes

sudan45 requested changes Dec 10, 2024

View reviewed changes

per/test_views.py Outdated Show resolved Hide resolved

per/drf_views.py Outdated Show resolved Hide resolved

samshara changed the title ~~Feature/ops learning stat api~~ Operational learning stats API Dec 10, 2024

susilnem requested changes Dec 10, 2024

View reviewed changes

per/drf_views.py Outdated Show resolved Hide resolved

sudip-khanal force-pushed the feature/ops-learning-stat-api branch 2 times, most recently from 3e73ced to 4d61d3d Compare December 11, 2024 17:36

susilnem requested changes Dec 12, 2024

View reviewed changes

per/drf_views.py Outdated Show resolved Hide resolved

per/drf_views.py Outdated Show resolved Hide resolved

per/drf_views.py Outdated Show resolved Hide resolved

per/drf_views.py Outdated Show resolved Hide resolved

per/drf_views.py Outdated Show resolved Hide resolved

sudip-khanal force-pushed the feature/ops-learning-stat-api branch from ad5e19a to c1245a6 Compare December 13, 2024 01:36

Add Opslearning stats

2a6d79f

Add validated filter

sudip-khanal force-pushed the feature/ops-learning-stat-api branch from c1245a6 to 2a6d79f Compare December 16, 2024 03:23

sudan45 requested changes Dec 16, 2024

View reviewed changes

per/test_views.py Outdated Show resolved Hide resolved

per/drf_views.py Outdated Show resolved Hide resolved

susilnem added 2 commits December 17, 2024 10:16

Refactor ops learning stat api

543215c

Change in source over time

ef38a4f

sudan45 requested changes Dec 17, 2024

View reviewed changes

per/test_views.py Outdated Show resolved Hide resolved

per/test_views.py Outdated Show resolved Hide resolved

per/drf_views.py Outdated Show resolved Hide resolved

sudan45 approved these changes Dec 17, 2024

View reviewed changes

susilnem force-pushed the feature/ops-learning-stat-api branch from 3c9dda6 to ca1c3d3 Compare December 17, 2024 10:39

Add filter check for validated opslearning

ca1c3d3

Rup-Narayan-Rajbanshi reviewed Dec 17, 2024

View reviewed changes

fix test cases and refactor queryset

afff697

susilnem force-pushed the feature/ops-learning-stat-api branch from 32c4d62 to afff697 Compare December 17, 2024 14:02

susilnem self-assigned this Dec 17, 2024

Add start date field in appeal serailizer

569eae9

susilnem marked this pull request as ready for review December 18, 2024 04:34

thenav56 requested changes Dec 18, 2024

View reviewed changes

susilnem added 3 commits December 18, 2024 11:53

Change filter queryset and add label for appealtype

641fb4d

Define required field in serializers

da571fc

Remove subfactories and id in appeal queryset

33c3626

susilnem merged commit 0777e4e into project/operational-learning2.0 Dec 18, 2024
3 checks passed

susilnem deleted the feature/ops-learning-stat-api branch December 18, 2024 06:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Operational learning stats API #2335

Operational learning stats API #2335

sudip-khanal commented Dec 9, 2024 •

edited by susilnem

Loading

sudan45 left a comment

susilnem left a comment

susilnem left a comment

Rup-Narayan-Rajbanshi Dec 17, 2024

susilnem Dec 17, 2024 •

edited

Loading

thenav56 Dec 18, 2024

thenav56 left a comment

thenav56 Dec 18, 2024

thenav56 Dec 18, 2024

thenav56 Dec 18, 2024

thenav56 Dec 18, 2024

thenav56 Dec 18, 2024

thenav56 Dec 18, 2024

thenav56 Dec 18, 2024

thenav56 Dec 18, 2024

thenav56 Dec 18, 2024

thenav56 Dec 18, 2024



		class LearningSourcesOvertimeSerializer(serializers.Serializer):
		type = serializers.IntegerField()

Operational learning stats API #2335

Operational learning stats API #2335

Conversation

sudip-khanal commented Dec 9, 2024 • edited by susilnem Loading

Changes

Checklist

Release

sudan45 left a comment

Choose a reason for hiding this comment

susilnem left a comment

Choose a reason for hiding this comment

susilnem left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

susilnem Dec 17, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thenav56 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sudip-khanal commented Dec 9, 2024 •

edited by susilnem

Loading

susilnem Dec 17, 2024 •

edited

Loading