CSCEXAM-1195 Change some dropdowns to typeaheads with reservation sea…

…rchy - also refactor the admin/teacher reservation components into one
CSCfi · Nov 17, 2023 · f9f6c64 · f9f6c64
1 parent a88753d
commit f9f6c64
Show file tree

Hide file tree

Showing 16 changed files with 335 additions and 355 deletions.
diff --git a/app/controllers/ReservationController.java b/app/controllers/ReservationController.java
@@ -71,7 +71,7 @@ public class ReservationController extends BaseController {
 
     @Authenticated
     @Restrict({ @Group("ADMIN"), @Group("TEACHER") })
-    public Result getExams(Http.Request request) {
+    public Result getExams(Http.Request request, Optional<String> filter) {
         User user = request.attrs().get(Attrs.AUTHENTICATED_USER);
         PathProperties props = PathProperties.parse("(id, name)");
         Query<Exam> q = DB.createQuery(Exam.class);
@@ -80,6 +80,9 @@ public Result getExams(Http.Request request) {
             .where()
             .isNull("parent") // only Exam prototypes
             .eq("state", Exam.State.PUBLISHED);
+        if (filter.isPresent()) {
+            el = el.ilike("name", String.format("%%%s%%", filter.get()));
+        }
         if (user.hasRole(Role.Name.TEACHER)) {
             el =
                 el
@@ -91,7 +94,8 @@ public Result getExams(Http.Request request) {
                     .eq("shared", true)
                     .endJunction();
         }
-        return ok(el.findList(), props);
+        List<Exam> exams = el.findList();
+        return ok(exams, props);
     }
 
     @Restrict({ @Group("ADMIN") })
@@ -119,15 +123,23 @@ private ArrayNode asJson(List<User> users) {
     }
 
     @Restrict({ @Group("ADMIN"), @Group("TEACHER") })
-    public Result getStudents() {
-        List<User> students = DB.find(User.class).where().eq("roles.name", "STUDENT").findList();
+    public Result getStudents(Optional<String> filter) {
+        ExpressionList<User> el = DB.find(User.class).where().eq("roles.name", "STUDENT");
+        if (filter.isPresent()) {
+            el = el.or().ilike("userIdentifier", String.format("%%%s%%", filter.get()));
+            el = applyUserFilter(null, el, filter.get()).endOr();
+        }
+        List<User> students = el.findList();
         return ok(Json.toJson(asJson(students)));
     }
 
     @Restrict({ @Group("ADMIN") })
-    public Result getTeachers() {
-        List<User> teachers = DB.find(User.class).where().eq("roles.name", "TEACHER").findList();
-
+    public Result getTeachers(Optional<String> filter) {
+        ExpressionList<User> el = DB.find(User.class).where().eq("roles.name", "TEACHER");
+        if (filter.isPresent()) {
+            el = applyUserFilter(null, el.or(), filter.get()).endOr();
+        }
+        List<User> teachers = el.findList();
         return ok(Json.toJson(asJson(teachers)));
     }
 
@@ -155,7 +167,7 @@ public CompletionStage<Result> removeReservation(long id, Http.Request request)
         }
 
         Reservation reservation = enrolment.getReservation();
-        // Lets not send emails about historical reservations
+        // Let's not send emails about historical reservations
         if (reservation.getEndAt().isAfter(DateTime.now())) {
             User student = enrolment.getUser();
             emailComposer.composeReservationCancellationNotification(student, reservation, msg, false, enrolment);

diff --git a/app/controllers/base/BaseController.java b/app/controllers/base/BaseController.java
@@ -95,7 +95,7 @@ protected <T> ExpressionList<T> applyUserFilter(String prefix, ExpressionList<T>
         String fnField = prefix == null ? "firstName" : String.format("%s.firstName", prefix);
         String lnField = prefix == null ? "lastName" : String.format("%s.lastName", prefix);
         if (rawFilter.contains(" ")) {
-            // Possible that user provided us two names. Lets try out some combinations of first and last names
+            // Possible that user provided us two names. Let's try out some combinations of first and last names
             String name1 = rawFilter.split(" ")[0];
             String name2 = rawFilter.split(" ")[1];
             result =

diff --git a/app/controllers/iop/collaboration/impl/CollaborationController.java b/app/controllers/iop/collaboration/impl/CollaborationController.java
@@ -13,6 +13,8 @@
 import java.net.MalformedURLException;
 import java.net.URI;
 import java.net.URL;
+import java.net.URLEncoder;
+import java.nio.charset.StandardCharsets;
 import java.util.Arrays;
 import java.util.Map;
 import java.util.Optional;
@@ -71,10 +73,13 @@ Optional<URL> parseUrlWithSearchParam(String filter, boolean anonymous) {
             if (filter == null) {
                 return Optional.empty();
             }
-
-            String paramStr = String.format("?filter=%s&anonymous=%s", filter, anonymous);
-            String url = String.format("%s/api/exams/search%s", configReader.getIopHost(), paramStr);
-            return Optional.of(URI.create(url).toURL());
+            String paramStr = String.format(
+                "filter=%s&anonymous=%s",
+                URLEncoder.encode(filter, StandardCharsets.UTF_8),
+                anonymous
+            );
+            URI uri = URI.create(String.format("%s/api/exams/search?%s", configReader.getIopHost(), paramStr));
+            return Optional.of(uri.toURL());
         } catch (MalformedURLException e) {
             logger.error("Malformed URL", e);
             return Optional.empty();

diff --git a/conf/routes b/conf/routes
@@ -221,10 +221,10 @@ GET           /app/accessibility                                       controlle
 
 GET           /app/draft/rooms                                         controllers.RoomController.createExamRoomDraft
 
-GET           /app/reservations/students                               controllers.ReservationController.getStudents
-GET           /app/reservations/teachers                               controllers.ReservationController.getTeachers
+GET           /app/reservations/students                               controllers.ReservationController.getStudents(filter: java.util.Optional[String])
+GET           /app/reservations/teachers                               controllers.ReservationController.getTeachers(filter: java.util.Optional[String])
 GET           /app/reservations/examrooms                              controllers.ReservationController.getExamRooms
-GET           /app/reservations/exams                                  controllers.ReservationController.getExams(request: Request)
+GET           /app/reservations/exams                                  controllers.ReservationController.getExams(request: Request, filter: java.util.Optional[String])
 GET           /app/reservations                                        controllers.ReservationController.getReservations(state: java.util.Optional[String], ownerId: java.util.Optional[java.lang.Long], studentId: java.util.Optional[java.lang.Long], roomId: java.util.Optional[java.lang.Long], machineId: java.util.Optional[java.lang.Long], examId: java.util.Optional[java.lang.Long], start: java.util.Optional[String], end: java.util.Optional[String], externalRef: java.util.Optional[String], request: Request)
 GET           /app/events                                              controllers.ReservationController.getExaminationEvents(state: java.util.Optional[String], ownerId: java.util.Optional[java.lang.Long], studentId: java.util.Optional[java.lang.Long], examId: java.util.Optional[java.lang.Long], start: java.util.Optional[String], end: java.util.Optional[String], request: Request)
 DELETE        /app/reservations/:id                                    controllers.ReservationController.removeReservation(id: Long, request: Request)

diff --git a/ui/src/app/dashboard/staff/admin/admin-dashboard.component.ts b/ui/src/app/dashboard/staff/admin/admin-dashboard.component.ts
@@ -16,6 +16,6 @@ import { Component } from '@angular/core';
 
 @Component({
     selector: 'xm-admin-dashboard',
-    template: '<xm-admin-reservations></xm-admin-reservations>',
+    template: '<xm-reservations></xm-reservations>',
 })
 export class AdminDashboardComponent {}
diff --git a/ui/src/app/dashboard/staff/admin/admin-dashboard.module.ts b/ui/src/app/dashboard/staff/admin/admin-dashboard.module.ts
@@ -12,6 +12,7 @@
  * on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the Licence for the specific language governing permissions and limitations under the Licence.
  */
+// TODO: maybe this module is redundant. Let's keep it anyway in case we want to lazy load admin stuff in the future
 import { NgModule } from '@angular/core';
 import { ReservationModule } from '../../../reservation/reservation.module';
 import { SharedModule } from '../../../shared/shared.module';

diff --git a/ui/src/app/dashboard/staff/staff-routing.module.ts b/ui/src/app/dashboard/staff/staff-routing.module.ts
@@ -34,7 +34,7 @@ import { LanguageInspectionsComponent } from '../../maturity/language-inspection
 import { MaturityReportingComponent } from '../../maturity/reporting/maturity-reporting.component';
 import { QuestionComponent } from '../../question/basequestion/question.component';
 import { LibraryComponent } from '../../question/library/library.component';
-import { TeacherReservationComponent } from '../../reservation/teacher/teacher-reservations.component';
+import { ReservationsComponent } from '../../reservation/reservations.component';
 import { AssessmentComponent } from '../../review/assessment/assessment.component';
 import { PrintedAssessmentComponent } from '../../review/assessment/print/printed-assessment.component';
 import { SpeedReviewComponent } from '../../review/listing/speed-review.component';
@@ -152,8 +152,8 @@ const routes: Route[] = [
             { path: 'inspections', component: LanguageInspectionsComponent },
             { path: 'inspections/reports', component: MaturityReportingComponent },
             { path: 'adminexams', component: ExamListingComponent },
-            { path: 'reservations', component: TeacherReservationComponent },
-            { path: 'reservations/:eid', component: TeacherReservationComponent },
+            { path: 'reservations', component: ReservationsComponent },
+            { path: 'reservations/:eid', component: ReservationsComponent },
             { path: 'rooms', component: FacilityComponent },
             { path: 'rooms/:id', component: RoomComponent },
             { path: 'rooms/:id/availability', component: AvailabilityComponent },

diff --git a/ui/src/app/reservation/admin/admin-reservations.component.html b/ui/src/app/reservation/admin/admin-reservations.component.html
diff --git a/ui/src/app/reservation/admin/admin-reservations.component.ts b/ui/src/app/reservation/admin/admin-reservations.component.ts
diff --git a/ui/src/app/reservation/reservation-details.component.ts b/ui/src/app/reservation/reservation-details.component.ts
@@ -19,9 +19,9 @@ import { Component, Input, OnChanges } from '@angular/core';
 import { TranslateService } from '@ngx-translate/core';
 import { ToastrService } from 'ngx-toastr';
 import { ExamEnrolment } from '../enrolment/enrolment.model';
-import { AnyReservation } from './reservation-base.component';
 import type { Reservation } from './reservation.model';
 import { ReservationService } from './reservation.service';
+import { AnyReservation } from './reservations.component';
 
 type ReservationDetail = Reservation & { org: { name: string; code: string }; userAggregate: string };
 

diff --git a/ui/src/app/reservation/reservation.module.ts b/ui/src/app/reservation/reservation.module.ts
@@ -16,22 +16,20 @@ import { NgModule } from '@angular/core';
 import { RouterModule } from '@angular/router';
 import { NgbModule } from '@ng-bootstrap/ng-bootstrap';
 import { SharedModule } from '../shared/shared.module';
-import { AdminReservationComponent } from './admin/admin-reservations.component';
 import { ChangeMachineDialogComponent } from './admin/change-machine-dialog.component';
 import { RemoveReservationDialogComponent } from './admin/remove-reservation-dialog.component';
 import { ReservationDetailsComponent } from './reservation-details.component';
 import { ReservationService } from './reservation.service';
-import { TeacherReservationComponent } from './teacher/teacher-reservations.component';
+import { ReservationsComponent } from './reservations.component';
 
 @NgModule({
     imports: [NgbModule, SharedModule, RouterModule],
-    exports: [AdminReservationComponent],
+    exports: [ReservationsComponent],
     declarations: [
         ChangeMachineDialogComponent,
         RemoveReservationDialogComponent,
         ReservationDetailsComponent,
-        AdminReservationComponent,
-        TeacherReservationComponent,
+        ReservationsComponent,
     ],
     bootstrap: [ChangeMachineDialogComponent, RemoveReservationDialogComponent],
     providers: [ReservationService],