@learnpack/learnpack 5.0.355 → 5.0.358

package/lib/utils/rigoActions.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateStepSlug = exports.generateCodeChallenge = exports.addInteractivity = exports.generateStepDescriptions = exports.initialContentGenerator = exports.getLanguageCodes = exports.isPackageAuthor = exports.fillSidebarJSON = exports.generateCourseShortName = exports.isValidRigoToken = exports.translateCourseMetadata = exports.createStructuredPreviewReadme = exports.readmeCreator = exports.createCodingReadme = exports.createCodeFile = exports.interactiveCreation = exports.generateCourseIntroduction = exports.translateExercise = exports.generateImage = exports.hasCreatorPermission = exports.createReadme = void 0;
+exports.generateStepSlug = exports.generateCodeChallenge = exports.addInteractivity = exports.generateStepDescriptions = exports.initialContentGenerator = exports.getLanguageCodes = exports.isPackageAuthor = exports.fillSidebarJSON = exports.generateCourseShortName = exports.isValidRigoToken = exports.translateCourseMetadata = exports.createStructuredPreviewReadme = exports.readmeCreator = exports.createCodingReadme = exports.createCodeFile = exports.interactiveCreation = exports.generateCourseIntroduction = exports.translateExerciseAndWait = exports.getCompletionJob = exports.translateExercise = exports.generateImage = exports.hasCreatorPermission = exports.createReadme = void 0;
 exports.downloadImage = downloadImage;
 exports.createPreviewReadme = createPreviewReadme;
 exports.makeReadmeReadable = makeReadmeReadable;
@@ -96,6 +96,107 @@ const translateExercise = async (token, inputs, webhookUrl) => {
     return response.data;
 };
 exports.translateExercise = translateExercise;
+const POST_RETRY_DELAYS_MS = [1000, 3000, 6000];
+const MAX_CONSECUTIVE_POLL_ERRORS = 5;
+const sleep = (ms) => new Promise(resolve => {
+    setTimeout(resolve, ms);
+});
+const isFinalStatus = (status) => status === "SUCCESS" || status === "ERROR";
+// Network failures and 5xx are worth retrying, a 4xx is not going to fix itself.
+const isRetriablePostError = (error) => {
+    var _a;
+    const status = (_a = error === null || error === void 0 ? void 0 : error.response) === null || _a === void 0 ? void 0 : _a.status;
+    return status === undefined || status >= 500;
+};
+const assertJobSucceeded = (job) => {
+    if (job.status === "ERROR") {
+        throw new Error(job.status_text || `Rigobot translation job ${job.id} finished with ERROR`);
+    }
+    return job;
+};
+const getCompletionJob = async (token, completionId) => {
+    const response = await axios_1.default.get(`${api_1.RIGOBOT_HOST}/v1/prompting/completion/${completionId}/`, {
+        headers: {
+            "Content-Type": "application/json",
+            Authorization: "Token " + token,
+        },
+    });
+    return response.data;
+};
+exports.getCompletionJob = getCompletionJob;
+// Translates an exercise as an asynchronous Rigobot job and waits for the
+// result by polling.
+//
+// Running the completion synchronously (execute_async: false) keeps the HTTP
+// request open until the LLM is done, which for a full README takes 28-45s and
+// gets killed by Heroku's 30s router limit. Firing the job asynchronously
+// answers in about a second and moves the waiting to the polling loop, so it
+// is no longer bound to the lifetime of a single request.
+const translateExerciseAndWait = async (token, inputs, options = {}) => {
+    const { pollIntervalMs = 3000, timeoutMs = 6 * 60 * 1000, onPoll } = options;
+    let job;
+    for (let attempt = 0; attempt <= POST_RETRY_DELAYS_MS.length; attempt++) {
+        try {
+            // eslint-disable-next-line no-await-in-loop
+            const response = await axios_1.default.post(`${api_1.RIGOBOT_HOST}/v1/prompting/completion/translate-asset-markdown/`, {
+                inputs: inputs,
+                include_purpose_objective: false,
+                execute_async: true,
+            }, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: "Token " + token,
+                },
+            });
+            job = response.data;
+            break;
+        }
+        catch (error) {
+            if (!isRetriablePostError(error) ||
+                attempt === POST_RETRY_DELAYS_MS.length) {
+                throw error;
+            }
+            // eslint-disable-next-line no-await-in-loop
+            await sleep(POST_RETRY_DELAYS_MS[attempt]);
+        }
+    }
+    if (!job) {
+        throw new Error("Rigobot did not return a translation job");
+    }
+    // Rigobot answers straight away with the cached completion when the very
+    // same inputs were translated before, so there is nothing to wait for.
+    if (isFinalStatus(job.status)) {
+        return assertJobSucceeded(job);
+    }
+    const jobId = job.id;
+    const startedAt = Date.now();
+    let consecutivePollErrors = 0;
+    while (Date.now() - startedAt < timeoutMs) {
+        // eslint-disable-next-line no-await-in-loop
+        await sleep(pollIntervalMs);
+        try {
+            // eslint-disable-next-line no-await-in-loop
+            job = await (0, exports.getCompletionJob)(token, jobId);
+            consecutivePollErrors = 0;
+        }
+        catch (error) {
+            consecutivePollErrors++;
+            if (consecutivePollErrors >= MAX_CONSECUTIVE_POLL_ERRORS) {
+                throw new Error(`Could not read the status of the translation job ${jobId} after ${MAX_CONSECUTIVE_POLL_ERRORS} attempts: ${error.message}`);
+            }
+            continue;
+        }
+        if (onPoll) {
+            // eslint-disable-next-line no-await-in-loop
+            await onPoll(job);
+        }
+        if (isFinalStatus(job.status)) {
+            return assertJobSucceeded(job);
+        }
+    }
+    throw new Error(`The translation job ${jobId} did not finish after ${Math.round(timeoutMs / 1000)}s, its last known status was ${job.status}`);
+};
+exports.translateExerciseAndWait = translateExerciseAndWait;
 const generateCourseIntroduction = async (token, inputs) => {
     const response = await axios_1.default.post(`${api_1.RIGOBOT_HOST}/v1/prompting/completion/192/`, {
         inputs: inputs,

package/lib/utils/socketRegistry.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Which sockets are listening on which channel.
+ *
+ * Extracted from `creatorSocket.ts` so the bookkeeping can be tested without
+ * standing up a socket.io server. The registry deals in socket ids only; the
+ * socket objects themselves stay with the transport layer.
+ *
+ * The behaviour that matters is `removeSocket`: a disconnecting client has to
+ * disappear from **every** channel it joined. The notification map used to be
+ * skipped on disconnect, so it grew for the lifetime of the process and
+ * accumulated ids of sockets that were long gone.
+ */
+export declare class SocketRegistry {
+    private readonly channels;
+    /**
+     * Adds a socket to a channel.
+     * @param channel - Channel key, such as a course slug or a notification id.
+     * @param socketId - The socket joining it.
+     */
+    register(channel: string, socketId: string): void;
+    /**
+     * Removes a socket from one channel, dropping the channel when it empties.
+     * @param channel - Channel to leave.
+     * @param socketId - The socket leaving it.
+     */
+    unregister(channel: string, socketId: string): void;
+    /**
+     * Removes a socket from every channel it joined.
+     *
+     * Called when the socket disconnects. Without it the registry keeps growing
+     * with ids that can never receive anything again.
+     * @param socketId - The socket that went away.
+     */
+    removeSocket(socketId: string): void;
+    /**
+     * The sockets currently listening on a channel.
+     * @param channel - Channel to look up.
+     * @returns Their socket ids, empty when nobody is listening.
+     */
+    listeners(channel: string): string[];
+    /**
+     * How many channels are being tracked. Exposed for tests and diagnostics.
+     * @returns The number of non-empty channels.
+     */
+    channelCount(): number;
+}

package/lib/utils/socketRegistry.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SocketRegistry = void 0;
+/**
+ * Which sockets are listening on which channel.
+ *
+ * Extracted from `creatorSocket.ts` so the bookkeeping can be tested without
+ * standing up a socket.io server. The registry deals in socket ids only; the
+ * socket objects themselves stay with the transport layer.
+ *
+ * The behaviour that matters is `removeSocket`: a disconnecting client has to
+ * disappear from **every** channel it joined. The notification map used to be
+ * skipped on disconnect, so it grew for the lifetime of the process and
+ * accumulated ids of sockets that were long gone.
+ */
+class SocketRegistry {
+    constructor() {
+        this.channels = new Map();
+    }
+    /**
+     * Adds a socket to a channel.
+     * @param channel - Channel key, such as a course slug or a notification id.
+     * @param socketId - The socket joining it.
+     */
+    register(channel, socketId) {
+        if (!channel || !socketId) {
+            return;
+        }
+        let listeners = this.channels.get(channel);
+        if (!listeners) {
+            listeners = new Set();
+            this.channels.set(channel, listeners);
+        }
+        listeners.add(socketId);
+    }
+    /**
+     * Removes a socket from one channel, dropping the channel when it empties.
+     * @param channel - Channel to leave.
+     * @param socketId - The socket leaving it.
+     */
+    unregister(channel, socketId) {
+        const listeners = this.channels.get(channel);
+        if (!listeners) {
+            return;
+        }
+        listeners.delete(socketId);
+        if (listeners.size === 0) {
+            this.channels.delete(channel);
+        }
+    }
+    /**
+     * Removes a socket from every channel it joined.
+     *
+     * Called when the socket disconnects. Without it the registry keeps growing
+     * with ids that can never receive anything again.
+     * @param socketId - The socket that went away.
+     */
+    removeSocket(socketId) {
+        for (const [channel, listeners] of this.channels) {
+            listeners.delete(socketId);
+            if (listeners.size === 0) {
+                this.channels.delete(channel);
+            }
+        }
+    }
+    /**
+     * The sockets currently listening on a channel.
+     * @param channel - Channel to look up.
+     * @returns Their socket ids, empty when nobody is listening.
+     */
+    listeners(channel) {
+        const listeners = this.channels.get(channel);
+        return listeners ? [...listeners] : [];
+    }
+    /**
+     * How many channels are being tracked. Exposed for tests and diagnostics.
+     * @returns The number of non-empty channels.
+     */
+    channelCount() {
+        return this.channels.size;
+    }
+}
+exports.SocketRegistry = SocketRegistry;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@learnpack/learnpack",
   "description": "Seamlessly build, sell and/or take interactive & auto-graded tutorials, start learning now or build a new tutorial to your audience.",
-  "version": "5.0.355",
+  "version": "5.0.358",
   "author": "Alejandro Sanchez @alesanchezr",
   "contributors": [
     {
@@ -166,7 +166,7 @@
     "audit:package-sources": "ts-node --project ./tsconfig.json ./scripts/audit-package-sources.ts",
     "backfill:package-manifest": "ts-node --project ./tsconfig.json ./scripts/backfill-package-manifest-s3.ts",
     "repair:legacy-packages": "ts-node --project ./tsconfig.json ./scripts/repair-legacy-packages.ts",
-    "copy-assets": "npx cpy src/creatorDist/**/* lib/creatorDist --parents --verbose && npx cpy src/utils/templates/**/* lib/utils/templates --parents --verbose && npx cpy src/lua/**/* lib/lua --parents --verbose",
+    "copy-assets": "npx cpy src/creatorDist/**/* lib/creatorDist --parents --verbose && npx cpy src/utils/templates/**/* lib/utils/templates --parents --verbose && npx cpy src/lua/**/* lib/lua --parents --verbose && npx cpy src/ui/static/**/* lib/ui/static --parents --verbose",
     "tsc": "tsc -b",
     "postpack": "rm -f oclif.manifest.json && eslint . --ext .ts --config .eslintrc",
     "prepack": "rm -rf lib && tsc -b && npm run copy-assets",

package/src/commands/publish.ts

@@ -20,6 +20,7 @@ import * as prompts from "prompts"
 import { isValidRigoToken } from "../utils/rigoActions"
 import { minutesToISO8601Duration } from "../utils/misc"
 import { getReadmeExtension, slugify } from "../utils/creatorUtilities"
+import { getFallbackPreviewUrl } from "../utils/branding"
 
 const uploadZipEndpont = RIGOBOT_HOST + "/v1/learnpack/upload"
 
@@ -588,9 +589,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)