@learnpack/learnpack 4.0.9 → 4.0.12

package/lib/managers/telemetry.d.ts

@@ -1,74 +1,74 @@
-import { IFile } from "../models/file";
-declare type TCompilationAttempt = {
-    source_code: string;
-    stdout: string;
-    exit_code: number;
-    starting_at: number;
-    ending_at: number;
-};
-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: 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 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>;
-    workout_session: TWorkoutSession[];
-}
-declare type TStepEvent = "compile" | "test" | "ai_interaction" | "open_step";
-export declare 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>;
-}
-declare const TelemetryManager: ITelemetryManager;
-export default TelemetryManager;
+import { IFile } from "../models/file";
+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;
+    completed_at?: number;
+    compilations: TCompilationAttempt[];
+    tests: TTestAttempt[];
+    ai_interactions: TAIInteraction[];
+};
+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>;
+    workout_session: TWorkoutSession[];
+}
+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>;
+}
+declare const TelemetryManager: ITelemetryManager;
+export default TelemetryManager;

package/lib/managers/telemetry.js

@@ -1,214 +1,215 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const api_1 = require("../utils/api");
-const console_1 = require("../utils/console");
-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,
-    urls: {},
-    configPath: "",
-    salute: message => {
-        console_1.default.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_1.default.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 () {
-        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);
-        }
-        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, data) => {
-                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_1.default.debug("Submitting telemetry...");
-        if (!this.current)
-            return Promise.resolve();
-        const url = this.urls.batch;
-        if (!url) {
-            return;
-        }
-        const body = this.current;
-        api_1.default.sendBatchTelemetry(url, body);
-    },
-    save: function () {
-        fs.writeFile(`${this.configPath}/telemetry.json`, JSON.stringify(this.current), (err) => {
-            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_1.default.sendStreamTelemetry(url, body);
-    },
-};
-exports.default = TelemetryManager;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const api_1 = require("../utils/api");
+const console_1 = require("../utils/console");
+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,
+    urls: {},
+    configPath: "",
+    salute: message => {
+        console_1.default.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_1.default.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 () {
+        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);
+        }
+        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, data) => {
+                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_1.default.debug("Submitting telemetry...");
+        if (!this.current)
+            return Promise.resolve();
+        const url = this.urls.batch;
+        if (!url) {
+            return;
+        }
+        const body = this.current;
+        api_1.default.sendBatchTelemetry(url, body);
+    },
+    save: function () {
+        fs.writeFile(`${this.configPath}/telemetry.json`, JSON.stringify(this.current), (err) => {
+            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_1.default.sendStreamTelemetry(url, body);
+    },
+};
+exports.default = TelemetryManager;