@learnpack/learnpack 5.0.11 → 5.0.13

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @learnpack/learnpack
 $ learnpack COMMAND
 running command...
 $ learnpack (-v|--version|version)
-@learnpack/learnpack/5.0.11 win32-x64 node-v20.16.0
+@learnpack/learnpack/5.0.13 win32-x64 node-v20.16.0
 $ learnpack --help [COMMAND]
 USAGE
   $ learnpack COMMAND
@@ -75,7 +75,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/v5.0.11/src\commands\audit.ts)_
+_See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.13/src\commands\audit.ts)_
 
 ## `learnpack clean`
 
@@ -90,7 +90,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.11/src\commands\clean.ts)_
+_See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.13/src\commands\clean.ts)_
 
 ## `learnpack download [PACKAGE]`
 
@@ -108,7 +108,7 @@ DESCRIPTION
   Extra documentation goes here
 ```
 
-_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.11/src\commands\download.ts)_
+_See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.13/src\commands\download.ts)_
 
 ## `learnpack help [COMMAND]`
 
@@ -139,7 +139,7 @@ OPTIONS
   -h, --grading  show CLI help
 ```
 
-_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.11/src\commands\init.ts)_
+_See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.13/src\commands\init.ts)_
 
 ## `learnpack login [PACKAGE]`
 
@@ -157,7 +157,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.11/src\commands\login.ts)_
+_See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.13/src\commands\login.ts)_
 
 ## `learnpack logout [PACKAGE]`
 
@@ -175,7 +175,7 @@ DESCRIPTION
      Extra documentation goes here
 ```
 
-_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.11/src\commands\logout.ts)_
+_See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.13/src\commands\logout.ts)_
 
 ## `learnpack plugins`
 
@@ -306,7 +306,7 @@ OPTIONS
   -h, --help  show CLI help
 ```
 
-_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.11/src\commands\publish.ts)_
+_See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.13/src\commands\publish.ts)_
 
 ## `learnpack start`
 
@@ -327,7 +327,7 @@ OPTIONS
   -w, --watch                         Watch for file changes
 ```
 
-_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.11/src\commands\start.ts)_
+_See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.13/src\commands\start.ts)_
 
 ## `learnpack test [EXERCISESLUG]`
 
@@ -341,7 +341,7 @@ ARGUMENTS
   EXERCISESLUG  The name of the exercise to test
 ```
 
-_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.11/src\commands\test.ts)_
+_See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.13/src\commands\test.ts)_
 
 ## `learnpack translate`
 
@@ -352,7 +352,7 @@ USAGE
   $ learnpack translate
 ```
 
-_See code: [src\commands\translate.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.11/src\commands\translate.ts)_
+_See code: [src\commands\translate.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.13/src\commands\translate.ts)_
 <!-- commandsstop -->
 
 > > > > > > > 0cb3e56d84c197f9d008836bb573eade212b7e57

package/lib/commands/start.js

@@ -69,6 +69,7 @@ class StartCommand extends SessionCommand_1.default {
                         compilations: [],
                         tests: [],
                         is_testeable: e.graded || false,
+                        quiz_submissions: [],
                     }));
                     if (path && steps.length > 0) {
                         telemetry_1.default.start(agent, steps, path, tutorialSlug);
@@ -141,6 +142,10 @@ class StartCommand extends SessionCommand_1.default {
                         telemetry: telemetry_1.default,
                     });
                 });
+                socket_1.default.on("quiz_submission", (data) => {
+                    const { stepPosition, event, eventData } = data;
+                    telemetry_1.default.registerStepEvent(stepPosition, event, eventData);
+                });
                 socket_1.default.on("ai_interaction", (data) => {
                     const { stepPosition, event, eventData } = data;
                     telemetry_1.default.registerStepEvent(stepPosition, event, eventData);

package/lib/managers/server/routes.js

@@ -134,6 +134,11 @@ async function default_1(app, configObject, configManager) {
         const payload = await session_1.default.getPayload();
         if (payload && payload.rigobot && payload.rigobot.key) {
             res.json({ rigoToken: payload.rigobot.key, payload: payload });
+            telemetry_1.default.setStudent({
+                user_id: payload.user_id,
+                email: payload.email,
+                token: payload.token,
+            });
         }
         else {
             res

package/lib/managers/session.js

@@ -49,8 +49,13 @@ const Session = {
     },
     setPayload: async function (value) {
         await this.initialize();
-        await storage.setItem("bc-payload", Object.assign({ token: this.token }, value));
+        await storage.setItem("bc-payload", Object.assign({}, value));
         console_1.default.debug("Payload successfuly found and set for " + value.email);
+        // TelemetryManager.setStudent({
+        //   user_id: value.user_id.toString(),
+        //   email: value.email,
+        //   token: value.token,
+        // })
         return true;
     },
     getPayload: async function () {

package/lib/managers/telemetry.d.ts

@@ -20,6 +20,16 @@ type TAIInteraction = {
     starting_at: number;
     ending_at: number;
 };
+type TQuizSelection = {
+    question: string;
+    answer: string;
+    isCorrect: boolean;
+};
+type TQuizSubmission = {
+    quiz_hash: string;
+    selections: TQuizSelection[];
+    submitted_at: number;
+};
 export type TStep = {
     slug: string;
     position: number;
@@ -30,6 +40,7 @@ export type TStep = {
     compilations: TCompilationAttempt[];
     tests: TTestAttempt[];
     ai_interactions: TAIInteraction[];
+    quiz_submissions: TQuizSubmission[];
 };
 type TWorkoutSession = {
     started_at: number;
@@ -45,20 +56,27 @@ export interface ITelemetryJSONSchema {
     user_id?: number | string;
     slug: string;
     agent?: string;
-    tutorial_started_at?: number;
-    last_interaction_at?: number;
+    tutorial_started_at: number;
+    last_interaction_at: number;
     steps: Array<TStep>;
     workout_session: TWorkoutSession[];
 }
-type TStepEvent = "compile" | "test" | "ai_interaction" | "open_step";
+type TStepEvent = "compile" | "test" | "ai_interaction" | "open_step" | "quiz_submission";
 export type TTelemetryUrls = {
     streaming?: string;
     batch?: string;
 };
+type TUser = {
+    token: string;
+    id: string;
+    email: string;
+};
 interface ITelemetryManager {
     current: ITelemetryJSONSchema | null;
     configPath: string | null;
+    user: TUser;
     urls: TTelemetryUrls;
+    started: boolean;
     salute: (message: string) => void;
     start: (agent: string, steps: TStep[], path: string, tutorialSlug: string) => void;
     prevStep?: number;

package/lib/managers/telemetry.js

@@ -13,7 +13,13 @@ function stringToBase64(input) {
 const TelemetryManager = {
     current: null,
     urls: {},
+    user: {
+        token: "",
+        id: "",
+        email: "",
+    },
     configPath: "",
+    started: false,
     salute: message => {
         console_1.default.info(message);
     },
@@ -33,6 +39,7 @@ const TelemetryManager = {
                         slug: tutorialSlug,
                         agent,
                         tutorial_started_at: Date.now(),
+                        last_interaction_at: Date.now(),
                         steps,
                         workout_session: [
                             {
@@ -41,7 +48,16 @@ const TelemetryManager = {
                         ],
                     };
                 }
+                if (this.current.user_id) {
+                    this.user.id = this.current.user_id.toString();
+                }
                 this.save();
+                this.started = true;
+                console_1.default.debug("Telemetry started successfully!");
+                if (!this.user.id) {
+                    console_1.default.debug("No user ID found, impossible to submit telemetry at start");
+                    return;
+                }
                 this.submit();
             })
                 .catch(error => {
@@ -52,18 +68,16 @@ const TelemetryManager = {
             });
         }
     },
-    // verifyStudent: function () {
-    //   if (!this.current) {
-    //     return;
-    //   }
-    //   if (!this.current.user_id) {
-    //   }
-    // },
     setStudent: function (student) {
         if (!this.current) {
+            console_1.default.debug("Telemetry has not been started");
             return;
         }
+        console_1.default.debug("Setting student", student);
         this.current.user_id = student.user_id;
+        this.user.id = student.user_id;
+        this.user.token = student.token;
+        this.user.email = student.email;
         this.save();
         this.submit();
     },
@@ -83,6 +97,7 @@ const TelemetryManager = {
         }
     },
     registerStepEvent: function (stepPosition, event, data) {
+        console_1.default.debug(`Registering Event ${event} for user ${this.user.id}`);
         if (!this.current) {
             // throw new Error("Telemetry has not been started");
             return;
@@ -129,6 +144,13 @@ const TelemetryManager = {
                 }
                 step.ai_interactions.push(data);
                 break;
+            case "quiz_submission": {
+                if (!step.quiz_submissions) {
+                    step.quiz_submissions = [];
+                }
+                step.quiz_submissions.push(data);
+                break;
+            }
             case "open_step": {
                 const now = Date.now();
                 if (!step.opened_at) {
@@ -178,13 +200,23 @@ const TelemetryManager = {
     },
     submit: async function () {
         console_1.default.debug("Submitting telemetry...");
-        if (!this.current)
+        if (!this.current) {
+            console_1.default.debug("Telemetry has not been started");
+            return Promise.resolve();
+        }
+        if (!this.user.id) {
+            console_1.default.debug("User ID not found, skipping batch telemetry delivery");
             return Promise.resolve();
+        }
         const url = this.urls.batch;
         if (!url) {
-            return;
+            console_1.default.debug("Batch URL not found, skipping batch telemetry delivery");
+            return Promise.resolve();
         }
         const body = this.current;
+        if (!body.user_id) {
+            body.user_id = this.user.id;
+        }
         api_1.default.sendBatchTelemetry(url, body);
     },
     save: function () {

package/lib/models/session.d.ts

@@ -1,6 +1,8 @@
 import { IConfig, IConfigObj } from "./config";
 export interface IPayload {
     email: string;
+    user_id: number;
+    token: string;
 }
 export interface IStartProps {
     token: string;

package/lib/utils/api.d.ts

@@ -8,7 +8,7 @@ declare const _default: {
         lang?: string;
         slug?: string;
     }) => Promise<any>;
-    sendBatchTelemetry: (url: string, body: object) => Promise<void>;
+    sendBatchTelemetry: (url: string, body: any) => Promise<void>;
     sendStreamTelemetry: (url: string, body: object) => Promise<void>;
 };
 export default _default;

package/lib/utils/api.js

@@ -207,16 +207,21 @@ const sendBatchTelemetry = async function (url, body) {
     if (!session ||
         !Object.prototype.hasOwnProperty.call(session, "token") ||
         session.token === "") {
-        console_1.default.debug("No token found, skipping stream telemetry delivery");
+        console_1.default.debug("No token found, skipping batch telemetry delivery");
+        return;
+    }
+    if (!session || !session.user_id || session.user_id === "") {
+        console_1.default.debug("No user_id found, skipping batch telemetry delivery");
         return;
     }
+    body.user_id = session.user_id;
     fetch(url, {
         method: "POST",
         body: JSON.stringify(body),
     }, false)
         .then(response => {
         console_1.default.debug("Telemetry sent successfully");
-        return response.text();
+        return response;
     })
         .catch(error => {
         console_1.default.debug("Error while sending batch Telemetry", error);

package/lib/utils/checkNotInstalled.js

@@ -160,6 +160,7 @@ const checkNotInstalledDependencies = async (neededPlugins) => {
         await installDependencies(jsPluginsDependencies, "npm");
     }
     if (pytestNeeded) {
+        await exec("pip install --upgrade pip");
         const { stdout, stderr } = await exec("pip list");
         if (stderr) {
             console_1.default.error(`Error executing pip list. Use debug for more info`);

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"5.0.11","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":"Builds the project by copying necessary files and directories into a zip file","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"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":"[preview, extension]","options":["extension","preview"]},"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}]},"translate":{"id":"translate","description":"List all the lessons, the user is able of select many of them to translate to the given languages","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]}}}
+{"version":"5.0.13","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":"Builds the project by copying necessary files and directories into a zip file","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"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":"[preview, extension]","options":["extension","preview"]},"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}]},"translate":{"id":"translate","description":"List all the lessons, the user is able of select many of them to translate to the given languages","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]}}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@learnpack/learnpack",
   "description": "Seamlessly build, sell and/or take interactive & auto-graded tutorials, start learning now or build a new tutorial to your audience.",
-  "version": "5.0.11",
+  "version": "5.0.13",
   "author": "Alejandro Sanchez @alesanchezr",
   "contributors": [
     {

package/src/commands/start.ts

@@ -157,6 +157,7 @@ export default class StartCommand extends SessionCommand {
               compilations: [],
               tests: [],
               is_testeable: e.graded || false,
+              quiz_submissions: [],
             })
           )
           if (path && steps.length > 0) {
@@ -248,6 +249,11 @@ export default class StartCommand extends SessionCommand {
           })
         })
 
+        socket.on("quiz_submission", (data: any) => {
+          const { stepPosition, event, eventData } = data
+          TelemetryManager.registerStepEvent(stepPosition, event, eventData)
+        })
+
         socket.on("ai_interaction", (data: any) => {
           const { stepPosition, event, eventData } = data
           TelemetryManager.registerStepEvent(stepPosition, event, eventData)

package/src/managers/server/routes.ts

@@ -177,6 +177,12 @@ export default async function (
 
       if (payload && payload.rigobot && payload.rigobot.key) {
         res.json({ rigoToken: payload.rigobot.key, payload: payload })
+
+        TelemetryManager.setStudent({
+          user_id: payload.user_id,
+          email: payload.email,
+          token: payload.token,
+        })
       } else {
         res
           .status(400)

package/src/managers/session.ts

@@ -66,8 +66,15 @@ const Session: ISession = {
   },
   setPayload: async function (value: IPayload) {
     await this.initialize()
-    await storage.setItem("bc-payload", { token: this.token, ...value })
+    await storage.setItem("bc-payload", { ...value })
     Console.debug("Payload successfuly found and set for " + value.email)
+
+    // TelemetryManager.setStudent({
+    //   user_id: value.user_id.toString(),
+    //   email: value.email,
+    //   token: value.token,
+    // })
+
     return true
   },
   getPayload: async function () {
@@ -128,6 +135,7 @@ 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,

package/src/managers/telemetry.ts

@@ -1,353 +1,423 @@
-import { IFile } from "../models/file"
-import API from "../utils/api"
-import Console from "../utils/console"
-
-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 TAIInteraction = {
-  student_message: string;
-  source_code: string;
-  ai_response: string;
-  starting_at: number;
-  ending_at: number;
-};
-
-export type TStep = {
-  slug: string;
-  position: number;
-  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 TStudent = {
-  token: string;
-  user_id: string;
-  email: string;
-};
-
-export interface ITelemetryJSONSchema {
-  telemetry_id?: string;
-  user_id?: number | string;
-  slug: string;
-  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: ITelemetryJSONSchema | null;
-  configPath: string | null;
-  urls: TTelemetryUrls;
-  salute: (message: string) => void;
-  start: (
-    agent: string,
-    steps: TStep[],
-    path: string,
-    tutorialSlug: 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;
-  retrieve: () => Promise<ITelemetryJSONSchema | null>;
-}
-
-const TelemetryManager: ITelemetryManager = {
-  current: null,
-  urls: {},
-  configPath: "",
-  salute: message => {
-    Console.info(message)
-  },
-
-  start: function (agent, steps, path, tutorialSlug) {
-    this.configPath = path
-    if (!this.current) {
-      this.retrieve()
-        .then(data => {
-          const prevTelemetry = data
-          if (prevTelemetry) {
-            this.current = prevTelemetry
-            this.finishWorkoutSession()
-          } else {
-            this.current = {
-              telemetry_id: createUUID(),
-              slug: tutorialSlug,
-              agent,
-              tutorial_started_at: Date.now(),
-              steps,
-              workout_session: [
-                {
-                  started_at: Date.now(),
-                },
-              ],
-            }
-          }
-
-          this.save()
-          this.submit()
-        })
-        .catch(error => {
-          Console.debug(error)
-          // Delete the telemetry.json if it exists
-          fs.unlinkSync(`${this.configPath}/telemetry.json`)
-          throw new Error(
-            "There was a problem starting, reload LearnPack\nRun\n$ learnpack start"
-          )
-        })
-    }
-  },
-  // verifyStudent: function () {
-  //   if (!this.current) {
-  //     return;
-  //   }
-
-  //   if (!this.current.user_id) {
-
-  //   }
-  // },
-
-  setStudent: function (student) {
-    if (!this.current) {
-      return
-    }
-
-    this.current.user_id = student.user_id
-    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) {
-      // 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)
-    }
-
-    if (Object.prototype.hasOwnProperty.call(data, "exitCode")) {
-      data.exit_code = data.exitCode
-      data.exitCode = undefined
-    }
-
-    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: any, data: any) => {
-          if (err) {
-            if (err.code === "ENOENT") {
-              // File does not exist, resolve with undefined
-              resolve(null)
-            } else {
-              reject(err)
-            }
-          } else {
-            try {
-              resolve(JSON.parse(data))
-            } catch (error) {
-              reject(error)
-            }
-          }
-        }
-      )
-    })
-  },
-
-  submit: async function () {
-    Console.debug("Submitting telemetry...")
-
-    if (!this.current) 
-return Promise.resolve()
-    const url = this.urls.batch
-    if (!url) {
-      return
-    }
-
-    const body = this.current
-
-    API.sendBatchTelemetry(url, body)
-  },
-  save: function () {
-    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
-    }
-
-    const stepSlug = this.current.steps[stepPosition].slug
-
-    const body = {
-      slug: stepSlug,
-      telemetry_id: this.current.telemetry_id,
-      user_id: this.current.user_id,
-      step_position: stepPosition,
-      event,
-      data,
-    }
-
-    API.sendStreamTelemetry(url, body)
-  },
-}
-
-export default TelemetryManager
+import { IFile } from "../models/file"
+import API from "../utils/api"
+import Console from "../utils/console"
+
+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 TAIInteraction = {
+  student_message: string
+  source_code: string
+  ai_response: string
+  starting_at: number
+  ending_at: number
+}
+
+type TQuizSelection = {
+  question: string
+  answer: string
+  isCorrect: boolean
+}
+
+type TQuizSubmission = {
+  quiz_hash: string
+  selections: TQuizSelection[]
+  submitted_at: number
+}
+
+export type TStep = {
+  slug: string
+  position: number
+  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
+  quiz_submissions: TQuizSubmission[] // Everytime the user submits a quiz
+}
+
+type TWorkoutSession = {
+  started_at: number
+  ended_at?: number
+}
+
+type TStudent = {
+  token: string
+  user_id: string
+  email: string
+}
+
+export interface ITelemetryJSONSchema {
+  telemetry_id?: string
+  user_id?: number | string
+  slug: string
+  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"
+  | "quiz_submission"
+
+export type TTelemetryUrls = {
+  streaming?: string
+  batch?: string
+}
+
+type TUser = {
+  token: string
+  id: string
+  email: string
+}
+
+interface ITelemetryManager {
+  current: ITelemetryJSONSchema | null
+  configPath: string | null
+  user: TUser
+  urls: TTelemetryUrls
+  started: boolean
+  salute: (message: string) => void
+  start: (
+    agent: string,
+    steps: TStep[],
+    path: string,
+    tutorialSlug: 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
+  retrieve: () => Promise<ITelemetryJSONSchema | null>
+}
+
+const TelemetryManager: ITelemetryManager = {
+  current: null,
+  urls: {},
+  user: {
+    token: "",
+    id: "",
+    email: "",
+  },
+  configPath: "",
+  started: false,
+  salute: message => {
+    Console.info(message)
+  },
+
+  start: function (agent, steps, path, tutorialSlug) {
+    this.configPath = path
+    if (!this.current) {
+      this.retrieve()
+        .then(data => {
+          const prevTelemetry = data
+          if (prevTelemetry) {
+            this.current = prevTelemetry
+            this.finishWorkoutSession()
+          } else {
+            this.current = {
+              telemetry_id: createUUID(),
+              slug: tutorialSlug,
+              agent,
+              tutorial_started_at: Date.now(),
+              last_interaction_at: Date.now(),
+              steps,
+              workout_session: [
+                {
+                  started_at: Date.now(),
+                },
+              ],
+            }
+          }
+
+          if (this.current.user_id) {
+            this.user.id = this.current.user_id.toString()
+          }
+
+          this.save()
+
+          this.started = true
+          Console.debug("Telemetry started successfully!")
+
+          if (!this.user.id) {
+            Console.debug(
+              "No user ID found, impossible to submit telemetry at start"
+            )
+            return
+          }
+
+          this.submit()
+        })
+        .catch(error => {
+          Console.debug(error)
+          // Delete the telemetry.json if it exists
+          fs.unlinkSync(`${this.configPath}/telemetry.json`)
+          throw new Error(
+            "There was a problem starting, reload LearnPack\nRun\n$ learnpack start"
+          )
+        })
+    }
+  },
+
+  setStudent: function (student) {
+    if (!this.current) {
+      Console.debug("Telemetry has not been started")
+
+      return
+    }
+
+    Console.debug("Setting student", student)
+
+    this.current.user_id = student.user_id
+    this.user.id = student.user_id
+    this.user.token = student.token
+    this.user.email = student.email
+    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) {
+    Console.debug(`Registering Event ${event} for user ${this.user.id}`)
+
+    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)
+    }
+
+    if (Object.prototype.hasOwnProperty.call(data, "exitCode")) {
+      data.exit_code = data.exitCode
+      data.exitCode = undefined
+    }
+
+    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 "quiz_submission": {
+        if (!step.quiz_submissions) {
+          step.quiz_submissions = []
+        }
+
+        step.quiz_submissions.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: any, data: any) => {
+          if (err) {
+            if (err.code === "ENOENT") {
+              // File does not exist, resolve with undefined
+              resolve(null)
+            } else {
+              reject(err)
+            }
+          } else {
+            try {
+              resolve(JSON.parse(data))
+            } catch (error) {
+              reject(error)
+            }
+          }
+        }
+      )
+    })
+  },
+
+  submit: async function () {
+    Console.debug("Submitting telemetry...")
+
+    if (!this.current) {
+      Console.debug("Telemetry has not been started")
+      return Promise.resolve()
+    }
+
+    if (!this.user.id) {
+      Console.debug("User ID not found, skipping batch telemetry delivery")
+      return Promise.resolve()
+    }
+
+    const url = this.urls.batch
+    if (!url) {
+      Console.debug("Batch URL not found, skipping batch telemetry delivery")
+      return Promise.resolve()
+    }
+
+    const body = this.current
+
+    if (!body.user_id) {
+      body.user_id = this.user.id
+    }
+
+    API.sendBatchTelemetry(url, body)
+  },
+  save: function () {
+    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
+    }
+
+    const stepSlug = this.current.steps[stepPosition].slug
+
+    const body = {
+      slug: stepSlug,
+      telemetry_id: this.current.telemetry_id,
+      user_id: this.current.user_id,
+      step_position: stepPosition,
+      event,
+      data,
+    }
+
+    API.sendStreamTelemetry(url, body)
+  },
+}
+
+export default TelemetryManager

package/src/models/session.ts

@@ -2,6 +2,8 @@ import { IConfig, IConfigObj } from "./config"
 
 export interface IPayload {
   email: string
+  user_id: number
+  token: string
 }
 
 export interface IStartProps {

package/src/utils/api.ts

@@ -229,7 +229,7 @@ const APIError = (error: TypeError | string, code?: number) => {
   return _err
 }
 
-const sendBatchTelemetry = async function (url: string, body: object) {
+const sendBatchTelemetry = async function (url: string, body: any) {
   if (!url) {
     return
   }
@@ -240,10 +240,17 @@ const sendBatchTelemetry = async function (url: string, body: object) {
     !Object.prototype.hasOwnProperty.call(session, "token") ||
     session.token === ""
   ) {
-    Console.debug("No token found, skipping stream telemetry delivery")
+    Console.debug("No token found, skipping batch telemetry delivery")
+    return
+  }
+
+  if (!session || !session.user_id || session.user_id === "") {
+    Console.debug("No user_id found, skipping batch telemetry delivery")
     return
   }
 
+  body.user_id = session.user_id
+
   fetch(
     url,
     {
@@ -254,7 +261,7 @@ const sendBatchTelemetry = async function (url: string, body: object) {
   )
     .then(response => {
       Console.debug("Telemetry sent successfully")
-      return response.text()
+      return response
     })
     .catch(error => {
       Console.debug("Error while sending batch Telemetry", error)

package/src/utils/checkNotInstalled.ts

@@ -222,6 +222,8 @@ return true
   }
 
   if (pytestNeeded) {
+    await exec("pip install --upgrade pip")
+
     const { stdout, stderr } = await exec("pip list")
     if (stderr) {
       Console.error(`Error executing pip list. Use debug for more info`)