canvas crud on pages

This commit is contained in:
2024-09-10 09:00:58 -06:00
parent f94dcca904
commit edb2761de7
6 changed files with 311 additions and 93 deletions

View File

@@ -1,16 +1,22 @@
import { NextRequest, NextResponse } from "next/server"; import { NextRequest, NextResponse } from "next/server";
import { axiosClient } from "@/services/axiosUtils"; import { axiosClient } from "@/services/axiosUtils";
import { withErrorHandling } from "@/services/withErrorHandling";
const getUrl = (params: { rest: string[] }) => {
const { rest } = params;
const path = rest.join("/");
const newUrl = `https://snow.instructure.com/api/v1/${path}`;
return newUrl;
};
export async function GET( export async function GET(
req: NextRequest, req: NextRequest,
{ params }: { params: { rest: string[] } } { params }: { params: { rest: string[] } }
) { ) {
const { rest } = params; return withErrorHandling(async () => {
const path = rest.join("/");
try { try {
const newUrl = `https://snow.instructure.com/api/v1/${path}`; const url = getUrl(params);
const response = await axiosClient.get(newUrl, { const response = await axiosClient.get(url, {
headers: { headers: {
// Include other headers from the incoming request if needed: // Include other headers from the incoming request if needed:
// 'Content-Type': req.headers.get('content-type') || 'application/json', // 'Content-Type': req.headers.get('content-type') || 'application/json',
@@ -21,8 +27,68 @@ export async function GET(
return NextResponse.json(response.data); return NextResponse.json(response.data);
} catch (error: any) { } catch (error: any) {
return new NextResponse( return new NextResponse(
JSON.stringify({ error: error.message || "Request failed" }), JSON.stringify({ error: error.message || "Canvas get request failed" }),
{ status: error.response?.status || 500 } { status: error.response?.status || 500 }
); );
} }
});
}
export async function POST(
req: NextRequest,
{ params }: { params: { rest: string[] } }
) {
return withErrorHandling(async () => {
try {
const url = getUrl(params);
const body = await req.json();
const response = await axiosClient.post(url, body);
return NextResponse.json(response.data);
} catch (error: any) {
return new NextResponse(
JSON.stringify({
error: error.message || "Canvas post request failed",
}),
{ status: error.response?.status || 500 }
);
}
});
}
export async function PUT(
req: NextRequest,
{ params }: { params: { rest: string[] } }
) {
return withErrorHandling(async () => {
try {
const url = getUrl(params);
const body = await req.json();
const response = await axiosClient.put(url, body);
return NextResponse.json(response.data);
} catch (error: any) {
return new NextResponse(
JSON.stringify({ error: error.message || "Canvas put request failed" }),
{ status: error.response?.status || 500 }
);
}
});
}
export async function DELETE(
req: NextRequest,
{ params }: { params: { rest: string[] } }
) {
return withErrorHandling(async () => {
try {
const url = getUrl(params);
const response = await axiosClient.delete(url);
return NextResponse.json(response.data);
} catch (error: any) {
return new NextResponse(
JSON.stringify({
error: error.message || "Canvas delete request failed",
}),
{ status: error.response?.status || 500 }
);
}
});
} }

View File

@@ -9,7 +9,12 @@ import { localPageMarkdownUtils } from "@/models/local/page/localCoursePage";
import { useEffect, useState } from "react"; import { useEffect, useState } from "react";
import PagePreview from "./PagePreview"; import PagePreview from "./PagePreview";
import { useLocalCourseSettingsQuery } from "@/hooks/localCourse/localCoursesHooks"; import { useLocalCourseSettingsQuery } from "@/hooks/localCourse/localCoursesHooks";
import { useCanvasPagesQuery } from "@/hooks/canvas/canvasPageHooks"; import {
useCanvasPagesQuery,
useCreateCanvasPageMutation,
} from "@/hooks/canvas/canvasPageHooks";
import { Spinner } from "@/components/Spinner";
import EditPageButtons from "./EditPageButtons";
export default function EditPage({ export default function EditPage({
moduleName, moduleName,
@@ -26,9 +31,6 @@ export default function EditPage({
const [error, setError] = useState(""); const [error, setError] = useState("");
const { data: settings } = useLocalCourseSettingsQuery(); const { data: settings } = useLocalCourseSettingsQuery();
const { data: canvasPages } = useCanvasPagesQuery(settings.canvasId ?? 0);
console.log("canvas pages", canvasPages);
const pageInCanvas = canvasPages?.find((p) => p.title === pageName);
useEffect(() => { useEffect(() => {
const delay = 500; const delay = 500;
@@ -70,17 +72,13 @@ export default function EditPage({
</div> </div>
</div> </div>
</div> </div>
<div className="p-5 flex flex-row"> {settings.canvasId && (
{pageInCanvas && ( <EditPageButtons
<a pageName={pageName}
target="_blank" moduleName={moduleName}
href={`https://snow.instructure.com/courses/${settings.canvasId}/pages/${pageInCanvas.page_id}`} courseCanvasId={settings.canvasId}
> />
View Page In Canvas
</a>
)} )}
<button>Add to canvas</button>
</div>
</div> </div>
); );
} }

View File

@@ -0,0 +1,75 @@
import { Spinner } from "@/components/Spinner";
import {
useCanvasPagesQuery,
useCreateCanvasPageMutation,
useDeleteCanvasPageMutation,
useUpdateCanvasPageMutation,
} from "@/hooks/canvas/canvasPageHooks";
import { usePageQuery } from "@/hooks/localCourse/pageHooks";
import React from "react";
export default function EditPageButtons({
moduleName,
pageName,
courseCanvasId,
}: {
pageName: string;
moduleName: string;
courseCanvasId: number;
}) {
const { data: page } = usePageQuery(moduleName, pageName);
const { data: canvasPages } = useCanvasPagesQuery(courseCanvasId);
const createPageInCanvas = useCreateCanvasPageMutation(courseCanvasId);
const updatePageInCanvas = useUpdateCanvasPageMutation(courseCanvasId);
const deletePageInCanvas = useDeleteCanvasPageMutation(courseCanvasId);
const pageInCanvas = canvasPages?.find((p) => p.title === pageName);
const requestIsPending =
createPageInCanvas.isPending ||
updatePageInCanvas.isPending ||
deletePageInCanvas.isPending;
return (
<div className="p-5 flex flex-row gap-x-3">
{pageInCanvas && (
<a
target="_blank"
href={`https://snow.instructure.com/courses/${courseCanvasId}/pages/${pageInCanvas.page_id}`}
>
View Page In Canvas
</a>
)}
{!pageInCanvas && (
<button
onClick={() => createPageInCanvas.mutate(page)}
disabled={requestIsPending}
>
Add to Canvas
</button>
)}
{pageInCanvas && (
<button
onClick={() =>
updatePageInCanvas.mutate({
page,
canvasPageId: pageInCanvas.page_id,
})
}
disabled={requestIsPending}
>
Update in Canvas
</button>
)}
{pageInCanvas && (
<button
onClick={() => deletePageInCanvas.mutate(pageInCanvas.page_id)}
disabled={requestIsPending}
>
Delete from Canvas
</button>
)}
{requestIsPending && <Spinner />}
</div>
);
}

View File

@@ -1,5 +1,6 @@
import { LocalCoursePage } from "@/models/local/page/localCoursePage";
import { canvasPageService } from "@/services/canvas/canvasPageService"; import { canvasPageService } from "@/services/canvas/canvasPageService";
import { useQuery } from "@tanstack/react-query"; import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
export const canvasPageKeys = { export const canvasPageKeys = {
pagesInCourse: (canvasCourseId: number) => [ pagesInCourse: (canvasCourseId: number) => [
@@ -14,3 +15,47 @@ export const useCanvasPagesQuery = (canvasCourseId: number) =>
queryKey: canvasPageKeys.pagesInCourse(canvasCourseId), queryKey: canvasPageKeys.pagesInCourse(canvasCourseId),
queryFn: async () => await canvasPageService.getAll(canvasCourseId), queryFn: async () => await canvasPageService.getAll(canvasCourseId),
}); });
export const useCreateCanvasPageMutation = (canvasCourseId: number) => {
const queryClient = useQueryClient();
return useMutation({
mutationFn: async (page: LocalCoursePage) =>
canvasPageService.create(canvasCourseId, page),
onSuccess: () => {
queryClient.invalidateQueries({
queryKey: canvasPageKeys.pagesInCourse(canvasCourseId),
});
},
});
};
export const useUpdateCanvasPageMutation = (canvasCourseId: number) => {
const queryClient = useQueryClient();
return useMutation({
mutationFn: async ({
page,
canvasPageId,
}: {
page: LocalCoursePage;
canvasPageId: number;
}) => canvasPageService.update(canvasCourseId, canvasPageId, page),
onSuccess: () => {
queryClient.invalidateQueries({
queryKey: canvasPageKeys.pagesInCourse(canvasCourseId),
});
},
});
};
export const useDeleteCanvasPageMutation = (canvasCourseId: number) => {
const queryClient = useQueryClient();
return useMutation({
mutationFn: async (canvasPageId: number) =>
canvasPageService.delete(canvasCourseId, canvasPageId),
onSuccess: () => {
queryClient.invalidateQueries({
queryKey: canvasPageKeys.pagesInCourse(canvasCourseId),
});
},
});
};

View File

@@ -1,6 +1,9 @@
import { CanvasPage } from "@/models/canvas/pages/canvasPageModel"; import { CanvasPage } from "@/models/canvas/pages/canvasPageModel";
import { LocalCoursePage } from "@/models/local/page/localCoursePage"; import { LocalCoursePage } from "@/models/local/page/localCoursePage";
import { canvasServiceUtils } from "./canvasServiceUtils"; import { canvasServiceUtils } from "./canvasServiceUtils";
import { markdownToHTMLSafe } from "../htmlMarkdownUtils";
import { axiosClient } from "../axiosUtils";
import { rateLimitAwareDelete } from "./canvasWebRequestor";
const baseCanvasUrl = "https://snow.instructure.com/api/v1"; const baseCanvasUrl = "https://snow.instructure.com/api/v1";
@@ -14,52 +17,45 @@ export const canvasPageService = {
return pages.flatMap((pageList) => pageList); return pages.flatMap((pageList) => pageList);
}, },
// async create(canvasCourseId: number, localCourse: LocalCoursePage): Promise<CanvasPage> { async create(
// console.log(`Creating course page: ${localCourse.name}`); canvasCourseId: number,
// const url = `courses/${canvasCourseId}/pages`; page: LocalCoursePage
// const body = { ): Promise<CanvasPage> {
// wiki_page: { console.log(`Creating course page: ${page.name}`);
// title: localCourse.name, const url = `${baseCanvasUrl}/courses/${canvasCourseId}/pages`;
// body: localCourse.getBodyHtml(), const body = {
// }, wiki_page: {
// }; title: page.name,
body: markdownToHTMLSafe(page.text),
// const { canvasPage, response } = await webRequestor.post<CanvasPage>({ },
// url, };
// body,
// }); const { data: canvasPage } = await axiosClient.post<CanvasPage>(url, body);
if (!canvasPage) {
// if (!canvasPage) { throw new Error("Created canvas course page was null");
// throw new Error("Created canvas course page was null"); }
// } return canvasPage;
},
// return canvasPage;
// }, async update(
courseId: number,
// async update(courseId: number, canvasPageId: number, localCoursePage: LocalCoursePage): Promise<void> { canvasPageId: number,
// console.log(`Updating course page: ${localCoursePage.name}`); page: LocalCoursePage
// const url = `courses/${courseId}/pages/${canvasPageId}`; ): Promise<void> {
// const body = { console.log(`Updating course page: ${page.name}`);
// wiki_page: { const url = `${baseCanvasUrl}/courses/${courseId}/pages/${canvasPageId}`;
// title: localCoursePage.name, const body = {
// body: localCoursePage.getBodyHtml(), wiki_page: {
// }, title: page.name,
// }; body: markdownToHTMLSafe(page.text),
},
// await webRequestor.put({ };
// url, await axiosClient.put(url, body);
// body, },
// });
// }, async delete(courseId: number, canvasPageId: number): Promise<void> {
console.log(`Deleting page from canvas ${canvasPageId}`);
// async delete(courseId: number, canvasPageId: number): Promise<void> { const url = `${baseCanvasUrl}/courses/${courseId}/pages/${canvasPageId}`;
// console.log(`Deleting page from canvas ${canvasPageId}`); await rateLimitAwareDelete(url);
// const url = `courses/${courseId}/pages/${canvasPageId}`; },
// const response = await webRequestor.delete({ url });
// if (!response.isSuccessful) {
// console.error(url);
// throw new Error("Failed to delete canvas course page");
// }
// },
}; };

View File

@@ -9,9 +9,18 @@ import {
directoryOrFileExists, directoryOrFileExists,
hasFileSystemEntries, hasFileSystemEntries,
} from "./utils/fileSystemUtils"; } from "./utils/fileSystemUtils";
import { LocalAssignment, localAssignmentMarkdown } from "@/models/local/assignment/localAssignment"; import {
import { LocalQuiz, localQuizMarkdownUtils } from "@/models/local/quiz/localQuiz"; LocalAssignment,
import { LocalCoursePage, localPageMarkdownUtils } from "@/models/local/page/localCoursePage"; localAssignmentMarkdown,
} from "@/models/local/assignment/localAssignment";
import {
LocalQuiz,
localQuizMarkdownUtils,
} from "@/models/local/quiz/localQuiz";
import {
LocalCoursePage,
localPageMarkdownUtils,
} from "@/models/local/page/localCoursePage";
import { quizMarkdownUtils } from "@/models/local/quiz/utils/quizMarkdownUtils"; import { quizMarkdownUtils } from "@/models/local/quiz/utils/quizMarkdownUtils";
import { assignmentMarkdownSerializer } from "@/models/local/assignment/utils/assignmentMarkdownSerializer"; import { assignmentMarkdownSerializer } from "@/models/local/assignment/utils/assignmentMarkdownSerializer";
@@ -90,7 +99,7 @@ export const fileStorageService = {
} }
const assignmentFiles = await fs.readdir(filePath); const assignmentFiles = await fs.readdir(filePath);
return assignmentFiles.map(f => f.replace(/\.md$/, '')); return assignmentFiles.map((f) => f.replace(/\.md$/, ""));
}, },
async getQuizNames(courseName: string, moduleName: string) { async getQuizNames(courseName: string, moduleName: string) {
@@ -103,7 +112,7 @@ export const fileStorageService = {
} }
const files = await fs.readdir(filePath); const files = await fs.readdir(filePath);
return files.map(f => f.replace(/\.md$/, '')); return files.map((f) => f.replace(/\.md$/, ""));
}, },
async getPageNames(courseName: string, moduleName: string) { async getPageNames(courseName: string, moduleName: string) {
@@ -116,7 +125,7 @@ export const fileStorageService = {
} }
const files = await fs.readdir(filePath); const files = await fs.readdir(filePath);
return files.map(f => f.replace(/\.md$/, '')); return files.map((f) => f.replace(/\.md$/, ""));
}, },
async getAssignment( async getAssignment(
@@ -137,7 +146,12 @@ export const fileStorageService = {
); );
return localAssignmentMarkdown.parseMarkdown(rawFile); return localAssignmentMarkdown.parseMarkdown(rawFile);
}, },
async updateAssignment(courseName: string, moduleName: string, assignmentName: string, assignment: LocalAssignment) { async updateAssignment(
courseName: string,
moduleName: string,
assignmentName: string,
assignment: LocalAssignment
) {
const filePath = path.join( const filePath = path.join(
basePath, basePath,
courseName, courseName,
@@ -146,7 +160,8 @@ export const fileStorageService = {
assignmentName + ".md" assignmentName + ".md"
); );
const assignmentMarkdown = assignmentMarkdownSerializer.toMarkdown(assignment); const assignmentMarkdown =
assignmentMarkdownSerializer.toMarkdown(assignment);
console.log(`Saving assignment ${filePath}`); console.log(`Saving assignment ${filePath}`);
await fs.writeFile(filePath, assignmentMarkdown); await fs.writeFile(filePath, assignmentMarkdown);
}, },
@@ -166,7 +181,12 @@ export const fileStorageService = {
return localQuizMarkdownUtils.parseMarkdown(rawFile); return localQuizMarkdownUtils.parseMarkdown(rawFile);
}, },
async updateQuiz(courseName: string, moduleName: string, quizName: string, quiz: LocalQuiz) { async updateQuiz(
courseName: string,
moduleName: string,
quizName: string,
quiz: LocalQuiz
) {
const filePath = path.join( const filePath = path.join(
basePath, basePath,
courseName, courseName,
@@ -194,18 +214,36 @@ export const fileStorageService = {
); );
return localPageMarkdownUtils.parseMarkdown(rawFile); return localPageMarkdownUtils.parseMarkdown(rawFile);
}, },
async updatePage(courseName: string, moduleName: string, pageName: string, page: LocalCoursePage) { async updatePage(
courseName: string,
moduleName: string,
pageName: string,
page: LocalCoursePage
) {
const filePath = path.join( const filePath = path.join(
basePath,
courseName,
moduleName,
"pages",
page.name + ".md"
);
const pageMarkdown = localPageMarkdownUtils.toMarkdown(page);
console.log(`Saving page ${filePath}`);
await fs.writeFile(filePath, pageMarkdown);
const pageNameIsChanged = pageName !== page.name;
if (pageNameIsChanged) {
console.log("removing old page after name change " + pageName);
const oldFilePath = path.join(
basePath, basePath,
courseName, courseName,
moduleName, moduleName,
"pages", "pages",
pageName + ".md" pageName + ".md"
); );
await fs.unlink(oldFilePath);
const pageMarkdown = localPageMarkdownUtils.toMarkdown(page); }
console.log(`Saving page ${filePath}`);
await fs.writeFile(filePath, pageMarkdown);
}, },
async getEmptyDirectories(): Promise<string[]> { async getEmptyDirectories(): Promise<string[]> {