track-cli 4.1.0-rc1 → 4.1.0-rc2

package/esm/src/action/frontend-template-switch.js

@@ -1,15 +1,15 @@
 import * as dntShim from "../../_dnt.shims.js";
 import { load as loadConfig, save as saveConfig, } from "../shared/config.js";
 import { OtherError } from "../shared/errors.js";
+import { archiveExistingChallengeFiles, chooseFrontendTemplate, downloadChallengeFilesTo, getCommonChallengeContext, trackClientFromConfig, } from "../shared/mod.js";
 import { ChallengeStyle } from "../shared/types.js";
-import { archiveExistingChallengeFiles, chooseFrontendTemplate, getCommonChallengeContext, trackClientFromConfig, } from "../shared/mod.js";
-import { unzip } from "../shared/file.js";
 export async function switchFrontendTemplate() {
     const config = await loadConfig();
     const api = trackClientFromConfig(config);
     const [codingContext, challenge] = await getCommonChallengeContext(config, api);
     if (challenge.style !== ChallengeStyle.Frontend) {
-        throw new OtherError("This challenge is not a frontend challenge");
+        throw new OtherError("This challenge is not a Frontend Framework (VSCode) challenge." +
+            "\n\thint: Use 'track lang' to change programming language instead.");
     }
     // Get available frontend templates from Track
     const allFrontendTemplates = await api.frontendTemplates();
@@ -29,24 +29,21 @@ export async function switchFrontendTemplate() {
     const desiredTemplate = chooseFrontendTemplate(availableTemplates);
     if (desiredTemplate.seriesCode ===
         codingContext.selectedFrontendTemplate?.seriesCode) {
-        // already using this template
-        return;
-    }
-    // Get template details with presigned URLs
-    const templateDetails = await api.frontendTemplate(desiredTemplate.seriesCode);
-    if (!templateDetails.downloadUrl) {
-        throw new OtherError("Template does not have a download URL available");
+        const shouldForceReset = dntShim.confirm(`You are already using the template '${desiredTemplate.seriesCode}'. Do you want to start-over from the template code anyway?`);
+        if (!shouldForceReset) {
+            // already using this template
+            return;
+        }
     }
-    const currentDir = dntShim.Deno.cwd();
     await archiveExistingChallengeFiles(config.orgName);
-    // Download and extract the template ZIP file
-    const templateResp = await dntShim.fetch(templateDetails.downloadUrl);
-    if (!templateResp.ok) {
-        throw new OtherError(`Failed to download template: ${templateResp.status} ${templateResp.statusText}`);
-    }
-    // Extract template files
-    const templateZip = new Uint8Array(await templateResp.arrayBuffer());
-    await unzip(templateZip, currentDir);
+    // Ask the backend to reset the user's solution to the starter code for this template.
+    await api.updateFrontendTemplate(desiredTemplate.seriesCode);
+    // Re-download the challenge files to reflect the reset solution in the backend.
+    const currentDir = dntShim.Deno.cwd();
+    const newCodingContext = await api.context();
+    const showFileDiff = false;
+    const includeTarball = false;
+    await downloadChallengeFilesTo(newCodingContext, currentDir, api, showFileDiff, includeTarball);
     const updatedConfig = {
         ...config,
         frontendTemplate: desiredTemplate.seriesCode,

package/esm/src/action/lang.js

@@ -2,15 +2,24 @@ import * as dntShim from "../../_dnt.shims.js";
 import { load as loadConfig, save as saveConfig, } from "../shared/config.js";
 import { CantChooseLanguage } from "../shared/errors.js";
 import { archiveExistingChallengeFiles, chooseProgrammingLanguage, downloadChallengeFilesTo, getCommonChallengeContext, trackClientFromConfig, } from "../shared/mod.js";
+import { ChallengeStyle, } from "../shared/types.js";
 export async function lang() {
     const config = await loadConfig();
     const api = trackClientFromConfig(config);
     const [codingContext, challenge] = await getCommonChallengeContext(config, api);
     if (challenge.programmingLanguages.length === 0) {
-        throw new CantChooseLanguage();
+        throw new CantChooseLanguage({
+            hint: challenge.style === ChallengeStyle.Frontend
+                ? "Use 'track frontend-template' to change the frontend template for a Frontend Framework (VSCode) challenge."
+                : "",
+        });
     }
     const availableLanguages = (await api.languages())
-        .filter((pl) => codingContext.programmingLanguages.find((n) => n === pl.value));
+        .filter((pl) => {
+        return codingContext.programmingLanguages.find((n) => {
+            return n === pl.value;
+        });
+    });
     console.log("Your existing code will be archived in this directory and the original challenge code for the new language will be downloaded");
     const shouldContinue = dntShim.confirm("Are you sure you want to continue?");
     if (!shouldContinue) {

package/esm/src/action/run.js

@@ -59,17 +59,16 @@ export async function run(options) {
     const runId = dntShim.crypto.randomUUID();
     // Run the initialize/build commands if they exist
     let buildDoneData;
-    if ((codingContext.answers.build?.length || 0) > 0 ||
-        codingContext.settings.initialize.length > 0) {
-        const shellCommand = []
-            .concat(codingContext.settings.initialize)
-            .concat(codingContext.answers.build || [])
-            .filter((s) => s && s.length > 0);
+    const buildCommands = []
+        .concat(codingContext.settings.initialize || [])
+        .concat(codingContext.answers.build || [])
+        .filter((s) => s && s.length > 0);
+    if (buildCommands.length > 0) {
         const runCmd = {
             id: `${runId}-build`,
             imageName: envConfig.imageName,
             workingDir: envConfig.workingDir ?? "",
-            shellCmd: shellCommand.join(" && "),
+            shellCmd: buildCommands.join(" && "),
             attachVolume: true,
             files,
             envVars: {},

package/esm/src/meta.d.ts

@@ -1,3 +1,3 @@
-export declare const VERSION = "4.1.0-rc1";
+export declare const VERSION = "4.1.0-rc2";
 export declare const DESCRIPTION = "A CLI for interacting with tracks.run and running code tests on track's servers";
 export declare function checkUpdates(): Promise<boolean>;

package/esm/src/meta.js

@@ -1,7 +1,7 @@
 import * as colors from "../deps/deno.land/std@0.195.0/fmt/colors.js";
 // @ts-ignore: has no exported member
 import { CookieJar, fetch } from "node-fetch-cookies";
-export const VERSION = "4.1.0-rc1";
+export const VERSION = "4.1.0-rc2";
 export const DESCRIPTION = "A CLI for interacting with tracks.run and running code tests on track's servers";
 const VERSION_RE = /^(\d+)\.(\d+)\.(\d+)(?:-?(.*))$/;
 function parseSemver(s) {

package/esm/src/shared/errors.d.ts

@@ -47,8 +47,14 @@ export declare class InvalidChallengeId extends TrackError {
     challengeId: number;
     constructor(challengeId: number);
 }
+export declare class UnsupportedChallenge extends TrackError {
+    challengeId: number;
+    constructor(challengeId: number);
+}
 export declare class CantChooseLanguage extends TrackError {
-    constructor();
+    constructor(p?: {
+        hint?: string;
+    });
 }
 export declare class NotASingleResponse extends TrackError {
     constructor();

package/esm/src/shared/errors.js

@@ -119,7 +119,7 @@ export class ChallengeAlreadyFinished extends TrackError {
 }
 export class InvalidChallengeId extends TrackError {
     constructor(challengeId) {
-        super(`The challenge id specified in your URL (${challengeId}), is invalid`);
+        super(`The challenge id specified in your URL (${challengeId}) is invalid`);
         Object.defineProperty(this, "challengeId", {
             enumerable: true,
             configurable: true,
@@ -129,9 +129,22 @@ export class InvalidChallengeId extends TrackError {
         this.name = "InvalidChallengeId";
     }
 }
+export class UnsupportedChallenge extends TrackError {
+    constructor(challengeId) {
+        super(`The challenge id specified in your URL (${challengeId}) is not supported by the 'track' CLI`);
+        Object.defineProperty(this, "challengeId", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: challengeId
+        });
+        this.name = "UnsupportedChallenge";
+    }
+}
 export class CantChooseLanguage extends TrackError {
-    constructor() {
-        super("This challenge does not support changing programming languages");
+    constructor(p = {}) {
+        super("This challenge does not support changing programming languages." +
+            (p.hint ? `\n\thint: ${p.hint}` : ""));
         this.name = "CantChooseLanguage";
     }
 }

package/esm/src/shared/file.d.ts

@@ -24,7 +24,6 @@ export declare function getAllDirFiles(p: string): Promise<string[]>;
 export declare function toNixStyle(p: string): string;
 export declare function toNativeStyle(p: string): string;
 export declare function untgz(compressed: Uint8Array, dest: string): Promise<void>;
-export declare function unzip(zipData: Uint8Array, dest: string): Promise<void>;
 export type GetUniqueDirNameOptions = {
     root?: string;
 };

package/esm/src/shared/file.js

@@ -1,8 +1,8 @@
 import * as dntShim from "../../_dnt.shims.js";
-import * as path from "../../deps/deno.land/std@0.195.0/path/mod.js";
 import { Foras, gunzip } from "@hazae41/foras";
 import tar from "tar";
 import * as fs from "../../deps/deno.land/std@0.195.0/fs/mod.js";
+import * as path from "../../deps/deno.land/std@0.195.0/path/mod.js";
 export const _internals = {
     SEP: path.SEP,
 };
@@ -97,38 +97,6 @@ export async function untgz(compressed, dest) {
         cwd: dest,
     });
 }
-export async function unzip(zipData, dest) {
-    const JSZip = (await import("jszip")).default;
-    try {
-        // destination directory exists
-        await fs.ensureDir(dest);
-        const zip = new JSZip();
-        await zip.loadAsync(zipData);
-        const promises = [];
-        zip.forEach((relativePath, file) => {
-            if (!file.dir) {
-                // file
-                promises.push((async () => {
-                    const content = await file.async("uint8array");
-                    const filePath = path.join(dest, relativePath);
-                    await fs.ensureFile(filePath);
-                    await dntShim.Deno.writeFile(filePath, content);
-                })());
-            }
-            else {
-                // directory
-                promises.push((async () => {
-                    const dirPath = path.join(dest, relativePath);
-                    await fs.ensureDir(dirPath);
-                })());
-            }
-        });
-        await Promise.all(promises);
-    }
-    catch (error) {
-        throw new Error(`Failed to extract ZIP file: ${error}`);
-    }
-}
 export async function getUniqueDirName(base, options) {
     let counter = 1;
     const root = options?.root ?? dntShim.Deno.cwd();

package/esm/src/shared/types.d.ts

@@ -124,6 +124,7 @@ export declare const ChallengeStyle: {
     readonly Quiz: 1;
     readonly Development: 2;
     readonly Algorithm: 3;
+    readonly Function: 7;
     readonly Ai: 4;
     readonly Frontend: 8;
 };

package/esm/src/shared/types.js

@@ -83,6 +83,7 @@ export const ChallengeStyle = {
     Quiz: 1,
     Development: 2,
     Algorithm: 3,
+    Function: 7,
     Ai: 4,
     Frontend: 8,
 };

package/esm/src/track/test.d.ts

@@ -15,13 +15,14 @@ export declare class TestClient extends TrackClientBase implements TrackClient {
     private ensureExamInProgress;
     private getExamSession;
     private getChallengeFromExamSession;
+    isChallengeSupported(c: ChallengeSession): boolean;
     languages(): Promise<ProgrammingLanguageInfo[]>;
     frontendTemplates(): Promise<FrontendTemplateInfo[]>;
     frontendTemplate(code: string): Promise<FrontendTemplateInfo>;
     start(): Promise<ChallengeResult>;
     prepare(): Promise<ChallengeResult>;
     updateLanguage(language: ProgrammingLanguage): Promise<void>;
-    updateFrontendTemplate(templateCode: string): Promise<void>;
+    updateFrontendTemplate(seriesCode: string): Promise<void>;
     timeLeft(): Promise<number>;
     context(): Promise<CodingContext>;
     presigned(files: string[]): Promise<{

package/esm/src/track/test.js

@@ -1,4 +1,4 @@
-import { ExamCanceled, ExamExpired, ExamSubmitted, ExamUnread, InvalidChallengeId, OtherError, } from "../shared/errors.js";
+import { ExamCanceled, ExamExpired, ExamSubmitted, ExamUnread, InvalidChallengeId, OtherError, UnsupportedChallenge, } from "../shared/errors.js";
 import { HttpStatus } from "../shared/mod.js";
 import { ChallengeStyle, } from "../shared/types.js";
 import { FormType, TrackClientBase, } from "./client.js";
@@ -71,6 +71,9 @@ export class TestClient extends TrackClientBase {
         if (!challenge) {
             throw new InvalidChallengeId(this.challengeId);
         }
+        else if (!this.isChallengeSupported(challenge)) {
+            throw new UnsupportedChallenge(this.challengeId);
+        }
         this.applicantExamId = applicantExam.id;
         this.resultId = result?.id || 0;
         return challenge;
@@ -100,10 +103,13 @@ export class TestClient extends TrackClientBase {
         return examSession.challengesSets
             .flatMap((s) => s.challenges)
             .map((esc) => toChallengeSession(esc, result))
-            .find((c) => c.challengeId === this.challengeId &&
-            (c.style === ChallengeStyle.Development ||
-                c.style === ChallengeStyle.Algorithm ||
-                c.style === ChallengeStyle.Frontend));
+            .find((c) => c.challengeId === this.challengeId);
+    }
+    isChallengeSupported(c) {
+        return (c.style === ChallengeStyle.Development ||
+            c.style === ChallengeStyle.Algorithm ||
+            c.style === ChallengeStyle.Function ||
+            c.style === ChallengeStyle.Frontend);
     }
     async languages() {
         return (await this._get(`/api/enum/challenges/programminglanguages`))
@@ -130,9 +136,10 @@ export class TestClient extends TrackClientBase {
             programmingLanguage: language,
         }); // ChallengeResult
     }
-    async updateFrontendTemplate(templateCode) {
-        return await this._put(`/api/applicants/exams/${this.applicantExamId}/results/${this.resultId}/frontend-template`, FormType.URLEncoded, {
-            frontendTemplate: templateCode,
+    async updateFrontendTemplate(seriesCode) {
+        return await this._post(`/api/applicants/exams/${this.applicantExamId}/results/${this.resultId}/frontend/switch-frontend-template`, FormType.JSON, {
+            seriesCode,
+            forceReset: true,
         });
     }
     async timeLeft() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "track-cli",
-  "version": "4.1.0-rc1",
+  "version": "4.1.0-rc2",
   "description": "A CLI for interacting with tracks.run and running code tests on track's servers",
   "repository": {
     "type": "git",
@@ -19,7 +19,6 @@
   "dependencies": {
     "@hazae41/foras": "2.0.8",
     "eventemitter3": "5.0.1",
-    "jszip": "3.10.1",
     "node-fetch-cookies": "2.0.4",
     "proxy-agent": "6.3.0",
     "tar": "6.1.13",