@learnpack/learnpack 1.0.0 → 2.0.0

package/src/managers/config/index.ts

@@ -0,0 +1,411 @@
+import * as path from "path";
+import * as fs from "fs";
+import * as shell from "shelljs";
+import Console from "../../utils/console";
+import watch from "../../utils/watcher";
+import {
+  ValidationError,
+  NotFoundError,
+  InternalError,
+} from "../../utils/errors";
+
+import defaults from "./defaults";
+import { exercise } from "./exercise";
+
+import { rmSync } from "../file";
+import { IConfigObj, TConfigObjAttributes, TMode } from "../../models/config";
+import {
+  IConfigManagerAttributes,
+  IConfigManager,
+} from "../../models/config-manager";
+import { IFile } from "../../models/file";
+
+/* exercise folder name standard */
+
+// eslint-disable-next-line
+const fetch = require("node-fetch");
+// eslint-disable-next-line
+const chalk = require("chalk");
+
+/* exercise folder name standard */
+
+const getConfigPath = () => {
+  const possibleFileNames = [
+    "learn.json",
+    ".learn/learn.json",
+    "bc.json",
+    ".breathecode/bc.json",
+  ];
+  const config = possibleFileNames.find(file => fs.existsSync(file)) || null;
+  if (config && fs.existsSync(".breathecode"))
+    return { config, base: ".breathecode" };
+  if (config === null)
+    throw NotFoundError(
+      "learn.json file not found on current folder, is this a learnpack package?"
+    );
+  return { config, base: ".learn" };
+};
+
+const getExercisesPath = (base: string) => {
+  const possibleFileNames = ["./exercises", base + "/exercises", "./"];
+  return possibleFileNames.find(file => fs.existsSync(file)) || null;
+};
+
+const getGitpodAddress = () => {
+  if (shell.exec("gp -h", { silent: true }).code === 0) {
+    return shell
+      .exec("gp url", { silent: true })
+      .stdout.replace(/(\r\n|\n|\r)/gm, "");
+  }
+
+  Console.debug("Gitpod command line tool not found");
+  return "http://localhost";
+};
+
+export default async ({
+  grading,
+  mode,
+  disableGrading,
+  version,
+}: IConfigManagerAttributes): Promise<IConfigManager> => {
+  const confPath = getConfigPath();
+  Console.debug("This is the config path: ", confPath);
+
+  let configObj: IConfigObj = {};
+
+  if (confPath) {
+    const bcContent = fs.readFileSync(confPath.config);
+
+    let hiddenBcContent = {};
+    if (fs.existsSync(confPath.base + "/config.json")) {
+      hiddenBcContent = fs.readFileSync(confPath.base + "/config.json");
+      hiddenBcContent = JSON.parse(hiddenBcContent as string);
+      if (!hiddenBcContent)
+        throw new Error(
+          `Invalid ${confPath.base}/config.json syntax: Unable to parse.`
+        );
+    }
+
+    const jsonConfig = JSON.parse(`${bcContent}`);
+    if (!jsonConfig)
+      throw new Error(`Invalid ${confPath.config} syntax: Unable to parse.`);
+
+    let session: number;
+
+    // add using id to the installation
+    if (!jsonConfig.session) {
+      session = Math.floor(Math.random() * 10_000_000_000_000_000_000);
+    } else {
+      session = jsonConfig.session;
+      delete jsonConfig.session;
+    }
+
+    configObj = deepMerge(hiddenBcContent, {
+      config: jsonConfig,
+      session: session,
+    });
+    Console.debug("Content from the configuration .json ", configObj);
+  } else {
+    throw ValidationError(
+      "No learn.json file has been found, make sure you are in the folder"
+    );
+  }
+
+  configObj = deepMerge(defaults || {}, configObj, {
+    config: {
+      grading: grading || configObj.config?.grading,
+      configPath: confPath.config,
+    },
+  });
+
+  if (configObj.config) {
+    configObj.config.outputPath = confPath.base + "/dist";
+  }
+
+  Console.debug("This is your configuration object: ", {
+    ...configObj,
+    exercises: configObj.exercises ? configObj.exercises.map(e => e.slug) : [],
+  });
+
+  // auto detect agent (if possible)
+  if (shell.which("gp") && configObj && configObj.config) {
+    configObj.config.editor.agent = "gitpod";
+    configObj.address = getGitpodAddress();
+    configObj.config.publicUrl = `https://${
+      configObj.config.port
+    }-${configObj.address?.slice(8)}`;
+  } else if (configObj.config && !configObj.config.editor.agent) {
+    configObj.config.editor.agent = "localhost";
+  }
+
+  if (configObj.config && !configObj.config.publicUrl)
+    configObj.config.publicUrl = `${configObj.address}:${configObj.config.port}`;
+
+  // Assign default editor mode if not set already
+  if (configObj.config && mode !== null) {
+    configObj.config.editor.mode = (mode as TMode) || ("vscode" as TMode);
+  }
+
+  if (configObj.config && !configObj.config.editor.mode)
+    configObj.config.editor.mode =
+      configObj.config.editor.agent === "localhost" ? "standalone" : "preview";
+
+  if (version && configObj.config) 
+    configObj.config.editor.version = version;
+
+  else if (configObj.config && configObj.config.editor.version === null) {
+    Console.debug("Config version not found, downloading default.");
+    const resp = await fetch(
+      "https://raw.githubusercontent.com/learnpack/coding-ide/learnpack/package.json"
+    );
+    const packageJSON = await resp.json();
+    configObj.config.editor.version = packageJSON.version || "1.0.72";
+  }
+
+  if (configObj.config) {
+    configObj.config.dirPath = "./" + confPath.base;
+    configObj.config.exercisesPath = getExercisesPath(confPath.base) || "./";
+  }
+
+  return {
+    validLanguages: {},
+    get: () => configObj,
+    validateEngine: function (language: string, server: any, socket: any) {
+      // eslint-disable-next-line
+      const alias = (_l: string) => {
+        const map: any = {
+          python3: "python",
+        };
+        if (map[_l]) 
+          return map[_l];
+        return _l;
+      };
+
+      // decode aliases
+      language = alias(language);
+
+      if (this.validLanguages[language]) 
+        return true;
+
+      Console.debug(`Validating engine for ${language} compilation`);
+      let result = shell.exec("learnpack plugins", { silent: true });
+
+      if (
+        result.code === 0 &&
+        result.stdout.includes(`learnpack-${language}`)
+      ) {
+        this.validLanguages[language] = true;
+        return true;
+      }
+
+      Console.info(`Language engine for ${language} not found, installing...`);
+      result = shell.exec(`learnpack plugins:install learnpack-${language}`, {
+        silent: true,
+      });
+      if (result.code === 0) {
+        socket.log(
+          "compiling",
+          "Installing the python compiler, you will have to reset the exercises after installation by writing on your terminal: $ learnpack run"
+        );
+        Console.info(
+          `Successfully installed the ${language} exercise engine, \n please start learnpack again by running the following command: \n ${chalk.white(
+            "$ learnpack start"
+          )}\n\n `
+        );
+        server.terminate();
+        return false;
+      }
+
+      this.validLanguages[language] = false;
+      socket.error(`Error installing ${language} exercise engine`);
+      Console.error(`Error installing ${language} exercise engine`);
+      Console.log(result.stdout);
+      throw InternalError(`Error installing ${language} exercise engine`);
+    },
+    clean: () => {
+      if (configObj.config) {
+        if (configObj.config.outputPath) {
+          rmSync(configObj.config.outputPath);
+        }
+
+        rmSync(configObj.config.dirPath + "/_app");
+        rmSync(configObj.config.dirPath + "/reports");
+        rmSync(configObj.config.dirPath + "/.session");
+        rmSync(configObj.config.dirPath + "/resets");
+
+        // clean tag gz
+        if (fs.existsSync(configObj.config.dirPath + "/app.tar.gz"))
+          fs.unlinkSync(configObj.config.dirPath + "/app.tar.gz");
+
+        if (fs.existsSync(configObj.config.dirPath + "/config.json"))
+          fs.unlinkSync(configObj.config.dirPath + "/config.json");
+
+        if (fs.existsSync(configObj.config.dirPath + "/vscode_queue.json"))
+          fs.unlinkSync(configObj.config.dirPath + "/vscode_queue.json");
+      }
+    },
+    getExercise: slug => {
+      Console.debug("ExercisePath Slug", slug);
+      const exercise = (configObj.exercises || []).find(
+        ex => ex.slug === slug
+      );
+      if (!exercise) 
+throw ValidationError(`Exercise ${slug} not found`);
+
+      return exercise;
+    },
+    getAllExercises: () => {
+      return configObj.exercises;
+    },
+    startExercise: function (slug: string) {
+      const exercise = this.getExercise(slug);
+
+      // set config.json with current exercise
+      configObj.currentExercise = exercise.slug;
+
+      this.save();
+
+      // eslint-disable-next-line
+      exercise.files.forEach((f: IFile) => {
+        if (configObj.config) {
+          const _path = configObj.config.outputPath + "/" + f.name;
+          if (f.hidden === false && fs.existsSync(_path)) 
+fs.unlinkSync(_path);
+        }
+      });
+
+      return exercise;
+    },
+    noCurrentExercise: function () {
+      configObj.currentExercise = null;
+      this.save();
+    },
+    reset: slug => {
+      if (
+        configObj.config &&
+        !fs.existsSync(`${configObj.config.dirPath}/resets/` + slug)
+      )
+        throw ValidationError("Could not find the original files for " + slug);
+
+      const exercise = (configObj.exercises || []).find(
+        ex => ex.slug === slug
+      );
+      if (!exercise)
+        throw ValidationError(
+          `Exercise ${slug} not found on the configuration`
+        );
+
+      if (configObj.config) {
+        for (const fileName of fs.readdirSync(
+          `${configObj.config.dirPath}/resets/${slug}/`
+        )) {
+          const content = fs.readFileSync(
+            `${configObj.config?.dirPath}/resets/${slug}/${fileName}`
+          );
+          fs.writeFileSync(`${exercise.path}/${fileName}`, content);
+        }
+      }
+    },
+    buildIndex: function () {
+      Console.info("Building the exercise index...");
+
+      const isDirectory = (source: string) => {
+        const name = path.basename(source);
+        if (name === path.basename(configObj?.config?.dirPath || ""))
+          return false;
+        // ignore folders that start with a dot
+        if (name.charAt(0) === "." || name.charAt(0) === "_") 
+return false;
+
+        return fs.lstatSync(source).isDirectory();
+      };
+
+      const getDirectories = (source: string) =>
+        fs
+          .readdirSync(source)
+          .map(name => path.join(source, name))
+          .filter(isDirectory);
+      // add the .learn folder
+      if (!fs.existsSync(confPath.base)) 
+fs.mkdirSync(confPath.base);
+      // add the outout folder where webpack will publish the the html/css/js files
+      if (
+        configObj.config &&
+        configObj.config.outputPath &&
+        !fs.existsSync(configObj.config.outputPath)
+      )
+        fs.mkdirSync(configObj.config.outputPath);
+
+      // TODO: we could use npm library front-mater to read the title of the exercises from the README.md
+      const grupedByDirectory = getDirectories(
+        configObj?.config?.exercisesPath || ""
+      );
+      configObj.exercises =
+        grupedByDirectory.length > 0 ?
+          grupedByDirectory.map((path, position) =>
+              exercise(path, position, configObj)
+            ) :
+          [exercise(configObj?.config?.exercisesPath || "", 0, configObj)];
+      this.save();
+    },
+    watchIndex: function (onChange: () => void) {
+      if (configObj.config && !configObj.config.exercisesPath)
+        throw ValidationError(
+          "No exercises directory to watch: " + configObj.config.exercisesPath
+        );
+
+      this.buildIndex();
+      watch(configObj?.config?.exercisesPath || "")
+        .then((/* eventname, filename */) => {
+          Console.debug("Changes detected on your exercises");
+          this.buildIndex();
+          if (onChange) 
+onChange();
+        })
+        .catch(error => {
+          throw error;
+        });
+    },
+    save: () => {
+      Console.debug("Saving configuration with: ", configObj);
+
+      // remove the duplicates form the actions array
+      // configObj.config.actions = [...new Set(configObj.config.actions)];
+      if (configObj.config) {
+        configObj.config.translations = [
+          ...new Set(configObj.config.translations),
+        ];
+
+        fs.writeFileSync(
+          configObj.config.dirPath + "/config.json",
+          JSON.stringify(configObj, null, 4)
+        );
+      }
+    },
+  } as IConfigManager;
+};
+
+function deepMerge(...sources: any): any {
+  let acc: any = {};
+  for (const source of sources) {
+    if (Array.isArray(source)) {
+      if (!Array.isArray(acc)) {
+        acc = [];
+      }
+
+      acc = [...source];
+    } else if (source instanceof Object) {
+      // eslint-disable-next-line
+      for (let [key, value] of Object.entries(source)) {
+        if (value instanceof Object && key in acc) {
+          value = deepMerge(acc[key], value);
+        }
+
+        if (value !== undefined) 
+acc = { ...acc, [key]: value };
+      }
+    }
+  }
+
+  return acc;
+}

package/src/managers/file.ts

@@ -0,0 +1,169 @@
+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 };

package/src/managers/gitpod.ts

@@ -0,0 +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