test(cypress): preserve live quiz state across relogin

Author: rschlaefli

cypress/cypress/e2e/O-live-quiz-workflow.cy.ts

@@ -1065,7 +1065,7 @@ describe('Different live-quiz workflows', function () {
   it('Test the live quiz functionalities on mobile devices', function () {
     // login student again on mobile, test navigation and answer second question
     cy.viewport('iphone-x')
-    cy.loginStudent()
+    cy.loginStudent({ preserveClientState: true })
     cy.findByText(this.data.course2.quiz.displayName).should('exist').click()
     cy.findByText(this.data.NR.content, { timeout: 10000 }).should('exist')
     cy.findByText(messages.pwa.liveQuiz.allQuestionsAnswered).should(

cypress/cypress/support/commands.ts

@@ -299,27 +299,44 @@ Cypress.Commands.add('logoutUser', () => {
   cy.clearCookie('next-auth.session-token')
 })
 
-Cypress.Commands.add('loginStudent', () => {
-  cy.loginStudentPassword({ username: Cypress.env('STUDENT_USERNAME') })
+interface StudentLoginOptions {
+  preserveClientState?: boolean
+}
+
+Cypress.Commands.add('loginStudent', (options: StudentLoginOptions = {}) => {
+  cy.loginStudentPassword({
+    username: Cypress.env('STUDENT_USERNAME'),
+    preserveClientState: options.preserveClientState,
+  })
 })
 
 Cypress.Commands.add(
   'loginStudentPassword',
-  ({ username }: { username: string }) => {
+  ({
+    username,
+    preserveClientState = false,
+  }: { username: string } & StudentLoginOptions) => {
     cy.clearAllCookies()
     cy.clearAllLocalStorage()
-    cy.visit(Cypress.env('URL_STUDENT_LOGIN'), {
-      onBeforeLoad: (win) => {
-        win.localStorage.clear()
-        win.sessionStorage.clear()
-        try {
-          win.indexedDB?.deleteDatabase('localforage')
-        } catch {
-          // Fall back to the regular localforage clear after load.
-        }
-      },
-    })
-    clearPersistedClientState()
+    cy.visit(
+      Cypress.env('URL_STUDENT_LOGIN'),
+      preserveClientState
+        ? undefined
+        : {
+            onBeforeLoad: (win) => {
+              win.localStorage.clear()
+              win.sessionStorage.clear()
+              try {
+                win.indexedDB?.deleteDatabase('localforage')
+              } catch {
+                // Fall back to the regular localforage clear after load.
+              }
+            },
+          }
+    )
+    if (!preserveClientState) {
+      clearPersistedClientState()
+    }
     cy.get('[data-cy="username-field"]').click().type(username)
     cy.get('[data-cy="password-field"]')
       .click()
@@ -1844,9 +1861,12 @@ declare global {
       loginInstitutionalCatalyst3(): Chainable<void>
       loginInstitutionalCatalyst4(): Chainable<void>
       logoutUser(): Chainable<void>
-      loginStudent(): Chainable<void>
+      loginStudent(options?: StudentLoginOptions): Chainable<void>
       loginAssessmentStudent(): Chainable<void>
-      loginStudentPassword({ username }: { username: string }): Chainable<void>
+      loginStudentPassword({
+        username,
+        preserveClientState,
+      }: { username: string } & StudentLoginOptions): Chainable<void>
       createAnswerCollection({
         name,
         description,

project/CODEBASE_NOTES.md

@@ -49,6 +49,7 @@ This is a **living document**: when you discover such a pattern during a task, a
 
 - **Test environment caveats**: `pnpm run test:run` triggers Cypress which needs a running DB + seeded data. `pnpm --filter @klicker-uzh/graphql test` needs `HATCHET_CLIENT_TOKEN`. For verifying non-DB changes locally, target specific packages (e.g., `pnpm --filter @klicker-uzh/grading test`, `pnpm --filter @klicker-uzh/util test`).
 - **Cypress CI signal timing**: `cypress: default-group (merge)` can report an increasing failed-test count while `cypress-run-cloud` is still in progress; wait for `cypress-run-cloud` completion before expecting downloadable GitHub job logs. (`.github/workflows/cypress-testing.yml`)
+- **Cypress student login state**: `cy.loginStudent()` and `cy.loginStudentPassword()` clear localforage by default for test isolation. Live quiz continuation tests that intentionally rely on stored unanswered-question state should pass `{ preserveClientState: true }`. (`cypress/cypress/support/commands.ts`, `cypress/cypress/e2e/O-live-quiz-workflow.cy.ts`)
 
 ## Process & tooling