@learnpack/learnpack 2.0.18 → 2.0.19

package/lib/managers/file.js

@@ -1,134 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.rmSync = exports.clone = exports.download = exports.downloadEditor = exports.decompress = void 0;
-const fs = require("fs");
-const p = require("path");
-const shell = require("shelljs");
-const cli_ux_1 = require("cli-ux");
-const targz = require("targz");
-const console_1 = require("../utils/console");
-const https = require("https");
-const errors_1 = require("../utils/errors");
-// eslint-disable-next-line
-const fetch = require("node-fetch");
-exports.decompress = (sourcePath, destinationPath) => new Promise((resolve, reject) => {
-    console_1.default.debug("Decompressing " + sourcePath);
-    targz.decompress({
-        src: sourcePath,
-        dest: destinationPath,
-    }, function (err) {
-        if (err) {
-            console_1.default.error("Error when trying to decompress");
-            reject(err);
-        }
-        else {
-            console_1.default.info("Decompression finished successfully");
-            resolve(/* */ "");
-        }
-    });
-});
-exports.downloadEditor = async (version, destination) => {
-    // 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 errors_1.InternalError(`Coding Editor ${version} was not found on learnpack repository, check the config.editor.version property on learn.json`);
-    console_1.default.info("Downloading the LearnPack coding UI, this may take a minute...");
-    return exports.download(`https://github.com/learnpack/coding-ide/blob/${version}/dist/app.tar.gz?raw=true`, destination);
-};
-exports.download = (url, dest) => {
-    console_1.default.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_1.default.debug("File already exists");
-                        resolve("File already exists");
-                    }
-                    else {
-                        console_1.default.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) {
-                    exports.download(response.headers.location, dest)
-                        .then(() => resolve(/* */ ""))
-                        .catch(error => {
-                        console_1.default.error(error);
-                        reject(error);
-                    });
-                }
-            }
-            else {
-                console_1.default.debug(`Server responded with ${response.statusCode}: ${response.statusMessage}`);
-                reject(`Server responded with ${response.statusCode}: ${response.statusMessage}`);
-            }
-        });
-        request.on("error", err => {
-            reject(err.message);
-        });
-    });
-};
-exports.clone = (repository = "", folder = "./") => new Promise((resolve, reject) => {
-    if (!repository) {
-        reject("Missing repository url for this package");
-        // return false
-    }
-    cli_ux_1.cli.action.start("Verifying GIT...");
-    if (!shell.which("git")) {
-        reject("Sorry, this script requires git");
-        // return false
-    }
-    cli_ux_1.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_ux_1.cli.action.start(`Cloning repository ${repository}...`);
-    if (shell.exec(`git clone ${repository}`).code !== 0) {
-        reject("Error: Installation failed");
-    }
-    cli_ux_1.cli.action.stop();
-    cli_ux_1.cli.action.start("Cleaning installation...");
-    if (shell.exec(`rm -R -f ${folder}${fileName}/.git`).code !== 0) {
-        reject("Error: removing .git directory");
-    }
-    cli_ux_1.cli.action.stop();
-    resolve("Done");
-});
-exports.rmSync = function (path) {
-    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
-                exports.rmSync(curPath);
-            }
-            else {
-                // delete file
-                fs.unlinkSync(curPath);
-            }
-        }
-        fs.rmdirSync(path);
-    }
-};
-exports.default = { download: exports.download, decompress: exports.decompress, downloadEditor: exports.downloadEditor, clone: exports.clone, rmSync: exports.rmSync };

package/lib/managers/gitpod.d.ts

@@ -1,3 +0,0 @@
-import { IGitpod } from '../models/gitpod-data';
-declare const Gitpod: IGitpod;
-export default Gitpod;

package/lib/managers/gitpod.js

@@ -1,67 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const console_1 = require("../utils/console");
-const shell = require("shelljs");
-const socket_1 = require("./socket");
-const fs = require("fs");
-const Gitpod = {
-    socket: null,
-    config: null,
-    initialized: false,
-    hasGPCommand: false,
-    init: function (config) {
-        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_1.default.debug('Gitpod command line tool not found');
-        }
-    },
-    openFiles: async function (files) {
-        var _a;
-        console_1.default.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 || ((_a = this.config.config) === null || _a === void 0 ? void 0 : _a.grading) !== 'isolated') {
-            console_1.default.debug('Files cannot be automatically opened because we are not on isolated grading (only for isolated)');
-            socket_1.default.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_1.default.debug(`Error opening file ${f} on gitpod`);
-                }
-            }
-        socket_1.default.log('ready', ['Ready to compile or test...']);
-    },
-    setup(config) {
-        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));
-            }
-        }
-    },
-};
-exports.default = Gitpod;

package/lib/managers/server/index.d.ts

@@ -1,6 +0,0 @@
-/// <reference types="node" />
-import * as http from "http";
-import { IConfigObj } from "../../models/config";
-import { IConfigManager } from "../../models/config-manager";
-export declare let TEST_SERVER: http.Server;
-export default function (configObj: IConfigObj, configManager: IConfigManager, isTestingEnvironment?: boolean): Promise<any>;

package/lib/managers/server/index.js

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TEST_SERVER = void 0;
-const express = require("express");
-// eslint-disable-next-line
-const cors = require("cors");
-const console_1 = require("../../utils/console");
-const routes_1 = require("./routes");
-const cli_ux_1 = require("cli-ux");
-async function default_1(configObj, configManager, 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 routes_1.default(app, configObj, configManager);
-    server.listen(isTestingEnvironment ? 5000 : config === null || config === void 0 ? void 0 : config.port, function () {
-        if (!isTestingEnvironment) {
-            console_1.default.success(`Exercises are running 😃 Open your browser to start practicing!`);
-            console_1.default.success(`\n            Open the exercise on this link:`);
-            console_1.default.log(`            ${config === null || config === void 0 ? void 0 : config.publicUrl}`);
-            if ((config === null || config === void 0 ? void 0 : config.editor.mode) === "standalone")
-                cli_ux_1.default.open(`${config.publicUrl}`);
-        }
-    });
-    const sockets = new Set();
-    server.on("connection", (socket) => {
-        sockets.add(socket);
-        server.once("close", () => {
-            sockets.delete(socket);
-        });
-    });
-    /**
-     * Forcefully terminates HTTP server.
-     */
-    server.terminate = (callback) => {
-        for (const socket of sockets) {
-            socket.destroy();
-            sockets.delete(socket);
-        }
-        server.close(callback);
-    };
-    return server;
-}
-exports.default = default_1;

package/lib/managers/server/routes.d.ts

@@ -1,4 +0,0 @@
-import * as express from "express";
-import { IConfigObj } from "../../models/config";
-import { IConfigManager } from "../../models/config-manager";
-export default function (app: express.Application, configObject: IConfigObj, configManager: IConfigManager): Promise<void>;

package/lib/managers/server/routes.js

@@ -1,160 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const console_1 = require("../../utils/console");
-const express = require("express");
-const fs = require("fs");
-const bodyParser = require("body-parser");
-const socket_1 = require("../socket");
-const fileQueue_1 = require("../../utils/fileQueue");
-// import gitpod from '../gitpod'
-const exercise_1 = require("../config/exercise");
-const withHandler = (func) => (req, res) => {
-    try {
-        func(req, res);
-    }
-    catch (error) {
-        console_1.default.debug(error);
-        const _err = {
-            message: error.message || "There has been an error",
-            status: error.status || 500,
-            type: error.type || null,
-        };
-        console_1.default.error(_err.message);
-        // send rep to the server
-        res.status(_err.status);
-        res.json(_err);
-    }
-};
-async function default_1(app, configObject, configManager) {
-    const { config, exercises } = configObject;
-    const dispatcher = fileQueue_1.default.dispatcher({
-        create: true,
-        path: `${config === null || config === void 0 ? void 0 : config.dirPath}/vscode_queue.json`,
-    });
-    app.get("/config", withHandler((_, res) => {
-        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 === null || config === void 0 ? void 0 : 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 === null || config === void 0 ? void 0 : config.dirPath.indexOf("./")) === 0 ?
-        config.dirPath.slice(1) : config === null || config === void 0 ? void 0 : config.dirPath}/assets/:filePath`, fetchStaticAsset);
-    app.get("/assets/:filePath", fetchStaticAsset);
-    app.get("/exercise", withHandler((_, res) => {
-        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);
-            res.json(readme);
-        }
-        else {
-            res.status(400);
-        }
-    }));
-    app.get("/exercise/:slug/report", withHandler(({ params: { slug } }, res) => {
-        const report = configManager.getExercise(slug).getTestReport();
-        res.json(JSON.stringify(report));
-    }));
-    app.get("/exercise/:slug", withHandler((req, res) => {
-        var _a, _b, _c, _d;
-        // 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);
-        const entries = new Set(Object.keys(config === null || config === void 0 ? void 0 : config.entries).map(lang => config === null || config === void 0 ? void 0 : config.entries[lang]));
-        // 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 === null || config === void 0 ? void 0 : config.grading) === "incremental") {
-            const scanedFiles = fs.readdirSync("./");
-            // update the file hierarchy with updates
-            exercise.files = [
-                ...exercise.files.filter(f => f.name.includes("test.")),
-                ...exercise_1.filterFiles(scanedFiles),
-            ];
-            console_1.default.debug(`Exercise updated files: `, exercise.files);
-        }
-        const detected = exercise_1.detect(configObject, exercise.files
-            .filter(fileName => entries.has(fileName.name))
-            .map(f => f.name || f));
-        // if a new language for the testing engine is detected, we replace it
-        // if not we leave it as it was before
-        if ((config === null || config === void 0 ? void 0 : config.language) && !["", "auto"].includes(config === null || config === void 0 ? void 0 : config.language)) {
-            console_1.default.debug(`Exercise language ignored, instead imported from configuration ${config === null || config === void 0 ? void 0 : config.language}`);
-            exercise.language = detected === null || detected === void 0 ? void 0 : detected.language;
-        }
-        else if ((detected === null || detected === void 0 ? void 0 : detected.language) &&
-            (!(config === null || config === void 0 ? void 0 : config.language) || (config === null || config === void 0 ? void 0 : config.language) === "auto")) {
-            console_1.default.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 === null || detected === void 0 ? void 0 : detected.entry;
-        console_1.default.debug(`Exercise detected entry: ${detected === null || detected === void 0 ? void 0 : detected.entry} and language ${exercise.language}`);
-        if (!exercise.graded || (config === null || config === void 0 ? void 0 : config.disableGrading) || ((_a = config === null || config === void 0 ? void 0 : config.disabledActions) === null || _a === void 0 ? void 0 : _a.includes("test"))) {
-            socket_1.default.removeAllowed("test");
-        }
-        else {
-            socket_1.default.addAllowed("test");
-        }
-        if (!exercise.entry || ((_b = config === null || config === void 0 ? void 0 : config.disabledActions) === null || _b === void 0 ? void 0 : _b.includes("build"))) {
-            socket_1.default.removeAllowed("build");
-        }
-        else {
-            socket_1.default.addAllowed("build");
-        }
-        if (exercise.files.filter((f) => !f.name.toLowerCase().includes("readme.") &&
-            !f.name.toLowerCase().includes("test.")).length === 0 || ((_c = config === null || config === void 0 ? void 0 : config.disabledActions) === null || _c === void 0 ? void 0 : _c.includes("reset"))) {
-            socket_1.default.removeAllowed("reset");
-        }
-        else if (!((_d = config === null || config === void 0 ? void 0 : config.disabledActions) === null || _d === void 0 ? void 0 : _d.includes("reset"))) {
-            socket_1.default.addAllowed("reset");
-        }
-        socket_1.default.log("ready");
-        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 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();
-    }));
-    if (config === null || config === void 0 ? void 0 : config.outputPath) {
-        app.use("/preview", express.static(config.outputPath));
-    }
-    app.use("/", express.static(`${config === null || config === void 0 ? void 0 : config.dirPath}/_app`));
-}
-exports.default = default_1;

package/lib/managers/session.d.ts

@@ -1,3 +0,0 @@
-import { ISession } from '../models/session';
-declare const Session: ISession;
-export default Session;

package/lib/managers/session.js

@@ -1,104 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const console_1 = require("../utils/console");
-const api_1 = require("../utils/api");
-const validator_1 = require("validator");
-const errors_1 = require("../utils/errors");
-// import moment from 'moment'
-const fs = require("fs");
-const cli_ux_1 = require("cli-ux");
-const storage = require("node-persist");
-const Session = {
-    sessionStarted: false,
-    token: null,
-    config: null,
-    currentCohort: null,
-    initialize: async function () {
-        if (!this.sessionStarted) {
-            if (!this.config) {
-                throw errors_1.InternalError('Configuration not found');
-            }
-            if (!fs.existsSync(this.config.dirPath)) {
-                fs.mkdirSync(this.config.dirPath);
-            }
-            await storage.init({ dir: `${this.config.dirPath}/.session` });
-            this.sessionStarted = true;
-        }
-        return true;
-    },
-    setPayload: async function (value) {
-        await this.initialize();
-        await storage.setItem('bc-payload', Object.assign({ token: this.token }, value));
-        console_1.default.debug('Payload successfuly found and set for ' + value.email);
-        return true;
-    },
-    getPayload: async function () {
-        await this.initialize();
-        let payload = null;
-        try {
-            payload = await storage.getItem('bc-payload');
-        }
-        catch (error) {
-            // TODO: Remove it
-            console.log(error);
-            console_1.default.debug('Error retriving session payload');
-        }
-        return payload;
-    },
-    isActive: function () {
-        /* if (this.token) {
-          return true
-        } else {
-          return false
-        } */
-        return !!this.token;
-    },
-    get: async function (configObj) {
-        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_ux_1.default.prompt('What is your email?');
-        if (!validator_1.default.isEmail(email)) {
-            throw errors_1.ValidationError('Invalid email');
-        }
-        const password = await cli_ux_1.default.prompt('What is your password?', {
-            type: 'hide',
-        });
-        const data = await api_1.default.login(email, password);
-        if (data) {
-            this.start({ token: data.token, payload: data });
-        }
-    },
-    sync: async function () {
-        const payload = await this.getPayload();
-        if (payload) {
-            this.token = payload.token;
-        }
-    },
-    start: async function ({ token, payload = null }) {
-        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_1.default.success(`Successfully logged in as ${payload.email}`);
-        }
-    },
-    destroy: async function () {
-        await storage.clear();
-        this.token = null;
-        console_1.default.success('You have logged out');
-    },
-};
-exports.default = Session;

package/lib/managers/socket.d.ts

@@ -1,3 +0,0 @@
-import { ISocket } from '../models/socket';
-declare const SocketManager: ISocket;
-export default SocketManager;