@learnpack/learnpack 4.0.12 → 4.0.13

package/src/commands/publish.ts

@@ -1,107 +1,181 @@
-import { prompt } from "enquirer"
-import SessionCommand from "../utils/SessionCommand"
-import Console from "../utils/console"
-import api from "../utils/api"
-import { validURL } from "../utils/validators"
-
-// eslint-disable-next-line
-const fetch = require("node-fetch");
-
-class PublishCommand extends SessionCommand {
-  static description = `Describe the command here
-  ...
-  Extra documentation goes here
-  `
-
-  static flags: any = {
-    // name: flags.string({char: 'n', description: 'name to print'}),
-  }
-
-  static args = [
-    {
-      name: "package", // name of arg to show in help and reference with args[name]
-      required: false, // make the arg required with `required: true`
-      description:
-        "The unique string that identifies this package on learnpack", // help description
-      hidden: false, // hide this arg from help
-    },
-  ]
-
-  async init() {
-    const { flags } = this.parse(PublishCommand)
-    await this.initSession(flags, true)
-  }
-
-  async run() {
-    const { flags, args } = this.parse(PublishCommand)
-
-    // avoid annonymus sessions
-    // eslint-disable-next-line
-    if (!this.session) return;
-
-    Console.info(
-      `Session found for ${this.session.payload.email}, publishing the package...`
-    )
-
-    const configObject = this.configManager?.get()
-    if (
-      configObject?.config?.slug === undefined ||
-      !configObject.config?.slug
-    ) {
-      throw new Error(
-        "The package is missing a slug (unique name identifier), please check your learn.json file and make sure it has a 'slug'"
-      )
-    }
-
-    if (!validURL(configObject?.config?.repository ?? "")) {
-      throw new Error(
-        "The package has a missing or invalid 'repository' on the configuration file, it needs to be a Github URL"
-      )
-    } else {
-      const validateResp = await fetch(configObject.config?.repository, {
-        method: "HEAD",
-      })
-      if (!validateResp.ok || validateResp.status !== 200) {
-        throw new Error(
-          `The specified repository URL on the configuration file does not exist or its private, only public repositories are allowed at the moment: ${configObject.config?.repository}`
-        )
-      }
-    }
-
-    // start watching for file changes
-    try {
-      await api.publish({
-        ...configObject,
-        author: this.session.payload.user_id,
-      })
-      Console.success(
-        `Package updated and published successfully: ${configObject.config?.slug}`
-      )
-    } catch (error) {
-      if ((error as any).status === 404) {
-        const answer = await prompt([
-          {
-            type: "confirm",
-            name: "create",
-            message: `Package with slug ${configObject.config?.slug} does not exist, do you want to create it?`,
-          },
-        ])
-        if (answer) {
-          await api.update({
-            ...configObject,
-            author: this.session.payload.user_id,
-          })
-          Console.success(
-            `Package created and published successfully: ${configObject.config?.slug}`
-          )
-        } else {
-          Console.error("No answer from server")
-        }
-      } else {
-        Console.error((error as TypeError).message)
-      }
-    }
-  }
-}
-
-export default PublishCommand
+/* eslint-disable arrow-parens */
+/* eslint-disable unicorn/no-array-for-each */
+import { flags } from "@oclif/command"
+import SessionCommand from "../utils/SessionCommand"
+import SessionManager from "../managers/session"
+import * as fs from "fs"
+import * as path from "path"
+import * as archiver from "archiver"
+import axios from "axios"
+import FormData = require("form-data")
+import Console from "../utils/console"
+
+// const RIGOBOT_HOST = "https://rigobot-test-cca7d841c9d8.herokuapp.com"
+const RIGOBOT_HOST =
+  // "https://8000-charlytoc-rigobot-bmwdeam7cev.ws-us116.gitpod.io"
+  "https://rigobot.herokuapp.com"
+const uploadZipEndpont = RIGOBOT_HOST + "/v1/learnpack/upload"
+
+export default class BuildCommand extends SessionCommand {
+  static description =
+    "Builds the project by copying necessary files and directories into a zip file"
+
+  static flags = {
+    help: flags.help({ char: "h" }),
+  }
+
+  async init() {
+    const { flags } = this.parse(BuildCommand)
+    await this.initSession(flags)
+  }
+
+  async run() {
+    const buildDir = path.join(process.cwd(), "build")
+    const sessionPayload = await SessionManager.getPayload()
+    if (!sessionPayload || !sessionPayload.rigobot) {
+      Console.error(
+        "You must be logged in to upload a LearnPack packge, please run: \n$ learnpack login"
+      )
+      return
+    }
+
+    const rigoToken = sessionPayload.rigobot.key
+    // const rigoToken = "417d612d226a1606ad3a4e94b1881a9f0124b667"
+
+    // Read learn.json to get the slug
+    const learnJsonPath = path.join(process.cwd(), "learn.json")
+    if (!fs.existsSync(learnJsonPath)) {
+      this.error("learn.json not found")
+    }
+
+    const learnJson = JSON.parse(fs.readFileSync(learnJsonPath, "utf-8"))
+
+    const zipFilePath = path.join(process.cwd(), `${learnJson.slug}.zip`)
+
+    // Ensure build directory exists
+    if (!fs.existsSync(buildDir)) {
+      fs.mkdirSync(buildDir)
+    }
+
+    // Copy config.json
+    const configPath = path.join(process.cwd(), ".learn", "config.json")
+    if (fs.existsSync(configPath)) {
+      fs.copyFileSync(configPath, path.join(buildDir, "config.json"))
+    } else {
+      this.error("config.json not found")
+    }
+
+    // Copy .learn/assets directory
+    const assetsDir = path.join(process.cwd(), ".learn", "assets")
+    if (fs.existsSync(assetsDir)) {
+      this.copyDirectory(assetsDir, path.join(buildDir, ".learn", "assets"))
+    } else {
+      this.error(".learn/assets directory not found")
+    }
+
+    // Copy .learn/_app directory files to the same level as config.json
+    const appDir = path.join(process.cwd(), ".learn", "_app")
+    if (fs.existsSync(appDir)) {
+      this.copyDirectory(appDir, buildDir)
+    } else {
+      this.error(".learn/_app directory not found")
+    }
+
+    // Copy exercises directory
+    const exercisesDir = path.join(process.cwd(), "exercises")
+    const learnExercisesDir = path.join(process.cwd(), ".learn", "exercises")
+
+    if (fs.existsSync(exercisesDir)) {
+      this.copyDirectory(exercisesDir, path.join(buildDir, "exercises"))
+    } else if (fs.existsSync(learnExercisesDir)) {
+      this.copyDirectory(learnExercisesDir, path.join(buildDir, "exercises"))
+    } else {
+      this.error("exercises directory not found in either location")
+    }
+
+    // Copy learn.json
+    fs.copyFileSync(learnJsonPath, path.join(buildDir, "learn.json"))
+
+    // Create zip file
+    const output = fs.createWriteStream(zipFilePath)
+    const archive = archiver("zip", {
+      zlib: { level: 9 },
+    })
+
+    output.on("close", async () => {
+      this.log(
+        `Build completed: ${zipFilePath} (${archive.pointer()} total bytes)`
+      )
+      // Remove build directory after zip is created
+      this.removeDirectory(buildDir)
+      console.log("Zip file saved in project root")
+
+      const formData = new FormData()
+      formData.append("file", fs.createReadStream(zipFilePath))
+      formData.append("config", JSON.stringify(learnJson))
+
+      try {
+        const res = await axios.post(uploadZipEndpont, formData, {
+          headers: {
+            ...formData.getHeaders(),
+            Authorization: `Token ${rigoToken}`,
+          },
+        })
+        console.log(res.data)
+      } catch (error) {
+        if (axios.isAxiosError(error)) {
+          if (error.response && error.response.status === 403) {
+            console.error("Error 403:", error.response.data.error)
+          } else if (error.response && error.response.status === 400) {
+            console.error(error.response.data.error)
+          } else {
+            console.error("Error uploading file:", error.message)
+          }
+        } else {
+          console.error("Error uploading file:", error)
+        }
+      }
+    })
+
+    archive.on("error", (err: any) => {
+      throw err
+    })
+
+    archive.pipe(output)
+    archive.directory(buildDir, false)
+    await archive.finalize()
+  }
+
+  copyDirectory(src: string, dest: string) {
+    if (!fs.existsSync(dest)) {
+      fs.mkdirSync(dest, { recursive: true })
+    }
+
+    const entries = fs.readdirSync(src, { withFileTypes: true })
+
+    for (const entry of entries) {
+      const srcPath = path.join(src, entry.name)
+      const destPath = path.join(dest, entry.name)
+
+      if (entry.isDirectory()) {
+        this.copyDirectory(srcPath, destPath)
+      } else {
+        fs.copyFileSync(srcPath, destPath)
+      }
+    }
+  }
+
+  removeDirectory(dir: string) {
+    if (fs.existsSync(dir)) {
+      fs.readdirSync(dir).forEach((file) => {
+        const currentPath = path.join(dir, file)
+        if (fs.lstatSync(currentPath).isDirectory()) {
+          this.removeDirectory(currentPath)
+        } else {
+          fs.unlinkSync(currentPath)
+        }
+      })
+      fs.rmdirSync(dir)
+    }
+  }
+}

package/src/managers/session.ts

@@ -1,145 +1,145 @@
-import Console from "../utils/console"
-import api from "../utils/api"
-
-import v from "validator"
-import { ValidationError, InternalError } from "../utils/errors"
-
-import * as fs from "fs"
-import cli from "cli-ux"
-import * as storage from "node-persist"
-
-import { IPayload, ISession, IStartProps } from "../models/session"
-import { IConfigObj } from "../models/config"
-import TelemetryManager from "./telemetry"
-
-const Session: ISession = {
-  sessionStarted: false,
-  token: null,
-  config: null,
-  currentCohort: null,
-  initialize: async function () {
-    if (!this.sessionStarted) {
-      if (!this.config) {
-        throw InternalError("Configuration not found")
-      }
-
-      if (!fs.existsSync(this.config.dirPath)) {
-        fs.mkdirSync(this.config.dirPath)
-      }
-
-      await storage.init({ dir: `${this.config.dirPath}/.session` })
-      this.sessionStarted = true
-    }
-
-    return true
-  },
-
-  setRigoToken: async function (token: string) {
-    await this.initialize()
-    const payload = await storage.getItem("bc-payload")
-    await storage.setItem("bc-payload", {
-      ...payload,
-      rigobot: { key: token },
-    })
-    Console.debug("Rigobot token successfuly set")
-    return true
-  },
-  setPayload: async function (value: IPayload) {
-    await this.initialize()
-    await storage.setItem("bc-payload", { token: this.token, ...value })
-    Console.debug("Payload successfuly found and set for " + value.email)
-    return true
-  },
-  getPayload: async function () {
-    await this.initialize()
-    let payload = null
-    try {
-      payload = await storage.getItem("bc-payload")
-    } catch {
-      Console.debug("Error retriving session payload")
-    }
-
-    return payload
-  },
-  isActive: function () {
-    /* if (this.token) {
-      return true
-    } else {
-      return false
-    } */
-    return !!this.token
-  },
-  get: async function (configObj?: IConfigObj) {
-    if (configObj && configObj.config) {
-      this.config = configObj.config
-    }
-
-    await this.sync()
-    if (!this.isActive()) {
-      return null
-    }
-
-    const payload = await this.getPayload()
-
-    return {
-      payload,
-      token: this.token,
-    }
-  },
-  login: async function () {
-    const email = await cli.prompt("What is your email?")
-    if (!v.isEmail(email)) {
-      throw ValidationError("Invalid email")
-    }
-
-    const password = await cli.prompt("What is your password?", {
-      type: "hide",
-    })
-
-    const data = await api.login(email, password)
-    if (data) {
-      // cli.log(data)
-      this.start({ token: data.token, payload: data })
-    }
-  },
-  loginWeb: async function (email, password) {
-    if (!v.isEmail(email)) {
-      throw ValidationError("Invalid email")
-    }
-
-    const data = await api.login(email, password)
-    if (data) {
-      this.start({ token: data.token, payload: data })
-      TelemetryManager.setStudent({
-        user_id: data.user_id,
-        email: data.email,
-        token: data.token,
-      })
-      return data
-    }
-  },
-  sync: async function () {
-    const payload = await this.getPayload()
-    if (payload) {
-      this.token = payload.token
-    }
-  },
-  start: async function ({ token, payload = null }: IStartProps) {
-    if (!token) {
-      throw new Error("A token and email is needed to start a session")
-    }
-
-    this.token = token
-
-    if (payload && (await this.setPayload(payload))) {
-      Console.success(`Successfully logged in as ${payload.email}`)
-    }
-  },
-  destroy: async function () {
-    await storage.clear()
-    this.token = null
-    Console.success("You have logged out")
-  },
-}
-
-export default Session
+import Console from "../utils/console"
+import api from "../utils/api"
+
+import v from "validator"
+import { ValidationError, InternalError } from "../utils/errors"
+
+import * as fs from "fs"
+import cli from "cli-ux"
+import * as storage from "node-persist"
+
+import { IPayload, ISession, IStartProps } from "../models/session"
+import { IConfigObj } from "../models/config"
+import TelemetryManager from "./telemetry"
+
+const Session: ISession = {
+  sessionStarted: false,
+  token: null,
+  config: null,
+  currentCohort: null,
+  initialize: async function () {
+    if (!this.sessionStarted) {
+      if (!this.config) {
+        throw InternalError("Configuration not found")
+      }
+
+      if (!fs.existsSync(this.config.dirPath)) {
+        fs.mkdirSync(this.config.dirPath)
+      }
+
+      await storage.init({ dir: `${this.config.dirPath}/.session` })
+      this.sessionStarted = true
+    }
+
+    return true
+  },
+
+  setRigoToken: async function (token: string) {
+    await this.initialize()
+    const payload = await storage.getItem("bc-payload")
+    await storage.setItem("bc-payload", {
+      ...payload,
+      rigobot: { key: token },
+    })
+    Console.debug("Rigobot token successfuly set")
+    return true
+  },
+  setPayload: async function (value: IPayload) {
+    await this.initialize()
+    await storage.setItem("bc-payload", { token: this.token, ...value })
+    Console.debug("Payload successfuly found and set for " + value.email)
+    return true
+  },
+  getPayload: async function () {
+    await this.initialize()
+    let payload = null
+    try {
+      payload = await storage.getItem("bc-payload")
+    } catch {
+      Console.debug("Error retriving session payload")
+    }
+
+    return payload
+  },
+  isActive: function () {
+    /* if (this.token) {
+      return true
+    } else {
+      return false
+    } */
+    return !!this.token
+  },
+  get: async function (configObj?: IConfigObj) {
+    if (configObj && configObj.config) {
+      this.config = configObj.config
+    }
+
+    await this.sync()
+    if (!this.isActive()) {
+      return null
+    }
+
+    const payload = await this.getPayload()
+
+    return {
+      payload,
+      token: this.token,
+    }
+  },
+  login: async function () {
+    const email = await cli.prompt("What is your email?")
+    if (!v.isEmail(email)) {
+      throw ValidationError("Invalid email")
+    }
+
+    const password = await cli.prompt("What is your password?", {
+      type: "hide",
+    })
+
+    const data = await api.login(email, password)
+    if (data) {
+      // cli.log(data)
+      this.start({ token: data.token, payload: data })
+    }
+  },
+  loginWeb: async function (email, password) {
+    if (!v.isEmail(email)) {
+      throw ValidationError("Invalid email")
+    }
+
+    const data = await api.login(email, password)
+    if (data) {
+      this.start({ token: data.token, payload: data })
+      TelemetryManager.setStudent({
+        user_id: data.user_id,
+        email: data.email,
+        token: data.token,
+      })
+      return data
+    }
+  },
+  sync: async function () {
+    const payload = await this.getPayload()
+    if (payload) {
+      this.token = payload.token
+    }
+  },
+  start: async function ({ token, payload = null }: IStartProps) {
+    if (!token) {
+      throw new Error("A token and email is needed to start a session")
+    }
+
+    this.token = token
+
+    if (payload && (await this.setPayload(payload))) {
+      Console.success(`Successfully logged in as ${payload.email}`)
+    }
+  },
+  destroy: async function () {
+    await storage.clear()
+    this.token = null
+    Console.success("You have logged out")
+  },
+}
+
+export default Session

package/lib/commands/build.d.ts

@@ -1,11 +0,0 @@
-import SessionCommand from "../utils/SessionCommand";
-export default class BuildCommand extends SessionCommand {
-    static description: string;
-    static flags: {
-        help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
-    };
-    init(): Promise<void>;
-    run(): Promise<void>;
-    copyDirectory(src: string, dest: string): void;
-    removeDirectory(dir: string): void;
-}