@learnpack/learnpack 2.1.31 → 2.1.32

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @learnpack/learnpack
 $ learnpack COMMAND
 running command...
 $ learnpack (-v|--version|version)
-@learnpack/learnpack/2.1.31 darwin-arm64 node-v16.20.0
+@learnpack/learnpack/2.1.32 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.31/src/commands/audit.ts)_
+_See code: [src/commands/audit.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.32/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.31/src/commands/clean.ts)_
+_See code: [src/commands/clean.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.32/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.31/src/commands/download.ts)_
+_See code: [src/commands/download.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.32/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.31/src/commands/init.ts)_
+_See code: [src/commands/init.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.32/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.31/src/commands/login.ts)_
+_See code: [src/commands/login.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.32/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.31/src/commands/logout.ts)_
+_See code: [src/commands/logout.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.32/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.31/src/commands/publish.ts)_
+_See code: [src/commands/publish.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.32/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.31/src/commands/start.ts)_
+_See code: [src/commands/start.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.32/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.31/src/commands/test.ts)_
+_See code: [src/commands/test.ts](https://github.com/learnpack/learnpack-cli/blob/v2.1.32/src/commands/test.ts)_
 <!-- commandsstop -->
 
 > > > > > > > 0cb3e56d84c197f9d008836bb573eade212b7e57

package/lib/commands/start.js

@@ -5,6 +5,7 @@ const command_1 = require("@oclif/command");
 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 fileQueue_1 = require("../utils/fileQueue");
 const file_1 = require("../managers/file");
 const misc_1 = require("../utils/misc");
@@ -92,8 +93,9 @@ class StartCommand extends SessionCommand_1.default {
                         exercise,
                     });
                 });
-                socket_1.default.on("generate", async (data) => {
-                    console.log("Receving generate event, this shouldn't be happening", data);
+                socket_1.default.on("telemetry", (data) => {
+                    console_1.default.info("Registering telemetry event: ", data);
+                    telemetry_1.default.registerEvent(data);
                 });
                 socket_1.default.on("test", async (data) => {
                     var _a, _b;
@@ -135,7 +137,10 @@ class StartCommand extends SessionCommand_1.default {
                 setTimeout(() => dispatcher.enqueue(dispatcher.events.RUNNING), 1000);
                 // start watching for file changes
                 if (StartCommand.flags.watch)
-                    this.configManager.watchIndex(_exercises => socket_1.default.reload(null, _exercises));
+                    this.configManager.watchIndex(_filename => {
+                        // Instead of reloading with socket.reload(), I just notify the frontend for the file change
+                        socket_1.default.emit("file_change", "ready", _filename);
+                    });
             }
         }
     }

package/lib/managers/config/index.js

@@ -284,11 +284,10 @@ exports.default = async ({ grading, mode, disableGrading, version, }) => {
                 throw errors_1.ValidationError("No exercises directory to watch: " + configObj.config.exercisesPath);
             this.buildIndex();
             watcher_1.default(((_a = configObj === null || configObj === void 0 ? void 0 : configObj.config) === null || _a === void 0 ? void 0 : _a.exercisesPath) || "", onChange)
-                .then(( /* eventname, filename */) => {
+                .then(() => {
                 console_1.default.debug("Changes detected on your exercises");
                 this.buildIndex();
-                if (onChange)
-                    onChange();
+                // if (onChange) onChange(filename);
             })
                 .catch(error => {
                 throw error;

package/lib/managers/telemetry.d.ts

@@ -0,0 +1,26 @@
+declare type TEventType = "form_submit" | "build" | "test" | "visualize_step" | "code_start";
+declare type TFile = {
+    name: string;
+    content: string;
+};
+declare type TStep = {
+    name: string;
+    position: number;
+    files: TFile[];
+};
+declare type TTelemetryEvent = {
+    type: TEventType;
+    data: any;
+    timestamp: number;
+    step: TStep;
+};
+interface ITelemetryManager {
+    current: Array<TTelemetryEvent> | null;
+    start: () => void;
+    submit: () => void;
+    registerEvent: (event: Omit<TTelemetryEvent, "timestamp">) => void;
+    save: () => void;
+    onSaveCallback?: (current: Array<TTelemetryEvent>) => void;
+}
+declare const TelemetryManager: ITelemetryManager;
+export default TelemetryManager;

package/lib/managers/telemetry.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const TelemetryManager = {
+    current: null,
+    start: function () {
+        if (!this.current) {
+            this.current = [];
+        }
+    },
+    submit: function () {
+        console.log("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);
+    },
+    save: function () {
+        if (this.onSaveCallback && this.current) {
+            this.onSaveCallback(this.current);
+        }
+    },
+};
+exports.default = TelemetryManager;

package/lib/models/action.d.ts

@@ -1,2 +1,2 @@
-export declare type TAction = "test" | "log" | "reload" | "ready" | "clean" | "ask" | "generation";
+export declare type TAction = "test" | "log" | "reload" | "ready" | "clean" | "ask" | "file_change";
 export declare type ICallback = (...agrs: any[]) => any;

package/lib/utils/watcher.d.ts

@@ -1,2 +1,2 @@
-declare const _default: (path: string, reloadSocket: () => void) => Promise<unknown>;
+declare const _default: (path: string, reloadSocket: (filename: string) => void) => Promise<unknown>;
 export default _default;

package/lib/utils/watcher.js

@@ -7,12 +7,14 @@ exports.default = (path, reloadSocket) => new Promise((resolve /* , reject */) =
     console_1.default.debug("PATH:", path);
     const watcher = chokidar.watch(path, {
         // TODO: This watcher is not ready yet
-        ignored: /^(?=.*(\.\w+)$)(?!.*\.md$).*$/gm,
+        // ignored: /^(?=.*(\.\w+)$)(?!.*\.md$).*$/gm,
+        ignored: /\.pyc$/,
         ignoreInitial: true,
     });
     const onChange = (eventname, _filename) => {
-        resolve(eventname /* , filename */);
-        reloadSocket();
+        // Console.info(`Event ${eventname} detected. in file: ${_filename}`)
+        resolve(_filename);
+        reloadSocket(_filename);
     };
     watcher.on("all", debounce(onChange, 500, true));
     // watcher.on('all', onChange)

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"2.1.31","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.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}]}}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@learnpack/learnpack",
   "description": "Create, sell or download and take learning amazing learning packages",
-  "version": "2.1.31",
+  "version": "2.1.32",
   "author": "Alejandro Sanchez @alesanchezr",
   "bin": {
     "learnpack": "bin/run"

package/src/commands/start.ts

@@ -4,6 +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 queue from "../utils/fileQueue"
 import {
   decompress,
@@ -185,11 +187,9 @@ export default class StartCommand extends SessionCommand {
           })
         })
 
-        socket.on("generate", async (data: IExerciseData) => {
-          console.log(
-            "Receving generate event, this shouldn't be happening",
-            data
-          )
+        socket.on("telemetry", (data: any) => {
+          Console.info("Registering telemetry event: ", data)
+          TelemetryManager.registerEvent(data)
         })
 
         socket.on("test", async (data: IExerciseData) => {
@@ -248,11 +248,11 @@ export default class StartCommand extends SessionCommand {
         setTimeout(() => dispatcher.enqueue(dispatcher.events.RUNNING), 1000)
 
         // start watching for file changes
-
         if (StartCommand.flags.watch)
-          this.configManager.watchIndex(_exercises =>
-            socket.reload(null, _exercises)
-          )
+          this.configManager.watchIndex(_filename => {
+            // Instead of reloading with socket.reload(), I just notify the frontend for the file change
+            socket.emit("file_change", "ready", _filename)
+          })
       }
     }
   }

package/src/managers/config/index.ts

@@ -386,24 +386,25 @@ fs.mkdirSync(confPath.base)
           [exercise(configObj?.config?.exercisesPath || "", 0, configObj)]
       this.save()
     },
-    watchIndex: function (onChange: () => void) {
+    watchIndex: function (onChange: (filename: string) => void) {
       if (configObj.config && !configObj.config.exercisesPath)
         throw ValidationError(
           "No exercises directory to watch: " + configObj.config.exercisesPath
         )
 
       this.buildIndex()
+
       watch(configObj?.config?.exercisesPath || "", onChange)
-        .then((/* eventname, filename */) => {
+        .then(() => {
           Console.debug("Changes detected on your exercises")
           this.buildIndex()
-          if (onChange) 
-onChange()
+          // if (onChange) onChange(filename);
         })
         .catch(error => {
           throw error
         })
     },
+
     save: () => {
       // Console.debug("Saving configuration with: ", configObj)
 

package/src/managers/telemetry.ts

@@ -0,0 +1,58 @@
+type TEventType =
+  | "form_submit"
+  | "build"
+  | "test"
+  | "visualize_step"
+  | "code_start";
+
+type TFile = {
+  name: string;
+  content: string;
+};
+
+type TStep = {
+  name: string;
+  position: number;
+  files: TFile[];
+};
+
+type TTelemetryEvent = {
+  type: TEventType;
+  data: any;
+  timestamp: number;
+  step: TStep;
+};
+
+interface ITelemetryManager {
+  current: Array<TTelemetryEvent> | null;
+  start: () => void;
+  submit: () => void;
+  registerEvent: (event: Omit<TTelemetryEvent, "timestamp">) => void;
+  save: () => void;
+  onSaveCallback?: (current: Array<TTelemetryEvent>) => void;
+}
+
+const TelemetryManager: ITelemetryManager = {
+  current: null,
+  start: function () {
+    if (!this.current) {
+      this.current = []
+    }
+  },
+  submit: function () {
+    console.log("submit")
+  },
+  registerEvent: function (event) {
+    this.start()
+    const timestamp = Date.now()
+    const _event = { ...event, timestamp }
+    this.current?.push(_event)
+  },
+  save: function () {
+    if (this.onSaveCallback && this.current) {
+      this.onSaveCallback(this.current)
+    }
+  },
+}
+
+export default TelemetryManager

package/src/models/action.ts

@@ -5,6 +5,6 @@ export type TAction =
   | "ready"
   | "clean"
   | "ask"
-  | "generation";
+  | "file_change";
 
 export type ICallback = (...agrs: any[]) => any;

package/src/utils/watcher.ts

@@ -3,17 +3,19 @@ import Console from "./console"
 import * as debounce from "debounce"
 import { IConfigManager } from "../models/config-manager"
 
-export default (path: string, reloadSocket: () => void) =>
+export default (path: string, reloadSocket: (filename: string) => void) =>
   new Promise((resolve /* , reject */) => {
     Console.debug("PATH:", path)
     const watcher = chokidar.watch(path, {
       // TODO: This watcher is not ready yet
-      ignored: /^(?=.*(\.\w+)$)(?!.*\.md$).*$/gm,
+      // ignored: /^(?=.*(\.\w+)$)(?!.*\.md$).*$/gm,
+      ignored: /\.pyc$/,
       ignoreInitial: true,
     })
     const onChange = (eventname: string, _filename: string) => {
-      resolve(eventname /* , filename */)
-      reloadSocket()
+      // Console.info(`Event ${eventname} detected. in file: ${_filename}`)
+      resolve(_filename)
+      reloadSocket(_filename)
     }
 
     watcher.on("all", debounce(onChange, 500, true))