Test pages types overhaul #2209
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,7 @@ | ||
| import { | ||
| ContentDTO, | ||
| DetailedQuizSummaryDTO, | ||
| IsaacQuizDTO, | ||
| IsaacQuizSectionDTO, | ||
| QuestionDTO, | ||
| QuizAttemptDTO, | ||
|
|
@@ -17,8 +19,6 @@ import { | |
| isTeacherOrAbove, | ||
| QUIZ_VIEW_STUDENT_ANSWERS_RELEASE_TIMESTAMP, | ||
| siteSpecific, | ||
| useDeviceSize | ||
| } from "../../../services"; | ||
| import {Spacer} from "../Spacer"; | ||
|
|
@@ -35,42 +35,43 @@ import {EditContentButton} from "../EditContentButton"; | |
| import {Markup} from "../markup"; | ||
| import classNames from "classnames"; | ||
| import { MainContent, SidebarLayout } from "../layout/SidebarLayout"; | ||
| import { QuizSidebar, QuizSidebarProps } from "../sidebar/QuizSidebar"; | ||
|
|
||
| type QuizContents = { | ||
| questions: QuestionDTO[]; | ||
| sections: { [id: string]: IsaacQuizSectionDTO }; | ||
| pageLink: (page?: number) => string; | ||
| }; | ||
|
|
||
| export type FullQuizInfo = { | ||
| quiz: IsaacQuizDTO; | ||
| attempt: QuizAttemptDTO; | ||
| quizContents: QuizContents; | ||
| }; | ||
|
|
||
| export type QuizSummaryInfo = { | ||
| quiz: DetailedQuizSummaryDTO; | ||
| } | ||
|
|
||
| export type QuizProps = { | ||
| user: RegisteredUserDTO; | ||
| pageHelp: React.ReactElement; | ||
| studentUser?: UserSummaryDTO; | ||
| quizAssignmentId?: string; | ||
| preview?: boolean; | ||
| page?: number; | ||
| } & (FullQuizInfo | QuizSummaryInfo); | ||
|
|
||
| const isFullQuizProps = (props: QuizProps): props is QuizProps & FullQuizInfo => { | ||
| return isDefined((props as QuizProps & FullQuizInfo).attempt); | ||
| }; | ||
|
|
||
|
|
||
| function inSection(section: IsaacQuizSectionDTO, questions: QuestionDTO[]) { | ||
| return questions.filter(q => q.id?.startsWith(section.id as string + "|")); | ||
| } | ||
|
|
||
| function QuizDetails({quizContents: {sections, questions, pageLink}, attempt}: FullQuizInfo) { | ||
| if (isDefined(attempt.completedDate)) { | ||
| return attempt.feedbackMode === "NONE" ? | ||
| <h4>No feedback available</h4> | ||
|
|
@@ -123,18 +124,19 @@ function QuizDetails({attempt, sections, questions, pageLink}: QuizAttemptProps) | |
| } | ||
| } | ||
|
|
||
| function QuizHeader(quizProps: QuizProps) { | ||
|
|
||
| if (!isFullQuizProps(quizProps) && !quizProps.preview) { | ||
| return <p data-testid="quiz-action">You are freely attempting this test.</p>; | ||
| } | ||
|
|
||
| const {quiz, preview, attempt} = quizProps as QuizProps & FullQuizInfo; | ||
|
|
||
| if (preview) { | ||
| return <> | ||
| <EditContentButton doc={quiz} /> | ||
| <div data-testid="quiz-action"> | ||
| <p>You are previewing this test.</p> | ||
| </div> | ||
| </>; | ||
| } else if (isDefined(attempt.quizAssignment)) { | ||
|
|
@@ -165,41 +167,39 @@ function QuizHeader({attempt, preview, view, user}: QuizAttemptProps | QuizViewP | |
| } | ||
| } | ||
|
|
||
| function QuizRubric({rubric}: {rubric?: ContentDTO}) { | ||
| const renderRubric = (rubric?.children || []).length > 0; | ||
| return rubric && renderRubric && <div data-testid="quiz-rubric"> | ||
| <IsaacContentValueOrChildren value={rubric.value}> | ||
| {rubric.children} | ||
| </IsaacContentValueOrChildren> | ||
| </div>; | ||
| } | ||
|
|
||
| export function QuizRubricButton({rubric}: {rubric?: ContentDTO}) { | ||
| const dispatch = useAppDispatch(); | ||
|
|
||
| const openQuestionModal = () => { | ||
| dispatch(openActiveModal({ | ||
| closeAction: () => {dispatch(closeActiveModal());}, size: "lg", | ||
| title: "Test Instructions", body: <QuizRubric rubric={rubric} /> | ||
| })); | ||
| }; | ||
|
|
||
| if (rubric) { | ||
| return <Button color={siteSpecific("keyline", "tertiary")} outline={isAda} className={siteSpecific("btn-lg text-nowrap", "mb-4 bg-light")} | ||
| title="Show instructions in a modal" onClick={openQuestionModal} | ||
| > | ||
| Show instructions | ||
| </Button>; | ||
| } | ||
| } | ||
|
|
||
| function QuizSection(quizProps: QuizProps & FullQuizInfo) { | ||
| const {attempt, page, studentUser, user, quizAssignmentId} = quizProps; | ||
| const deviceSize = useDeviceSize(); | ||
| const sections = attempt.quiz?.children; | ||
| const section = !!(page && sections) && sections[page - 1]; | ||
| const attribution = attempt.quiz?.attribution; | ||
| const viewingAsSomeoneElse = isDefined(studentUser) && studentUser?.id !== user?.id; | ||
|
|
||
|
|
@@ -212,7 +212,7 @@ function QuizSection({attempt, page, studentUser, user, quizAssignmentId}: QuizA | |
| <Row> | ||
| <Col className="d-flex flex-column align-items-end"> | ||
| {(isAda || above["lg"](deviceSize)) && <div className="mb-3"> | ||
| <QuizRubricButton rubric={attempt.quiz?.rubric} /> | ||
| </div>} | ||
| </Col> | ||
| </Row> | ||
|
|
@@ -236,34 +236,48 @@ function QuizSection({attempt, page, studentUser, user, quizAssignmentId}: QuizA | |
| export const myQuizzesCrumbs = [{title: siteSpecific("My tests", "Tests"), to: `/tests`}]; | ||
| export const teacherQuizzesCrumbs = [{title: siteSpecific("Set / manage tests", "Tests"), to: `/set_tests`}]; | ||
| export const rubricCrumbs = [{title: "Practice tests", to: "/practice_tests"}]; | ||
| export const viewQuizzesCrumbs = [{title: "View tests", to: "/view_tests"}]; | ||
|
Contributor
There was a problem hiding this comment. I'd comment out this line too, as this is just an unused variable until we implement the TODO. A pity that eslint doesn't detect unused exports!
Contributor
Author
There was a problem hiding this comment. If we comment it out, we'll need to uncomment it when we do the merge which uses this (#2228). I'm not intending one to exist in main without the other, so yes while I shouldn't have added this on this branch, now it's here let's just leave it. |
||
| const getCrumbs = (preview: boolean | undefined, isFreeAttempt: boolean, user: RegisteredUserDTO) => { | ||
| if (preview && isTeacherOrAbove(user)) { | ||
| return teacherQuizzesCrumbs; | ||
| } | ||
| // TODO adjust with changes to test pages – remove isFreeAttempt entirely, just use viewQuizzesCrumbs from here down | ||
| // return viewQuizzesCrumbs; | ||
| if (isFreeAttempt) { | ||
| return rubricCrumbs; | ||
| } | ||
| return myQuizzesCrumbs; | ||
| }; | ||
|
|
||
| const generateQuizTitle = (quiz: IsaacQuizDTO | DetailedQuizSummaryDTO | undefined, preview: boolean | undefined, attempt: QuizAttemptDTO | undefined, studentUser: RegisteredUserDTO | undefined) => { | ||
| let quizTitle = quiz?.title || quiz?.id || "Test"; | ||
| if (preview) { | ||
| return `${quizTitle} Preview`; | ||
| } | ||
|
|
||
| if (isDefined(attempt?.completedDate)) { | ||
| quizTitle += " Feedback"; | ||
| } | ||
| if (isDefined(studentUser)) { | ||
| quizTitle += ` for ${studentUser.givenName} ${studentUser.familyName}`; | ||
| } | ||
|
|
||
| return quizTitle; | ||
| }; | ||
|
|
||
| const QuizTitle = (quizProps: QuizProps) => { | ||
| const {page, pageHelp, preview, studentUser, user, quiz} = quizProps as QuizProps; | ||
|
|
||
| const crumbs = getCrumbs(preview, window.location.pathname.includes('/view/'), user); | ||
| if (!isDefined(page) || !isFullQuizProps(quizProps)) { | ||
| const quizTitle = generateQuizTitle(quiz, preview, undefined, studentUser); | ||
| return <TitleAndBreadcrumb currentPageTitle={quizTitle} help={pageHelp} | ||
| intermediateCrumbs={crumbs} icon={{"type": "icon", "icon": "icon-tests"}} | ||
| />; | ||
| } else { | ||
| const {attempt, quizContents: {pageLink}} = quizProps as QuizProps & FullQuizInfo; | ||
| const quizTitle = generateQuizTitle(quiz, preview, attempt, studentUser); | ||
|
|
||
| const sections = attempt.quiz?.children; | ||
| const section = sections && sections[page - 1] as IsaacQuizSectionDTO; | ||
| const sectionTitle = section?.title ?? "Section " + page; | ||
|
|
@@ -275,12 +289,13 @@ const QuizTitle = ({attempt, view, page, pageLink, pageHelp, preview, studentUse | |
| }; | ||
|
|
||
| interface QuizPaginationProps { | ||
| finalLabel: string; | ||
| } | ||
|
|
||
| export function QuizPagination({page, quizContents: {sections, pageLink}, finalLabel}: QuizProps & FullQuizInfo & QuizPaginationProps) { | ||
| const deviceSize = useDeviceSize(); | ||
| if (!page) return; | ||
|
|
||
| const sectionCount = Object.keys(sections).length; | ||
| const backLink = pageLink(page > 1 ? page - 1 : undefined); | ||
| const finalSection = page === sectionCount; | ||
|
|
@@ -299,33 +314,33 @@ export enum SectionProgress { | |
| COMPLETED = "Completed" | ||
| } | ||
|
|
||
| function QuizOverview(props: QuizProps & { viewingAsSomeoneElse: boolean }) { | ||
| const {studentUser, quizAssignmentId, viewingAsSomeoneElse, quiz} = props; | ||
| return <div className="mt-4"> | ||
| {!isDefined(studentUser?.id) && <QuizHeader {...props as QuizProps & FullQuizInfo} />} | ||
| {viewingAsSomeoneElse && <div className="mb-2"> | ||
| You are viewing this test as <b>{studentUser?.givenName} {studentUser?.familyName}</b>.{quizAssignmentId && <> <Link to={`/test/assignment/${quizAssignmentId}/feedback`}>Click here</Link> to return to the teacher test feedback page.</>} | ||
| </div>} | ||
| <QuizRubric rubric={quiz.rubric}/> | ||
| {isFullQuizProps(props) && <QuizDetails {...props} />} | ||
| </div>; | ||
| } | ||
|
|
||
| function QuizQuestions(props: QuizProps & FullQuizInfo) { | ||
| // Assumes that ids of questions are defined - I don't know why this is not enforced in the editor/backend, because | ||
| // we do unchecked casts of "possibly undefined" content ids to strings almost everywhere | ||
| const questionNumbers = Object.assign({}, ...props.quizContents.questions.map((q, i) => ({[q.id as string]: i + 1}))); | ||
|
|
||
| return <QuizAttemptContext.Provider value={{quizAttempt: props.attempt, questionNumbers}}> | ||
| <QuizSection {...props} page={props.page}/> | ||
| </QuizAttemptContext.Provider>; | ||
| } | ||
|
|
||
| export function QuizContentsComponent(props: QuizProps) { | ||
| const {quiz, studentUser, user} = props; | ||
|
|
||
| const questions = isFullQuizProps(props) ? (props as QuizProps & FullQuizInfo).quizContents.questions : []; | ||
|
Contributor
There was a problem hiding this comment. we don't need these casts, that's the whole point of
Contributor
Author
There was a problem hiding this comment. Good spot. When I first wrote isFullQuiz(quiz) ? (props as QuizProps & FullQuizInfo).quizContents.questions : [];which does need the cast. |
||
| const sections = isFullQuizProps(props) ? (props as QuizProps & FullQuizInfo).quizContents.sections : {}; | ||
|
|
||
| const sectionState = (section: IsaacQuizSectionDTO) => { | ||
| const sectionQs = section ? inSection(section, questions) : undefined; | ||
|
|
@@ -336,20 +351,23 @@ export function QuizContentsComponent(props: QuizAttemptProps | QuizViewProps) { | |
|
|
||
| const viewingAsSomeoneElse = isDefined(studentUser) && studentUser?.id !== user?.id; | ||
|
|
||
| const sidebarProps: QuizSidebarProps = { | ||
| quiz, | ||
| viewingAsSomeoneElse, | ||
| totalSections: Object.keys(sections).length, | ||
| currentSection: props.page ? props.page : undefined, | ||
| sectionStates: Object.values(sections).map(section => sectionState(section)), | ||
| sectionTitles: Object.keys(sections).map(k => sections[k].title || "Section " + k), | ||
| }; | ||
|
|
||
| return <> | ||
| <QuizTitle {...props} /> | ||
| <SidebarLayout show={isPhy}> | ||
| <QuizSidebar {...sidebarProps} /> | ||
| <MainContent> | ||
| {!isDefined(props.page) | ||
| ? <QuizOverview {...props} viewingAsSomeoneElse={viewingAsSomeoneElse} /> | ||
| : <QuizQuestions {...props as QuizProps & FullQuizInfo} page={props.page} /> } | ||
| </MainContent> | ||
| </SidebarLayout> | ||
| </>; | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this can just be
page && sections && sections[page - 1]. The inferred type forsectionbecomes messier, but the check on line 206 only leavesContenBaseDtoThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It could even be
page && sections?.[page - 1];if we want extra shortening!I most likely did this as you say to tidy up the inferred type, but idrm.