@learnpack/learnpack 5.0.357 → 5.0.359

package/src/commands/publish.ts

@@ -19,281 +19,78 @@ import api, { getConsumable, RIGOBOT_HOST, TAcademy } from "../utils/api"
 import * as prompts from "prompts"
 import { isValidRigoToken } from "../utils/rigoActions"
 import { minutesToISO8601Duration } from "../utils/misc"
-import { getReadmeExtension, slugify } from "../utils/creatorUtilities"
+import { getReadmeExtension } from "../utils/creatorUtilities"
+import { getFallbackPreviewUrl } from "../utils/branding"
+import {
+  determineAcademyMode,
+  getAvailableLangs,
+  PackageAssetsResolution,
+  resolvePackageAssets,
+} from "../utils/assetResolver"
+import { getLocalizedValue, syncPackageAssets } from "../utils/assetSync"
 
 const uploadZipEndpont = RIGOBOT_HOST + "/v1/learnpack/upload"
 
-const getAvailableLangs = (learnJson: any): string[] => {
-  const langs = Object.keys(learnJson?.title || {})
-  return langs.filter((l) => typeof l === "string" && l.length > 0)
-}
-
 const getDefaultLang = (learnJson: any): string => {
   const availableLangs = getAvailableLangs(learnJson)
   if (availableLangs.length === 0) return "en"
   return availableLangs.includes("en") ? "en" : availableLangs[0]
 }
 
-const getLocalizedValue = (
-  translations: Record<string, any> | undefined,
-  lang: string,
-  fallbackLangs: string[] = ["en", "us"]
-): string => {
-  if (!translations || typeof translations !== "object") return ""
-
-  const direct = translations[lang]
-  if (typeof direct === "string" && direct.trim().length > 0) return direct
-
-  for (const fb of fallbackLangs) {
-    const v = translations[fb]
-    if (typeof v === "string" && v.trim().length > 0) return v
-  }
-
-  const firstKey = Object.keys(translations)[0]
-  const first = firstKey ? translations[firstKey] : ""
-  return typeof first === "string" ? first : ""
-}
-
-type ExistingAssetInfo = {
-  lang: string;
-  slug: string;
-  exists: boolean;
-  academyId?: number;
-};
-
-type AcademyMode =
-  | { type: "select" }
-  | { type: "locked"; academyId: number }
-  | { type: "conflict"; academies: number[] };
-
-const getExistingAssetsInfo = async (
-  token: string,
-  learnJson: any
-): Promise<ExistingAssetInfo[]> => {
-  const availableLangs = getAvailableLangs(learnJson)
-  const results: ExistingAssetInfo[] = []
-
-  for (const lang of availableLangs) {
-    const assetTitle = getLocalizedValue(learnJson?.title, lang)
-    if (!assetTitle) continue
-
-    let slug = slugify(assetTitle).slice(0, 47)
-    slug = `${slug}-${lang}`
-
-    // eslint-disable-next-line no-await-in-loop
-    const { exists, academyId } = await api.doesAssetExists(token, slug)
-    results.push({ lang, slug, exists, academyId })
-  }
-
-  return results
-}
-
-const determinePublishAcademyMode = (
-  existingAssets: ExistingAssetInfo[]
-): AcademyMode => {
-  const academyIds = existingAssets
-    .filter((a) => a.exists && a.academyId !== undefined)
-    .map((a) => a.academyId as number)
-
-  const unique = [...new Set(academyIds)]
-
-  if (unique.length === 0) return { type: "select" }
-  if (unique.length === 1) return { type: "locked", academyId: unique[0] }
-  return { type: "conflict", academies: unique }
-}
-
-export const handleAssetCreation = async (
-  sessionPayload: { token: string; rigobotToken: string },
-  learnJson: any,
-  selectedLang: string,
-  learnpackDeployUrl: string,
-  b64IndexReadme: string,
-  academyId: number | undefined,
-  learnpackId: number,
-  preflightInfo?: ExistingAssetInfo,
-  all_translations: string[] = []
-) => {
-  const category = "uncategorized"
-
+const readReadmeFromDisk = async (lang: string): Promise<string> => {
+  const readmePath = path.join(
+    process.cwd(),
+    `README${getReadmeExtension(lang)}`
+  )
   try {
-    const user = await api.validateToken(sessionPayload.token)
-
-    const assetTitle = getLocalizedValue(learnJson?.title, selectedLang)
-    const assetDescription = getLocalizedValue(
-      learnJson?.description,
-      selectedLang
-    )
-
-    if (!assetTitle) {
-      throw new Error(
-        `Missing learn.json title for language "${selectedLang}"`
-      )
-    }
-
-    let slug = slugify(assetTitle).slice(0, 47)
-    slug = `${slug}-${selectedLang}`
-
-    // Use pre-flight info when available to avoid an extra GET request
-    const { exists, academyId: existingAcademyId } =
-      preflightInfo ?? (await api.doesAssetExists(sessionPayload.token, slug))
-
-    // const technologies: unknown[] = Array.isArray(learnJson?.technologies) ?
-    //   learnJson.technologies :
-    //   []
-
-    if (!exists) {
-      Console.info("Asset does not exist in this academy, creating it")
-      const assetPayload: any = {
-        slug: slug,
-        title: assetTitle,
-        lang: selectedLang,
-        graded: true,
-        description: assetDescription,
-        learnpack_deploy_url: learnpackDeployUrl,
-        // technologies: technologies.map((tech: unknown) =>
-        //   String(tech).toLowerCase().replace(/\s+/g, "-")
-        // ),
-        technologies: [],
-        url: learnpackDeployUrl,
-        category: category,
-        owner: user.id,
-        author: user.id,
-        preview: learnJson.preview,
-        readme_raw: b64IndexReadme,
-        all_translations,
-        learnpack_id: learnpackId,
-      }
-      if (academyId !== undefined) {
-        assetPayload.academy_id = academyId
-      }
-
-      const asset = await api.createAsset(sessionPayload.token, assetPayload)
-      try {
-        await api.updateRigoPackage(
-          sessionPayload.rigobotToken.trim(),
-          learnJson.slug,
-          {
-            asset_id: asset.id,
-          }
-        )
-      } catch (error) {
-        Console.error("Error updating Rigo package:", error)
-      }
-
-      Console.info("Asset created with id", asset.id)
-      return asset
-    }
-
-    Console.info("Asset exists, updating it")
-    const updatePayload: any = {
-      graded: true,
-      learnpack_deploy_url: learnpackDeployUrl,
-      title: assetTitle,
-      category: category,
-      description: assetDescription,
-      all_translations,
-      learnpack_id: learnpackId,
-    }
-    // Only set academy when the asset has none yet and the user selected one
-    if (existingAcademyId === undefined && academyId !== undefined) {
-      updatePayload.academy_id = academyId
-    }
-
-    const asset = await api.updateAsset(
-      sessionPayload.token,
-      slug,
-      updatePayload
-    )
-    try {
-      await api.updateRigoPackage(
-        sessionPayload.rigobotToken.trim(),
-        learnJson.slug,
-        {
-          asset_id: asset.id,
-        }
-      )
-    } catch (error) {
-      Console.error("Error updating Rigo package:", error)
-    }
-
-    Console.info("Asset updated with id", asset.id)
-    return asset
+    return fs.existsSync(readmePath) ?
+      fs.readFileSync(readmePath, "utf-8") :
+      ""
   } catch (error) {
-    Console.error("Error updating or creating asset:", error)
-    throw error
+    Console.error("Error reading index readme:", error)
+    return ""
   }
 }
 
-const createMultiLangAssetFromDisk = async (
+const syncAssetsFromDisk = async (
   sessionPayload: { token: string; rigobotToken: string },
   learnJson: any,
   deployUrl: string,
-  selectedAcademyId?: number,
-  existingAssetsInfo: ExistingAssetInfo[] = []
+  selectedAcademyId: number | undefined,
+  resolution: PackageAssetsResolution
 ) => {
-  const availableLangs = getAvailableLangs(learnJson)
-
-  if (availableLangs.length === 0) {
+  if (getAvailableLangs(learnJson).length === 0) {
     Console.error(
       "No languages found in learn.json.title. Add at least one language (e.g. title.en)."
     )
     return
   }
 
-  const learnpackId = await api.resolveLearnpackPackageId(
-    sessionPayload.rigobotToken,
-    learnJson.slug
-  )
-  if (learnpackId === null) {
-    Console.warning(
-      "Breathecode assets skipped: could not resolve Learnpack package id"
-    )
-    return
-  }
+  // The pre-upload resolution is reused unless the package did not exist in
+  // Rigobot yet (first publish): the upload has just created it.
+  const result = await syncPackageAssets({
+    bcToken: sessionPayload.token,
+    rigoToken: sessionPayload.rigobotToken,
+    packageSlug: learnJson.slug,
+    learnJson,
+    deployUrl,
+    academyId: selectedAcademyId,
+    readReadme: readReadmeFromDisk,
+    resolution: resolution.learnpackId === null ? undefined : resolution,
+  })
 
-  const all_translations: string[] = []
-  for (const lang of availableLangs) {
-    const readmePath = path.join(
-      process.cwd(),
-      `README${getReadmeExtension(lang)}`
+  for (const warning of result.warnings) Console.warning(warning)
+  for (const synced of result.synced) {
+    Console.info(
+      `Asset ${synced.action} for "${synced.lang}": #${synced.asset.id} ${synced.asset.slug}`
     )
+  }
 
-    let indexReadmeString = ""
-    try {
-      if (fs.existsSync(readmePath)) {
-        indexReadmeString = fs.readFileSync(readmePath, "utf-8")
-      }
-    } catch (error) {
-      Console.error("Error reading index readme:", error)
-      indexReadmeString = ""
-    }
-
-    const b64IndexReadme = Buffer.from(indexReadmeString).toString("base64")
-    const preflightInfo = existingAssetsInfo.find((a) => a.lang === lang)
-
-    try {
-      // eslint-disable-next-line no-await-in-loop
-      const asset = await handleAssetCreation(
-        sessionPayload,
-        learnJson,
-        lang,
-        deployUrl,
-        b64IndexReadme,
-        selectedAcademyId,
-        learnpackId,
-        preflightInfo,
-        all_translations
-      )
-
-      if (!asset) {
-        Console.debug("Could not create/update asset for lang", lang)
-        continue
-      }
-
-      all_translations.push(asset.slug)
-    } catch (error) {
-      Console.error("Error creating asset for language", lang, error)
-      // Continue with other languages
+  for (const error of result.errors) {
+    if (error.kind === "lang_error") {
+      Console.error(`Asset for "${error.lang}": ${error.error.detail}`)
+    } else {
+      Console.error(error.error.detail)
     }
   }
 }
@@ -487,11 +284,21 @@ class BuildCommand extends SessionCommand {
     }
 
     Console.info("Checking existing assets...")
-    const existingAssetsInfo = await getExistingAssetsInfo(
-      sessionPayload.token,
-      learnJson
-    )
-    const academyMode = determinePublishAcademyMode(existingAssetsInfo)
+    const resolution = await resolvePackageAssets({
+      bcToken: sessionPayload.token,
+      rigoToken: rigoToken,
+      packageSlug: learnJson.slug,
+      learnJson,
+    })
+    for (const warning of resolution.warnings) Console.warning(warning)
+    if (resolution.packageState === "unknown") {
+      Console.error(
+        `${resolution.packageError}. Existing assets cannot be checked, so publishing now could create duplicates. Try again later.`
+      )
+      process.exit(1)
+    }
+
+    const academyMode = determineAcademyMode(resolution)
 
     let selectedAcademyId: number | undefined
 
@@ -588,9 +395,7 @@ class BuildCommand extends SessionCommand {
         getLocalizedValue(learnJson?.title, selectedLang) ||
         "LearnPack: Interactive Learning as a Service"
 
-      const previewUrl =
-        learnJson.preview ||
-        "https://raw.githubusercontent.com/learnpack/ide/refs/heads/master/public/learnpack.svg"
+      const previewUrl = learnJson.preview || getFallbackPreviewUrl()
       // Replace placeholders and the <title>Old title </title> tag for a new tag with the title
       indexHtmlContent = indexHtmlContent
         .replace(/{{description}}/g, description)
@@ -689,12 +494,12 @@ class BuildCommand extends SessionCommand {
         fs.unlinkSync(zipFilePath)
         this.removeDirectory(buildDir)
 
-        await createMultiLangAssetFromDisk(
+        await syncAssetsFromDisk(
           { token: sessionPayload.token, rigobotToken: rigoToken },
           learnJson,
           res.data.url,
           selectedAcademyId,
-          existingAssetsInfo
+          resolution
         )
       } catch (error) {
         if (axios.isAxiosError(error)) {