course difference deletions

This commit is contained in:
2024-08-24 14:43:11 -06:00
parent d32dd4e3db
commit 8d28346431
18 changed files with 766 additions and 58 deletions

View File

@@ -0,0 +1,152 @@
import { LocalCourse, LocalCourseSettings } from "@/models/local/localCourse";
import { LocalModule } from "@/models/local/localModules";
export const CourseDifferences = {
getDeletedChanges(
newCourse: LocalCourse,
oldCourse: LocalCourse
): DeleteCourseChanges {
if (newCourse === oldCourse) {
const emptyDeletes: DeleteCourseChanges = {
namesOfModulesToDeleteCompletely: [],
deleteContentsOfModule: [],
};
return emptyDeletes;
}
const moduleNamesNoLongerReferenced = oldCourse.modules
.filter(
(oldModule) =>
!newCourse.modules.some(
(newModule) => newModule.name === oldModule.name
)
)
.map((oldModule) => oldModule.name);
const modulesWithDeletions = oldCourse.modules
.filter(
(oldModule) =>
!newCourse.modules.some(
(newModule) =>
JSON.stringify(newModule) === JSON.stringify(oldModule)
)
)
.map((oldModule) => {
const newModule = newCourse.modules.find(
(m) => m.name === oldModule.name
);
if (!newModule) return oldModule;
const unreferencedAssignments = oldModule.assignments.filter(
(oldAssignment) =>
!newModule.assignments.some(
(newAssignment) => newAssignment.name === oldAssignment.name
)
);
const unreferencedQuizzes = oldModule.quizzes.filter(
(oldQuiz) =>
!newModule.quizzes.some((newQuiz) => newQuiz.name === oldQuiz.name)
);
const unreferencedPages = oldModule.pages.filter(
(oldPage) =>
!newModule.pages.some((newPage) => newPage.name === oldPage.name)
);
return {
...oldModule,
assignments: unreferencedAssignments,
quizzes: unreferencedQuizzes,
pages: unreferencedPages,
};
});
return {
namesOfModulesToDeleteCompletely: moduleNamesNoLongerReferenced,
deleteContentsOfModule: modulesWithDeletions,
};
},
getNewChanges(
newCourse: LocalCourse,
oldCourse: LocalCourse
): NewCourseChanges {
if (newCourse === oldCourse) {
const emptyChanges: NewCourseChanges = {
modules: [],
};
return emptyChanges;
}
const differentModules = newCourse.modules
.filter(
(newModule) =>
!oldCourse.modules.some(
(oldModule) =>
JSON.stringify(oldModule) === JSON.stringify(newModule)
)
)
.map((newModule) => {
const oldModule = oldCourse.modules.find(
(m) => m.name === newModule.name
);
if (!oldModule) return newModule;
const newAssignments = newModule.assignments.filter(
(newAssignment) =>
!oldModule.assignments.some(
(oldAssignment) =>
JSON.stringify(newAssignment) === JSON.stringify(oldAssignment)
)
);
const newQuizzes = newModule.quizzes.filter(
(newQuiz) =>
!oldModule.quizzes.some(
(oldQuiz) => JSON.stringify(newQuiz) === JSON.stringify(oldQuiz)
)
);
const newPages = newModule.pages.filter(
(newPage) =>
!oldModule.pages.some(
(oldPage) => JSON.stringify(newPage) === JSON.stringify(oldPage)
)
);
return {
...newModule,
assignments: newAssignments,
quizzes: newQuizzes,
pages: newPages,
};
});
return {
settings: newCourse.settings,
modules: differentModules,
};
},
};
export interface DeleteCourseChanges {
namesOfModulesToDeleteCompletely: string[];
deleteContentsOfModule: LocalModule[];
}
export interface NewCourseChanges {
modules: LocalModule[];
settings?: LocalCourseSettings;
}
// Default values for DeleteCourseChanges and NewCourseChanges
// export const createDeleteCourseChanges = (
// init?: Partial<DeleteCourseChanges>
// ): DeleteCourseChanges => ({
// namesOfModulesToDeleteCompletely: init?.namesOfModulesToDeleteCompletely ?? [],
// deleteContentsOfModule: init?.deleteContentsOfModule ?? [],
// });
// export const createNewCourseChanges = (
// init?: Partial<NewCourseChanges>
// ): NewCourseChanges => ({
// modules: init?.modules ?? [],
// settings: init?.settings,
// });

View File

@@ -0,0 +1,423 @@
import { describe, it, expect } from "vitest";
import { LocalCourse } from "@/models/local/localCourse";
import { CourseDifferences } from "../fileStorage/courseDifferences";
describe("CourseDifferencesDeletionsTests", () => {
it("same module does not get deleted", () => {
const oldCourse: LocalCourse = {
settings: {
assignmentGroups: [],
daysOfWeek: [],
startDate: "09/07/2024 23:59:00",
endDate: "09/07/2024 23:59:00",
defaultDueTime: {
hour: 23,
minute: 59,
},
},
modules: [
{
name: "test module",
assignments: [],
quizzes: [],
pages: [],
},
],
};
const newCourse: LocalCourse = {
...oldCourse,
modules: [
{
name: "test module",
assignments: [],
quizzes: [],
pages: [],
},
],
};
const differences = CourseDifferences.getDeletedChanges(newCourse, oldCourse);
expect(differences.namesOfModulesToDeleteCompletely).toHaveLength(0);
});
it("changed module - old one gets deleted", () => {
const oldCourse: LocalCourse = {
settings: {
assignmentGroups: [],
daysOfWeek: [],
startDate: "09/07/2024 23:59:00",
endDate: "09/07/2024 23:59:00",
defaultDueTime: {
hour: 23,
minute: 59,
},
},
modules: [
{
name: "test module",
assignments: [],
quizzes: [],
pages: [],
},
],
};
const newCourse: LocalCourse = {
...oldCourse,
modules: [
{
name: "test module 2",
assignments: [],
quizzes: [],
pages: [],
},
],
};
const differences = CourseDifferences.getDeletedChanges(newCourse, oldCourse);
expect(differences.namesOfModulesToDeleteCompletely).toHaveLength(1);
expect(differences.namesOfModulesToDeleteCompletely[0]).toBe("test module");
});
it("new assignment name gets deleted", () => {
const oldCourse: LocalCourse = {
settings: {
assignmentGroups: [],
daysOfWeek: [],
startDate: "09/07/2024 23:59:00",
endDate: "09/07/2024 23:59:00",
defaultDueTime: {
hour: 23,
minute: 59,
},
},
modules: [
{
name: "test module",
assignments: [
{
name: "test assignment",
description: "test description",
dueAt: "09/07/2024 23:59:00",
submissionTypes: [],
allowedFileUploadExtensions: [],
rubric: []
},
],
quizzes: [],
pages: [],
},
],
};
const newCourse: LocalCourse = {
...oldCourse,
modules: [
{
name: "test module",
assignments: [
{
name: "test assignment changed name",
description: "test description",
dueAt: "09/07/2024 23:59:00",
submissionTypes: [],
allowedFileUploadExtensions: [],
rubric: []
},
],
quizzes: [],
pages: [],
},
],
};
const differences = CourseDifferences.getDeletedChanges(newCourse, oldCourse);
expect(differences.namesOfModulesToDeleteCompletely).toHaveLength(0);
expect(differences.deleteContentsOfModule).toHaveLength(1);
expect(differences.deleteContentsOfModule[0].assignments).toHaveLength(1);
expect(differences.deleteContentsOfModule[0].assignments[0].name).toBe(
"test assignment"
);
});
it("assignments with changed descriptions do not get deleted", () => {
const oldCourse: LocalCourse = {
settings: {
assignmentGroups: [],
daysOfWeek: [],
startDate: "09/07/2024 23:59:00",
endDate: "09/07/2024 23:59:00",
defaultDueTime: {
hour: 23,
minute: 59,
},
},
modules: [
{
name: "test module",
assignments: [
{
name: "test assignment",
description: "test description",
dueAt: "09/07/2024 23:59:00",
submissionTypes: [],
allowedFileUploadExtensions: [],
rubric: []
},
],
quizzes: [],
pages: [],
},
],
};
const newCourse: LocalCourse = {
...oldCourse,
modules: [
{
name: "test module",
assignments: [
{
name: "test assignment",
description: "test description",
dueAt: "09/07/2024 23:59:00",
submissionTypes: [],
allowedFileUploadExtensions: [],
rubric: []
},
],
quizzes: [],
pages: [],
},
],
};
const differences = CourseDifferences.getDeletedChanges(newCourse, oldCourse);
expect(differences.deleteContentsOfModule).toHaveLength(0);
});
it("can detect changed and unchanged assignments", () => {
const oldCourse: LocalCourse = {
settings: {
assignmentGroups: [],
daysOfWeek: [],
startDate: "09/07/2024 23:59:00",
endDate: "09/07/2024 23:59:00",
defaultDueTime: {
hour: 23,
minute: 59,
},
},
modules: [
{
name: "test module",
assignments: [
{
name: "test assignment",
description: "test description",
dueAt: "09/07/2024 23:59:00",
submissionTypes: [],
allowedFileUploadExtensions: [],
rubric: []
},
{
name: "test assignment 2",
description: "test description",
dueAt: "09/07/2024 23:59:00",
submissionTypes: [],
allowedFileUploadExtensions: [],
rubric: []
},
],
quizzes: [],
pages: [],
},
],
};
const newCourse: LocalCourse = {
...oldCourse,
modules: [
{
name: "test module",
assignments: [
{
name: "test assignment",
description: "test description",
dueAt: "09/07/2024 23:59:00",
submissionTypes: [],
allowedFileUploadExtensions: [],
rubric: []
},
{
name: "test assignment 2 changed",
description: "test description",
dueAt: "09/07/2024 23:59:00",
submissionTypes: [],
allowedFileUploadExtensions: [],
rubric: []
},
],
quizzes: [],
pages: [],
},
],
};
const differences = CourseDifferences.getDeletedChanges(newCourse, oldCourse);
expect(differences.deleteContentsOfModule).toHaveLength(1);
expect(differences.deleteContentsOfModule[0].assignments).toHaveLength(1);
expect(differences.deleteContentsOfModule[0].assignments[0].name).toBe(
"test assignment 2"
);
});
it("changed quizzes get deleted", () => {
const oldCourse: LocalCourse = {
settings: {
assignmentGroups: [],
daysOfWeek: [],
startDate: "09/07/2024 23:59:00",
endDate: "09/07/2024 23:59:00",
defaultDueTime: {
hour: 23,
minute: 59,
},
},
modules: [
{
name: "test module",
assignments: [],
quizzes: [
{
name: "Test Quiz",
description: "test description",
dueAt: "09/07/2024 23:59:00",
shuffleAnswers: false,
showCorrectAnswers: false,
oneQuestionAtATime: false,
allowedAttempts: 0,
questions: []
},
{
name: "Test Quiz 2",
description: "test description",
dueAt: "09/07/2024 23:59:00",
shuffleAnswers: false,
showCorrectAnswers: false,
oneQuestionAtATime: false,
allowedAttempts: 0,
questions: []
},
],
pages: [],
},
],
};
const newCourse: LocalCourse = {
...oldCourse,
modules: [
{
name: "test module",
assignments: [],
quizzes: [
{
name: "Test Quiz",
description: "test description",
dueAt: "09/07/2024 23:59:00",
shuffleAnswers: false,
showCorrectAnswers: false,
oneQuestionAtATime: false,
allowedAttempts: 0,
questions: []
},
{
name: "Test Quiz 3",
description: "test description",
dueAt: "09/07/2024 23:59:00",
shuffleAnswers: false,
showCorrectAnswers: false,
oneQuestionAtATime: false,
allowedAttempts: 0,
questions: []
},
],
pages: [],
},
],
};
const differences = CourseDifferences.getDeletedChanges(newCourse, oldCourse);
expect(differences.deleteContentsOfModule).toHaveLength(1);
expect(differences.deleteContentsOfModule[0].quizzes).toHaveLength(1);
expect(differences.deleteContentsOfModule[0].quizzes[0].name).toBe(
"Test Quiz 2"
);
});
it("changed pages get deleted", () => {
const oldCourse: LocalCourse = {
settings: {
assignmentGroups: [],
daysOfWeek: [],
startDate: "09/07/2024 23:59:00",
endDate: "09/07/2024 23:59:00",
defaultDueTime: {
hour: 23,
minute: 59,
},
},
modules: [
{
name: "test module",
assignments: [],
quizzes: [],
pages: [
{
name: "Test Page",
text: "test contents",
dueAt: "09/07/2024 23:59:00",
},
{
name: "Test Page 2",
text: "test contents",
dueAt: "09/07/2024 23:59:00"
},
],
},
],
};
const newCourse: LocalCourse = {
...oldCourse,
modules: [
{
name: "test module",
assignments: [],
quizzes: [],
pages: [
{
name: "Test Page",
text: "test contents",
dueAt: "09/07/2024 23:59:00"
},
{
name: "Test Page 3",
text: "test contents",
dueAt: "09/07/2024 23:59:00"
},
],
},
],
};
const differences = CourseDifferences.getDeletedChanges(newCourse, oldCourse);
expect(differences.deleteContentsOfModule).toHaveLength(1);
expect(differences.deleteContentsOfModule[0].pages).toHaveLength(1);
expect(differences.deleteContentsOfModule[0].pages[0].name).toBe(
"Test Page 2"
);
});
});