@learnpack/learnpack 2.1.33 → 2.1.34

package/README.md

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

package/lib/managers/telemetry.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const api_1 = require("../utils/api");
 const fs = require("fs");
 function createUUID() {
     return (Math.random().toString(36).slice(2, 10) +
@@ -159,22 +160,9 @@ const TelemetryManager = {
         const url = this.urls.batch;
         if (!url) {
             return;
-            // throw new Error("Batch URL not specified");
         }
         const body = this.current;
-        fetch(url, {
-            method: "POST",
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: JSON.stringify(body),
-        })
-            .then(response => {
-            return response.text();
-        })
-            .catch(error => {
-            console.log("Error", error);
-        });
+        api_1.default.sendBatchTelemetry(url, body);
     },
     save: function () {
         fs.writeFile(`${this.configPath}/telemetry.json`, JSON.stringify(this.current), (err) => {
@@ -200,20 +188,7 @@ const TelemetryManager = {
             event,
             data,
         };
-        try {
-            const response = await fetch(url, {
-                method: "POST",
-                headers: {
-                    "Content-Type": "application/json",
-                },
-                body: JSON.stringify(body),
-            });
-            const responseText = await response.text();
-        }
-        catch (error) {
-            error;
-            // Console.error(error);
-        }
+        api_1.default.sendStreamTelemetry(url, body);
     },
 };
 exports.default = TelemetryManager;

package/lib/utils/api.d.ts

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

package/lib/utils/api.js

@@ -7,9 +7,9 @@ const HOST = "https://breathecode.herokuapp.com";
 const RIGOBOT_HOST = "https://rigobot.herokuapp.com";
 // eslint-disable-next-line
 const _fetch = require("node-fetch");
-const fetch = async (url, options = {}) => {
+const fetch = async (url, options = {}, returnAsJson = true) => {
     const headers = { "Content-Type": "application/json" };
-    console_1.default.log(`Fetching ${url}`);
+    console_1.default.debug(`Fetching ${url}`);
     let session = null;
     try {
         session = await storage.getItem("bc-payload");
@@ -19,8 +19,9 @@ const fetch = async (url, options = {}) => {
     catch (_a) { }
     try {
         const resp = await _fetch(url, Object.assign(Object.assign({}, options), { headers: Object.assign(Object.assign({}, headers), options.headers) }));
-        if (resp.status >= 200 && resp.status < 300)
-            return await resp.json();
+        if (resp.status >= 200 && resp.status < 300) {
+            return returnAsJson ? await resp.json() : await resp.text();
+        }
         if (resp.status === 401)
             throw APIError("Invalid authentication credentials", 401);
         else if (resp.status === 404)
@@ -196,6 +197,36 @@ const APIError = (error, code) => {
     _err.status = code || 400;
     return _err;
 };
+const sendBatchTelemetry = async function (url, body) {
+    if (!url) {
+        return;
+    }
+    fetch(url, {
+        method: "POST",
+        body: JSON.stringify(body),
+    }, false)
+        .then(response => {
+        return response.text();
+    })
+        .catch(error => {
+        console_1.default.debug("Error while sending batch Telemetry", error);
+    });
+};
+const sendStreamTelemetry = async function (url, body) {
+    if (!url) {
+        return;
+    }
+    fetch(url, {
+        method: "POST",
+        body: JSON.stringify(body),
+    }, false)
+        .then(response => {
+        return response;
+    })
+        .catch(error => {
+        console_1.default.debug("Error while sending stream Telemetry", error);
+    });
+};
 exports.default = {
     login,
     publish,
@@ -203,4 +234,6 @@ exports.default = {
     getPackage,
     getLangs,
     getAllPackages,
+    sendBatchTelemetry,
+    sendStreamTelemetry,
 };

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"2.1.33","commands":{"audit":{"id":"audit","description":"learnpack audit is the command in charge of creating an auditory of the repository\n...\nlearnpack audit checks for the following information in a repository:\n    1. The configuration object has slug, repository and description. (Error)\n    2. The command learnpack clean has been run. (Error)\n    3. If a markdown or test file doesn't have any content. (Error)\n    4. The links are accessing to valid servers. (Error)\n    5. The relative images are working (If they have the shortest path to the image or if the images exists in the assets). (Error)\n    6. The external images are working (If they are pointing to a valid server). (Error)\n    7. The exercises directory names are valid. (Error)\n    8. If an exercise doesn't have a README file. (Error)\n    9. The exercises array (Of the config file) has content. (Error)\n    10. The exercses have the same translations. (Warning)\n    11. The .gitignore file exists. (Warning)\n    12. If there is a file within the exercises folder but not inside of any particular exercise's folder. (Warning)\n","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]},"clean":{"id":"clean","description":"Clean the configuration object\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[]},"download":{"id":"download","description":"Describe the command here\n...\nExtra documentation goes here\n","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"init":{"id":"init","description":"Create a new learning package: Book, Tutorial or Exercise","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"grading":{"name":"grading","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"login":{"id":"login","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"logout":{"id":"logout","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"publish":{"id":"publish","description":"Describe the command here\n  ...\n  Extra documentation goes here\n  ","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"package","description":"The unique string that identifies this package on learnpack","required":false,"hidden":false}]},"start":{"id":"start","description":"Runs a small server with all the exercise instructions","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{"port":{"name":"port","type":"option","char":"p","description":"server port"},"host":{"name":"host","type":"option","char":"h","description":"server host"},"disableGrading":{"name":"disableGrading","type":"boolean","char":"D","description":"disble grading functionality","allowNo":false},"watch":{"name":"watch","type":"boolean","char":"w","description":"Watch for file changes","allowNo":false},"editor":{"name":"editor","type":"option","char":"e","description":"[standalone, gitpod]","options":["standalone","gitpod"]},"version":{"name":"version","type":"option","char":"v","description":"E.g: 1.0.1"},"grading":{"name":"grading","type":"option","char":"g","description":"[isolated, incremental]","options":["isolated","incremental"]},"debug":{"name":"debug","type":"boolean","char":"d","description":"debugger mode for more verbage","allowNo":false}},"args":[]},"test":{"id":"test","description":"Test exercises","pluginName":"@learnpack/learnpack","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"exerciseSlug","description":"The name of the exercise to test","required":false,"hidden":false}]}}}
+{"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}]}}}

package/package.json

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

package/src/managers/telemetry.ts

@@ -1,5 +1,5 @@
 import { IFile } from "../models/file"
-
+import API from "../utils/api"
 const fs = require("fs")
 
 function createUUID(): string {
@@ -277,23 +277,11 @@ return Promise.resolve()
     const url = this.urls.batch
     if (!url) {
       return
-      // throw new Error("Batch URL not specified");
     }
 
     const body = this.current
-    fetch(url, {
-      method: "POST",
-      headers: {
-        "Content-Type": "application/json",
-      },
-      body: JSON.stringify(body),
-    })
-      .then(response => {
-        return response.text()
-      })
-      .catch(error => {
-        console.log("Error", error)
-      })
+
+    API.sendBatchTelemetry(url, body)
   },
   save: function () {
     fs.writeFile(
@@ -327,19 +315,7 @@ return
       data,
     }
 
-    try {
-      const response = await fetch(url, {
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: JSON.stringify(body),
-      })
-      const responseText = await response.text()
-    } catch (error) {
-      error
-      // Console.error(error);
-    }
+    API.sendStreamTelemetry(url, body)
   },
 }
 

package/src/utils/api.ts

@@ -18,9 +18,13 @@ interface IOptions {
   body?: string;
 }
 
-const fetch = async (url: string, options: IOptions = {}) => {
+const fetch = async (
+  url: string,
+  options: IOptions = {},
+  returnAsJson = true
+) => {
   const headers: IHeaders = { "Content-Type": "application/json" }
-  Console.log(`Fetching ${url}`)
+  Console.debug(`Fetching ${url}`)
   let session = null
   try {
     session = await storage.getItem("bc-payload")
@@ -34,8 +38,10 @@ const fetch = async (url: string, options: IOptions = {}) => {
       headers: { ...headers, ...options.headers },
     } as any)
 
-    if (resp.status >= 200 && resp.status < 300) 
-return await resp.json()
+    if (resp.status >= 200 && resp.status < 300) {
+      return returnAsJson ? await resp.json() : await resp.text()
+    }
+
     if (resp.status === 401)
       throw APIError("Invalid authentication credentials", 401)
     else if (resp.status === 404) 
@@ -221,6 +227,48 @@ const APIError = (error: TypeError | string, code?: number) => {
   return _err
 }
 
+const sendBatchTelemetry = async function (url: string, body: object) {
+  if (!url) {
+    return
+  }
+
+  fetch(
+    url,
+    {
+      method: "POST",
+      body: JSON.stringify(body),
+    },
+    false
+  )
+    .then(response => {
+      return response.text()
+    })
+    .catch(error => {
+      Console.debug("Error while sending batch Telemetry", error)
+    })
+}
+
+const sendStreamTelemetry = async function (url: string, body: object) {
+  if (!url) {
+    return
+  }
+
+  fetch(
+    url,
+    {
+      method: "POST",
+      body: JSON.stringify(body),
+    },
+    false
+  )
+    .then(response => {
+      return response
+    })
+    .catch(error => {
+      Console.debug("Error while sending stream Telemetry", error)
+    })
+}
+
 export default {
   login,
   publish,
@@ -228,4 +276,6 @@ export default {
   getPackage,
   getLangs,
   getAllPackages,
+  sendBatchTelemetry,
+  sendStreamTelemetry,
 }