@learnpack/learnpack 2.1.26 → 2.1.28

package/src/commands/start.ts

@@ -1,19 +1,24 @@
 // import path from "path";
-import { flags } from "@oclif/command";
-import SessionCommand from "../utils/SessionCommand";
-import Console from "../utils/console";
-import socket from "../managers/socket";
-import queue from "../utils/fileQueue";
-import { decompress, downloadEditor } from "../managers/file";
-import { prioritizeHTMLFile } from "../utils/misc";
+import { flags } from "@oclif/command"
 
-import createServer from "../managers/server";
+import SessionCommand from "../utils/SessionCommand"
+import Console from "../utils/console"
+import socket from "../managers/socket"
+import queue from "../utils/fileQueue"
+import {
+  decompress,
+  downloadEditor,
+  checkIfDirectoryExists,
+} from "../managers/file"
+import { prioritizeHTMLFile } from "../utils/misc"
 
-import { IGitpodData } from "../models/gitpod-data";
-import { IExercise, IExerciseData } from "../models/exercise-obj";
+import createServer from "../managers/server"
+
+import { IGitpodData } from "../models/gitpod-data"
+import { IExercise, IExerciseData } from "../models/exercise-obj"
 
 export default class StartCommand extends SessionCommand {
-  static description = "Runs a small server with all the exercise instructions";
+  static description = "Runs a small server with all the exercise instructions"
 
   static flags = {
     ...SessionCommand.flags,
@@ -50,25 +55,25 @@ export default class StartCommand extends SessionCommand {
       description: "debugger mode for more verbage",
       default: false,
     }),
-  };
+  }
 
   // 🛑 IMPORTANT
   // Every command that will use the configManager needs this init method
   async init() {
-    const { flags } = this.parse(StartCommand);
-    await this.initSession(flags);
+    const { flags } = this.parse(StartCommand)
+    await this.initSession(flags)
   }
 
   async run() {
     // get configuration object
-    const configObject = this.configManager?.get();
-    const config = configObject?.config;
+    const configObject = this.configManager?.get()
+    const config = configObject?.config
 
     if (configObject) {
-      const { config } = configObject;
+      const { config } = configObject
 
       // build exerises
-      this.configManager?.buildIndex();
+      this.configManager?.buildIndex()
 
       Console.debug(
         `Grading: ${config?.grading} ${
@@ -78,19 +83,25 @@ export default class StartCommand extends SessionCommand {
             configObject?.exercises.length :
             0
         } exercises found`
-      );
+      )
+
+      const appAlreadyExists = checkIfDirectoryExists(
+        `${config?.dirPath}/_app`
+      )
 
-      // download app and decompress
-      await downloadEditor(
-        config?.editor.version,
-        `${config?.dirPath}/app.tar.gz`
-      );
+      if (!appAlreadyExists) {
+        // download app and decompress
+        await downloadEditor(
+          config?.editor.version,
+          `${config?.dirPath}/app.tar.gz`
+        )
 
-      Console.info("Decompressing LearnPack UI, this may take a minute...");
-      await decompress(
-        `${config?.dirPath}/app.tar.gz`,
-        `${config?.dirPath}/_app/`
-      );
+        Console.info("Decompressing LearnPack UI, this may take a minute...")
+        await decompress(
+          `${config?.dirPath}/app.tar.gz`,
+          `${config?.dirPath}/_app/`
+        )
+      }
 
       // listen to socket commands
       if (config && this.configManager) {
@@ -98,45 +109,51 @@ export default class StartCommand extends SessionCommand {
           configObject,
           this.configManager,
           process.env.NODE_ENV === "test"
-        );
+        )
 
         const dispatcher = queue.dispatcher({
           create: true,
           path: `${config.dirPath}/vscode_queue.json`,
-        });
+        })
 
-        socket.start(config, server, false);
+        socket.start(config, server, false)
 
         socket.on("open", (data: IGitpodData) => {
-          Console.debug("Opening these files: ", data);
-          const files = prioritizeHTMLFile(data.files);
-          dispatcher.enqueue(dispatcher.events.OPEN_FILES, files);
-          socket.ready("Ready to compile...");
-        });
+          Console.debug("Opening these files: ", data)
+          console.log("Opening files", data)
+
+          const files = prioritizeHTMLFile(data.files)
+          // console.log("files",files);
+
+          dispatcher.enqueue(dispatcher.events.OPEN_FILES, files)
+          socket.ready("Ready to compile...")
+        })
 
         socket.on("open_window", (data: IGitpodData) => {
-          Console.debug("Opening window: ", data);
-          dispatcher.enqueue(dispatcher.events.OPEN_WINDOW, data);
-          socket.ready("Ready to compile...");
-        });
+          Console.debug("Opening window: ", data)
+          dispatcher.enqueue(dispatcher.events.OPEN_WINDOW, data)
+          console.log(data)
+
+          socket.ready("Ready to compile...")
+        })
 
         socket.on("reset", (exercise: IExerciseData) => {
           try {
-            this.configManager?.reset(exercise.exerciseSlug);
+            this.configManager?.reset(exercise.exerciseSlug)
             dispatcher.enqueue(
               dispatcher.events.RESET_EXERCISE,
               exercise.exerciseSlug
-            );
-            socket.ready("Ready to compile...");
+            )
+            socket.ready("Ready to compile...")
           } catch (error) {
             socket.error(
               "compiler-error",
               (error as TypeError).message ||
                 "There was an error reseting the exercise"
-            );
-            setTimeout(() => socket.ready("Ready to compile..."), 2000);
+            )
+            setTimeout(() => socket.ready("Ready to compile..."), 2000)
           }
-        });
+        })
         // socket.on("preview", (data) => {
         //   Console.debug("Preview triggered, removing the 'preview' action ")
         //   socket.removeAllowed("preview")
@@ -144,7 +161,7 @@ export default class StartCommand extends SessionCommand {
         // })
 
         socket.on("build", async (data: IExerciseData) => {
-          const exercise = this.configManager?.getExercise(data.exerciseSlug);
+          const exercise = this.configManager?.getExercise(data.exerciseSlug)
 
           if (!exercise?.language) {
             socket.error(
@@ -152,8 +169,8 @@ export default class StartCommand extends SessionCommand {
               "Impossible to detect language to build for " +
                 data.exerciseSlug +
                 "..."
-            );
-            return;
+            )
+            return
           }
 
           socket.log(
@@ -163,17 +180,23 @@ export default class StartCommand extends SessionCommand {
               " with " +
               exercise.language +
               "..."
-          );
+          )
           await this.config.runHook("action", {
             action: "compile",
             socket,
             configuration: config,
             exercise,
-          });
-        });
+          })
+        })
+
+        socket.on("generate", async (data: IExerciseData) => {
+          console.log("data", data)
+        })
 
         socket.on("test", async (data: IExerciseData) => {
-          const exercise = this.configManager?.getExercise(data.exerciseSlug);
+          const exercise = this.configManager?.getExercise(data.exerciseSlug)
+
+          console.log("data", data)
 
           if (!exercise?.language) {
             socket.error(
@@ -181,57 +204,60 @@ export default class StartCommand extends SessionCommand {
               "Impossible to detect engine language for testing for " +
                 data.exerciseSlug +
                 "..."
-            );
-            return;
+            )
+            return
           }
 
           if (
             config?.disabledActions!.includes("test") ||
             config?.disableGrading
           ) {
-            socket.ready("Grading is disabled on configuration");
-            return true;
+            socket.ready("Grading is disabled on configuration")
+            return true
           }
 
           socket.log(
             "testing",
             "Testing your exercise using the " + exercise.language + " engine."
-          );
+          )
+
+          console.log("About to call runHook")
 
           await this.config.runHook("action", {
             action: "test",
             socket,
             configuration: config,
             exercise,
-          });
-          this.configManager?.save();
+          })
+
+          this.configManager?.save()
 
-          return true;
-        });
+          return true
+        })
 
         const terminate = () => {
-          Console.debug("Terminating Learnpack...");
+          Console.debug("Terminating Learnpack...")
           server.terminate(() => {
-            this.configManager?.noCurrentExercise();
-            dispatcher.enqueue(dispatcher.events.END);
-            process.exit();
-          });
-        };
+            this.configManager?.noCurrentExercise()
+            dispatcher.enqueue(dispatcher.events.END)
+            process.exit()
+          })
+        }
 
-        server.on("close", terminate);
-        process.on("SIGINT", terminate);
-        process.on("SIGTERM", terminate);
-        process.on("SIGHUP", terminate);
+        server.on("close", terminate)
+        process.on("SIGINT", terminate)
+        process.on("SIGTERM", terminate)
+        process.on("SIGHUP", terminate)
 
         // finish the server startup
-        setTimeout(() => dispatcher.enqueue(dispatcher.events.RUNNING), 1000);
+        setTimeout(() => dispatcher.enqueue(dispatcher.events.RUNNING), 1000)
 
         // start watching for file changes
 
         if (StartCommand.flags.watch)
           this.configManager.watchIndex(_exercises =>
             socket.reload(null, _exercises)
-          );
+          )
       }
     }
   }

package/src/commands/test.ts

@@ -1,77 +1,77 @@
-import Console from "../utils/console";
-import SessionCommand from "../utils/SessionCommand";
-import socket from "../managers/socket";
+import Console from "../utils/console"
+import SessionCommand from "../utils/SessionCommand"
+import socket from "../managers/socket"
 
-import createServer from "../managers/server";
-import ExercisesQueue from "../utils/exercisesQueue";
-import { IExercise } from "../models/exercise-obj";
+import createServer from "../managers/server"
+import ExercisesQueue from "../utils/exercisesQueue"
+import { IExercise } from "../models/exercise-obj"
 
 class TestCommand extends SessionCommand {
   async init() {
-    const { flags } = this.parse(TestCommand);
-    await this.initSession(flags);
+    const { flags } = this.parse(TestCommand)
+    await this.initSession(flags)
   }
 
   async run() {
     const {
       args: { exerciseSlug },
-    } = this.parse(TestCommand);
+    } = this.parse(TestCommand)
 
     // Build exercises index
-    this.configManager?.buildIndex();
+    this.configManager?.buildIndex()
 
-    let exercises: IExercise[] | undefined = [];
+    let exercises: IExercise[] | undefined = []
 
     // test all exercises
     !exerciseSlug ?
       (exercises = this.configManager?.getAllExercises()) :
-      (exercises = [this.configManager!.getExercise(exerciseSlug)]);
+      (exercises = [this.configManager!.getExercise(exerciseSlug)])
 
-    const exercisesQueue = new ExercisesQueue(exercises);
+    const exercisesQueue = new ExercisesQueue(exercises)
 
-    const configObject = this.configManager?.get();
+    const configObject = this.configManager?.get()
 
-    let hasFailed = false;
-    let failedTestsCount = 0;
-    let successTestsCount = 0;
-    const testsToRunCount = exercisesQueue.size();
+    let hasFailed = false
+    let failedTestsCount = 0
+    let successTestsCount = 0
+    const testsToRunCount = exercisesQueue.size()
 
     configObject!.config!.testingFinishedCallback = ({ result }) => {
       if (result === "failed") {
-        hasFailed = true;
-        failedTestsCount++;
+        hasFailed = true
+        failedTestsCount++
       } else {
-        successTestsCount++;
+        successTestsCount++
       }
 
       if (exercisesQueue.isEmpty()) {
         Console.info(
           `${testsToRunCount} test${testsToRunCount > 1 ? "s" : ""} runned`
-        );
+        )
         Console.success(
           `${successTestsCount} test${successTestsCount > 1 ? "s" : ""} passed`
-        );
+        )
         Console.error(
           `${failedTestsCount} test${failedTestsCount > 1 ? "s" : ""} failed`
-        );
+        )
 
-        process.exit(hasFailed ? 1 : 0);
+        process.exit(hasFailed ? 1 : 0)
       } else {
-        exercisesQueue.pop()!.test!(this.config, config!, socket);
+        exercisesQueue.pop()!.test!(this.config, config!, socket)
       }
-    };
+    }
 
-    const config = configObject?.config;
+    const config = configObject?.config
 
-    const server = await createServer(configObject!, this.configManager!, true);
+    const server = await createServer(configObject!, this.configManager!, true)
 
-    socket.start(config!, server, true);
+    socket.start(config!, server, true)
 
-    exercisesQueue.pop()!.test!(this.config, config!, socket);
+    exercisesQueue.pop()!.test!(this.config, config!, socket)
   }
 }
 
-TestCommand.description = `Test exercises`;
+TestCommand.description = `Test exercises`
 
 TestCommand.args = [
   {
@@ -80,6 +80,6 @@ TestCommand.args = [
     description: "The name of the exercise to test",
     hidden: false,
   },
-];
+]
 
-export default TestCommand;
+export default TestCommand

package/src/managers/config/allowed_files.ts

@@ -24,6 +24,6 @@ const extensions = {
     "readme", // compressed files
   ],
   names: ["package.json", "package-lock.json"],
-};
+}
 
-export default extensions;
+export default extensions

package/src/managers/config/defaults.ts

@@ -3,7 +3,7 @@ export default {
     port: 3000,
     editor: {
       mode: null, // [standalone, preview]
-      agent: null, // [vscode, gitpod, localhost]
+      agent: null, // [vscode, gitpod, localhost, codespaces] TODO: We need to check if we are in codespaces
       version: null,
     },
     dirPath: "./.learn",
@@ -35,4 +35,4 @@ export default {
   exercises: [],
   bugsLink: null,
   videoSolutions: false,
-};
+}