@learnpack/learnpack 5.0.357 → 5.0.359

package/lib/commands/serve.js

@@ -31,13 +31,15 @@ const misc_1 = require("../utils/misc");
 const configBuilder_1 = require("../utils/configBuilder");
 const creatorUtilities_2 = require("../utils/creatorUtilities");
 const sidebarGenerator_1 = require("../utils/sidebarGenerator");
-const publish_1 = require("./publish");
+const assetResolver_1 = require("../utils/assetResolver");
+const assetSync_1 = require("../utils/assetSync");
 const export_1 = require("../utils/export");
 const router_1 = require("../services/ingest/http/router");
 const bucketIo_1 = require("../utils/coursePackage/bucketIo");
 const learnJson_1 = require("../utils/coursePackage/learnJson");
 const sidebar_1 = require("../utils/coursePackage/sidebar");
 const packageManifest_1 = require("../utils/packageManifest");
+const branding_1 = require("../utils/branding");
 const gcsBucketName_1 = require("../utils/gcsBucketName");
 const syllabusSync_1 = require("../utils/syllabusSync");
 const publishJournal_1 = require("../utils/publishJournal");
@@ -318,94 +320,34 @@ const cleanFormState = (formState) => {
 const cleanFormStateForSyllabus = (formState) => {
     return Object.assign(Object.assign({}, formState), { description: formState.description, technologies: formState.technologies, contentIndex: formState.contentIndex, purposse: undefined, duration: undefined, hasContentIndex: undefined, variables: undefined, currentStep: undefined, language: undefined, isCompleted: undefined });
 };
-const getLocalizedValue = (translations, lang, fallbackLangs = ["en", "us"]) => {
-    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 : "";
-};
-function assetSyncErrorDetail(err) {
-    if (typeof (err === null || err === void 0 ? void 0 : err.detail) === "string")
-        return err.detail;
-    if (typeof (err === null || err === void 0 ? void 0 : err.message) === "string")
-        return err.message;
-    try {
-        return JSON.stringify(err);
-    }
-    catch (_a) {
-        return String(err);
-    }
-}
 const createMultiLangAsset = async (bucket, rigoToken, bcToken, courseSlug, courseJson, deployUrl, academyId) => {
-    var _a;
-    const learnpackId = await (0, api_1.resolveLearnpackPackageId)(rigoToken, courseSlug);
-    if (learnpackId === null) {
-        return {
-            errors: [
-                {
-                    kind: "package_error",
-                    error: {
-                        detail: "Could not resolve Learnpack package id; assets not synced to Breathecode.",
-                    },
-                },
-            ],
-        };
-    }
-    const availableLangs = Object.keys(courseJson.title);
-    console.log("AVAILABLE LANGUAGES to upload asset", availableLangs);
-    const all_translations = [];
-    const errors = [];
-    for (const lang of availableLangs) {
-        // eslint-disable-next-line no-await-in-loop
-        const indexReadme = await bucket.file(`courses/${courseSlug}/README${(0, creatorUtilities_1.getReadmeExtension)(lang)}`);
-        let indexReadmeString = "";
+    const readReadme = async (lang) => {
+        const indexReadme = bucket.file(`courses/${courseSlug}/README${(0, creatorUtilities_1.getReadmeExtension)(lang)}`);
         try {
-            // eslint-disable-next-line no-await-in-loop
-            const [indexReadmeContent] = await indexReadme.download();
-            indexReadmeString = indexReadmeContent.toString();
+            const [content] = await indexReadme.download();
+            return content.toString();
         }
         catch (error) {
             console.error("Error downloading index readme", error);
             // TODO: Trigger generation of the index readme
-            indexReadmeString = "";
-        }
-        const b64IndexReadme = buffer_1.Buffer.from(indexReadmeString).toString("base64");
-        try {
-            // eslint-disable-next-line no-await-in-loop
-            const asset = await (0, publish_1.handleAssetCreation)({ token: bcToken, rigobotToken: rigoToken.trim() }, courseJson, lang, deployUrl, b64IndexReadme, academyId, learnpackId, undefined, all_translations);
-            if (!asset) {
-                errors.push({
-                    kind: "lang_error",
-                    lang,
-                    error: { detail: "Failed to create asset" },
-                });
-                console.log("No se pudo crear el asset, saltando idioma", lang);
-                continue;
-            }
-            all_translations.push(asset.slug);
-        }
-        catch (error) {
-            const errorData = error && typeof error === "object" && "response" in error ?
-                ((_a = error.response) === null || _a === void 0 ? void 0 : _a.data) || error :
-                error;
-            errors.push({
-                kind: "lang_error",
-                lang,
-                error: { detail: assetSyncErrorDetail(errorData) },
-            });
-            console.error(`Error creating asset for language ${lang}:`, error);
+            return "";
         }
+    };
+    const result = await (0, assetSync_1.syncPackageAssets)({
+        bcToken,
+        rigoToken,
+        packageSlug: courseSlug,
+        learnJson: courseJson,
+        deployUrl,
+        academyId,
+        readReadme,
+    });
+    for (const warning of result.warnings)
+        console.warn("[assets]", warning);
+    for (const synced of result.synced) {
+        console.log(`[assets] ${synced.action} "${synced.lang}": #${synced.asset.id} ${synced.asset.slug}`);
     }
-    return { errors };
+    return { errors: result.errors };
 };
 const lessonCleaner = (lesson) => {
     return Object.assign(Object.assign({}, lesson), { duration: undefined, generated: undefined, status: undefined, translations: undefined, uid: undefined, initialContent: undefined, locked: undefined });
@@ -733,21 +675,88 @@ async function continueWithNextLesson(courseSlug, currentExerciseIndex, rigoToke
         }) });
     await saveSyllabus(courseSlug, newSyllabus, bucket);
 }
-const fixPreviewUrl = (slug, previewUrl) => {
-    if (!previewUrl) {
-        return null;
+/**
+ * The `og:image` of a published course.
+ *
+ * A published package is served from `{slug}.learn-pack.com`, so the course's
+ * own `preview.png` is the right card whenever it exists. This used to go
+ * through a helper that returned null for an empty preview, and both call sites
+ * passed an empty string — so every published course, preview or not, fell back
+ * to a shared SVG that no unfurl crawler can render.
+ */
+const resolveCoursePreviewUrl = async (bucket, slug, configuredPreview) => {
+    // `config` is parsed from a config.json in the bucket, so its declared types
+    // are an assertion rather than a guarantee: an old or hand-edited course can
+    // carry anything here, and a throw would fail the whole publication.
+    if (typeof configuredPreview === "string" &&
+        configuredPreview.startsWith("http")) {
+        return configuredPreview;
+    }
+    try {
+        const [exists] = await bucket.file(`courses/${slug}/preview.png`).exists();
+        if (exists) {
+            return (0, packageManifest_1.resolvePreviewUrl)(slug);
+        }
     }
-    if (previewUrl.startsWith("http")) {
-        return previewUrl;
+    catch (error) {
+        console.error(`WARNING: could not check preview.png for ${slug}, using the brand card`, error);
     }
-    const expectedUrl = `https://${slug}.learn-pack.com/preview.png`;
-    return expectedUrl;
+    return (0, branding_1.getFallbackPreviewUrl)();
 };
 const getTitleFromHTML = (html) => {
     const titleRegex = /<title>(.*?)<\/title>/;
     const titleMatch = html.match(titleRegex);
     return titleMatch ? titleMatch[1] : null;
 };
+const escapeHtmlAttribute = (value) => value.replace(/&/g, "&amp;").replace(/"/g, "&quot;").replace(/</g, "&lt;");
+/**
+ * The IDE shell served to draft courses, with its meta tags filled in.
+ *
+ * The shell ships with `{{title}}`, `{{description}}` and `{{preview}}`
+ * placeholders that only get substituted when a course is published. Drafts were
+ * served the raw template, so a link shared in Slack or WhatsApp unfurled to a
+ * literal `{{title}}` / `{{description}}`.
+ */
+let draftShellTemplate = null;
+const loadDraftShellTemplate = () => {
+    const file = path.resolve(__dirname, "../ui/_app/index.html");
+    draftShellTemplate = fs
+        .readFileSync(file, "utf-8")
+        // A draft is not a real Course, so it must not emit Course structured data.
+        // The match is anchored to the typed opening tag and non-greedy on purpose:
+        // the shell also carries an inline <script> that loads the app bundle from
+        // CloudFront, and a looser pattern would swallow it and blank the page.
+        .replace(/[^\S\n]*<script type="application\/ld\+json">[\S\s]*?<\/script>\n?/, "");
+    return draftShellTemplate;
+};
+const renderDraftShell = (req) => {
+    const template = draftShellTemplate || loadDraftShellTemplate();
+    // Only the path: a preview URL can carry tokens in its query string, and
+    // og:url ends up in whatever crawler cache unfurls the link.
+    const canonicalUrl = escapeHtmlAttribute(`${(0, branding_1.getPublicHost)()}${req.path}`);
+    return (template
+        .replace(/<title>.*<\/title>/, `<title>${branding_1.DRAFT_PREVIEW_TITLE}</title>`)
+        .replace(/{{title}}/g, branding_1.DRAFT_PREVIEW_TITLE)
+        .replace(/{{description}}/g, branding_1.DRAFT_PREVIEW_DESCRIPTION)
+        .replace(/{{preview}}/g, (0, branding_1.getFallbackPreviewUrl)())
+        .replace("</head>", `  <meta property="og:url" content="${canonicalUrl}" />\n` +
+        `    <meta name="robots" content="noindex, nofollow, noarchive" />\n  </head>`)
+        // Safety net for placeholders a future shell may add: shipping an empty
+        // value to a crawler beats shipping "{{whatever}}".
+        .replace(/{{\w+}}/g, ""));
+};
+/**
+ * Drafts are unlisted work in progress. `noindex` goes out as both a meta tag
+ * and a header so it reaches crawlers that skip the markup; a `robots.txt`
+ * `Disallow` would be the wrong tool, since it blocks the fetch itself and
+ * would stop Slack and X from unfurling the link at all.
+ */
+const sendDraftShell = (req, res) => {
+    res
+        .type("html")
+        .set("X-Robots-Tag", "noindex, nofollow")
+        .send(renderDraftShell(req));
+};
 /** How often the notification is touched while a translation is running. */
 const SYNC_HEARTBEAT_INTERVAL_MS = 60 * 1000;
 /**
@@ -1045,6 +1054,10 @@ class ServeCommand extends SessionCommand_1.default {
         await (0, file_1.decompress)(`${__dirname}/../ui/app.tar.gz`, `${__dirname}/../ui/_app/`);
         const localAppPath = path.resolve(__dirname, "../ui/_app");
         // app.use(express.static(localAppPath))
+        // Warm the draft shell now that _app is on disk. Doing it here rather than
+        // on first request means a corrupt tarball fails at boot, with a stack
+        // trace, instead of on some user's preview link.
+        loadDraftShellTemplate();
         app.post("/upload", async (req, res) => {
             const { content, destination } = req.body;
             //   console.log("UPLOAD", content, destination)
@@ -2160,8 +2173,7 @@ class ServeCommand extends SessionCommand_1.default {
             console.log("GET /");
             const slug = req.query.slug;
             if (slug) {
-                const file = path.resolve(__dirname, "../ui/_app/index.html");
-                res.sendFile(file);
+                sendDraftShell(req, res);
             }
             else {
                 res.redirect("https://learnpack.co");
@@ -2169,12 +2181,16 @@ class ServeCommand extends SessionCommand_1.default {
         });
         app.get("/preview/:slug", async (req, res) => {
             console.log("GET COURSE PREVIEW /");
-            const file = path.resolve(__dirname, "../ui/_app/index.html");
-            res.sendFile(file);
+            sendDraftShell(req, res);
         });
         app.get("/preview/:slug/webview", async (req, res) => {
-            const file = path.resolve(__dirname, "../ui/_app/index.html");
-            res.sendFile(file);
+            sendDraftShell(req, res);
+        });
+        // The brand card used as og:image by drafts, and as the last-resort
+        // fallback by published courses without a preview of their own.
+        app.get("/og-image.png", (req, res) => {
+            res.set("Cache-Control", "public, max-age=86400");
+            res.sendFile(path.resolve(__dirname, "../ui/static/og-image.png"));
         });
         app.get("/config", async (req, res) => {
             const courseSlug = req.query.slug;
@@ -3638,52 +3654,47 @@ class ServeCommand extends SessionCommand_1.default {
                         error: "Authentication failed, missing breathecode token",
                     });
                 }
+                // Older IDEs only send the Breathecode token; without the Rigobot
+                // token the lookup falls back to the title-derived slugs.
+                const rigoToken = req.header("x-rigo-token");
                 const configFile = await bucket.file(`courses/${slug}/.learn/config.json`);
                 const [configContent] = await configFile.download();
                 const configJson = JSON.parse(configContent.toString());
                 const { config } = configJson;
-                const availableLangs = Object.keys(config.title || {});
-                let isPublished = false;
-                // Collect academy ids from all existing assets
-                const foundAcademyIds = [];
-                const slugsToCheck = availableLangs
-                    .map(lang => {
-                    const assetTitle = getLocalizedValue(config.title, lang);
-                    if (!assetTitle)
-                        return null;
-                    const assetSlug = (0, creatorUtilities_2.slugify)(assetTitle).slice(0, 47);
-                    return `${assetSlug}-${lang}`;
-                })
-                    .filter((slug) => slug !== null);
-                const assetChecks = await Promise.all(slugsToCheck.map(slug => (0, api_1.doesAssetExists)(bcToken, slug)));
-                for (const { exists, academyId: existingAcademyId } of assetChecks) {
-                    if (exists) {
-                        isPublished = true;
-                        if (existingAcademyId !== undefined) {
-                            foundAcademyIds.push(existingAcademyId);
-                        }
+                const resolution = await (0, assetResolver_1.resolvePackageAssets)({
+                    bcToken,
+                    rigoToken,
+                    packageSlug: slug,
+                    learnJson: config,
+                });
+                for (const warning of resolution.warnings) {
+                    console.warn("[package-academy]", warning);
+                }
+                const isPublished = (0, assetResolver_1.hasPublishedAsset)(resolution);
+                const academyMode = (0, assetResolver_1.determineAcademyMode)(resolution);
+                const warnings = [...resolution.warnings];
+                if (resolution.packageState === "unknown") {
+                    warnings.push(`${resolution.packageError}; existing assets could not be checked.`);
+                }
+                for (const [lang, entry] of resolution.byLang) {
+                    if (entry.status === "unknown") {
+                        warnings.push(`"${lang}": ${entry.error}`);
+                    }
+                    else if (entry.status === "ambiguous") {
+                        warnings.push(`"${lang}": ${entry.candidates.length} assets found (${entry.candidates
+                            .map(c => `#${c.id} ${c.slug}`)
+                            .join(", ")})`);
                     }
                 }
-                const uniqueAcademies = [...new Set(foundAcademyIds)];
-                let mode;
-                let lockedAcademyId;
-                let conflictAcademies;
-                if (uniqueAcademies.length === 0) {
-                    mode = "select";
-                }
-                else if (uniqueAcademies.length === 1) {
-                    mode = "locked";
-                    lockedAcademyId = uniqueAcademies[0];
-                }
-                else {
-                    mode = "conflict";
-                    conflictAcademies = uniqueAcademies;
-                }
+                const mode = academyMode.type;
+                const lockedAcademyId = academyMode.type === "locked" ? academyMode.academyId : undefined;
+                const conflictAcademies = academyMode.type === "conflict" ? academyMode.academies : undefined;
                 return res.json({
                     isPublished,
                     mode,
                     lockedAcademyId,
                     conflictAcademies,
+                    warnings,
                 });
             }
             catch (error) {
@@ -3742,13 +3753,13 @@ class ServeCommand extends SessionCommand_1.default {
                     title = config.title[availableLangs[0]];
                     selectedLang = availableLangs[0];
                 }
+                const previewUrl = await resolveCoursePreviewUrl(bucket, slug, config.preview);
                 const idxTpl = fs.readFileSync(path.join(uiSrc, "index.html"), "utf-8");
                 const idxHtml = idxTpl
                     .replace(/{{title}}/g, title)
                     .replace(/<title>.*<\/title>/, `<title>${title}</title>`)
                     .replace(/{{description}}/g, config.description[selectedLang])
-                    .replace(/{{preview}}/g, fixPreviewUrl(slug, "") ||
-                    "https://raw.githubusercontent.com/learnpack/ide/master/public/learnpack.svg")
+                    .replace(/{{preview}}/g, previewUrl)
                     .replace(/{{slug}}/g, slug)
                     .replace(/{{duration}}/g, (0, misc_1.minutesToISO8601Duration)(config.duration));
                 fs.writeFileSync(path.join(buildRoot, "index.html"), idxHtml);
@@ -3778,9 +3789,9 @@ class ServeCommand extends SessionCommand_1.default {
                 // 8) Crear el config.json en buildRoot con lo que retorna buildConfig
                 const fullConfig = { config, exercises };
                 fullConfig.config.slug = slug;
-                fullConfig.config.preview =
-                    fixPreviewUrl(slug, "") ||
-                        "https://raw.githubusercontent.com/learnpack/ide/master/public/learnpack.svg";
+                // Same URL the meta tags got: this used to overwrite the real preview
+                // of every published package with the unusable SVG fallback.
+                fullConfig.config.preview = previewUrl;
                 fs.writeFileSync(path.join(buildRoot, "config.json"), JSON.stringify(fullConfig, null, 2), "utf-8");
                 // 9) Empaquetar en ZIP (solo contenido de buildRoot)
                 const zipName = `${slug}.zip`;

package/lib/utils/api.d.ts

@@ -1,3 +1,4 @@
+export declare const BREATHECODE_HOST = "https://breathecode.herokuapp.com";
 /**
  * Student telemetry, and publication events. Both share the endpoint: a body
  * carrying a top-level `event` key is dispatched as an event, anything else
@@ -31,13 +32,30 @@ export type AssetSyncError = {
         detail: string;
     };
 };
+export type RigoPackageLookup = {
+    kind: "found";
+    id: number;
+    assetIds: number[];
+} | {
+    kind: "missing";
+} | {
+    kind: "error";
+    error: string;
+};
 /**
- * GET Rigobot package by slug after a successful upload. Does not throw.
- * @param rigoToken Rigobot API token (Bearer-style `Token` header value).
+ * Human-readable summary of a failed axios call, for warnings and error payloads.
+ * @param error - Whatever the request rejected with.
+ * @returns "HTTP <status>" when the server answered, the error message otherwise.
+ */
+export declare function describeRequestError(error: unknown): string;
+/**
+ * GET a Rigobot package by slug. Distinguishes "no such package" from
+ * "could not check", so callers can fail closed on the latter.
+ * @param rigoToken Rigobot API token (`Token` header value).
  * @param courseSlug Learnpack package slug used in the Rigobot URL path.
- * @returns Resolved numeric package id from Rigobot, or `null` if the request fails, the id is missing, or it is not a finite integer.
+ * @returns The package id and its asset_ids, `missing` on 404, `error` otherwise (403 included: a package owned by somebody else is not ours to read).
  */
-export declare function resolveLearnpackPackageId(rigoToken: string, courseSlug: string): Promise<number | null>;
+export declare function getRigoPackage(rigoToken: string, courseSlug: string): Promise<RigoPackageLookup>;
 type TAssetMissing = {
     slug: string;
     title: string;
@@ -57,10 +75,41 @@ type TAssetMissing = {
     learnpack_id: number;
 };
 export declare const createAsset: (token: string, asset: TAssetMissing) => Promise<any>;
-export declare const doesAssetExists: (token: string, assetSlug: string) => Promise<{
-    exists: boolean;
-    academyId?: number;
-}>;
+/** The subset of a Breathecode asset the publish flow reads. */
+export type BcAsset = {
+    id: number;
+    slug: string;
+    lang: string | null;
+    status: string | null;
+    learnpackId: number | null;
+    learnpackDeployUrl: string | null;
+    ownerId: number | null;
+    academyId: number | null;
+};
+export type AssetLookup = {
+    kind: "found";
+    asset: BcAsset;
+} | {
+    kind: "missing";
+} | {
+    kind: "error";
+    error: string;
+};
+/**
+ * GET a Breathecode asset by numeric id. The endpoint applies no status or
+ * visibility filter for a single asset, so this is the stable anchor.
+ * @param token Breathecode token.
+ * @param assetId Asset primary key.
+ * @returns `found` with the asset, `missing` on 404, `error` when it could not be checked.
+ */
+export declare const getAssetById: (token: string, assetId: number) => Promise<AssetLookup>;
+/**
+ * GET a Breathecode asset by slug.
+ * @param token Breathecode token.
+ * @param assetSlug Asset slug.
+ * @returns `found` with the asset, `missing` on 404, `error` when it could not be checked.
+ */
+export declare const getAssetBySlug: (token: string, assetSlug: string) => Promise<AssetLookup>;
 type TTechnology = {
     slug: string;
     lang: string;
@@ -83,18 +132,16 @@ declare const _default: {
     listUserAcademies: (breathecodeToken: string) => Promise<TAcademy[]>;
     validateToken: (token: string) => Promise<any>;
     createAsset: (token: string, asset: TAssetMissing) => Promise<any>;
-    doesAssetExists: (token: string, assetSlug: string) => Promise<{
-        exists: boolean;
-        academyId?: number;
-    }>;
-    updateAsset: (token: string, assetSlug: string, asset: Partial<TAssetMissing> & {
+    getAssetById: (token: string, assetId: number) => Promise<AssetLookup>;
+    getAssetBySlug: (token: string, assetSlug: string) => Promise<AssetLookup>;
+    updateAsset: (token: string, assetId: number, asset: Partial<TAssetMissing> & {
         learnpack_id: number;
     }) => Promise<any>;
-    resolveLearnpackPackageId: typeof resolveLearnpackPackageId;
+    getRigoPackage: typeof getRigoPackage;
     getCategories: (token: string) => Promise<any>;
     updateRigoPackage: (token: string, slug: string, updates: {
         asset_id?: number;
-        new_slug?: string;
+        asset_ids?: number[];
     }) => Promise<any>;
     createRigoPackage: (token: string, slug: string, config: any) => Promise<any>;
     getCurrentTechnologies: () => TTechnology[];