@learnpack/learnpack 5.0.31 → 5.0.32

package/src/managers/socket.ts

@@ -1,274 +1,274 @@
-import { Socket, Server } from "socket.io"
-import Console from "../utils/console"
-import queue from "../utils/fileQueue"
-
-import { ISocket, TPossibleActions } from "../models/socket"
-import { IConfig } from "../models/config"
-import { ICallback, TAction } from "../models/action"
-import { IExercise, IExerciseData } from "../models/exercise-obj"
-import { TStatus } from "../models/status"
-import { TSuccessType } from "../models/success-types"
-import * as http from "http"
-
-const languageToMessage: Record<string, string> = {
-  python3:
-    "Your code executed without erros, but no output is shown on the terminal.  Maybe you forgot to include a print statement in your code?",
-  node: "Your code executed without erros, but no output is shown on the terminal.  Maybe you forgot to include a console.log statement in your code?",
-}
-
-const SocketManager: ISocket = {
-  socket: null,
-  config: null,
-  allowedActions: [],
-  possibleActions: ["build", "reset", "test", "tutorial"],
-  isTestingEnvironment: false,
-  actionCallBacks: {
-    clean: (_, s: { logs: Array<string> }) => {
-      s.logs = []
-    },
-  },
-  addAllowed: function (actions: Array<TPossibleActions> | TPossibleActions) {
-    if (!Array.isArray(actions)) 
-actions = [actions]
-
-    // avoid adding the "test" action if grading is disabled
-    if (
-      actions.includes("test") &&
-      this.config?.disabledActions?.includes("test")
-    ) {
-      actions = actions.filter((a: TPossibleActions) => a !== "test")
-    }
-
-    this.allowedActions = [
-      ...(this.allowedActions || []).filter(
-        (a: TPossibleActions) => !actions.includes(a)
-      ),
-      ...actions,
-    ]
-  },
-  removeAllowed: function (
-    actions: Array<TPossibleActions> | TPossibleActions
-  ) {
-    if (!Array.isArray(actions)) {
-      actions = [actions]
-    }
-
-    this.allowedActions = (this.allowedActions || []).filter(
-      (a: TPossibleActions) => !actions.includes(a)
-    )
-  },
-  start: function (
-    config: IConfig,
-    server: http.Server,
-    isTestingEnvironment = false
-  ) {
-    this.config = config
-    this.isTestingEnvironment = isTestingEnvironment
-    this.socket = new Server(server, {
-      allowEIO3: true,
-      cors: {
-        origin: "http://localhost:5173",
-        methods: ["GET", "POST"],
-      },
-    })
-
-    this.allowedActions =
-      this.config?.disabledActions?.includes("test") ||
-      this.config?.disableGrading ?
-        this.possibleActions.filter(
-            a => !this.config?.disabledActions?.includes(a) && a !== "test"
-          ) :
-        this.possibleActions.filter(a => !this.allowedActions?.includes(a))
-
-    if (this.config?.grading === "incremental") {
-      this.removeAllowed("reset")
-    }
-
-    if (this.socket) {
-      this.socket.on("connection", (socket: Socket) => {
-        Console.debug(
-          "Connection with client successfully established",
-          this.allowedActions
-        )
-        if (!this.isTestingEnvironment) {
-          this.log("ready", ["Ready to compile or test..."])
-        }
-
-        socket.on(
-          "compiler",
-          ({ action, data }: { action: string; data: IExerciseData }) => {
-            this.emit("clean", "pending", ["Working..."])
-            if (typeof data.exerciseSlug === "undefined") {
-              this.log("internal-error", ["No exercise slug specified"])
-              Console.error("No exercise slug especified")
-              return
-            }
-
-            if (
-              this.actionCallBacks &&
-              typeof this.actionCallBacks[action] === "function"
-            ) {
-              this.actionCallBacks[action](data)
-            } else {
-              this.log("internal-error", ["Uknown action " + action])
-            }
-          }
-        )
-      })
-    }
-  },
-  on: function (action: TAction, callBack: ICallback) {
-    if (this.actionCallBacks) {
-      this.actionCallBacks[action] = callBack
-    }
-  },
-  clean: function (_ = "pending", logs = []) {
-    this.emit("clean", "pending", logs)
-  },
-  ask: function (questions = []) {
-    return new Promise((resolve, _) => {
-      this.emit("ask", "pending", ["Waiting for input..."], questions)
-
-      this.on("input", ({ inputs }: any) => {
-        // Workaround to fix issue because null inputs
-
-        let isNull = false
-        // eslint-disable-next-line
-        inputs.forEach((input: any) => {
-          if (input === null) {
-            isNull = true
-          }
-        })
-
-        if (!isNull) {
-          resolve(inputs)
-        }
-      })
-    })
-  },
-  sessionRefreshed: function (data) {
-    this.emit("session-refreshed", "", [data])
-  },
-
-  reload: function (
-    files: Array<string> | null = null,
-    exercises: Array<string> | null = null
-  ) {
-    this.emit("reload", files?.join("") || "", exercises!)
-  },
-  openWindow: function (url = "") {
-    queue.dispatcher().enqueue(queue.events.OPEN_WINDOW, url)
-    this.emit(
-      queue.events.OPEN_WINDOW as TAction,
-      "ready",
-      [`Opening ${url}`],
-      [],
-      [],
-      url
-    )
-  },
-  log: function (
-    status: TStatus,
-    messages: string | Array<string> = [],
-    report: Array<string> = [],
-    data: any = null
-  ) {
-    this.emit("log", status, messages, [], report, data)
-    Console.log(messages)
-  },
-  emit: function (
-    action: TAction,
-    status: TStatus | string = "ready",
-    logs: string | Array<string> = [],
-    inputs: Array<string> = [],
-    report: Array<string> = [],
-    data: any = null
-  ) {
-    if (
-      this.config?.compiler &&
-      ["webpack", "vanillajs", "vue", "react", "css", "html"].includes(
-        this.config?.compiler
-      )
-    ) {
-      if (["compiler-success", "compiler-warning"].includes(status))
-        this.addAllowed("preview")
-      if (["compiler-error"].includes(status) || action === "ready")
-        this.removeAllowed("preview")
-    }
-
-    if (this.config?.grading === "incremental") {
-      this.removeAllowed("reset")
-    }
-
-    // eslint-disable-next-line
-    this.config?.disabledActions?.forEach((a) => this.removeAllowed(a))
-
-    this.socket?.emit("compiler", {
-      action,
-      status,
-      logs,
-      allowed: this.allowedActions,
-      inputs,
-      report,
-      data,
-    })
-  },
-
-  ready: function (message: string) {
-    this.log("ready", [message])
-  },
-  success: function (type: TSuccessType, stdout: string, lang) {
-    const types = ["compiler", "testing"]
-
-    if (!types.includes(type))
-      this.fatal(`Invalid socket success type "${type}" on socket`)
-    else if (
-      stdout === "" &&
-      lang &&
-      Object.keys(languageToMessage).includes(lang)
-    ) {
-      this.log((type + "-success") as TSuccessType, [languageToMessage[lang]])
-    } else if (stdout === "") {
-      this.log((type + "-success") as TSuccessType, [
-        "No stdout to display on the console",
-      ])
-    } else 
-this.log((type + "-success") as TSuccessType, [stdout])
-  },
-  error: function (type: TStatus, stdout: string) {
-    if (!this.config?.editor.hideTerminal) {
-      queue.dispatcher().enqueue(queue.events.OPEN_TERMINAL, "")
-    }
-
-    this.log(type, [stdout])
-
-    if (this.isTestingEnvironment) {
-      this.onTestingFinished({
-        result: "failed",
-      })
-    }
-  },
-  complete: function () {
-    console.log("complete")
-  },
-  dialog: function (message: string, format = "md") {
-    if (!this.socket) {
-      this.fatal("Socket is not initialized")
-      return
-    }
-
-    this.emit("dialog", "talk", [], undefined, undefined, { message, format })
-  },
-
-  fatal: function (msg: string) {
-    this.log("internal-error", [msg])
-    throw msg
-  },
-  onTestingFinished: function (result: any) {
-    if (this.config?.testingFinishedCallback) {
-      this.config.testingFinishedCallback(result)
-    }
-  },
-}
-
-export default SocketManager
+import { Socket, Server } from "socket.io"
+import Console from "../utils/console"
+import queue from "../utils/fileQueue"
+
+import { ISocket, TPossibleActions } from "../models/socket"
+import { IConfig } from "../models/config"
+import { ICallback, TAction } from "../models/action"
+import { IExercise, IExerciseData } from "../models/exercise-obj"
+import { TStatus } from "../models/status"
+import { TSuccessType } from "../models/success-types"
+import * as http from "http"
+
+const languageToMessage: Record<string, string> = {
+  python3:
+    "Your code executed without erros, but no output is shown on the terminal.  Maybe you forgot to include a print statement in your code?",
+  node: "Your code executed without erros, but no output is shown on the terminal.  Maybe you forgot to include a console.log statement in your code?",
+}
+
+const SocketManager: ISocket = {
+  socket: null,
+  config: null,
+  allowedActions: [],
+  possibleActions: ["build", "reset", "test", "tutorial"],
+  isTestingEnvironment: false,
+  actionCallBacks: {
+    clean: (_, s: { logs: Array<string> }) => {
+      s.logs = []
+    },
+  },
+  addAllowed: function (actions: Array<TPossibleActions> | TPossibleActions) {
+    if (!Array.isArray(actions)) 
+actions = [actions]
+
+    // avoid adding the "test" action if grading is disabled
+    if (
+      actions.includes("test") &&
+      this.config?.disabledActions?.includes("test")
+    ) {
+      actions = actions.filter((a: TPossibleActions) => a !== "test")
+    }
+
+    this.allowedActions = [
+      ...(this.allowedActions || []).filter(
+        (a: TPossibleActions) => !actions.includes(a)
+      ),
+      ...actions,
+    ]
+  },
+  removeAllowed: function (
+    actions: Array<TPossibleActions> | TPossibleActions
+  ) {
+    if (!Array.isArray(actions)) {
+      actions = [actions]
+    }
+
+    this.allowedActions = (this.allowedActions || []).filter(
+      (a: TPossibleActions) => !actions.includes(a)
+    )
+  },
+  start: function (
+    config: IConfig,
+    server: http.Server,
+    isTestingEnvironment = false
+  ) {
+    this.config = config
+    this.isTestingEnvironment = isTestingEnvironment
+    this.socket = new Server(server, {
+      allowEIO3: true,
+      cors: {
+        origin: "http://localhost:5173",
+        methods: ["GET", "POST"],
+      },
+    })
+
+    this.allowedActions =
+      this.config?.disabledActions?.includes("test") ||
+      this.config?.disableGrading ?
+        this.possibleActions.filter(
+            a => !this.config?.disabledActions?.includes(a) && a !== "test"
+          ) :
+        this.possibleActions.filter(a => !this.allowedActions?.includes(a))
+
+    if (this.config?.grading === "incremental") {
+      this.removeAllowed("reset")
+    }
+
+    if (this.socket) {
+      this.socket.on("connection", (socket: Socket) => {
+        Console.debug(
+          "Connection with client successfully established",
+          this.allowedActions
+        )
+        if (!this.isTestingEnvironment) {
+          this.log("ready", ["Ready to compile or test..."])
+        }
+
+        socket.on(
+          "compiler",
+          ({ action, data }: { action: string; data: IExerciseData }) => {
+            this.emit("clean", "pending", ["Working..."])
+            if (typeof data.exerciseSlug === "undefined") {
+              this.log("internal-error", ["No exercise slug specified"])
+              Console.error("No exercise slug especified")
+              return
+            }
+
+            if (
+              this.actionCallBacks &&
+              typeof this.actionCallBacks[action] === "function"
+            ) {
+              this.actionCallBacks[action](data)
+            } else {
+              this.log("internal-error", ["Uknown action " + action])
+            }
+          }
+        )
+      })
+    }
+  },
+  on: function (action: TAction, callBack: ICallback) {
+    if (this.actionCallBacks) {
+      this.actionCallBacks[action] = callBack
+    }
+  },
+  clean: function (_ = "pending", logs = []) {
+    this.emit("clean", "pending", logs)
+  },
+  ask: function (questions = []) {
+    return new Promise((resolve, _) => {
+      this.emit("ask", "pending", ["Waiting for input..."], questions)
+
+      this.on("input", ({ inputs }: any) => {
+        // Workaround to fix issue because null inputs
+
+        let isNull = false
+        // eslint-disable-next-line
+        inputs.forEach((input: any) => {
+          if (input === null) {
+            isNull = true
+          }
+        })
+
+        if (!isNull) {
+          resolve(inputs)
+        }
+      })
+    })
+  },
+  sessionRefreshed: function (data) {
+    this.emit("session-refreshed", "", [data])
+  },
+
+  reload: function (
+    files: Array<string> | null = null,
+    exercises: Array<string> | null = null
+  ) {
+    this.emit("reload", files?.join("") || "", exercises!)
+  },
+  openWindow: function (url = "") {
+    queue.dispatcher().enqueue(queue.events.OPEN_WINDOW, url)
+    this.emit(
+      queue.events.OPEN_WINDOW as TAction,
+      "ready",
+      [`Opening ${url}`],
+      [],
+      [],
+      url
+    )
+  },
+  log: function (
+    status: TStatus,
+    messages: string | Array<string> = [],
+    report: Array<string> = [],
+    data: any = null
+  ) {
+    this.emit("log", status, messages, [], report, data)
+    Console.log(messages)
+  },
+  emit: function (
+    action: TAction,
+    status: TStatus | string = "ready",
+    logs: string | Array<string> = [],
+    inputs: Array<string> = [],
+    report: Array<string> = [],
+    data: any = null
+  ) {
+    if (
+      this.config?.compiler &&
+      ["webpack", "vanillajs", "vue", "react", "css", "html"].includes(
+        this.config?.compiler
+      )
+    ) {
+      if (["compiler-success", "compiler-warning"].includes(status))
+        this.addAllowed("preview")
+      if (["compiler-error"].includes(status) || action === "ready")
+        this.removeAllowed("preview")
+    }
+
+    if (this.config?.grading === "incremental") {
+      this.removeAllowed("reset")
+    }
+
+    // eslint-disable-next-line
+    this.config?.disabledActions?.forEach((a) => this.removeAllowed(a))
+
+    this.socket?.emit("compiler", {
+      action,
+      status,
+      logs,
+      allowed: this.allowedActions,
+      inputs,
+      report,
+      data,
+    })
+  },
+
+  ready: function (message: string) {
+    this.log("ready", [message])
+  },
+  success: function (type: TSuccessType, stdout: string, lang) {
+    const types = ["compiler", "testing"]
+
+    if (!types.includes(type))
+      this.fatal(`Invalid socket success type "${type}" on socket`)
+    else if (
+      stdout === "" &&
+      lang &&
+      Object.keys(languageToMessage).includes(lang)
+    ) {
+      this.log((type + "-success") as TSuccessType, [languageToMessage[lang]])
+    } else if (stdout === "") {
+      this.log((type + "-success") as TSuccessType, [
+        "No stdout to display on the console",
+      ])
+    } else 
+this.log((type + "-success") as TSuccessType, [stdout])
+  },
+  error: function (type: TStatus, stdout: string) {
+    if (!this.config?.editor.hideTerminal) {
+      queue.dispatcher().enqueue(queue.events.OPEN_TERMINAL, "")
+    }
+
+    this.log(type, [stdout])
+
+    if (this.isTestingEnvironment) {
+      this.onTestingFinished({
+        result: "failed",
+      })
+    }
+  },
+  complete: function () {
+    console.log("complete")
+  },
+  dialog: function (message: string, format = "md") {
+    if (!this.socket) {
+      this.fatal("Socket is not initialized")
+      return
+    }
+
+    this.emit("dialog", "talk", [], undefined, undefined, { message, format })
+  },
+
+  fatal: function (msg: string) {
+    this.log("internal-error", [msg])
+    throw msg
+  },
+  onTestingFinished: function (result: any) {
+    if (this.config?.testingFinishedCallback) {
+      this.config.testingFinishedCallback(result)
+    }
+  },
+}
+
+export default SocketManager

package/src/managers/telemetry.ts

@@ -1,5 +1,6 @@
 import { IFile } from "../models/file"
 import API from "../utils/api"
+const packageInfo = require("../../package.json")
 import Console from "../utils/console"
 
 const fs = require("fs")
@@ -77,6 +78,7 @@ type TStudent = {
 
 export interface ITelemetryJSONSchema {
   telemetry_id?: string
+  version: string
   user_id?: number | string
   slug: string
   agent?: string
@@ -111,6 +113,7 @@ interface ITelemetryManager {
   user: TUser
   urls: TTelemetryUrls
   started: boolean
+  version: string
   salute: (message: string) => void
   start: (
     agent: string,
@@ -136,6 +139,7 @@ interface ITelemetryManager {
 const TelemetryManager: ITelemetryManager = {
   current: null,
   urls: {},
+  version: packageInfo.version,
   user: {
     token: "",
     id: "",
@@ -160,6 +164,8 @@ const TelemetryManager: ITelemetryManager = {
             this.current = {
               telemetry_id: createUUID(),
               slug: tutorialSlug,
+              version: `CLI:${this.version}`,
+              user_id: 0,
               agent,
               tutorial_started_at: Date.now(),
               last_interaction_at: Date.now(),
@@ -176,6 +182,10 @@ const TelemetryManager: ITelemetryManager = {
             this.user.id = this.current.user_id.toString()
           }
 
+          if (!this.current.version) {
+            this.current.version = `CLI:${this.version}`
+          }
+
           this.save()
 
           this.started = true

package/src/models/action.ts

@@ -1,12 +1,12 @@
-export type TAction =
-  | "test"
-  | "log"
-  | "reload"
-  | "ready"
-  | "clean"
-  | "ask"
-  | "file_change"
-  | "dialog"
-  | "session-refreshed"
-
-export type ICallback = (...agrs: any[]) => any
+export type TAction =
+  | "test"
+  | "log"
+  | "reload"
+  | "ready"
+  | "clean"
+  | "ask"
+  | "file_change"
+  | "dialog"
+  | "session-refreshed"
+
+export type ICallback = (...agrs: any[]) => any