@learnpack/learnpack 2.1.34 → 2.1.36

package/README.md

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

package/lib/commands/start.js

@@ -18,7 +18,7 @@ class StartCommand extends SessionCommand_1.default {
         await this.initSession(flags);
     }
     async run() {
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d, _e, _f;
         // 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;
@@ -45,6 +45,8 @@ class StartCommand extends SessionCommand_1.default {
                 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 tutorialSlug = ((_f = configObject.config) === null || _f === void 0 ? void 0 : _f.slug) || "";
+                    console_1.default.info("Starting Telemetry with slug...", tutorialSlug);
                     const steps = configObject.exercises.map((e, index) => ({
                         slug: e.slug,
                         position: e.position || index,
@@ -55,7 +57,7 @@ class StartCommand extends SessionCommand_1.default {
                         is_testeable: e.graded || false,
                     }));
                     if (path && steps.length > 0) {
-                        telemetry_1.default.start(agent, steps, path);
+                        telemetry_1.default.start(agent, steps, path, tutorialSlug);
                     }
                     if (config.telemetry) {
                         telemetry_1.default.urls = config.telemetry;

package/lib/managers/telemetry.d.ts

@@ -42,7 +42,8 @@ declare type TStudent = {
 };
 export interface ITelemetryJSONSchema {
     telemetry_id?: string;
-    student?: TStudent;
+    user_id?: number | string;
+    slug: string;
     agent?: string;
     tutorial_started_at?: number;
     last_interaction_at?: number;
@@ -59,7 +60,7 @@ interface ITelemetryManager {
     configPath: string | null;
     urls: TTelemetryUrls;
     salute: (message: string) => void;
-    start: (agent: string, steps: TStep[], path: 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;

package/lib/managers/telemetry.js

@@ -16,7 +16,7 @@ const TelemetryManager = {
     salute: message => {
         console.log(message);
     },
-    start: function (agent, steps, path) {
+    start: function (agent, steps, path, tutorialSlug) {
         this.configPath = path;
         if (!this.current) {
             this.retrieve(agent, steps)
@@ -29,6 +29,7 @@ const TelemetryManager = {
                 else {
                     this.current = {
                         telemetry_id: createUUID(),
+                        slug: tutorialSlug,
                         agent,
                         tutorial_started_at: Date.now(),
                         steps,
@@ -47,11 +48,18 @@ const TelemetryManager = {
             });
         }
     },
+    // verifyStudent: function () {
+    //   if (!this.current) {
+    //     return;
+    //   }
+    //   if (!this.current.user_id) {
+    //   }
+    // },
     setStudent: function (student) {
         if (!this.current) {
             return;
         }
-        this.current.student = student;
+        this.current.user_id = student.user_id;
         this.save();
         this.submit();
     },
@@ -171,19 +179,17 @@ const TelemetryManager = {
         });
     },
     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,
+            user_id: this.current.user_id,
             step_position: stepPosition,
             event,
             data,

package/lib/utils/api.js

@@ -23,7 +23,8 @@ const fetch = async (url, options = {}, returnAsJson = true) => {
             return returnAsJson ? await resp.json() : await resp.text();
         }
         if (resp.status === 401)
-            throw APIError("Invalid authentication credentials", 401);
+            console_1.default.debug("Invalid authentication credentials", `Code: 401`);
+        // throw APIError("Invalid authentication credentials", 401)
         else if (resp.status === 404)
             throw APIError("Package not found", 404);
         else if (resp.status >= 500)
@@ -201,6 +202,13 @@ const sendBatchTelemetry = async function (url, body) {
     if (!url) {
         return;
     }
+    const session = await storage.getItem("bc-payload");
+    if (!session ||
+        !Object.prototype.hasOwnProperty.call(session, "token") ||
+        session.token === "") {
+        console_1.default.debug("No token found, skipping stream telemetry delivery");
+        return;
+    }
     fetch(url, {
         method: "POST",
         body: JSON.stringify(body),
@@ -216,6 +224,13 @@ const sendStreamTelemetry = async function (url, body) {
     if (!url) {
         return;
     }
+    const session = await storage.getItem("bc-payload");
+    if (!session ||
+        !Object.prototype.hasOwnProperty.call(session, "token") ||
+        session.token === "") {
+        console_1.default.debug("No token found, skipping stream telemetry delivery");
+        return;
+    }
     fetch(url, {
         method: "POST",
         body: JSON.stringify(body),

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"2.1.34","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.36","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.34",
+  "version": "2.1.36",
   "author": "Alejandro Sanchez @alesanchezr",
   "bin": {
     "learnpack": "bin/run"

package/src/commands/start.ts

@@ -119,7 +119,9 @@ export default class StartCommand extends SessionCommand {
         if (configObject.exercises) {
           const agent = configObject.config?.editor.agent || ""
           const path = configObject.config?.dirPath || ""
+          const tutorialSlug = configObject.config?.slug || ""
 
+          Console.info("Starting Telemetry with slug...", tutorialSlug)
           const steps = configObject.exercises.map(
             (e: IExercise, index): TStep => ({
               slug: e.slug,
@@ -132,7 +134,7 @@ export default class StartCommand extends SessionCommand {
             })
           )
           if (path && steps.length > 0) {
-            TelemetryManager.start(agent, steps, path)
+            TelemetryManager.start(agent, steps, path, tutorialSlug)
           }
 
           if (config.telemetry) {

package/src/managers/telemetry.ts

@@ -62,7 +62,8 @@ type TStudent = {
 
 export interface ITelemetryJSONSchema {
   telemetry_id?: string;
-  student?: TStudent;
+  user_id?: number | string;
+  slug: string;
   agent?: string;
   tutorial_started_at?: number;
   last_interaction_at?: number;
@@ -83,7 +84,12 @@ interface ITelemetryManager {
   configPath: string | null;
   urls: TTelemetryUrls;
   salute: (message: string) => void;
-  start: (agent: string, steps: TStep[], path: string) => void;
+  start: (
+    agent: string,
+    steps: TStep[],
+    path: string,
+    tutorialSlug: string
+  ) => void;
   prevStep?: number;
   registerStepEvent: (
     stepPosition: number,
@@ -109,7 +115,7 @@ const TelemetryManager: ITelemetryManager = {
     console.log(message)
   },
 
-  start: function (agent, steps, path) {
+  start: function (agent, steps, path, tutorialSlug) {
     this.configPath = path
     if (!this.current) {
       this.retrieve(agent, steps)
@@ -121,6 +127,7 @@ const TelemetryManager: ITelemetryManager = {
           } else {
             this.current = {
               telemetry_id: createUUID(),
+              slug: tutorialSlug,
               agent,
               tutorial_started_at: Date.now(),
               steps,
@@ -140,13 +147,22 @@ const TelemetryManager: ITelemetryManager = {
         })
     }
   },
+  // verifyStudent: function () {
+  //   if (!this.current) {
+  //     return;
+  //   }
+
+  //   if (!this.current.user_id) {
+
+  //   }
+  // },
 
   setStudent: function (student) {
     if (!this.current) {
       return
     }
 
-    this.current.student = student
+    this.current.user_id = student.user_id
     this.save()
     this.submit()
   },
@@ -301,7 +317,6 @@ return
     const url = this.urls.streaming
     if (!url) {
       return
-      // throw new Error("Streaming URL not specified");
     }
 
     const stepSlug = this.current.steps[stepPosition].slug
@@ -309,7 +324,7 @@ return
     const body = {
       slug: stepSlug,
       telemetry_id: this.current.telemetry_id,
-      user_id: this.current.student?.user_id,
+      user_id: this.current.user_id,
       step_position: stepPosition,
       event,
       data,

package/src/utils/api.ts

@@ -43,7 +43,8 @@ const fetch = async (
     }
 
     if (resp.status === 401)
-      throw APIError("Invalid authentication credentials", 401)
+      Console.debug("Invalid authentication credentials", `Code: 401`)
+    // throw APIError("Invalid authentication credentials", 401)
     else if (resp.status === 404) 
 throw APIError("Package not found", 404)
     else if (resp.status >= 500)
@@ -232,6 +233,16 @@ const sendBatchTelemetry = async function (url: string, body: object) {
     return
   }
 
+  const session = await storage.getItem("bc-payload")
+  if (
+    !session ||
+    !Object.prototype.hasOwnProperty.call(session, "token") ||
+    session.token === ""
+  ) {
+    Console.debug("No token found, skipping stream telemetry delivery")
+    return
+  }
+
   fetch(
     url,
     {
@@ -253,6 +264,16 @@ const sendStreamTelemetry = async function (url: string, body: object) {
     return
   }
 
+  const session = await storage.getItem("bc-payload")
+  if (
+    !session ||
+    !Object.prototype.hasOwnProperty.call(session, "token") ||
+    session.token === ""
+  ) {
+    Console.debug("No token found, skipping stream telemetry delivery")
+    return
+  }
+
   fetch(
     url,
     {