@learnpack/learnpack 2.1.25 → 2.1.27

package/src/managers/file.ts

@@ -1,169 +1,178 @@
-import * as fs from "fs";
-import * as p from "path";
-import * as shell from "shelljs";
-import { cli } from "cli-ux";
-import * as targz from "targz";
-import Console from "../utils/console";
-import * as https from "https";
-import { InternalError } from "../utils/errors";
-
-// eslint-disable-next-line
-const fetch = require("node-fetch");
-
-export const decompress = (sourcePath: string, destinationPath: string) =>
-  new Promise((resolve, reject) => {
-    Console.debug("Decompressing " + sourcePath);
-    targz.decompress(
-      {
-        src: sourcePath,
-        dest: destinationPath,
-      },
-      function (err: string | Error | null) {
-        if (err) {
-          Console.error("Error when trying to decompress");
-          reject(err);
-        } else {
-          Console.info("Decompression finished successfully");
-          resolve(/* */ "");
-        }
-      }
-    );
-  });
-
-export const downloadEditor = async (
-  version: string | undefined,
-  destination: string
-) => {
-  // https://raw.githubusercontent.com/learnpack/coding-ide/master/dist/app.tar.gz
-  // if(versions[version] === undefined) throw new Error(`Invalid editor version ${version}`)
-  const resp2 = await fetch(
-    `https://github.com/learnpack/coding-ide/blob/${version}/dist`,
-    { method: "HEAD" }
-  );
-  if (!resp2.ok)
-    throw InternalError(
-      `Coding Editor ${version} was not found on learnpack repository, check the config.editor.version property on learn.json`
-    );
-
-  Console.info(
-    "Downloading the LearnPack coding UI, this may take a minute..."
-  );
-  return download(
-    `https://github.com/learnpack/coding-ide/blob/${version}/dist/app.tar.gz?raw=true`,
-    destination
-  );
-};
-
-export const download = (url: string, dest: string) => {
-  Console.debug("Downloading " + url);
-  return new Promise((resolve, reject) => {
-    const request = https.get(url, response => {
-      if (response.statusCode === 200) {
-        const file = fs.createWriteStream(dest, { flags: "wx" });
-        file.on("finish", () => {
-          resolve(true);
-        });
-        file.on("error", err => {
-          file.close();
-          if (err.code === "EEXIST") {
-            Console.debug("File already exists");
-            resolve("File already exists");
-          } else {
-            Console.debug("Error ", err.message);
-            fs.unlink(dest, () => reject(err.message)); // Delete temp file
-          }
-        });
-        response.pipe(file);
-      } else if (response.statusCode === 302 || response.statusCode === 301) {
-        // Console.debug("Servers redirected to "+response.headers.location)
-        // Recursively follow redirects, only a 200 will resolve.
-        if (response.headers.location) {
-          download(response.headers.location, dest)
-            .then(() => resolve(/* */ ""))
-            .catch(error => {
-              Console.error(error);
-              reject(error);
-            });
-        }
-      } else {
-        Console.debug(
-          `Server responded with ${response.statusCode}: ${response.statusMessage}`
-        );
-        reject(
-          `Server responded with ${response.statusCode}: ${response.statusMessage}`
-        );
-      }
-    });
-
-    request.on("error", err => {
-      reject(err.message);
-    });
-  });
-};
-
-export const clone = (repository = "", folder = "./") =>
-  new Promise((resolve, reject) => {
-    if (!repository) {
-      reject("Missing repository url for this package");
-      // return false
-    }
-
-    cli.action.start("Verifying GIT...");
-    if (!shell.which("git")) {
-      reject("Sorry, this script requires git");
-      // return false
-    }
-
-    cli.action.stop();
-
-    let fileName = p.basename(repository);
-    if (!fileName) {
-      reject("Invalid repository information on package: " + repository);
-      // return false
-    }
-
-    fileName = fileName.split(".")[0];
-    if (fs.existsSync("./" + fileName)) {
-      reject(
-        `Directory ${fileName} already exists; Did you download this package already?`
-      );
-      // return false
-    }
-
-    cli.action.start(`Cloning repository ${repository}...`);
-    if (shell.exec(`git clone ${repository}`).code !== 0) {
-      reject("Error: Installation failed");
-    }
-
-    cli.action.stop();
-
-    cli.action.start("Cleaning installation...");
-    if (shell.exec(`rm -R -f ${folder}${fileName}/.git`).code !== 0) {
-      reject("Error: removing .git directory");
-    }
-
-    cli.action.stop();
-
-    resolve("Done");
-  });
-
-export const rmSync = function (path: string) {
-  let files = [];
-  if (fs.existsSync(path)) {
-    files = fs.readdirSync(path);
-    for (const [, file] of files.entries()) {
-      const curPath = path + "/" + file;
-      if (fs.lstatSync(curPath).isDirectory()) {
-        // recurse
-        rmSync(curPath);
-      } else {
-        // delete file
-        fs.unlinkSync(curPath);
-      }
-    }
-
-    fs.rmdirSync(path);
-  }
-};
-
-export default { download, decompress, downloadEditor, clone, rmSync };
+import * as fs from "fs"
+import * as p from "path"
+import * as shell from "shelljs"
+import { cli } from "cli-ux"
+import * as targz from "targz"
+import Console from "../utils/console"
+import * as https from "https"
+import { InternalError } from "../utils/errors"
+
+// eslint-disable-next-line
+const fetch = require("node-fetch");
+
+export const decompress = (sourcePath: string, destinationPath: string) =>
+  new Promise((resolve, reject) => {
+    Console.debug("Decompressing " + sourcePath)
+    targz.decompress(
+      {
+        src: sourcePath,
+        dest: destinationPath,
+      },
+      function (err: string | Error | null) {
+        if (err) {
+          Console.error("Error when trying to decompress")
+          reject(err)
+        } else {
+          Console.info("Decompression finished successfully")
+          resolve(/* */ "")
+        }
+      }
+    )
+  })
+
+export const downloadEditor = async (
+  version: string | undefined,
+  destination: string
+) => {
+  // https://raw.githubusercontent.com/learnpack/coding-ide/master/dist/app.tar.gz
+  // if(versions[version] === undefined) throw new Error(`Invalid editor version ${version}`)
+  const resp2 = await fetch(
+    `https://github.com/learnpack/coding-ide/blob/${version}/dist`,
+    { method: "HEAD" }
+  )
+  if (!resp2.ok)
+    throw InternalError(
+      `Coding Editor ${version} was not found on learnpack repository, check the config.editor.version property on learn.json`
+    )
+
+  Console.info(
+    "Downloading the LearnPack coding UI, this may take a minute..."
+  )
+  return download(
+    `https://github.com/learnpack/coding-ide/blob/${version}/dist/app.tar.gz?raw=true`,
+    destination
+  )
+}
+
+export const download = (url: string, dest: string) => {
+  Console.debug("Downloading " + url)
+  return new Promise((resolve, reject) => {
+    const request = https.get(url, response => {
+      if (response.statusCode === 200) {
+        const file = fs.createWriteStream(dest, { flags: "wx" })
+        file.on("finish", () => {
+          resolve(true)
+        })
+        file.on("error", err => {
+          file.close()
+          if (err.code === "EEXIST") {
+            Console.debug("File already exists")
+            resolve("File already exists")
+          } else {
+            Console.debug("Error ", err.message)
+            fs.unlink(dest, () => reject(err.message)) // Delete temp file
+          }
+        })
+        response.pipe(file)
+      } else if (response.statusCode === 302 || response.statusCode === 301) {
+        // Console.debug("Servers redirected to "+response.headers.location)
+        // Recursively follow redirects, only a 200 will resolve.
+        if (response.headers.location) {
+          download(response.headers.location, dest)
+            .then(() => resolve(/* */ ""))
+            .catch(error => {
+              Console.error(error)
+              reject(error)
+            })
+        }
+      } else {
+        Console.debug(
+          `Server responded with ${response.statusCode}: ${response.statusMessage}`
+        )
+        reject(
+          `Server responded with ${response.statusCode}: ${response.statusMessage}`
+        )
+      }
+    })
+
+    request.on("error", err => {
+      reject(err.message)
+    })
+  })
+}
+
+export const clone = (repository = "", folder = "./") =>
+  new Promise((resolve, reject) => {
+    if (!repository) {
+      reject("Missing repository url for this package")
+      // return false
+    }
+
+    cli.action.start("Verifying GIT...")
+    if (!shell.which("git")) {
+      reject("Sorry, this script requires git")
+      // return false
+    }
+
+    cli.action.stop()
+
+    let fileName = p.basename(repository)
+    if (!fileName) {
+      reject("Invalid repository information on package: " + repository)
+      // return false
+    }
+
+    fileName = fileName.split(".")[0]
+    if (fs.existsSync("./" + fileName)) {
+      reject(
+        `Directory ${fileName} already exists; Did you download this package already?`
+      )
+      // return false
+    }
+
+    cli.action.start(`Cloning repository ${repository}...`)
+    if (shell.exec(`git clone ${repository}`).code !== 0) {
+      reject("Error: Installation failed")
+    }
+
+    cli.action.stop()
+
+    cli.action.start("Cleaning installation...")
+    if (shell.exec(`rm -R -f ${folder}${fileName}/.git`).code !== 0) {
+      reject("Error: removing .git directory")
+    }
+
+    cli.action.stop()
+
+    resolve("Done")
+  })
+
+export const rmSync = function (path: string) {
+  let files = []
+  if (fs.existsSync(path)) {
+    files = fs.readdirSync(path)
+    for (const [, file] of files.entries()) {
+      const curPath = path + "/" + file
+      if (fs.lstatSync(curPath).isDirectory()) {
+        // recurse
+        rmSync(curPath)
+      } else {
+        // delete file
+        fs.unlinkSync(curPath)
+      }
+    }
+
+    fs.rmdirSync(path)
+  }
+}
+
+export const checkIfDirectoryExists = (path: string) => {
+  const fs = require("fs")
+  if (fs.existsSync(path)) {
+    return true
+  }
+
+  return false
+}
+
+export default { download, decompress, downloadEditor, clone, rmSync }

package/src/managers/gitpod.ts

@@ -1,84 +1,84 @@
-import Console from '../utils/console'
-import * as shell from 'shelljs'
-import socket from './socket'
-import * as fs from 'fs'
-
-import {TFile, IGitpod} from '../models/gitpod-data'
-import {IConfigObj} from '../models/config'
-
-const Gitpod: IGitpod = {
-  socket: null,
-  config: null,
-  initialized: false,
-  hasGPCommand: false,
-  init: function (config?: IConfigObj) {
-    if (this.initialized) {
-      return
-    }
-
-    this.initialized = true
-
-    if (config) {
-      this.config = config
-    }
-
-    if (shell.exec('gp -h', {silent: true}).code === 0) {
-      this.hasGPCommand = true
-      if (config) {
-        config.address = shell
-        .exec('gp url', {silent: true})
-        .stdout.replace(/(\r\n|\n|\r)/gm, '')
-      }
-    } else {
-      Console.debug('Gitpod command line tool not found')
-    }
-  },
-  openFiles: async function (files: Array<TFile>) {
-    Console.debug('Attempting to open files in gitpod mode', files)
-    this.init() // initilize gitpod config
-
-    // gitpod will open files only on isolated mode
-    if (!this.config || this.config.config?.grading !== 'isolated') {
-      Console.debug(
-        'Files cannot be automatically opened because we are not on isolated grading (only for isolated)',
-      )
-      socket.log('ready', ['Ready to compile or test...'])
-      return true
-    }
-
-    if (this.hasGPCommand)
-      for (const f of files.reverse()) {
-        if (shell.exec(`gp open ${f}`).code > 0) {
-          Console.debug(`Error opening file ${f} on gitpod`)
-        }
-      }
-
-    socket.log('ready', ['Ready to compile or test...'])
-  },
-  setup(config?: IConfigObj) {
-    this.init(config) // initilize gitpod config
-    this.autosave('on')
-  },
-  autosave: async function (value = 'on') {
-    this.init() // initilize gitpod config
-
-    if (this.hasGPCommand) {
-      if (!fs.existsSync('./.theia'))
-        fs.mkdirSync('./.theia')
-      if (!fs.existsSync('./.theia/settings.json')) {
-        fs.writeFileSync(
-          './.theia/settings.json',
-          JSON.stringify(
-            {
-              'editor.autoSave': value,
-            },
-            null,
-            4,
-          ),
-        )
-      }
-    }
-  },
-}
-
-export default Gitpod
+import Console from '../utils/console'
+import * as shell from 'shelljs'
+import socket from './socket'
+import * as fs from 'fs'
+
+import {TFile, IGitpod} from '../models/gitpod-data'
+import {IConfigObj} from '../models/config'
+
+const Gitpod: IGitpod = {
+  socket: null,
+  config: null,
+  initialized: false,
+  hasGPCommand: false,
+  init: function (config?: IConfigObj) {
+    if (this.initialized) {
+      return
+    }
+
+    this.initialized = true
+
+    if (config) {
+      this.config = config
+    }
+
+    if (shell.exec('gp -h', {silent: true}).code === 0) {
+      this.hasGPCommand = true
+      if (config) {
+        config.address = shell
+        .exec('gp url', {silent: true})
+        .stdout.replace(/(\r\n|\n|\r)/gm, '')
+      }
+    } else {
+      Console.debug('Gitpod command line tool not found')
+    }
+  },
+  openFiles: async function (files: Array<TFile>) {
+    Console.debug('Attempting to open files in gitpod mode', files)
+    this.init() // initilize gitpod config
+
+    // gitpod will open files only on isolated mode
+    if (!this.config || this.config.config?.grading !== 'isolated') {
+      Console.debug(
+        'Files cannot be automatically opened because we are not on isolated grading (only for isolated)',
+      )
+      socket.log('ready', ['Ready to compile or test...'])
+      return true
+    }
+
+    if (this.hasGPCommand)
+      for (const f of files.reverse()) {
+        if (shell.exec(`gp open ${f}`).code > 0) {
+          Console.debug(`Error opening file ${f} on gitpod`)
+        }
+      }
+
+    socket.log('ready', ['Ready to compile or test...'])
+  },
+  setup(config?: IConfigObj) {
+    this.init(config) // initilize gitpod config
+    this.autosave('on')
+  },
+  autosave: async function (value = 'on') {
+    this.init() // initilize gitpod config
+
+    if (this.hasGPCommand) {
+      if (!fs.existsSync('./.theia'))
+        fs.mkdirSync('./.theia')
+      if (!fs.existsSync('./.theia/settings.json')) {
+        fs.writeFileSync(
+          './.theia/settings.json',
+          JSON.stringify(
+            {
+              'editor.autoSave': value,
+            },
+            null,
+            4,
+          ),
+        )
+      }
+    }
+  },
+}
+
+export default Gitpod

package/src/managers/server/index.ts

@@ -1,69 +1,78 @@
-import * as express from "express";
-// eslint-disable-next-line
-import * as cors from "cors";
-import * as http from "http";
-import Console from "../../utils/console";
-import addRoutes from "./routes";
-import cli from "cli-ux";
-import { IConfigObj } from "../../models/config";
-import { IConfigManager } from "../../models/config-manager";
-
-export let TEST_SERVER: http.Server;
-
-export default async function (
-  configObj: IConfigObj,
-  configManager: IConfigManager,
-  isTestingEnvironment = false
-) {
-  const { config } = configObj;
-  const app = express();
-  const server = require("http").Server(app);
-  app.use(cors());
-
-  // app.use(function(req, res, next) {
-  //     res.header("Access-Control-Allow-Origin", "*")
-  //     res.header("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept")
-  //     res.header("Access-Control-Allow-Methods", "GET,PUT")
-  //     next()
-  // })
-
-  // add all needed endpoints
-  await addRoutes(app, configObj, configManager);
-
-  server.listen(isTestingEnvironment ? 5000 : config?.port, function () {
-    if (!isTestingEnvironment) {
-      Console.success(
-        `Exercises are running 😃 Open your browser to start practicing!`
-      );
-      Console.success(`\n            Open the exercise on this link:`);
-      Console.log(`            ${config?.publicUrl}`);
-      if (config?.editor.mode === "standalone") 
-cli.open(`${config.publicUrl}`);
-    }
-  });
-
-  const sockets: any = new Set();
-
-  server.on("connection", (socket: any) => {
-    sockets.add(socket);
-
-    server.once("close", () => {
-      sockets.delete(socket);
-    });
-  });
-
-  /**
-   * Forcefully terminates HTTP server.
-   */
-  server.terminate = (callback: void) => {
-    for (const socket of sockets) {
-      socket.destroy();
-
-      sockets.delete(socket);
-    }
-
-    server.close(callback);
-  };
-
-  return server;
-}
+import * as express from "express"
+// eslint-disable-next-line
+import * as cors from "cors";
+import * as http from "http"
+import Console from "../../utils/console"
+import addRoutes from "./routes"
+import cli from "cli-ux"
+import { IConfigObj } from "../../models/config"
+import { IConfigManager } from "../../models/config-manager"
+
+export let TEST_SERVER: http.Server
+
+export default async function (
+  configObj: IConfigObj,
+  configManager: IConfigManager,
+  isTestingEnvironment = false
+) {
+  const { config } = configObj
+  const app = express()
+  let server: any
+
+  if (isTestingEnvironment) {
+    if (TEST_SERVER === undefined) 
+TEST_SERVER = require("http").Server(app)
+    server = TEST_SERVER
+  } else 
+server = require("http").Server(app)
+
+  app.use(cors())
+
+  // app.use(function(req, res, next) {
+  //     res.header("Access-Control-Allow-Origin", "*")
+  //     res.header("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept")
+  //     res.header("Access-Control-Allow-Methods", "GET,PUT")
+  //     next()
+  // })
+
+  // add all needed endpoints
+
+  await addRoutes(app, configObj, configManager)
+
+  server.listen(isTestingEnvironment ? 5000 : config?.port, function () {
+    if (!isTestingEnvironment) {
+      Console.success(
+        `Exercises are running 😃 Open your browser to start practicing!`
+      )
+      Console.success(`\n            Open the exercise on this link:`)
+      Console.log(`            ${config?.publicUrl}`)
+      if (config?.editor.mode === "standalone") 
+cli.open(`${config.publicUrl}`)
+    }
+  })
+
+  const sockets: any = new Set()
+
+  server.on("connection", (socket: any) => {
+    sockets.add(socket)
+
+    server.once("close", () => {
+      sockets.delete(socket)
+    })
+  })
+
+  /**
+   * Forcefully terminates HTTP server.
+   */
+  server.terminate = (callback: void) => {
+    for (const socket of sockets) {
+      socket.destroy()
+
+      sockets.delete(socket)
+    }
+
+    server.close(callback)
+  }
+
+  return server
+}