@learnpack/learnpack 5.0.335 → 5.0.340

package/src/managers/config/exercise.ts

@@ -7,6 +7,7 @@ import allowed from "./allowed_files"
 import { IConfigObj } from "../../models/config"
 import { IFile } from "../../models/file"
 import { IExercise } from "../../models/exercise-obj"
+import { compareExerciseFileNames } from "../../utils/exerciseFileOrder"
 
 // function processQuestions(markdown: string): {
 //   updatedMarkdown: string
@@ -46,7 +47,7 @@ import { IExercise } from "../../models/exercise-obj"
 //   return { updatedMarkdown, questions }
 // }
 // eslint-disable-next-line
-const frontMatter = require("front-matter")
+const frontMatter = require("front-matter");
 
 export const exercise = (
   path: string,
@@ -342,20 +343,7 @@ export const filterFiles = (files: Array<string>, basePath = ".") =>
         path: basePath + "/" + ex,
       } as IFile),
     }))
-    .sort((f1, f2) => {
-      const score: { [key: string]: number } = {
-        // sorting priority
-        "index.html": 1,
-        "styles.css": 2,
-        "styles.scss": 2,
-        "style.css": 2,
-        "style.scss": 2,
-        "index.css": 2,
-        "index.scss": 2,
-        "index.js": 3,
-      }
-      return score[f1.name] < score[f2.name] ? -1 : 1
-    })
+    .sort((f1, f2) => compareExerciseFileNames(f1.name, f2.name))
 
 export default {
   exercise,

package/src/managers/readmeHistoryService.ts

@@ -1,5 +1,6 @@
 import type { Bucket } from "@google-cloud/storage"
 import type { HistoryManager } from "./historyManager"
+import { sanitizeReadmeNewlines } from "../utils/readmeSanitizer"
 
 export interface SaveReadmeWithHistoryOptions {
   courseSlug: string;
@@ -260,10 +261,11 @@ export class ReadmeHistoryService {
     fileName: string,
     content: string
   ): Promise<void> {
+    const sanitizedContent = sanitizeReadmeNewlines(content)
     const filePath = `courses/${courseSlug}/exercises/${exerciseSlug}/${fileName}`
     const file = this.bucket.file(filePath)
 
-    await file.save(content, {
+    await file.save(sanitizedContent, {
       resumable: false,
     })
   }

package/src/managers/server/routes.ts

@@ -14,8 +14,9 @@ import SessionManager from "../../managers/session"
 import TelemetryManager from "../telemetry"
 import { saveTranslatedReadme } from "../../utils/creatorUtilities"
 import { translateExercise } from "../../utils/rigoActions"
+import { sanitizeReadmeNewlines } from "../../utils/readmeSanitizer"
 import { addExerciseToSidebar } from "../../utils/sidebarGenerator"
-import path = require("path")
+import path = require("path");
 // import { eventManager } from "../../utils/osOperations"
 
 const withHandler =
@@ -204,7 +205,8 @@ export default async function (
   // symbolic link to maintain path compatiblity
   const fetchStaticAsset = withHandler((req, res) => {
     const filePath = `${config?.dirPath}/assets/${req.params.filePath}`
-    if (!fs.existsSync(filePath)) throw new Error("File not found: " + filePath)
+    if (!fs.existsSync(filePath))
+      throw new Error("File not found: " + filePath)
     const content = fs.readFileSync(filePath)
     res.write(content)
     res.end()
@@ -271,7 +273,11 @@ export default async function (
         const exercise = configManager.getExercise(req.params.slug)
         res.json(exercise)
         if (exercise.position) {
-          TelemetryManager.registerStepEvent(exercise.position, "open_step", {})
+          TelemetryManager.registerStepEvent(
+            exercise.position,
+            "open_step",
+            {}
+          )
         }
 
         return
@@ -286,7 +292,7 @@ export default async function (
         dispatcher.enqueue(dispatcher.events.START_EXERCISE, req.params.slug)
       }
 
-      type TEntry = "python3" | "html" | "node" | "react" | "java"
+      type TEntry = "python3" | "html" | "node" | "react" | "java";
 
       const entries = new Set(
         Object.keys(config?.entries!).map(
@@ -438,7 +444,7 @@ export default async function (
                   const response = await translateExercise(
                     rigoToken,
                     {
-                      text_to_translate: readme.body,
+                      text_to_translate: sanitizeReadmeNewlines(readme.body),
                       output_language: language,
                     },
                     `${process.env.HOST}/webhooks/translate-exercise`
@@ -550,5 +556,8 @@ export default async function (
 
   app.use("/", express.static(`${config?.dirPath}/_app`))
 
-  app.use("/creator", express.static(path.join(__dirname, "..", "creatorDist")))
+  app.use(
+    "/creator",
+    express.static(path.join(__dirname, "..", "creatorDist"))
+  )
 }

package/src/managers/session.ts

@@ -1,184 +1,184 @@
-import Console from "../utils/console"
-import api from "../utils/api"
-
-import v from "validator"
-import { ValidationError, InternalError } from "../utils/errors"
-
-import * as fs from "fs"
-import cli from "cli-ux"
-import * as storage from "node-persist"
-
-import { IPayload, ISession, IStartProps } from "../models/session"
-import { IConfigObj } from "../models/config"
-import TelemetryManager from "./telemetry"
-import * as path from "path"
-import * as os from "os"
-
-const GLOBAL_SESSION_PATH = path.join(os.homedir(), ".learnpack-session")
-
-const Session: ISession = {
-  sessionStarted: false,
-  token: null,
-  config: null,
-  currentCohort: null,
-  initialize: async function () {
-    if (!this.sessionStarted) {
-      // Use a system-wide path instead of config.dirPath
-      if (!fs.existsSync(GLOBAL_SESSION_PATH)) {
-        fs.mkdirSync(GLOBAL_SESSION_PATH, { recursive: true })
-      }
-
-      await storage.init({ dir: GLOBAL_SESSION_PATH })
-      this.sessionStarted = true
-    }
-
-    return true
-  },
-
-  setRigoToken: async function (token: string) {
-    await this.initialize()
-    const payload = await storage.getItem("bc-payload")
-    await storage.setItem("bc-payload", {
-      ...payload,
-      rigobot: { key: token },
-    })
-    Console.debug("Rigobot token successfuly set")
-    return true
-  },
-  setTabHash: async function (hash: string) {
-    await this.initialize()
-    const payload = await storage.getItem("bc-payload")
-    await storage.setItem("bc-payload", {
-      ...payload,
-      tabHash: hash,
-    })
-    Console.debug("tabHash successfuly set")
-    return true
-  },
-  setSessionKey: async function (value: string) {
-    await this.initialize()
-    const payload = await storage.getItem("bc-payload")
-    await storage.setItem("bc-payload", {
-      ...payload,
-      sessionKey: value,
-    })
-    Console.debug("sessionKey successfuly set")
-    return true
-  },
-  setPayload: async function (value: IPayload) {
-    await this.initialize()
-    await storage.setItem("bc-payload", { ...value })
-    Console.debug(
-      "Payload successfuly found and set for user " + value.user_id
-    )
-
-    // TelemetryManager.setStudent({
-    //   user_id: value.user_id.toString(),
-    //   email: value.email,
-    //   token: value.token,
-    // })
-
-    return true
-  },
-  getPayload: async function () {
-    await this.initialize()
-    let payload = null
-    try {
-      payload = await storage.getItem("bc-payload")
-    } catch {
-      Console.debug("Error retriving session payload")
-    }
-
-    return payload
-  },
-  isActive: function () {
-    return !!this.token
-  },
-  get: async function (configObj?: IConfigObj) {
-    if (configObj && configObj.config) {
-      this.config = configObj.config
-    }
-
-    await this.sync()
-    if (!this.isActive()) {
-      return null
-    }
-
-    const payload = await this.getPayload()
-
-    return {
-      payload,
-      token: this.token,
-    }
-  },
-  login: async function () {
-    const email = await cli.prompt("What is your email?")
-    if (!v.isEmail(email)) {
-      throw ValidationError("Invalid email")
-    }
-
-    const password = await cli.prompt("What is your password?", {
-      type: "hide",
-    })
-
-    const data = await api.login(email, password)
-
-    if (data) {
-      Console.debug("Login successfull")
-      // cli.log(data)
-      await this.start({ token: data.token, payload: data })
-      return data
-    }
-  },
-  loginWeb: async function (email, password) {
-    if (!v.isEmail(email)) {
-      throw ValidationError("Invalid email")
-    }
-
-    const data = await api.login(email, password)
-    if (data) {
-      this.start({ token: data.token, payload: data })
-
-      return data
-    }
-  },
-  sync: async function () {
-    const payload = await this.getPayload()
-    if (payload) {
-      this.token = payload.token
-    }
-  },
-  start: async function ({ token, payload = null }: IStartProps) {
-    if (!token) {
-      throw new Error("A token and email is needed to start a session")
-    }
-
-    this.token = token
-
-    if (payload && (await this.setPayload(payload))) {
-      Console.success(`Successfully logged in as user ${payload.user_id}`)
-    }
-  },
-  destroy: async function () {
-    if (!this.sessionStarted) {
-      await this.initialize()
-    }
-
-    await storage.clear()
-    this.token = null
-    Console.success("You have logged out")
-  },
-  breakToken: async function () {
-    const payload = await this.getPayload()
-    if (payload) {
-      this.token = "asdasdasdasd"
-      await storage.setItem("bc-payload", {
-        ...payload,
-        token: "asdasdsad",
-      })
-      Console.success("Token broken successfully")
-    }
-  },
-}
-
-export default Session
+import Console from "../utils/console"
+import api from "../utils/api"
+
+import v from "validator"
+import { ValidationError, InternalError } from "../utils/errors"
+
+import * as fs from "fs"
+import cli from "cli-ux"
+import * as storage from "node-persist"
+
+import { IPayload, ISession, IStartProps } from "../models/session"
+import { IConfigObj } from "../models/config"
+import TelemetryManager from "./telemetry"
+import * as path from "path"
+import * as os from "os"
+
+const GLOBAL_SESSION_PATH = path.join(os.homedir(), ".learnpack-session")
+
+const Session: ISession = {
+  sessionStarted: false,
+  token: null,
+  config: null,
+  currentCohort: null,
+  initialize: async function () {
+    if (!this.sessionStarted) {
+      // Use a system-wide path instead of config.dirPath
+      if (!fs.existsSync(GLOBAL_SESSION_PATH)) {
+        fs.mkdirSync(GLOBAL_SESSION_PATH, { recursive: true })
+      }
+
+      await storage.init({ dir: GLOBAL_SESSION_PATH })
+      this.sessionStarted = true
+    }
+
+    return true
+  },
+
+  setRigoToken: async function (token: string) {
+    await this.initialize()
+    const payload = await storage.getItem("bc-payload")
+    await storage.setItem("bc-payload", {
+      ...payload,
+      rigobot: { key: token },
+    })
+    Console.debug("Rigobot token successfuly set")
+    return true
+  },
+  setTabHash: async function (hash: string) {
+    await this.initialize()
+    const payload = await storage.getItem("bc-payload")
+    await storage.setItem("bc-payload", {
+      ...payload,
+      tabHash: hash,
+    })
+    Console.debug("tabHash successfuly set")
+    return true
+  },
+  setSessionKey: async function (value: string) {
+    await this.initialize()
+    const payload = await storage.getItem("bc-payload")
+    await storage.setItem("bc-payload", {
+      ...payload,
+      sessionKey: value,
+    })
+    Console.debug("sessionKey successfuly set")
+    return true
+  },
+  setPayload: async function (value: IPayload) {
+    await this.initialize()
+    await storage.setItem("bc-payload", { ...value })
+    Console.debug(
+      "Payload successfuly found and set for user " + value.user_id
+    )
+
+    // TelemetryManager.setStudent({
+    //   user_id: value.user_id.toString(),
+    //   email: value.email,
+    //   token: value.token,
+    // })
+
+    return true
+  },
+  getPayload: async function () {
+    await this.initialize()
+    let payload = null
+    try {
+      payload = await storage.getItem("bc-payload")
+    } catch {
+      Console.debug("Error retriving session payload")
+    }
+
+    return payload
+  },
+  isActive: function () {
+    return !!this.token
+  },
+  get: async function (configObj?: IConfigObj) {
+    if (configObj && configObj.config) {
+      this.config = configObj.config
+    }
+
+    await this.sync()
+    if (!this.isActive()) {
+      return null
+    }
+
+    const payload = await this.getPayload()
+
+    return {
+      payload,
+      token: this.token,
+    }
+  },
+  login: async function () {
+    const email = await cli.prompt("What is your email?")
+    if (!v.isEmail(email)) {
+      throw ValidationError("Invalid email")
+    }
+
+    const password = await cli.prompt("What is your password?", {
+      type: "hide",
+    })
+
+    const data = await api.login(email, password)
+
+    if (data) {
+      Console.debug("Login successfull")
+      // cli.log(data)
+      await this.start({ token: data.token, payload: data })
+      return data
+    }
+  },
+  loginWeb: async function (email, password) {
+    if (!v.isEmail(email)) {
+      throw ValidationError("Invalid email")
+    }
+
+    const data = await api.login(email, password)
+    if (data) {
+      this.start({ token: data.token, payload: data })
+
+      return data
+    }
+  },
+  sync: async function () {
+    const payload = await this.getPayload()
+    if (payload) {
+      this.token = payload.token
+    }
+  },
+  start: async function ({ token, payload = null }: IStartProps) {
+    if (!token) {
+      throw new Error("A token and email is needed to start a session")
+    }
+
+    this.token = token
+
+    if (payload && (await this.setPayload(payload))) {
+      Console.success(`Successfully logged in as user ${payload.user_id}`)
+    }
+  },
+  destroy: async function () {
+    if (!this.sessionStarted) {
+      await this.initialize()
+    }
+
+    await storage.clear()
+    this.token = null
+    Console.success("You have logged out")
+  },
+  breakToken: async function () {
+    const payload = await this.getPayload()
+    if (payload) {
+      this.token = "asdasdasdasd"
+      await storage.setItem("bc-payload", {
+        ...payload,
+        token: "asdasdsad",
+      })
+      Console.success("Token broken successfully")
+    }
+  },
+}
+
+export default Session