@learnpack/learnpack 2.1.3 → 2.1.6

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @learnpack/learnpack
 $ learnpack COMMAND
 running command...
 $ learnpack (-v|--version|version)
-@learnpack/learnpack/2.1.3 win32-x64 node-v16.14.0
+@learnpack/learnpack/2.1.6 win32-x64 node-v16.14.0
 $ learnpack --help [COMMAND]
 USAGE
   $ learnpack COMMAND
@@ -74,7 +74,7 @@ DESCRIPTION
        12. If there is a file within the exercises folder but not inside of any particular exercise's folder. (Warning)
 ```
 
-_See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.3/src\commands\audit.ts)_
+_See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.6/src\commands\audit.ts)_
 
 ## `learnpack clean`
 
@@ -89,7 +89,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.3/src\commands\clean.ts)_
+_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.6/src\commands\clean.ts)_
 
 ## `learnpack download [PACKAGE]`
 
@@ -107,7 +107,7 @@ DESCRIPTION
   Extra documentation goes here
 ```
 
-_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.3/src\commands\download.ts)_
+_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.6/src\commands\download.ts)_
 
 ## `learnpack help [COMMAND]`
 
@@ -138,7 +138,7 @@ OPTIONS
   -h, --grading  show CLI help
 ```
 
-_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.3/src\commands\init.ts)_
+_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.6/src\commands\init.ts)_
 
 ## `learnpack login [PACKAGE]`
 
@@ -156,7 +156,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.3/src\commands\login.ts)_
+_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.6/src\commands\login.ts)_
 
 ## `learnpack logout [PACKAGE]`
 
@@ -174,7 +174,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.3/src\commands\logout.ts)_
+_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.6/src\commands\logout.ts)_
 
 ## `learnpack plugins`
 
@@ -309,7 +309,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.3/src\commands\publish.ts)_
+_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.6/src\commands\publish.ts)_
 
 ## `learnpack start`
 
@@ -330,7 +330,7 @@ OPTIONS
   -w, --watch                         Watch for file changes
 ```
 
-_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.3/src\commands\start.ts)_
+_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.6/src\commands\start.ts)_
 
 ## `learnpack test [EXERCISESLUG]`
 
@@ -344,5 +344,5 @@ ARGUMENTS
   EXERCISESLUG  The name of the exercise to test
 ```
 
-_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.3/src\commands\test.ts)_
+_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.6/src\commands\test.ts)_
 <!-- commandsstop -->

package/lib/commands/audit.js

@@ -38,10 +38,8 @@ class AuditCommand extends SessionCommand_1.default {
             // Checks if learnpack clean has been run
             audit_1.default.checkLearnpackClean(config, errors);
             // Build exercises if they are not built yet.
-            if (!config.exercises || config.exercises.length === 0) {
-                (_b = this.configManager) === null || _b === void 0 ? void 0 : _b.buildIndex();
-                config = (_c = this.configManager) === null || _c === void 0 ? void 0 : _c.get();
-            }
+            (_b = this.configManager) === null || _b === void 0 ? void 0 : _b.buildIndex();
+            config = (_c = this.configManager) === null || _c === void 0 ? void 0 : _c.get();
             // Check if the exercises folder has some files within any ./exercise
             const exercisesPath = config.config.exercisesPath;
             fs.readdir(exercisesPath, (err, files) => {
@@ -175,8 +173,8 @@ class AuditCommand extends SessionCommand_1.default {
                                     try {
                                         // eslint-disable-next-line
                                         let res = await fetch(obj[link].mdUrl, { method: "HEAD" });
-                                        console_1.default.log("Response links:", obj[link].mdUrl, res);
                                         if (res.status > 399 && res.status < 500) {
+                                            console_1.default.log("Response links:", res.status, obj[link].mdUrl, res);
                                             counter.links.error++;
                                             errors.push({
                                                 exercise: exercise.title,

package/lib/managers/config/index.js

@@ -86,6 +86,7 @@ exports.default = async ({ grading, mode, disableGrading, version, }) => {
             [] }));
     // auto detect agent (if possible)
     if (shell.which("gp") && configObj && configObj.config) {
+        configObj.config.editor.agent = "vscode";
         configObj.address = getGitpodAddress();
         configObj.config.publicUrl = `https://${configObj.config.port}-${(_b = configObj.address) === null || _b === void 0 ? void 0 : _b.slice(8)}`;
     }

package/lib/managers/server/routes.js

@@ -64,9 +64,9 @@ async function default_1(app, configObject, configManager) {
         res.json(exercises);
     }));
     app.get("/exercise/:slug/readme", withHandler(({ params: { slug }, query: { lang } }, res) => {
-        const excercise = configManager.getExercise(slug);
-        if (excercise) {
-            const readme = excercise.getReadme(lang || null);
+        const exercise = configManager.getExercise(slug);
+        if (exercise && exercise.getReadme) {
+            const readme = exercise.getReadme(lang || null);
             res.json(readme);
         }
         else {
@@ -74,8 +74,11 @@ async function default_1(app, configObject, configManager) {
         }
     }));
     app.get("/exercise/:slug/report", withHandler(({ params: { slug } }, res) => {
-        const report = configManager.getExercise(slug).getTestReport();
-        res.json(JSON.stringify(report));
+        const exercise = configManager.getExercise(slug);
+        if (exercise && exercise.getTestReport) {
+            const report = exercise.getTestReport();
+            res.json(JSON.stringify(report));
+        }
     }));
     app.get("/exercise/:slug", withHandler((req, res) => {
         var _a, _b, _c, _d;
@@ -141,16 +144,19 @@ async function default_1(app, configObject, configManager) {
         res.json(exercise);
     }));
     app.get("/exercise/:slug/file/:fileName", withHandler((req, res) => {
-        res.write(configManager.getExercise(req.params.slug).getFile(req.params.fileName));
-        res.end();
+        const exercise = configManager.getExercise(req.params.slug);
+        if (exercise && exercise.getFile) {
+            res.write(exercise.getFile(req.params.fileName));
+            res.end();
+        }
     }));
     const textBodyParser = bodyParser.text();
     app.put("/exercise/:slug/file/:fileName", textBodyParser, withHandler((req, res) => {
-        // const result =
-        configManager
-            .getExercise(req.params.slug)
-            .saveFile(req.params.fileName, req.body);
-        res.end();
+        const exercise = configManager.getExercise(req.params.slug);
+        if (exercise && exercise.saveFile) {
+            exercise.saveFile(req.params.fileName, req.body);
+            res.end();
+        }
     }));
     if (config === null || config === void 0 ? void 0 : config.outputPath) {
         app.use("/preview", express.static(config.outputPath));

package/lib/models/exercise-obj.d.ts

@@ -15,10 +15,10 @@ export interface IExercise {
         [key: string]: string;
     };
     title: string;
-    getReadme: (lang: string | null) => any;
-    getFile: (name: string) => string | Buffer;
-    saveFile: (name: string, content: string) => void;
-    getTestReport: () => any;
+    getReadme?: (lang: string | null) => any;
+    getFile?: (name: string) => string | Buffer;
+    saveFile?: (name: string, content: string) => void;
+    getTestReport?: () => any;
     test?: (sessionConfig: any, config: IConfig, socket: ISocket) => void;
 }
 export interface IExerciseData {

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"2.1.3","commands":{"audit":{"id":"audit","description":"learnpack audit is the command in charge of creating an auditory of the repository\n...\nlearnpack audit checks for the following information in a repository:\n    1. The configuration object has slug, repository and description. (Error)\n    2. The command learnpack clean has been run. (Error)\n    3. If a markdown or test file doesn't have any content. (Error)\n    4. The links are accessing to valid servers. (Error)\n    5. The relative images are working (If they have the shortest path to the image or if the images exists in the assets). (Error)\n    6. The external images are working (If they are pointing to a valid server). (Error)\n    7. The exercises directory names are valid. (Error)\n    8. If an exercise doesn't have a README file. (Error)\n    9. The exercises array (Of the config file) has content. (Error)\n    10. The exercses have the same translations. (Warning)\n    11. The .gitignore file exists. (Warning)\n    12. If there is a file within the exercises folder but not inside of any particular exercise's folder. (Warning)\n","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]},"clean":{"id":"clean","description":"Clean the configuration object\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]},"download":{"id":"download","description":"Describe the command here\n...\nExtra documentation goes here\n","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"init":{"id":"init","description":"Create a new learning package: Book, Tutorial or Exercise","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"grading":{"name":"grading","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"login":{"id":"login","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"logout":{"id":"logout","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"publish":{"id":"publish","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"start":{"id":"start","description":"Runs a small server with all the exercise instructions","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"port":{"name":"port","type":"option","char":"p","description":"server port"},"host":{"name":"host","type":"option","char":"h","description":"server host"},"disableGrading":{"name":"disableGrading","type":"boolean","char":"D","description":"disble grading functionality","allowNo":false},"watch":{"name":"watch","type":"boolean","char":"w","description":"Watch for file changes","allowNo":false},"editor":{"name":"editor","type":"option","char":"e","description":"[standalone, gitpod]","options":["standalone","gitpod"]},"version":{"name":"version","type":"option","char":"v","description":"E.g: 1.0.1"},"grading":{"name":"grading","type":"option","char":"g","description":"[isolated, incremental]","options":["isolated","incremental"]},"debug":{"name":"debug","type":"boolean","char":"d","description":"debugger mode for more verbage","allowNo":false}},"args":[]},"test":{"id":"test","description":"Test exercises","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"exerciseSlug","description":"The name of the exercise to test","required":false,"hidden":false}]}}}
+{"version":"2.1.6","commands":{"audit":{"id":"audit","description":"learnpack audit is the command in charge of creating an auditory of the repository\n...\nlearnpack audit checks for the following information in a repository:\n    1. The configuration object has slug, repository and description. (Error)\n    2. The command learnpack clean has been run. (Error)\n    3. If a markdown or test file doesn't have any content. (Error)\n    4. The links are accessing to valid servers. (Error)\n    5. The relative images are working (If they have the shortest path to the image or if the images exists in the assets). (Error)\n    6. The external images are working (If they are pointing to a valid server). (Error)\n    7. The exercises directory names are valid. (Error)\n    8. If an exercise doesn't have a README file. (Error)\n    9. The exercises array (Of the config file) has content. (Error)\n    10. The exercses have the same translations. (Warning)\n    11. The .gitignore file exists. (Warning)\n    12. If there is a file within the exercises folder but not inside of any particular exercise's folder. (Warning)\n","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]},"clean":{"id":"clean","description":"Clean the configuration object\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]},"download":{"id":"download","description":"Describe the command here\n...\nExtra documentation goes here\n","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"init":{"id":"init","description":"Create a new learning package: Book, Tutorial or Exercise","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"grading":{"name":"grading","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"login":{"id":"login","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"logout":{"id":"logout","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"publish":{"id":"publish","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"start":{"id":"start","description":"Runs a small server with all the exercise instructions","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"port":{"name":"port","type":"option","char":"p","description":"server port"},"host":{"name":"host","type":"option","char":"h","description":"server host"},"disableGrading":{"name":"disableGrading","type":"boolean","char":"D","description":"disble grading functionality","allowNo":false},"watch":{"name":"watch","type":"boolean","char":"w","description":"Watch for file changes","allowNo":false},"editor":{"name":"editor","type":"option","char":"e","description":"[standalone, gitpod]","options":["standalone","gitpod"]},"version":{"name":"version","type":"option","char":"v","description":"E.g: 1.0.1"},"grading":{"name":"grading","type":"option","char":"g","description":"[isolated, incremental]","options":["isolated","incremental"]},"debug":{"name":"debug","type":"boolean","char":"d","description":"debugger mode for more verbage","allowNo":false}},"args":[]},"test":{"id":"test","description":"Test exercises","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"exerciseSlug","description":"The name of the exercise to test","required":false,"hidden":false}]}}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@learnpack/learnpack",
   "description": "Create, sell or download and take learning amazing learning packages",
-  "version": "2.1.3",
+  "version": "2.1.6",
   "author": "Alejandro Sanchez @alesanchezr",
   "bin": {
     "learnpack": "bin/run"

package/src/commands/audit.ts

@@ -48,10 +48,8 @@ class AuditCommand extends SessionCommand {
       Audit.checkLearnpackClean(config, errors);
 
       // Build exercises if they are not built yet.
-      if (!config.exercises || config.exercises.length === 0) {
-        this.configManager?.buildIndex();
-        config = this.configManager?.get();
-      }
+      this.configManager?.buildIndex();
+      config = this.configManager?.get();
 
       // Check if the exercises folder has some files within any ./exercise
       const exercisesPath: string = config!.config!.exercisesPath;
@@ -220,8 +218,13 @@ return false;
                   try {
                     // eslint-disable-next-line
                     let res = await fetch(obj[link].mdUrl, { method: "HEAD" });
-                    Console.log("Response links:", obj[link].mdUrl, res);
                     if (res.status > 399 && res.status < 500) {
+                      Console.log(
+                        "Response links:",
+                        res.status,
+                        obj[link].mdUrl,
+                        res
+                      );
                       counter.links.error++;
                       errors.push({
                         exercise: exercise.title,

package/src/managers/config/index.ts

@@ -125,6 +125,7 @@ export default async ({
 
   // auto detect agent (if possible)
   if (shell.which("gp") && configObj && configObj.config) {
+    configObj.config.editor.agent = "vscode";
     configObj.address = getGitpodAddress();
     configObj.config.publicUrl = `https://${
       configObj.config.port

package/src/managers/server/routes.ts

@@ -1,255 +1,259 @@
-import Console from "../../utils/console";
-import * as express from "express";
-import * as fs from "fs";
-import * as bodyParser from "body-parser";
-import socket from "../socket";
-import queue from "../../utils/fileQueue";
-// import gitpod from '../gitpod'
-import { detect, filterFiles } from "../config/exercise";
-import { IFile } from "../../models/file";
-import { IConfigObj, TEntries } from "../../models/config";
-import { IConfigManager } from "../../models/config-manager";
-import { IExercise } from "../../models/exercise-obj";
-
-const withHandler =
-  (func: (req: express.Request, res: express.Response) => void) =>
-  (req: express.Request, res: express.Response) => {
-    try {
-      func(req, res);
-    } catch (error) {
-      Console.debug(error);
-      const _err = {
-        message: (error as TypeError).message || "There has been an error",
-        status: (error as any).status || 500,
-        type: (error as any).type || null,
-      };
-      Console.error(_err.message);
-
-      // send rep to the server
-      res.status(_err.status);
-      res.json(_err);
-    }
-  };
-
-export default async function (
-  app: express.Application,
-  configObject: IConfigObj,
-  configManager: IConfigManager
-) {
-  const { config, exercises } = configObject;
-
-  const dispatcher = queue.dispatcher({
-    create: true,
-    path: `${config?.dirPath}/vscode_queue.json`,
-  });
-  app.get(
-    "/config",
-    withHandler((_: express.Request, res: express.Response) => {
-      res.json(configObject);
-    })
-  );
-
-  /**
-     * TODO: replicate a socket action, the request payload must be passed to the socket as well
-  
-   const jsonBodyParser = bodyParser.json()
-   
-   type ISocketActions = "addAllowed" | "removeAllowed" | "start" | "on" | "clean" | "ask" | "reload" | "openWindow" | "log" | "emit" | "ready" | "error" | "fatal" | "success" | "onTestingFinished";
-   
-   app.post('/socket/:actionName', jsonBodyParser, withHandler((req, res) => {
-     if (socket[req.params.actionName as ISocketActions] instanceof Function) {
-       socket[req.params.actionName as ISocketActions](req.body ? req.body.data : null)
-       res.json({ "details": "Socket call executed sucessfully" })
-      } else res.status(400).json({ "details": `Socket action ${req.params.actionName} not found` })
-    }))
-  */
-
-  // 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);
-    const content = fs.readFileSync(filePath);
-    res.write(content);
-    res.end();
-  });
-
-  app.get(
-    `${
-      config?.dirPath.indexOf("./") === 0 ?
-        config.dirPath.slice(1) :
-        config?.dirPath
-    }/assets/:filePath`,
-    fetchStaticAsset
-  );
-
-  app.get("/assets/:filePath", fetchStaticAsset);
-
-  app.get(
-    "/exercise",
-    withHandler((_: express.Request, res: express.Response) => {
-      res.json(exercises);
-    })
-  );
-
-  app.get(
-    "/exercise/:slug/readme",
-    withHandler(
-      (
-        { params: { slug }, query: { lang } }: express.Request,
-        res: express.Response
-      ) => {
-        const excercise: IExercise = configManager.getExercise(slug);
-
-        if (excercise) {
-          const readme = excercise.getReadme((lang as string) || null);
-          res.json(readme);
-        } else {
-          res.status(400);
-        }
-      }
-    )
-  );
-
-  app.get(
-    "/exercise/:slug/report",
-    withHandler(
-      ({ params: { slug } }: express.Request, res: express.Response) => {
-        const report = configManager.getExercise(slug).getTestReport();
-        res.json(JSON.stringify(report));
-      }
-    )
-  );
-
-  app.get(
-    "/exercise/:slug",
-    withHandler((req: express.Request, res: express.Response) => {
-      // no need to re-start exercise if it's already started
-      if (
-        configObject.currentExercise &&
-        req.params.slug === configObject.currentExercise
-      ) {
-        const exercise = configManager.getExercise(req.params.slug);
-        res.json(exercise);
-        return;
-      }
-
-      const exercise = configManager.startExercise(req.params.slug);
-      dispatcher.enqueue(dispatcher.events.START_EXERCISE, req.params.slug);
-
-      type TEntry = "python3" | "html" | "node" | "react" | "java";
-       
-      const entries = new Set(
-        Object.keys(config?.entries!).map(
-          lang => config?.entries[lang as TEntry]
-        )
-      );
-
-      // if we are in incremental grading, the entry file can by dinamically detected
-      // based on the changes the student is making during the exercise
-      if (config?.grading === "incremental") {
-        const scanedFiles = fs.readdirSync("./");
-
-        // update the file hierarchy with updates
-        exercise.files = [
-          ...exercise.files.filter(f => f.name.includes("test.")),
-          ...filterFiles(scanedFiles),
-        ];
-        Console.debug(`Exercise updated files: `, exercise.files);
-      }
-
-      const detected = detect(
-        configObject,
-        exercise.files
-          .filter(fileName => entries.has(fileName.name))
-          .map(f => f.name || f) as string[]
-      );
-
-      // if a new language for the testing engine is detected, we replace it
-      // if not we leave it as it was before
-      if (config?.language && !["", "auto"].includes(config?.language)) {
-        Console.debug(
-          `Exercise language ignored, instead imported from configuration ${config?.language}`
-        );
-        exercise.language = detected?.language;
-      } else if (
-        detected?.language &&
-        (!config?.language || config?.language === "auto")
-      ) {
-        Console.debug(
-          `Switching to ${detected.language} engine in this exercise`
-        );
-        exercise.language = detected.language;
-      }
-
-      // WARNING: has to be the FULL PATH to the entry path
-      // We need to detect entry in both gradings: Incremental and Isolate
-      exercise.entry = detected?.entry;
-      Console.debug(
-        `Exercise detected entry: ${detected?.entry} and language ${exercise.language}`
-      );
-
-      if (
-        !exercise.graded ||
-        config?.disableGrading ||
-        config?.disabledActions?.includes("test")
-      ) {
-        socket.removeAllowed("test");
-      } else {
-        socket.addAllowed("test");
-      }
-
-      if (!exercise.entry || config?.disabledActions?.includes("build")) {
-        socket.removeAllowed("build");
-      } else {
-        socket.addAllowed("build");
-      }
-
-      if (
-        exercise.files.filter(
-          (f: IFile) =>
-            !f.name.toLowerCase().includes("readme.") &&
-            !f.name.toLowerCase().includes("test.")
-        ).length === 0 ||
-        config?.disabledActions?.includes("reset")
-      ) {
-        socket.removeAllowed("reset");
-      } else if (!config?.disabledActions?.includes("reset")) {
-        socket.addAllowed("reset");
-      }
-
-      socket.log("ready");
-
-      res.json(exercise);
-    })
-  );
-
-  app.get(
-    "/exercise/:slug/file/:fileName",
-    withHandler((req: express.Request, res: express.Response) => {
-      res.write(
-        configManager.getExercise(req.params.slug).getFile(req.params.fileName)
-      );
-      res.end();
-    })
-  );
-
-  const textBodyParser = bodyParser.text();
-  app.put(
-    "/exercise/:slug/file/:fileName",
-    textBodyParser,
-    withHandler((req: express.Request, res: express.Response) => {
-      // const result =
-      configManager
-        .getExercise(req.params.slug)
-        .saveFile(req.params.fileName, req.body);
-      res.end();
-    })
-  );
-
-  if (config?.outputPath) {
-    app.use("/preview", express.static(config.outputPath));
-  }
-
-  app.use("/", express.static(`${config?.dirPath}/_app`));
-}
+import Console from "../../utils/console";
+import * as express from "express";
+import * as fs from "fs";
+import * as bodyParser from "body-parser";
+import socket from "../socket";
+import queue from "../../utils/fileQueue";
+// import gitpod from '../gitpod'
+import { detect, filterFiles } from "../config/exercise";
+import { IFile } from "../../models/file";
+import { IConfigObj, TEntries } from "../../models/config";
+import { IConfigManager } from "../../models/config-manager";
+import { IExercise } from "../../models/exercise-obj";
+
+const withHandler =
+  (func: (req: express.Request, res: express.Response) => void) =>
+  (req: express.Request, res: express.Response) => {
+    try {
+      func(req, res);
+    } catch (error) {
+      Console.debug(error);
+      const _err = {
+        message: (error as TypeError).message || "There has been an error",
+        status: (error as any).status || 500,
+        type: (error as any).type || null,
+      };
+      Console.error(_err.message);
+
+      // send rep to the server
+      res.status(_err.status);
+      res.json(_err);
+    }
+  };
+
+export default async function (
+  app: express.Application,
+  configObject: IConfigObj,
+  configManager: IConfigManager
+) {
+  const { config, exercises } = configObject;
+
+  const dispatcher = queue.dispatcher({
+    create: true,
+    path: `${config?.dirPath}/vscode_queue.json`,
+  });
+  app.get(
+    "/config",
+    withHandler((_: express.Request, res: express.Response) => {
+      res.json(configObject);
+    })
+  );
+
+  /**
+     * TODO: replicate a socket action, the request payload must be passed to the socket as well
+  
+   const jsonBodyParser = bodyParser.json()
+   
+   type ISocketActions = "addAllowed" | "removeAllowed" | "start" | "on" | "clean" | "ask" | "reload" | "openWindow" | "log" | "emit" | "ready" | "error" | "fatal" | "success" | "onTestingFinished";
+   
+   app.post('/socket/:actionName', jsonBodyParser, withHandler((req, res) => {
+     if (socket[req.params.actionName as ISocketActions] instanceof Function) {
+       socket[req.params.actionName as ISocketActions](req.body ? req.body.data : null)
+       res.json({ "details": "Socket call executed sucessfully" })
+      } else res.status(400).json({ "details": `Socket action ${req.params.actionName} not found` })
+    }))
+  */
+
+  // 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);
+    const content = fs.readFileSync(filePath);
+    res.write(content);
+    res.end();
+  });
+
+  app.get(
+    `${
+      config?.dirPath.indexOf("./") === 0 ?
+        config.dirPath.slice(1) :
+        config?.dirPath
+    }/assets/:filePath`,
+    fetchStaticAsset
+  );
+
+  app.get("/assets/:filePath", fetchStaticAsset);
+
+  app.get(
+    "/exercise",
+    withHandler((_: express.Request, res: express.Response) => {
+      res.json(exercises);
+    })
+  );
+
+  app.get(
+    "/exercise/:slug/readme",
+    withHandler(
+      (
+        { params: { slug }, query: { lang } }: express.Request,
+        res: express.Response
+      ) => {
+        const exercise: IExercise = configManager.getExercise(slug);
+
+        if (exercise && exercise.getReadme) {
+          const readme = exercise.getReadme((lang as string) || null);
+          res.json(readme);
+        } else {
+          res.status(400);
+        }
+      }
+    )
+  );
+
+  app.get(
+    "/exercise/:slug/report",
+    withHandler(
+      ({ params: { slug } }: express.Request, res: express.Response) => {
+        const exercise = configManager.getExercise(slug);
+        if (exercise && exercise.getTestReport) {
+          const report = exercise.getTestReport();
+          res.json(JSON.stringify(report));
+        }
+      }
+    )
+  );
+
+  app.get(
+    "/exercise/:slug",
+    withHandler((req: express.Request, res: express.Response) => {
+      // no need to re-start exercise if it's already started
+      if (
+        configObject.currentExercise &&
+        req.params.slug === configObject.currentExercise
+      ) {
+        const exercise = configManager.getExercise(req.params.slug);
+        res.json(exercise);
+        return;
+      }
+
+      const exercise = configManager.startExercise(req.params.slug);
+      dispatcher.enqueue(dispatcher.events.START_EXERCISE, req.params.slug);
+
+      type TEntry = "python3" | "html" | "node" | "react" | "java";
+
+      const entries = new Set(
+        Object.keys(config?.entries!).map(
+          lang => config?.entries[lang as TEntry]
+        )
+      );
+
+      // if we are in incremental grading, the entry file can by dinamically detected
+      // based on the changes the student is making during the exercise
+      if (config?.grading === "incremental") {
+        const scanedFiles = fs.readdirSync("./");
+
+        // update the file hierarchy with updates
+        exercise.files = [
+          ...exercise.files.filter(f => f.name.includes("test.")),
+          ...filterFiles(scanedFiles),
+        ];
+        Console.debug(`Exercise updated files: `, exercise.files);
+      }
+
+      const detected = detect(
+        configObject,
+        exercise.files
+          .filter(fileName => entries.has(fileName.name))
+          .map(f => f.name || f) as string[]
+      );
+
+      // if a new language for the testing engine is detected, we replace it
+      // if not we leave it as it was before
+      if (config?.language && !["", "auto"].includes(config?.language)) {
+        Console.debug(
+          `Exercise language ignored, instead imported from configuration ${config?.language}`
+        );
+        exercise.language = detected?.language;
+      } else if (
+        detected?.language &&
+        (!config?.language || config?.language === "auto")
+      ) {
+        Console.debug(
+          `Switching to ${detected.language} engine in this exercise`
+        );
+        exercise.language = detected.language;
+      }
+
+      // WARNING: has to be the FULL PATH to the entry path
+      // We need to detect entry in both gradings: Incremental and Isolate
+      exercise.entry = detected?.entry;
+      Console.debug(
+        `Exercise detected entry: ${detected?.entry} and language ${exercise.language}`
+      );
+
+      if (
+        !exercise.graded ||
+        config?.disableGrading ||
+        config?.disabledActions?.includes("test")
+      ) {
+        socket.removeAllowed("test");
+      } else {
+        socket.addAllowed("test");
+      }
+
+      if (!exercise.entry || config?.disabledActions?.includes("build")) {
+        socket.removeAllowed("build");
+      } else {
+        socket.addAllowed("build");
+      }
+
+      if (
+        exercise.files.filter(
+          (f: IFile) =>
+            !f.name.toLowerCase().includes("readme.") &&
+            !f.name.toLowerCase().includes("test.")
+        ).length === 0 ||
+        config?.disabledActions?.includes("reset")
+      ) {
+        socket.removeAllowed("reset");
+      } else if (!config?.disabledActions?.includes("reset")) {
+        socket.addAllowed("reset");
+      }
+
+      socket.log("ready");
+
+      res.json(exercise);
+    })
+  );
+
+  app.get(
+    "/exercise/:slug/file/:fileName",
+    withHandler((req: express.Request, res: express.Response) => {
+      const exercise = configManager.getExercise(req.params.slug);
+      if (exercise && exercise.getFile) {
+        res.write(exercise.getFile(req.params.fileName));
+        res.end();
+      }
+    })
+  );
+
+  const textBodyParser = bodyParser.text();
+  app.put(
+    "/exercise/:slug/file/:fileName",
+    textBodyParser,
+    withHandler((req: express.Request, res: express.Response) => {
+      const exercise = configManager.getExercise(req.params.slug);
+      if (exercise && exercise.saveFile) {
+        exercise.saveFile(req.params.fileName, req.body);
+        res.end();
+      }
+    })
+  );
+
+  if (config?.outputPath) {
+    app.use("/preview", express.static(config.outputPath));
+  }
+
+  app.use("/", express.static(`${config?.dirPath}/_app`));
+}

package/src/models/exercise-obj.ts

@@ -1,26 +1,26 @@
-import { IFile } from "./file";
-import { IConfig } from "./config";
-import { ISocket } from "./socket";
-
-export interface IExercise {
-  position?: number;
-  files: Array<IFile>;
-  slug: string;
-  path: string;
-  done: boolean;
-  language?: string | null;
-  entry?: string | null;
-  graded?: boolean;
-  translations?: { [key: string]: string };
-  title: string;
-  getReadme: (lang: string | null) => any;
-  getFile: (name: string) => string | Buffer;
-  saveFile: (name: string, content: string) => void;
-  getTestReport: () => any;
-  test?: (sessionConfig: any, config: IConfig, socket: ISocket) => void;
-}
-
-export interface IExerciseData {
-  exerciseSlug: string;
-  files: string[];
-}
+import { IFile } from "./file";
+import { IConfig } from "./config";
+import { ISocket } from "./socket";
+
+export interface IExercise {
+  position?: number;
+  files: Array<IFile>;
+  slug: string;
+  path: string;
+  done: boolean;
+  language?: string | null;
+  entry?: string | null;
+  graded?: boolean;
+  translations?: { [key: string]: string };
+  title: string;
+  getReadme?: (lang: string | null) => any;
+  getFile?: (name: string) => string | Buffer;
+  saveFile?: (name: string, content: string) => void;
+  getTestReport?: () => any;
+  test?: (sessionConfig: any, config: IConfig, socket: ISocket) => void;
+}
+
+export interface IExerciseData {
+  exerciseSlug: string;
+  files: string[];
+}