Revert "Department REST API (#1877)"

This reverts commit f49e9c6.
mitodl · Sep 12, 2023 · 912072c · 912072c
1 parent 94fbd3d
commit 912072c
Show file tree

Hide file tree

Showing 6 changed files with 71 additions and 216 deletions.
diff --git a/courses/serializers.py b/courses/serializers.py
@@ -157,20 +157,6 @@ class Meta:
         fields = ["name"]
 
 
-class DepartmentWithCountSerializer(DepartmentSerializer):
-    """CourseRun model serializer that includes the number of courses and programs associated with each departments"""
-
-    courses = serializers.IntegerField()
-    programs = serializers.IntegerField()
-
-    class Meta:
-        model = models.Department
-        fields = DepartmentSerializer.Meta.fields + [
-            "courses",
-            "programs",
-        ]
-
-
 class CourseSerializer(BaseCourseSerializer):
     """Course model serializer"""
 

diff --git a/courses/urls.py b/courses/urls.py
@@ -19,7 +19,6 @@
     v1.UserProgramEnrollmentsViewSet,
     basename="user_program_enrollments_api",
 )
-router.register(r"departments", v1.DepartmentViewSet, basename="departments_api")
 
 urlpatterns = [
     re_path(r"^api/v1/", include(router.urls)),

diff --git a/courses/views/v1/__init__.py b/courses/views/v1/__init__.py
@@ -5,7 +5,7 @@
 from django.contrib.auth.models import User
 from django.contrib.contenttypes.models import ContentType
 from django.db import transaction
-from django.db.models import Q, Count
+from django.db.models import Q
 from django.http import HttpResponse, HttpResponseRedirect
 from django.urls import reverse
 from django_filters.rest_framework import DjangoFilterBackend
@@ -33,7 +33,6 @@
     PartnerSchool,
     Program,
     ProgramEnrollment,
-    Department,
 )
 from courses.serializers import (
     CourseRunEnrollmentSerializer,
@@ -43,7 +42,6 @@
     ProgramSerializer,
     UserProgramEnrollmentDetailSerializer,
     CourseWithCourseRunsSerializer,
-    DepartmentWithCountSerializer,
 )
 from courses.tasks import send_partner_school_email
 from courses.utils import get_program_certificate_by_enrollment
@@ -509,15 +507,3 @@ def get_learner_record_from_uuid(request, uuid):
             record.program, context={"user": record.user, "anonymous_pull": True}
         ).data
     )
-
-
-@permission_classes([])
-class DepartmentViewSet(viewsets.ReadOnlyModelViewSet):
-    """API view set for Departments"""
-
-    serializer_class = DepartmentWithCountSerializer
-
-    def get_queryset(self):
-        return Department.objects.annotate(
-            courses=Count("course"), programs=Count("program")
-        )
diff --git a/frontend/public/src/containers/pages/CatalogPage.js b/frontend/public/src/containers/pages/CatalogPage.js
@@ -17,12 +17,6 @@ import {
   programsQueryKey
 } from "../../lib/queries/programs"
 
-import {
-  departmentsSelector,
-  departmentsQuery,
-  departmentsQueryKey
-} from "../../lib/queries/departments"
-
 import { createStructuredSelector } from "reselect"
 import { compose } from "redux"
 import { connect } from "react-redux"
@@ -56,8 +50,7 @@ export class CatalogPage extends React.Component<Props> {
     filteredCourses:            [],
     filteredPrograms:           [],
     filterCoursesCalled:        false,
-    filteredDepartments:        [],
-    filterDepartmentsCalled:    false,
+    departments:                [],
     selectedDepartment:         ALL_DEPARTMENTS,
     mobileFilterWindowExpanded: false,
     items_per_row:              3,
@@ -161,11 +154,9 @@ export class CatalogPage extends React.Component<Props> {
   }
 
   /**
-   * Updates the filteredCourses state variable
-   * once coursesIsLoading is false..  Adds an observer to detect when
+   * Updates the filteredCourses and courseDepartments state variables
+   * once coursesIsLoading is False.  Adds an observer to detect when
    * the learner has scrolled to the bottom of the visible catalog items.
-   * Updates the filteredDepartments state variable once departmentsIsLoading
-   * is false.
    */
   componentDidUpdate = () => {
     const { courses, coursesIsLoading } = this.props
@@ -177,6 +168,9 @@ export class CatalogPage extends React.Component<Props> {
         courses
       )
       this.setState({ filteredCourses: filteredCourses })
+      this.setState({
+        departments: this.collectDepartmentsFromCatalogItems(filteredCourses)
+      })
 
       // Detect when the bottom of the catalog page has been reached and display more catalog items.
       this.io = new window.IntersectionObserver(
@@ -185,54 +179,30 @@ export class CatalogPage extends React.Component<Props> {
       )
       this.io.observe(this.container.current)
     }
-
-    if (
-      !this.props.departmentsIsLoading &&
-      !this.state.filterDepartmentsCalled
-    ) {
-      this.setState({ filterDepartmentsCalled: true })
-      this.setState({
-        filteredDepartments: this.filterDepartmentsByTabName(
-          this.state.tabSelected
-        )
-      })
-    }
   }
 
   /**
-   * Returns an array of departments names which have one or more course(s) or program(s)
-   * related to them depending on the currently selected tab.
-   * @param {string} selectedTabName the name of the currently selected tab.
+   * Returns an array of unique Department names that are associated with the Courses or Programs in the
+   * parameter and also includes an entry for "All Departments".
+   * @param {Array<CourseDetailWithRuns | Program>} catalogItems Array of Courses or Programs to collect Department names from.
    */
-  filterDepartmentsByTabName(selectedTabName: string) {
-    if (!this.props.departmentsIsLoading) {
-      const { departments } = this.props
-      if (selectedTabName === COURSES_TAB) {
-        return [
-          ...new Set([
-            ALL_DEPARTMENTS,
-            ...departments.flatMap(department =>
-              department.courses > 0 ? department.name : []
-            )
-          ])
-        ]
-      } else {
-        return [
-          ...new Set([
-            ALL_DEPARTMENTS,
-            ...departments.flatMap(department =>
-              department.programs > 0 ? department.name : []
-            )
-          ])
-        ]
-      }
-    }
+  collectDepartmentsFromCatalogItems(
+    catalogItems: Array<CourseDetailWithRuns | Program>
+  ) {
+    const departments = Array.from(catalogItems, item => item.departments)
+    return [
+      ...new Set([
+        ALL_DEPARTMENTS,
+        ...departments.flat().map(department => department.name)
+      ])
+    ]
   }
 
   /**
    * Updates this.state.selectedDepartment to {ALL_DEPARTMENTS},
    * updates this.state.tabSelected to the parameter,
-   * updates this.state.filteredDepartments
+   * updates this.state.numberCatalogRowsToDisplay to {DEFAULT_MIN_CATALOG_ROWS_RENDERED},
+   * updates this.state.departments to equal the unique department
    * names from the catalog items in the selected tab,
    * updates this.state.filteredPrograms to equal the programs
    * which meet the criteria to be displayed in the catalog.
@@ -242,7 +212,16 @@ export class CatalogPage extends React.Component<Props> {
     this.setState({ tabSelected: selectTabName })
     this.changeSelectedDepartment(ALL_DEPARTMENTS, selectTabName)
 
-    if (selectTabName === PROGRAMS_TAB) {
+    if (selectTabName === COURSES_TAB) {
+      const { coursesIsLoading } = this.props
+      if (!coursesIsLoading) {
+        this.setState({
+          departments: this.collectDepartmentsFromCatalogItems(
+            this.state.allCoursesRetrieved
+          )
+        })
+      }
+    } else {
       const { programs, programsIsLoading } = this.props
       if (!programsIsLoading) {
         const programsToFilter = []
@@ -262,11 +241,11 @@ export class CatalogPage extends React.Component<Props> {
         this.setState({
           filteredPrograms: filteredPrograms
         })
+        this.setState({
+          departments: this.collectDepartmentsFromCatalogItems(programsToFilter)
+        })
       }
     }
-    this.setState({
-      filteredDepartments: this.filterDepartmentsByTabName(selectTabName)
-    })
   }
 
   /**
@@ -525,7 +504,7 @@ export class CatalogPage extends React.Component<Props> {
    */
   renderDepartmentSideBarList() {
     const departmentSideBarListItems = []
-    this.state.filteredDepartments.forEach(department =>
+    this.state.departments.forEach(department =>
       departmentSideBarListItems.push(
         <li
           className={`sidebar-link ${
@@ -685,30 +664,20 @@ const getNextProgramPage = page =>
     force: true
   })
 
-const mapPropsToConfig = () => [
-  coursesQuery(1),
-  programsQuery(1),
-  departmentsQuery()
-]
+const mapPropsToConfig = () => [coursesQuery(1), programsQuery(1)]
 
 const mapDispatchToProps = {
   getNextCoursePage:  getNextCoursePage,
   getNextProgramPage: getNextProgramPage
 }
 
 const mapStateToProps = createStructuredSelector({
-  courses:              coursesSelector,
-  coursesNextPage:      coursesNextPageSelector,
-  programs:             programsSelector,
-  programsNextPage:     programsNextPageSelector,
-  departments:          departmentsSelector,
-  coursesIsLoading:     pathOr(true, ["queries", coursesQueryKey, "isPending"]),
-  programsIsLoading:    pathOr(true, ["queries", programsQueryKey, "isPending"]),
-  departmentsIsLoading: pathOr(true, [
-    "queries",
-    departmentsQueryKey,
-    "isPending"
-  ])
+  courses:           coursesSelector,
+  coursesNextPage:   coursesNextPageSelector,
+  programs:          programsSelector,
+  programsNextPage:  programsNextPageSelector,
+  coursesIsLoading:  pathOr(true, ["queries", coursesQueryKey, "isPending"]),
+  programsIsLoading: pathOr(true, ["queries", programsQueryKey, "isPending"])
 })
 
 export default compose(