Merge pull request #726 from freeCodeCamp/main

Create a new pull request by comparing changes across two branches

Author: GulajavaMinistudio

.github/workflows/e2e-playwright.yml

@@ -157,10 +157,16 @@ jobs:
           pnpm run start-ci &
           sleep 10
           npx playwright test --project="${{ matrix.browsers }}" --grep-invert 'third-party-donation.spec.ts'
-
       - uses: actions/upload-artifact@v4
         if: ${{ !cancelled() }}
         with:
           name: playwright-report-${{ matrix.browsers }}
           path: playwright/reporter
           retention-days: 30
+      - name: Upload screenshots
+        if: failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: screenshots-${{ matrix.browsers }}
+          path: playwright/test-results
+          retention-days: 14

LICENSE.md

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2024, freeCodeCamp.
+Copyright (c) 2025, freeCodeCamp.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -263,9 +263,9 @@ The general platform status for all our applications is available at [`status.fr
 
 ### License
 
-Copyright © 2024 freeCodeCamp.org
+Copyright © 2025 freeCodeCamp.org
 
 The content of this repository is bound by the following licenses:
 
 - The computer software is licensed under the [BSD-3-Clause](LICENSE.md) license.
-- The learning resources in the [`/curriculum`](/curriculum) directory including their subdirectories thereon are copyright © 2024 freeCodeCamp.org
+- The learning resources in the [`/curriculum`](/curriculum) directory including their subdirectories thereon are copyright © 2025 freeCodeCamp.org

api/README.md

@@ -25,6 +25,16 @@ cd ../.. # back to the root of the repo
 pnpm seed
 ```
 
+### Troubleshooting
+
+If you have any issues connecting to the database (e.g. MongoServerError: not primary), try removing the volume and recreating the containers.
+
+```bash
+cd tools
+docker compose down -v
+docker compose up -d
+```
+
 ## Login in development/testing
 
 During development and testing, the api exposes the endpoint GET auth/dev-callback. Calling this will log you in as the user with the email `[email protected]` by setting the session cookie for that user.

api/__mocks__/env-exam.ts

@@ -45,7 +45,8 @@ export const config: EnvConfig = {
       numberOfCorrectAnswers: 1,
       numberOfIncorrectAnswers: 1
     }
-  ]
+  ],
+  retakeTimeInMS: 24 * 60 * 60 * 1000
 };
 
 export const questionSets: EnvQuestionSet[] = [
@@ -292,8 +293,7 @@ export const examAttempt: EnvExamAttempt = {
     }
   ],
   startTimeInMS: Date.now(),
-  userId: defaultUserId,
-  submissionTimeInMS: null
+  userId: defaultUserId
 };
 
 export const examAttemptSansSubmissionTimeInMS: Static<

api/prisma/schema.prisma

@@ -69,13 +69,20 @@ type SavedChallenge {
   lastSavedDate Float
 }
 
+type QuizAttempt {
+  challengeId String
+  quizId      String
+  timestamp   Float
+}
+
 /// Corresponds to the `user` collection.
 model user {
   id                           String                        @id @default(auto()) @map("_id") @db.ObjectId
   about                        String
   acceptedPrivacyTerms         Boolean
   completedChallenges          CompletedChallenge[]
   completedExams               CompletedExam[] // Undefined
+  quizAttempts                 QuizAttempt[] // Undefined
   currentChallengeId           String?
   donationEmails               String[] // Undefined | String[] (only possible for built in Types like String)
   email                        String
@@ -108,7 +115,7 @@ model user {
   is2018DataVisCert            Boolean? // Undefined
   is2018FullStackCert          Boolean? // Undefined
   isCollegeAlgebraPyCertV8     Boolean? // Undefined
-  isUpcomingPythonCertV8       Boolean? // Undefined
+  // isUpcomingPythonCertV8    Boolean? // Undefined. It is in the db but has never been used.
   keyboardShortcuts            Boolean? // Undefined
   linkedin                     String? // Null | Undefined
   location                     String? // Null
@@ -223,15 +230,17 @@ type EnvAnswer {
 /// Configuration for an exam in the Exam Environment App
 type EnvConfig {
   /// Human-readable exam name
-  name          String
+  name           String
   /// Notes given about exam
-  note          String
+  note           String
   /// Category configuration for question selection
-  tags          EnvTagConfig[]
+  tags           EnvTagConfig[]
   /// Total time allocated for exam in milliseconds
-  totalTimeInMS Int
+  totalTimeInMS  Int
   /// Configuration for sets of questions
-  questionSets  EnvQuestionSetConfig[]
+  questionSets   EnvQuestionSetConfig[]
+  /// Duration after exam completion before a retake is allowed in milliseconds
+  retakeTimeInMS Int
 }
 
 /// Configuration for a set of questions in the Exam Environment App
@@ -267,14 +276,10 @@ model EnvExamAttempt {
   /// Foreign key to generated exam id
   generatedExamId String @db.ObjectId
 
-  questionSets       EnvQuestionSetAttempt[]
+  questionSets  EnvQuestionSetAttempt[]
   /// Time exam was started as milliseconds since epoch
-  startTimeInMS      Int
-  /// Time exam was submitted as milliseconds since epoch
-  ///
-  /// As attempt might not be submitted (disconnection or quit), field is optional
-  submissionTimeInMS Int?
-  needsRetake        Boolean
+  startTimeInMS Int
+  needsRetake   Boolean
 
   // Relations
   user          user             @relation(fields: [userId], references: [id], onDelete: Cascade)
@@ -301,7 +306,6 @@ type EnvMultipleChoiceQuestionAttempt {
 /// A generated exam for the Exam Environment App
 ///
 /// This is the user-facing information for an exam.
-/// TODO: Add userId?
 model EnvGeneratedExam {
   id           String                    @id @default(auto()) @map("_id") @db.ObjectId
   /// Foreign key to exam

api/src/app.ts

@@ -38,7 +38,8 @@ import {
   FCC_ENABLE_DEV_LOGIN_MODE,
   FCC_ENABLE_SWAGGER_UI,
   FCC_ENABLE_SHADOW_CAPTURE,
-  FCC_ENABLE_EXAM_ENVIRONMENT
+  FCC_ENABLE_EXAM_ENVIRONMENT,
+  FCC_ENABLE_SENTRY_ROUTES
 } from './utils/env';
 import { isObjectID } from './utils/validation';
 import {
@@ -198,6 +199,10 @@ export const build = async (
     void fastify.register(examEnvironmentOpenRoutes);
   }
 
+  if (FCC_ENABLE_SENTRY_ROUTES) {
+    void fastify.register(publicRoutes.sentryRoutes);
+  }
+
   void fastify.register(publicRoutes.chargeStripeRoute);
   void fastify.register(publicRoutes.signoutRoute);
   void fastify.register(publicRoutes.emailSubscribtionRoutes);

api/src/exam-environment/generate/index.ts

@@ -24,7 +24,9 @@ const prisma = new PrismaClient({
 /// TODO:
 /// 1. Deprecate all previous generated exams for a given exam id?
 async function main() {
+  console.info('Connecting to cluster...');
   await prisma.$connect();
+  console.info('Connected.');
 
   const exam = await prisma.envExam.findUnique({
     where: {
@@ -38,17 +40,22 @@ async function main() {
 
   let numberOfExamsGenerated = 0;
 
+  console.info(
+    `Exam with _id ${ENV_EXAM_ID} found. Generating ${NUMBER_OF_EXAMS_TO_GENERATE} exams...`
+  );
   while (numberOfExamsGenerated < NUMBER_OF_EXAMS_TO_GENERATE) {
     try {
       const generatedExam = generateExam(exam);
       await prisma.envGeneratedExam.create({
         data: generatedExam
       });
       numberOfExamsGenerated++;
+      console.info(`Generated ${numberOfExamsGenerated} exams`);
     } catch (e) {
       console.log(e);
     }
   }
+  console.log(`Finished generating exams.`);
 }
 
 void main();

api/src/exam-environment/routes/exam-environment.test.ts

@@ -1,4 +1,6 @@
 import { Static } from '@fastify/type-provider-typebox';
+import jwt from 'jsonwebtoken';
+
 import {
   createSuperRequest,
   defaultUserId,
@@ -11,6 +13,7 @@ import {
 } from '../schemas';
 import * as mock from '../../../__mocks__/env-exam';
 import { constructUserExam } from '../utils/exam';
+import { JWT_SECRET } from '../../utils/env';
 
 jest.mock('../../utils/env', () => {
   // eslint-disable-next-line @typescript-eslint/no-unsafe-return
@@ -435,8 +438,6 @@ describe('/exam-environment/', () => {
           24 * 60 * 60 * 1000 -
           mock.exam.config.totalTimeInMS -
           1 * 60 * 60 * 1000;
-        submittedAttempt.submissionTimeInMS =
-          Date.now() - mock.exam.config.totalTimeInMS - 24 * 60 * 60 * 1000;
         await fastifyTestInstance.prisma.envExamAttempt.create({
           data: submittedAttempt
         });
@@ -492,7 +493,6 @@ describe('/exam-environment/', () => {
           generatedExamId: generatedExam!.id,
           questionSets: [],
           needsRetake: false,
-          submissionTimeInMS: null,
           // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
           startTimeInMS: expect.any(Number)
         });
@@ -579,7 +579,8 @@ describe('/exam-environment/', () => {
               config: {
                 name: mock.exam.config.name,
                 note: mock.exam.config.note,
-                totalTimeInMS: mock.exam.config.totalTimeInMS
+                totalTimeInMS: mock.exam.config.totalTimeInMS,
+                retakeTimeInMS: mock.exam.config.retakeTimeInMS
               },
               id: mock.examId
             }
@@ -641,7 +642,7 @@ describe('/exam-environment/', () => {
     });
 
     describe('GET /exam-environment/token-meta', () => {
-      it('should allow a valid request', async () => {
+      it('should reject invalid tokens', async () => {
         const res = await superGet('/exam-environment/token-meta').set(
           'exam-environment-authorization-token',
           'invalid-token'
@@ -654,6 +655,24 @@ describe('/exam-environment/', () => {
           }
         });
       });
+
+      it('should tell the requester if the token does not exist', async () => {
+        const validToken = jwt.sign(
+          { examEnvironmentAuthorizationToken: 'does-not-exist' },
+          JWT_SECRET
+        );
+        const res = await superGet('/exam-environment/token-meta').set(
+          'exam-environment-authorization-token',
+          validToken
+        );
+
+        expect(res).toMatchObject({
+          status: 418,
+          body: {
+            code: 'FCC_EINVAL_EXAM_ENVIRONMENT_AUTHORIZATION_TOKEN'
+          }
+        });
+      });
     });
 
     describe('GET /exam-environment/exams', () => {