Merge pull request #728 from freeCodeCamp/main

Create a new pull request by comparing changes across two branches

Author: GulajavaMinistudio

.github/PULL_REQUEST_TEMPLATE.md

@@ -5,7 +5,7 @@ Checklist:
 - [ ] I have read and followed the [contribution guidelines](https://contribute.freecodecamp.org).
 - [ ] I have read and followed the [how to open a pull request guide](https://contribute.freecodecamp.org/how-to-open-a-pull-request/).
 - [ ] My pull request targets the `main` branch of freeCodeCamp.
-- [ ] I have tested these changes either locally on my machine, or GitPod.
+- [ ] I have tested these changes either locally on my machine, or Gitpod.
 
 <!--If your pull request closes a GitHub issue, replace the XXXXX below with the issue number.-->
 

.github/workflows/build-images.yml

@@ -10,7 +10,7 @@ jobs:
       matrix:
         node-version: [20.x]
         apps: [api]
-        site_tlds: [dev]
+        site_tlds: [dev, org]
       fail-fast: false
 
     steps:

.gitpod.yml

@@ -35,6 +35,7 @@ tasks:
       export API_LOCATION=$(gp url 3000)
       export CHALLENGE_EDITOR_API_LOCATION=$(gp url 3200)
       export CHALLENGE_EDITOR_CLIENT_LOCATION=$(gp url 3300)
+      export CHALLENGE_EDITOR_LEARN_CLIENT_LOCATION=$(gp url 8000)
       ' >> ~/.bashrc;
       exit;
 

.lintstagedrc.js

@@ -25,7 +25,7 @@ module.exports = {
       ];
     }
   },
-  '*.!(js|ts|tsx)': files => {
+  '*.!(js|ts|tsx|css)': files => {
     if (completedStages.has('not-js')) return [];
 
     if (files.length > 10) {
@@ -49,5 +49,16 @@ module.exports = {
         filename => `node ./tools/scripts/lint/index.js '${filename}'`
       );
     }
+  },
+
+  '*.css': files => {
+    if (completedStages.has('css')) return [];
+
+    if (files.length > 10) {
+      completedStages.add('css');
+      return 'pnpm run stylelint --fix .';
+    } else {
+      return files.map(filename => `stylelint '${filename}'`);
+    }
   }
 };

api-server/src/common/utils/constantStrings.json

@@ -1,6 +1,6 @@
 {
   "aboutUrl": "https://www.freecodecamp.org/about",
-  "defaultProfileImage": "https://s3.amazonaws.com/freecodecamp/camper-image-placeholder.png",
+  "defaultProfileImage": "https://cdn.freecodecamp.org/platform/universal/camper-image-placeholder.png",
   "donateUrl": "https://www.freecodecamp.org/donate",
   "forumUrl": "https://forum.freecodecamp.org",
   "githubUrl": "https://github.com/freecodecamp/freecodecamp",

api/__mocks__/env-exam.ts

@@ -339,7 +339,8 @@ export const exam: EnvExam = {
   id: examId,
   config,
   questionSets,
-  prerequisites: ['67112fe1c994faa2c26d0b1d']
+  prerequisites: ['67112fe1c994faa2c26d0b1d'],
+  deprecated: false
 };
 
 export async function seedEnvExam() {
@@ -379,3 +380,9 @@ export async function seedEnvExamAttempt() {
     data: examAttempt
   });
 }
+
+export async function seedExamEnvExamAuthToken() {
+  return fastifyTestInstance.prisma.examEnvironmentAuthorizationToken.create({
+    data: { userId: defaultUserId, expireAt: new Date(Date.now() + 60000) }
+  });
+}

api/jest.utils.ts

@@ -127,16 +127,6 @@ const indexData: IndexData[] = [
     collection: 'Survey',
     indexes: [{ key: { userId: 1 }, name: 'userId_1' }]
   },
-  {
-    collection: 'UserRateLimit',
-    indexes: [
-      {
-        key: { expirationDate: 1 },
-        name: 'expirationDate_1',
-        expireAfterSeconds: 0
-      }
-    ]
-  },
   {
     collection: 'UserToken',
     indexes: [{ key: { userId: 1 }, name: 'userId_1' }]

api/package.json

@@ -9,10 +9,10 @@
     "@fastify/cookie": "9.4.0",
     "@fastify/csrf-protection": "6.4.1",
     "@fastify/oauth2": "7.8.1",
-    "@fastify/rate-limit": "9.1.0",
     "@fastify/swagger": "8.14.0",
     "@fastify/swagger-ui": "1.10.2",
     "@fastify/type-provider-typebox": "3.6.0",
+    "@growthbook/growthbook": "1.3.1",
     "@immobiliarelabs/fastify-sentry": "7.1.1",
     "@prisma/client": "5.5.2",
     "ajv": "8.12.0",
@@ -32,7 +32,6 @@
     "nodemon": "2.0.22",
     "pino-pretty": "10.2.3",
     "query-string": "7.1.3",
-    "rate-limit-mongo": "^2.3.2",
     "stripe": "16.0.0",
     "validator": "13.11.0"
   },
@@ -80,8 +79,9 @@
     "test": "jest --force-exit",
     "prisma": "dotenv -e ../.env prisma",
     "postinstall": "prisma generate",
-    "lint": "cd .. && eslint api/src --max-warnings 0",
     "generate-exams": "tsx src/exam-environment/generate/index.ts",
+    "deprecate-exam": "tsx src/exam-environment/generate/deprecate.ts",
+    "insert-exam": "tsx src/exam-environment/generate/insert.ts",
     "seed:env-exam": "tsx src/exam-environment/seed/index.ts"
   },
   "version": "0.0.1"

api/prisma/schema.prisma

@@ -166,6 +166,8 @@ model EnvExam {
   config        EnvConfig
   /// ObjectIds for required challenges/blocks to take the exam
   prerequisites String[]         @db.ObjectId
+  /// If `deprecated`, the exam should no longer be considered for users
+  deprecated    Boolean
 
   // Relations
   generatedExams EnvGeneratedExam[]
@@ -365,14 +367,6 @@ model Donation {
   @@index([userId], map: "userId_1")
 }
 
-model UserRateLimit {
-  id             String   @id @map("_id")
-  counter        Int
-  expirationDate DateTime @db.Date
-
-  @@index([expirationDate], map: "expirationDate_1")
-}
-
 model UserToken {
   id      String   @id @map("_id")
   created DateTime @db.Date
@@ -390,7 +384,7 @@ model ExamEnvironmentAuthorizationToken {
   userId   String   @unique @db.ObjectId
 
   // Relations
-  user user @relation(fields: [userId], references: [id])
+  user user @relation(fields: [userId], references: [id], onDelete: Cascade)
 }
 
 model sessions {

api/src/app.ts

@@ -2,6 +2,7 @@ import fastifyAccepts from '@fastify/accepts';
 import fastifySwagger from '@fastify/swagger';
 import fastifySwaggerUI from '@fastify/swagger-ui';
 import type { TypeBoxTypeProvider } from '@fastify/type-provider-typebox';
+import { GrowthBook } from '@growthbook/growthbook';
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
 import uriResolver from 'fast-uri';
@@ -28,6 +29,7 @@ import errorHandling from './plugins/error-handling';
 import csrf from './plugins/csrf';
 import notFound from './plugins/not-found';
 import shadowCapture from './plugins/shadow-capture';
+import growthBook from './plugins/growth-book';
 
 import * as publicRoutes from './routes/public';
 import * as protectedRoutes from './routes/protected';
@@ -39,7 +41,9 @@ import {
   FCC_ENABLE_SWAGGER_UI,
   FCC_ENABLE_SHADOW_CAPTURE,
   FCC_ENABLE_EXAM_ENVIRONMENT,
-  FCC_ENABLE_SENTRY_ROUTES
+  FCC_ENABLE_SENTRY_ROUTES,
+  GROWTHBOOK_FASTIFY_API_HOST,
+  GROWTHBOOK_FASTIFY_CLIENT_KEY
 } from './utils/env';
 import { isObjectID } from './utils/validation';
 import {
@@ -55,6 +59,12 @@ type FastifyInstanceWithTypeProvider = FastifyInstance<
   TypeBoxTypeProvider
 >;
 
+declare module 'fastify' {
+  interface FastifyInstance {
+    gb: GrowthBook;
+  }
+}
+
 // Options that fastify uses
 const ajv = new Ajv({
   coerceTypes: 'array', // change data type of data to match type keyword
@@ -99,12 +109,17 @@ export const build = async (
   await fastify.register(cookies);
   await fastify.register(csrf);
 
+  await fastify.register(growthBook, {
+    apiHost: GROWTHBOOK_FASTIFY_API_HOST,
+    clientKey: GROWTHBOOK_FASTIFY_CLIENT_KEY
+  });
+
   const provider =
     EMAIL_PROVIDER === 'ses' ? new SESProvider() : new NodemailerProvider();
   void fastify.register(mailer, { provider });
 
   // Swagger plugin
-  if (FCC_ENABLE_SWAGGER_UI) {
+  if (FCC_ENABLE_SWAGGER_UI ?? fastify.gb.isOn('swagger-ui')) {
     void fastify.register(fastifySwagger, {
       openapi: {
         openapi: '3.1.0',
@@ -132,7 +147,7 @@ export const build = async (
     fastify.log.info(`Swagger UI available at ${API_LOCATION}/documentation`);
   }
 
-  if (FCC_ENABLE_SHADOW_CAPTURE) {
+  if (FCC_ENABLE_SHADOW_CAPTURE ?? fastify.gb.isOn('shadow-capture')) {
     void fastify.register(shadowCapture);
   }
 
@@ -189,7 +204,7 @@ export const build = async (
     }
   });
 
-  if (FCC_ENABLE_EXAM_ENVIRONMENT) {
+  if (FCC_ENABLE_EXAM_ENVIRONMENT ?? fastify.gb.isOn('exam-environment')) {
     void fastify.register(function (fastify, _opts, done) {
       fastify.addHook('onRequest', fastify.authorizeExamEnvironmentToken);
 
@@ -199,7 +214,7 @@ export const build = async (
     void fastify.register(examEnvironmentOpenRoutes);
   }
 
-  if (FCC_ENABLE_SENTRY_ROUTES) {
+  if (FCC_ENABLE_SENTRY_ROUTES ?? fastify.gb.isOn('sentry-routes')) {
     void fastify.register(publicRoutes.sentryRoutes);
   }