@learnpack/learnpack 2.1.32 → 2.1.33

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @learnpack/learnpack
 $ learnpack COMMAND
 running command...
 $ learnpack (-v|--version|version)
-@learnpack/learnpack/2.1.32 darwin-arm64 node-v16.20.0
+@learnpack/learnpack/2.1.33 darwin-arm64 node-v16.20.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.32/src/commands/audit.ts)_
+_See code: [src/commands/audit.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.33/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.32/src/commands/clean.ts)_
+_See code: [src/commands/clean.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.33/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.32/src/commands/download.ts)_
+_See code: [src/commands/download.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.33/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.32/src/commands/init.ts)_
+_See code: [src/commands/init.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.33/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.32/src/commands/login.ts)_
+_See code: [src/commands/login.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.33/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.32/src/commands/logout.ts)_
+_See code: [src/commands/logout.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.33/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.32/src/commands/publish.ts)_
+_See code: [src/commands/publish.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.33/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.32/src/commands/start.ts)_
+_See code: [src/commands/start.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.33/src/commands/start.ts)_
 
 ## `learnpack test [EXERCISESLUG]`
 
@@ -344,7 +344,7 @@ ARGUMENTS
   EXERCISESLUG  The name of the exercise to test
 ```
 
-_See code: [src/commands/test.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.32/src/commands/test.ts)_
+_See code: [src/commands/test.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.33/src/commands/test.ts)_
 <!-- commandsstop -->
 
 > > > > > > > 0cb3e56d84c197f9d008836bb573eade212b7e57

package/lib/commands/start.js

@@ -6,10 +6,10 @@ const SessionCommand_1 = require("../utils/SessionCommand");
 const console_1 = require("../utils/console");
 const socket_1 = require("../managers/socket");
 const telemetry_1 = require("../managers/telemetry");
+const server_1 = require("../managers/server");
 const fileQueue_1 = require("../utils/fileQueue");
 const file_1 = require("../managers/file");
 const misc_1 = require("../utils/misc");
-const server_1 = require("../managers/server");
 class StartCommand extends SessionCommand_1.default {
     // 🛑 IMPORTANT
     // Every command that will use the configManager needs this init method
@@ -18,7 +18,7 @@ class StartCommand extends SessionCommand_1.default {
         await this.initSession(flags);
     }
     async run() {
-        var _a, _b, _c;
+        var _a, _b, _c, _d, _e;
         // get configuration object
         const configObject = (_a = this.configManager) === null || _a === void 0 ? void 0 : _a.get();
         const config = configObject === null || configObject === void 0 ? void 0 : configObject.config;
@@ -42,6 +42,25 @@ class StartCommand extends SessionCommand_1.default {
                     create: true,
                     path: `${config.dirPath}/vscode_queue.json`,
                 });
+                if (configObject.exercises) {
+                    const agent = ((_d = configObject.config) === null || _d === void 0 ? void 0 : _d.editor.agent) || "";
+                    const path = ((_e = configObject.config) === null || _e === void 0 ? void 0 : _e.dirPath) || "";
+                    const steps = configObject.exercises.map((e, index) => ({
+                        slug: e.slug,
+                        position: e.position || index,
+                        files: e.files,
+                        ai_interactions: [],
+                        compilations: [],
+                        tests: [],
+                        is_testeable: e.graded || false,
+                    }));
+                    if (path && steps.length > 0) {
+                        telemetry_1.default.start(agent, steps, path);
+                    }
+                    if (config.telemetry) {
+                        telemetry_1.default.urls = config.telemetry;
+                    }
+                }
                 socket_1.default.start(config, server, false);
                 socket_1.default.on("open", (data) => {
                     console_1.default.debug("Opening these files: ", data);
@@ -91,11 +110,12 @@ class StartCommand extends SessionCommand_1.default {
                         socket: socket_1.default,
                         configuration: config,
                         exercise,
+                        telemetry: telemetry_1.default,
                     });
                 });
-                socket_1.default.on("telemetry", (data) => {
-                    console_1.default.info("Registering telemetry event: ", data);
-                    telemetry_1.default.registerEvent(data);
+                socket_1.default.on("ai_interaction", (data) => {
+                    const { stepPosition, event, eventData } = data;
+                    telemetry_1.default.registerStepEvent(stepPosition, event, eventData);
                 });
                 socket_1.default.on("test", async (data) => {
                     var _a, _b;
@@ -116,12 +136,14 @@ class StartCommand extends SessionCommand_1.default {
                         socket: socket_1.default,
                         configuration: config,
                         exercise,
+                        telemetry: telemetry_1.default,
                     });
                     (_b = this.configManager) === null || _b === void 0 ? void 0 : _b.save();
                     return true;
                 });
                 const terminate = () => {
                     console_1.default.debug("Terminating Learnpack...");
+                    telemetry_1.default.submit();
                     server.terminate(() => {
                         var _a;
                         (_a = this.configManager) === null || _a === void 0 ? void 0 : _a.noCurrentExercise();

package/lib/managers/server/routes.js

@@ -9,6 +9,7 @@ const fileQueue_1 = require("../../utils/fileQueue");
 // import gitpod from '../gitpod'
 const exercise_1 = require("../config/exercise");
 const session_1 = require("../../managers/session");
+const telemetry_1 = require("../telemetry");
 const withHandler = (func) => (req, res) => {
     try {
         func(req, res);
@@ -117,9 +118,15 @@ async function default_1(app, configObject, configManager) {
             req.params.slug === configObject.currentExercise) {
             const exercise = configManager.getExercise(req.params.slug);
             res.json(exercise);
+            if (exercise.position) {
+                telemetry_1.default.registerStepEvent(exercise.position, "open_step", {});
+            }
             return;
         }
         const exercise = configManager.startExercise(req.params.slug);
+        if (exercise.position) {
+            telemetry_1.default.registerStepEvent(exercise.position, "open_step", {});
+        }
         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

package/lib/managers/session.js

@@ -7,6 +7,7 @@ const errors_1 = require("../utils/errors");
 const fs = require("fs");
 const cli_ux_1 = require("cli-ux");
 const storage = require("node-persist");
+const telemetry_1 = require("./telemetry");
 const Session = {
     sessionStarted: false,
     token: null,
@@ -92,6 +93,11 @@ const Session = {
         const data = await api_1.default.login(email, password);
         if (data) {
             this.start({ token: data.token, payload: data });
+            telemetry_1.default.setStudent({
+                user_id: data.user_id,
+                email: data.email,
+                token: data.token,
+            });
             return data;
         }
     },

package/lib/managers/telemetry.d.ts

@@ -1,26 +1,73 @@
-declare type TEventType = "form_submit" | "build" | "test" | "visualize_step" | "code_start";
-declare type TFile = {
-    name: string;
-    content: string;
+import { IFile } from "../models/file";
+declare type TCompilationAttempt = {
+    source_code: string;
+    stdout: string;
+    exit_code: number;
+    starting_at: number;
+    ending_at: number;
 };
-declare type TStep = {
-    name: string;
+declare type TTestAttempt = {
+    source_code: string;
+    stdout: string;
+    exit_code: number;
+    starting_at: number;
+    ending_at: number;
+};
+declare type TAIInteraction = {
+    student_message: string;
+    source_code: string;
+    ai_response: string;
+    starting_at: number;
+    ending_at: number;
+};
+export declare type TStep = {
+    slug: string;
     position: number;
-    files: TFile[];
+    files: IFile[];
+    is_testeable: boolean;
+    opened_at?: number;
+    completed_at?: number;
+    compilations: TCompilationAttempt[];
+    tests: TTestAttempt[];
+    ai_interactions: TAIInteraction[];
+};
+declare type TWorkoutSession = {
+    started_at: number;
+    ended_at?: number;
 };
-declare type TTelemetryEvent = {
-    type: TEventType;
-    data: any;
-    timestamp: number;
-    step: TStep;
+declare type TStudent = {
+    token: string;
+    user_id: string;
+    email: string;
+};
+export interface ITelemetryJSONSchema {
+    telemetry_id?: string;
+    student?: TStudent;
+    agent?: string;
+    tutorial_started_at?: number;
+    last_interaction_at?: number;
+    steps: Array<TStep>;
+    workout_session: TWorkoutSession[];
+}
+declare type TStepEvent = "compile" | "test" | "ai_interaction" | "open_step";
+export declare type TTelemetryUrls = {
+    streaming?: string;
+    batch?: string;
 };
 interface ITelemetryManager {
-    current: Array<TTelemetryEvent> | null;
-    start: () => void;
-    submit: () => void;
-    registerEvent: (event: Omit<TTelemetryEvent, "timestamp">) => void;
+    current: ITelemetryJSONSchema | null;
+    configPath: string | null;
+    urls: TTelemetryUrls;
+    salute: (message: string) => void;
+    start: (agent: string, steps: TStep[], path: string) => void;
+    prevStep?: number;
+    registerStepEvent: (stepPosition: number, event: TStepEvent, data: any) => void;
+    streamEvent: (stepPosition: number, event: string, data: any) => void;
+    submit: () => Promise<void>;
+    finishWorkoutSession: () => void;
+    setStudent: (student: TStudent) => void;
     save: () => void;
-    onSaveCallback?: (current: Array<TTelemetryEvent>) => void;
+    retrieve: (agent: string, steps: TStep[]) => Promise<ITelemetryJSONSchema | null>;
 }
 declare const TelemetryManager: ITelemetryManager;
 export default TelemetryManager;

package/lib/managers/telemetry.js

@@ -1,25 +1,218 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const fs = require("fs");
+function createUUID() {
+    return (Math.random().toString(36).slice(2, 10) +
+        Math.random().toString(36).slice(2, 10));
+}
+function stringToBase64(input) {
+    return Buffer.from(input).toString("base64");
+}
 const TelemetryManager = {
     current: null,
-    start: function () {
+    urls: {},
+    configPath: "",
+    salute: message => {
+        console.log(message);
+    },
+    start: function (agent, steps, path) {
+        this.configPath = path;
         if (!this.current) {
-            this.current = [];
+            this.retrieve(agent, steps)
+                .then(data => {
+                const prevTelemetry = data;
+                if (prevTelemetry) {
+                    this.current = prevTelemetry;
+                    this.finishWorkoutSession();
+                }
+                else {
+                    this.current = {
+                        telemetry_id: createUUID(),
+                        agent,
+                        tutorial_started_at: Date.now(),
+                        steps,
+                        workout_session: [
+                            {
+                                started_at: Date.now(),
+                            },
+                        ],
+                    };
+                }
+                this.save();
+                this.submit();
+            })
+                .catch(error => {
+                console.error(error);
+            });
         }
     },
-    submit: function () {
-        console.log("submit");
+    setStudent: function (student) {
+        if (!this.current) {
+            return;
+        }
+        this.current.student = student;
+        this.save();
+        this.submit();
     },
-    registerEvent: function (event) {
-        var _a;
-        this.start();
-        const timestamp = Date.now();
-        const _event = Object.assign(Object.assign({}, event), { timestamp });
-        (_a = this.current) === null || _a === void 0 ? void 0 : _a.push(_event);
+    finishWorkoutSession: function () {
+        var _a, _b;
+        if (!this.current) {
+            return;
+        }
+        const lastSession = (_a = this.current) === null || _a === void 0 ? void 0 : _a.workout_session[this.current.workout_session.length - 1];
+        if (lastSession &&
+            !lastSession.ended_at && ((_b = this.current) === null || _b === void 0 ? void 0 : _b.last_interaction_at)) {
+            lastSession.ended_at = this.current.last_interaction_at;
+            this.current.workout_session.push({
+                started_at: Date.now(),
+            });
+        }
+    },
+    registerStepEvent: function (stepPosition, event, data) {
+        if (!this.current) {
+            // throw new Error("Telemetry has not been started");
+            return;
+        }
+        const step = this.current.steps[stepPosition];
+        if (!step) {
+            return;
+        }
+        if (data.source_code) {
+            data.source_code = stringToBase64(data.source_code);
+        }
+        if (data.stdout) {
+            data.stdout = stringToBase64(data.stdout);
+        }
+        if (data.stderr) {
+            data.stderr = stringToBase64(data.stderr);
+        }
+        switch (event) {
+            case "compile":
+                if (!step.compilations) {
+                    step.compilations = [];
+                }
+                step.compilations.push(data);
+                this.current.steps[stepPosition] = step;
+                break;
+            case "test":
+                if (!step.tests) {
+                    step.tests = [];
+                }
+                // data.stdout =
+                step.tests.push(data);
+                if (data.exit_code === 0) {
+                    step.completed_at = Date.now();
+                }
+                this.current.steps[stepPosition] = step;
+                break;
+            case "ai_interaction":
+                if (!step.ai_interactions) {
+                    step.ai_interactions = [];
+                }
+                step.ai_interactions.push(data);
+                break;
+            case "open_step": {
+                const now = Date.now();
+                if (!step.opened_at) {
+                    step.opened_at = now;
+                    this.current.steps[stepPosition] = step;
+                }
+                if (this.prevStep || this.prevStep === 0) {
+                    const prevStep = this.current.steps[this.prevStep];
+                    if (!prevStep.is_testeable && !prevStep.completed_at) {
+                        prevStep.completed_at = now;
+                        this.current.steps[this.prevStep] = prevStep;
+                    }
+                }
+                this.prevStep = stepPosition;
+                this.submit();
+                break;
+            }
+            default:
+                throw new Error(`Event type ${event} is not supported`);
+        }
+        this.current.last_interaction_at = Date.now();
+        this.streamEvent(stepPosition, event, data);
+        this.save();
+    },
+    retrieve: function () {
+        return new Promise((resolve, reject) => {
+            fs.readFile(`${this.configPath}/telemetry.json`, "utf8", (err, data) => {
+                if (err) {
+                    if (err.code === "ENOENT") {
+                        // File does not exist, resolve with undefined
+                        resolve(null);
+                    }
+                    else {
+                        reject(err);
+                    }
+                }
+                else {
+                    resolve(JSON.parse(data));
+                }
+            });
+        });
+    },
+    submit: async function () {
+        if (!this.current)
+            return Promise.resolve();
+        const url = this.urls.batch;
+        if (!url) {
+            return;
+            // throw new Error("Batch URL not specified");
+        }
+        const body = this.current;
+        fetch(url, {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: JSON.stringify(body),
+        })
+            .then(response => {
+            return response.text();
+        })
+            .catch(error => {
+            console.log("Error", error);
+        });
     },
     save: function () {
-        if (this.onSaveCallback && this.current) {
-            this.onSaveCallback(this.current);
+        fs.writeFile(`${this.configPath}/telemetry.json`, JSON.stringify(this.current), (err) => {
+            if (err)
+                throw err;
+        });
+    },
+    streamEvent: async function (stepPosition, event, data) {
+        var _a;
+        if (!this.current)
+            return;
+        const url = this.urls.streaming;
+        if (!url) {
+            return;
+            // throw new Error("Streaming URL not specified");
+        }
+        const stepSlug = this.current.steps[stepPosition].slug;
+        const body = {
+            slug: stepSlug,
+            telemetry_id: this.current.telemetry_id,
+            user_id: (_a = this.current.student) === null || _a === void 0 ? void 0 : _a.user_id,
+            step_position: stepPosition,
+            event,
+            data,
+        };
+        try {
+            const response = await fetch(url, {
+                method: "POST",
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: JSON.stringify(body),
+            });
+            const responseText = await response.text();
+        }
+        catch (error) {
+            error;
+            // Console.error(error);
         }
     },
 };

package/lib/models/config.d.ts

@@ -1,4 +1,5 @@
 import { IExercise } from "./exercise-obj";
+import { TTelemetryUrls } from "../managers/telemetry";
 export declare type TGrading = "isolated" | "incremental" | "no-grading";
 export declare type TMode = "preview" | "standalone";
 export declare type TConfigAction = "test" | "build" | "tutorial" | "reset" | "generate";
@@ -49,6 +50,7 @@ export interface IConfig {
     bugsLink?: string;
     videoSolutions?: boolean;
     skills: Array<string>;
+    telemetry?: TTelemetryUrls;
     runHook: (...agrs: Array<any>) => void;
     testingFinishedCallback: (arg: any | undefined) => void;
 }

package/lib/models/session.d.ts

@@ -6,6 +6,11 @@ export interface IStartProps {
     token: string;
     payload: IPayload | null;
 }
+declare type TLoginResponse = {
+    token: string;
+    user_id: string;
+    email: string;
+};
 export interface ISession {
     sessionStarted: boolean;
     token: string | null;
@@ -18,8 +23,9 @@ export interface ISession {
     isActive: () => boolean;
     get: (config?: IConfigObj) => Promise<any>;
     login: () => Promise<void>;
-    loginWeb: (email: string, password: string) => Promise<void>;
+    loginWeb: (email: string, password: string) => Promise<TLoginResponse>;
     sync: () => Promise<void>;
     start: ({ token, payload }: IStartProps) => Promise<void>;
     destroy: () => Promise<void>;
 }
+export {};

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"2.1.32","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.33","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.32",
+  "version": "2.1.33",
   "author": "Alejandro Sanchez @alesanchezr",
   "bin": {
     "learnpack": "bin/run"

package/src/commands/start.ts

@@ -4,8 +4,8 @@ import { flags } from "@oclif/command"
 import SessionCommand from "../utils/SessionCommand"
 import Console from "../utils/console"
 import socket from "../managers/socket"
-import TelemetryManager from "../managers/telemetry"
-
+import TelemetryManager, { TStep } from "../managers/telemetry"
+import createServer from "../managers/server"
 import queue from "../utils/fileQueue"
 import {
   decompress,
@@ -14,8 +14,6 @@ import {
 } from "../managers/file"
 import { prioritizeHTMLFile } from "../utils/misc"
 
-import createServer from "../managers/server"
-
 import { IGitpodData } from "../models/gitpod-data"
 import { IExercise, IExerciseData } from "../models/exercise-obj"
 
@@ -118,6 +116,30 @@ export default class StartCommand extends SessionCommand {
           path: `${config.dirPath}/vscode_queue.json`,
         })
 
+        if (configObject.exercises) {
+          const agent = configObject.config?.editor.agent || ""
+          const path = configObject.config?.dirPath || ""
+
+          const steps = configObject.exercises.map(
+            (e: IExercise, index): TStep => ({
+              slug: e.slug,
+              position: e.position || index,
+              files: e.files,
+              ai_interactions: [],
+              compilations: [],
+              tests: [],
+              is_testeable: e.graded || false,
+            })
+          )
+          if (path && steps.length > 0) {
+            TelemetryManager.start(agent, steps, path)
+          }
+
+          if (config.telemetry) {
+            TelemetryManager.urls = config.telemetry
+          }
+        }
+
         socket.start(config, server, false)
 
         socket.on("open", (data: IGitpodData) => {
@@ -184,12 +206,13 @@ export default class StartCommand extends SessionCommand {
             socket,
             configuration: config,
             exercise,
+            telemetry: TelemetryManager,
           })
         })
 
-        socket.on("telemetry", (data: any) => {
-          Console.info("Registering telemetry event: ", data)
-          TelemetryManager.registerEvent(data)
+        socket.on("ai_interaction", (data: any) => {
+          const { stepPosition, event, eventData } = data
+          TelemetryManager.registerStepEvent(stepPosition, event, eventData)
         })
 
         socket.on("test", async (data: IExerciseData) => {
@@ -223,6 +246,7 @@ export default class StartCommand extends SessionCommand {
             socket,
             configuration: config,
             exercise,
+            telemetry: TelemetryManager,
           })
 
           this.configManager?.save()
@@ -232,6 +256,9 @@ export default class StartCommand extends SessionCommand {
 
         const terminate = () => {
           Console.debug("Terminating Learnpack...")
+
+          TelemetryManager.submit()
+
           server.terminate(() => {
             this.configManager?.noCurrentExercise()
             dispatcher.enqueue(dispatcher.events.END)

package/src/managers/server/routes.ts

@@ -11,6 +11,7 @@ import { IConfigObj, TEntries } from "../../models/config"
 import { IConfigManager } from "../../models/config-manager"
 import { IExercise } from "../../models/exercise-obj"
 import SessionManager from "../../managers/session"
+import TelemetryManager from "../telemetry"
 
 const withHandler =
   (func: (req: express.Request, res: express.Response) => void) =>
@@ -177,10 +178,22 @@ export default async function (
       ) {
         const exercise = configManager.getExercise(req.params.slug)
         res.json(exercise)
+        if (exercise.position) {
+          TelemetryManager.registerStepEvent(
+            exercise.position,
+            "open_step",
+            {}
+          )
+        }
+
         return
       }
 
       const exercise = configManager.startExercise(req.params.slug)
+      if (exercise.position) {
+        TelemetryManager.registerStepEvent(exercise.position, "open_step", {})
+      }
+
       dispatcher.enqueue(dispatcher.events.START_EXERCISE, req.params.slug)
 
       type TEntry = "python3" | "html" | "node" | "react" | "java";

package/src/managers/session.ts

@@ -10,6 +10,7 @@ import * as storage from "node-persist"
 
 import { IPayload, ISession, IStartProps } from "../models/session"
 import { IConfigObj } from "../models/config"
+import TelemetryManager from "./telemetry"
 
 const Session: ISession = {
   sessionStarted: false,
@@ -109,6 +110,11 @@ const Session: ISession = {
     const data = await api.login(email, password)
     if (data) {
       this.start({ token: data.token, payload: data })
+      TelemetryManager.setStudent({
+        user_id: data.user_id,
+        email: data.email,
+        token: data.token,
+      })
       return data
     }
   },

package/src/managers/telemetry.ts

@@ -1,56 +1,344 @@
-type TEventType =
-  | "form_submit"
-  | "build"
-  | "test"
-  | "visualize_step"
-  | "code_start";
-
-type TFile = {
-  name: string;
-  content: string;
+import { IFile } from "../models/file"
+
+const fs = require("fs")
+
+function createUUID(): string {
+  return (
+    Math.random().toString(36).slice(2, 10) +
+    Math.random().toString(36).slice(2, 10)
+  )
+}
+
+function stringToBase64(input: string): string {
+  return Buffer.from(input).toString("base64")
+}
+
+type TCompilationAttempt = {
+  source_code: string;
+  stdout: string;
+  exit_code: number;
+  starting_at: number;
+  ending_at: number;
+};
+
+type TTestAttempt = {
+  source_code: string;
+  stdout: string;
+  exit_code: number;
+  starting_at: number;
+  ending_at: number;
 };
 
-type TStep = {
-  name: string;
+type TAIInteraction = {
+  student_message: string;
+  source_code: string;
+  ai_response: string;
+  starting_at: number;
+  ending_at: number;
+};
+
+export type TStep = {
+  slug: string;
   position: number;
-  files: TFile[];
+  files: IFile[];
+  is_testeable: boolean;
+  opened_at?: number; // The time when the step was opened
+  completed_at?: number; // If the step has tests, the time when all the tests passed, else, the time when the user opens the next step
+  compilations: TCompilationAttempt[]; // Everytime the user tries to compile the code
+  tests: TTestAttempt[]; // Everytime the user tries to run the tests
+  ai_interactions: TAIInteraction[]; // Everytime the user interacts with the AI
+};
+
+type TWorkoutSession = {
+  started_at: number;
+  ended_at?: number;
 };
 
-type TTelemetryEvent = {
-  type: TEventType;
-  data: any;
-  timestamp: number;
-  step: TStep;
+type TStudent = {
+  token: string;
+  user_id: string;
+  email: string;
+};
+
+export interface ITelemetryJSONSchema {
+  telemetry_id?: string;
+  student?: TStudent;
+  agent?: string;
+  tutorial_started_at?: number;
+  last_interaction_at?: number;
+  steps: Array<TStep>; // The steps should be the same as the exercise
+  workout_session: TWorkoutSession[]; // It start when the user starts Learnpack, if the last_interaction_at is available, it automatically fills with that
+  // number and start another session
+}
+
+type TStepEvent = "compile" | "test" | "ai_interaction" | "open_step";
+
+export type TTelemetryUrls = {
+  streaming?: string;
+  batch?: string;
 };
 
 interface ITelemetryManager {
-  current: Array<TTelemetryEvent> | null;
-  start: () => void;
-  submit: () => void;
-  registerEvent: (event: Omit<TTelemetryEvent, "timestamp">) => void;
+  current: ITelemetryJSONSchema | null;
+  configPath: string | null;
+  urls: TTelemetryUrls;
+  salute: (message: string) => void;
+  start: (agent: string, steps: TStep[], path: string) => void;
+  prevStep?: number;
+  registerStepEvent: (
+    stepPosition: number,
+    event: TStepEvent,
+    data: any
+  ) => void;
+  streamEvent: (stepPosition: number, event: string, data: any) => void;
+  submit: () => Promise<void>;
+  finishWorkoutSession: () => void;
+  setStudent: (student: TStudent) => void;
   save: () => void;
-  onSaveCallback?: (current: Array<TTelemetryEvent>) => void;
+  retrieve: (
+    agent: string,
+    steps: TStep[]
+  ) => Promise<ITelemetryJSONSchema | null>;
 }
 
 const TelemetryManager: ITelemetryManager = {
   current: null,
-  start: function () {
+  urls: {},
+  configPath: "",
+  salute: message => {
+    console.log(message)
+  },
+
+  start: function (agent, steps, path) {
+    this.configPath = path
+    if (!this.current) {
+      this.retrieve(agent, steps)
+        .then(data => {
+          const prevTelemetry = data
+          if (prevTelemetry) {
+            this.current = prevTelemetry
+            this.finishWorkoutSession()
+          } else {
+            this.current = {
+              telemetry_id: createUUID(),
+              agent,
+              tutorial_started_at: Date.now(),
+              steps,
+              workout_session: [
+                {
+                  started_at: Date.now(),
+                },
+              ],
+            }
+          }
+
+          this.save()
+          this.submit()
+        })
+        .catch(error => {
+          console.error(error)
+        })
+    }
+  },
+
+  setStudent: function (student) {
+    if (!this.current) {
+      return
+    }
+
+    this.current.student = student
+    this.save()
+    this.submit()
+  },
+  finishWorkoutSession: function () {
+    if (!this.current) {
+      return
+    }
+
+    const lastSession =
+      this.current?.workout_session[this.current.workout_session.length - 1]
+    if (
+      lastSession &&
+      !lastSession.ended_at &&
+      this.current?.last_interaction_at
+    ) {
+      lastSession.ended_at = this.current.last_interaction_at
+      this.current.workout_session.push({
+        started_at: Date.now(),
+      })
+    }
+  },
+
+  registerStepEvent: function (stepPosition, event, data) {
     if (!this.current) {
-      this.current = []
+      // throw new Error("Telemetry has not been started");
+      return
+    }
+
+    const step = this.current.steps[stepPosition]
+    if (!step) {
+      return
+    }
+
+    if (data.source_code) {
+      data.source_code = stringToBase64(data.source_code)
+    }
+
+    if (data.stdout) {
+      data.stdout = stringToBase64(data.stdout)
+    }
+
+    if (data.stderr) {
+      data.stderr = stringToBase64(data.stderr)
+    }
+
+    switch (event) {
+      case "compile":
+        if (!step.compilations) {
+          step.compilations = []
+        }
+
+        step.compilations.push(data)
+        this.current.steps[stepPosition] = step
+        break
+      case "test":
+        if (!step.tests) {
+          step.tests = []
+        }
+
+        // data.stdout =
+        step.tests.push(data)
+        if (data.exit_code === 0) {
+          step.completed_at = Date.now()
+        }
+
+        this.current.steps[stepPosition] = step
+        break
+      case "ai_interaction":
+        if (!step.ai_interactions) {
+          step.ai_interactions = []
+        }
+
+        step.ai_interactions.push(data)
+        break
+      case "open_step": {
+        const now = Date.now()
+
+        if (!step.opened_at) {
+          step.opened_at = now
+          this.current.steps[stepPosition] = step
+        }
+
+        if (this.prevStep || this.prevStep === 0) {
+          const prevStep = this.current.steps[this.prevStep]
+          if (!prevStep.is_testeable && !prevStep.completed_at) {
+            prevStep.completed_at = now
+            this.current.steps[this.prevStep] = prevStep
+          }
+        }
+
+        this.prevStep = stepPosition
+
+        this.submit()
+        break
+      }
+
+      default:
+        throw new Error(`Event type ${event} is not supported`)
     }
+
+    this.current.last_interaction_at = Date.now()
+    this.streamEvent(stepPosition, event, data)
+    this.save()
   },
-  submit: function () {
-    console.log("submit")
+  retrieve: function () {
+    return new Promise((resolve, reject) => {
+      fs.readFile(
+        `${this.configPath}/telemetry.json`,
+        "utf8",
+        (err: any, data: any) => {
+          if (err) {
+            if (err.code === "ENOENT") {
+              // File does not exist, resolve with undefined
+              resolve(null)
+            } else {
+              reject(err)
+            }
+          } else {
+            resolve(JSON.parse(data))
+          }
+        }
+      )
+    })
   },
-  registerEvent: function (event) {
-    this.start()
-    const timestamp = Date.now()
-    const _event = { ...event, timestamp }
-    this.current?.push(_event)
+  submit: async function () {
+    if (!this.current) 
+return Promise.resolve()
+    const url = this.urls.batch
+    if (!url) {
+      return
+      // throw new Error("Batch URL not specified");
+    }
+
+    const body = this.current
+    fetch(url, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+      },
+      body: JSON.stringify(body),
+    })
+      .then(response => {
+        return response.text()
+      })
+      .catch(error => {
+        console.log("Error", error)
+      })
   },
   save: function () {
-    if (this.onSaveCallback && this.current) {
-      this.onSaveCallback(this.current)
+    fs.writeFile(
+      `${this.configPath}/telemetry.json`,
+      JSON.stringify(this.current),
+      (err: any) => {
+        if (err) 
+throw err
+      }
+    )
+  },
+
+  streamEvent: async function (stepPosition, event, data) {
+    if (!this.current) 
+return
+
+    const url = this.urls.streaming
+    if (!url) {
+      return
+      // throw new Error("Streaming URL not specified");
+    }
+
+    const stepSlug = this.current.steps[stepPosition].slug
+
+    const body = {
+      slug: stepSlug,
+      telemetry_id: this.current.telemetry_id,
+      user_id: this.current.student?.user_id,
+      step_position: stepPosition,
+      event,
+      data,
+    }
+
+    try {
+      const response = await fetch(url, {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: JSON.stringify(body),
+      })
+      const responseText = await response.text()
+    } catch (error) {
+      error
+      // Console.error(error);
     }
   },
 }

package/src/models/config.ts

@@ -1,4 +1,5 @@
 import { IExercise } from "./exercise-obj"
+import { TTelemetryUrls } from "../managers/telemetry"
 
 export type TGrading = "isolated" | "incremental" | "no-grading";
 
@@ -70,6 +71,7 @@ export interface IConfig {
   bugsLink?: string;
   videoSolutions?: boolean;
   skills: Array<string>;
+  telemetry?: TTelemetryUrls;
   runHook: (...agrs: Array<any>) => void;
   testingFinishedCallback: (arg: any | undefined) => void;
 }

package/src/models/session.ts

@@ -9,6 +9,12 @@ export interface IStartProps {
   payload: IPayload | null;
 }
 
+type TLoginResponse = {
+  token: string;
+  user_id: string;
+  email: string;
+};
+
 export interface ISession {
   sessionStarted: boolean;
   token: string | null;
@@ -21,7 +27,7 @@ export interface ISession {
   isActive: () => boolean;
   get: (config?: IConfigObj) => Promise<any>;
   login: () => Promise<void>;
-  loginWeb: (email: string, password: string) => Promise<void>;
+  loginWeb: (email: string, password: string) => Promise<TLoginResponse>;
   sync: () => Promise<void>;
   start: ({ token, payload }: IStartProps) => Promise<void>;
   destroy: () => Promise<void>;