feat: adds openedx-filter hook to the course enrollments site #31331

JuanDavidBuitrago · 2022-11-23T04:39:03Z

Description

This PR introduces a new openedx-filters event org.openedx.learning.course_enrollment_queryset.requested.v1. This is implemented to guaranty multi tenancy in eox-tenant in course enrollments request, but eox-tenant is only an example would consider use.

Impact by the change on GET request:

http://{lms_custom_site}/api/enrollment/v1/enrollment
http://{lms_custom_site}/api/mobile/v1/users/{username}/course_enrollments/

Supporting information

There are not openedx related tickets. The related PR are:

Testing instructions

The change can be tested with testing instructions in eox-tenant plugin.

Deadline

"None"

Other information

Warning: Once accepted this PR, it has to be merged only after openedx/openedx-filters#47 is merged and the requirements in this PR are updated.

Settings

EDXAPP_EXTRA_REQUIREMENTS:
  - name: git+https://github.com/eduNEXT/eox-tenant.git@v3.6.0

openedx-webhooks · 2022-11-23T04:39:08Z

Thanks for the pull request, @JuanDavidBuitrago! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

supporting documentation
Open edX discussion forum threads
timeline information ("this must be merged by XX date", and why that is)
partner information ("this is a course on edx.org")
any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

This is currently a draft pull request. When it is ready for our review and all tests are green, click "Ready for Review", or remove "WIP" from the title, as appropriate.

JuanDavidBuitrago · 2022-11-25T13:21:58Z

Hi @mariajgrimaldi and @felipemontoya, could you help me review this?

mphilbrick211 · 2022-12-16T20:52:18Z

Hi @JuanDavidBuitrago! Just checking in on this. Are you planning to pursue this pull request? It looks like some failing tests need to be re-run.

JuanDavidBuitrago · 2022-12-16T21:17:53Z

Hi @JuanDavidBuitrago! Just checking in on this. Are you planning to pursue this pull request? It looks like some failing tests need to be re-run.

Hi @mphilbrick211! Yes, I'm planning to pursue this. I just need to make changes in openedx/openedx-filters#47 to update some requirements and solve tests in this PR.

lms/djangoapps/mobile_api/users/views.py

openedx/core/djangoapps/enrollments/data.py

mphilbrick211 · 2023-01-10T17:36:06Z

Hi @JuanDavidBuitrago! Just checking in on this. Are you planning to pursue this pull request? It looks like some failing tests need to be re-run.

Hi @mphilbrick211! Yes, I'm planning to pursue this. I just need to make changes in openedx/openedx-filters#47 to update some requirements and solve tests in this PR.

Hi @JuanDavidBuitrago! Just checking in on this!

mariajgrimaldi · 2023-01-18T15:02:20Z

lms/djangoapps/mobile_api/users/views.py

+        try:
+            ## .. filter_implemented_name: CourseEnrollmentQuerysetRequested
+            ## .. filter_type: org.openedx.learning.course_enrollment_queryset.requested.v1
+            enrollments = CourseEnrollmentQuerysetRequested.run_filter(enrollments=enrollments)
+        except CourseEnrollmentQuerysetRequested.PreventEnrollmentQuerysetRequest as exc:
+            raise EnrollmentRequestNotAllowed(str(exc)) from exc


Remember to add tests for this implementation. You could use these tests as guidance.

Can you add a test testing this line?

^ I second this comment again

mphilbrick211 · 2023-02-07T20:20:29Z

Hi @JuanDavidBuitrago - just checking in to see if you have an update?

JuanDavidBuitrago · 2023-02-21T19:21:46Z

Hi @mphilbrick211 and @mariajgrimaldi

I need to do some tests with everything integrated to verify that everything continues to work well, I need a little more time.

common/djangoapps/student/tests/test_filters.py

JuanDavidBuitrago · 2023-03-07T13:17:41Z

Hi, we are studying where else we should add the filter to make it as complete as possible

mariajgrimaldi · 2023-03-13T17:01:18Z

Addressing @JuanDavidBuitrago comment:

IMO, we have two options for this implementation:

Use the filter in the CourseEnrollment model manager (example), so every time the course enrollments' queryset is requested, the filter is executed. Now, we'll have to keep in mind that this approach might be too aggressive (overriding the models' manager). All operations related to the course enrollment queryset will pass through the filter. Even though the filter acts as a noop when not configured, it executes a piece of code before returning. So a delay will be added to the operation.
Identify relevant places where the enrollment queryset is used so we can apply the filter -as you're currently doing-. I say relevant since I don't think covering all cases is possible.

I like option one, I'm just hesitant about how aggressive it is and how much it affects the whole service. It's not just getting the queryset when making an API call, it's related to all the models queries. Option two is good as well, but we must clarify the cases we cover.

I'd like to know what you both think, including @felipemontoya.

JuanDavidBuitrago · 2023-03-14T13:13:14Z

At the moment, we only have included the use of the filter when we make a request with a user without staff permissions.
http://{lms_custom_site}/api/enrollment/v1/enrollment from desktop and http://{lms_custom_site}/api/mobile/v1/users/{username}/course_enrollments from mobile

@mariajgrimaldi have you identified another connection point?

mariajgrimaldi · 2023-03-14T15:44:35Z

@JuanDavidBuitrago: there are many places where this could go.
/api/enrollment/v1/enrollment -> for browsers
/api/enrollment/v1/enrollments -> for browsers
/api/mobile/v1/users/{username}/course_enrollments -> mobile
... and so on. There's also the implementation detail I mentioned above. What do you think about that? I'm okay If this is the implementation we're going for, but let me know.

JuanDavidBuitrago · 2023-03-14T18:05:59Z

With option two that you put above, I think we can cover what is necessary to obtain the course enrollments that we want, we have already tested it in the edx-platform fork that we manage eduNEXT/edunext-platform#696
I'm not sure if we can cover other cases without problems. @felipemontoya's opinion here would be very useful

mphilbrick211 · 2023-04-04T01:30:38Z

Hi @JuanDavidBuitrago - just following up on this :)

CC: @mariajgrimaldi & @felipemontoya

mphilbrick211 · 2023-04-24T23:46:11Z

Hi @JuanDavidBuitrago! Looks like some tests are failing and need to be re-run.

mariajgrimaldi · 2023-09-05T13:31:12Z

common/djangoapps/student/tests/test_filters.py

+        Test filter enrollment queryset when a request is made.
+
+        Expected result:
+            - CourseEnrollmentQuerysetRequested is triggered and executes TestCourseEnrollmentsPipelineStep.
+            - The result is a list of course enrollments queryset filter by org
+        """
+        enrollments = get_course_enrollments(self.user)
+
+        self.assertListEqual(self.enrollment, enrollments)


This is not true, is it? This tests that when the filter is not turned on, then the filtering doesn't occur. Or am I missing something?

mariajgrimaldi · 2023-09-05T13:31:58Z

common/djangoapps/student/tests/test_filters.py

+        self.assertEqual(expected_enrollment, enrollments)
+        self.assertAlmostEqual(len(enrollments), len(expected_enrollment), 1)


Please, check that all the courses associated with the enrollment have the demo org

mariajgrimaldi · 2023-09-05T13:32:46Z

lms/djangoapps/mobile_api/users/test_filter.py

+        Expected result:
+            - CourseEnrollmentQuerysetRequested is triggered and executes TestCourseEnrollmentsPipelineStep.
+            - The result is a list of course enrollments queryset filter by org


You'll need to update the docstring here too.

mariajgrimaldi · 2023-09-05T13:33:28Z

lms/djangoapps/mobile_api/users/test_filter.py

+        view.request = self.mock_request
+        enrollments = view.get_queryset()
+
+        self.assertEqual(self.enrollment, enrollments)


can we check that both orgs demo and test are included here?

mariajgrimaldi · 2023-09-05T13:34:05Z

lms/djangoapps/mobile_api/users/test_filter.py

+        enrollments = view.get_queryset()
+
+        self.assertAlmostEqual(len(enrollments), len(expected_enrollment), 1)
+        self.assertEqual(expected_enrollment.course.org, "helo")


Not sure what's this. Isn't the org supposed to be demo?

mariajgrimaldi · 2023-09-05T13:35:11Z

I left a few more comments. Also, can we make the tests pass?

mariajgrimaldi · 2023-09-07T14:43:49Z

@mphilbrick211: I spoke internally with @JuanDavidBuitrago's team, and they told me they didn't have the capacity to take this on right now. I'll move this PR to draft to give them time to work on it. Thanks!

JuanDavidBuitrago · 2023-09-07T15:20:32Z

Hi @mphilbrick211 @mariajgrimaldi, thank you for your patience.

mphilbrick211 · 2024-02-21T15:57:08Z

Closing this for now. We can reopen in the future if needed. Thanks!

openedx-webhooks · 2024-02-21T15:57:11Z

@JuanDavidBuitrago Even though your pull request wasn’t merged, please take a moment to answer a two question survey so we can improve your experience in the future.

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 23, 2022

JuanDavidBuitrago mentioned this pull request Nov 23, 2022

feat: adds the CourseEnrollmentSiteFilterRequested filter openedx/openedx-filters#47

Merged

10 tasks

JuanDavidBuitrago marked this pull request as ready for review November 23, 2022 21:18

mphilbrick211 added the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Dec 16, 2022

openedx-webhooks removed the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Dec 20, 2022

mariajgrimaldi reviewed Jan 3, 2023

View reviewed changes

lms/djangoapps/mobile_api/users/views.py Outdated Show resolved Hide resolved

mariajgrimaldi reviewed Jan 3, 2023

View reviewed changes

openedx/core/djangoapps/enrollments/data.py Outdated Show resolved Hide resolved

JuanDavidBuitrago requested a review from mariajgrimaldi January 6, 2023 00:12

mariajgrimaldi reviewed Jan 18, 2023

View reviewed changes

mphilbrick211 added the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Jan 23, 2023

JuanDavidBuitrago force-pushed the JDB/add_filter_hook_to_enrollment_site branch 2 times, most recently from 056638c to 14c4df2 Compare March 2, 2023 10:07

JuanDavidBuitrago mentioned this pull request Mar 2, 2023

refactor: use CourseEnrollmentQuerysetRequested from openedx-filters eduNEXT/eox-tenant#159

Merged

mariajgrimaldi reviewed Mar 2, 2023

View reviewed changes

common/djangoapps/student/tests/test_filters.py Outdated Show resolved Hide resolved

JuanDavidBuitrago force-pushed the JDB/add_filter_hook_to_enrollment_site branch from de032b6 to 54866f8 Compare March 3, 2023 04:23

mphilbrick211 removed the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Mar 15, 2023

JuanDavidBuitrago force-pushed the JDB/add_filter_hook_to_enrollment_site branch 6 times, most recently from 7477128 to 14df646 Compare August 10, 2023 16:42

test: add test for mobile app view

11e386d

JuanDavidBuitrago force-pushed the JDB/add_filter_hook_to_enrollment_site branch from 14df646 to 11e386d Compare August 10, 2023 17:17

JuanDavidBuitrago force-pushed the JDB/add_filter_hook_to_enrollment_site branch 4 times, most recently from dd5deb0 to c470e52 Compare August 28, 2023 02:36

test: add test for mobile app view

c0c68c8

JuanDavidBuitrago force-pushed the JDB/add_filter_hook_to_enrollment_site branch from c470e52 to c0c68c8 Compare August 28, 2023 03:03

mphilbrick211 requested a review from mariajgrimaldi August 28, 2023 17:37

mariajgrimaldi reviewed Sep 5, 2023

View reviewed changes

mariajgrimaldi marked this pull request as draft September 7, 2023 14:43

mphilbrick211 removed the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Oct 24, 2023

mphilbrick211 closed this Feb 21, 2024

mphilbrick211 added the closed inactivity PR was closed because the author abandoned it label Feb 21, 2024

DonatoBD mentioned this pull request Oct 21, 2024

[DEPR] FFI-3 (Course Enrollment by Tenant) feature eduNEXT/eox-tenant#218

Open

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: adds openedx-filter hook to the course enrollments site #31331

feat: adds openedx-filter hook to the course enrollments site #31331

JuanDavidBuitrago commented Nov 23, 2022 •

edited

Loading

openedx-webhooks commented Nov 23, 2022 •

edited

Loading

JuanDavidBuitrago commented Nov 25, 2022

mphilbrick211 commented Dec 16, 2022

JuanDavidBuitrago commented Dec 16, 2022

mphilbrick211 commented Jan 10, 2023

mariajgrimaldi Jan 18, 2023

mariajgrimaldi May 25, 2023

mariajgrimaldi Sep 5, 2023

mphilbrick211 commented Feb 7, 2023

JuanDavidBuitrago commented Feb 21, 2023

JuanDavidBuitrago commented Mar 7, 2023

mariajgrimaldi commented Mar 13, 2023 •

edited

Loading

JuanDavidBuitrago commented Mar 14, 2023

mariajgrimaldi commented Mar 14, 2023

JuanDavidBuitrago commented Mar 14, 2023

mphilbrick211 commented Apr 4, 2023

mphilbrick211 commented Apr 24, 2023

mariajgrimaldi Sep 5, 2023

mariajgrimaldi Sep 5, 2023

mariajgrimaldi Sep 5, 2023

mariajgrimaldi Sep 5, 2023

mariajgrimaldi Sep 5, 2023

mariajgrimaldi commented Sep 5, 2023

mariajgrimaldi commented Sep 7, 2023

JuanDavidBuitrago commented Sep 7, 2023

mphilbrick211 commented Feb 21, 2024

openedx-webhooks commented Feb 21, 2024

		self.assertEqual(expected_enrollment, enrollments)
		self.assertAlmostEqual(len(enrollments), len(expected_enrollment), 1)

feat: adds openedx-filter hook to the course enrollments site #31331

feat: adds openedx-filter hook to the course enrollments site #31331

Conversation

JuanDavidBuitrago commented Nov 23, 2022 • edited Loading

Description

Supporting information

Testing instructions

Deadline

Other information

Settings

openedx-webhooks commented Nov 23, 2022 • edited Loading

JuanDavidBuitrago commented Nov 25, 2022

mphilbrick211 commented Dec 16, 2022

JuanDavidBuitrago commented Dec 16, 2022

mphilbrick211 commented Jan 10, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mphilbrick211 commented Feb 7, 2023

JuanDavidBuitrago commented Feb 21, 2023

JuanDavidBuitrago commented Mar 7, 2023

mariajgrimaldi commented Mar 13, 2023 • edited Loading

JuanDavidBuitrago commented Mar 14, 2023

mariajgrimaldi commented Mar 14, 2023

JuanDavidBuitrago commented Mar 14, 2023

mphilbrick211 commented Apr 4, 2023

mphilbrick211 commented Apr 24, 2023

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

mariajgrimaldi commented Sep 5, 2023

mariajgrimaldi commented Sep 7, 2023

JuanDavidBuitrago commented Sep 7, 2023

mphilbrick211 commented Feb 21, 2024

openedx-webhooks commented Feb 21, 2024

JuanDavidBuitrago commented Nov 23, 2022 •

edited

Loading

openedx-webhooks commented Nov 23, 2022 •

edited

Loading

mariajgrimaldi commented Mar 13, 2023 •

edited

Loading