[ACADEMIC-16210] Moved API logic to api module and added check #43

rijuma · 2023-07-25T19:16:51Z

Separated API methods in its own module.
Enabled settings restrictions under summaryhook.summaryhook_summaries_configuration waffle flag.
Added endpoint specifications in readme.

Merge checklist:
Check off if complete or not applicable:

Version bumped
Changelog record added
Documentation updated (not only docstrings)
Fixup commits are squashed away
Unit tests added/updated
Manual testing instructions provided
Noted any: Concerns, dependencies, migration issues, deadlines, tickets

ashultz0

I have some random nitpicking comments about names and return values that honestly I don't care whether you take them or not.

The one thing that makes me hit request changes is that we do need the exposed API function and view and URL exposing the waffle flag to know if configuration is even allowed for the course.

ashultz0 · 2023-07-26T20:01:22Z

ai_aside/api/api.py

@@ -0,0 +1,138 @@
+"""


a trick you can do here is to put the api calls into init.py inside the api directory, then you won't have api.api going on.

if you do that it would probably make sense to put just the public items in there and put the _get style internal methods in like api/internal.py

honestly I'm not a huge fan of putting a bunch of stuff in the init.py but it is a very common practice

alternately, what if we called the api directory the config_api directory, that sets the context for the views and the api.py file

I went for the config_api directory but keeping the api.py. Tried a few things and it went weird. I did move the _get_* methods to a different internal.py module.

ashultz0 · 2023-07-26T20:10:20Z

ai_aside/api/api.py

+
+
+def get_course_settings(course_key):
+    "Gets the settings of a course"


since the get and set are using key/value dicts, you should describe the expected dicts in the docstring

ashultz0 · 2023-07-26T20:10:53Z

ai_aside/api/api.py

+    if not isinstance(enabled, bool):
+        raise TypeError
+
+    update = {'enabled': enabled}


isn't this just settings?

ashultz0 · 2023-07-26T20:11:47Z

ai_aside/api/api.py

+        defaults=update,
+    )
+
+    return True


this return value doesn't really mean anything so don't bother to return anything

ashultz0 · 2023-07-26T20:12:08Z

ai_aside/api/api.py

+    if not isinstance(enabled, bool):
+        raise TypeError
+
+    update = {'enabled': enabled}


same as in course

ashultz0 · 2023-07-26T20:12:17Z

ai_aside/api/api.py

+        defaults=update,
+    )
+
+    return True


meaningless return

a common thing you could do instead is to return the same thing the GET would - so in this case the settings dict again - but that's still pretty meaningless. In the future case where you are updating only some settings it would be more useful to return the complete settings dict incorporating changes afterwards, but we only have the one

ashultz0 · 2023-07-26T20:14:58Z

ai_aside/api/api.py

+    if course is not None:
+        return course.enabled
+
+    return False


we need one more function in the API (and views) that just exposes summaries_configuration_enabled(course_key), since neither the course level or unit level settings should appear if that is not on

added this to the PR to unblock David while Marcos is out sick so this should be all set

ashultz0 · 2023-07-26T20:26:04Z

ai_aside/block.py

-        return summary_enabled(course_key)
+
+        if not ff_summary_enabled(course_key):
+            return False


this clause should only trigger if the new flag is not on - we'll be retiring this old flag and replacing this with configuration, so it will start to be off everywhere. You could move this check into is_summary_enabled, something like:

if summary config waffle is enabled for this course: check the config otherwise if the old flag is enabled for this course: return true return false

requirements.txt

ashultz0

👍 after cleaning out the stray requirements.txt file

ashultz0

actually I missed one needed logic change

ashultz0 · 2023-07-28T15:20:47Z

ai_aside/config_api/api.py

+
+    # If the feature flag is disabled, do not restrict
+    if not summaries_configuration_enabled(course_key):
+        return True


I think this should be false

this function is only for use when using the config settings

if you're not allowed to use the config settings, you shouldn't be here and shouldn't be allowed to do anything

I agree. It was returning True just to keep the current logic for the blocks to be enabled by default. Now that the should_apply_to_block is using it only when the waffle flag is enabled, any other uses of the method make sense to return False if the flag is disabled. Updated.

ashultz0

one comment to fix before merge but then good to go

ashultz0 · 2023-07-28T16:11:28Z

ai_aside/config_api/api.py

+    It considers both the state of a unit's override and a course defaults.
+    """
+
+    # If the feature flag is disabled, do not restrict


the code is updated but he comment isn't

- Added endpoint exposing is this course allowed to configure summaries - Added tests for new endpoint - Added more tests while introcucing the DDT library Co-authored-by: Andy Shultz <ashultz@edx.org>

[https://jira.2u.com/browse/ACADEMIC-16209](https://jira.2u.com/browse/ACADEMIC-16209) 1. Add unit xpert unit summaries settings behind flag `summaryhook_summaries_configuration` added [here](https://github.com/edx/ai-aside/pull/45/files) 2. Only show the checkbox when the value is a `boolean` otherwise the feature is considerer `disabled` by the flag. 3. Update block handler to update this value via `api` exposed [here](edx/ai-aside#43) 4. Create `AiAsideSummary` configuration class to provide access to the `ai_aside.api` endpoints.

* feat: [ACADEMIC-16209] Unit summary settings [https://jira.2u.com/browse/ACADEMIC-16209](https://jira.2u.com/browse/ACADEMIC-16209) 1. Add unit xpert unit summaries settings behind flag `summaryhook_summaries_configuration` added [here](https://github.com/edx/ai-aside/pull/45/files) 2. Only show the checkbox when the value is a `boolean` otherwise the feature is considerer `disabled` by the flag. 3. Update block handler to update this value via `api` exposed [here](edx/ai-aside#43) 4. Create `AiAsideSummary` configuration class to provide access to the `ai_aside.api` endpoints.

rijuma added the WIP Work in Progress label Jul 25, 2023

rijuma force-pushed the rijuma/16210-separate-logic-into-api-layer branch 6 times, most recently from 530a338 to bc9a3b7 Compare July 26, 2023 17:57

rijuma changed the title ~~[ACADEMIC-16210] (WIP)~~ [ACADEMIC-16210] Moved API logic to api module and added check Jul 26, 2023

rijuma removed the WIP Work in Progress label Jul 26, 2023

rijuma force-pushed the rijuma/16210-separate-logic-into-api-layer branch 2 times, most recently from b1dd198 to 25bcaaa Compare July 26, 2023 19:51

rijuma marked this pull request as ready for review July 26, 2023 19:51

rijuma force-pushed the rijuma/16210-separate-logic-into-api-layer branch from 25bcaaa to 4ddf700 Compare July 26, 2023 20:01

ashultz0 suggested changes Jul 26, 2023

View reviewed changes

ashultz0 reviewed Jul 26, 2023

View reviewed changes

ashultz0 force-pushed the rijuma/16210-separate-logic-into-api-layer branch 3 times, most recently from 8f4a209 to dc198b6 Compare July 27, 2023 17:22

rijuma force-pushed the rijuma/16210-separate-logic-into-api-layer branch from 2d40b17 to 4c188ce Compare July 28, 2023 15:16

ashultz0 reviewed Jul 28, 2023

View reviewed changes

requirements.txt Outdated Show resolved Hide resolved

ashultz0 approved these changes Jul 28, 2023

View reviewed changes

ashultz0 suggested changes Jul 28, 2023

View reviewed changes

rijuma force-pushed the rijuma/16210-separate-logic-into-api-layer branch 4 times, most recently from dfcf614 to 873129b Compare July 28, 2023 16:05

ashultz0 approved these changes Jul 28, 2023

View reviewed changes

feat: ACADEMIC-16210: Created a module for API methods

3d113d2

- Added endpoint exposing is this course allowed to configure summaries - Added tests for new endpoint - Added more tests while introcucing the DDT library Co-authored-by: Andy Shultz <ashultz@edx.org>

rijuma force-pushed the rijuma/16210-separate-logic-into-api-layer branch from 873129b to 3d113d2 Compare July 28, 2023 17:36

rijuma merged commit a110d86 into main Jul 28, 2023
4 checks passed

rijuma deleted the rijuma/16210-separate-logic-into-api-layer branch July 28, 2023 17:37

germanolleunlp mentioned this pull request Jul 31, 2023

feat: [ACADEMIC-16209] Unit summary settings openedx/edx-platform#32855

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ACADEMIC-16210] Moved API logic to api module and added check #43

[ACADEMIC-16210] Moved API logic to api module and added check #43

rijuma commented Jul 25, 2023 •

edited

Loading

ashultz0 left a comment

ashultz0 Jul 26, 2023

rijuma Jul 28, 2023

ashultz0 Jul 26, 2023

ashultz0 Jul 26, 2023

ashultz0 Jul 26, 2023

ashultz0 Jul 26, 2023

ashultz0 Jul 26, 2023

ashultz0 Jul 26, 2023

ashultz0 Jul 27, 2023

ashultz0 Jul 26, 2023 •

edited

Loading

ashultz0 left a comment

ashultz0 left a comment

ashultz0 Jul 28, 2023

rijuma Jul 28, 2023 •

edited

Loading

ashultz0 left a comment

ashultz0 Jul 28, 2023



		def get_course_settings(course_key):
		"Gets the settings of a course"

[ACADEMIC-16210] Moved API logic to api module and added check #43

[ACADEMIC-16210] Moved API logic to api module and added check #43

Conversation

rijuma commented Jul 25, 2023 • edited Loading

ashultz0 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

ashultz0 Jul 26, 2023 • edited Loading

Choose a reason for hiding this comment

ashultz0 left a comment

Choose a reason for hiding this comment

ashultz0 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rijuma Jul 28, 2023 • edited Loading

Choose a reason for hiding this comment

ashultz0 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rijuma commented Jul 25, 2023 •

edited

Loading

ashultz0 Jul 26, 2023 •

edited

Loading

rijuma Jul 28, 2023 •

edited

Loading