alex/canvasManagement
1
0
Fork 0
mirror of https://github.com/alexmickelson/canvasManagement.git synced 2026-03-25 23:28:33 -06:00
Code Issues Packages Projects Releases Wiki Activity

organizing file storage

Browse Source
This commit is contained in:
Alex Mickelson
2024-09-13 20:46:05 -06:00
parent 5c7ddf18d6
commit 1442f246b5
27 changed files with 1413 additions and 1321 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
nextjs/src/app/api/courses/[courseName]/modules/[moduleName]/assignments/[assignmentName]/route.ts
View File

@@ -10,7 +10,7 @@ export const GET = async (
}
) =>
await withErrorHandling(async () => {
const settings = await fileStorageService.getAssignment(
const settings = await fileStorageService.assignments.getAssignment(
courseName,
moduleName,
assignmentName
@@ -28,7 +28,7 @@ export const PUT = async (
) =>
await withErrorHandling(async () => {
const assignment = await request.json();
await fileStorageService.updateAssignment(
await fileStorageService.assignments.updateAssignment(
courseName,
moduleName,
assignmentName,

2
nextjs/src/app/api/courses/[courseName]/modules/[moduleName]/assignments/route.ts
View File

@@ -7,7 +7,7 @@ export const GET = async (
params: { courseName, moduleName },
}: { params: { courseName: string; moduleName: string } }
) => await withErrorHandling(async () => {
const settings = await fileStorageService.getAssignmentNames(
const settings = await fileStorageService.assignments.getAssignmentNames(
courseName,
moduleName
);

4
nextjs/src/app/api/courses/[courseName]/modules/[moduleName]/pages/[pageName]/route.ts
View File

@@ -8,7 +8,7 @@ export const GET = async (
}: { params: { courseName: string; moduleName: string; pageName: string } }
) =>
await withErrorHandling(async () => {
const settings = await fileStorageService.getPage(
const settings = await fileStorageService.pages.getPage(
courseName,
moduleName,
pageName
@@ -24,6 +24,6 @@ export const PUT = async (
) =>
await withErrorHandling(async () => {
const page = await request.json();
await fileStorageService.updatePage(courseName, moduleName, pageName, page);
await fileStorageService.pages.updatePage(courseName, moduleName, pageName, page);
return Response.json({});
});

2
nextjs/src/app/api/courses/[courseName]/modules/[moduleName]/pages/route.ts
View File

@@ -8,7 +8,7 @@ export const GET = async (
}: { params: { courseName: string; moduleName: string } }
) =>
await withErrorHandling(async () => {
const settings = await fileStorageService.getPageNames(
const settings = await fileStorageService.pages.getPageNames(
courseName,
moduleName
);

4
nextjs/src/app/api/courses/[courseName]/modules/[moduleName]/quizzes/[quizName]/route.ts
View File

@@ -7,7 +7,7 @@ export const GET = async (
params: { courseName, moduleName, quizName },
}: { params: { courseName: string; moduleName: string; quizName: string } }
) => await withErrorHandling(async () => {
const quiz = await fileStorageService.getQuiz(
const quiz = await fileStorageService.quizzes.getQuiz(
courseName,
moduleName,
quizName
@@ -22,7 +22,7 @@ export const PUT = async (
}: { params: { courseName: string; moduleName: string; quizName: string } }
) => await withErrorHandling(async () => {
const quiz = await request.json()
await fileStorageService.updateQuiz(
await fileStorageService.quizzes.updateQuiz(
courseName,
moduleName,
quizName,

2
nextjs/src/app/api/courses/[courseName]/modules/[moduleName]/quizzes/route.ts
View File

@@ -8,7 +8,7 @@ export const GET = async (
}: { params: { courseName: string; moduleName: string } }
) =>
await withErrorHandling(async () => {
const settings = await fileStorageService.getQuizNames(
const settings = await fileStorageService.quizzes.getQuizNames(
courseName,
moduleName
);

12
nextjs/src/app/api/courses/[courseName]/modules/route.ts
View File

@@ -6,6 +6,16 @@ export const GET = async (
{ params: { courseName } }: { params: { courseName: string } }
) =>
await withErrorHandling(async () => {
const settings = await fileStorageService.getModuleNames(courseName);
const settings = await fileStorageService.modules.getModuleNames(courseName);
return Response.json(settings);
});
export const POST = async (
request: Request,
{ params: { courseName } }: { params: { courseName: string } }
) =>
await withErrorHandling(async () => {
const { moduleName } = await request.json();
await fileStorageService.modules.createModule(courseName, moduleName);
return Response.json({});
});

4
nextjs/src/app/api/courses/[courseName]/settings/route.ts
View File

@@ -9,7 +9,7 @@ export const GET = async (
if (courseName.includes(".js.map")) {
return Response.json({});
}
const settings = await fileStorageService.getCourseSettings(courseName);
const settings = await fileStorageService.settings.getCourseSettings(courseName);
return Response.json(settings);
});
@@ -20,7 +20,7 @@ export const PUT = async (
await withErrorHandling(async () => {
const settings = await request.json();
await fileStorageService.updateCourseSettings(courseName, settings);
await fileStorageService.settings.updateCourseSettings(courseName, settings);
return Response.json({});
});

2
nextjs/src/app/api/courses/route.ts
View File

@@ -11,7 +11,7 @@ export const GET = async () =>
export const POST = async (request: Request) =>
await withErrorHandling(async () => {
const newCourse: LocalCourse = await request.json();
await fileStorageService.updateCourseSettings(
await fileStorageService.settings.updateCourseSettings(
newCourse.settings.name,
newCourse.settings
);

2
nextjs/src/app/api/courses/settings/route.ts
View File

@@ -3,7 +3,7 @@ import { withErrorHandling } from "@/services/withErrorHandling";
export const GET = async () =>
await withErrorHandling(async () => {
const settings = await fileStorageService.getAllCoursesSettings();
const settings = await fileStorageService.settings.getAllCoursesSettings();
return Response.json(settings);
});

2
nextjs/src/app/course/[courseName]/CourseSettingsLink.tsx
View File

@@ -12,7 +12,7 @@ export default function CourseSettingsLink() {
<div>
{settings.name}
<Link href={getCourseSettingsUrl(courseName)} shallow={true}>
<Link className="mx-3 underline" href={getCourseSettingsUrl(courseName)} shallow={true}>
Course Settings
</Link>
</div>

10
nextjs/src/app/course/[courseName]/CourseTitle.tsx Normal file
View File

@@ -0,0 +1,10 @@
"use client"
import { useCourseContext } from "./context/courseContext"
export default function CourseTitle() {
const {courseName}= useCourseContext()
return (
<title>{courseName}</title>
)
}

4
nextjs/src/app/course/[courseName]/calendar/CalendarMonth.tsx
View File

@@ -25,7 +25,7 @@ export const CalendarMonth = ({ month }: { month: CalendarMonthModel }) => {
<h3
className={
"text-2xl transition-all duration-500 " +
"hover:text-slate-50 underline hover:scale-105 "
"hover:text-slate-50 underline hover:scale-105 `"
}
onClick={toggleCollapse}
role="button"
@@ -36,7 +36,7 @@ export const CalendarMonth = ({ month }: { month: CalendarMonthModel }) => {
<div
id={monthName}
className={"collapsable " + (isCollapsed ? "" : "expand")}
className={"collapsible " + (isCollapsed ? "" : "expand")}
>
<div className="grid grid-cols-7 text-center fw-bold">
{weekDaysList.map((day) => (

9
nextjs/src/app/course/[courseName]/calendar/Day.tsx
View File

@@ -11,6 +11,9 @@ import { IModuleItem } from "@/models/local/IModuleItem";
import { useLocalCourseSettingsQuery } from "@/hooks/localCourse/localCoursesHooks";
import { getDayOfWeek } from "@/models/local/localCourse";
import { getModuleItemUrl } from "@/services/urlUtils";
import { LocalAssignment } from "@/models/local/assignment/localAssignment";
import { LocalQuiz } from "@/models/local/quiz/localQuiz";
import { LocalCoursePage } from "@/models/local/page/localCoursePage";
export default function Day({ day, month }: { day: string; month: number }) {
const dayAsDate = getDateFromStringOrThrow(
@@ -74,9 +77,9 @@ export default function Day({ day, month }: { day: string; month: number }) {
function getTodaysItems(todaysModules: {
[moduleName: string]: {
assignments: import("/home/alexm/projects/canvasManagement/nextjs/src/models/local/assignment/localAssignment").LocalAssignment[];
quizzes: import("/home/alexm/projects/canvasManagement/nextjs/src/models/local/quiz/localQuiz").LocalQuiz[];
pages: import("/home/alexm/projects/canvasManagement/nextjs/src/models/local/page/localCoursePage").LocalCoursePage[];
assignments: LocalAssignment[];
quizzes: LocalQuiz[];
pages: LocalCoursePage[];
};
}) {
const todaysAssignments = todaysModules

9
nextjs/src/app/course/[courseName]/context/CalendarItemsContextProvider.tsx
View File

@@ -1,20 +1,13 @@
import { ReactNode } from "react";
import { useCourseContext } from "./courseContext";
import {
useAllCourseDataQuery,
} from "@/hooks/localCourse/localCoursesHooks";
import {
CalendarItemsContext,
CalendarItemsInterface,
} from "./calendarItemsContext";
import {
dateToMarkdownString,
getDateFromStringOrThrow,
getDateOnlyMarkdownString,
} from "@/models/local/timeUtils";
import { LocalAssignment } from "@/models/local/assignment/localAssignment";
import { LocalQuiz } from "@/models/local/quiz/localQuiz";
import { LocalCoursePage } from "@/models/local/page/localCoursePage";
import { useAllCourseDataQuery } from "@/hooks/localCourse/localCourseModuleHooks";
export default function CalendarItemsContextProvider({
children,

36
nextjs/src/app/course/[courseName]/modules/CreateModule.tsx Normal file
View File

@@ -0,0 +1,36 @@
import TextInput from "@/components/form/TextInput";
import { useCreateModuleMutation } from "@/hooks/localCourse/localCourseModuleHooks";
import React, { useState } from "react";
export default function CreateModule() {
const createModule = useCreateModuleMutation();
const [showForm, setShowForm] = useState(false);
const [moduleName, setModuleName] = useState("");
return (
<>
<button onClick={() => setShowForm((v) => !v)}>
{showForm ? "Hide Form" : "Create Module"}
</button>
<div className={"collapsible " + (showForm ? "expand" : "")}>
<form
onSubmit={async (e) => {
e.preventDefault();
if (moduleName) {
await createModule.mutateAsync(moduleName);
setModuleName("");
}
}}
className="p-1 border border-slate-500 rounded-md my-1 flex flex-row gap-3 justify-between"
>
<TextInput
className="flex-grow"
value={moduleName}
setValue={setModuleName}
label={"New Module Name"}
/>
<button className="mt-auto">Add</button>
</form>
</div>
</>
);
}

4
nextjs/src/app/course/[courseName]/modules/ModuleList.tsx
View File

@@ -1,11 +1,13 @@
"use client";
import { useModuleNamesQuery } from "@/hooks/localCourse/localCoursesHooks";
import { useModuleNamesQuery } from "@/hooks/localCourse/localCourseModuleHooks";
import ExpandableModule from "./ExpandableModule";
import CreateModule from "./CreateModule";
export default function ModuleList() {
const { data: moduleNames } = useModuleNamesQuery();
return (
<div>
<CreateModule />
{moduleNames.map((m) => (
<ExpandableModule key={m} moduleName={m} />
))}

4
nextjs/src/app/course/[courseName]/page.tsx
View File

@@ -3,9 +3,12 @@ import CourseSettingsLink from "./CourseSettingsLink";
import ModuleList from "./modules/ModuleList";
import DraggingContextProvider from "./context/DraggingContextProvider";
import Link from "next/link";
import CourseTitle from "./CourseTitle";
export default async function CoursePage({}: {}) {
return (
<>
<CourseTitle />
<div className="h-full flex flex-col">
<div className="flex flex-row min-h-0">
<DraggingContextProvider>
@@ -25,5 +28,6 @@ export default async function CoursePage({}: {}) {
</DraggingContextProvider>
</div>
</div>
</>
);
}

4
nextjs/src/app/globals.css
View File

@@ -90,12 +90,12 @@ select {
}
.collapsable {
.collapsible {
max-height: 0;
overflow: hidden;
transition: max-height .5s ease-out;
}
.collapsable.expand {
.collapsible.expand {
max-height: 100vh;
}

2
nextjs/src/app/newCourse/AddNewCourse.tsx
View File

@@ -10,7 +10,7 @@ export default function AddNewCourse() {
<div>
<button onClick={() => setShowForm(true)}>Add New Course</button>
<div className={" collapsable " + (showForm && "expand")}>
<div className={" collapsible " + (showForm && "expand")}>
<div className="border rounded-md p-3 m-3">
<SuspenseAndErrorHandling>
{showForm && <NewCourseForm />}

6
nextjs/src/components/form/TextInput.tsx
View File

@@ -4,17 +4,19 @@ export default function TextInput({
value,
setValue,
label,
className,
}: {
value: string;
setValue: (newValue: string) => void;
label: string;
className?: string;
}) {
return (
<label className="block">
<label className={"block " + className}>
{label}
<br />
<input
className="bg-slate-800 rounded-md px-1"
className="bg-slate-800 rounded-md w-full px-1"
value={value}
onChange={(e) => setValue(e.target.value)}
/>

23
nextjs/src/hooks/hookHydration.ts
View File

@@ -4,7 +4,7 @@ import { fileStorageService } from "@/services/fileStorage/fileStorageService";
import { LocalCourseSettings } from "@/models/local/localCourse";
// https://tanstack.com/query/latest/docs/framework/react/guides/ssr
export const hydrateCourses = async (queryClient: QueryClient) => {
const allSettings = await fileStorageService.getAllCoursesSettings();
const allSettings = await fileStorageService.settings.getAllCoursesSettings();
const courseNames = allSettings.map((s) => s.name);
await queryClient.prefetchQuery({
queryKey: localCourseKeys.allCoursesSettings,
@@ -22,21 +22,26 @@ export const hydrateCourse = async (
queryClient: QueryClient,
courseSettings: LocalCourseSettings
) => {
const courseName = courseSettings.name
const moduleNames = await fileStorageService.getModuleNames(courseName);
const courseName = courseSettings.name;
const moduleNames = await fileStorageService.modules.getModuleNames(
courseName
);
const modulesData = await Promise.all(
moduleNames.map(async (moduleName) => {
const [assignmentNames, pageNames, quizNames] = await Promise.all([
await fileStorageService.getAssignmentNames(courseName, moduleName),
await fileStorageService.getPageNames(courseName, moduleName),
await fileStorageService.getQuizNames(courseName, moduleName),
await fileStorageService.assignments.getAssignmentNames(
courseName,
moduleName
),
await fileStorageService.pages.getPageNames(courseName, moduleName),
await fileStorageService.quizzes.getQuizNames(courseName, moduleName),
]);
const [assignments, quizzes, pages] = await Promise.all([
await Promise.all(
assignmentNames.map(
async (assignmentName) =>
await fileStorageService.getAssignment(
await fileStorageService.assignments.getAssignment(
courseName,
moduleName,
assignmentName
@@ -46,13 +51,13 @@ export const hydrateCourse = async (
await Promise.all(
quizNames.map(
async (quizName) =>
await fileStorageService.getQuiz(courseName, moduleName, quizName)
await fileStorageService.quizzes.getQuiz(courseName, moduleName, quizName)
)
),
await Promise.all(
pageNames.map(
async (pageName) =>
await fileStorageService.getPage(courseName, moduleName, pageName)
await fileStorageService.pages.getPage(courseName, moduleName, pageName)
)
),
]);

190
nextjs/src/hooks/localCourse/localCourseModuleHooks.ts
View File

@@ -1,7 +1,18 @@
import { useCourseContext } from "@/app/course/[courseName]/context/courseContext";
import { axiosClient } from "@/services/axiosUtils";
import { useMutation, useSuspenseQuery } from "@tanstack/react-query";
import {
useMutation,
useQueryClient,
useSuspenseQueries,
useSuspenseQuery,
} from "@tanstack/react-query";
import { localCourseKeys } from "./localCourseKeys";
import {
getAssignmentNamesQueryConfig,
getAssignmentQueryConfig,
} from "./assignmentHooks";
import { getPageNamesQueryConfig, getPageQueryConfig } from "./pageHooks";
import { getQuizNamesQueryConfig, getQuizQueryConfig } from "./quizHooks";
export const useModuleNamesQuery = () => {
const { courseName } = useCourseContext();
@@ -17,11 +28,18 @@ export const useModuleNamesQuery = () => {
export const useCreateModuleMutation = () => {
const { courseName } = useCourseContext();
const queryClient = useQueryClient();
return useMutation({
mutationFn: async (moduleName: string) => {
const url = `/api/courses/${courseName}/modules`;
const response = await axiosClient.post(url, { moduleName });
return response.data;},
return response.data;
},
onSuccess: () => {
queryClient.invalidateQueries({
queryKey: localCourseKeys.moduleNames(courseName),
});
},
});
};
@@ -55,94 +73,94 @@ export const useCreateModuleMutation = () => {
// // );
// };
// export const useAllCourseDataQuery = () => {
// const { courseName } = useCourseContext();
// const { data: moduleNames } = useModuleNamesQuery();
export const useAllCourseDataQuery = () => {
const { courseName } = useCourseContext();
const { data: moduleNames } = useModuleNamesQuery();
// const { data: assignmentNamesAndModules } = useSuspenseQueries({
// queries: moduleNames.map((moduleName) =>
// getAssignmentNamesQueryConfig(courseName, moduleName)
// ),
// combine: (results) => ({
// data: results.flatMap((r, i) =>
// r.data.map((assignmentName) => ({
// moduleName: moduleNames[i],
// assignmentName,
// }))
// ),
// pending: results.some((r) => r.isPending),
// }),
// });
const { data: assignmentNamesAndModules } = useSuspenseQueries({
queries: moduleNames.map((moduleName) =>
getAssignmentNamesQueryConfig(courseName, moduleName)
),
combine: (results) => ({
data: results.flatMap((r, i) =>
r.data.map((assignmentName) => ({
moduleName: moduleNames[i],
assignmentName,
}))
),
pending: results.some((r) => r.isPending),
}),
});
// const { data: assignmentsAndModules } = useSuspenseQueries({
// queries: assignmentNamesAndModules.map(
// ({ moduleName, assignmentName }, i) =>
// getAssignmentQueryConfig(courseName, moduleName, assignmentName)
// ),
// combine: (results) => ({
// data: results.flatMap((r, i) => ({
// moduleName: assignmentNamesAndModules[i].moduleName,
// assignment: r.data,
// })),
// pending: results.some((r) => r.isPending),
// }),
// });
const { data: assignmentsAndModules } = useSuspenseQueries({
queries: assignmentNamesAndModules.map(
({ moduleName, assignmentName }, i) =>
getAssignmentQueryConfig(courseName, moduleName, assignmentName)
),
combine: (results) => ({
data: results.flatMap((r, i) => ({
moduleName: assignmentNamesAndModules[i].moduleName,
assignment: r.data,
})),
pending: results.some((r) => r.isPending),
}),
});
// const { data: quizNamesAndModules } = useSuspenseQueries({
// queries: moduleNames.map((moduleName) =>
// getQuizNamesQueryConfig(courseName, moduleName)
// ),
// combine: (results) => ({
// data: results.flatMap((r, i) =>
// r.data.map((quizName) => ({
// moduleName: moduleNames[i],
// quizName: quizName,
// }))
// ),
// pending: results.some((r) => r.isPending),
// }),
// });
const { data: quizNamesAndModules } = useSuspenseQueries({
queries: moduleNames.map((moduleName) =>
getQuizNamesQueryConfig(courseName, moduleName)
),
combine: (results) => ({
data: results.flatMap((r, i) =>
r.data.map((quizName) => ({
moduleName: moduleNames[i],
quizName: quizName,
}))
),
pending: results.some((r) => r.isPending),
}),
});
// const { data: quizzesAndModules } = useSuspenseQueries({
// queries: quizNamesAndModules.map(({ moduleName, quizName }, i) =>
// getQuizQueryConfig(courseName, moduleName, quizName)
// ),
// combine: (results) => ({
// data: results.flatMap((r, i) => ({
// moduleName: quizNamesAndModules[i].moduleName,
// quiz: r.data,
// })),
// pending: results.some((r) => r.isPending),
// }),
// });
const { data: quizzesAndModules } = useSuspenseQueries({
queries: quizNamesAndModules.map(({ moduleName, quizName }, i) =>
getQuizQueryConfig(courseName, moduleName, quizName)
),
combine: (results) => ({
data: results.flatMap((r, i) => ({
moduleName: quizNamesAndModules[i].moduleName,
quiz: r.data,
})),
pending: results.some((r) => r.isPending),
}),
});
// const { data: pageNamesAndModules } = useSuspenseQueries({
// queries: moduleNames.map((moduleName) =>
// getPageNamesQueryConfig(courseName, moduleName)
// ),
// combine: (results) => ({
// data: results.flatMap((r, i) =>
// r.data.map((pageName) => ({
// moduleName: moduleNames[i],
// pageName,
// }))
// ),
// pending: results.some((r) => r.isPending),
// }),
// });
const { data: pageNamesAndModules } = useSuspenseQueries({
queries: moduleNames.map((moduleName) =>
getPageNamesQueryConfig(courseName, moduleName)
),
combine: (results) => ({
data: results.flatMap((r, i) =>
r.data.map((pageName) => ({
moduleName: moduleNames[i],
pageName,
}))
),
pending: results.some((r) => r.isPending),
}),
});
// const { data: pagesAndModules } = useSuspenseQueries({
// queries: pageNamesAndModules.map(({ moduleName, pageName }, i) =>
// getPageQueryConfig(courseName, moduleName, pageName)
// ),
// combine: (results) => ({
// data: results.flatMap((r, i) => ({
// moduleName: pageNamesAndModules[i].moduleName,
// page: r.data,
// })),
// pending: results.some((r) => r.isPending),
// }),
// });
const { data: pagesAndModules } = useSuspenseQueries({
queries: pageNamesAndModules.map(({ moduleName, pageName }, i) =>
getPageQueryConfig(courseName, moduleName, pageName)
),
combine: (results) => ({
data: results.flatMap((r, i) => ({
moduleName: pageNamesAndModules[i].moduleName,
page: r.data,
})),
pending: results.some((r) => r.isPending),
}),
});
// return { assignmentsAndModules, quizzesAndModules, pagesAndModules };
// };
return { assignmentsAndModules, quizzesAndModules, pagesAndModules };
};

79
nextjs/src/services/fileStorage/fileStorageService.ts
View File

@@ -49,16 +49,17 @@ export const fileStorageService = {
return courseNamesFromDirectories;
},
settings: {
async getAllCoursesSettings() {
const courses = await fileStorageService.getCourseNames();
const settings = await Promise.all(
courses.map(async (c) => await fileStorageService.getCourseSettings(c))
const courseSettings = await Promise.all(
courses.map(
async (c) => await fileStorageService.settings.getCourseSettings(c)
)
);
return settings;
return courseSettings;
},
async getCourseSettings(courseName: string): Promise<LocalCourseSettings> {
const courseDirectory = path.join(basePath, courseName);
const settingsPath = path.join(courseDirectory, "settings.yml");
@@ -89,7 +90,8 @@ export const fileStorageService = {
console.log(`Saving settings ${settingsPath}`);
await fs.writeFile(settingsPath, settingsMarkdown);
},
},
modules: {
async getModuleNames(courseName: string) {
const courseDirectory = path.join(basePath, courseName);
const moduleDirectories = await fs.readdir(courseDirectory, {
@@ -108,9 +110,15 @@ export const fileStorageService = {
await fs.mkdir(courseDirectory + "/" + moduleName, { recursive: true });
},
},
assignments: {
async getAssignmentNames(courseName: string, moduleName: string) {
const filePath = path.join(basePath, courseName, moduleName, "assignments");
const filePath = path.join(
basePath,
courseName,
moduleName,
"assignments"
);
if (!(await directoryOrFileExists(filePath))) {
console.log(
`Error loading course by name, assignments folder does not exist in ${filePath}`
@@ -121,33 +129,6 @@ export const fileStorageService = {
const assignmentFiles = await fs.readdir(filePath);
return assignmentFiles.map((f) => f.replace(/\.md$/, ""));
},
async getQuizNames(courseName: string, moduleName: string) {
const filePath = path.join(basePath, courseName, moduleName, "quizzes");
if (!(await directoryOrFileExists(filePath))) {
console.log(
`Error loading course by name, quiz folder does not exist in ${filePath}`
);
await fs.mkdir(filePath);
}
const files = await fs.readdir(filePath);
return files.map((f) => f.replace(/\.md$/, ""));
},
async getPageNames(courseName: string, moduleName: string) {
const filePath = path.join(basePath, courseName, moduleName, "pages");
if (!(await directoryOrFileExists(filePath))) {
console.log(
`Error loading course by name, pages folder does not exist in ${filePath}`
);
await fs.mkdir(filePath);
}
const files = await fs.readdir(filePath);
return files.map((f) => f.replace(/\.md$/, ""));
},
async getAssignment(
courseName: string,
moduleName: string,
@@ -185,7 +166,20 @@ export const fileStorageService = {
console.log(`Saving assignment ${filePath}`);
await fs.writeFile(filePath, assignmentMarkdown);
},
},
quizzes: {
async getQuizNames(courseName: string, moduleName: string) {
const filePath = path.join(basePath, courseName, moduleName, "quizzes");
if (!(await directoryOrFileExists(filePath))) {
console.log(
`Error loading course by name, quiz folder does not exist in ${filePath}`
);
await fs.mkdir(filePath);
}
const files = await fs.readdir(filePath);
return files.map((f) => f.replace(/\.md$/, ""));
},
async getQuiz(courseName: string, moduleName: string, quizName: string) {
const filePath = path.join(
basePath,
@@ -219,6 +213,20 @@ export const fileStorageService = {
console.log(`Saving quiz ${filePath}`);
await fs.writeFile(filePath, quizMarkdown);
},
},
pages: {
async getPageNames(courseName: string, moduleName: string) {
const filePath = path.join(basePath, courseName, moduleName, "pages");
if (!(await directoryOrFileExists(filePath))) {
console.log(
`Error loading course by name, pages folder does not exist in ${filePath}`
);
await fs.mkdir(filePath);
}
const files = await fs.readdir(filePath);
return files.map((f) => f.replace(/\.md$/, ""));
},
async getPage(courseName: string, moduleName: string, pageName: string) {
const filePath = path.join(
@@ -265,6 +273,7 @@ export const fileStorageService = {
await fs.unlink(oldFilePath);
}
},
},
async getEmptyDirectories(): Promise<string[]> {
if (!(await directoryOrFileExists(basePath))) {

1156
nextjs/src/services/tests/courseDifferenceChanges.test.ts
View File

File diff suppressed because it is too large Load Diff

886
nextjs/src/services/tests/courseDifferencesDeletions.test.ts
View File

@@ -3,449 +3,449 @@ import { LocalCourse } from "@/models/local/localCourse";
import { CourseDifferences } from "../fileStorage/utils/courseDifferences";
describe("CourseDifferencesDeletionsTests", () => {
it("same module does not get deleted", () => {
const oldCourse: LocalCourse = {
settings: {
name: "test course",
assignmentGroups: [],
daysOfWeek: [],
startDate: "07/09/2024 23:59:00",
endDate: "07/09/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: [],
},
],
};
// it("same module does not get deleted", () => {
// const oldCourse: LocalCourse = {
// settings: {
// name: "test course",
// assignmentGroups: [],
// daysOfWeek: [],
// startDate: "07/09/2024 23:59:00",
// endDate: "07/09/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
);
// const differences = CourseDifferences.getDeletedChanges(
// newCourse,
// oldCourse
// );
expect(differences.namesOfModulesToDeleteCompletely).toHaveLength(0);
});
it("changed module - old one gets deleted", () => {
const oldCourse: LocalCourse = {
settings: {
name: "test course",
assignmentGroups: [],
daysOfWeek: [],
startDate: "07/09/2024 23:59:00",
endDate: "07/09/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: {
name: "test course",
assignmentGroups: [],
daysOfWeek: [],
startDate: "07/09/2024 23:59:00",
endDate: "07/09/2024 23:59:00",
defaultDueTime: {
hour: 23,
minute: 59,
},
},
modules: [
{
name: "test module",
assignments: [
{
name: "test assignment",
description: "test description",
dueAt: "07/09/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: "07/09/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: {
name: "test course",
assignmentGroups: [],
daysOfWeek: [],
startDate: "07/09/2024 23:59:00",
endDate: "07/09/2024 23:59:00",
defaultDueTime: {
hour: 23,
minute: 59,
},
},
modules: [
{
name: "test module",
assignments: [
{
name: "test assignment",
description: "test description",
dueAt: "07/09/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: "07/09/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: {
name: "test course",
assignmentGroups: [],
daysOfWeek: [],
startDate: "07/09/2024 23:59:00",
endDate: "07/09/2024 23:59:00",
defaultDueTime: {
hour: 23,
minute: 59,
},
},
modules: [
{
name: "test module",
assignments: [
{
name: "test assignment",
description: "test description",
dueAt: "07/09/2024 23:59:00",
submissionTypes: [],
allowedFileUploadExtensions: [],
rubric: [],
},
{
name: "test assignment 2",
description: "test description",
dueAt: "07/09/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: "07/09/2024 23:59:00",
submissionTypes: [],
allowedFileUploadExtensions: [],
rubric: [],
},
{
name: "test assignment 2 changed",
description: "test description",
dueAt: "07/09/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: {
name: "test course",
assignmentGroups: [],
daysOfWeek: [],
startDate: "07/09/2024 23:59:00",
endDate: "07/09/2024 23:59:00",
defaultDueTime: {
hour: 23,
minute: 59,
},
},
modules: [
{
name: "test module",
assignments: [],
quizzes: [
{
name: "Test Quiz",
description: "test description",
dueAt: "07/09/2024 23:59:00",
shuffleAnswers: false,
showCorrectAnswers: false,
oneQuestionAtATime: false,
allowedAttempts: 0,
questions: [],
},
{
name: "Test Quiz 2",
description: "test description",
dueAt: "07/09/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: "07/09/2024 23:59:00",
shuffleAnswers: false,
showCorrectAnswers: false,
oneQuestionAtATime: false,
allowedAttempts: 0,
questions: [],
},
{
name: "Test Quiz 3",
description: "test description",
dueAt: "07/09/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: {
name: "test course",
assignmentGroups: [],
daysOfWeek: [],
startDate: "07/09/2024 23:59:00",
endDate: "07/09/2024 23:59:00",
defaultDueTime: {
hour: 23,
minute: 59,
},
},
modules: [
{
name: "test module",
assignments: [],
quizzes: [],
pages: [
{
name: "Test Page",
text: "test contents",
dueAt: "07/09/2024 23:59:00",
},
{
name: "Test Page 2",
text: "test contents",
dueAt: "07/09/2024 23:59:00",
},
],
},
],
};
const newCourse: LocalCourse = {
...oldCourse,
modules: [
{
name: "test module",
assignments: [],
quizzes: [],
pages: [
{
name: "Test Page",
text: "test contents",
dueAt: "07/09/2024 23:59:00",
},
{
name: "Test Page 3",
text: "test contents",
dueAt: "07/09/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"
);
});
// expect(differences.namesOfModulesToDeleteCompletely).toHaveLength(0);
// });
// it("changed module - old one gets deleted", () => {
// const oldCourse: LocalCourse = {
// settings: {
// name: "test course",
// assignmentGroups: [],
// daysOfWeek: [],
// startDate: "07/09/2024 23:59:00",
// endDate: "07/09/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: {
// name: "test course",
// assignmentGroups: [],
// daysOfWeek: [],
// startDate: "07/09/2024 23:59:00",
// endDate: "07/09/2024 23:59:00",
// defaultDueTime: {
// hour: 23,
// minute: 59,
// },
// },
// modules: [
// {
// name: "test module",
// assignments: [
// {
// name: "test assignment",
// description: "test description",
// dueAt: "07/09/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: "07/09/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: {
// name: "test course",
// assignmentGroups: [],
// daysOfWeek: [],
// startDate: "07/09/2024 23:59:00",
// endDate: "07/09/2024 23:59:00",
// defaultDueTime: {
// hour: 23,
// minute: 59,
// },
// },
// modules: [
// {
// name: "test module",
// assignments: [
// {
// name: "test assignment",
// description: "test description",
// dueAt: "07/09/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: "07/09/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: {
// name: "test course",
// assignmentGroups: [],
// daysOfWeek: [],
// startDate: "07/09/2024 23:59:00",
// endDate: "07/09/2024 23:59:00",
// defaultDueTime: {
// hour: 23,
// minute: 59,
// },
// },
// modules: [
// {
// name: "test module",
// assignments: [
// {
// name: "test assignment",
// description: "test description",
// dueAt: "07/09/2024 23:59:00",
// submissionTypes: [],
// allowedFileUploadExtensions: [],
// rubric: [],
// },
// {
// name: "test assignment 2",
// description: "test description",
// dueAt: "07/09/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: "07/09/2024 23:59:00",
// submissionTypes: [],
// allowedFileUploadExtensions: [],
// rubric: [],
// },
// {
// name: "test assignment 2 changed",
// description: "test description",
// dueAt: "07/09/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: {
// name: "test course",
// assignmentGroups: [],
// daysOfWeek: [],
// startDate: "07/09/2024 23:59:00",
// endDate: "07/09/2024 23:59:00",
// defaultDueTime: {
// hour: 23,
// minute: 59,
// },
// },
// modules: [
// {
// name: "test module",
// assignments: [],
// quizzes: [
// {
// name: "Test Quiz",
// description: "test description",
// dueAt: "07/09/2024 23:59:00",
// shuffleAnswers: false,
// showCorrectAnswers: false,
// oneQuestionAtATime: false,
// allowedAttempts: 0,
// questions: [],
// },
// {
// name: "Test Quiz 2",
// description: "test description",
// dueAt: "07/09/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: "07/09/2024 23:59:00",
// shuffleAnswers: false,
// showCorrectAnswers: false,
// oneQuestionAtATime: false,
// allowedAttempts: 0,
// questions: [],
// },
// {
// name: "Test Quiz 3",
// description: "test description",
// dueAt: "07/09/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: {
// name: "test course",
// assignmentGroups: [],
// daysOfWeek: [],
// startDate: "07/09/2024 23:59:00",
// endDate: "07/09/2024 23:59:00",
// defaultDueTime: {
// hour: 23,
// minute: 59,
// },
// },
// modules: [
// {
// name: "test module",
// assignments: [],
// quizzes: [],
// pages: [
// {
// name: "Test Page",
// text: "test contents",
// dueAt: "07/09/2024 23:59:00",
// },
// {
// name: "Test Page 2",
// text: "test contents",
// dueAt: "07/09/2024 23:59:00",
// },
// ],
// },
// ],
// };
// const newCourse: LocalCourse = {
// ...oldCourse,
// modules: [
// {
// name: "test module",
// assignments: [],
// quizzes: [],
// pages: [
// {
// name: "Test Page",
// text: "test contents",
// dueAt: "07/09/2024 23:59:00",
// },
// {
// name: "Test Page 3",
// text: "test contents",
// dueAt: "07/09/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"
// );
// });
});

8
nextjs/src/services/tests/fileStorage.test.ts
View File

@@ -32,9 +32,9 @@ describe("FileStorageTests", () => {
canvasId: 0,
};
await fileStorageService.updateCourseSettings(name, settings);
await fileStorageService.settings.updateCourseSettings(name, settings);
const loadedSettings = await fileStorageService.getCourseSettings(name);
const loadedSettings = await fileStorageService.settings.getCourseSettings(name);
expect(loadedSettings).toEqual(settings);
});
@@ -43,9 +43,9 @@ describe("FileStorageTests", () => {
const courseName = "test empty course";
const moduleName = "test module 1";
await fileStorageService.createModule(courseName, moduleName);
await fileStorageService.modules.createModule(courseName, moduleName);
const moduleNames = await fileStorageService.getModuleNames(courseName);
const moduleNames = await fileStorageService.modules.getModuleNames(courseName);
expect(moduleNames).toContain(moduleName);
});