WIP: add user-set tests to mojolicious

WIP: add user-set tests to mojolicious routes


WIP: add user-set tests to mojolicious routes


WIP: updated user_sets tests to check for permissions

FIX: update the way the set_version param is fetched to avoid error.

WIP: new set_version mojolicious test.

WIP: new set_version mojolicious test.


WIP: deleting from db--update store tests

WIP: cleanup the tests

WIP: deleting from db--update store tests
WIP: send message from mojolicious layer and more cleanup.
FIX: update the pinia store tests.

WIP: add user-set tests to mojolicious

Author: pstaabp

conf/permissions.dist.yml

@@ -100,6 +100,10 @@ db_permissions:
       allowed_roles: ['course_admin', 'instructor']
     getUserSets:
       allowed_roles: ['course_admin', 'instructor']
+      allow_self_access: true
+    getUserSet:
+      allowed_roles: ['course_admin', 'instructor']
+      allow_self_access: true
     addUserSet:
       allowed_roles: ['course_admin', 'instructor']
     updateUserSet:

lib/DB/Schema/ResultSet/ProblemPool.pm

@@ -333,6 +333,7 @@ sub getPoolProblem ($self, %args) {
 				. ' is not in the pool named \''
 				. $problem_pool->pool_name
 				. "'");
+		return;
 	} else {
 		# Pick a random problem.
 		my $prob = $pool_problems[ rand @pool_problems ];
@@ -434,12 +435,8 @@ remove a Problem out of a ProblemPool in a course
 =cut
 
 sub removePoolProblem ($self, %args) {
-	my $prob = $self->getPoolProblem(info => $args{info}, as_result_set => 1);
-	DB::Exception::PoolProblemNotInPool->throw(info => $args{info}) unless defined($prob);
-
-	my $prob2 = $prob->delete;
-	return $prob2 if $args{as_result_set};
-	return { $prob2->get_inflated_columns };
+	$self->getPoolProblem(info => $args{info}, as_result_set => 1)->delete;
+	return;
 }
 
 # just a small subroutine to shorten access to the db.

lib/DB/Schema/ResultSet/User.pm

@@ -323,9 +323,17 @@ An hashref of the user or merged user or a C<DBIx::Class::ResultSet>
 sub getCourseUser ($self, %args) {
 	my $course_user;
 
-	if (defined($args{info}->{course_user_id})) {
+	if (defined($args{info}{course_user_id})) {
 		$course_user = $self->rs('CourseUser')
 			->find({ course_user_id => $args{info}->{course_user_id} }, { prefetch => [qw/role/] });
+		DB::Exception::UserNotInCourse->throw(
+			message => "The user with id '$args{info}->{course_user_id}' is not enrolled in the course "
+				. (
+					$args{info}->{course_name}
+					? " with name '$args{info}->{course_name}'"
+					: " with course_id '$args{info}->{course_id}'."
+				)
+		) unless defined $course_user || $args{skip_throw};
 	} else {
 		my $course = $self->rs('Course')->getCourse(info => getCourseInfo($args{info}), as_result_set => 1);
 		my $user   = $self->getGlobalUser(info => getUserInfo($args{info}), as_result_set => 1);

lib/DB/Schema/ResultSet/UserSet.pm

@@ -374,10 +374,10 @@ sub updateUserSet ($self, %args) {
 	my $user_set = $self->getUserSet(info => $args{info}, as_result_set => 1, skip_throw => 1);
 
 	DB::Exception::UserSetNotInCourse->throw(message => 'The user '
-			. $args{info}{username}
+			. ($args{info}{username} ? "with username '$args{info}{username}'" : "with user_id '$args{info}{user_id}'")
 			. ' is not assigned to the set '
-			. $args{info}{set_name}
-			. ' with set version '
+			. ($args{info}{set_name} ? "with set name '$args{info}{set_name}'" : "with set_id '$args{info}{set_id}'")
+			. ' and set version '
 			. ($args{info}{set_version} // 0))
 		unless defined($user_set);
 

lib/WeBWorK3.pm

@@ -173,8 +173,16 @@ sub problemSetRoutes ($app, $course_routes) {
 	$course_routes->get('/user-sets')->to('ProblemSet#getAllUserSets');
 	$course_routes->get('/sets/:set_id/users')->to('ProblemSet#getUserSets');
 	$course_routes->post('/sets/:set_id/users')->to('ProblemSet#addUserSet');
-	$course_routes->put('/sets/:set_id/users/:course_user_id')->to('ProblemSet#updateUserSet');
-	$course_routes->delete('/sets/:set_id/users/:course_user_id')->to('ProblemSet#deleteUserSet');
+
+	# User sets that will default to set_version of 0
+	$course_routes->get('/sets/:set_id/users/:user_id')->to('ProblemSet#getUserSet');
+	$course_routes->put('/sets/:set_id/users/:user_id')->to('ProblemSet#updateUserSet');
+	$course_routes->delete('/sets/:set_id/users/:user_id')->to('ProblemSet#deleteUserSet');
+
+	# User sets for given set_version
+	$course_routes->get('/sets/:set_id/users/:user_id/v/:set_version')->to('ProblemSet#getUserSet');
+	$course_routes->put('/sets/:set_id/users/:user_id/v/:set_version')->to('ProblemSet#updateUserSet');
+	$course_routes->delete('/sets/:set_id/users/:user_id/v/:set_version')->to('ProblemSet#deleteUserSet');
 
 	$course_routes->get('/users/:user_id/sets')->to('ProblemSet#getUserSets');
 	return;

lib/WeBWorK3/Controller/Course.pm

@@ -32,9 +32,8 @@ sub addCourse ($c) {
 }
 
 sub deleteCourse ($c) {
-	my $course =
-		$c->schema->resultset('Course')->deleteCourse(info => { course_id => int($c->param('course_id')) });
-	$c->render(json => $course);
+	$c->schema->resultset('Course')->deleteCourse(info => { course_id => int($c->param('course_id')) });
+	$c->render(json => { message => 'The course was successfully deleted.' });
 	return;
 }
 

lib/WeBWorK3/Controller/Problem.pm

@@ -55,14 +55,14 @@ sub updateProblem ($c) {
 }
 
 sub deleteProblem ($c) {
-	my $deleted_problem = $c->schema->resultset('SetProblem')->deleteSetProblem(
+	$c->schema->resultset('SetProblem')->deleteSetProblem(
 		info => {
 			course_id      => int($c->param('course_id')),
 			set_id         => int($c->param('set_id')),
 			set_problem_id => int($c->param('set_problem_id'))
 		}
 	);
-	$c->render(json => $deleted_problem);
+	$c->render(json => { message => 'The problem was successfully deleted.' });
 	return;
 }
 
@@ -142,15 +142,15 @@ sub updateUserProblem ($c) {
 }
 
 sub deleteUserProblem ($c) {
-	my $deleted_problem = $c->schema->resultset('UserProblem')->deleteUserProblem(
+	$c->schema->resultset('UserProblem')->deleteUserProblem(
 		info => {
 			course_id       => int($c->param('course_id')),
 			set_id          => int($c->param('set_id')),
 			user_id         => int($c->param('user_id')),
 			user_problem_id => int($c->param('user_problem_id'))
 		}
 	);
-	$c->render(json => $deleted_problem);
+	$c->render(json => { message => 'The user problem was successfully deleted.' });
 	return;
 }
 
@@ -204,14 +204,14 @@ sub updateProblemPool ($c) {
 }
 
 sub deleteProblemPool ($c) {
-	my $problem_pool = $c->schema->resultset('ProblemPool')->deleteProblemPool(
+	$c->schema->resultset('ProblemPool')->deleteProblemPool(
 		info => {
 			course_id       => int($c->param('course_id')),
 			problem_pool_id => int($c->param('problem_pool_id')),
 		},
 		params => $c->req->json
 	);
-	$c->render(json => $problem_pool);
+	$c->render(json => { message => 'The problem pool was successfully deleted.' });
 	return;
 }
 
@@ -261,14 +261,13 @@ sub updatePoolProblem ($c) {
 }
 
 sub removePoolProblem ($c) {
-	my $problem_pool = $c->schema->resultset('ProblemPool')->removePoolProblem(
+	$c->schema->resultset('ProblemPool')->removePoolProblem(
 		info => {
 			course_id       => int($c->param('course_id')),
 			problem_pool_id => int($c->param('problem_pool_id')),
-		},
-		params => $c->req->json
+		}
 	);
-	$c->render(json => $problem_pool);
+	$c->render(json => { message => 'The pool problem was successfully removed.' });
 	return;
 }
 

lib/WeBWorK3/Controller/ProblemSet.pm

@@ -62,13 +62,13 @@ sub addProblemSet ($self) {
 }
 
 sub deleteProblemSet ($self) {
-	my $problem_set = $self->schema->resultset('ProblemSet')->deleteProblemSet(
+	$self->schema->resultset('ProblemSet')->deleteProblemSet(
 		info => {
 			course_id => int($self->param('course_id')),
 			set_id    => int($self->param('set_id'))
 		}
 	);
-	$self->render(json => $problem_set);
+	$self->render(json => { message => 'The problem set was successfully deleted.' });
 	return;
 }
 
@@ -106,6 +106,19 @@ sub getUserSets ($self) {
 	return;
 }
 
+sub getUserSet ($self) {
+	my $user_set = $self->schema->resultset('UserSet')->getUserSet(
+		info => {
+			course_id   => int($self->param('course_id')),
+			set_id      => int($self->param('set_id')),
+			user_id     => int($self->param('user_id')),
+			set_version => int($self->param('set_version') // 0)
+		}
+	);
+	$self->render(json => $user_set);
+	return;
+}
+
 sub addUserSet ($self) {
 	my $new_user_set = $self->schema->resultset('UserSet')->addUserSet(
 		params => {
@@ -121,9 +134,10 @@ sub addUserSet ($self) {
 sub updateUserSet ($self) {
 	my $updated_user_set = $self->schema->resultset('UserSet')->updateUserSet(
 		info => {
-			course_id      => int($self->param('course_id')),
-			set_id         => int($self->param('set_id')),
-			course_user_id => int($self->param('course_user_id'))
+			course_id   => int($self->param('course_id')),
+			set_id      => int($self->param('set_id')),
+			user_id     => int($self->param('user_id')),
+			set_version => int($self->param('set_version') // 0)
 		},
 		params => $self->req->json
 	);
@@ -132,15 +146,16 @@ sub updateUserSet ($self) {
 }
 
 sub deleteUserSet ($self) {
-	my $updated_user_set = $self->schema->resultset('UserSet')->deleteUserSet(
+	$self->schema->resultset('UserSet')->deleteUserSet(
 		info => {
-			course_id      => int($self->param('course_id')),
-			set_id         => int($self->param('set_id')),
-			course_user_id => int($self->param('course_user_id'))
+			course_id   => int($self->param('course_id')),
+			set_id      => int($self->param('set_id')),
+			user_id     => int($self->param('user_id')),
+			set_version => int($self->param('set_version') // 0)
 		},
 		params => $self->req->json
 	);
-	$self->render(json => $updated_user_set);
+	$self->render(json => { message => 'The user set was successfully deleted.' });
 	return;
 }
 

lib/WeBWorK3/Controller/User.pm

@@ -48,7 +48,7 @@ sub addGlobalUser ($c) {
 
 sub deleteGlobalUser ($c) {
 	my $user = $c->schema->resultset('User')->deleteGlobalUser(info => { user_id => int($c->param('user_id')) });
-	$c->render(json => $user);
+	$c->render(json => { message => 'The global user was successfully deleted.' });
 	return;
 }
 
@@ -132,7 +132,7 @@ sub deleteCourseUser ($c) {
 			user_id   => int($c->param('user_id'))
 		}
 	);
-	$c->render(json => $course_user);
+	$c->render(json => { message => 'The course user was successfully deleted.' });
 	return;
 }
 

src/stores/courses.ts

@@ -77,13 +77,11 @@ export const useCourseStore = defineStore('courses', {
 		/**
 		 * This deletes the course in the database and the store.
 		 */
-		async deleteCourse(course: Course): Promise<Course | undefined> {
+		async deleteCourse(course: Course): Promise<void> {
 			const response = await api.delete(`courses/${course.course_id}`);
 			if (response.status === 200) {
-				const deleted_course = new Course(response.data as ParseableCourse);
-				const index = this.courses.findIndex(course => course.course_id === deleted_course.course_id);
+				const index = this.courses.findIndex(c => c.course_id === course.course_id);
 				this.courses.splice(index, 1);
-				return deleted_course;
 			} else {
 				throw response.data as ResponseError;
 			}