From 56ec909c1a1802b857b5c90bae3874b0321c00a4 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Tue, 16 Mar 2021 10:07:42 +0200 Subject: [PATCH 01/79] Set release target to 2.1.0 --- CHANGELOG.md | 3 +++ package-lock.json | 2 +- package.json | 2 +- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7c880693..1c3fd677 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,8 @@ # Changelog +## [2.1.0] - Unreleased + + ## [2.0.1] - 2021-03-11 #### Fixed diff --git a/package-lock.json b/package-lock.json index fa15625b..e996b116 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "test-my-code", - "version": "2.0.1", + "version": "2.1.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 1263cf3f..b85a4305 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "test-my-code", "displayName": "TestMyCode", "description": "TestMyCode extension for Visual Studio Code", - "version": "2.0.1", + "version": "2.1.0", "license": "MIT", "publisher": "moocfi", "repository": { From 0fdd6500a0ba9d28b7e604b19f2ef9b38e65ee42 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Tue, 16 Mar 2021 11:01:38 +0200 Subject: [PATCH 02/79] Refactor WorkspaceManager mocking --- .../actions/moveExtensionDataPath.test.ts | 19 ++------ .../actions/refreshLocalExercises.test.ts | 10 ++-- src/test/commands/cleanExercise.test.ts | 25 +++++----- src/test/mocks/workspaceManager.ts | 48 +++++++++++++++++++ 4 files changed, 68 insertions(+), 34 deletions(-) create mode 100644 src/test/mocks/workspaceManager.ts diff --git a/src/test/actions/moveExtensionDataPath.test.ts b/src/test/actions/moveExtensionDataPath.test.ts index a11d2e2c..1ad0b2af 100644 --- a/src/test/actions/moveExtensionDataPath.test.ts +++ b/src/test/actions/moveExtensionDataPath.test.ts @@ -14,6 +14,7 @@ import { v2_0_0 as userData } from "../fixtures/userData"; import { workspaceExercises } from "../fixtures/workspaceManager"; import { createMockActionContext } from "../mocks/actionContext"; import { createTMCMock, TMCMockValues } from "../mocks/tmc"; +import { createWorkspaceMangerMock, WorkspaceManagerMockValues } from "../mocks/workspaceManager"; suite("moveExtensionDataPath action", function () { const virtualFileSystem = { @@ -36,7 +37,7 @@ suite("moveExtensionDataPath action", function () { let tmcMockValues: TMCMockValues; let userDataMock: IMock; let workspaceManagerMock: IMock; - let workspaceManagerActiveCourse: string | undefined; + let workspaceManagerMockValues: WorkspaceManagerMockValues; const actionContext = (): ActionContext => ({ ...stubContext, @@ -50,18 +51,8 @@ suite("moveExtensionDataPath action", function () { [tmcMock, tmcMockValues] = createTMCMock(); userDataMock = Mock.ofType(); userDataMock.setup((x) => x.getCourses()).returns(() => userData.courses); - workspaceManagerMock = Mock.ofType(); - workspaceManagerMock - .setup((x) => x.activeCourse) - .returns(() => workspaceManagerActiveCourse); - workspaceManagerMock - .setup((x) => x.closeCourseExercises(It.isAny(), It.isAny())) - .returns(async () => Ok.EMPTY); - workspaceManagerMock - .setup((x) => x.getExercisesByCourseSlug(It.isValue(courseName))) - .returns(() => workspaceExercises); - workspaceManagerMock.setup((x) => x.setExercises(It.isAny())).returns(async () => Ok.EMPTY); - workspaceManagerActiveCourse = courseName; + [workspaceManagerMock, workspaceManagerMockValues] = createWorkspaceMangerMock(); + workspaceManagerMockValues.activeCourse = courseName; }); test("should change extension data path", async function () { @@ -98,7 +89,7 @@ suite("moveExtensionDataPath action", function () { }); test.skip("should not close anything if no course workspace is active", async function () { - workspaceManagerActiveCourse = undefined; + workspaceManagerMockValues.activeCourse = undefined; await moveExtensionDataPath(actionContext(), emptyFolder); workspaceManagerMock.verify( (x) => x.closeCourseExercises(It.isValue(courseName), It.isValue(openExerciseSlugs)), diff --git a/src/test/actions/refreshLocalExercises.test.ts b/src/test/actions/refreshLocalExercises.test.ts index 741b7239..11b7bf42 100644 --- a/src/test/actions/refreshLocalExercises.test.ts +++ b/src/test/actions/refreshLocalExercises.test.ts @@ -10,6 +10,7 @@ import { UserData } from "../../config/userdata"; import { v2_0_0 as userData } from "../fixtures/userData"; import { createMockActionContext } from "../mocks/actionContext"; import { createTMCMock, TMCMockValues } from "../mocks/tmc"; +import { createWorkspaceMangerMock, WorkspaceManagerMockValues } from "../mocks/workspaceManager"; suite("refreshLocalExercises action", function () { const stubContext = createMockActionContext(); @@ -18,6 +19,7 @@ suite("refreshLocalExercises action", function () { let tmcMockValues: TMCMockValues; let userDataMock: IMock; let workspaceManagerMock: IMock; + let workspaceManagerMockValues: WorkspaceManagerMockValues; const actionContext = (): ActionContext => ({ ...stubContext, @@ -30,8 +32,7 @@ suite("refreshLocalExercises action", function () { [tmcMock, tmcMockValues] = createTMCMock(); userDataMock = Mock.ofType(); userDataMock.setup((x) => x.getCourses()).returns(() => userData.courses); - workspaceManagerMock = Mock.ofType(); - workspaceManagerMock.setup((x) => x.setExercises(It.isAny())).returns(async () => Ok.EMPTY); + [workspaceManagerMock, workspaceManagerMockValues] = createWorkspaceMangerMock(); }); test("should set exercises to WorkspaceManager", async function () { @@ -55,10 +56,7 @@ suite("refreshLocalExercises action", function () { }); test("should return error if WorkspaceManager operation fails", async function () { - workspaceManagerMock.reset(); - workspaceManagerMock - .setup((x) => x.setExercises(It.isAny())) - .returns(async () => Err(new Error())); + workspaceManagerMockValues.setExercises = Err(new Error()); const result = await refreshLocalExercises(actionContext()); expect(result.val).to.be.instanceOf(Error); }); diff --git a/src/test/commands/cleanExercise.test.ts b/src/test/commands/cleanExercise.test.ts index 968f9bce..4d173081 100644 --- a/src/test/commands/cleanExercise.test.ts +++ b/src/test/commands/cleanExercise.test.ts @@ -1,5 +1,5 @@ import * as path from "path"; -import { IMock, It, Mock, Times } from "typemoq"; +import { IMock, It, Times } from "typemoq"; import * as vscode from "vscode"; import { ActionContext } from "../../actions/types"; @@ -8,6 +8,7 @@ import WorkspaceManager, { ExerciseStatus } from "../../api/workspaceManager"; import { cleanExercise } from "../../commands"; import { createMockActionContext } from "../mocks/actionContext"; import { createTMCMock } from "../mocks/tmc"; +import { createWorkspaceMangerMock, WorkspaceManagerMockValues } from "../mocks/workspaceManager"; suite("Clean exercise command", function () { const BACKEND_FOLDER = path.join(__dirname, "..", "backend"); @@ -19,6 +20,7 @@ suite("Clean exercise command", function () { let tmcMock: IMock; let workspaceManagerMock: IMock; + let workspaceManagerMockValues: WorkspaceManagerMockValues; function actionContext(): ActionContext { return { @@ -30,37 +32,32 @@ suite("Clean exercise command", function () { setup(function () { [tmcMock] = createTMCMock(); - workspaceManagerMock = Mock.ofType(); + [workspaceManagerMock, workspaceManagerMockValues] = createWorkspaceMangerMock(); }); test("should clean active exercise by default", async function () { - workspaceManagerMock.setup((x) => x.uriIsExercise(It.isAny())).returns(() => true); - workspaceManagerMock - .setup((x) => x.activeExercise) - .returns(() => ({ - courseSlug: "test-python-course", - exerciseSlug: "part01-01_passing_exercise", - status: ExerciseStatus.Open, - uri, - })); + workspaceManagerMockValues.activeExercise = { + courseSlug: "test-python-course", + exerciseSlug: "part01-01_passing_exercise", + status: ExerciseStatus.Open, + uri, + }; await cleanExercise(actionContext(), undefined); tmcMock.verify((x) => x.clean(It.isValue(uri.fsPath)), Times.once()); }); test("should not clean active non-exercise", async function () { - workspaceManagerMock.setup((x) => x.activeExercise).returns(() => undefined); await cleanExercise(actionContext(), undefined); tmcMock.verify((x) => x.clean(It.isAny()), Times.never()); }); test("should clean provided exercise", async function () { - workspaceManagerMock.setup((x) => x.uriIsExercise(It.isAny())).returns(() => true); await cleanExercise(actionContext(), uri); tmcMock.verify((x) => x.clean(It.isValue(uri.fsPath)), Times.once()); }); test("should not clean provided non-exercise", async function () { - workspaceManagerMock.setup((x) => x.uriIsExercise(It.isAny())).returns(() => false); + workspaceManagerMockValues.uriIsExercise = false; await cleanExercise(actionContext(), uri); tmcMock.verify((x) => x.clean(It.isAny()), Times.never()); }); diff --git a/src/test/mocks/workspaceManager.ts b/src/test/mocks/workspaceManager.ts new file mode 100644 index 00000000..1ea56862 --- /dev/null +++ b/src/test/mocks/workspaceManager.ts @@ -0,0 +1,48 @@ +import { Ok, Result } from "ts-results"; +import { IMock, It, Mock } from "typemoq"; + +import WorkspaceManager, { WorkspaceExercise } from "../../api/workspaceManager"; +import { workspaceExercises } from "../fixtures/workspaceManager"; + +export interface WorkspaceManagerMockValues { + activeCourse?: string; + activeExercise?: Readonly; + closeExercises: Result; + getExercisesByCoursePythonCourse: ReadonlyArray; + setExercises: Result; + uriIsExercise: boolean; +} + +export function createWorkspaceMangerMock(): [IMock, WorkspaceManagerMockValues] { + const values: WorkspaceManagerMockValues = { + activeCourse: undefined, + activeExercise: undefined, + closeExercises: Ok.EMPTY, + getExercisesByCoursePythonCourse: workspaceExercises, + setExercises: Ok.EMPTY, + uriIsExercise: true, + }; + const mock = setupMockValues(values); + + return [mock, values]; +} + +function setupMockValues(values: WorkspaceManagerMockValues): IMock { + const mock = Mock.ofType(); + + mock.setup((x) => x.activeCourse).returns(() => values.activeCourse); + mock.setup((x) => x.activeExercise).returns(() => values.activeExercise); + + mock.setup((x) => x.closeCourseExercises(It.isAny(), It.isAny())).returns( + async () => values.closeExercises, + ); + + mock.setup((x) => x.getExercisesByCourseSlug(It.isValue("test-python-course"))).returns( + () => values.getExercisesByCoursePythonCourse, + ); + + mock.setup((x) => x.setExercises(It.isAny())).returns(async () => values.setExercises); + mock.setup((x) => x.uriIsExercise(It.isAny())).returns(() => values.uriIsExercise); + + return mock; +} From 1dc8196583d4edb5cc8b114e36a0b03f51424e53 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Tue, 16 Mar 2021 11:30:58 +0200 Subject: [PATCH 03/79] Refactor UserData mocking --- .../actions/checkForExerciseUpdates.test.ts | 7 +++-- .../actions/moveExtensionDataPath.test.ts | 7 +++-- .../actions/refreshLocalExercises.test.ts | 11 ++++---- src/test/mocks/userdata.ts | 26 +++++++++++++++++++ 4 files changed, 37 insertions(+), 14 deletions(-) create mode 100644 src/test/mocks/userdata.ts diff --git a/src/test/actions/checkForExerciseUpdates.test.ts b/src/test/actions/checkForExerciseUpdates.test.ts index bcfbf16d..4ced47a8 100644 --- a/src/test/actions/checkForExerciseUpdates.test.ts +++ b/src/test/actions/checkForExerciseUpdates.test.ts @@ -1,14 +1,14 @@ import { expect } from "chai"; import { Err, Ok } from "ts-results"; -import { IMock, It, Mock, Times } from "typemoq"; +import { IMock, It, Times } from "typemoq"; import { checkForExerciseUpdates } from "../../actions"; import { ActionContext } from "../../actions/types"; import TMC from "../../api/tmc"; import { UserData } from "../../config/userdata"; -import { v2_0_0 as userData } from "../fixtures/userData"; import { createMockActionContext } from "../mocks/actionContext"; import { createTMCMock, TMCMockValues } from "../mocks/tmc"; +import { createUserDataMock } from "../mocks/userdata"; suite("checkForExerciseUpdates action", function () { const stubContext = createMockActionContext(); @@ -26,8 +26,7 @@ suite("checkForExerciseUpdates action", function () { setup(function () { [tmcMock, tmcMockValues] = createTMCMock(); - userDataMock = Mock.ofType(); - userDataMock.setup((x) => x.getCourses()).returns(() => userData.courses); + [userDataMock] = createUserDataMock(); }); test("should return exercise updates", async function () { diff --git a/src/test/actions/moveExtensionDataPath.test.ts b/src/test/actions/moveExtensionDataPath.test.ts index 1ad0b2af..3696215d 100644 --- a/src/test/actions/moveExtensionDataPath.test.ts +++ b/src/test/actions/moveExtensionDataPath.test.ts @@ -2,7 +2,7 @@ import { expect } from "chai"; import * as mockFs from "mock-fs"; import * as path from "path"; import { Err, Ok } from "ts-results"; -import { IMock, It, Mock, Times } from "typemoq"; +import { IMock, It, Times } from "typemoq"; import * as vscode from "vscode"; import { moveExtensionDataPath } from "../../actions"; @@ -10,10 +10,10 @@ import { ActionContext } from "../../actions/types"; import TMC from "../../api/tmc"; import WorkspaceManager, { ExerciseStatus } from "../../api/workspaceManager"; import { UserData } from "../../config/userdata"; -import { v2_0_0 as userData } from "../fixtures/userData"; import { workspaceExercises } from "../fixtures/workspaceManager"; import { createMockActionContext } from "../mocks/actionContext"; import { createTMCMock, TMCMockValues } from "../mocks/tmc"; +import { createUserDataMock } from "../mocks/userdata"; import { createWorkspaceMangerMock, WorkspaceManagerMockValues } from "../mocks/workspaceManager"; suite("moveExtensionDataPath action", function () { @@ -49,8 +49,7 @@ suite("moveExtensionDataPath action", function () { setup(function () { mockFs(virtualFileSystem); [tmcMock, tmcMockValues] = createTMCMock(); - userDataMock = Mock.ofType(); - userDataMock.setup((x) => x.getCourses()).returns(() => userData.courses); + [userDataMock] = createUserDataMock(); [workspaceManagerMock, workspaceManagerMockValues] = createWorkspaceMangerMock(); workspaceManagerMockValues.activeCourse = courseName; }); diff --git a/src/test/actions/refreshLocalExercises.test.ts b/src/test/actions/refreshLocalExercises.test.ts index 11b7bf42..c0934a36 100644 --- a/src/test/actions/refreshLocalExercises.test.ts +++ b/src/test/actions/refreshLocalExercises.test.ts @@ -1,15 +1,15 @@ import { expect } from "chai"; import { Err, Ok } from "ts-results"; -import { IMock, It, Mock, Times } from "typemoq"; +import { IMock, It, Times } from "typemoq"; import { refreshLocalExercises } from "../../actions/refreshLocalExercises"; import { ActionContext } from "../../actions/types"; import TMC from "../../api/tmc"; import WorkspaceManager from "../../api/workspaceManager"; import { UserData } from "../../config/userdata"; -import { v2_0_0 as userData } from "../fixtures/userData"; import { createMockActionContext } from "../mocks/actionContext"; import { createTMCMock, TMCMockValues } from "../mocks/tmc"; +import { createUserDataMock, UserDataMockValues } from "../mocks/userdata"; import { createWorkspaceMangerMock, WorkspaceManagerMockValues } from "../mocks/workspaceManager"; suite("refreshLocalExercises action", function () { @@ -18,6 +18,7 @@ suite("refreshLocalExercises action", function () { let tmcMock: IMock; let tmcMockValues: TMCMockValues; let userDataMock: IMock; + let userDataMockValues: UserDataMockValues; let workspaceManagerMock: IMock; let workspaceManagerMockValues: WorkspaceManagerMockValues; @@ -30,8 +31,7 @@ suite("refreshLocalExercises action", function () { setup(function () { [tmcMock, tmcMockValues] = createTMCMock(); - userDataMock = Mock.ofType(); - userDataMock.setup((x) => x.getCourses()).returns(() => userData.courses); + [userDataMock, userDataMockValues] = createUserDataMock(); [workspaceManagerMock, workspaceManagerMockValues] = createWorkspaceMangerMock(); }); @@ -42,8 +42,7 @@ suite("refreshLocalExercises action", function () { }); test("should work without any courses", async function () { - userDataMock.reset(); - userDataMock.setup((x) => x.getCourses()).returns(() => []); + userDataMockValues.getCourses = []; const result = await refreshLocalExercises(actionContext()); expect(result).to.be.equal(Ok.EMPTY); }); diff --git a/src/test/mocks/userdata.ts b/src/test/mocks/userdata.ts new file mode 100644 index 00000000..3385ea92 --- /dev/null +++ b/src/test/mocks/userdata.ts @@ -0,0 +1,26 @@ +import { IMock, Mock } from "typemoq"; + +import { LocalCourseData } from "../../api/storage"; +import { UserData } from "../../config/userdata"; +import { v2_0_0 as userData } from "../fixtures/userData"; + +export interface UserDataMockValues { + getCourses: LocalCourseData[]; +} + +export function createUserDataMock(): [IMock, UserDataMockValues] { + const values: UserDataMockValues = { + getCourses: userData.courses, + }; + const mock = setupMockValues(values); + + return [mock, values]; +} + +function setupMockValues(values: UserDataMockValues): IMock { + const mock = Mock.ofType(); + + mock.setup((x) => x.getCourses()).returns(() => values.getCourses); + + return mock; +} From a2fefd3a8a5ecf9f1c11a53473a99d6cb1da00d0 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Tue, 16 Mar 2021 13:34:58 +0200 Subject: [PATCH 04/79] Exercise decoration provider Co-authored-by: Sebastian Sergelius <39335537+sebazai@users.noreply.github.com> --- src/api/exerciseDecorationProvider.ts | 63 ++++++++++++++++ src/config/constants.ts | 1 + src/extension.ts | 4 + .../api/exerciseDecorationProvider.test.ts | 73 +++++++++++++++++++ src/test/fixtures/userData.ts | 33 ++++++--- src/test/fixtures/workspaceManager.ts | 29 ++++---- src/test/mocks/userdata.ts | 10 ++- src/test/mocks/workspaceManager.ts | 4 + 8 files changed, 189 insertions(+), 28 deletions(-) create mode 100644 src/api/exerciseDecorationProvider.ts create mode 100644 src/test/api/exerciseDecorationProvider.test.ts diff --git a/src/api/exerciseDecorationProvider.ts b/src/api/exerciseDecorationProvider.ts new file mode 100644 index 00000000..51324954 --- /dev/null +++ b/src/api/exerciseDecorationProvider.ts @@ -0,0 +1,63 @@ +import * as vscode from "vscode"; + +import WorkspaceManager from "../api/workspaceManager"; +import { UserData } from "../config/userdata"; + +/** + * Class that adds decorations like completion icons for exercises. + */ +export class ExerciseDecorationProvider implements vscode.FileDecorationProvider { + public onDidChangeFileDecorations: vscode.Event; + + private static _passedExercise = new vscode.FileDecoration( + "✓", + "Exercise completed!", + new vscode.ThemeColor("gitDecoration.addedResourceForeground"), + ); + + private static _missingExercise = new vscode.FileDecoration( + "ⓘ", + "Exercise not found in course. This could be an old exercise that has been renamed or removed from course.", + new vscode.ThemeColor("gitDecoration.ignoredResourceForeground"), + ); + + private static _expiredExercise = new vscode.FileDecoration("✗", "Deadline exceeded."); + + /** + * Creates a new instance of an `ExerciseDecorationProvider`. + */ + constructor( + private readonly userData: UserData, + private readonly workspaceManager: WorkspaceManager, + ) { + this.onDidChangeFileDecorations = new vscode.EventEmitter< + vscode.Uri | vscode.Uri[] + >().event; + } + + public provideFileDecoration(uri: vscode.Uri): vscode.ProviderResult { + const exercise = this.workspaceManager.getExerciseByPath(uri); + if (!exercise || exercise.uri.fsPath !== uri.fsPath) { + return; + } + + const apiExercise = this.userData.getExerciseByName( + exercise.courseSlug, + exercise.exerciseSlug, + ); + if (!apiExercise) { + return ExerciseDecorationProvider._missingExercise; + } + + if (apiExercise.passed) { + return ExerciseDecorationProvider._passedExercise; + } + + const deadlinePassed = apiExercise.deadline + ? Date.now() > Date.parse(apiExercise.deadline) + : undefined; + if (deadlinePassed) { + return ExerciseDecorationProvider._expiredExercise; + } + } +} diff --git a/src/config/constants.ts b/src/config/constants.ts index 6ccb4c0e..3b00bf94 100644 --- a/src/config/constants.ts +++ b/src/config/constants.ts @@ -53,6 +53,7 @@ export const WATCHER_EXCLUDE = { export const WORKSPACE_SETTINGS = { folders: [{ path: ".tmc" }], settings: { + "explorer.decorations.colors": false, "workbench.editor.closeOnFileDelete": true, "files.autoSave": "onFocusChange", "files.exclude": { ...HIDE_META_FILES }, diff --git a/src/extension.ts b/src/extension.ts index a881bd9d..6903e899 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -4,6 +4,7 @@ import * as vscode from "vscode"; import { checkForCourseUpdates, refreshLocalExercises } from "./actions"; import Dialog from "./api/dialog"; +import { ExerciseDecorationProvider } from "./api/exerciseDecorationProvider"; import Storage from "./api/storage"; import TMC from "./api/tmc"; import WorkspaceManager from "./api/workspaceManager"; @@ -187,6 +188,9 @@ export async function activate(context: vscode.ExtensionContext): Promise ); }, EXERCISE_CHECK_INTERVAL); + const decorator = new ExerciseDecorationProvider(userData, workspaceManager); + context.subscriptions.push(vscode.window.registerFileDecorationProvider(decorator)); + const versionDiff = semVerCompare(currentVersion, previousVersion || "", "minor"); if (versionDiff === undefined || versionDiff > 0) { await vscode.commands.executeCommand("tmc.showWelcome"); diff --git a/src/test/api/exerciseDecorationProvider.test.ts b/src/test/api/exerciseDecorationProvider.test.ts new file mode 100644 index 00000000..4bf5730c --- /dev/null +++ b/src/test/api/exerciseDecorationProvider.test.ts @@ -0,0 +1,73 @@ +import { expect } from "chai"; +import { IMock, It, Times } from "typemoq"; +import * as vscode from "vscode"; + +import { ExerciseDecorationProvider } from "../../api/exerciseDecorationProvider"; +import WorkspaceManager from "../../api/workspaceManager"; +import { UserData } from "../../config/userdata"; +import { userDataExerciseHelloWorld } from "../fixtures/userData"; +import { exerciseHelloWorld } from "../fixtures/workspaceManager"; +import { createUserDataMock, UserDataMockValues } from "../mocks/userdata"; +import { createWorkspaceMangerMock, WorkspaceManagerMockValues } from "../mocks/workspaceManager"; + +suite("ExerciseDecoratorProvider class", function () { + let userDataMock: IMock; + let userDataMockValues: UserDataMockValues; + let workspaceManagerMock: IMock; + let workspaceManagerMockValues: WorkspaceManagerMockValues; + + let exerciseDecorationProvider: ExerciseDecorationProvider; + + setup(function () { + [userDataMock, userDataMockValues] = createUserDataMock(); + userDataMockValues.getExerciseByName = userDataExerciseHelloWorld; + + [workspaceManagerMock, workspaceManagerMockValues] = createWorkspaceMangerMock(); + workspaceManagerMockValues.getExerciseByPath = exerciseHelloWorld; + + exerciseDecorationProvider = new ExerciseDecorationProvider( + userDataMock.object, + workspaceManagerMock.object, + ); + }); + + test("should decorate passed exercise with a checkmark", function () { + userDataMockValues.getExerciseByName = { ...userDataExerciseHelloWorld, passed: true }; + const decoration = exerciseDecorationProvider.provideFileDecoration(exerciseHelloWorld.uri); + expect((decoration as vscode.FileDecoration).badge).to.be.equal("✓"); + }); + + test("should decorate expired exercise with an X mark", function () { + const expiredExercise = { ...userDataExerciseHelloWorld, deadline: "1970-01-01" }; + userDataMockValues.getExerciseByName = expiredExercise; + const decoration = exerciseDecorationProvider.provideFileDecoration(exerciseHelloWorld.uri); + expect((decoration as vscode.FileDecoration).badge).to.be.equal("✗"); + }); + + test("should decorate exercise missing from UserData with information symbol", function () { + userDataMockValues.getExerciseByName = undefined; + const decoration = exerciseDecorationProvider.provideFileDecoration(exerciseHelloWorld.uri); + expect((decoration as vscode.FileDecoration).badge).to.be.equal("ⓘ"); + }); + + test("should not decorate valid exercise that isn't yet passed", function () { + userDataMockValues.getExerciseByName = { ...userDataExerciseHelloWorld, passed: false }; + const decoration = exerciseDecorationProvider.provideFileDecoration(exerciseHelloWorld.uri); + expect(decoration).to.be.undefined; + }); + + test("should not decorate exercise folder subitem", function () { + const rootUri = vscode.Uri.file("/tmc/vscode/test-python-course/hello_world"); + const subUri = vscode.Uri.file("/tmc/vscode/test-python-course/hello_world/src/hello.py"); + workspaceManagerMockValues.getExerciseByPath = { ...exerciseHelloWorld, uri: rootUri }; + const decoration = exerciseDecorationProvider.provideFileDecoration(subUri); + expect(decoration).to.be.undefined; + }); + + test("should not attempt to decorate a non-exercise", function () { + const notExercise = vscode.Uri.file("something.txt"); + const decoration = exerciseDecorationProvider.provideFileDecoration(notExercise); + expect(decoration).to.be.undefined; + userDataMock.verify((x) => x.getExerciseByName(It.isAny(), It.isAny()), Times.never()); + }); +}); diff --git a/src/test/fixtures/userData.ts b/src/test/fixtures/userData.ts index c2816df6..80b30ff1 100644 --- a/src/test/fixtures/userData.ts +++ b/src/test/fixtures/userData.ts @@ -1,5 +1,18 @@ +import { LocalCourseExercise } from "../../api/storage"; import { LocalCourseDataV0, LocalCourseDataV1 } from "../../migrate/migrateUserData"; +export const userDataExerciseHelloWorld: LocalCourseExercise = { + id: 1, + deadline: null, + name: "hello_world", + passed: false, + softDeadline: null, +}; + +// ------------------------------------------------------------------------------------------------- +// Previous version snapshots +// ------------------------------------------------------------------------------------------------- + interface UserDataV0 { courses: LocalCourseDataV0[]; } @@ -8,7 +21,7 @@ interface UserDataV1 { courses: LocalCourseDataV1[]; } -const v0_1_0: UserDataV0 = { +export const v0_1_0: UserDataV0 = { courses: [ { id: 0, @@ -23,7 +36,7 @@ const v0_1_0: UserDataV0 = { ], }; -const v0_2_0: UserDataV0 = { +export const v0_2_0: UserDataV0 = { courses: [ { id: 0, @@ -40,7 +53,7 @@ const v0_2_0: UserDataV0 = { ], }; -const v0_3_0: UserDataV0 = { +export const v0_3_0: UserDataV0 = { courses: [ { id: 0, @@ -59,7 +72,7 @@ const v0_3_0: UserDataV0 = { ], }; -const v0_4_0: UserDataV0 = { +export const v0_4_0: UserDataV0 = { courses: [ { id: 0, @@ -79,7 +92,7 @@ const v0_4_0: UserDataV0 = { ], }; -const v0_6_0: UserDataV0 = { +export const v0_6_0: UserDataV0 = { courses: [ { id: 0, @@ -99,7 +112,7 @@ const v0_6_0: UserDataV0 = { ], }; -const v0_8_0: UserDataV0 = { +export const v0_8_0: UserDataV0 = { courses: [ { id: 0, @@ -120,7 +133,7 @@ const v0_8_0: UserDataV0 = { ], }; -const v0_9_0: UserDataV0 = { +export const v0_9_0: UserDataV0 = { courses: [ { id: 0, @@ -143,7 +156,7 @@ const v0_9_0: UserDataV0 = { ], }; -const v1_0_0: UserDataV0 = { +export const v1_0_0: UserDataV0 = { courses: [ { id: 0, @@ -178,7 +191,7 @@ const v1_0_0: UserDataV0 = { ], }; -const v2_0_0: UserDataV1 = { +export const v2_0_0: UserDataV1 = { courses: [ { id: 0, @@ -212,5 +225,3 @@ const v2_0_0: UserDataV1 = { }, ], }; - -export { v0_1_0, v0_2_0, v0_3_0, v0_4_0, v0_6_0, v0_8_0, v0_9_0, v1_0_0, v2_0_0 }; diff --git a/src/test/fixtures/workspaceManager.ts b/src/test/fixtures/workspaceManager.ts index e0979120..5655abdb 100644 --- a/src/test/fixtures/workspaceManager.ts +++ b/src/test/fixtures/workspaceManager.ts @@ -2,19 +2,18 @@ import * as vscode from "vscode"; import { ExerciseStatus, WorkspaceExercise } from "../../api/workspaceManager"; -const workspaceExercises: WorkspaceExercise[] = [ - { - courseSlug: "test-python-course", - exerciseSlug: "hello_world", - status: ExerciseStatus.Open, - uri: vscode.Uri.file("/tmc/vscode/test-python-course/hello_world"), - }, - { - courseSlug: "test-python-course", - exerciseSlug: "other_world", - status: ExerciseStatus.Closed, - uri: vscode.Uri.file("/tmc/vscode/test-python-course/other_world"), - }, -]; +export const exerciseHelloWorld: WorkspaceExercise = { + courseSlug: "test-python-course", + exerciseSlug: "hello_world", + status: ExerciseStatus.Open, + uri: vscode.Uri.file("/tmc/vscode/test-python-course/hello_world"), +}; -export { workspaceExercises }; +export const exerciseOtherWorld: WorkspaceExercise = { + courseSlug: "test-python-course", + exerciseSlug: "other_world", + status: ExerciseStatus.Closed, + uri: vscode.Uri.file("/tmc/vscode/test-python-course/other_world"), +}; + +export const workspaceExercises: WorkspaceExercise[] = [exerciseHelloWorld, exerciseOtherWorld]; diff --git a/src/test/mocks/userdata.ts b/src/test/mocks/userdata.ts index 3385ea92..dbdf31e3 100644 --- a/src/test/mocks/userdata.ts +++ b/src/test/mocks/userdata.ts @@ -1,16 +1,18 @@ -import { IMock, Mock } from "typemoq"; +import { IMock, It, Mock } from "typemoq"; -import { LocalCourseData } from "../../api/storage"; +import { LocalCourseData, LocalCourseExercise } from "../../api/storage"; import { UserData } from "../../config/userdata"; import { v2_0_0 as userData } from "../fixtures/userData"; export interface UserDataMockValues { getCourses: LocalCourseData[]; + getExerciseByName: Readonly | undefined; } export function createUserDataMock(): [IMock, UserDataMockValues] { const values: UserDataMockValues = { getCourses: userData.courses, + getExerciseByName: undefined, }; const mock = setupMockValues(values); @@ -22,5 +24,9 @@ function setupMockValues(values: UserDataMockValues): IMock { mock.setup((x) => x.getCourses()).returns(() => values.getCourses); + mock.setup((x) => x.getExerciseByName(It.isAny(), It.isAny())).returns( + () => values.getExerciseByName, + ); + return mock; } diff --git a/src/test/mocks/workspaceManager.ts b/src/test/mocks/workspaceManager.ts index 1ea56862..03b30942 100644 --- a/src/test/mocks/workspaceManager.ts +++ b/src/test/mocks/workspaceManager.ts @@ -8,6 +8,7 @@ export interface WorkspaceManagerMockValues { activeCourse?: string; activeExercise?: Readonly; closeExercises: Result; + getExerciseByPath: Readonly | undefined; getExercisesByCoursePythonCourse: ReadonlyArray; setExercises: Result; uriIsExercise: boolean; @@ -18,6 +19,7 @@ export function createWorkspaceMangerMock(): [IMock, Workspace activeCourse: undefined, activeExercise: undefined, closeExercises: Ok.EMPTY, + getExerciseByPath: undefined, getExercisesByCoursePythonCourse: workspaceExercises, setExercises: Ok.EMPTY, uriIsExercise: true, @@ -37,6 +39,8 @@ function setupMockValues(values: WorkspaceManagerMockValues): IMock values.closeExercises, ); + mock.setup((x) => x.getExerciseByPath(It.isAny())).returns(() => values.getExerciseByPath); + mock.setup((x) => x.getExercisesByCourseSlug(It.isValue("test-python-course"))).returns( () => values.getExercisesByCoursePythonCourse, ); From 52f668eb2db32d939edf98366a5a12a63cc78665 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Tue, 16 Mar 2021 16:07:36 +0200 Subject: [PATCH 05/79] Add method for refreshing decorations --- src/actions/types.ts | 2 ++ src/api/exerciseDecorationProvider.ts | 24 +++++++++++++++++++----- src/extension.ts | 10 +++++++--- src/test/mocks/actionContext.ts | 2 ++ 4 files changed, 30 insertions(+), 8 deletions(-) diff --git a/src/actions/types.ts b/src/actions/types.ts index 013fdf3e..64323442 100644 --- a/src/actions/types.ts +++ b/src/actions/types.ts @@ -1,4 +1,5 @@ import Dialog from "../api/dialog"; +import { ExerciseDecorationProvider } from "../api/exerciseDecorationProvider"; import TMC from "../api/tmc"; import WorkspaceManager from "../api/workspaceManager"; import Resources from "../config/resources"; @@ -10,6 +11,7 @@ import UI from "../ui/ui"; export type ActionContext = { dialog: Dialog; + exerciseDecorationProvider: ExerciseDecorationProvider; resources: Resources; settings: Settings; temporaryWebviewProvider: TemporaryWebviewProvider; diff --git a/src/api/exerciseDecorationProvider.ts b/src/api/exerciseDecorationProvider.ts index 51324954..aaf4aaa7 100644 --- a/src/api/exerciseDecorationProvider.ts +++ b/src/api/exerciseDecorationProvider.ts @@ -1,12 +1,13 @@ import * as vscode from "vscode"; -import WorkspaceManager from "../api/workspaceManager"; +import WorkspaceManager, { WorkspaceExercise } from "../api/workspaceManager"; import { UserData } from "../config/userdata"; /** * Class that adds decorations like completion icons for exercises. */ -export class ExerciseDecorationProvider implements vscode.FileDecorationProvider { +export class ExerciseDecorationProvider + implements vscode.Disposable, vscode.FileDecorationProvider { public onDidChangeFileDecorations: vscode.Event; private static _passedExercise = new vscode.FileDecoration( @@ -23,6 +24,8 @@ export class ExerciseDecorationProvider implements vscode.FileDecorationProvider private static _expiredExercise = new vscode.FileDecoration("✗", "Deadline exceeded."); + private _eventEmiter: vscode.EventEmitter; + /** * Creates a new instance of an `ExerciseDecorationProvider`. */ @@ -30,9 +33,12 @@ export class ExerciseDecorationProvider implements vscode.FileDecorationProvider private readonly userData: UserData, private readonly workspaceManager: WorkspaceManager, ) { - this.onDidChangeFileDecorations = new vscode.EventEmitter< - vscode.Uri | vscode.Uri[] - >().event; + this._eventEmiter = new vscode.EventEmitter(); + this.onDidChangeFileDecorations = this._eventEmiter.event; + } + + public dispose(): void { + this._eventEmiter.dispose(); } public provideFileDecoration(uri: vscode.Uri): vscode.ProviderResult { @@ -60,4 +66,12 @@ export class ExerciseDecorationProvider implements vscode.FileDecorationProvider return ExerciseDecorationProvider._expiredExercise; } } + + /** + * Trigger decorator event for given exercises. Requires this object to be registered with + * `vscode.window.registerFileDecorationProvider` for any effects to take any effect. + */ + public updateDecorationsForExercises(...exercises: ReadonlyArray): void { + this._eventEmiter.fire(exercises.map((x) => x.uri)); + } } diff --git a/src/extension.ts b/src/extension.ts index 6903e899..35808d78 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -3,6 +3,7 @@ import { createIs } from "typescript-is"; import * as vscode from "vscode"; import { checkForCourseUpdates, refreshLocalExercises } from "./actions"; +import { ActionContext } from "./actions/types"; import Dialog from "./api/dialog"; import { ExerciseDecorationProvider } from "./api/exerciseDecorationProvider"; import Storage from "./api/storage"; @@ -144,8 +145,10 @@ export async function activate(context: vscode.ExtensionContext): Promise } const temporaryWebviewProvider = new TemporaryWebviewProvider(resources, ui); - const actionContext = { + const exerciseDecorationProvider = new ExerciseDecorationProvider(userData, workspaceManager); + const actionContext: ActionContext = { dialog, + exerciseDecorationProvider, resources, settings, temporaryWebviewProvider, @@ -188,8 +191,9 @@ export async function activate(context: vscode.ExtensionContext): Promise ); }, EXERCISE_CHECK_INTERVAL); - const decorator = new ExerciseDecorationProvider(userData, workspaceManager); - context.subscriptions.push(vscode.window.registerFileDecorationProvider(decorator)); + context.subscriptions.push( + vscode.window.registerFileDecorationProvider(exerciseDecorationProvider), + ); const versionDiff = semVerCompare(currentVersion, previousVersion || "", "minor"); if (versionDiff === undefined || versionDiff > 0) { diff --git a/src/test/mocks/actionContext.ts b/src/test/mocks/actionContext.ts index 571ecd93..81d7d356 100644 --- a/src/test/mocks/actionContext.ts +++ b/src/test/mocks/actionContext.ts @@ -2,6 +2,7 @@ import { Mock } from "typemoq"; import { ActionContext } from "../../actions/types"; import Dialog from "../../api/dialog"; +import { ExerciseDecorationProvider } from "../../api/exerciseDecorationProvider"; import TMC from "../../api/tmc"; import WorkspaceManager from "../../api/workspaceManager"; import Resouces from "../../config/resources"; @@ -14,6 +15,7 @@ import UI from "../../ui/ui"; export function createMockActionContext(): ActionContext { return { dialog: Mock.ofType().object, + exerciseDecorationProvider: Mock.ofType().object, resources: Mock.ofType().object, settings: Mock.ofType().object, temporaryWebviewProvider: Mock.ofType().object, From 516ab76f0254b5a87e11c326ffd25bb35fed80ff Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Tue, 16 Mar 2021 16:52:44 +0200 Subject: [PATCH 06/79] Redecorate when data may be changed --- src/actions/user.ts | 21 ++++++++++++++++++--- src/config/userdata.ts | 13 +++++++++++++ src/extension.ts | 8 ++++---- 3 files changed, 35 insertions(+), 7 deletions(-) diff --git a/src/actions/user.ts b/src/actions/user.ts index c3d10eb0..717cb738 100644 --- a/src/actions/user.ts +++ b/src/actions/user.ts @@ -10,7 +10,7 @@ import * as _ from "lodash"; import { Err, Ok, Result } from "ts-results"; import * as vscode from "vscode"; -import { LocalCourseData } from "../api/storage"; +import { LocalCourseData, LocalCourseExercise } from "../api/storage"; import { SubmissionFeedback } from "../api/types"; import { WorkspaceExercise } from "../api/workspaceManager"; import { EXAM_TEST_RESULT, NOTIFICATION_DELAY } from "../config/constants"; @@ -190,7 +190,13 @@ export async function submitExercise( actionContext: ActionContext, exercise: WorkspaceExercise, ): Promise> { - const { dialog, temporaryWebviewProvider, tmc, userData } = actionContext; + const { + dialog, + exerciseDecorationProvider, + temporaryWebviewProvider, + tmc, + userData, + } = actionContext; Logger.log(`Submitting exercise ${exercise.exerciseSlug} to server`); const course = userData.getCourseByName(exercise.courseSlug); @@ -294,6 +300,9 @@ export async function submitExercise( let feedbackQuestions: FeedbackQuestion[] = []; if (statusData.status === "ok" && statusData.all_tests_passed) { + userData.setExerciseAsPassed(exercise.courseSlug, exercise.exerciseSlug).then(() => { + exerciseDecorationProvider.updateDecorationsForExercises(exercise); + }); if (statusData.feedback_questions) { feedbackQuestions = parseFeedbackQuestion(statusData.feedback_questions); } @@ -589,7 +598,7 @@ export async function updateCourse( actionContext: ActionContext, courseId: number, ): Promise> { - const { tmc, ui, userData } = actionContext; + const { exerciseDecorationProvider, tmc, ui, userData, workspaceManager } = actionContext; const postMessage = (courseId: number, disabled: boolean, exerciseIds: number[]): void => { ui.webview.postMessage( { @@ -660,6 +669,12 @@ export async function updateCourse( return updateExercisesResult; } + if (courseData.name === workspaceManager.activeCourse) { + exerciseDecorationProvider.updateDecorationsForExercises( + ...workspaceManager.getExercisesByCourseSlug(courseData.name), + ); + } + const course = userData.getCourse(courseId); postMessage(course.id, course.disabled, course.newExercises); diff --git a/src/config/userdata.ts b/src/config/userdata.ts index 736fd193..830d93a8 100644 --- a/src/config/userdata.ts +++ b/src/config/userdata.ts @@ -50,6 +50,19 @@ export class UserData { } } + public async setExerciseAsPassed(courseSlug: string, exerciseName: string): Promise { + for (const course of this._courses.values()) { + if (course.name === courseSlug) { + const exercise = course.exercises.find((x) => x.name === exerciseName); + if (exercise) { + exercise.passed = true; + await this._updatePersistentData(); + break; + } + } + } + } + public addCourse(data: LocalCourseData): void { if (this._courses.has(data.id)) { throw new Error("Trying to add an already existing course"); diff --git a/src/extension.ts b/src/extension.ts index 35808d78..f1f21e4e 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -167,6 +167,10 @@ export async function activate(context: vscode.ExtensionContext): Promise init.registerUiActions(actionContext); init.registerCommands(context, actionContext); + context.subscriptions.push( + vscode.window.registerFileDecorationProvider(exerciseDecorationProvider), + ); + if (authenticated) { vscode.commands.executeCommand("tmc.updateExercises", "silent"); checkForCourseUpdates(actionContext); @@ -191,10 +195,6 @@ export async function activate(context: vscode.ExtensionContext): Promise ); }, EXERCISE_CHECK_INTERVAL); - context.subscriptions.push( - vscode.window.registerFileDecorationProvider(exerciseDecorationProvider), - ); - const versionDiff = semVerCompare(currentVersion, previousVersion || "", "minor"); if (versionDiff === undefined || versionDiff > 0) { await vscode.commands.executeCommand("tmc.showWelcome"); From 7d9670d50f0e00cc5f7c9a65f11acf20b4c466f5 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Fri, 26 Mar 2021 10:48:05 +0200 Subject: [PATCH 07/79] Hide problem decorations --- src/actions/user.ts | 2 +- src/api/exerciseDecorationProvider.ts | 7 +++++++ src/config/constants.ts | 3 ++- 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/src/actions/user.ts b/src/actions/user.ts index 717cb738..b61a61f1 100644 --- a/src/actions/user.ts +++ b/src/actions/user.ts @@ -10,7 +10,7 @@ import * as _ from "lodash"; import { Err, Ok, Result } from "ts-results"; import * as vscode from "vscode"; -import { LocalCourseData, LocalCourseExercise } from "../api/storage"; +import { LocalCourseData } from "../api/storage"; import { SubmissionFeedback } from "../api/types"; import { WorkspaceExercise } from "../api/workspaceManager"; import { EXAM_TEST_RESULT, NOTIFICATION_DELAY } from "../config/constants"; diff --git a/src/api/exerciseDecorationProvider.ts b/src/api/exerciseDecorationProvider.ts index aaf4aaa7..b8c3ede6 100644 --- a/src/api/exerciseDecorationProvider.ts +++ b/src/api/exerciseDecorationProvider.ts @@ -10,12 +10,19 @@ export class ExerciseDecorationProvider implements vscode.Disposable, vscode.FileDecorationProvider { public onDidChangeFileDecorations: vscode.Event; + // Use ⬤ instead? private static _passedExercise = new vscode.FileDecoration( "✓", "Exercise completed!", new vscode.ThemeColor("gitDecoration.addedResourceForeground"), ); + private static _partiallyCompletedExercise = new vscode.FileDecoration( + "○", + "Some points gained", + new vscode.ThemeColor("gitDecoration.modifiedResourceForeground"), + ); + private static _missingExercise = new vscode.FileDecoration( "ⓘ", "Exercise not found in course. This could be an old exercise that has been renamed or removed from course.", diff --git a/src/config/constants.ts b/src/config/constants.ts index 3b00bf94..43e29232 100644 --- a/src/config/constants.ts +++ b/src/config/constants.ts @@ -54,10 +54,11 @@ export const WORKSPACE_SETTINGS = { folders: [{ path: ".tmc" }], settings: { "explorer.decorations.colors": false, - "workbench.editor.closeOnFileDelete": true, "files.autoSave": "onFocusChange", "files.exclude": { ...HIDE_META_FILES }, "files.watcherExclude": { ...WATCHER_EXCLUDE }, + "problems.decorations.enabled": false, + "workbench.editor.closeOnFileDelete": true, }, }; From 70a8207119d43ac6a070c49c1c1a35a2c5a90382 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Fri, 26 Mar 2021 11:20:16 +0200 Subject: [PATCH 08/79] Bump vscode-extension-tester from 4.0.1 to 4.0.2 --- package-lock.json | 20 ++++++++++---------- package.json | 2 +- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/package-lock.json b/package-lock.json index e996b116..bd69b83f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -3702,9 +3702,9 @@ } }, "domutils": { - "version": "2.4.4", - "resolved": "https://registry.npmjs.org/domutils/-/domutils-2.4.4.tgz", - "integrity": "sha512-jBC0vOsECI4OMdD0GC9mGn7NXPLb+Qt6KW1YDQzeQYRUFKmNG8lh7mO5HiELfr+lLQE7loDVI4QcAxV80HS+RA==", + "version": "2.5.0", + "resolved": "https://registry.npmjs.org/domutils/-/domutils-2.5.0.tgz", + "integrity": "sha512-Ho16rzNMOFk2fPwChGh3D2D9OEHAfG19HgmRR2l+WLSsIstNsAYBzePH412bL0y5T44ejABIVfTHQ8nqi/tBCg==", "dev": true, "requires": { "dom-serializer": "^1.0.1", @@ -8567,9 +8567,9 @@ } }, "vsce": { - "version": "1.85.1", - "resolved": "https://registry.npmjs.org/vsce/-/vsce-1.85.1.tgz", - "integrity": "sha512-IdfH8OCK+FgQGmihFoh6/17KBl4Ad3q4Sw3NFNI9T9KX6KdMR5az2/GO512cC9IqCjbgJl12CA7X84vYoc0ifg==", + "version": "1.87.0", + "resolved": "https://registry.npmjs.org/vsce/-/vsce-1.87.0.tgz", + "integrity": "sha512-7Ow05XxIM4gHBq/Ho3hefdmiZG0fddHtu0M0XJ1sojyZBvxPxTHaMuBsRnfnMzgCqxDTFI5iLr94AgiwQnhOMQ==", "dev": true, "requires": { "azure-devops-node-api": "^7.2.0", @@ -8612,9 +8612,9 @@ } }, "vscode-extension-tester": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/vscode-extension-tester/-/vscode-extension-tester-4.0.1.tgz", - "integrity": "sha512-FdiutfsBmDWF9vQQkICyYzngU++JDBKDr/sgSX1l+GY66vtXZuE2gs7EfNJ1h7zaAn7x3gBbYvMZPKcTfQyGHw==", + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/vscode-extension-tester/-/vscode-extension-tester-4.0.2.tgz", + "integrity": "sha512-g24GbeyRgx6SEtodtP1U3RShjX7y+A9i13OuSou3yyq/mVB6HyBGlEV7dLdctdSg45u7PfbLXpVZPy3C5jKQ9g==", "dev": true, "requires": { "@types/selenium-webdriver": "^3.0.15", @@ -8630,7 +8630,7 @@ "targz": "^1.0.1", "unzip-stream": "^0.3.0", "vsce": "^1.81.0", - "vscode-extension-tester-locators": "^1.53.2" + "vscode-extension-tester-locators": "^1.54.0" }, "dependencies": { "commander": { diff --git a/package.json b/package.json index b85a4305..0be8c8f9 100644 --- a/package.json +++ b/package.json @@ -439,7 +439,7 @@ "ttypescript": "^1.5.12", "typemoq": "^2.1.0", "typescript": "^4.2.3", - "vscode-extension-tester": "^4.0.1", + "vscode-extension-tester": "^4.0.2", "vscode-test": "^1.5.1", "webpack": "^5.24.4", "webpack-cli": "^4.5.0", From 7ee3b3a0dc367f3e4ea82a796b027862c80f7365 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Fri, 26 Mar 2021 11:23:40 +0200 Subject: [PATCH 09/79] Debump husky from verson 5.1.3 to 4.3.8 --- package-lock.json | 98 +++++++++++++++++++++++++++++++++++++++++++++-- package.json | 2 +- 2 files changed, 95 insertions(+), 5 deletions(-) diff --git a/package-lock.json b/package-lock.json index bd69b83f..fbc2c478 100644 --- a/package-lock.json +++ b/package-lock.json @@ -3044,6 +3044,12 @@ "tslib": "^1.9.0" } }, + "ci-info": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-2.0.0.tgz", + "integrity": "sha512-5tK7EtrZ0N+OLFMthtqOj4fI2Jeb88C4CAZPu25LDVUgXJ0A3Js4PMGqrn0JU1W0Mh1/Z8wZzYPxqUrXeBboCQ==", + "dev": true + }, "circular-json": { "version": "0.3.3", "resolved": "https://registry.npmjs.org/circular-json/-/circular-json-0.3.3.tgz", @@ -4568,6 +4574,15 @@ } } }, + "find-versions": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/find-versions/-/find-versions-4.0.0.tgz", + "integrity": "sha512-wgpWy002tA+wgmO27buH/9KzyEOQnKsG/R0yrcjPT9BOFm0zRBVQbZ95nRGXWMywS8YR5knRbpohio0bcJABxQ==", + "dev": true, + "requires": { + "semver-regex": "^3.1.2" + } + }, "flat": { "version": "5.0.2", "resolved": "https://registry.npmjs.org/flat/-/flat-5.0.2.tgz", @@ -4969,10 +4984,67 @@ "dev": true }, "husky": { - "version": "5.1.3", - "resolved": "https://registry.npmjs.org/husky/-/husky-5.1.3.tgz", - "integrity": "sha512-fbNJ+Gz5wx2LIBtMweJNY1D7Uc8p1XERi5KNRMccwfQA+rXlxWNSdUxswo0gT8XqxywTIw7Ywm/F4v/O35RdMg==", - "dev": true + "version": "4.3.8", + "resolved": "https://registry.npmjs.org/husky/-/husky-4.3.8.tgz", + "integrity": "sha512-LCqqsB0PzJQ/AlCgfrfzRe3e3+NvmefAdKQhRYpxS4u6clblBoDdzzvHi8fmxKRzvMxPY/1WZWzomPZww0Anow==", + "dev": true, + "requires": { + "chalk": "^4.0.0", + "ci-info": "^2.0.0", + "compare-versions": "^3.6.0", + "cosmiconfig": "^7.0.0", + "find-versions": "^4.0.0", + "opencollective-postinstall": "^2.0.2", + "pkg-dir": "^5.0.0", + "please-upgrade-node": "^3.2.0", + "slash": "^3.0.0", + "which-pm-runs": "^1.0.0" + }, + "dependencies": { + "ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "requires": { + "color-convert": "^2.0.1" + } + }, + "chalk": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.0.tgz", + "integrity": "sha512-qwx12AxXe2Q5xQ43Ac//I6v5aXTipYrSESdOgzrN+9XjgEpyjpKuvSGaN4qE93f7TQTlerQQ8S+EQ0EyDoVL1A==", + "dev": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "pkg-dir": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/pkg-dir/-/pkg-dir-5.0.0.tgz", + "integrity": "sha512-NPE8TDbzl/3YQYY7CSS228s3g2ollTFnc+Qi3tqmqJp9Vg2ovUpixcJEo2HJScN2Ez+kEaal6y70c0ehqJBJeA==", + "dev": true, + "requires": { + "find-up": "^5.0.0" + } + } + } }, "ignore": { "version": "5.1.8", @@ -6355,6 +6427,12 @@ "mimic-fn": "^2.1.0" } }, + "opencollective-postinstall": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/opencollective-postinstall/-/opencollective-postinstall-2.0.3.tgz", + "integrity": "sha512-8AV/sCtuzUeTo8gQK5qDZzARrulB3egtLzFgteqB2tcT4Mw7B8Kt7JcDHmltjz6FOAHsvTevk70gZEbhM4ZS9Q==", + "dev": true + }, "optionator": { "version": "0.9.1", "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.1.tgz", @@ -7345,6 +7423,12 @@ "integrity": "sha1-De4hahyUGrN+nvsXiPavxf9VN/w=", "dev": true }, + "semver-regex": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/semver-regex/-/semver-regex-3.1.2.tgz", + "integrity": "sha512-bXWyL6EAKOJa81XG1OZ/Yyuq+oT0b2YLlxx7c+mrdYPaPbnj6WgVULXhinMIeZGufuUBu/eVRqXEhiv4imfwxA==", + "dev": true + }, "serialize-javascript": { "version": "5.0.1", "resolved": "https://registry.npmjs.org/serialize-javascript/-/serialize-javascript-5.0.1.tgz", @@ -8851,6 +8935,12 @@ "isexe": "^2.0.0" } }, + "which-pm-runs": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/which-pm-runs/-/which-pm-runs-1.0.0.tgz", + "integrity": "sha1-Zws6+8VS4LVd9rd4DKdGFfI60cs=", + "dev": true + }, "wide-align": { "version": "1.1.3", "resolved": "https://registry.npmjs.org/wide-align/-/wide-align-1.1.3.tgz", diff --git a/package.json b/package.json index 0be8c8f9..59a7823c 100644 --- a/package.json +++ b/package.json @@ -427,7 +427,7 @@ "eslint-plugin-prettier": "^3.3.1", "eslint-plugin-sort-class-members": "^1.9.0", "glob": "^7.1.6", - "husky": "^5.1.3", + "husky": "^4.3.8", "lint-staged": "^10.5.4", "mocha": "^8.3.1", "mock-fs": "^4.13.0", From 7e6f2f7badcc8a9ba8517c185e57a2807a26724c Mon Sep 17 00:00:00 2001 From: Sebastian Sergelius Date: Mon, 29 Mar 2021 12:11:09 +0300 Subject: [PATCH 10/79] Force settings for TMC multi-root ws --- .vscode/settings.json | 1 + package-lock.json | 6 +++--- package.json | 2 +- src/config/constants.ts | 2 ++ src/config/settings.ts | 12 +++++++++++- src/extension.ts | 1 + 6 files changed, 19 insertions(+), 5 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 76586405..3193b026 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -10,6 +10,7 @@ "search.exclude": { "**/out": true }, + "files.eol": "\n", // Turn off tsc task auto detection since we have the necessary tasks as npm scripts "typescript.tsc.autoDetect": "off", "html.validate.scripts": false, diff --git a/package-lock.json b/package-lock.json index fbc2c478..e99e6b37 100644 --- a/package-lock.json +++ b/package-lock.json @@ -2003,9 +2003,9 @@ } }, "@types/node": { - "version": "14.14.32", - "resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.32.tgz", - "integrity": "sha512-/Ctrftx/zp4m8JOujM5ZhwzlWLx22nbQJiVqz8/zE15gOeEW+uly3FSX4fGFpcfEvFzXcMCJwq9lGVWgyARXhg==", + "version": "14.14.37", + "resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.37.tgz", + "integrity": "sha512-XYmBiy+ohOR4Lh5jE379fV2IU+6Jn4g5qASinhitfyO71b/sCo6MKsMLF5tc7Zf2CE8hViVQyYSobJNke8OvUw==", "dev": true }, "@types/node-fetch": { diff --git a/package.json b/package.json index 59a7823c..34ba6b33 100644 --- a/package.json +++ b/package.json @@ -411,7 +411,7 @@ "@types/lodash": "^4.14.168", "@types/mocha": "^8.2.1", "@types/mock-fs": "^4.13.0", - "@types/node": "^14.14.32", + "@types/node": "^14.14.37", "@types/node-fetch": "^2.5.8", "@types/unzipper": "^0.10.3", "@types/vscode": "1.52.0", diff --git a/src/config/constants.ts b/src/config/constants.ts index 43e29232..251f4c3b 100644 --- a/src/config/constants.ts +++ b/src/config/constants.ts @@ -31,6 +31,7 @@ export const HIDE_META_FILES = { "**/.tmcproject.json": true, "**/.tmc.json": true, "**/.tmc.lock": true, + "**/.tmc_test_results.hmac.sha256": true, }; export const SHOW_META_FILES = { @@ -43,6 +44,7 @@ export const SHOW_META_FILES = { "**/.tmcproject.json": false, "**/.tmc.json": false, "**/.tmc.lock": false, + "**/.tmc_test_results.hmac.sha256": false, }; export const WATCHER_EXCLUDE = { diff --git a/src/config/settings.ts b/src/config/settings.ts index 9a2f10fe..cca66cb7 100644 --- a/src/config/settings.ts +++ b/src/config/settings.ts @@ -61,6 +61,7 @@ export default class Settings { Logger.log("TMC Workspace open, verifying workspace settings integrity."); await this._setFilesExcludeInWorkspace(this._settings.hideMetaFiles); await this._verifyWatcherPatternExclusion(); + await this._forceTMCWorkspaceSettings(); } } @@ -180,9 +181,9 @@ export default class Settings { private async _updateWorkspaceSetting(section: string, value: unknown): Promise { const workspace = vscode.workspace.name?.split(" ")[0]; if (workspace && isCorrectWorkspaceOpen(this._resources, workspace)) { - const oldValue = this.getWorkspaceSettings(section); let newValue = value; if (value instanceof Object) { + const oldValue = this.getWorkspaceSettings(section); newValue = { ...oldValue, ...value }; } await vscode.workspace @@ -202,4 +203,13 @@ export default class Settings { private async _verifyWatcherPatternExclusion(): Promise { await this._updateWorkspaceSetting("files.watcherExclude", { ...WATCHER_EXCLUDE }); } + + /** + * Force some settings for TMC .code-workspace files. + */ + private async _forceTMCWorkspaceSettings(): Promise { + await this._updateWorkspaceSetting("explorer.decorations.colors", false); + await this._updateWorkspaceSetting("explorer.decorations.badges", true); + await this._updateWorkspaceSetting("problems.decorations.enabled", false); + } } diff --git a/src/extension.ts b/src/extension.ts index f1f21e4e..83292fea 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -111,6 +111,7 @@ export async function activate(context: vscode.ExtensionContext): Promise const resources = resourcesResult.val; const settings = new Settings(storage, resources); + // We still rely on VSCode Extenion Host restart when workspace switches await settings.verifyWorkspaceSettingsIntegrity(); Logger.configure(settings.getLogLevel()); From 034724d178e4f184ea78e398c8e16250116d14c9 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Tue, 6 Apr 2021 14:46:32 +0300 Subject: [PATCH 11/79] Convert env util to JavaScript --- src/utils/env.d.ts | 15 +++++++++++++++ src/utils/{env.ts => env.js} | 18 +++++------------- 2 files changed, 20 insertions(+), 13 deletions(-) create mode 100644 src/utils/env.d.ts rename src/utils/{env.ts => env.js} (83%) diff --git a/src/utils/env.d.ts b/src/utils/env.d.ts new file mode 100644 index 00000000..5bc58068 --- /dev/null +++ b/src/utils/env.d.ts @@ -0,0 +1,15 @@ +export type Platform = + | "linux32" + | "linux64" + | "linuxarm" + | "linuxarm64" + | "macos32" + | "macos64" + | "macosarm64" + | "windows32" + | "windows64" + | "other"; + +export function getPlatform(): Platform; + +export function getLangsCLIForPlatform(platform: Platform, version: string): string; diff --git a/src/utils/env.ts b/src/utils/env.js similarity index 83% rename from src/utils/env.ts rename to src/utils/env.js index cd688907..6dd2c7a2 100644 --- a/src/utils/env.ts +++ b/src/utils/env.js @@ -1,16 +1,7 @@ -export type Platform = - | "linux32" - | "linux64" - | "linuxarm64" - | "linuxarm" - | "windows32" - | "windows64" - | "macosarm64" - | "macos64" - | "macos32" - | "other"; +//@ts-check -export function getPlatform(): Platform { +/**@type {import("./env").getPlatform} */ +export function getPlatform() { const platform = process.platform; const arch = process.arch; if (platform === "linux") { @@ -34,7 +25,8 @@ export function getPlatform(): Platform { return "other"; } -export function getLangsCLIForPlatform(platform: Platform, version: string): string { +/**@type {import("./env").getLangsCLIForPlatform} */ +export function getLangsCLIForPlatform(platform, version) { switch (platform) { case "linux32": return `tmc-langs-cli-i686-unknown-linux-gnu-${version}`; From 294b489d7b5bd6dea5c04b03675aafaca3eced6b Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Tue, 6 Apr 2021 15:15:40 +0300 Subject: [PATCH 12/79] Convert env module to CommonJS --- src/utils/env.js | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/utils/env.js b/src/utils/env.js index 6dd2c7a2..915d11f1 100644 --- a/src/utils/env.js +++ b/src/utils/env.js @@ -1,7 +1,7 @@ //@ts-check /**@type {import("./env").getPlatform} */ -export function getPlatform() { +function getPlatform() { const platform = process.platform; const arch = process.arch; if (platform === "linux") { @@ -26,7 +26,7 @@ export function getPlatform() { } /**@type {import("./env").getLangsCLIForPlatform} */ -export function getLangsCLIForPlatform(platform, version) { +function getLangsCLIForPlatform(platform, version) { switch (platform) { case "linux32": return `tmc-langs-cli-i686-unknown-linux-gnu-${version}`; @@ -50,3 +50,5 @@ export function getLangsCLIForPlatform(platform, version) { return `tmc-langs-cli-x86_64-unknown-linux-gnu-${version}`; } } + +module.exports = { getLangsCLIForPlatform, getPlatform }; From 560c5db37a1fbf0f06d8ca51cb69598beb398c78 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Tue, 6 Apr 2021 15:35:47 +0300 Subject: [PATCH 13/79] Add script to check that all langs builds exist --- bin/verifyThatLangsBuildsExist.js | 34 +++++++++++++++++++++++++++++++ src/utils/env.d.ts | 4 +++- src/utils/env.js | 24 +++++++++++++++++++++- 3 files changed, 60 insertions(+), 2 deletions(-) create mode 100644 bin/verifyThatLangsBuildsExist.js diff --git a/bin/verifyThatLangsBuildsExist.js b/bin/verifyThatLangsBuildsExist.js new file mode 100644 index 00000000..c844d44d --- /dev/null +++ b/bin/verifyThatLangsBuildsExist.js @@ -0,0 +1,34 @@ +const fetch = require("node-fetch"); + +const config = require("../config"); +const getAllLangsCLIs = require("../src/utils/env").getAllLangsCLIs; + +const TMC_LANGS_DL_URL = config.productionApi.__TMC_LANGS_DL_URL__.replace(/"/g, ""); +const TMC_LANGS_VERSION = config.productionApi.__TMC_LANGS_VERSION__.replace(/"/g, ""); + +const langsBuildExists = (url) => + fetch.default(url, { method: "head" }).then((res) => res.status === 200); + +async function main() { + console.log("Verifying that all target TMC-langs builds exist..."); + let missingBuilds = false; + try { + const allCLIs = getAllLangsCLIs(TMC_LANGS_VERSION); + for (const cli of allCLIs) { + const url = TMC_LANGS_DL_URL + cli; + if (!(await langsBuildExists(url))) { + missingBuilds = true; + console.log("Failed to find", cli, "from", url); + } + } + if (missingBuilds) { + throw new Error("Some Langs builds were missing."); + } + } catch (e) { + console.error("Verification resulted in error:", e.message); + process.exit(1); + } + console.log("Looks good!"); +} + +main(); diff --git a/src/utils/env.d.ts b/src/utils/env.d.ts index 5bc58068..adb100f6 100644 --- a/src/utils/env.d.ts +++ b/src/utils/env.d.ts @@ -10,6 +10,8 @@ export type Platform = | "windows64" | "other"; -export function getPlatform(): Platform; +export function getAllLangsCLIs(version: string): string[]; export function getLangsCLIForPlatform(platform: Platform, version: string): string; + +export function getPlatform(): Platform; diff --git a/src/utils/env.js b/src/utils/env.js index 915d11f1..ac153627 100644 --- a/src/utils/env.js +++ b/src/utils/env.js @@ -1,5 +1,27 @@ //@ts-check +const uniq = require("lodash").uniq; + +/**@type {import("./env").Platform[]} */ +const allPlatforms = [ + "linux32", + "linux64", + "linuxarm", + "linuxarm64", + "macos32", + "macos64", + "macosarm64", + "windows32", + "windows64", + "other", +]; + +/**@type {import("./env").getAllLangsCLIs} */ +function getAllLangsCLIs(version) { + const allCLIs = allPlatforms.map((x) => getLangsCLIForPlatform(x, version)); + return uniq(allCLIs); +} + /**@type {import("./env").getPlatform} */ function getPlatform() { const platform = process.platform; @@ -51,4 +73,4 @@ function getLangsCLIForPlatform(platform, version) { } } -module.exports = { getLangsCLIForPlatform, getPlatform }; +module.exports = { getAllLangsCLIs, getLangsCLIForPlatform, getPlatform }; From 6840f396da80947e63d7768ad68e0bf86b1f6422 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Tue, 6 Apr 2021 15:54:36 +0300 Subject: [PATCH 14/79] Add langs build check to release validation --- bin/validateRelease.sh | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/bin/validateRelease.sh b/bin/validateRelease.sh index 40ec9529..272c5e7f 100755 --- a/bin/validateRelease.sh +++ b/bin/validateRelease.sh @@ -22,7 +22,7 @@ fi packageLockVersion=`grep -Eo '"version":.+$' package-lock.json` if [[ ! $packageLockVersion =~ '"version": "'$tagVersion'",' ]] then - echo "Error: The version in package-lock.json doesn't match with the tag. Did you forget to run npm install?" + echo "Error: The version in package-lock.json doesn't match with the tag." exitCode=1 fi @@ -35,4 +35,12 @@ then exitCode=1 fi +# All configured Langs versions should exist on the download server. +node ./bin/verifyThatLangsBuildsExist.js +if [ $? != 0 ] +then + echo "Error: Failed to verify that all Langs builds exist." + exitCode=1 +fi + exit $exitCode From 7fb4760b60884139cbc09fd3763f54fe3389d340 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Fri, 16 Apr 2021 10:26:20 +0300 Subject: [PATCH 15/79] Change decorator import signature --- src/actions/types.ts | 2 +- src/api/exerciseDecorationProvider.ts | 2 +- src/extension.ts | 2 +- src/test/api/exerciseDecorationProvider.test.ts | 2 +- src/test/mocks/actionContext.ts | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/actions/types.ts b/src/actions/types.ts index 64323442..772d85ef 100644 --- a/src/actions/types.ts +++ b/src/actions/types.ts @@ -1,5 +1,5 @@ import Dialog from "../api/dialog"; -import { ExerciseDecorationProvider } from "../api/exerciseDecorationProvider"; +import ExerciseDecorationProvider from "../api/exerciseDecorationProvider"; import TMC from "../api/tmc"; import WorkspaceManager from "../api/workspaceManager"; import Resources from "../config/resources"; diff --git a/src/api/exerciseDecorationProvider.ts b/src/api/exerciseDecorationProvider.ts index b8c3ede6..952906bd 100644 --- a/src/api/exerciseDecorationProvider.ts +++ b/src/api/exerciseDecorationProvider.ts @@ -6,7 +6,7 @@ import { UserData } from "../config/userdata"; /** * Class that adds decorations like completion icons for exercises. */ -export class ExerciseDecorationProvider +export default class ExerciseDecorationProvider implements vscode.Disposable, vscode.FileDecorationProvider { public onDidChangeFileDecorations: vscode.Event; diff --git a/src/extension.ts b/src/extension.ts index 8342ff5f..28738f5d 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -5,7 +5,7 @@ import * as vscode from "vscode"; import { checkForCourseUpdates, refreshLocalExercises } from "./actions"; import { ActionContext } from "./actions/types"; import Dialog from "./api/dialog"; -import { ExerciseDecorationProvider } from "./api/exerciseDecorationProvider"; +import ExerciseDecorationProvider from "./api/exerciseDecorationProvider"; import Storage from "./api/storage"; import TMC from "./api/tmc"; import WorkspaceManager from "./api/workspaceManager"; diff --git a/src/test/api/exerciseDecorationProvider.test.ts b/src/test/api/exerciseDecorationProvider.test.ts index 4bf5730c..69447e1a 100644 --- a/src/test/api/exerciseDecorationProvider.test.ts +++ b/src/test/api/exerciseDecorationProvider.test.ts @@ -2,7 +2,7 @@ import { expect } from "chai"; import { IMock, It, Times } from "typemoq"; import * as vscode from "vscode"; -import { ExerciseDecorationProvider } from "../../api/exerciseDecorationProvider"; +import ExerciseDecorationProvider from "../../api/exerciseDecorationProvider"; import WorkspaceManager from "../../api/workspaceManager"; import { UserData } from "../../config/userdata"; import { userDataExerciseHelloWorld } from "../fixtures/userData"; diff --git a/src/test/mocks/actionContext.ts b/src/test/mocks/actionContext.ts index 81d7d356..328920df 100644 --- a/src/test/mocks/actionContext.ts +++ b/src/test/mocks/actionContext.ts @@ -2,7 +2,7 @@ import { Mock } from "typemoq"; import { ActionContext } from "../../actions/types"; import Dialog from "../../api/dialog"; -import { ExerciseDecorationProvider } from "../../api/exerciseDecorationProvider"; +import ExerciseDecorationProvider from "../../api/exerciseDecorationProvider"; import TMC from "../../api/tmc"; import WorkspaceManager from "../../api/workspaceManager"; import Resouces from "../../config/resources"; From 728acb1c422a213e49dc217407e7435d7a75155e Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Fri, 16 Apr 2021 10:44:12 +0300 Subject: [PATCH 16/79] Move addNewCourse action to own file --- src/actions/addNewCourse.ts | 73 ++++++++++++++++++++++++++++++++++++ src/actions/index.ts | 1 + src/actions/user.ts | 72 ----------------------------------- src/commands/addNewCourse.ts | 5 +-- 4 files changed, 75 insertions(+), 76 deletions(-) create mode 100644 src/actions/addNewCourse.ts diff --git a/src/actions/addNewCourse.ts b/src/actions/addNewCourse.ts new file mode 100644 index 00000000..6a2955cf --- /dev/null +++ b/src/actions/addNewCourse.ts @@ -0,0 +1,73 @@ +import { Result } from "ts-results"; + +import { LocalCourseData } from "../api/storage"; +import { Logger } from "../utils"; + +import { refreshLocalExercises } from "./refreshLocalExercises"; +import { ActionContext } from "./types"; +import { displayUserCourses, selectOrganizationAndCourse } from "./webview"; + +/** + * Adds a new course to user's courses. + */ +export async function addNewCourse( + actionContext: ActionContext, + organization?: string, + course?: number, +): Promise> { + const { tmc, ui, userData, workspaceManager } = actionContext; + Logger.log("Adding new course"); + + if (!organization || !course) { + const orgAndCourse = await selectOrganizationAndCourse(actionContext); + if (orgAndCourse.err) { + return orgAndCourse; + } + organization = orgAndCourse.val.organization; + course = orgAndCourse.val.course; + } + + const courseDataResult = await tmc.getCourseData(course); + if (courseDataResult.err) { + return courseDataResult; + } + const courseData = courseDataResult.val; + + let availablePoints = 0; + let awardedPoints = 0; + courseData.exercises.forEach((x) => { + availablePoints += x.available_points.length; + awardedPoints += x.awarded_points.length; + }); + + const localData: LocalCourseData = { + description: courseData.details.description || "", + exercises: courseData.details.exercises.map((e) => ({ + id: e.id, + name: e.name, + deadline: e.deadline, + passed: e.completed, + softDeadline: e.soft_deadline, + })), + id: courseData.details.id, + name: courseData.details.name, + title: courseData.details.title, + organization: organization, + availablePoints: availablePoints, + awardedPoints: awardedPoints, + perhapsExamMode: courseData.settings.hide_submission_results, + newExercises: [], + notifyAfter: 0, + disabled: courseData.settings.disabled_status === "enabled" ? false : true, + materialUrl: courseData.settings.material_url, + }; + userData.addCourse(localData); + ui.treeDP.addChildWithId("myCourses", localData.id, localData.title, { + command: "tmc.courseDetails", + title: "Go To Course Details", + arguments: [localData.id], + }); + workspaceManager.createWorkspaceFile(courseData.details.name); + await displayUserCourses(actionContext); + return refreshLocalExercises(actionContext); +} diff --git a/src/actions/index.ts b/src/actions/index.ts index e44e8b79..ed68dd06 100644 --- a/src/actions/index.ts +++ b/src/actions/index.ts @@ -1,3 +1,4 @@ +export * from "./addNewCourse"; export * from "./checkForExerciseUpdates"; export * from "./downloadNewExercisesForCourse"; export * from "./downloadOrUpdateCourseExercises"; diff --git a/src/actions/user.ts b/src/actions/user.ts index b61a61f1..0e1eae5d 100644 --- a/src/actions/user.ts +++ b/src/actions/user.ts @@ -25,9 +25,7 @@ import { import { getActiveEditorExecutablePath } from "../window"; import { downloadNewExercisesForCourse } from "./downloadNewExercisesForCourse"; -import { refreshLocalExercises } from "./refreshLocalExercises"; import { ActionContext, FeedbackQuestion } from "./types"; -import { displayUserCourses, selectOrganizationAndCourse } from "./webview"; /** * Authenticates and logs the user in if credentials are correct. @@ -492,76 +490,6 @@ export async function openSettings(actionContext: ActionContext): Promise ]); } -interface NewCourseOptions { - organization?: string; - course?: number; -} -/** - * Adds a new course to user's courses. - */ -export async function addNewCourse( - actionContext: ActionContext, - options?: NewCourseOptions, -): Promise> { - const { tmc, ui, userData, workspaceManager } = actionContext; - Logger.log("Adding new course"); - let organization = options?.organization; - let course = options?.course; - - if (!organization || !course) { - const orgAndCourse = await selectOrganizationAndCourse(actionContext); - if (orgAndCourse.err) { - return orgAndCourse; - } - organization = orgAndCourse.val.organization; - course = orgAndCourse.val.course; - } - - const courseDataResult = await tmc.getCourseData(course); - if (courseDataResult.err) { - return courseDataResult; - } - const courseData = courseDataResult.val; - - let availablePoints = 0; - let awardedPoints = 0; - courseData.exercises.forEach((x) => { - availablePoints += x.available_points.length; - awardedPoints += x.awarded_points.length; - }); - - const localData: LocalCourseData = { - description: courseData.details.description || "", - exercises: courseData.details.exercises.map((e) => ({ - id: e.id, - name: e.name, - deadline: e.deadline, - passed: e.completed, - softDeadline: e.soft_deadline, - })), - id: courseData.details.id, - name: courseData.details.name, - title: courseData.details.title, - organization: organization, - availablePoints: availablePoints, - awardedPoints: awardedPoints, - perhapsExamMode: courseData.settings.hide_submission_results, - newExercises: [], - notifyAfter: 0, - disabled: courseData.settings.disabled_status === "enabled" ? false : true, - materialUrl: courseData.settings.material_url, - }; - userData.addCourse(localData); - ui.treeDP.addChildWithId("myCourses", localData.id, localData.title, { - command: "tmc.courseDetails", - title: "Go To Course Details", - arguments: [localData.id], - }); - workspaceManager.createWorkspaceFile(courseData.details.name); - await displayUserCourses(actionContext); - return refreshLocalExercises(actionContext); -} - /** * Removes given course from UserData and removes its associated files. However, doesn't remove any * exercises that are on disk. diff --git a/src/commands/addNewCourse.ts b/src/commands/addNewCourse.ts index 4f440f4a..2d7d398e 100644 --- a/src/commands/addNewCourse.ts +++ b/src/commands/addNewCourse.ts @@ -30,10 +30,7 @@ export async function addNewCourse(actionContext: ActionContext): Promise return; } - const result = await actions.addNewCourse(actionContext, { - organization: chosenOrg, - course: chosenCourse, - }); + const result = await actions.addNewCourse(actionContext, chosenOrg, chosenCourse); if (result.err) { dialog.errorNotification("Failed to add course.", result.val); } From 7b7348b530e3b81edf818f40f0654751b318fa81 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Fri, 16 Apr 2021 11:14:38 +0300 Subject: [PATCH 17/79] Move selectOrganizationAndCourse action to own file --- src/actions/addNewCourse.ts | 3 +- src/actions/index.ts | 1 + src/actions/selectOrganizationAndCourse.ts | 120 ++++++++++++++++++++ src/actions/webview.ts | 123 --------------------- 4 files changed, 123 insertions(+), 124 deletions(-) create mode 100644 src/actions/selectOrganizationAndCourse.ts diff --git a/src/actions/addNewCourse.ts b/src/actions/addNewCourse.ts index 6a2955cf..17fde996 100644 --- a/src/actions/addNewCourse.ts +++ b/src/actions/addNewCourse.ts @@ -4,8 +4,9 @@ import { LocalCourseData } from "../api/storage"; import { Logger } from "../utils"; import { refreshLocalExercises } from "./refreshLocalExercises"; +import { selectOrganizationAndCourse } from "./selectOrganizationAndCourse"; import { ActionContext } from "./types"; -import { displayUserCourses, selectOrganizationAndCourse } from "./webview"; +import { displayUserCourses } from "./webview"; /** * Adds a new course to user's courses. diff --git a/src/actions/index.ts b/src/actions/index.ts index ed68dd06..0e089610 100644 --- a/src/actions/index.ts +++ b/src/actions/index.ts @@ -4,6 +4,7 @@ export * from "./downloadNewExercisesForCourse"; export * from "./downloadOrUpdateCourseExercises"; export * from "./moveExtensionDataPath"; export * from "./refreshLocalExercises"; +export * from "./selectOrganizationAndCourse"; export * from "./user"; export * from "./webview"; export * from "./workspace"; diff --git a/src/actions/selectOrganizationAndCourse.ts b/src/actions/selectOrganizationAndCourse.ts new file mode 100644 index 00000000..868f0bea --- /dev/null +++ b/src/actions/selectOrganizationAndCourse.ts @@ -0,0 +1,120 @@ +import { Err, Ok, Result } from "ts-results"; + +import TemporaryWebview from "../ui/temporaryWebview"; +import { Logger } from "../utils"; + +import { ActionContext } from "./types"; + +/** + * Creates a new temporary webview where user can select an organization and a course. + */ +export async function selectOrganizationAndCourse( + actionContext: ActionContext, +): Promise> { + const { resources, ui } = actionContext; + + const tempView = new TemporaryWebview(resources, ui); + + let organizationSlug: string | undefined; + let courseId: number | undefined; + + while (!(organizationSlug && courseId)) { + const orgResult = await selectOrganization(actionContext, tempView); + if (orgResult.err) { + tempView.dispose(); + return orgResult; + } + Logger.log(`Organization slug ${orgResult.val} selected`); + organizationSlug = orgResult.val; + const courseResult = await selectCourse(actionContext, organizationSlug, tempView); + if (courseResult.err) { + tempView.dispose(); + return courseResult; + } + if (courseResult.val.changeOrg) { + continue; + } + courseId = courseResult.val.course; + } + Logger.log(`Course with id ${courseId} selected`); + tempView.dispose(); + return new Ok({ organization: organizationSlug, course: courseId }); +} + +async function selectOrganization( + actionContext: ActionContext, + webview?: TemporaryWebview, +): Promise> { + const { tmc, resources, ui } = actionContext; + + const result = await tmc.getOrganizations(); + if (result.err) { + return result; + } + const organizations = result.val.sort((org1, org2) => org1.name.localeCompare(org2.name)); + const pinned = organizations.filter((organization) => organization.pinned); + const data = { organizations, pinned }; + let slug: string | undefined; + + await new Promise((resolve) => { + const temp = webview || new TemporaryWebview(resources, ui); + temp.setContent({ + title: "Select organization", + template: { templateName: "organization", ...data }, + messageHandler: (msg: { type?: string; slug?: string }) => { + if (msg.type !== "setOrganization") { + return; + } + slug = msg.slug; + if (!webview) { + temp.dispose(); + } + resolve(); + }, + }); + }); + if (!slug) { + return new Err(new Error("Couldn't get organization")); + } + return new Ok(slug); +} + +async function selectCourse( + actionContext: ActionContext, + orgSlug: string, + webview?: TemporaryWebview, +): Promise> { + const { tmc, resources, ui } = actionContext; + const result = await tmc.getCourses(orgSlug); + + if (result.err) { + return result; + } + const courses = result.val.sort((course1, course2) => course1.name.localeCompare(course2.name)); + const organization = (await tmc.getOrganization(orgSlug)).unwrap(); + const data = { courses, organization }; + let changeOrg = false; + let course: number | undefined; + + await new Promise((resolve) => { + const temp = webview || new TemporaryWebview(resources, ui); + temp.setContent({ + title: "Select course", + template: { templateName: "course", ...data }, + messageHandler: (msg: { type?: string; id?: number }) => { + if (msg.type === "setCourse") { + course = msg.id; + } else if (msg.type === "changeOrg") { + changeOrg = true; + } else { + return; + } + if (!webview) { + temp.dispose(); + } + resolve(); + }, + }); + }); + return new Ok({ changeOrg, course }); +} diff --git a/src/actions/webview.ts b/src/actions/webview.ts index d4ab1e87..3d765e35 100644 --- a/src/actions/webview.ts +++ b/src/actions/webview.ts @@ -4,11 +4,8 @@ * ------------------------------------------------------------------------------------------------- */ -import { Err, Ok, Result } from "ts-results"; - import { Exercise } from "../api/types"; import { ExerciseStatus } from "../api/workspaceManager"; -import TemporaryWebview from "../ui/temporaryWebview"; import * as UITypes from "../ui/types"; import { WebviewMessage } from "../ui/types"; import { dateToString, Logger, parseDate, parseNextDeadlineAfter } from "../utils/"; @@ -180,123 +177,3 @@ export async function displayLocalCourseDetails( Logger.warn("Failed to check for exercise updates"); } } - -/** - * Lets the user select a course - */ -export async function selectCourse( - actionContext: ActionContext, - orgSlug: string, - webview?: TemporaryWebview, -): Promise> { - const { tmc, resources, ui } = actionContext; - const result = await tmc.getCourses(orgSlug); - - if (result.err) { - return result; - } - const courses = result.val.sort((course1, course2) => course1.name.localeCompare(course2.name)); - const organization = (await tmc.getOrganization(orgSlug)).unwrap(); - const data = { courses, organization }; - let changeOrg = false; - let course: number | undefined; - - await new Promise((resolve) => { - const temp = webview || new TemporaryWebview(resources, ui); - temp.setContent({ - title: "Select course", - template: { templateName: "course", ...data }, - messageHandler: (msg: { type?: string; id?: number }) => { - if (msg.type === "setCourse") { - course = msg.id; - } else if (msg.type === "changeOrg") { - changeOrg = true; - } else { - return; - } - if (!webview) { - temp.dispose(); - } - resolve(); - }, - }); - }); - return new Ok({ changeOrg, course }); -} - -/** - * Lets the user select an organization - */ -export async function selectOrganization( - actionContext: ActionContext, - webview?: TemporaryWebview, -): Promise> { - const { tmc, resources, ui } = actionContext; - - const result = await tmc.getOrganizations(); - if (result.err) { - return result; - } - const organizations = result.val.sort((org1, org2) => org1.name.localeCompare(org2.name)); - const pinned = organizations.filter((organization) => organization.pinned); - const data = { organizations, pinned }; - let slug: string | undefined; - - await new Promise((resolve) => { - const temp = webview || new TemporaryWebview(resources, ui); - temp.setContent({ - title: "Select organization", - template: { templateName: "organization", ...data }, - messageHandler: (msg: { type?: string; slug?: string }) => { - if (msg.type !== "setOrganization") { - return; - } - slug = msg.slug; - if (!webview) { - temp.dispose(); - } - resolve(); - }, - }); - }); - if (!slug) { - return new Err(new Error("Couldn't get organization")); - } - return new Ok(slug); -} - -/** - * Creates a new temporary webview where user can select an organization and a course. - */ -export async function selectOrganizationAndCourse( - actionContext: ActionContext, -): Promise> { - const { resources, ui } = actionContext; - - const tempView = new TemporaryWebview(resources, ui); - - let organizationSlug: string | undefined; - let courseId: number | undefined; - - while (!(organizationSlug && courseId)) { - const orgResult = await selectOrganization(actionContext, tempView); - if (orgResult.err) { - tempView.dispose(); - return orgResult; - } - Logger.log(`Organization slug ${orgResult.val} selected`); - organizationSlug = orgResult.val; - const courseResult = await selectCourse(actionContext, organizationSlug, tempView); - if (courseResult.err) { - tempView.dispose(); - return courseResult; - } - if (courseResult.val.changeOrg) { - continue; - } - courseId = courseResult.val.course; - } - Logger.log(`Course with id ${courseId} selected`); - tempView.dispose(); - return new Ok({ organization: organizationSlug, course: courseId }); -} From 60568262356b86075afb44417c1e7d2542fcda1b Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Fri, 16 Apr 2021 11:25:53 +0300 Subject: [PATCH 18/79] Less complicated addNewCourse --- src/actions/addNewCourse.ts | 14 ++------------ src/init/ui.ts | 11 ++++++++++- 2 files changed, 12 insertions(+), 13 deletions(-) diff --git a/src/actions/addNewCourse.ts b/src/actions/addNewCourse.ts index 17fde996..9d68c8e5 100644 --- a/src/actions/addNewCourse.ts +++ b/src/actions/addNewCourse.ts @@ -4,7 +4,6 @@ import { LocalCourseData } from "../api/storage"; import { Logger } from "../utils"; import { refreshLocalExercises } from "./refreshLocalExercises"; -import { selectOrganizationAndCourse } from "./selectOrganizationAndCourse"; import { ActionContext } from "./types"; import { displayUserCourses } from "./webview"; @@ -13,21 +12,12 @@ import { displayUserCourses } from "./webview"; */ export async function addNewCourse( actionContext: ActionContext, - organization?: string, - course?: number, + organization: string, + course: number, ): Promise> { const { tmc, ui, userData, workspaceManager } = actionContext; Logger.log("Adding new course"); - if (!organization || !course) { - const orgAndCourse = await selectOrganizationAndCourse(actionContext); - if (orgAndCourse.err) { - return orgAndCourse; - } - organization = orgAndCourse.val.organization; - course = orgAndCourse.val.course; - } - const courseDataResult = await tmc.getCourseData(course); if (courseDataResult.err) { return courseDataResult; diff --git a/src/init/ui.ts b/src/init/ui.ts index 29483728..a3e5a1e6 100644 --- a/src/init/ui.ts +++ b/src/init/ui.ts @@ -14,6 +14,7 @@ import { openWorkspace, refreshLocalExercises, removeCourse, + selectOrganizationAndCourse, updateCourse, } from "../actions"; import { ActionContext } from "../actions/types"; @@ -183,7 +184,15 @@ export function registerUiActions(actionContext: ActionContext): void { }, ); ui.webview.registerHandler("addCourse", async () => { - const result = await addNewCourse(actionContext); + const orgAndCourse = await selectOrganizationAndCourse(actionContext); + if (orgAndCourse.err) { + return dialog.errorNotification( + `Failed to add new course: ${orgAndCourse.val.message}`, + ); + } + const organization = orgAndCourse.val.organization; + const course = orgAndCourse.val.course; + const result = await addNewCourse(actionContext, organization, course); if (result.err) { dialog.errorNotification(`Failed to add new course: ${result.val.message}`); } From c978db65144298afe465aabc01c2ac544d742051 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Fri, 16 Apr 2021 12:06:57 +0300 Subject: [PATCH 19/79] Move updateCourse action to own file --- src/actions/index.ts | 1 + src/actions/updateCourse.ts | 100 ++++++++++++++++++++++++++++++++++++ src/actions/user.ts | 97 +--------------------------------- 3 files changed, 103 insertions(+), 95 deletions(-) create mode 100644 src/actions/updateCourse.ts diff --git a/src/actions/index.ts b/src/actions/index.ts index 0e089610..0f382177 100644 --- a/src/actions/index.ts +++ b/src/actions/index.ts @@ -6,5 +6,6 @@ export * from "./moveExtensionDataPath"; export * from "./refreshLocalExercises"; export * from "./selectOrganizationAndCourse"; export * from "./user"; +export * from "./updateCourse"; export * from "./webview"; export * from "./workspace"; diff --git a/src/actions/updateCourse.ts b/src/actions/updateCourse.ts new file mode 100644 index 00000000..23e53034 --- /dev/null +++ b/src/actions/updateCourse.ts @@ -0,0 +1,100 @@ +import { Ok, Result } from "ts-results"; + +import { ConnectionError, ForbiddenError } from "../errors"; +import { Logger } from "../utils"; + +import { ActionContext } from "./types"; + +/** + * Updates the given course by re-fetching all data from the server. Handles authorization and + * connection errors as successful operations where the data was not actually updated. + * + * @param courseId ID of the course to update. + * @returns Boolean value representing whether the data from server was successfully received. + */ +export async function updateCourse( + actionContext: ActionContext, + courseId: number, +): Promise> { + const { exerciseDecorationProvider, tmc, ui, userData, workspaceManager } = actionContext; + const postMessage = (courseId: number, disabled: boolean, exerciseIds: number[]): void => { + ui.webview.postMessage( + { + command: "setNewExercises", + courseId, + exerciseIds, + }, + { + command: "setCourseDisabledStatus", + courseId, + disabled, + }, + ); + }; + const courseData = userData.getCourse(courseId); + const updateResult = await tmc.getCourseData(courseId, { forceRefresh: true }); + if (updateResult.err) { + if (updateResult.val instanceof ForbiddenError) { + if (!courseData.disabled) { + Logger.warn( + `Failed to access information for course ${courseData.name}. Marking as disabled.`, + ); + const course = userData.getCourse(courseId); + await userData.updateCourse({ ...course, disabled: true }); + postMessage(course.id, true, []); + } else { + Logger.warn( + `ForbiddenError above probably caused by course still being disabled ${courseData.name}`, + ); + postMessage(courseData.id, true, []); + } + return Ok(false); + } else if (updateResult.val instanceof ConnectionError) { + Logger.warn("Failed to fetch data from TMC servers, data not updated."); + return Ok(false); + } else { + return updateResult; + } + } + + const { details, exercises, settings } = updateResult.val; + const [availablePoints, awardedPoints] = exercises.reduce( + (a, b) => [a[0] + b.available_points.length, a[1] + b.awarded_points.length], + [0, 0], + ); + + await userData.updateCourse({ + ...courseData, + availablePoints, + awardedPoints, + description: details.description || "", + disabled: settings.disabled_status !== "enabled", + materialUrl: settings.material_url, + perhapsExamMode: settings.hide_submission_results, + }); + + const updateExercisesResult = await userData.updateExercises( + courseId, + details.exercises.map((x) => ({ + id: x.id, + name: x.name, + deadline: x.deadline, + passed: x.completed, + softDeadline: x.soft_deadline, + })), + ); + if (updateExercisesResult.err) { + return updateExercisesResult; + } + + if (courseData.name === workspaceManager.activeCourse) { + exerciseDecorationProvider.updateDecorationsForExercises( + ...workspaceManager.getExercisesByCourseSlug(courseData.name), + ); + } + + const course = userData.getCourse(courseId); + postMessage(course.id, course.disabled, course.newExercises); + + return Ok(true); +} diff --git a/src/actions/user.ts b/src/actions/user.ts index 0e1eae5d..eacbd4ac 100644 --- a/src/actions/user.ts +++ b/src/actions/user.ts @@ -14,7 +14,7 @@ import { LocalCourseData } from "../api/storage"; import { SubmissionFeedback } from "../api/types"; import { WorkspaceExercise } from "../api/workspaceManager"; import { EXAM_TEST_RESULT, NOTIFICATION_DELAY } from "../config/constants"; -import { BottleneckError, ConnectionError, ForbiddenError } from "../errors"; +import { BottleneckError } from "../errors"; import { TestResultData } from "../ui/types"; import { formatSizeInBytes, @@ -26,6 +26,7 @@ import { getActiveEditorExecutablePath } from "../window"; import { downloadNewExercisesForCourse } from "./downloadNewExercisesForCourse"; import { ActionContext, FeedbackQuestion } from "./types"; +import { updateCourse } from "./updateCourse"; /** * Authenticates and logs the user in if credentials are correct. @@ -514,97 +515,3 @@ export async function removeCourse(actionContext: ActionContext, id: number): Pr await vscode.commands.executeCommand("workbench.action.closeFolder"); } } - -/** - * Updates the given course by re-fetching all data from the server. Handles authorization and - * connection errors as successful operations where the data was not actually updated. - * - * @param courseId ID of the course to update. - * @returns Boolean value representing whether the data from server was successfully received. - */ -export async function updateCourse( - actionContext: ActionContext, - courseId: number, -): Promise> { - const { exerciseDecorationProvider, tmc, ui, userData, workspaceManager } = actionContext; - const postMessage = (courseId: number, disabled: boolean, exerciseIds: number[]): void => { - ui.webview.postMessage( - { - command: "setNewExercises", - courseId, - exerciseIds, - }, - { - command: "setCourseDisabledStatus", - courseId, - disabled, - }, - ); - }; - const courseData = userData.getCourse(courseId); - const updateResult = await tmc.getCourseData(courseId, { forceRefresh: true }); - if (updateResult.err) { - if (updateResult.val instanceof ForbiddenError) { - if (!courseData.disabled) { - Logger.warn( - `Failed to access information for course ${courseData.name}. Marking as disabled.`, - ); - const course = userData.getCourse(courseId); - await userData.updateCourse({ ...course, disabled: true }); - postMessage(course.id, true, []); - } else { - Logger.warn( - `ForbiddenError above probably caused by course still being disabled ${courseData.name}`, - ); - postMessage(courseData.id, true, []); - } - return Ok(false); - } else if (updateResult.val instanceof ConnectionError) { - Logger.warn("Failed to fetch data from TMC servers, data not updated."); - return Ok(false); - } else { - return updateResult; - } - } - - const { details, exercises, settings } = updateResult.val; - const [availablePoints, awardedPoints] = exercises.reduce( - (a, b) => [a[0] + b.available_points.length, a[1] + b.awarded_points.length], - [0, 0], - ); - - await userData.updateCourse({ - ...courseData, - availablePoints, - awardedPoints, - description: details.description || "", - disabled: settings.disabled_status !== "enabled", - materialUrl: settings.material_url, - perhapsExamMode: settings.hide_submission_results, - }); - - const updateExercisesResult = await userData.updateExercises( - courseId, - details.exercises.map((x) => ({ - id: x.id, - name: x.name, - deadline: x.deadline, - passed: x.completed, - softDeadline: x.soft_deadline, - })), - ); - if (updateExercisesResult.err) { - return updateExercisesResult; - } - - if (courseData.name === workspaceManager.activeCourse) { - exerciseDecorationProvider.updateDecorationsForExercises( - ...workspaceManager.getExercisesByCourseSlug(courseData.name), - ); - } - - const course = userData.getCourse(courseId); - postMessage(course.id, course.disabled, course.newExercises); - - return Ok(true); -} From 5e585d2c223a698e38b7ea7195746de0d5e85f1a Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Fri, 16 Apr 2021 14:22:20 +0300 Subject: [PATCH 20/79] Store point data per exercise --- src/actions/addNewCourse.ts | 9 ++--- src/actions/updateCourse.ts | 9 ++--- src/api/storage.ts | 2 ++ src/config/constants.ts | 28 ++++++++------- src/migrate/migrateUserData.ts | 31 +++++++++++++++-- src/test/api/storage.test.ts | 38 ++------------------- src/test/fixtures/userData.ts | 43 +++++++++++++++++++++++- src/test/migrate/migrateUserData.test.ts | 30 +++++++++++++++-- src/test/mocks/userdata.ts | 2 +- src/utils/apiData.ts | 36 ++++++++++++++++++++ 10 files changed, 160 insertions(+), 68 deletions(-) create mode 100644 src/utils/apiData.ts diff --git a/src/actions/addNewCourse.ts b/src/actions/addNewCourse.ts index 9d68c8e5..8dd84540 100644 --- a/src/actions/addNewCourse.ts +++ b/src/actions/addNewCourse.ts @@ -2,6 +2,7 @@ import { Result } from "ts-results"; import { LocalCourseData } from "../api/storage"; import { Logger } from "../utils"; +import { combineApiExerciseData } from "../utils/apiData"; import { refreshLocalExercises } from "./refreshLocalExercises"; import { ActionContext } from "./types"; @@ -33,13 +34,7 @@ export async function addNewCourse( const localData: LocalCourseData = { description: courseData.details.description || "", - exercises: courseData.details.exercises.map((e) => ({ - id: e.id, - name: e.name, - deadline: e.deadline, - passed: e.completed, - softDeadline: e.soft_deadline, - })), + exercises: combineApiExerciseData(courseData.details.exercises, courseData.exercises), id: courseData.details.id, name: courseData.details.name, title: courseData.details.title, diff --git a/src/actions/updateCourse.ts b/src/actions/updateCourse.ts index 23e53034..f836e07c 100644 --- a/src/actions/updateCourse.ts +++ b/src/actions/updateCourse.ts @@ -2,6 +2,7 @@ import { Ok, Result } from "ts-results"; import { ConnectionError, ForbiddenError } from "../errors"; import { Logger } from "../utils"; +import { combineApiExerciseData } from "../utils/apiData"; import { ActionContext } from "./types"; @@ -75,13 +76,7 @@ export async function updateCourse( const updateExercisesResult = await userData.updateExercises( courseId, - details.exercises.map((x) => ({ - id: x.id, - name: x.name, - deadline: x.deadline, - passed: x.completed, - softDeadline: x.soft_deadline, - })), + combineApiExerciseData(details.exercises, exercises), ); if (updateExercisesResult.err) { return updateExercisesResult; diff --git a/src/api/storage.ts b/src/api/storage.ts index a5c03e17..bf3f637c 100644 --- a/src/api/storage.ts +++ b/src/api/storage.ts @@ -26,6 +26,8 @@ export interface LocalCourseData { export interface LocalCourseExercise { id: number; + availablePoints: number; + awardedPoints: number; name: string; deadline: string | null; passed: boolean; diff --git a/src/config/constants.ts b/src/config/constants.ts index 251f4c3b..c682fd45 100644 --- a/src/config/constants.ts +++ b/src/config/constants.ts @@ -21,6 +21,22 @@ export const CLIENT_NAME = "vscode_plugin"; export const EXTENSION_ID = "moocfi.test-my-code"; export const OUTPUT_CHANNEL_NAME = "TestMyCode"; +/** + * Delay for notifications that offer a "remind me later" option. + */ +export const NOTIFICATION_DELAY = 30 * 60 * 1000; + +export const API_CACHE_LIFETIME = 5 * 60 * 1000; +export const CLI_PROCESS_TIMEOUT = 2 * 60 * 1000; +export const EXERCISE_CHECK_INTERVAL = 30 * 60 * 1000; + +/** Minimum time that should be waited between submission attempts. */ +export const MINIMUM_SUBMISSION_INTERVAL = 5 * 1000; + +export const LOCAL_EXERCISE_AVAILABLE_POINTS_PLACEHOLDER = 1; +export const LOCAL_EXERCISE_AWARDED_POINTS_PLACEHOLDER = 1; +export const LOCAL_EXERCISE_UNAWARDED_POINTS_PLACEHOLDER = LOCAL_EXERCISE_AVAILABLE_POINTS_PLACEHOLDER; + export const HIDE_META_FILES = { "**/__pycache__": true, "**/.available_points.json": true, @@ -64,18 +80,6 @@ export const WORKSPACE_SETTINGS = { }, }; -/** - * Delay for notifications that offer a "remind me later" option. - */ -export const NOTIFICATION_DELAY = 30 * 60 * 1000; - -export const API_CACHE_LIFETIME = 5 * 60 * 1000; -export const CLI_PROCESS_TIMEOUT = 2 * 60 * 1000; -export const EXERCISE_CHECK_INTERVAL = 30 * 60 * 1000; - -/** Minimum time that should be waited between submission attempts. */ -export const MINIMUM_SUBMISSION_INTERVAL = 5 * 1000; - export const EMPTY_HTML_DOCUMENT = ``; /** diff --git a/src/migrate/migrateUserData.ts b/src/migrate/migrateUserData.ts index 51ea7577..9a9a8a08 100644 --- a/src/migrate/migrateUserData.ts +++ b/src/migrate/migrateUserData.ts @@ -1,6 +1,13 @@ import { createIs } from "typescript-is"; import * as vscode from "vscode"; +import { LocalCourseData } from "../api/storage"; +import { + LOCAL_EXERCISE_AVAILABLE_POINTS_PLACEHOLDER, + LOCAL_EXERCISE_AWARDED_POINTS_PLACEHOLDER, + LOCAL_EXERCISE_UNAWARDED_POINTS_PLACEHOLDER, +} from "../config/constants"; + import { MigratedData } from "./types"; import validateData from "./validateData"; @@ -39,6 +46,8 @@ export interface LocalCourseDataV1 { organization: string; exercises: Array<{ id: number; + awardedPoints?: number; + availablePoints?: number; name: string; deadline: string | null; passed: boolean; @@ -95,9 +104,25 @@ function courseDataFromV0ToV1( }); } +export function resolveMissingFields(localCourseData: LocalCourseDataV1[]): LocalCourseData[] { + return localCourseData.map((course) => { + const exercises = course.exercises.map((x) => { + const resolvedAwardedPoints = x.passed + ? LOCAL_EXERCISE_AWARDED_POINTS_PLACEHOLDER + : LOCAL_EXERCISE_UNAWARDED_POINTS_PLACEHOLDER; + return { + ...x, + availablePoints: x.availablePoints ?? LOCAL_EXERCISE_AVAILABLE_POINTS_PLACEHOLDER, + awardedPoints: x.awardedPoints ?? resolvedAwardedPoints, + }; + }); + return { ...course, exercises }; + }); +} + export default function migrateUserData( memento: vscode.Memento, -): MigratedData<{ courses: LocalCourseDataV1[] }> { +): MigratedData<{ courses: LocalCourseData[] }> { const obsoleteKeys: string[] = []; const dataV0 = validateData( memento.get(USER_DATA_KEY_V0), @@ -111,5 +136,7 @@ export default function migrateUserData( ? { courses: courseDataFromV0ToV1(dataV0.courses, memento) } : validateData(memento.get(USER_DATA_KEY_V1), createIs<{ courses: LocalCourseDataV1[] }>()); - return { data: dataV1, obsoleteKeys }; + const data = dataV1 ? { ...dataV1, courses: resolveMissingFields(dataV1?.courses) } : undefined; + + return { data, obsoleteKeys }; } diff --git a/src/test/api/storage.test.ts b/src/test/api/storage.test.ts index d4149394..6ec878ba 100644 --- a/src/test/api/storage.test.ts +++ b/src/test/api/storage.test.ts @@ -1,6 +1,7 @@ import { expect } from "chai"; -import Storage, { ExtensionSettings, SessionState, UserData } from "../../api/storage"; +import Storage, { ExtensionSettings, SessionState } from "../../api/storage"; +import { v2_1_0 as userData } from "../fixtures/userData"; import { createMockContext } from "../mocks/vscode"; suite("Storage class", function () { @@ -16,41 +17,6 @@ suite("Storage class", function () { extensionVersion: "2.0.0", }; - const userData: UserData = { - courses: [ - { - id: 0, - availablePoints: 3, - awardedPoints: 0, - description: "Python Course", - disabled: true, - exercises: [ - { - id: 1, - deadline: null, - name: "hello_world", - passed: false, - softDeadline: null, - }, - { - id: 2, - deadline: "20201214", - name: "other_hello_world", - passed: false, - softDeadline: "20201212", - }, - ], - materialUrl: "mooc.fi", - name: "test-python-course", - newExercises: [2, 3, 4], - notifyAfter: 1234, - organization: "test", - perhapsExamMode: true, - title: "The Python Course", - }, - ], - }; - let storage: Storage; setup(function () { diff --git a/src/test/fixtures/userData.ts b/src/test/fixtures/userData.ts index 80b30ff1..cc16b56c 100644 --- a/src/test/fixtures/userData.ts +++ b/src/test/fixtures/userData.ts @@ -1,8 +1,10 @@ -import { LocalCourseExercise } from "../../api/storage"; +import { LocalCourseExercise, UserData } from "../../api/storage"; import { LocalCourseDataV0, LocalCourseDataV1 } from "../../migrate/migrateUserData"; export const userDataExerciseHelloWorld: LocalCourseExercise = { id: 1, + availablePoints: 1, + awardedPoints: 0, deadline: null, name: "hello_world", passed: false, @@ -225,3 +227,42 @@ export const v2_0_0: UserDataV1 = { }, ], }; + +export const v2_1_0: UserData = { + courses: [ + { + id: 0, + availablePoints: 3, + awardedPoints: 0, + description: "Python Course", + disabled: true, + exercises: [ + { + id: 1, + availablePoints: 1, + awardedPoints: 0, + deadline: null, + name: "hello_world", + passed: false, + softDeadline: null, + }, + { + id: 2, + availablePoints: 1, + awardedPoints: 0, + deadline: "20201214", + name: "other_world", + passed: false, + softDeadline: "20201212", + }, + ], + materialUrl: "mooc.fi", + name: "test-python-course", + newExercises: [2, 3, 4], + notifyAfter: 1234, + organization: "test", + perhapsExamMode: true, + title: "The Python Course", + }, + ], +}; diff --git a/src/test/migrate/migrateUserData.test.ts b/src/test/migrate/migrateUserData.test.ts index 561ba959..febfe321 100644 --- a/src/test/migrate/migrateUserData.test.ts +++ b/src/test/migrate/migrateUserData.test.ts @@ -1,6 +1,11 @@ import { expect } from "chai"; import * as vscode from "vscode"; +import { + LOCAL_EXERCISE_AVAILABLE_POINTS_PLACEHOLDER, + LOCAL_EXERCISE_AWARDED_POINTS_PLACEHOLDER, + LOCAL_EXERCISE_UNAWARDED_POINTS_PLACEHOLDER, +} from "../../config/constants"; import migrateUserData, { LocalCourseDataV0 } from "../../migrate/migrateUserData"; import * as exerciseData from "../fixtures/exerciseData"; import * as userData from "../fixtures/userData"; @@ -86,11 +91,32 @@ suite("User data migration", function () { test("should succeed with version 2.0.0 data", async function () { await memento.update(USER_DATA_KEY_V1, userData.v2_0_0); - expect(migrateUserData(memento).data).to.be.deep.equal(userData.v2_0_0); + const courses = migrateUserData(memento).data?.courses; + courses?.forEach((course) => { + course.exercises.forEach((x) => { + expect(x.availablePoints).to.be.equal( + LOCAL_EXERCISE_AVAILABLE_POINTS_PLACEHOLDER, + ); + if (x.passed) { + expect(x.awardedPoints).to.be.equal( + LOCAL_EXERCISE_AWARDED_POINTS_PLACEHOLDER, + ); + } else { + expect(x.availablePoints).to.be.equal( + LOCAL_EXERCISE_UNAWARDED_POINTS_PLACEHOLDER, + ); + } + }); + }); + }); + + test("should succeed with version 2.1.0 data", async function () { + await memento.update(USER_DATA_KEY_V1, userData.v2_1_0); + expect(migrateUserData(memento).data).to.be.deep.equal(userData.v2_1_0); }); test("should succeed with backwards compatible future data", async function () { - const data = { ...userData.v2_0_0, batman: "Bruce Wayne" }; + const data = { ...userData.v2_1_0, batman: "Bruce Wayne" }; await memento.update(USER_DATA_KEY_V1, data); expect(migrateUserData(memento).data).to.be.deep.equal(data); }); diff --git a/src/test/mocks/userdata.ts b/src/test/mocks/userdata.ts index dbdf31e3..3a1a246f 100644 --- a/src/test/mocks/userdata.ts +++ b/src/test/mocks/userdata.ts @@ -2,7 +2,7 @@ import { IMock, It, Mock } from "typemoq"; import { LocalCourseData, LocalCourseExercise } from "../../api/storage"; import { UserData } from "../../config/userdata"; -import { v2_0_0 as userData } from "../fixtures/userData"; +import { v2_1_0 as userData } from "../fixtures/userData"; export interface UserDataMockValues { getCourses: LocalCourseData[]; diff --git a/src/utils/apiData.ts b/src/utils/apiData.ts new file mode 100644 index 00000000..1255be11 --- /dev/null +++ b/src/utils/apiData.ts @@ -0,0 +1,36 @@ +import { LocalCourseExercise } from "../api/storage"; +import { CourseExercise, Exercise } from "../api/types"; +import { + LOCAL_EXERCISE_AVAILABLE_POINTS_PLACEHOLDER, + LOCAL_EXERCISE_AWARDED_POINTS_PLACEHOLDER, + LOCAL_EXERCISE_UNAWARDED_POINTS_PLACEHOLDER, +} from "../config/constants"; + +/** + * Takes exercise arrays from two different endpoints and attempts to resolve them into + * `LocalCourseExercise`. Uses common default values, if matching id is not found from + * `courseExercises`. + */ +export function combineApiExerciseData( + exercises: Exercise[], + courseExercises: CourseExercise[], +): LocalCourseExercise[] { + const exercisePointsMap = new Map(courseExercises.map((x) => [x.id, x])); + return exercises.map((x) => { + const match = exercisePointsMap.get(x.id); + const passed = x.completed; + const awardedPointsFallback = passed + ? LOCAL_EXERCISE_AWARDED_POINTS_PLACEHOLDER + : LOCAL_EXERCISE_UNAWARDED_POINTS_PLACEHOLDER; + return { + id: x.id, + availablePoints: + match?.available_points.length ?? LOCAL_EXERCISE_AVAILABLE_POINTS_PLACEHOLDER, + awardedPoints: match?.awarded_points.length ?? awardedPointsFallback, + name: x.name, + deadline: x.deadline, + passed: x.completed, + softDeadline: x.soft_deadline, + }; + }); +} From bff6a9f3868918e0a9d7074491b64e46a9b8cb19 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Fri, 16 Apr 2021 15:15:18 +0300 Subject: [PATCH 21/79] Decorate partially completed exercises --- src/api/exerciseDecorationProvider.ts | 4 ++++ src/test/api/exerciseDecorationProvider.test.ts | 11 +++++++++++ 2 files changed, 15 insertions(+) diff --git a/src/api/exerciseDecorationProvider.ts b/src/api/exerciseDecorationProvider.ts index 952906bd..de34a653 100644 --- a/src/api/exerciseDecorationProvider.ts +++ b/src/api/exerciseDecorationProvider.ts @@ -72,6 +72,10 @@ export default class ExerciseDecorationProvider if (deadlinePassed) { return ExerciseDecorationProvider._expiredExercise; } + + if (apiExercise.awardedPoints > 0) { + return ExerciseDecorationProvider._partiallyCompletedExercise; + } } /** diff --git a/src/test/api/exerciseDecorationProvider.test.ts b/src/test/api/exerciseDecorationProvider.test.ts index 69447e1a..708b594d 100644 --- a/src/test/api/exerciseDecorationProvider.test.ts +++ b/src/test/api/exerciseDecorationProvider.test.ts @@ -44,6 +44,17 @@ suite("ExerciseDecoratorProvider class", function () { expect((decoration as vscode.FileDecoration).badge).to.be.equal("✗"); }); + test("should decorate partially completed exercise with small circle", function () { + const partialCompletion = { + ...userDataExerciseHelloWorld, + awardedPoints: 1, + passed: false, + }; + userDataMockValues.getExerciseByName = partialCompletion; + const decoration = exerciseDecorationProvider.provideFileDecoration(exerciseHelloWorld.uri); + expect((decoration as vscode.FileDecoration).badge).to.be.equal("○"); + }); + test("should decorate exercise missing from UserData with information symbol", function () { userDataMockValues.getExerciseByName = undefined; const decoration = exerciseDecorationProvider.provideFileDecoration(exerciseHelloWorld.uri); From 498fd16050a80fb1fdeed12afbaee6e1e36883af Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Fri, 16 Apr 2021 15:32:43 +0300 Subject: [PATCH 22/79] Fix constants --- src/config/constants.ts | 4 ++-- src/test/migrate/migrateUserData.test.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/config/constants.ts b/src/config/constants.ts index c682fd45..8408293a 100644 --- a/src/config/constants.ts +++ b/src/config/constants.ts @@ -34,8 +34,8 @@ export const EXERCISE_CHECK_INTERVAL = 30 * 60 * 1000; export const MINIMUM_SUBMISSION_INTERVAL = 5 * 1000; export const LOCAL_EXERCISE_AVAILABLE_POINTS_PLACEHOLDER = 1; -export const LOCAL_EXERCISE_AWARDED_POINTS_PLACEHOLDER = 1; -export const LOCAL_EXERCISE_UNAWARDED_POINTS_PLACEHOLDER = LOCAL_EXERCISE_AVAILABLE_POINTS_PLACEHOLDER; +export const LOCAL_EXERCISE_AWARDED_POINTS_PLACEHOLDER = LOCAL_EXERCISE_AVAILABLE_POINTS_PLACEHOLDER; +export const LOCAL_EXERCISE_UNAWARDED_POINTS_PLACEHOLDER = 0; export const HIDE_META_FILES = { "**/__pycache__": true, diff --git a/src/test/migrate/migrateUserData.test.ts b/src/test/migrate/migrateUserData.test.ts index febfe321..4b0076c6 100644 --- a/src/test/migrate/migrateUserData.test.ts +++ b/src/test/migrate/migrateUserData.test.ts @@ -102,7 +102,7 @@ suite("User data migration", function () { LOCAL_EXERCISE_AWARDED_POINTS_PLACEHOLDER, ); } else { - expect(x.availablePoints).to.be.equal( + expect(x.awardedPoints).to.be.equal( LOCAL_EXERCISE_UNAWARDED_POINTS_PLACEHOLDER, ); } From 33239f2c3239108be0ef83c5f32508d888e5affd Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Tue, 20 Apr 2021 13:28:21 +0300 Subject: [PATCH 23/79] Use filled circle for completed exercises --- src/api/exerciseDecorationProvider.ts | 3 +-- src/test/api/exerciseDecorationProvider.test.ts | 4 ++-- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/src/api/exerciseDecorationProvider.ts b/src/api/exerciseDecorationProvider.ts index de34a653..514dbc59 100644 --- a/src/api/exerciseDecorationProvider.ts +++ b/src/api/exerciseDecorationProvider.ts @@ -10,9 +10,8 @@ export default class ExerciseDecorationProvider implements vscode.Disposable, vscode.FileDecorationProvider { public onDidChangeFileDecorations: vscode.Event; - // Use ⬤ instead? private static _passedExercise = new vscode.FileDecoration( - "✓", + "⬤", "Exercise completed!", new vscode.ThemeColor("gitDecoration.addedResourceForeground"), ); diff --git a/src/test/api/exerciseDecorationProvider.test.ts b/src/test/api/exerciseDecorationProvider.test.ts index 708b594d..b2f81338 100644 --- a/src/test/api/exerciseDecorationProvider.test.ts +++ b/src/test/api/exerciseDecorationProvider.test.ts @@ -31,10 +31,10 @@ suite("ExerciseDecoratorProvider class", function () { ); }); - test("should decorate passed exercise with a checkmark", function () { + test("should decorate passed exercise with a filled circle", function () { userDataMockValues.getExerciseByName = { ...userDataExerciseHelloWorld, passed: true }; const decoration = exerciseDecorationProvider.provideFileDecoration(exerciseHelloWorld.uri); - expect((decoration as vscode.FileDecoration).badge).to.be.equal("✓"); + expect((decoration as vscode.FileDecoration).badge).to.be.equal("⬤"); }); test("should decorate expired exercise with an X mark", function () { From 30dca1b2ffb8faeb0f943fac2e7ab2dedb30e4b3 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Tue, 20 Apr 2021 14:57:00 +0300 Subject: [PATCH 24/79] Share common modules between entrypoints --- .vscodeignore | 2 +- webpack.config.js | 8 ++++++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/.vscodeignore b/.vscodeignore index 7565d45c..68382408 100644 --- a/.vscodeignore +++ b/.vscodeignore @@ -18,7 +18,7 @@ types/** **/.gitmodules **/.eslintignore **/.eslintrc.json -**/dist/testBundle* +**/dist/test* **/tsconfig.json **/tsconfig.production.json **/tslint.json diff --git a/webpack.config.js b/webpack.config.js index fee9b573..927c1873 100644 --- a/webpack.config.js +++ b/webpack.config.js @@ -56,6 +56,14 @@ const config = () => { infrastructureLogging: { level: "log", }, + optimization: { + splitChunks: { + chunks: "all", + name(module, chunks) { + return chunks.find((x) => x.name === "extension") ? "lib" : "testlib"; + }, + }, + }, module: { rules: [ { From 21d05332bbf7e104008a9b083874757bfe4803fb Mon Sep 17 00:00:00 2001 From: Sebastian Sergelius Date: Tue, 20 Apr 2021 15:46:19 +0300 Subject: [PATCH 25/79] Use VSCode API to handle extension & workspace settings --- package.json | 47 ++++++++++++++ src/actions/user.ts | 10 +-- src/api/workspaceManager.ts | 92 +++++++++++++++++++++++++- src/config/settings.ts | 126 ++++++++++++------------------------ src/extension.ts | 9 ++- src/init/ui.ts | 11 +++- src/utils/logger.ts | 4 +- src/utils/utils.ts | 14 ---- src/window/index.ts | 4 +- 9 files changed, 204 insertions(+), 113 deletions(-) diff --git a/package.json b/package.json index 32955f6a..042b6491 100644 --- a/package.json +++ b/package.json @@ -180,6 +180,53 @@ "title": "Wipe all extension data" } ], + "configuration": { + "title": "TestMyCode", + "properties": { + "testMyCode.downloadOldSubmissionByDefault": { + "type": "boolean", + "default": true, + "description": "When downloading exercises, download your latest submission instead of the exercise template." + }, + "testMyCode.hideMetaFiles": { + "type": "boolean", + "default": true, + "description": "Hide exercise meta files that are not relevant for completing exercises." + }, + "testMyCode.insiderVersion": { + "type": "boolean", + "scope": "application", + "default": false, + "description": "Insider version to test new features for the TestMyCode extension." + }, + "testMyCode.logLevel": { + "type": "string", + "scope": "application", + "default": "errors", + "enum": [ + "none", + "errors", + "verbose" + ], + "enumDescriptions": [ + "No extension logging.", + "Log only warning and error messages.", + "Log info, warning and error messages." + ] + }, + "testMyCode.updateExercisesAutomatically": { + "type": "boolean", + "default": true, + "description": "Download exercise updates automatically, if found." + }, + "testMyCode.dataPath": { + "type": "string", + "scope": "application", + "default": "/", + "description": "Currently a placeholder for setting the TMC Data Folder path." + } + } + }, "keybindings": [ { "command": "tmc.closeExercise", diff --git a/src/actions/user.ts b/src/actions/user.ts index eacbd4ac..d3dac8e5 100644 --- a/src/actions/user.ts +++ b/src/actions/user.ts @@ -16,12 +16,7 @@ import { WorkspaceExercise } from "../api/workspaceManager"; import { EXAM_TEST_RESULT, NOTIFICATION_DELAY } from "../config/constants"; import { BottleneckError } from "../errors"; import { TestResultData } from "../ui/types"; -import { - formatSizeInBytes, - isCorrectWorkspaceOpen, - Logger, - parseFeedbackQuestion, -} from "../utils/"; +import { formatSizeInBytes, Logger, parseFeedbackQuestion } from "../utils/"; import { getActiveEditorExecutablePath } from "../window"; import { downloadNewExercisesForCourse } from "./downloadNewExercisesForCourse"; @@ -418,7 +413,7 @@ export async function openWorkspace(actionContext: ActionContext, name: string): Logger.log(`Current workspace: ${currentWorkspaceFile?.fsPath}`); Logger.log(`TMC workspace: ${tmcWorkspaceFile}`); - if (!isCorrectWorkspaceOpen(resources, name)) { + if (!workspaceManager.activeCourse) { if ( !currentWorkspaceFile || (await dialog.confirmation( @@ -453,6 +448,7 @@ export async function openWorkspace(actionContext: ActionContext, name: string): } /** + * Deprecated * Settings webview */ export async function openSettings(actionContext: ActionContext): Promise { diff --git a/src/api/workspaceManager.ts b/src/api/workspaceManager.ts index 449fe1b0..7dd1a5c6 100644 --- a/src/api/workspaceManager.ts +++ b/src/api/workspaceManager.ts @@ -5,13 +5,16 @@ import { Err, Ok, Result } from "ts-results"; import * as vscode from "vscode"; import { + HIDE_META_FILES, + SHOW_META_FILES, + WATCHER_EXCLUDE, WORKSPACE_ROOT_FILE_NAME, WORKSPACE_ROOT_FILE_TEXT, WORKSPACE_ROOT_FOLDER_NAME, WORKSPACE_SETTINGS, } from "../config/constants"; import Resources, { EditorKind } from "../config/resources"; -import { Logger } from "../utils"; +import { Logger, LogLevel } from "../utils"; export enum ExerciseStatus { Closed = "closed", @@ -54,6 +57,19 @@ export default class WorkspaceManager implements vscode.Disposable { this._onDidChangeWorkspaceFolders(e), ), vscode.workspace.onDidOpenTextDocument((e) => this._onDidOpenTextDocument(e)), + vscode.workspace.onDidChangeConfiguration((e) => { + if (e.affectsConfiguration("testMyCode.logLevel")) { + Logger.configure( + vscode.workspace.getConfiguration("testMyCode").get("logLevel"), + ); + } + if (e.affectsConfiguration("testMyCode.hideMetaFiles")) { + this.excludeMetaFilesInWorkspace( + vscode.workspace.getConfiguration("testMyCode").get("hideMetaFiles") ?? + true, + ); + } + }), ]; } @@ -184,6 +200,40 @@ export default class WorkspaceManager implements vscode.Disposable { this._disposables.forEach((x) => x.dispose()); } + /** + * Updates files.exclude values in TMC Workspace.code-workspace. + * Keeps all user/workspace defined excluding patterns. + * @param hide true to hide meta files in TMC workspace. + */ + public async excludeMetaFilesInWorkspace(hide: boolean): Promise { + const value = hide ? HIDE_META_FILES : SHOW_META_FILES; + await this._updateWorkspaceSetting("files.exclude", value); + } + + /** + * Returns the section for the Workspace setting. + * If not found, returns User scope setting. + * @param section A dot-separated identifier. + */ + public getWorkspaceSettings(section?: string): vscode.WorkspaceConfiguration { + const activeCourse = this.activeCourse; + if (activeCourse) { + return vscode.workspace.getConfiguration(section, vscode.workspace.workspaceFile); + } + return vscode.workspace.getConfiguration(section); + } + + public async verifyWorkspaceSettingsIntegrity(): Promise { + if (this.activeCourse) { + Logger.log("TMC Workspace open, verifying workspace settings integrity."); + await this.excludeMetaFilesInWorkspace( + this.getWorkspaceSettings("testMyCode").get("hideMetaFiles") ?? true, + ); + await this._verifyWatcherPatternExclusion(); + await this._forceTMCWorkspaceSettings(); + } + } + /** * Event listener function for workspace watcher delete. * @param targetPath Path to deleted item @@ -203,6 +253,15 @@ export default class WorkspaceManager implements vscode.Disposable { } } + /** + * Force some settings for TMC .code-workspace files that. + */ + private async _forceTMCWorkspaceSettings(): Promise { + await this._updateWorkspaceSetting("explorer.decorations.colors", false); + await this._updateWorkspaceSetting("explorer.decorations.badges", true); + await this._updateWorkspaceSetting("problems.decorations.enabled", false); + } + /** * Refreshes current active course workspace by first making sure that the `.tmc` folder is at * the top and then lists all that course's open exercises in alphanumeric order. @@ -331,4 +390,35 @@ export default class WorkspaceManager implements vscode.Disposable { break; } } + + /** + * Updates a section for the TMC Workspace.code-workspace file, if the workspace is open. + * @param section Configuration name, supports dotted names. + * @param value The new value + */ + private async _updateWorkspaceSetting(section: string, value: unknown): Promise { + const activeCourse = this.activeCourse; + if (activeCourse) { + let newValue = value; + if (value instanceof Object) { + const oldValue = this.getWorkspaceSettings(section); + newValue = { ...oldValue, ...value }; + } + await vscode.workspace + .getConfiguration( + undefined, + vscode.Uri.file(this._resources.getWorkspaceFilePath(activeCourse)), + ) + .update(section, newValue, vscode.ConfigurationTarget.Workspace); + } + } + + /** + * Makes sure that folders and its contents aren't deleted by our watcher. + * .vscode folder needs to be unwatched, otherwise adding settings to WorkspaceFolder level + * doesn't work. For example defining Python interpreter for the Exercise folder. + */ + private async _verifyWatcherPatternExclusion(): Promise { + await this._updateWorkspaceSetting("files.watcherExclude", { ...WATCHER_EXCLUDE }); + } } diff --git a/src/config/settings.ts b/src/config/settings.ts index cca66cb7..5217b731 100644 --- a/src/config/settings.ts +++ b/src/config/settings.ts @@ -1,3 +1,4 @@ +import * as path from "path"; import { Ok, Result } from "ts-results"; import * as vscode from "vscode"; @@ -5,10 +6,8 @@ import Storage, { ExtensionSettings as SerializedExtensionSettings, SessionState, } from "../api/storage"; -import { isCorrectWorkspaceOpen } from "../utils"; import { Logger, LogLevel } from "../utils/logger"; -import { HIDE_META_FILES, SHOW_META_FILES, WATCHER_EXCLUDE } from "./constants"; import Resources from "./resources"; import { ExtensionSettingsData } from "./types"; @@ -21,13 +20,7 @@ export interface ExtensionSettings { } /** - * Settings class communicates changes to persistent storage and manages TMC - * Workspace.code-workspace settings. Workspace settings will only be updated when it is open. - * - * Perhaps TODO: Read and Write the .code-workspace file without using vscode premade functions for - * workspace, because they require the workspace to be open. Currently this approach works, because - * extension settings are saved to storage and VSCode restarts when our workspace is opened by the - * extension. + * TODO: Deprecate class */ export default class Settings { private static readonly _defaultSettings: ExtensionSettings = { @@ -55,16 +48,6 @@ export default class Settings { this._state = storage.getSessionState() ?? {}; } - public async verifyWorkspaceSettingsIntegrity(): Promise { - const workspace = vscode.workspace.name; - if (workspace && isCorrectWorkspaceOpen(this._resources, workspace.split(" ")[0])) { - Logger.log("TMC Workspace open, verifying workspace settings integrity."); - await this._setFilesExcludeInWorkspace(this._settings.hideMetaFiles); - await this._verifyWatcherPatternExclusion(); - await this._forceTMCWorkspaceSettings(); - } - } - /** * Update extension settings to storage. * @param settings ExtensionSettings object @@ -80,22 +63,61 @@ export default class Settings { * 'dataPath', value: '~/newpath' } */ public async updateSetting(data: ExtensionSettingsData): Promise { + // This is to ensure that settings globalStorage and the vscode settings match for now... + const workspaceFile = vscode.workspace.workspaceFile; + let isOurWorkspace: string | undefined = undefined; + if ( + workspaceFile && + path.relative(workspaceFile.fsPath, this._resources.workspaceFileFolder) === ".." + ) { + isOurWorkspace = vscode.workspace.name?.split(" ")[0]; + } + switch (data.setting) { case "downloadOldSubmission": this._settings.downloadOldSubmission = data.value; + if (isOurWorkspace) { + await vscode.workspace + .getConfiguration( + "testMyCode", + vscode.Uri.file(this._resources.getWorkspaceFilePath(isOurWorkspace)), + ) + .update("downloadOldSubmission", data.value); + } break; case "hideMetaFiles": this._settings.hideMetaFiles = data.value; - this._setFilesExcludeInWorkspace(data.value); + if (isOurWorkspace) { + await vscode.workspace + .getConfiguration( + "testMyCode", + vscode.Uri.file(this._resources.getWorkspaceFilePath(isOurWorkspace)), + ) + .update("hideMetaFiles", data.value); + } break; case "insiderVersion": this._settings.insiderVersion = data.value; + await vscode.workspace + .getConfiguration("testMyCode") + .update("insiderVersion", data.value); break; case "logLevel": this._settings.logLevel = data.value; + await vscode.workspace + .getConfiguration("testMyCode") + .update("logLevel", data.value); break; case "updateExercisesAutomatically": this._settings.updateExercisesAutomatically = data.value; + if (isOurWorkspace) { + await vscode.workspace + .getConfiguration( + "testMyCode", + vscode.Uri.file(this._resources.getWorkspaceFilePath(isOurWorkspace)), + ) + .update("updateExercisesAutomatically", data.value); + } break; } Logger.log("Updated settings data", data); @@ -123,20 +145,6 @@ export default class Settings { return Ok(this._settings); } - /** - * Returns the section for the Workspace setting. If undefined, returns all settings. - * @param section A dot-separated identifier. - */ - public getWorkspaceSettings(section?: string): vscode.WorkspaceConfiguration | undefined { - const workspace = vscode.workspace.name?.split(" ")[0]; - if (workspace && isCorrectWorkspaceOpen(this._resources, workspace)) { - return vscode.workspace.getConfiguration( - section, - vscode.Uri.file(this._resources.getWorkspaceFilePath(workspace)), - ); - } - } - public isInsider(): boolean { return this._settings.insiderVersion; } @@ -162,54 +170,4 @@ export default class Settings { logLevel, }; } - - /** - * Updates files.exclude values in TMC Workspace.code-workspace. - * Keeps all user/workspace defined excluding patterns. - * @param hide true to hide meta files in TMC workspace. - */ - private async _setFilesExcludeInWorkspace(hide: boolean): Promise { - const value = hide ? HIDE_META_FILES : SHOW_META_FILES; - await this._updateWorkspaceSetting("files.exclude", value); - } - - /** - * Updates a section for the TMC Workspace.code-workspace file, if the workspace is open. - * @param section Configuration name, supports dotted names. - * @param value The new value - */ - private async _updateWorkspaceSetting(section: string, value: unknown): Promise { - const workspace = vscode.workspace.name?.split(" ")[0]; - if (workspace && isCorrectWorkspaceOpen(this._resources, workspace)) { - let newValue = value; - if (value instanceof Object) { - const oldValue = this.getWorkspaceSettings(section); - newValue = { ...oldValue, ...value }; - } - await vscode.workspace - .getConfiguration( - undefined, - vscode.Uri.file(this._resources.getWorkspaceFilePath(workspace)), - ) - .update(section, newValue, vscode.ConfigurationTarget.Workspace); - } - } - - /** - * Makes sure that folders and its contents aren't deleted by our watcher. - * .vscode folder needs to be unwatched, otherwise adding settings to WorkspaceFolder level - * doesn't work. For example defining Python interpreter for the Exercise folder. - */ - private async _verifyWatcherPatternExclusion(): Promise { - await this._updateWorkspaceSetting("files.watcherExclude", { ...WATCHER_EXCLUDE }); - } - - /** - * Force some settings for TMC .code-workspace files. - */ - private async _forceTMCWorkspaceSettings(): Promise { - await this._updateWorkspaceSetting("explorer.decorations.colors", false); - await this._updateWorkspaceSetting("explorer.decorations.badges", true); - await this._updateWorkspaceSetting("problems.decorations.enabled", false); - } } diff --git a/src/extension.ts b/src/extension.ts index 28738f5d..d832fb5b 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -97,7 +97,7 @@ export async function activate(context: vscode.ExtensionContext): Promise } const tmcDataPath = dataPathResult.val; - const workspaceFileFolder = path.join(context.globalStoragePath, "workspaces"); + const workspaceFileFolder = path.join(context.globalStorageUri.fsPath, "workspaces"); const resourcesResult = await init.resourceInitialization( context, storage, @@ -112,8 +112,10 @@ export async function activate(context: vscode.ExtensionContext): Promise const resources = resourcesResult.val; const settings = new Settings(storage, resources); // We still rely on VSCode Extenion Host restart when workspace switches - await settings.verifyWorkspaceSettingsIntegrity(); - Logger.configure(settings.getLogLevel()); + // await settings.verifyWorkspaceSettingsIntegrity(); + Logger.configure( + vscode.workspace.getConfiguration("testMyCode").get("logLevel") || LogLevel.Errors, + ); const ui = new UI(context, resources, vscode.window.createStatusBarItem()); const loggedIn = ui.treeDP.createVisibilityGroup(authenticated); @@ -143,6 +145,7 @@ export async function activate(context: vscode.ExtensionContext): Promise context.subscriptions.push(workspaceManager); if (workspaceManager.activeCourse) { await vscode.commands.executeCommand("setContext", "test-my-code:WorkspaceActive", true); + await workspaceManager.verifyWorkspaceSettingsIntegrity(); } const temporaryWebviewProvider = new TemporaryWebviewProvider(resources, ui); diff --git a/src/init/ui.ts b/src/init/ui.ts index a3e5a1e6..f7454145 100644 --- a/src/init/ui.ts +++ b/src/init/ui.ts @@ -27,7 +27,15 @@ import { formatSizeInBytes, Logger, LogLevel } from "../utils/"; * @param tmc The TMC API object */ export function registerUiActions(actionContext: ActionContext): void { - const { dialog, ui, resources, settings, userData, visibilityGroups } = actionContext; + const { + dialog, + ui, + resources, + settings, + userData, + visibilityGroups, + workspaceManager, + } = actionContext; Logger.log("Initializing UI Actions"); // Register UI actions @@ -331,6 +339,7 @@ export function registerUiActions(actionContext: ActionContext): void { return; } await settings.updateSetting({ setting: "hideMetaFiles", value: msg.data }); + await workspaceManager.excludeMetaFilesInWorkspace(msg.data); ui.webview.postMessage({ command: "setBooleanSetting", setting: "hideMetaFiles", diff --git a/src/utils/logger.ts b/src/utils/logger.ts index 7106a3ea..b8f8925e 100644 --- a/src/utils/logger.ts +++ b/src/utils/logger.ts @@ -13,8 +13,8 @@ const channel = `[${OUTPUT_CHANNEL_NAME}]`; export class Logger { static output: OutputChannel | undefined; - static configure(level: LogLevel): void { - this.level = level; + static configure(level?: LogLevel): void { + this.level = level ?? LogLevel.Errors; } static get level(): LogLevel { diff --git a/src/utils/utils.ts b/src/utils/utils.ts index 81e796fa..ec68f460 100644 --- a/src/utils/utils.ts +++ b/src/utils/utils.ts @@ -2,11 +2,9 @@ import * as fs from "fs-extra"; import * as fetch from "node-fetch"; import * as path from "path"; import { Err, Ok, Result } from "ts-results"; -import * as vscode from "vscode"; import { FeedbackQuestion } from "../actions/types"; import { SubmissionFeedbackQuestion } from "../api/types"; -import Resources from "../config/resources"; import { ConnectionError } from "../errors"; import { Logger } from "./logger"; @@ -66,18 +64,6 @@ export async function downloadFile( return Ok.EMPTY; } -/** - * Checks if currently open vscode workspace file path and given courseName path matches. - * - * @param resources - * @param courseName - */ -export function isCorrectWorkspaceOpen(resources: Resources, courseName: string): boolean { - const currentWorkspaceFile = vscode.workspace.workspaceFile; - const tmcWorkspaceFile = vscode.Uri.file(resources.getWorkspaceFilePath(courseName)); - return currentWorkspaceFile?.toString() === tmcWorkspaceFile.toString(); -} - /** * Await this to pause execution for an amount of time * @param millis diff --git a/src/window/index.ts b/src/window/index.ts index bad3f282..22c7bf4e 100644 --- a/src/window/index.ts +++ b/src/window/index.ts @@ -47,7 +47,9 @@ function getPythonPath( : extension.exports.settings.getExecutionCommand(document.uri); return execCommand.join(" "); } else { - return actionContext.settings.getWorkspaceSettings()?.get("python.pythonPath"); + return actionContext.workspaceManager + .getWorkspaceSettings() + ?.get("python.pythonPath"); } } catch (error) { const message = "Error while fetching python executable string"; From b58a925e8ace5a422080f5d5a598125706618ead Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Tue, 20 Apr 2021 16:29:07 +0300 Subject: [PATCH 26/79] Separate integration test suite --- .github/workflows/nodejs.yml | 6 +- .vscodeignore | 1 + bin/integrationLoader.js | 31 ++++++++++ bin/runTests.js | 38 ++----------- bin/testLoader.js | 2 + package.json | 1 + .../tmc_langs_cli.spec.ts} | 56 +++++++++++++++---- webpack.config.js | 1 + 8 files changed, 89 insertions(+), 47 deletions(-) create mode 100644 bin/integrationLoader.js rename src/{test/api/tmc.test.ts => test-integration/tmc_langs_cli.spec.ts} (93%) diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml index a531a6d0..1ec7406f 100644 --- a/.github/workflows/nodejs.yml +++ b/.github/workflows/nodejs.yml @@ -34,7 +34,11 @@ jobs: npm run setup chmod -R +x cli cd .. - - name: Run tests + - name: Unit tests uses: GabrielBB/xvfb-action@v1.0 with: run: npm test + - name: Integration tests + uses: GabrielBB/xvfb-action@v1.0 + with: + run: npm run test-only integration diff --git a/.vscodeignore b/.vscodeignore index 68382408..7f76f6d7 100644 --- a/.vscodeignore +++ b/.vscodeignore @@ -18,6 +18,7 @@ types/** **/.gitmodules **/.eslintignore **/.eslintrc.json +**dist/integration* **/dist/test* **/tsconfig.json **/tsconfig.production.json diff --git a/bin/integrationLoader.js b/bin/integrationLoader.js new file mode 100644 index 00000000..ae5de42c --- /dev/null +++ b/bin/integrationLoader.js @@ -0,0 +1,31 @@ +//@ts-check + +const Mocha = require("mocha"); +const path = require("path"); + +function run() { + // Create the mocha test + const mocha = new Mocha({ + ui: "tdd", + color: true, + }); + + return new Promise((c, e) => { + mocha.addFile(path.resolve(__dirname, "..", "dist", "integration.spec.js")); + + try { + // Run the mocha test + mocha.run((failures) => { + if (failures > 0) { + e(new Error(`${failures} tests failed.`)); + } else { + c(); + } + }); + } catch (err) { + e(err); + } + }); +} + +exports.run = run; diff --git a/bin/runTests.js b/bin/runTests.js index d80b2bdb..ca98faa1 100644 --- a/bin/runTests.js +++ b/bin/runTests.js @@ -1,42 +1,12 @@ //@ts-check -const cp = require("child_process"); const path = require("path"); -const kill = require("tree-kill"); const runTests = require("vscode-test").runTests; -/**@returns {Promise} */ -async function startServer() { - let ready = false; - console.log(path.join(__dirname, "..", "backend")); - const server = cp.spawn("npm", ["start"], { - cwd: path.join(__dirname, "..", "backend"), - shell: "bash", - }); - server.stdout.on("data", (chunk) => { - if (chunk.toString().startsWith("Server listening to")) { - ready = true; - } - }); - - const timeout = setTimeout(() => { - throw new Error("Failed to start server"); - }, 10000); - - while (!ready) { - await new Promise((resolve) => setTimeout(resolve, 1000)); - } - - clearTimeout(timeout); - return server; -} - async function main() { let exitCode = 0; /**@type {import("child_process").ChildProcess} */ - let backend; try { - backend = await startServer(); const platform = process.platform === "win32" && process.arch === "x64" ? "win32-x64-archive" @@ -48,17 +18,17 @@ async function main() { // The path to test runner // Passed to --extensionTestsPath - const extensionTestsPath = path.resolve(__dirname, "testLoader"); + const testLoader = process.argv[2] === "integration" ? "integrationLoader" : "testLoader"; + const extensionTestsPath = path.resolve(__dirname, testLoader); // Download VS Code, unzip it and run the integration test await runTests({ extensionDevelopmentPath, extensionTestsPath, platform }); } catch (err) { console.error("Failed to run tests"); exitCode = 1; - } finally { - kill(backend.pid); - process.exit(exitCode); } + + process.exit(exitCode); } main(); diff --git a/bin/testLoader.js b/bin/testLoader.js index 431783e4..6c73bfce 100644 --- a/bin/testLoader.js +++ b/bin/testLoader.js @@ -1,3 +1,5 @@ +//@ts-check + const Mocha = require("mocha"); const path = require("path"); diff --git a/package.json b/package.json index 32955f6a..aaed2662 100644 --- a/package.json +++ b/package.json @@ -373,6 +373,7 @@ "ci:all": "npm ci && cd backend && npm ci", "pretest": "cross-env NODE_ENV=development BACKEND=mockBackend npm run webpack", "test": "node ./bin/runTests.js", + "test-only": "node ./bin/runTests.js", "eslint-check": "eslint . --ext .js,.ts", "eslint": "eslint --fix . --ext .js,.ts", "lint-check": "npm run eslint-check && npm run prettier-check", diff --git a/src/test/api/tmc.test.ts b/src/test-integration/tmc_langs_cli.spec.ts similarity index 93% rename from src/test/api/tmc.test.ts rename to src/test-integration/tmc_langs_cli.spec.ts index 9b1f6726..6bc457e6 100644 --- a/src/test/api/tmc.test.ts +++ b/src/test-integration/tmc_langs_cli.spec.ts @@ -1,18 +1,40 @@ import { expect } from "chai"; +import * as cp from "child_process"; import { sync as delSync } from "del"; import * as fs from "fs-extra"; import * as path from "path"; +import * as kill from "tree-kill"; + +import TMC from "../api/tmc"; +import { SubmissionFeedback } from "../api/types"; +import { CLIENT_NAME, TMC_LANGS_CONFIG_DIR, TMC_LANGS_VERSION } from "../config/constants"; +import { AuthenticationError, AuthorizationError, BottleneckError, RuntimeError } from "../errors"; +import { getLangsCLIForPlatform, getPlatform } from "../utils/"; + +async function startServer(): Promise { + let ready = false; + console.log(path.join(__dirname, "..", "backend")); + const server = cp.spawn("npm", ["start"], { + cwd: path.join(__dirname, "..", "backend"), + shell: "bash", + }); + server.stdout.on("data", (chunk) => { + if (chunk.toString().startsWith("Server listening to")) { + ready = true; + } + }); + + const timeout = setTimeout(() => { + throw new Error("Failed to start server"); + }, 10000); + + while (!ready) { + await new Promise((resolve) => setTimeout(resolve, 1000)); + } -import TMC from "../../api/tmc"; -import { SubmissionFeedback } from "../../api/types"; -import { CLIENT_NAME, TMC_LANGS_CONFIG_DIR, TMC_LANGS_VERSION } from "../../config/constants"; -import { - AuthenticationError, - AuthorizationError, - BottleneckError, - RuntimeError, -} from "../../errors"; -import { getLangsCLIForPlatform, getPlatform } from "../../utils/"; + clearTimeout(timeout); + return server; +} suite("TMC", function () { // Use CLI from backend folder to run tests. The location is relative to the dist-folder @@ -27,6 +49,13 @@ suite("TMC", function () { const PASSING_EXERCISE_PATH = path.join(COURSE_PATH, "part01-01_passing_exercise"); const MISSING_EXERCISE_PATH = path.join(COURSE_PATH, "part01-404_missing_exercise"); + let server: cp.ChildProcess | undefined; + + suiteSetup(async function () { + this.timeout(30000); + server = await startServer(); + }); + function removeArtifacts(): void { delSync(ARTIFACT_PATH, { force: true }); } @@ -456,7 +485,7 @@ suite("TMC", function () { }); }); - suite("$submitSubmissionFeedback()", function () { + suite("#submitSubmissionFeedback()", function () { const feedback: SubmissionFeedback = { status: [{ question_id: 0, answer: "42" }], }; @@ -467,5 +496,8 @@ suite("TMC", function () { }); }); - suiteTeardown(removeCliConfig); + suiteTeardown(function () { + removeCliConfig(); + server && kill(server.pid); + }); }); diff --git a/webpack.config.js b/webpack.config.js index 927c1873..d0f0b502 100644 --- a/webpack.config.js +++ b/webpack.config.js @@ -31,6 +31,7 @@ const config = () => { entry: { extension: "./src/extension.ts", "testBundle.test": glob.sync("./src/test/**/*.test.ts"), + "integration.spec": glob.sync("./src/test-integration/**/*.spec.ts"), }, output: { path: path.resolve(__dirname, "dist"), From a9a3dc3c241124fffd899e956cf18a30c497ffa2 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Tue, 20 Apr 2021 17:02:59 +0300 Subject: [PATCH 27/79] Configuring this test environment is pure pain and misery --- .github/workflows/nodejs.yml | 2 +- .vscode/launch.json | 14 ++++++++- bin/runIntegration.js | 33 ++++++++++++++++++++++ bin/runTests.js | 3 +- package.json | 3 +- src/test-integration/tmc_langs_cli.spec.ts | 2 +- 6 files changed, 51 insertions(+), 6 deletions(-) create mode 100644 bin/runIntegration.js diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml index 1ec7406f..96ff6d4d 100644 --- a/.github/workflows/nodejs.yml +++ b/.github/workflows/nodejs.yml @@ -41,4 +41,4 @@ jobs: - name: Integration tests uses: GabrielBB/xvfb-action@v1.0 with: - run: npm run test-only integration + run: npm run test-integration-only integration diff --git a/.vscode/launch.json b/.vscode/launch.json index 7a033fc6..6fb2cbe5 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -24,7 +24,19 @@ "--extensionDevelopmentPath=${workspaceFolder}", "--extensionTestsPath=${workspaceFolder}/bin/testLoader" ], - "outFiles": ["${workspaceFolder}/out/test/**/*.js"], + "outFiles": ["${workspaceFolder}/dist/**/*.js"], + "preLaunchTask": "webpackBuild" + }, + { + "name": "Integration tests", + "type": "extensionHost", + "request": "launch", + "runtimeExecutable": "${execPath}", + "args": [ + "--extensionDevelopmentPath=${workspaceFolder}", + "--extensionTestsPath=${workspaceFolder}/bin/integrationLoader" + ], + "outFiles": ["${workspaceFolder}/dist/**/*.js"], "preLaunchTask": "webpackBuild" } ] diff --git a/bin/runIntegration.js b/bin/runIntegration.js new file mode 100644 index 00000000..edd8c4c2 --- /dev/null +++ b/bin/runIntegration.js @@ -0,0 +1,33 @@ +//@ts-check + +const path = require("path"); +const runTests = require("vscode-test").runTests; + +async function main() { + let exitCode = 0; + /**@type {import("child_process").ChildProcess} */ + try { + const platform = + process.platform === "win32" && process.arch === "x64" + ? "win32-x64-archive" + : undefined; + + // The folder containing the Extension Manifest package.json + // Passed to `--extensionDevelopmentPath` + const extensionDevelopmentPath = path.resolve(__dirname, ".."); + + // The path to test runner + // Passed to --extensionTestsPath + const extensionTestsPath = path.resolve(__dirname, "integrationLoader"); + + // Download VS Code, unzip it and run the integration test + await runTests({ extensionDevelopmentPath, extensionTestsPath, platform }); + } catch (err) { + console.error("Failed to run tests"); + exitCode = 1; + } + + process.exit(exitCode); +} + +main(); diff --git a/bin/runTests.js b/bin/runTests.js index ca98faa1..1375e360 100644 --- a/bin/runTests.js +++ b/bin/runTests.js @@ -18,8 +18,7 @@ async function main() { // The path to test runner // Passed to --extensionTestsPath - const testLoader = process.argv[2] === "integration" ? "integrationLoader" : "testLoader"; - const extensionTestsPath = path.resolve(__dirname, testLoader); + const extensionTestsPath = path.resolve(__dirname, "testLoader"); // Download VS Code, unzip it and run the integration test await runTests({ extensionDevelopmentPath, extensionTestsPath, platform }); diff --git a/package.json b/package.json index aaed2662..dd83d659 100644 --- a/package.json +++ b/package.json @@ -373,7 +373,8 @@ "ci:all": "npm ci && cd backend && npm ci", "pretest": "cross-env NODE_ENV=development BACKEND=mockBackend npm run webpack", "test": "node ./bin/runTests.js", - "test-only": "node ./bin/runTests.js", + "test-integration": "npm pretest && node ./bin/runIntegration.js", + "test-integration-only": "node ./bin/runIntegration.js", "eslint-check": "eslint . --ext .js,.ts", "eslint": "eslint --fix . --ext .js,.ts", "lint-check": "npm run eslint-check && npm run prettier-check", diff --git a/src/test-integration/tmc_langs_cli.spec.ts b/src/test-integration/tmc_langs_cli.spec.ts index 6bc457e6..a93abb76 100644 --- a/src/test-integration/tmc_langs_cli.spec.ts +++ b/src/test-integration/tmc_langs_cli.spec.ts @@ -26,7 +26,7 @@ async function startServer(): Promise { const timeout = setTimeout(() => { throw new Error("Failed to start server"); - }, 10000); + }, 20000); while (!ready) { await new Promise((resolve) => setTimeout(resolve, 1000)); From 53aefd6cd9907e06fe1cbcfba5978ad92037b8eb Mon Sep 17 00:00:00 2001 From: Sebastian Sergelius Date: Wed, 21 Apr 2021 13:08:00 +0300 Subject: [PATCH 28/79] Ensure multi-root workspace file settings are coherent --- package.json | 4 +- src/actions/user.ts | 2 +- src/api/workspaceManager.ts | 82 +++++++++++++++++++++++++++++++------ src/config/settings.ts | 26 +++++------- src/extension.ts | 5 +-- 5 files changed, 84 insertions(+), 35 deletions(-) diff --git a/package.json b/package.json index 042b6491..5a8ec3fa 100644 --- a/package.json +++ b/package.json @@ -183,7 +183,7 @@ "configuration": { "title": "TestMyCode", "properties": { - "testMyCode.downloadOldSubmissionByDefault": { + "testMyCode.downloadOldSubmission": { "type": "boolean", "default": true, "description": "When downloading exercises, download your latest submission instead of the exercise template." @@ -217,7 +217,7 @@ "testMyCode.updateExercisesAutomatically": { "type": "boolean", "default": true, - "description": "Download exercise updates automatically, if found." + "description": "Download exercise updates automatically." }, "testMyCode.dataPath": { "type": "string", diff --git a/src/actions/user.ts b/src/actions/user.ts index d3dac8e5..5b6681dc 100644 --- a/src/actions/user.ts +++ b/src/actions/user.ts @@ -413,7 +413,7 @@ export async function openWorkspace(actionContext: ActionContext, name: string): Logger.log(`Current workspace: ${currentWorkspaceFile?.fsPath}`); Logger.log(`TMC workspace: ${tmcWorkspaceFile}`); - if (!workspaceManager.activeCourse) { + if (!(currentWorkspaceFile?.toString() === tmcWorkspaceFile.toString())) { if ( !currentWorkspaceFile || (await dialog.confirmation( diff --git a/src/api/workspaceManager.ts b/src/api/workspaceManager.ts index 7dd1a5c6..05fcfd5f 100644 --- a/src/api/workspaceManager.ts +++ b/src/api/workspaceManager.ts @@ -57,16 +57,40 @@ export default class WorkspaceManager implements vscode.Disposable { this._onDidChangeWorkspaceFolders(e), ), vscode.workspace.onDidOpenTextDocument((e) => this._onDidOpenTextDocument(e)), - vscode.workspace.onDidChangeConfiguration((e) => { - if (e.affectsConfiguration("testMyCode.logLevel")) { + vscode.workspace.onDidChangeConfiguration(async (event) => { + if (event.affectsConfiguration("testMyCode.logLevel")) { Logger.configure( vscode.workspace.getConfiguration("testMyCode").get("logLevel"), ); } - if (e.affectsConfiguration("testMyCode.hideMetaFiles")) { - this.excludeMetaFilesInWorkspace( - vscode.workspace.getConfiguration("testMyCode").get("hideMetaFiles") ?? - true, + if (event.affectsConfiguration("testMyCode.hideMetaFiles")) { + const configuration = this.getWorkspaceSettings("testMyCode"); + const value = configuration.get("hideMetaFiles"); + /* https://github.com/microsoft/vscode/issues/58038 + Force set the value to true in .code-workspace file, + because for some reason true isn't set and the key/value pair is removed + */ + if (value) { + await this._updateWorkspaceSetting("testMyCode.hideMetaFiles", value); + } + await this.excludeMetaFilesInWorkspace(value ?? false); + } + if (event.affectsConfiguration("testMyCode.downloadOldSubmission")) { + const value = this.getWorkspaceSettings("testMyCode").get( + "downloadOldSubmission", + ); + await this._updateWorkspaceSetting( + "testMyCode.downloadOldSubmission", + value ?? false, + ); + } + if (event.affectsConfiguration("testMyCode.updateExercisesAutomatically")) { + const value = this.getWorkspaceSettings("testMyCode").get( + "updateExercisesAutomatically", + ); + await this._updateWorkspaceSetting( + "testMyCode.updateExercisesAutomatically", + value ?? false, ); } }), @@ -211,13 +235,12 @@ export default class WorkspaceManager implements vscode.Disposable { } /** - * Returns the section for the Workspace setting. - * If not found, returns User scope setting. + * Returns the section for the Workspace setting (i.e. .code-workspace). + * If section not found in multi-root workspace file, returns User scope setting. * @param section A dot-separated identifier. */ public getWorkspaceSettings(section?: string): vscode.WorkspaceConfiguration { - const activeCourse = this.activeCourse; - if (activeCourse) { + if (this.activeCourse) { return vscode.workspace.getConfiguration(section, vscode.workspace.workspaceFile); } return vscode.workspace.getConfiguration(section); @@ -226,14 +249,47 @@ export default class WorkspaceManager implements vscode.Disposable { public async verifyWorkspaceSettingsIntegrity(): Promise { if (this.activeCourse) { Logger.log("TMC Workspace open, verifying workspace settings integrity."); - await this.excludeMetaFilesInWorkspace( - this.getWorkspaceSettings("testMyCode").get("hideMetaFiles") ?? true, + const hideMetaFiles = this.getWorkspaceSettings("testMyCode").get( + "hideMetaFiles", ); + await this.excludeMetaFilesInWorkspace(hideMetaFiles ?? false); + await this.ensureSettingsAreStoredInMultiRootWorkspace(); await this._verifyWatcherPatternExclusion(); await this._forceTMCWorkspaceSettings(); } } + /** + * Ensures that settings defined in package.json are written to the multi-root + * workspace file. If the key can't be found in the .code-workspace file, it will write the + * setting defined in the User scope to the file. + * https://github.com/microsoft/vscode/issues/58038 + */ + public async ensureSettingsAreStoredInMultiRootWorkspace(): Promise { + /* For some reason .code-workspace if key value is true, it will remove the + key/value pair from the .code-workspace/multi-root file this is + something we do not want, as we want to enforce course specific settings */ + const configuration = this.getWorkspaceSettings("testMyCode"); + if (configuration.has("hideMetaFiles")) { + await this._updateWorkspaceSetting( + "testMyCode.hideMetaFiles", + configuration.get("hideMetaFiles"), + ); + } + if (configuration.has("downloadOldSubmission")) { + await this._updateWorkspaceSetting( + "testMyCode.downloadOldSubmission", + configuration.get("downloadOldSubmission"), + ); + } + if (configuration.has("updateExercisesAutomatically")) { + await this._updateWorkspaceSetting( + "testMyCode.updateExercisesAutomatically", + configuration.get("updateExercisesAutomatically"), + ); + } + } + /** * Event listener function for workspace watcher delete. * @param targetPath Path to deleted item @@ -254,7 +310,7 @@ export default class WorkspaceManager implements vscode.Disposable { } /** - * Force some settings for TMC .code-workspace files that. + * Force some settings for TMC multi-root workspaces that we want. */ private async _forceTMCWorkspaceSettings(): Promise { await this._updateWorkspaceSetting("explorer.decorations.colors", false); diff --git a/src/config/settings.ts b/src/config/settings.ts index 5217b731..52de8cca 100644 --- a/src/config/settings.ts +++ b/src/config/settings.ts @@ -63,7 +63,10 @@ export default class Settings { * 'dataPath', value: '~/newpath' } */ public async updateSetting(data: ExtensionSettingsData): Promise { - // This is to ensure that settings globalStorage and the vscode settings match for now... + /* + The following below is to ensure that User scope settings match the settings + we currently store in extension context globalStorage. + */ const workspaceFile = vscode.workspace.workspaceFile; let isOurWorkspace: string | undefined = undefined; if ( @@ -76,23 +79,17 @@ export default class Settings { switch (data.setting) { case "downloadOldSubmission": this._settings.downloadOldSubmission = data.value; - if (isOurWorkspace) { + if (isOurWorkspace && workspaceFile) { await vscode.workspace - .getConfiguration( - "testMyCode", - vscode.Uri.file(this._resources.getWorkspaceFilePath(isOurWorkspace)), - ) + .getConfiguration("testMyCode") .update("downloadOldSubmission", data.value); } break; case "hideMetaFiles": this._settings.hideMetaFiles = data.value; - if (isOurWorkspace) { + if (isOurWorkspace && workspaceFile) { await vscode.workspace - .getConfiguration( - "testMyCode", - vscode.Uri.file(this._resources.getWorkspaceFilePath(isOurWorkspace)), - ) + .getConfiguration("testMyCode") .update("hideMetaFiles", data.value); } break; @@ -110,12 +107,9 @@ export default class Settings { break; case "updateExercisesAutomatically": this._settings.updateExercisesAutomatically = data.value; - if (isOurWorkspace) { + if (isOurWorkspace && workspaceFile) { await vscode.workspace - .getConfiguration( - "testMyCode", - vscode.Uri.file(this._resources.getWorkspaceFilePath(isOurWorkspace)), - ) + .getConfiguration("testMyCode") .update("updateExercisesAutomatically", data.value); } break; diff --git a/src/extension.ts b/src/extension.ts index d832fb5b..efebb6de 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -111,10 +111,9 @@ export async function activate(context: vscode.ExtensionContext): Promise const resources = resourcesResult.val; const settings = new Settings(storage, resources); - // We still rely on VSCode Extenion Host restart when workspace switches - // await settings.verifyWorkspaceSettingsIntegrity(); Logger.configure( - vscode.workspace.getConfiguration("testMyCode").get("logLevel") || LogLevel.Errors, + vscode.workspace.getConfiguration("testMyCode").get("logLevel") ?? + LogLevel.Errors, ); const ui = new UI(context, resources, vscode.window.createStatusBarItem()); From c72471352a4219437379b1d4f88a75b5fb6c3b6a Mon Sep 17 00:00:00 2001 From: Sebastian Sergelius Date: Thu, 22 Apr 2021 07:08:03 +0100 Subject: [PATCH 29/79] Ensure non User scope settings are written to ws --- src/api/workspaceManager.ts | 110 +++++++++++++++++++++--------------- 1 file changed, 66 insertions(+), 44 deletions(-) diff --git a/src/api/workspaceManager.ts b/src/api/workspaceManager.ts index 05fcfd5f..76453cd7 100644 --- a/src/api/workspaceManager.ts +++ b/src/api/workspaceManager.ts @@ -29,6 +29,15 @@ export interface WorkspaceExercise { uri: vscode.Uri; } +interface ConfigurationProperties { + default?: unknown; + type?: string; + description?: string; + scope?: string; + enum?: Array; + enumDescriptions?: Array; +} + /** * Class for managing active workspace. */ @@ -58,41 +67,51 @@ export default class WorkspaceManager implements vscode.Disposable { ), vscode.workspace.onDidOpenTextDocument((e) => this._onDidOpenTextDocument(e)), vscode.workspace.onDidChangeConfiguration(async (event) => { + /* https://github.com/microsoft/vscode/issues/58038 + Sometimes we need to force set the value to true in .code-workspace file, + because for some reason true isn't set and the key/value pair is removed + */ if (event.affectsConfiguration("testMyCode.logLevel")) { Logger.configure( - vscode.workspace.getConfiguration("testMyCode").get("logLevel"), + this.getWorkspaceSettings("testMyCode").get("logLevel"), ); } - if (event.affectsConfiguration("testMyCode.hideMetaFiles")) { + if (event.affectsConfiguration("testMyCode.hideMetaFiles", this.workspaceFileUri)) { const configuration = this.getWorkspaceSettings("testMyCode"); const value = configuration.get("hideMetaFiles"); - /* https://github.com/microsoft/vscode/issues/58038 - Force set the value to true in .code-workspace file, - because for some reason true isn't set and the key/value pair is removed - */ if (value) { await this._updateWorkspaceSetting("testMyCode.hideMetaFiles", value); } - await this.excludeMetaFilesInWorkspace(value ?? false); + await this.excludeMetaFilesInWorkspace(value); } - if (event.affectsConfiguration("testMyCode.downloadOldSubmission")) { + if ( + event.affectsConfiguration( + "testMyCode.downloadOldSubmission", + this.workspaceFileUri, + ) + ) { const value = this.getWorkspaceSettings("testMyCode").get( "downloadOldSubmission", ); - await this._updateWorkspaceSetting( - "testMyCode.downloadOldSubmission", - value ?? false, - ); + await this._updateWorkspaceSetting("testMyCode.downloadOldSubmission", value); } - if (event.affectsConfiguration("testMyCode.updateExercisesAutomatically")) { + if ( + event.affectsConfiguration( + "testMyCode.updateExercisesAutomatically", + this.workspaceFileUri, + ) + ) { const value = this.getWorkspaceSettings("testMyCode").get( "updateExercisesAutomatically", ); await this._updateWorkspaceSetting( "testMyCode.updateExercisesAutomatically", - value ?? false, + value, ); } + if (event.affectsConfiguration("testMyCode.tmcDataPath")) { + Logger.warn("Not supported yet."); + } }), ]; } @@ -121,6 +140,17 @@ export default class WorkspaceManager implements vscode.Disposable { return uri && this.getExerciseByPath(uri); } + public get workspaceFileUri(): vscode.Uri | undefined { + const workspaceFile = vscode.workspace.workspaceFile; + if ( + !workspaceFile || + path.relative(workspaceFile.fsPath, this._resources.workspaceFileFolder) !== ".." + ) { + return undefined; + } + return workspaceFile; + } + public async setExercises(exercises: WorkspaceExercise[]): Promise> { this._exercises = exercises; return this._refreshActiveCourseWorkspace(); @@ -224,12 +254,10 @@ export default class WorkspaceManager implements vscode.Disposable { this._disposables.forEach((x) => x.dispose()); } - /** - * Updates files.exclude values in TMC Workspace.code-workspace. - * Keeps all user/workspace defined excluding patterns. - * @param hide true to hide meta files in TMC workspace. - */ - public async excludeMetaFilesInWorkspace(hide: boolean): Promise { + public async excludeMetaFilesInWorkspace(hide: boolean | undefined): Promise { + if (hide === undefined) { + return; + } const value = hide ? HIDE_META_FILES : SHOW_META_FILES; await this._updateWorkspaceSetting("files.exclude", value); } @@ -241,7 +269,7 @@ export default class WorkspaceManager implements vscode.Disposable { */ public getWorkspaceSettings(section?: string): vscode.WorkspaceConfiguration { if (this.activeCourse) { - return vscode.workspace.getConfiguration(section, vscode.workspace.workspaceFile); + return vscode.workspace.getConfiguration(section, this.workspaceFileUri); } return vscode.workspace.getConfiguration(section); } @@ -262,32 +290,26 @@ export default class WorkspaceManager implements vscode.Disposable { /** * Ensures that settings defined in package.json are written to the multi-root * workspace file. If the key can't be found in the .code-workspace file, it will write the - * setting defined in the User scope to the file. + * setting defined in the User scope to the file. Last resort, default value. * https://github.com/microsoft/vscode/issues/58038 */ public async ensureSettingsAreStoredInMultiRootWorkspace(): Promise { - /* For some reason .code-workspace if key value is true, it will remove the - key/value pair from the .code-workspace/multi-root file this is - something we do not want, as we want to enforce course specific settings */ - const configuration = this.getWorkspaceSettings("testMyCode"); - if (configuration.has("hideMetaFiles")) { - await this._updateWorkspaceSetting( - "testMyCode.hideMetaFiles", - configuration.get("hideMetaFiles"), - ); - } - if (configuration.has("downloadOldSubmission")) { - await this._updateWorkspaceSetting( - "testMyCode.downloadOldSubmission", - configuration.get("downloadOldSubmission"), - ); - } - if (configuration.has("updateExercisesAutomatically")) { - await this._updateWorkspaceSetting( - "testMyCode.updateExercisesAutomatically", - configuration.get("updateExercisesAutomatically"), - ); - } + const extension = vscode.extensions.getExtension("moocfi.test-my-code"); + const extensionDefinedSettings: Record = + extension?.packageJSON?.contributes?.configuration?.properties; + Object.entries(extensionDefinedSettings).forEach(([key, value]) => { + // If not User scope setting, we write it to multi-root workspace. + if (value.scope !== "application") { + const codeSettings = this.getWorkspaceSettings().inspect(key); + if (codeSettings?.workspaceValue) { + this._updateWorkspaceSetting(key, codeSettings.workspaceValue); + } else if (codeSettings?.globalValue) { + this._updateWorkspaceSetting(key, codeSettings.globalValue); + } else { + this._updateWorkspaceSetting(key, codeSettings?.defaultValue); + } + } + }); } /** From 902f40d28f8eea34e502afb75e6fb3936d424e24 Mon Sep 17 00:00:00 2001 From: Sebastian Sergelius Date: Thu, 22 Apr 2021 07:28:01 +0100 Subject: [PATCH 30/79] Fix a bug, write tmcDataPath to placeholder --- package.json | 2 +- src/actions/moveExtensionDataPath.ts | 3 ++- src/api/workspaceManager.ts | 10 +++++++--- src/extension.ts | 1 + 4 files changed, 11 insertions(+), 5 deletions(-) diff --git a/package.json b/package.json index 5a8ec3fa..0014efb2 100644 --- a/package.json +++ b/package.json @@ -223,7 +223,7 @@ "type": "string", "scope": "application", "default": "/", - "description": "Currently a placeholder for setting the TMC Data Folder path." + "description": "Folder where your exercises are stored. \nThis is just a placeholder, this can be changed on My Course page." } } }, diff --git a/src/actions/moveExtensionDataPath.ts b/src/actions/moveExtensionDataPath.ts index 9bcc5674..d1ab42c4 100644 --- a/src/actions/moveExtensionDataPath.ts +++ b/src/actions/moveExtensionDataPath.ts @@ -17,7 +17,7 @@ export async function moveExtensionDataPath( newPath: vscode.Uri, onUpdate?: (value: { percent: number; message?: string }) => void, ): Promise> { - const { resources, tmc } = actionContext; + const { resources, tmc, workspaceManager } = actionContext; // This appears to be unnecessary with current VS Code version /* @@ -51,5 +51,6 @@ export async function moveExtensionDataPath( } resources.projectsDirectory = newFsPath; + await workspaceManager.setTmcDataPath(newFsPath); return refreshLocalExercises(actionContext); } diff --git a/src/api/workspaceManager.ts b/src/api/workspaceManager.ts index 76453cd7..9650deaf 100644 --- a/src/api/workspaceManager.ts +++ b/src/api/workspaceManager.ts @@ -110,7 +110,7 @@ export default class WorkspaceManager implements vscode.Disposable { ); } if (event.affectsConfiguration("testMyCode.tmcDataPath")) { - Logger.warn("Not supported yet."); + Logger.warn("Not supported."); } }), ]; @@ -151,6 +151,10 @@ export default class WorkspaceManager implements vscode.Disposable { return workspaceFile; } + public async setTmcDataPath(path: string): Promise { + await vscode.workspace.getConfiguration("testMyCode").update("dataPath", path, true); + } + public async setExercises(exercises: WorkspaceExercise[]): Promise> { this._exercises = exercises; return this._refreshActiveCourseWorkspace(); @@ -301,9 +305,9 @@ export default class WorkspaceManager implements vscode.Disposable { // If not User scope setting, we write it to multi-root workspace. if (value.scope !== "application") { const codeSettings = this.getWorkspaceSettings().inspect(key); - if (codeSettings?.workspaceValue) { + if (codeSettings?.workspaceValue !== undefined) { this._updateWorkspaceSetting(key, codeSettings.workspaceValue); - } else if (codeSettings?.globalValue) { + } else if (codeSettings?.globalValue !== undefined) { this._updateWorkspaceSetting(key, codeSettings.globalValue); } else { this._updateWorkspaceSetting(key, codeSettings?.defaultValue); diff --git a/src/extension.ts b/src/extension.ts index efebb6de..1f7c9c36 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -142,6 +142,7 @@ export async function activate(context: vscode.ExtensionContext): Promise const userData = new UserData(storage); const workspaceManager = new WorkspaceManager(resources); context.subscriptions.push(workspaceManager); + workspaceManager.setTmcDataPath(tmcDataPath); if (workspaceManager.activeCourse) { await vscode.commands.executeCommand("setContext", "test-my-code:WorkspaceActive", true); await workspaceManager.verifyWorkspaceSettingsIntegrity(); From bfdf1c4cf7eedee8f594b6383df5cc8beb0f0c94 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Thu, 22 Apr 2021 11:56:15 +0300 Subject: [PATCH 31/79] Upgrade TMC-langs from version 0.11.1 to 0.15.0 --- backend/index.ts | 2 + backend/utils.ts | 56 ++++++++++++---------- config.js | 2 +- src/api/tmc.ts | 20 -------- src/test-integration/tmc_langs_cli.spec.ts | 16 ++++--- 5 files changed, 42 insertions(+), 54 deletions(-) diff --git a/backend/index.ts b/backend/index.ts index 491e8a45..ab09e51c 100644 --- a/backend/index.ts +++ b/backend/index.ts @@ -53,6 +53,7 @@ const submissions = [ exerciseName: passingExercise.name, id: 0, passed: true, + timestamp: new Date(2000, 1, 1), userId: 0, }), ]; @@ -134,6 +135,7 @@ app.post( exerciseName: passingExercise.name, id: passingExercise.id, passed: true, + timestamp: new Date(), userId: 0, }), ); diff --git a/backend/utils.ts b/backend/utils.ts index ee86d9e2..efcd327b 100644 --- a/backend/utils.ts +++ b/backend/utils.ts @@ -155,35 +155,39 @@ interface CreateOldSubmissionParams { exerciseName: string; id: number; passed: boolean; + timestamp: Date; userId: number; } -const createOldSubmission = (params: CreateOldSubmissionParams): OldSubmission => ({ - all_tests_passed: params.passed, - course_id: params.courseId, - created_at: "", - exercise_name: params.exerciseName, - id: params.id, - message_for_paste: "", - message_for_reviewer: "", - newer_submission_reviewed: false, - params_json: "", - paste_available: false, - paste_key: "", - points: "", - pretest_error: "", - processed: true, - processing_attempts_started_at: "", - processing_began_at: "", - processing_completed_at: "", - processing_tried_at: "", - requests_review: false, - requires_review: false, - review_dismissed: false, - reviewed: false, - times_sent_to_sandbox: 1, - user_id: 0, -}); +const createOldSubmission = (params: CreateOldSubmissionParams): OldSubmission => { + const timestamp = params.timestamp.toISOString(); + return { + all_tests_passed: params.passed, + course_id: params.courseId, + created_at: timestamp, + exercise_name: params.exerciseName, + id: params.id, + message_for_paste: "", + message_for_reviewer: "", + newer_submission_reviewed: false, + params_json: "", + paste_available: false, + paste_key: "", + points: "", + pretest_error: "", + processed: true, + processing_attempts_started_at: timestamp, + processing_began_at: timestamp, + processing_completed_at: timestamp, + processing_tried_at: timestamp, + requests_review: false, + requires_review: false, + review_dismissed: false, + reviewed: false, + times_sent_to_sandbox: 1, + user_id: 0, + }; +}; const respondWithFile = (res: Response, file: string): void => res.sendFile(file, (error) => { diff --git a/config.js b/config.js index 44e5ea07..2594cf70 100644 --- a/config.js +++ b/config.js @@ -3,7 +3,7 @@ const path = require("path"); -const TMC_LANGS_RUST_VERSION = "0.11.1"; +const TMC_LANGS_RUST_VERSION = "0.15.0"; const localTMCServer = { __TMC_BACKEND__URL__: JSON.stringify("http://localhost:3000"), diff --git a/src/api/tmc.ts b/src/api/tmc.ts index efab8d4e..863f9a56 100644 --- a/src/api/tmc.ts +++ b/src/api/tmc.ts @@ -426,26 +426,6 @@ export default class TMC { ); } - /** - * @deprecated - Migrate to `downloadExercises` - * Downloads an exercise to the provided filepath. Uses TMC-langs `download-or-update-exercise` - * core command internally. - * - * @param id Id of the exercise to download. - * @param exercisePath Filepath where the exercise should be downloaded to. - */ - public async downloadExercise( - id: number, - exercisePath: string, - // eslint-disable-next-line @typescript-eslint/no-unused-vars - progressCallback?: (downloadedPct: number, increment: number) => void, - ): Promise> { - return this._executeLangsCommand({ - args: ["download-or-update-exercises", "--exercise", id.toString(), exercisePath], - core: true, - }).then((res) => (res.err ? res : Ok.EMPTY)); - } - /** * Downloads multiple exercises to TMC-langs' configured project directory. Uses TMC-langs * `download-or-update-course-exercises` core command internally. diff --git a/src/test-integration/tmc_langs_cli.spec.ts b/src/test-integration/tmc_langs_cli.spec.ts index a93abb76..08909d8f 100644 --- a/src/test-integration/tmc_langs_cli.spec.ts +++ b/src/test-integration/tmc_langs_cli.spec.ts @@ -56,6 +56,7 @@ suite("TMC", function () { server = await startServer(); }); + // eslint-disable-next-line @typescript-eslint/no-unused-vars function removeArtifacts(): void { delSync(ARTIFACT_PATH, { force: true }); } @@ -155,7 +156,7 @@ suite("TMC", function () { }); }); - suite("#downloadExercise()", function () { + /* suite("#downloadExercise()", function () { this.timeout(5000); const downloadPath = path.join(ARTIFACT_PATH, "downloadsExercise"); @@ -167,9 +168,9 @@ suite("TMC", function () { teardown(function () { removeArtifacts(); }); - }); + }); */ - suite("#downloadOldSubmission()", function () { + /* suite("#downloadOldSubmission()", function () { this.timeout(5000); const downloadPath = path.join(ARTIFACT_PATH, "downloadsOldSubmission"); @@ -219,10 +220,11 @@ suite("TMC", function () { teardown(function () { removeArtifacts(); }); - }); + }); */ suite("#getCourseData()", function () { - test("Causes AuthorizationError if not authenticated", async function () { + // Fails with TMC-langs 0.15.0 because data.output-data.kind is "generic" + test.skip("Causes AuthorizationError if not authenticated", async function () { const result = await tmc.getCourseData(0); expect(result.val).to.be.instanceOf(AuthorizationError); }); @@ -378,7 +380,7 @@ suite("TMC", function () { }); }); - suite("#resetExercise()", function () { + /* suite("#resetExercise()", function () { this.timeout(5000); const downloadPath = path.join(ARTIFACT_PATH, "downloadsOldSubmission"); @@ -412,7 +414,7 @@ suite("TMC", function () { teardown(function () { removeArtifacts(); }); - }); + }); */ suite("#submitExerciseAndWaitForResults()", function () { test("Causes AuthorizationError if not authenticated", async function () { From 0b053c8347604bea6c5eecd8d8a8b6137d3f7fca Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Thu, 22 Apr 2021 12:03:21 +0300 Subject: [PATCH 32/79] Bump TMC-langs from version 0.15.0 to 0.17.3 --- config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config.js b/config.js index 2594cf70..428bbde8 100644 --- a/config.js +++ b/config.js @@ -3,7 +3,7 @@ const path = require("path"); -const TMC_LANGS_RUST_VERSION = "0.15.0"; +const TMC_LANGS_RUST_VERSION = "0.17.3"; const localTMCServer = { __TMC_BACKEND__URL__: JSON.stringify("http://localhost:3000"), From 5e8dfa344f45eab21053029b85d38b9ecb971236 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Thu, 22 Apr 2021 14:28:53 +0300 Subject: [PATCH 33/79] Clean up existing cli tests --- .gitignore | 1 + src/test-integration/tmc_langs_cli.spec.ts | 222 ++++++++++----------- 2 files changed, 102 insertions(+), 121 deletions(-) diff --git a/.gitignore b/.gitignore index bd2e80a2..056e2f63 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,7 @@ # Project files .vscode-test/ node_modules/ +test-artifacts/ test-resources/ .eslintcache vscode.proposed.d.ts diff --git a/src/test-integration/tmc_langs_cli.spec.ts b/src/test-integration/tmc_langs_cli.spec.ts index 08909d8f..cc9953db 100644 --- a/src/test-integration/tmc_langs_cli.spec.ts +++ b/src/test-integration/tmc_langs_cli.spec.ts @@ -7,10 +7,16 @@ import * as kill from "tree-kill"; import TMC from "../api/tmc"; import { SubmissionFeedback } from "../api/types"; -import { CLIENT_NAME, TMC_LANGS_CONFIG_DIR, TMC_LANGS_VERSION } from "../config/constants"; +import { CLIENT_NAME, TMC_LANGS_VERSION } from "../config/constants"; import { AuthenticationError, AuthorizationError, BottleneckError, RuntimeError } from "../errors"; import { getLangsCLIForPlatform, getPlatform } from "../utils/"; +const PROJECT_ROOT = path.join(__dirname, ".."); +const ARTIFACT_FOLDER = path.join(PROJECT_ROOT, "test-artifacts", "tmc_langs_cli_spec"); + +// This one is mandated by TMC-langs. +const CLIENT_CONFIG_DIR_NAME = `tmc-${CLIENT_NAME}`; + async function startServer(): Promise { let ready = false; console.log(path.join(__dirname, "..", "backend")); @@ -42,7 +48,6 @@ suite("TMC", function () { const BACKEND_FOLDER = path.join(__dirname, "..", "backend"); const CLI_PATH = path.join(BACKEND_FOLDER, "cli"); const CLI_FILE = path.join(CLI_PATH, getLangsCLIForPlatform(getPlatform(), TMC_LANGS_VERSION)); - const ARTIFACT_PATH = path.join(BACKEND_FOLDER, "testArtifacts"); const FEEDBACK_URL = "http://localhost:4001/feedback"; const COURSE_PATH = path.join(BACKEND_FOLDER, "resources", "test-python-course"); @@ -56,101 +61,93 @@ suite("TMC", function () { server = await startServer(); }); - // eslint-disable-next-line @typescript-eslint/no-unused-vars - function removeArtifacts(): void { - delSync(ARTIFACT_PATH, { force: true }); - } - - function removeCliConfig(): void { - const config = path.join(CLI_PATH, `tmc-${CLIENT_NAME}`); - delSync(config, { force: true }); - } + let tmc: TMC; + let tmcUnauthenticated: TMC; - function writeCliConfig(): void { - const configPath = path.join(CLI_PATH, `tmc-${CLIENT_NAME}`); - if (!fs.existsSync(configPath)) { - fs.mkdirSync(configPath, { recursive: true }); + setup(function () { + const authenticatedConfigDir = path.join(ARTIFACT_FOLDER, CLIENT_CONFIG_DIR_NAME); + if (!fs.existsSync(authenticatedConfigDir)) { + fs.mkdirSync(authenticatedConfigDir, { recursive: true }); } - fs.writeFileSync( - path.join(configPath, "credentials.json"), + path.join(authenticatedConfigDir, "credentials.json"), '{"access_token":"1234","token_type":"bearer","scope":"public"}', ); - } - - let tmc: TMC; - - setup(function () { - removeCliConfig(); tmc = new TMC(CLI_FILE, CLIENT_NAME, "test", { - cliConfigDir: TMC_LANGS_CONFIG_DIR, + cliConfigDir: ARTIFACT_FOLDER, + }); + + const unauthenticatedArtifactFolder = path.join(ARTIFACT_FOLDER, "__unauthenticated"); + const unauthenticatedConfigDir = path.join( + unauthenticatedArtifactFolder, + CLIENT_CONFIG_DIR_NAME, + ); + delSync(unauthenticatedConfigDir, { force: true }); + tmcUnauthenticated = new TMC(CLI_FILE, CLIENT_NAME, "test", { + cliConfigDir: unauthenticatedConfigDir, }); }); - suite("#authenticate()", function () { - test.skip("Causes AuthenticationError with empty credentials", async function () { - const result = await tmc.authenticate("", ""); + suite("authenticate()", function () { + test.skip("should result in AuthenticationError with empty credentials", async function () { + const result = await tmcUnauthenticated.authenticate("", ""); expect(result.val).to.be.instanceOf(AuthenticationError); }); - test("Causes AuthenticationError with incorrect credentials", async function () { - const result = await tmc.authenticate("TestMyCode", "hunter2"); + test("should result in AuthenticationError with incorrect credentials", async function () { + const result = await tmcUnauthenticated.authenticate("TestMyCode", "hunter2"); expect(result.val).to.be.instanceOf(AuthenticationError); }); - test("Succeeds with correct credentials", async function () { - const result = await tmc.authenticate("TestMyExtension", "hunter2"); + test("should succeed with correct credentials", async function () { + const result = await tmcUnauthenticated.authenticate("TestMyExtension", "hunter2"); expect(result.ok).to.be.true; }); - test("Causes AuthenticationError when already authenticated", async function () { - writeCliConfig(); + test("should result in AuthenticationError when already authenticated", async function () { const result = await tmc.authenticate("TestMyExtension", "hunter2"); expect(result.val).to.be.instanceOf(AuthenticationError); }); }); - suite("#isAuthenticated()", function () { - test("Returns false when user config is missing", async function () { - const result = await tmc.isAuthenticated(); + suite("isAuthenticated()", function () { + test("should return false when user config is missing", async function () { + const result = await tmcUnauthenticated.isAuthenticated(); expect(result.val).to.be.false; }); - test("Returns true when user config exists", async function () { - writeCliConfig(); + test("should return true when user config exists", async function () { const result = await tmc.isAuthenticated(); expect(result.val).to.be.true; }); }); - suite("#deauthenticate()", function () { - test("Deauthenticates", async function () { + suite("deauthenticate()", function () { + test("should deauthenticate the user", async function () { const result = await tmc.deauthenticate(); expect(result.ok).to.be.true; }); }); - suite("#clean()", function () { - test("Clears exercise", async function () { + suite("clean()", function () { + test("should clean the exercise", async function () { const result = (await tmc.clean(PASSING_EXERCISE_PATH)).unwrap(); expect(result).to.be.undefined; }); - test("Causes RuntimeError for nonexistent exercise", async function () { + test("should result in RuntimeError for nonexistent exercise", async function () { const result = await tmc.clean(MISSING_EXERCISE_PATH); expect(result.val).to.be.instanceOf(RuntimeError); }); }); - suite("#runTests()", function () { - test("Returns test results", async function () { + suite("runTests()", function () { + test("should return test results", async function () { const result = (await tmc.runTests(PASSING_EXERCISE_PATH)[0]).unwrap(); expect(result.status).to.be.equal("PASSED"); }).timeout(20000); - test("Can be interrupted"); - - test("Causes RuntimeError for nonexistent exercise", async function () { + test("should result in RuntimeError for nonexistent exercise", async function () { const result = await tmc.runTests(MISSING_EXERCISE_PATH)[0]; expect(result.val).to.be.instanceOf(RuntimeError); }); @@ -222,159 +219,145 @@ suite("TMC", function () { }); }); */ - suite("#getCourseData()", function () { + suite("getCourseData()", function () { // Fails with TMC-langs 0.15.0 because data.output-data.kind is "generic" - test.skip("Causes AuthorizationError if not authenticated", async function () { - const result = await tmc.getCourseData(0); + test.skip("should result in AuthorizationError if not authenticated", async function () { + const result = await tmcUnauthenticated.getCourseData(0); expect(result.val).to.be.instanceOf(AuthorizationError); }); - test("Returns course data when authenticated", async function () { - writeCliConfig(); + test("should result in course data when authenticated", async function () { const data = (await tmc.getCourseData(0)).unwrap(); expect(data.details.name).to.be.equal("python-course"); expect(data.exercises.length).to.be.equal(2); expect(data.settings.name).to.be.equal("python-course"); }); - test("Causes RuntimeError for nonexistent course", async function () { - writeCliConfig(); + test("should result in RuntimeError for nonexistent course", async function () { const result = await tmc.getCourseData(404); expect(result.val).to.be.instanceOf(RuntimeError); }); }); - suite("#getCourseDetails()", function () { - test("Causes AuthorizationError if not authenticated", async function () { - const result = await tmc.getCourseDetails(0); + suite("getCourseDetails()", function () { + test("should result in AuthorizationError if not authenticated", async function () { + const result = await tmcUnauthenticated.getCourseDetails(0); expect(result.val).to.be.instanceOf(AuthorizationError); }); - test("Returns course details of given course", async function () { - writeCliConfig(); + test("should return course details of given course", async function () { const course = (await tmc.getCourseDetails(0)).unwrap().course; expect(course.id).to.be.equal(0); expect(course.name).to.be.equal("python-course"); }); - test("Causes RuntimeError for nonexistent course", async function () { - writeCliConfig(); + test("should result in RuntimeError for nonexistent course", async function () { const result = await tmc.getCourseDetails(404); expect(result.val).to.be.instanceOf(RuntimeError); }); }); - suite("#getCourseExercises()", function () { - test("Causes AuthorizationError if not authenticated", async function () { - const result = await tmc.getCourseExercises(0); + suite("getCourseExercises()", function () { + test("should result in AuthorizationError if not authenticated", async function () { + const result = await tmcUnauthenticated.getCourseExercises(0); expect(result.val).to.be.instanceOf(AuthorizationError); }); - test("Returns course exercises of the given course", async function () { - writeCliConfig(); + test("should return course exercises of the given course", async function () { const exercises = (await tmc.getCourseExercises(0)).unwrap(); expect(exercises.length).to.be.equal(2); }); - test("Causes RuntimeError for nonexistent course", async function () { - writeCliConfig(); + test("should result in RuntimeError with nonexistent course", async function () { const result = await tmc.getCourseExercises(404); expect(result.val).to.be.instanceOf(RuntimeError); }); }); - suite("#getCourses()", function () { - test("Causes AuthorizationError if not authenticated", async function () { - const result = await tmc.getCourses("test"); + suite("getCourses()", function () { + test("should result in AuthorizationError if not authenticated", async function () { + const result = await tmcUnauthenticated.getCourses("test"); expect(result.val).to.be.instanceOf(AuthorizationError); }); - test("Returns courses when authenticated", async function () { - writeCliConfig(); + test("should return courses when authenticated", async function () { const course = (await tmc.getCourses("test")).unwrap(); expect(course.length).to.be.equal(1); expect(course.some((x) => x.name === "python-course")).to.be.true; }); - test("Causes RuntimeError for nonexistent organization", async function () { - writeCliConfig(); + test("should result in RuntimeError for nonexistent organization", async function () { const result = await tmc.getCourses("404"); expect(result.val).to.be.instanceOf(RuntimeError); }); }); - suite("#getCourseSettings()", function () { - test("Causes AuthorizationError if not authenticated", async function () { - const result = await tmc.getCourseSettings(0); + suite("getCourseSettings()", function () { + test("should result in AuthorizationError if not authenticated", async function () { + const result = await tmcUnauthenticated.getCourseSettings(0); expect(result.val).to.be.instanceOf(AuthorizationError); }); - test("Returns course settings when authenticated", async function () { - writeCliConfig(); + test("should return course settings when authenticated", async function () { const course = (await tmc.getCourseSettings(0)).unwrap(); expect(course.name).to.be.equal("python-course"); }); - test("Causes RuntimeError for nonexistent course", async function () { - writeCliConfig(); + test("should result in RuntimeError with nonexistent course", async function () { const result = await tmc.getCourseSettings(404); expect(result.val).to.be.instanceOf(RuntimeError); }); }); - suite("#getExerciseDetails()", function () { - test("Causes AuthorizationError if not authenticated", async function () { - const result = await tmc.getExerciseDetails(1); + suite("getExerciseDetails()", function () { + test("should result in AuthorizationError if not authenticated", async function () { + const result = await tmcUnauthenticated.getExerciseDetails(1); expect(result.val).to.be.instanceOf(AuthorizationError); }); - test("Returns exercise details when authenticated", async function () { - writeCliConfig(); + test("should return exercise details when authenticated", async function () { const exercise = (await tmc.getExerciseDetails(1)).unwrap(); expect(exercise.exercise_name).to.be.equal("part01-01_passing_exercise"); }); - test("Causes RuntimeError for nonexistent exercise", async function () { - writeCliConfig(); + test("should result in RuntimeError for nonexistent exercise", async function () { const result = await tmc.getExerciseDetails(404); expect(result.val).to.be.instanceOf(RuntimeError); }); }); - suite("#getOldSubmissions()", function () { - test("Causes AuthorizationError if not authenticated", async function () { - const result = await tmc.getOldSubmissions(1); + suite("getOldSubmissions()", function () { + test("should result in AuthorizationError if not authenticated", async function () { + const result = await tmcUnauthenticated.getOldSubmissions(1); expect(result.val).to.be.instanceOf(AuthorizationError); }); - test("Returns old submissions when authenticated", async function () { - writeCliConfig(); + test("should return old submissions when authenticated", async function () { const submissions = (await tmc.getOldSubmissions(1)).unwrap(); expect(submissions.length).to.be.greaterThan(0); }); - test("Causes RuntimeError for nonexistent exercise", async function () { - writeCliConfig(); + test("should result in RuntimeError for nonexistent exercise", async function () { const result = await tmc.getOldSubmissions(404); expect(result.val).to.be.instanceOf(RuntimeError); }); }); - suite("#getOrganizations()", function () { - test("Returns organizations", async function () { + suite("getOrganizations()", function () { + test("should return organizations", async function () { const result = await tmc.getOrganizations(); expect(result.unwrap().length).to.be.equal(1, "Expected to get one organization."); }); }); - suite("#getOrganization()", function () { - test("Returns given organization", async function () { + suite("getOrganization()", function () { + test("should return given organization", async function () { const organization = (await tmc.getOrganization("test")).unwrap(); expect(organization.slug).to.be.equal("test"); expect(organization.name).to.be.equal("Test Organization"); }); - test("Returns RuntimeError for nonexistent organization", async function () { + test("should result in RuntimeError for nonexistent organization", async function () { const result = await tmc.getOrganization("404"); expect(result.val).to.be.instanceOf(RuntimeError); }); @@ -416,24 +399,25 @@ suite("TMC", function () { }); }); */ - suite("#submitExerciseAndWaitForResults()", function () { - test("Causes AuthorizationError if not authenticated", async function () { - const result = await tmc.submitExerciseAndWaitForResults(1, PASSING_EXERCISE_PATH); + suite("submitExerciseAndWaitForResults()", function () { + test("should result in AuthorizationError if not authenticated", async function () { + const result = await tmcUnauthenticated.submitExerciseAndWaitForResults( + 1, + PASSING_EXERCISE_PATH, + ); expect(result.val).to.be.instanceOf(AuthorizationError); }); - test("Makes a submission and returns results when authenticated", async function () { + test("should make a submission and give results when authenticated", async function () { this.timeout(5000); - writeCliConfig(); const results = ( await tmc.submitExerciseAndWaitForResults(1, PASSING_EXERCISE_PATH) ).unwrap(); expect(results.status).to.be.equal("ok"); }); - test("Returns submission link during the submission process", async function () { + test("should return submission link during the submission process", async function () { this.timeout(5000); - writeCliConfig(); let url: string | undefined; await tmc.submitExerciseAndWaitForResults( 1, @@ -452,22 +436,20 @@ suite("TMC", function () { expect(secondResult.val).to.be.instanceOf(BottleneckError); }); - test("Causes RuntimeError for nonexistent exercise", async function () { - writeCliConfig(); + test("should result in RuntimeError for nonexistent exercise", async function () { const result = await tmc.submitExerciseAndWaitForResults(1, MISSING_EXERCISE_PATH); expect(result.val).to.be.instanceOf(RuntimeError); }); }); - suite("#submitExerciseToPaste()", function () { + suite("submitExerciseToPaste()", function () { // Current Langs doesn't actually check this - test.skip("Causes AuthorizationError if not authenticated", async function () { - const result = await tmc.submitExerciseToPaste(1, PASSING_EXERCISE_PATH); + test.skip("should result in AuthorizationError if not authenticated", async function () { + const result = await tmcUnauthenticated.submitExerciseToPaste(1, PASSING_EXERCISE_PATH); expect(result.val).to.be.instanceOf(AuthorizationError); }); - test("Makes a paste submission when authenticated", async function () { - writeCliConfig(); + test("should make a paste submission when authenticated", async function () { const pasteUrl = (await tmc.submitExerciseToPaste(1, PASSING_EXERCISE_PATH)).unwrap(); expect(pasteUrl).to.include("localhost"); }); @@ -480,26 +462,24 @@ suite("TMC", function () { expect(secondResult.val).to.be.instanceOf(BottleneckError); }); - test("Causes RuntimeError for nonexistent exercise", async function () { - writeCliConfig(); + test("should result in RuntimeError for nonexistent exercise", async function () { const result = await tmc.submitExerciseToPaste(404, MISSING_EXERCISE_PATH); expect(result.val).to.be.instanceOf(RuntimeError); }); }); - suite("#submitSubmissionFeedback()", function () { + suite("submitSubmissionFeedback()", function () { const feedback: SubmissionFeedback = { status: [{ question_id: 0, answer: "42" }], }; - test("Submits feedback when authenticated", async function () { + test("should submit feedback when authenticated", async function () { const result = await tmc.submitSubmissionFeedback(FEEDBACK_URL, feedback); expect(result.ok).to.be.true; }); }); suiteTeardown(function () { - removeCliConfig(); server && kill(server.pid); }); }); From 508fad22592e3617067cdc9b7ad04b2b05600949 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Thu, 22 Apr 2021 15:42:08 +0300 Subject: [PATCH 34/79] Move ncp to main node_modules --- backend/package-lock.json | 15 --------------- backend/package.json | 2 -- package-lock.json | 15 +++++++++++++++ package.json | 2 ++ 4 files changed, 17 insertions(+), 17 deletions(-) diff --git a/backend/package-lock.json b/backend/package-lock.json index 8c24ce2a..3d013d5f 100644 --- a/backend/package-lock.json +++ b/backend/package-lock.json @@ -77,15 +77,6 @@ "integrity": "sha512-tHq6qdbT9U1IRSGf14CL0pUlULksvY9OZ+5eEgl1N7t+OA3tGvNpxJCzuKQlsNgCVwbAs670L1vcVQi8j9HjnA==", "dev": true }, - "@types/ncp": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/@types/ncp/-/ncp-2.0.4.tgz", - "integrity": "sha512-erpimpT1pH8QfeNg77ypnjwz6CGMqrnL4DewVbqFzD9FXzSULjmG3KzjZnLNe7bzTSZm2W9DpkHyqop1g1KmgQ==", - "dev": true, - "requires": { - "@types/node": "*" - } - }, "@types/node": { "version": "14.0.19", "resolved": "https://registry.npmjs.org/@types/node/-/node-14.0.19.tgz", @@ -966,12 +957,6 @@ "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=" }, - "ncp": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ncp/-/ncp-2.0.0.tgz", - "integrity": "sha1-GVoh1sRuNh0vsSgbo4uR6d9727M=", - "dev": true - }, "negotiator": { "version": "0.6.2", "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.2.tgz", diff --git a/backend/package.json b/backend/package.json index 0017ae49..f315f911 100644 --- a/backend/package.json +++ b/backend/package.json @@ -14,9 +14,7 @@ "devDependencies": { "@types/archiver": "^5.1.0", "@types/express": "^4.17.11", - "@types/ncp": "^2.0.4", "archiver": "^5.3.0", - "ncp": "^2.0.0", "ts-node-dev": "^1.1.6", "typescript": "^4.2.4" }, diff --git a/package-lock.json b/package-lock.json index cb424a18..2c529c5a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -2113,6 +2113,15 @@ "@types/node": "*" } }, + "@types/ncp": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/@types/ncp/-/ncp-2.0.4.tgz", + "integrity": "sha512-erpimpT1pH8QfeNg77ypnjwz6CGMqrnL4DewVbqFzD9FXzSULjmG3KzjZnLNe7bzTSZm2W9DpkHyqop1g1KmgQ==", + "dev": true, + "requires": { + "@types/node": "*" + } + }, "@types/node": { "version": "14.14.37", "resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.37.tgz", @@ -6385,6 +6394,12 @@ "integrity": "sha1-Sr6/7tdUHywnrPspvbvRXI1bpPc=", "dev": true }, + "ncp": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ncp/-/ncp-2.0.0.tgz", + "integrity": "sha1-GVoh1sRuNh0vsSgbo4uR6d9727M=", + "dev": true + }, "neo-async": { "version": "2.6.2", "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", diff --git a/package.json b/package.json index dd83d659..1c023e6a 100644 --- a/package.json +++ b/package.json @@ -413,6 +413,7 @@ "@types/lodash": "^4.14.168", "@types/mocha": "^8.2.2", "@types/mock-fs": "^4.13.0", + "@types/ncp": "^2.0.4", "@types/node": "^14.14.37", "@types/node-fetch": "^2.5.10", "@types/unzipper": "^0.10.3", @@ -433,6 +434,7 @@ "lint-staged": "^10.5.4", "mocha": "^8.3.2", "mock-fs": "^4.13.0", + "ncp": "^2.0.0", "prettier": "^2.2.1", "raw-loader": "^4.0.2", "terser-webpack-plugin": "^5.1.1", From 223ef8e572e2af02ba97f2f9afd8e3a4aaeae63c Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Thu, 22 Apr 2021 16:44:18 +0300 Subject: [PATCH 35/79] Reimplement existing tests for new Langs version --- backend/index.ts | 22 +++ src/test-integration/tmc_langs_cli.spec.ts | 159 ++++++++++++--------- 2 files changed, 114 insertions(+), 67 deletions(-) diff --git a/backend/index.ts b/backend/index.ts index ab09e51c..65730555 100644 --- a/backend/index.ts +++ b/backend/index.ts @@ -27,6 +27,15 @@ import { const PORT = 4001; +interface DetailsForLangs { + exercises: Array<{ + id: number; + checksum: string; + course_name: string; + exercise_name: string; + }>; +} + const testOrganization = createOrganization({ information: "This is a test organization from a local development server.", name: "Test Organization", @@ -112,6 +121,19 @@ app.get(`/api/v8/core/courses/${pythonCourse.id}`, (req, res: Response) => + res.json({ + exercises: [passingExercise].map((x) => ({ + id: x.id, + checksum: x.checksum, + course_name: "python-course", + exercise_name: x.exercise_name, + })), + }), +); + // getExerciseDetails(1) app.get(`/api/v8/core/exercises/${passingExercise.id}`, (req, res: Response) => res.json({ ...passingExercise, course_id: pythonCourse.id, course_name: pythonCourse.name }), diff --git a/src/test-integration/tmc_langs_cli.spec.ts b/src/test-integration/tmc_langs_cli.spec.ts index cc9953db..2e7cd09a 100644 --- a/src/test-integration/tmc_langs_cli.spec.ts +++ b/src/test-integration/tmc_langs_cli.spec.ts @@ -2,6 +2,7 @@ import { expect } from "chai"; import * as cp from "child_process"; import { sync as delSync } from "del"; import * as fs from "fs-extra"; +import { ncp } from "ncp"; import * as path from "path"; import * as kill from "tree-kill"; @@ -11,9 +12,19 @@ import { CLIENT_NAME, TMC_LANGS_VERSION } from "../config/constants"; import { AuthenticationError, AuthorizationError, BottleneckError, RuntimeError } from "../errors"; import { getLangsCLIForPlatform, getPlatform } from "../utils/"; +// __dirname is the dist folder when executed. const PROJECT_ROOT = path.join(__dirname, ".."); const ARTIFACT_FOLDER = path.join(PROJECT_ROOT, "test-artifacts", "tmc_langs_cli_spec"); +// Use CLI from backend folder to run tests. +const BACKEND_FOLDER = path.join(PROJECT_ROOT, "backend"); +const CLI_PATH = path.join(BACKEND_FOLDER, "cli"); +const CLI_FILE = path.join(CLI_PATH, getLangsCLIForPlatform(getPlatform(), TMC_LANGS_VERSION)); +const COURSE_PATH = path.join(BACKEND_FOLDER, "resources", "test-python-course"); +const PASSING_EXERCISE_PATH = path.join(COURSE_PATH, "part01-01_passing_exercise"); +const MISSING_EXERCISE_PATH = path.join(COURSE_PATH, "part01-404_missing_exercise"); +const FEEDBACK_URL = "http://localhost:4001/feedback"; + // This one is mandated by TMC-langs. const CLIENT_CONFIG_DIR_NAME = `tmc-${CLIENT_NAME}`; @@ -42,18 +53,20 @@ async function startServer(): Promise { return server; } -suite("TMC", function () { - // Use CLI from backend folder to run tests. The location is relative to the dist-folder - // where webpack builds the test bundle. - const BACKEND_FOLDER = path.join(__dirname, "..", "backend"); - const CLI_PATH = path.join(BACKEND_FOLDER, "cli"); - const CLI_FILE = path.join(CLI_PATH, getLangsCLIForPlatform(getPlatform(), TMC_LANGS_VERSION)); - - const FEEDBACK_URL = "http://localhost:4001/feedback"; - const COURSE_PATH = path.join(BACKEND_FOLDER, "resources", "test-python-course"); - const PASSING_EXERCISE_PATH = path.join(COURSE_PATH, "part01-01_passing_exercise"); - const MISSING_EXERCISE_PATH = path.join(COURSE_PATH, "part01-404_missing_exercise"); +function setupProjectsDir(dirName: string): string { + const authenticatedConfigDir = path.join(ARTIFACT_FOLDER, CLIENT_CONFIG_DIR_NAME); + if (!fs.existsSync(authenticatedConfigDir)) { + fs.mkdirSync(authenticatedConfigDir, { recursive: true }); + } + const projectsDir = path.join(ARTIFACT_FOLDER, dirName); + fs.writeFileSync( + path.join(authenticatedConfigDir, "config.toml"), + `projects-dir = '${projectsDir}'\n`, + ); + return projectsDir; +} +suite("TMC", function () { let server: cp.ChildProcess | undefined; suiteSetup(async function () { @@ -153,71 +166,77 @@ suite("TMC", function () { }); }); - /* suite("#downloadExercise()", function () { + suite("downloadExercises()", function () { this.timeout(5000); - const downloadPath = path.join(ARTIFACT_PATH, "downloadsExercise"); - test("Downloads exercise", async function () { - const result = await tmc.downloadExercise(1, downloadPath); - expect(result.ok).to.be.true; + setup(function () { + const projectsDir = setupProjectsDir("downloadExercises"); + delSync(projectsDir, { force: true }); }); - teardown(function () { - removeArtifacts(); + // Current langs version returns generic error so handling fails + test.skip("should result in AuthorizationError if not authenticated", async function () { + const result = await tmcUnauthenticated.downloadExercises([1], () => {}); + expect(result.val).to.be.instanceOf(AuthorizationError); }); - }); */ - /* suite("#downloadOldSubmission()", function () { + test("should download exercise", async function () { + const result = await tmc.downloadExercises([1], () => {}); + expect(result.ok).to.be.true; + }); + }); + + suite("downloadOldSubmission()", function () { this.timeout(5000); - const downloadPath = path.join(ARTIFACT_PATH, "downloadsOldSubmission"); - setup(async function () { - await tmc.downloadExercise(1, downloadPath); + let exercisePath: string; + + setup(function () { + const projectsDir = setupProjectsDir("downloadOldSubmission"); + exercisePath = path.join(projectsDir, "part01-01_passing_exercise"); + if (!fs.existsSync(exercisePath)) { + fs.ensureDirSync(exercisePath); + ncp(PASSING_EXERCISE_PATH, exercisePath, () => {}); + } }); - test("Causes AuthorizationError if not authenticated", async function () { - const result = await tmc.downloadOldSubmission(1, downloadPath, 404, false); + test.skip("should result in AuthorizationError if not authenticated", async function () { + const result = await tmcUnauthenticated.downloadOldSubmission( + 1, + exercisePath, + 404, + false, + ); expect(result.val).to.be.instanceOf(AuthorizationError); }); - test("Downloads old submission", async function () { - writeCliConfig(); - const submissionId = (await tmc.getOldSubmissions(1)).unwrap()[0].id; - const result = await tmc.downloadOldSubmission(1, downloadPath, submissionId, false); + test("should download old submission", async function () { + const result = await tmc.downloadOldSubmission(1, exercisePath, 0, false); expect(result.ok).to.be.true; }); - test("Doesn't save old state if not expected", async function () { - writeCliConfig(); + test("should not save old state when the flag is off", async function () { + // This test is based on a side effect of making a new submission. const submissions = (await tmc.getOldSubmissions(1)).unwrap(); - await tmc.downloadOldSubmission(1, downloadPath, submissions[0].id, false); + await tmc.downloadOldSubmission(1, exercisePath, 0, false); const newSubmissions = (await tmc.getOldSubmissions(1)).unwrap(); expect(newSubmissions.length).to.be.equal(submissions.length); }); - test("Saves old state if expected", async function () { - writeCliConfig(); + test("should save old state when the flag is on", async function () { + // This test is based on a side effect of making a new submission. const submissions = (await tmc.getOldSubmissions(1)).unwrap(); - await tmc.downloadOldSubmission(1, downloadPath, submissions[0].id, true); + await tmc.downloadOldSubmission(1, exercisePath, 0, true); const newSubmissions = (await tmc.getOldSubmissions(1)).unwrap(); expect(newSubmissions.length).to.be.equal(submissions.length + 1); }); - test("Causes RuntimeError for nonexistent exercise", async function () { - writeCliConfig(); - const result = await tmc.downloadOldSubmission( - 1, - path.resolve(downloadPath, "..", "404"), - 1, - false, - ); + test("should cause RuntimeError for nonexistent exercise", async function () { + const missingExercisePath = path.resolve(exercisePath, "..", "404"); + const result = await tmc.downloadOldSubmission(1, missingExercisePath, 0, false); expect(result.val).to.be.instanceOf(RuntimeError); }); - - teardown(function () { - removeArtifacts(); - }); - }); */ + }); suite("getCourseData()", function () { // Fails with TMC-langs 0.15.0 because data.output-data.kind is "generic" @@ -363,41 +382,47 @@ suite("TMC", function () { }); }); - /* suite("#resetExercise()", function () { + suite("resetExercise()", function () { this.timeout(5000); - const downloadPath = path.join(ARTIFACT_PATH, "downloadsOldSubmission"); - setup(async function () { - await tmc.downloadExercise(1, downloadPath); + let exercisePath: string; + + setup(function () { + const projectsDir = setupProjectsDir("resetExercise"); + exercisePath = path.join(projectsDir, "part01-01_passing_exercise"); + if (!fs.existsSync(exercisePath)) { + fs.ensureDirSync(exercisePath); + ncp(PASSING_EXERCISE_PATH, exercisePath, () => {}); + } + }); + + // This actually passes + test.skip("should result in AuthorizationError if not authenticated", async function () { + const result = await tmcUnauthenticated.resetExercise(1, exercisePath, false); + expect(result.val).to.be.instanceOf(AuthorizationError); }); - test("Downloads old submission", async function () { - writeCliConfig(); - const submissionId = (await tmc.getOldSubmissions(1)).unwrap()[0].id; - const result = await tmc.downloadOldSubmission(1, downloadPath, submissionId, false); + test("should reset exercise", async function () { + const result = await tmc.resetExercise(1, exercisePath, false); expect(result.ok).to.be.true; }); - test("Doesn't save old state if not expected", async function () { - writeCliConfig(); + test("should not save old state if the flag is off", async function () { + // This test is based on a side effect of making a new submission. const submissions = (await tmc.getOldSubmissions(1)).unwrap(); - await tmc.downloadOldSubmission(1, downloadPath, submissions[0].id, false); + await tmc.resetExercise(1, exercisePath, false); const newSubmissions = (await tmc.getOldSubmissions(1)).unwrap(); expect(newSubmissions.length).to.be.equal(submissions.length); }); - test("Saves old state if expected", async function () { - writeCliConfig(); + test("should save old state if the flag is on", async function () { + // This test is based on a side effect of making a new submission. const submissions = (await tmc.getOldSubmissions(1)).unwrap(); - await tmc.downloadOldSubmission(1, downloadPath, submissions[0].id, true); + await tmc.resetExercise(1, exercisePath, true); const newSubmissions = (await tmc.getOldSubmissions(1)).unwrap(); expect(newSubmissions.length).to.be.equal(submissions.length + 1); }); - - teardown(function () { - removeArtifacts(); - }); - }); */ + }); suite("submitExerciseAndWaitForResults()", function () { test("should result in AuthorizationError if not authenticated", async function () { From 89b09bb8e2cb27d890542000249c51d243113103 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Thu, 22 Apr 2021 16:50:13 +0300 Subject: [PATCH 36/79] Try to get more informative error message --- src/test-integration/tmc_langs_cli.spec.ts | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/test-integration/tmc_langs_cli.spec.ts b/src/test-integration/tmc_langs_cli.spec.ts index 2e7cd09a..97d9ce62 100644 --- a/src/test-integration/tmc_langs_cli.spec.ts +++ b/src/test-integration/tmc_langs_cli.spec.ts @@ -182,7 +182,9 @@ suite("TMC", function () { test("should download exercise", async function () { const result = await tmc.downloadExercises([1], () => {}); - expect(result.ok).to.be.true; + if (result.err) { + expect.fail(result.val.message + ": " + result.val.stack); + } }); }); @@ -404,7 +406,9 @@ suite("TMC", function () { test("should reset exercise", async function () { const result = await tmc.resetExercise(1, exercisePath, false); - expect(result.ok).to.be.true; + if (result.err) { + expect.fail(result.val.message + ": " + result.val.stack); + } }); test("should not save old state if the flag is off", async function () { From bedc3972191a194a768fbfe80c5afbf2c01f851b Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Fri, 23 Apr 2021 10:41:53 +0300 Subject: [PATCH 37/79] Use separate folders for each reset test --- .eslintignore | 1 + src/test-integration/tmc_langs_cli.spec.ts | 15 +++++++++------ 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/.eslintignore b/.eslintignore index e98ca3a5..b2352cd3 100644 --- a/.eslintignore +++ b/.eslintignore @@ -3,6 +3,7 @@ dist **/node_modules out +test-artifacts/ test-resources/ submodules/ .vscode-test/ diff --git a/src/test-integration/tmc_langs_cli.spec.ts b/src/test-integration/tmc_langs_cli.spec.ts index 97d9ce62..1649d7fe 100644 --- a/src/test-integration/tmc_langs_cli.spec.ts +++ b/src/test-integration/tmc_langs_cli.spec.ts @@ -387,24 +387,25 @@ suite("TMC", function () { suite("resetExercise()", function () { this.timeout(5000); - let exercisePath: string; - - setup(function () { - const projectsDir = setupProjectsDir("resetExercise"); - exercisePath = path.join(projectsDir, "part01-01_passing_exercise"); + function setupExercise(folderName: string): string { + const projectsDir = setupProjectsDir(folderName); + const exercisePath = path.join(projectsDir, "part01-01_passing_exercise"); if (!fs.existsSync(exercisePath)) { fs.ensureDirSync(exercisePath); ncp(PASSING_EXERCISE_PATH, exercisePath, () => {}); } - }); + return exercisePath; + } // This actually passes test.skip("should result in AuthorizationError if not authenticated", async function () { + const exercisePath = setupExercise("resetExercise0"); const result = await tmcUnauthenticated.resetExercise(1, exercisePath, false); expect(result.val).to.be.instanceOf(AuthorizationError); }); test("should reset exercise", async function () { + const exercisePath = setupExercise("resetExercise1"); const result = await tmc.resetExercise(1, exercisePath, false); if (result.err) { expect.fail(result.val.message + ": " + result.val.stack); @@ -413,6 +414,7 @@ suite("TMC", function () { test("should not save old state if the flag is off", async function () { // This test is based on a side effect of making a new submission. + const exercisePath = setupExercise("resetExercise2"); const submissions = (await tmc.getOldSubmissions(1)).unwrap(); await tmc.resetExercise(1, exercisePath, false); const newSubmissions = (await tmc.getOldSubmissions(1)).unwrap(); @@ -421,6 +423,7 @@ suite("TMC", function () { test("should save old state if the flag is on", async function () { // This test is based on a side effect of making a new submission. + const exercisePath = setupExercise("resetExercise3"); const submissions = (await tmc.getOldSubmissions(1)).unwrap(); await tmc.resetExercise(1, exercisePath, true); const newSubmissions = (await tmc.getOldSubmissions(1)).unwrap(); From 503ff2a81bc4e92294b025023a9ac4a589e59f04 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Fri, 23 Apr 2021 11:08:25 +0300 Subject: [PATCH 38/79] Disable test that only fails on Windows CI --- src/test-integration/tmc_langs_cli.spec.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/test-integration/tmc_langs_cli.spec.ts b/src/test-integration/tmc_langs_cli.spec.ts index 1649d7fe..d38497ce 100644 --- a/src/test-integration/tmc_langs_cli.spec.ts +++ b/src/test-integration/tmc_langs_cli.spec.ts @@ -404,7 +404,8 @@ suite("TMC", function () { expect(result.val).to.be.instanceOf(AuthorizationError); }); - test("should reset exercise", async function () { + // Windows CI can't handle this for some reason? + test.skip("should reset exercise", async function () { const exercisePath = setupExercise("resetExercise1"); const result = await tmc.resetExercise(1, exercisePath, false); if (result.err) { From 028cf9e4d7a9992b7cb8c91a9d5f313d3a00001d Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Fri, 23 Apr 2021 11:31:53 +0300 Subject: [PATCH 39/79] More error messages because this time Mac sucks --- src/test-integration/tmc_langs_cli.spec.ts | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/src/test-integration/tmc_langs_cli.spec.ts b/src/test-integration/tmc_langs_cli.spec.ts index d38497ce..3138701c 100644 --- a/src/test-integration/tmc_langs_cli.spec.ts +++ b/src/test-integration/tmc_langs_cli.spec.ts @@ -114,7 +114,7 @@ suite("TMC", function () { test("should succeed with correct credentials", async function () { const result = await tmcUnauthenticated.authenticate("TestMyExtension", "hunter2"); - expect(result.ok).to.be.true; + result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); }); test("should result in AuthenticationError when already authenticated", async function () { @@ -138,7 +138,7 @@ suite("TMC", function () { suite("deauthenticate()", function () { test("should deauthenticate the user", async function () { const result = await tmc.deauthenticate(); - expect(result.ok).to.be.true; + result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); }); }); @@ -182,9 +182,7 @@ suite("TMC", function () { test("should download exercise", async function () { const result = await tmc.downloadExercises([1], () => {}); - if (result.err) { - expect.fail(result.val.message + ": " + result.val.stack); - } + result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); }); }); @@ -214,7 +212,7 @@ suite("TMC", function () { test("should download old submission", async function () { const result = await tmc.downloadOldSubmission(1, exercisePath, 0, false); - expect(result.ok).to.be.true; + result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); }); test("should not save old state when the flag is off", async function () { @@ -408,9 +406,7 @@ suite("TMC", function () { test.skip("should reset exercise", async function () { const exercisePath = setupExercise("resetExercise1"); const result = await tmc.resetExercise(1, exercisePath, false); - if (result.err) { - expect.fail(result.val.message + ": " + result.val.stack); - } + result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); }); test("should not save old state if the flag is off", async function () { @@ -508,7 +504,7 @@ suite("TMC", function () { test("should submit feedback when authenticated", async function () { const result = await tmc.submitSubmissionFeedback(FEEDBACK_URL, feedback); - expect(result.ok).to.be.true; + result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); }); }); From 53749d98e0107bd8a30a18b92c10267f08c682da Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Fri, 23 Apr 2021 12:32:52 +0300 Subject: [PATCH 40/79] Test login events in authentication tests --- src/test-integration/tmc_langs_cli.spec.ts | 82 +++++++++++++++------- 1 file changed, 57 insertions(+), 25 deletions(-) diff --git a/src/test-integration/tmc_langs_cli.spec.ts b/src/test-integration/tmc_langs_cli.spec.ts index 3138701c..12490a4a 100644 --- a/src/test-integration/tmc_langs_cli.spec.ts +++ b/src/test-integration/tmc_langs_cli.spec.ts @@ -28,6 +28,8 @@ const FEEDBACK_URL = "http://localhost:4001/feedback"; // This one is mandated by TMC-langs. const CLIENT_CONFIG_DIR_NAME = `tmc-${CLIENT_NAME}`; +const FAIL_MESSAGE = "TMC-langs execution failed: "; + async function startServer(): Promise { let ready = false; console.log(path.join(__dirname, "..", "backend")); @@ -101,44 +103,74 @@ suite("TMC", function () { }); }); - suite("authenticate()", function () { - test.skip("should result in AuthenticationError with empty credentials", async function () { - const result = await tmcUnauthenticated.authenticate("", ""); - expect(result.val).to.be.instanceOf(AuthenticationError); + suite("authentication", function () { + const incorrectUsername = "TestMyEkstension"; + const username = "TestMyExtension"; + const password = "hunter2"; + + let onLoggedInCalls: number; + let onLoggedOutCalls: number; + + setup(function () { + onLoggedInCalls = 0; + onLoggedOutCalls = 0; + tmcUnauthenticated.on("login", () => onLoggedInCalls++); + tmcUnauthenticated.on("logout", () => onLoggedOutCalls++); }); - test("should result in AuthenticationError with incorrect credentials", async function () { - const result = await tmcUnauthenticated.authenticate("TestMyCode", "hunter2"); - expect(result.val).to.be.instanceOf(AuthenticationError); + test("should fail with empty credentials"); + + test("should fail with incorrect credentials", async function () { + const result1 = await tmcUnauthenticated.authenticate(incorrectUsername, password); + expect(result1.val).to.be.instanceOf(AuthenticationError); + expect(onLoggedInCalls).to.be.equal(0); + + const result2 = await tmcUnauthenticated.isAuthenticated(); + result2.err && expect.fail(FAIL_MESSAGE + result2.val.message); + expect(result2.val).to.be.equal(false); + + expect(onLoggedOutCalls).to.be.equal(0); }); test("should succeed with correct credentials", async function () { - const result = await tmcUnauthenticated.authenticate("TestMyExtension", "hunter2"); - result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); + const result1 = await tmcUnauthenticated.authenticate(username, password); + result1.err && expect.fail(FAIL_MESSAGE + result1.val.message); + expect(onLoggedInCalls).to.be.equal(1); + + const result2 = await tmcUnauthenticated.isAuthenticated(); + result2.err && expect.fail(FAIL_MESSAGE + result2.val.message); + expect(result2.val).to.be.equal(true); + + expect(onLoggedOutCalls).to.be.equal(0); }); - test("should result in AuthenticationError when already authenticated", async function () { - const result = await tmc.authenticate("TestMyExtension", "hunter2"); - expect(result.val).to.be.instanceOf(AuthenticationError); + test("should fail when already authenticated", async function () { + const result2 = await tmc.authenticate(username, password); + expect(result2.val).to.be.instanceOf(AuthenticationError); }); }); - suite("isAuthenticated()", function () { - test("should return false when user config is missing", async function () { - const result = await tmcUnauthenticated.isAuthenticated(); - expect(result.val).to.be.false; - }); + suite("deauthentication", function () { + let onLoggedInCalls: number; + let onLoggedOutCalls: number; - test("should return true when user config exists", async function () { - const result = await tmc.isAuthenticated(); - expect(result.val).to.be.true; + setup(function () { + onLoggedInCalls = 0; + onLoggedOutCalls = 0; + tmc.on("login", () => onLoggedInCalls++); + tmc.on("logout", () => onLoggedOutCalls++); }); - }); - suite("deauthenticate()", function () { - test("should deauthenticate the user", async function () { - const result = await tmc.deauthenticate(); - result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); + test("should succeed", async function () { + const result1 = await tmc.deauthenticate(); + result1.err && expect.fail(FAIL_MESSAGE + result1.val.message); + expect(onLoggedOutCalls).to.be.equal(1); + + const result2 = await tmc.isAuthenticated(); + result2.err && expect.fail(FAIL_MESSAGE + result2.val.message); + expect(result2.val).to.be.false; + + expect(onLoggedInCalls).to.be.equal(0); }); }); From ffdffd64416d4ad55574a6d12bc21e46aa968cac Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Tue, 27 Apr 2021 10:30:58 +0300 Subject: [PATCH 41/79] Use old style of langs response validation --- src/api/langsSchema.ts | 67 ++--- src/api/tmc.ts | 587 ++++++++++++++++++++--------------------- src/api/types.ts | 6 - 3 files changed, 295 insertions(+), 365 deletions(-) diff --git a/src/api/langsSchema.ts b/src/api/langsSchema.ts index cc2b9d34..ae195ed9 100644 --- a/src/api/langsSchema.ts +++ b/src/api/langsSchema.ts @@ -1,17 +1,6 @@ -import { - Course, - CourseDetails, - CourseExercise, - CourseSettings, - ExerciseDetails, - OldSubmission, - Organization, - SubmissionFeedbackResponse, - SubmissionResponse, - SubmissionResultReport, -} from "./types"; - -// * Output schema for TMC-Langs 0.9.1 * +import { CourseDetails, CourseExercise, CourseSettings, SubmissionResponse } from "./types"; + +// * Output schema for TMC-Langs 0.17.3 * // ------------------------------------------------------------------------------------------------- // https://github.com/rage/tmc-langs-rust/blob/master/tmc-client/src/tmc_client.rs @@ -26,15 +15,22 @@ export type ClientUpdateData = // ------------------------------------------------------------------------------------------------- export type Output = - | ({ "output-kind": "output-data" } & OutputData) + | ({ "output-kind": "output-data" } & UncheckedOutputData) | ({ "output-kind": "status-update" } & StatusUpdateData) | ({ "output-kind": "warnings" } & Warnings); -export interface OutputData { +export interface UncheckedOutputData { status: Status; message: string; result: OutputResult; - data: Data | null; + data: DataType | null; +} + +export interface OutputData { + status: Status; + message: string; + result: OutputResult; + data: DataType; } interface DataType { @@ -42,37 +38,6 @@ interface DataType { "output-data": V; } -export type Data = - | DataType<"error", LangsError> - | DataType<"validation", unknown> - | DataType<"free-disk-space", number> - | DataType<"available-points", string[]> - | DataType<"exercises", string[]> - | DataType<"exercise-packaging-configuration", unknown> - | DataType<"local-exercises", LocalExercise[]> - | DataType<"refresh-result", unknown> - | DataType<"test-result", RunResult> - | DataType<"exercise-desc", unknown> - | DataType<"updated-exercises", UpdatedExercise[]> - | DataType<"exercise-download", DownloadOrUpdateCourseExercisesResult> - | DataType<"combined-course-data", CombinedCourseData> - | DataType<"course-details", CourseDetails["course"]> - | DataType<"course-exercises", CourseExercise[]> - | DataType<"course-data", CourseSettings> - | DataType<"courses", Course[]> - | DataType<"exercise-details", ExerciseDetails> - | DataType<"submissions", OldSubmission[]> - | DataType<"update-result", unknown> - | DataType<"organization", Organization> - | DataType<"organizations", Organization[]> - | DataType<"reviews", unknown> - | DataType<"token", unknown> - | DataType<"new-submission", SubmissionResponse> - | DataType<"submission-feedback-response", SubmissionFeedbackResponse> - | DataType<"submission-finished", SubmissionResultReport> - | DataType<"config-value", unknown> - | DataType<"tmc-config", TmcConfig>; - export type StatusUpdateData = | ({ "update-data-kind": "client-update-data" } & StatusUpdate) | ({ "update-data-kind": "none" } & StatusUpdate); @@ -86,8 +51,8 @@ export type OutputResult = | "error" | "executed-command"; -export interface LangsError { - kind: LangsErrorKind; +export interface ErrorResponse { + kind: ErrorResponseKind; trace: string[]; } @@ -97,7 +62,7 @@ export interface FailedExerciseDownload { failed: Array<[DownloadOrUpdateCourseExercise, string[]]>; } -export type LangsErrorKind = +export type ErrorResponseKind = | "generic" | "forbidden" | "not-logged-in" diff --git a/src/api/tmc.ts b/src/api/tmc.ts index 863f9a56..7681468e 100644 --- a/src/api/tmc.ts +++ b/src/api/tmc.ts @@ -1,7 +1,7 @@ import * as cp from "child_process"; import * as kill from "tree-kill"; import { Err, Ok, Result } from "ts-results"; -import { is } from "typescript-is"; +import { createIs, is } from "typescript-is"; import { API_CACHE_LIFETIME, @@ -24,19 +24,17 @@ import { Logger } from "../utils/logger"; import { CombinedCourseData, - Data, DownloadOrUpdateCourseExercisesResult, - FailedExerciseDownload, + ErrorResponse, LocalExercise, Output, OutputData, RunResult, StatusUpdateData, - UpdatedExercise, + UncheckedOutputData, } from "./langsSchema"; import { Course, - CourseData, CourseDetails, CourseExercise, CourseSettings, @@ -45,7 +43,7 @@ import { Organization, SubmissionFeedback, SubmissionFeedbackResponse, - SubmissionResultReport, + SubmissionResponse, SubmissionStatusReport, TestResults, } from "./types"; @@ -74,11 +72,11 @@ interface LangsProcessArgs { interface LangsProcessRunner { interrupt(): void; - result: Promise>; + result: Promise>; } interface ResponseCacheEntry { - response: OutputData; + response: UncheckedOutputData; timestamp: number; } @@ -86,11 +84,11 @@ interface CacheOptions { forceRefresh?: boolean; } -interface CacheConfig { +interface CacheConfig { forceRefresh?: boolean; key: string; /** Optional remapper for assigning parts of the result to different keys. */ - remapper?: (response: OutputData) => Array<[string, OutputData]>; + remapper?: (response: T) => Array<[string, OutputData]>; } /** @@ -152,18 +150,21 @@ export default class TMC { * @param password Password. */ public async authenticate(username: string, password: string): Promise> { - const loginResult = await this._executeLangsCommand({ - args: ["login", "--email", username, "--base64"], - core: true, - obfuscate: [2], - stdin: Buffer.from(password).toString("base64"), - }); - if (loginResult.err) { - return Err(new AuthenticationError(loginResult.val.message)); - } - - this._onLogin?.(); - return Ok.EMPTY; + const res = await this._executeLangsCommand( + { + args: ["login", "--email", username, "--base64"], + core: true, + obfuscate: [2], + stdin: Buffer.from(password).toString("base64"), + }, + createIs(), + ); + return res + .mapErr((x) => new AuthenticationError(x.message)) + .andThen(() => { + this._onLogin?.(); + return Ok.EMPTY; + }); } /** @@ -173,37 +174,39 @@ export default class TMC { * @returns Boolean indicating if the user is authenticated. */ public async isAuthenticated(options?: ExecutionOptions): Promise> { - const loggedInResult = await this._executeLangsCommand({ - args: ["logged-in"], - core: true, - processTimeout: options?.timeout, + const res = await this._executeLangsCommand( + { + args: ["logged-in"], + core: true, + processTimeout: options?.timeout, + }, + createIs(), + ); + return res.andThen((x) => { + switch (x.result) { + case "logged-in": + return Ok(true); + case "not-logged-in": + return Ok(false); + default: + return Err(new Error(`Unexpected langs result: ${x.result}`)); + } }); - if (loggedInResult.err) { - return loggedInResult; - } - - switch (loggedInResult.val.result) { - case "logged-in": - return new Ok(true); - case "not-logged-in": - return new Ok(false); - default: - return Err(new Error(`Unexpected langs result: ${loggedInResult.val.result}`)); - } } /** * Deauthenticates current user. Uses TMC-langs `logout` core command internally. */ public async deauthenticate(): Promise> { - const logoutResult = await this._executeLangsCommand({ args: ["logout"], core: true }); - if (logoutResult.err) { - return logoutResult; - } - - this._responseCache.clear(); - this._onLogout?.(); - return Ok.EMPTY; + const res = await this._executeLangsCommand( + { args: ["logout"], core: true }, + createIs(), + ); + return res.andThen(() => { + this._responseCache.clear(); + this._onLogout?.(); + return Ok.EMPTY; + }); } // --------------------------------------------------------------------------------------------- @@ -217,10 +220,14 @@ export default class TMC { * @param id ID of the exercise to clean. */ public async clean(exercisePath: string): Promise> { - return this._executeLangsCommand({ - args: ["clean", "--exercise-path", exercisePath], - core: false, - }).then((res) => (res.err ? res : Ok.EMPTY)); + const res = await this._executeLangsCommand( + { + args: ["clean", "--exercise-path", exercisePath], + core: false, + }, + createIs(), + ); + return res.err ? res : Ok.EMPTY; } /** @@ -232,8 +239,8 @@ export default class TMC { public async listLocalCourseExercises( courseSlug: string, ): Promise> { - return ( - await this._executeLangsCommand({ + const res = await this._executeLangsCommand( + { args: [ "list-local-course-exercises", "--client-name", @@ -242,12 +249,10 @@ export default class TMC { courseSlug, ], core: false, - }) - ).andThen((x) => - x.data?.["output-data-kind"] === "local-exercises" - ? Ok(x.data["output-data"]) - : Err(new Error("Unexpected Langs result.")), + }, + createIs>(), ); + return res.map((x) => x.data["output-data"]); } /** @@ -267,12 +272,21 @@ export default class TMC { message: res.message ?? undefined, }); }; - - return this._executeLangsCommand({ - args: ["settings", "--client-name", this.clientName, "move-projects-dir", newDirectory], - core: false, - onStdout, - }).then((res) => (res.err ? res : Ok.EMPTY)); + const res = await this._executeLangsCommand( + { + args: [ + "settings", + "--client-name", + this.clientName, + "move-projects-dir", + newDirectory, + ], + core: false, + onStdout, + }, + createIs>(), + ); + return res.err ? res : Ok.EMPTY; } /** @@ -299,14 +313,9 @@ export default class TMC { }); const postResult = result.then((res) => res - .andThen(this._checkLangsResponse) - .andThen((x) => - x.data?.["output-data-kind"] === "test-result" - ? Ok(x.data["output-data"]) - : Err(new Error("Unexpected Langs result.")), - ), + .andThen((x) => this._checkLangsResponse(x, createIs>())) + .map((x) => x.data["output-data"]), ); - return [postResult, interrupt]; } @@ -325,25 +334,29 @@ export default class TMC { exercisePath: string, exerciseSlug: string, ): Promise> { - return this._executeLangsCommand({ - args: [ - "settings", - "--client-name", - this.clientName, - "migrate", - "--course-slug", - courseSlug, - "--exercise-checksum", - exerciseChecksum, - "--exercise-id", - `${exerciseId}`, - "--exercise-path", - exercisePath, - "--exercise-slug", - exerciseSlug, - ], - core: false, - }).then((res) => (res.err ? res : Ok.EMPTY)); + const res = await this._executeLangsCommand( + { + args: [ + "settings", + "--client-name", + this.clientName, + "migrate", + "--course-slug", + courseSlug, + "--exercise-checksum", + exerciseChecksum, + "--exercise-id", + `${exerciseId}`, + "--exercise-path", + exercisePath, + "--exercise-slug", + exerciseSlug, + ], + core: false, + }, + createIs>(), + ); + return res.err ? res : Ok.EMPTY; } /** @@ -354,20 +367,17 @@ export default class TMC { key: string, checker: (object: unknown) => object is T, ): Promise> { - return ( - await this._executeLangsCommand({ + const res = await this._executeLangsCommand( + { args: ["settings", "--client-name", this.clientName, "get", key], core: false, - }) - ) - .andThen((result) => - result.data?.["output-data-kind"] === "config-value" - ? Ok(result.data["output-data"]) - : Err(new Error("Unexpected Langs result.")), - ) - .andThen((result) => - checker(result) ? Ok(result) : Err(new Error("Invalid object type.")), - ); + }, + createIs>(), + ); + return res.andThen((x) => { + const result_1 = x.data["output-data"]; + return checker(result_1) ? Ok(result_1) : Err(new Error("Invalid object type.")); + }); } /** @@ -375,10 +385,14 @@ export default class TMC { * internally. */ public async setSetting(key: string, value: string): Promise> { - return this._executeLangsCommand({ - args: ["settings", "--client-name", this.clientName, "set", key, value], - core: false, - }).then((x) => x.andThen(() => Ok.EMPTY)); + const res = await this._executeLangsCommand( + { + args: ["settings", "--client-name", this.clientName, "set", key, value], + core: false, + }, + createIs>(), + ); + return res.err ? res : Ok.EMPTY; } /** @@ -386,10 +400,14 @@ export default class TMC { * internally. */ public async resetSettings(): Promise> { - return this._executeLangsCommand({ - args: ["settings", "--client-name", this.clientName, "reset"], - core: false, - }).then((x) => x.andThen(() => Ok.EMPTY)); + const res = await this._executeLangsCommand( + { + args: ["settings", "--client-name", this.clientName, "reset"], + core: false, + }, + createIs>(), + ); + return res.err ? res : Ok.EMPTY; } /** @@ -397,10 +415,14 @@ export default class TMC { * internally. */ public async unsetSetting(key: string): Promise> { - return this._executeLangsCommand({ - args: ["settings", "--client-name", this.clientName, "unset", key], - core: false, - }).then((x) => x.andThen(() => Ok.EMPTY)); + const res = await this._executeLangsCommand( + { + args: ["settings", "--client-name", this.clientName, "unset", key], + core: false, + }, + createIs>(), + ); + return res.err ? res : Ok.EMPTY; } // --------------------------------------------------------------------------------------------- @@ -414,16 +436,12 @@ export default class TMC { public async checkExerciseUpdates( options?: CacheOptions, ): Promise, Error>> { - return ( - await this._executeLangsCommand( - { args: ["check-exercise-updates"], core: true }, - { forceRefresh: options?.forceRefresh, key: TMC._exerciseUpdatesCacheKey }, - ) - ).andThen((result) => - result.data?.["output-data-kind"] === "updated-exercises" - ? Ok(result.data["output-data"]) - : Err(new Error("Unexpected Langs result.")), + const res = await this._executeLangsCommand( + { args: ["check-exercise-updates"], core: true }, + createIs>>(), + { forceRefresh: options?.forceRefresh, key: TMC._exerciseUpdatesCacheKey }, ); + return res.map((x) => x.data["output-data"]); } /** @@ -448,9 +466,8 @@ export default class TMC { }); } }; - - const result = ( - await this._executeLangsCommand({ + const res = await this._executeLangsCommand( + { args: [ "download-or-update-course-exercises", "--exercise-id", @@ -458,19 +475,14 @@ export default class TMC { ], core: true, onStdout, - }) - ).andThen((result) => - result.data?.["output-data-kind"] === "exercise-download" - ? Ok(result.data["output-data"]) - : Err(new Error("Unexpected Langs result.")), + }, + createIs>(), ); - if (result.err) { - return result; - } - - // Invalidate exercise update cache - this._responseCache.delete(TMC._exerciseUpdatesCacheKey); - return result; + return res.andThen((x) => { + // Invalidate exercise update cache + this._responseCache.delete(TMC._exerciseUpdatesCacheKey); + return Ok(x.data["output-data"]); + }); } /** @@ -501,17 +513,17 @@ export default class TMC { "--submission-id", submissionId.toString(), ]; - if (saveOldState) { args.push( "--submission-url", `${TMC_BACKEND_URL}/api/v8/core/exercises/${exerciseId}/submissions`, ); } - - return this._executeLangsCommand({ args, core: true }).then((res) => - res.err ? res : Ok.EMPTY, + const res = await this._executeLangsCommand( + { args, core: true }, + createIs(), ); + return res.err ? res : Ok.EMPTY; } /** @@ -525,19 +537,15 @@ export default class TMC { organization: string, options?: CacheOptions, ): Promise> { - return ( - await this._executeLangsCommand( - { args: ["get-courses", "--organization", organization], core: true }, - { - forceRefresh: options?.forceRefresh, - key: `organization-${organization}-courses`, - }, - ) - ).andThen((result) => - result.data?.["output-data-kind"] === "courses" - ? Ok(result.data["output-data"]) - : Err(new Error("Unexpected Langs result.")), + const res = await this._executeLangsCommand( + { args: ["get-courses", "--organization", organization], core: true }, + createIs>(), + { + forceRefresh: options?.forceRefresh, + key: `organization-${organization}-courses`, + }, ); + return res.map((x) => x.data["output-data"]); } /** @@ -550,8 +558,8 @@ export default class TMC { public async getCourseData( courseId: number, options?: CacheOptions, - ): Promise> { - const remapper: CacheConfig["remapper"] = (response) => { + ): Promise> { + const remapper: CacheConfig>["remapper"] = (response) => { if (response.data?.["output-data-kind"] !== "combined-course-data") return []; const { details, exercises, settings } = response.data["output-data"]; return [ @@ -578,17 +586,12 @@ export default class TMC { ], ]; }; - - return ( - await this._executeLangsCommand( - { args: ["get-course-data", "--course-id", courseId.toString()], core: true }, - { forceRefresh: options?.forceRefresh, key: `course-${courseId}-data`, remapper }, - ) - ).andThen((result) => - result.data?.["output-data-kind"] === "combined-course-data" - ? Ok(result.data["output-data"]) - : Err(new Error("Unexpected Langs result.")), + const res = await this._executeLangsCommand>( + { args: ["get-course-data", "--course-id", courseId.toString()], core: true }, + createIs>(), + { forceRefresh: options?.forceRefresh, key: `course-${courseId}-data`, remapper }, ); + return res.map((x) => x.data["output-data"]); } /** @@ -602,18 +605,12 @@ export default class TMC { courseId: number, options?: CacheOptions, ): Promise> { - return ( - await this._executeLangsCommand( - { args: ["get-course-details", "--course-id", courseId.toString()], core: true }, - { forceRefresh: options?.forceRefresh, key: `course-${courseId}-details` }, - ) - ) - .andThen((result) => - result.data?.["output-data-kind"] === "course-details" - ? Ok(result.data["output-data"]) - : Err(new Error("Unexpected Langs result.")), - ) - .map((x) => ({ course: x })); + const res = await this._executeLangsCommand( + { args: ["get-course-details", "--course-id", courseId.toString()], core: true }, + createIs>(), + { forceRefresh: options?.forceRefresh, key: `course-${courseId}-details` }, + ); + return res.map((x) => ({ course: x.data["output-data"] })); } /** @@ -627,16 +624,12 @@ export default class TMC { courseId: number, options?: CacheOptions, ): Promise> { - return ( - await this._executeLangsCommand( - { args: ["get-course-exercises", "--course-id", courseId.toString()], core: true }, - { forceRefresh: options?.forceRefresh, key: `course-${courseId}-exercises` }, - ) - ).andThen((result) => - result.data?.["output-data-kind"] === "course-exercises" - ? Ok(result.data["output-data"]) - : Err(new Error("Unexpected Langs result.")), + const res = await this._executeLangsCommand( + { args: ["get-course-exercises", "--course-id", courseId.toString()], core: true }, + createIs>(), + { forceRefresh: options?.forceRefresh, key: `course-${courseId}-exercises` }, ); + return res.map((x) => x.data["output-data"]); } /** @@ -650,16 +643,12 @@ export default class TMC { courseId: number, options?: CacheOptions, ): Promise> { - return ( - await this._executeLangsCommand( - { args: ["get-course-settings", "--course-id", courseId.toString()], core: true }, - { forceRefresh: options?.forceRefresh, key: `course-${courseId}-settings` }, - ) - ).andThen((result) => - result.data?.["output-data-kind"] === "course-data" - ? Ok(result.data["output-data"]) - : Err(new Error("Unexpected Langs result.")), + const res = await this._executeLangsCommand( + { args: ["get-course-settings", "--course-id", courseId.toString()], core: true }, + createIs>(), + { forceRefresh: options?.forceRefresh, key: `course-${courseId}-settings` }, ); + return res.map((x) => x.data["output-data"]); } /** @@ -673,19 +662,15 @@ export default class TMC { exerciseId: number, options?: CacheOptions, ): Promise> { - return ( - await this._executeLangsCommand( - { - args: ["get-exercise-details", "--exercise-id", exerciseId.toString()], - core: true, - }, - { forceRefresh: options?.forceRefresh, key: `exercise-${exerciseId}-details` }, - ) - ).andThen((result) => - result.data?.["output-data-kind"] === "exercise-details" - ? Ok(result.data["output-data"]) - : Err(new Error("Unexpected Langs result.")), + const res = await this._executeLangsCommand( + { + args: ["get-exercise-details", "--exercise-id", exerciseId.toString()], + core: true, + }, + createIs>(), + { forceRefresh: options?.forceRefresh, key: `exercise-${exerciseId}-details` }, ); + return res.map((x) => x.data["output-data"]); } /** @@ -696,16 +681,14 @@ export default class TMC { * @returns Array of old submissions. */ public async getOldSubmissions(exerciseId: number): Promise> { - return ( - await this._executeLangsCommand({ + const res = await this._executeLangsCommand( + { args: ["get-exercise-submissions", "--exercise-id", exerciseId.toString()], core: true, - }) - ).andThen((result) => - result.data?.["output-data-kind"] === "submissions" - ? Ok(result.data["output-data"]) - : Err(new Error("Unexpected Langs result.")), + }, + createIs>(), ); + return res.map((x) => x.data["output-data"]); } /** @@ -719,16 +702,12 @@ export default class TMC { organizationSlug: string, options?: CacheOptions, ): Promise> { - return ( - await this._executeLangsCommand( - { args: ["get-organization", "--organization", organizationSlug], core: true }, - { forceRefresh: options?.forceRefresh, key: `organization-${organizationSlug}` }, - ) - ).andThen((result) => - result.data?.["output-data-kind"] === "organization" - ? Ok(result.data["output-data"]) - : Err(new Error("Unexpected Langs result.")), + const res = await this._executeLangsCommand( + { args: ["get-organization", "--organization", organizationSlug], core: true }, + createIs>(), + { forceRefresh: options?.forceRefresh, key: `organization-${organizationSlug}` }, ); + return res.map((x) => x.data["output-data"]); } /** @@ -737,24 +716,19 @@ export default class TMC { * @returns A list of organizations. */ public async getOrganizations(options?: CacheOptions): Promise> { - const remapper: CacheConfig["remapper"] = (res) => { + const remapper: CacheConfig>["remapper"] = (res) => { if (res.data?.["output-data-kind"] !== "organizations") return []; - return res.data["output-data"].map<[string, OutputData]>((x) => [ + return res.data["output-data"].map((x) => [ `organization-${x.slug}`, { ...res, data: { "output-data-kind": "organization", "output-data": x } }, ]); }; - - return ( - await this._executeLangsCommand( - { args: ["get-organizations"], core: true }, - { forceRefresh: options?.forceRefresh, key: "organizations", remapper }, - ) - ).andThen((result) => - result.data?.["output-data-kind"] === "organizations" - ? Ok(result.data["output-data"]) - : Err(new Error("Unexpected Langs result.")), + const res = await this._executeLangsCommand( + { args: ["get-organizations"], core: true }, + createIs>(), + { forceRefresh: options?.forceRefresh, key: "organizations", remapper }, ); + return res.map((x) => x.data["output-data"]); } /** @@ -784,13 +758,11 @@ export default class TMC { `${TMC_BACKEND_URL}/api/v8/core/exercises/${exerciseId}/submissions`, ); } - - const result = await this._executeLangsCommand({ args, core: true }); - if (result.err) { - return result; - } - - return Ok.EMPTY; + const res = await this._executeLangsCommand( + { args, core: true }, + createIs>(), + ); + return res.err ? res : Ok.EMPTY; } /** @@ -827,17 +799,15 @@ export default class TMC { } }; - return ( - await this._executeLangsCommand({ + const res = await this._executeLangsCommand( + { args: ["submit", "--submission-path", exercisePath, "--submission-url", submitUrl], core: true, onStdout, - }) - ).andThen((result) => - result.data?.["output-data-kind"] === "submission-finished" - ? Ok(result.data["output-data"]) - : Err(new Error("Unexpected Langs result.")), + }, + createIs>(), ); + return res.map((x) => x.data["output-data"]); } /** @@ -860,19 +830,15 @@ export default class TMC { } else { this._nextSubmissionAllowedTimestamp = now + MINIMUM_SUBMISSION_INTERVAL; } - const submitUrl = `${TMC_BACKEND_URL}/api/v8/core/exercises/${exerciseId}/submissions`; - - return ( - await this._executeLangsCommand({ + const res = await this._executeLangsCommand( + { args: ["paste", "--submission-path", exercisePath, "--submission-url", submitUrl], core: true, - }) - ).andThen((result) => - result.data?.["output-data-kind"] === "new-submission" - ? Ok(result.data["output-data"].paste_url) - : Err(new Error("Unexpected Langs result.")), + }, + createIs>(), ); + return res.map((x) => x.data["output-data"].paste_url); } /** @@ -890,17 +856,14 @@ export default class TMC { (acc, next) => acc.concat("--feedback", next.question_id.toString(), next.answer), [], ); - - return ( - await this._executeLangsCommand({ + const res = await this._executeLangsCommand( + { args: ["send-feedback", ...feedbackArgs, "--feedback-url", feedbackUrl], core: true, - }) - ).andThen((result) => - result.data?.["output-data-kind"] === "submission-feedback-response" - ? Ok(result.data["output-data"]) - : Err(new Error("Unexpected Langs result.")), + }, + createIs>(), ); + return res.map((x) => x.data["output-data"]); } /** @@ -908,17 +871,14 @@ export default class TMC { * validation for the last response received from the process. * * @param langsArgs Command arguments passed on to spawnLangsProcess. - * @param checker Checker function used to validate the type of data-property. - * @param useCache Whether to try fetching the data from cache instead of running the process. - * @param cacheKey Key used for storing and accessing cached data. Required with useCache. - * @param cacheTransformer Optional transformer function that can be used to split summary - * responses. - * @returns Result that resolves to a checked LansResponse. + * @param validator Validator used to check that the result corresponds to the expected type. + * @param cacheConfig Cache options. */ - private async _executeLangsCommand( + private async _executeLangsCommand( langsArgs: LangsProcessArgs, - cacheConfig?: CacheConfig, - ): Promise> { + validator: (object: unknown) => object is T, + cacheConfig?: CacheConfig, + ): Promise> { const cacheKey = cacheConfig?.key; const currentTime = Date.now(); if (!cacheConfig?.forceRefresh && cacheKey) { @@ -926,7 +886,7 @@ export default class TMC { if (cachedEntry) { const { response, timestamp } = cachedEntry; const cachedDataLifeLeft = timestamp + API_CACHE_LIFETIME - currentTime; - if (cachedDataLifeLeft > 0) { + if (validator(response) && cachedDataLifeLeft > 0) { const prettySecondsLeft = Math.ceil(cachedDataLifeLeft / 1000); Logger.log( `Using cached data for key: ${cacheKey}. Still valid for ${prettySecondsLeft}s`, @@ -938,40 +898,46 @@ export default class TMC { } } - const result = (await this._spawnLangsProcess(langsArgs).result).andThen((x) => - this._checkLangsResponse(x), - ); - if (result.err) { - return result; - } - - const response = result.val; - if (response && cacheKey) { - this._responseCache.set(cacheKey, { response, timestamp: currentTime }); - cacheConfig?.remapper?.(response).forEach(([key, response]) => { - this._responseCache.set(key, { response, timestamp: currentTime }); + const res = await this._spawnLangsProcess(langsArgs).result; + return res + .andThen((x) => this._checkLangsResponse(x, validator)) + .andThen((x) => { + if (x && cacheKey) { + this._responseCache.set(cacheKey, { response: x, timestamp: currentTime }); + cacheConfig?.remapper?.(x).forEach(([key, response]) => { + this._responseCache.set(key, { response, timestamp: currentTime }); + }); + } + return Ok(x); }); - } - - return Ok(response); } /** * Checks langs response for generic errors. */ - private _checkLangsResponse(langsResponse: OutputData): Result { + private _checkLangsResponse( + langsResponse: UncheckedOutputData, + validator: (object: unknown) => object is T, + ): Result { if (langsResponse.status === "crashed") { Logger.error(`Langs process crashed: ${langsResponse.message}`, langsResponse.data); return Err(new RuntimeError("Langs process crashed.")); } - if (langsResponse.data?.["output-data-kind"] !== "error") { + if (langsResponse.data?.["output-data-kind"] !== "error" && validator(langsResponse)) { return Ok(langsResponse); } + Logger.log("asd " + langsResponse.data?.["output-data-kind"] !== "error"); + Logger.log("sdf " + validator(langsResponse)); + + const data = langsResponse.data?.["output-data"]; + if (!is(data)) { + return Err(new Error("Unexpected TMC-langs response:" + langsResponse.data)); + } const message = langsResponse.message; - const traceString = langsResponse.data["output-data"].trace.join("\n"); - const outputDataKind = langsResponse.data["output-data"].kind; + const traceString = data.trace.join("\n"); + const outputDataKind = data.kind; switch (outputDataKind) { case "connection-error": return Err(new ConnectionError(message, traceString)); @@ -996,18 +962,19 @@ export default class TMC { ); } + // TODO: actual todo // Special handling because it makes usage simpler - if (is(outputDataKind)) { - const data: Data = { - "output-data-kind": "exercise-download", - "output-data": { - downloaded: outputDataKind.completed, - skipped: outputDataKind.skipped, - }, - }; - - return Ok({ ...langsResponse, data }); - } + // if (is(outputDataKind)) { + // const data: Data = { + // "output-data-kind": "exercise-download", + // "output-data": { + // downloaded: outputDataKind.completed, + // skipped: outputDataKind.skipped, + // }, + // }; + + // return Ok({ ...langsResponse, data }); + // } return Err(new RuntimeError(message, traceString)); } @@ -1036,7 +1003,7 @@ export default class TMC { this.clientVersion, ]; - let theResult: OutputData | undefined; + let theResult: UncheckedOutputData | undefined; let stdoutBuffer = ""; const executableArgs = core ? CORE_ARGS.concat(args) : args; @@ -1096,7 +1063,11 @@ export default class TMC { stdoutBuffer = parts.pop() || ""; for (const part of parts) { try { - const json = JSON.parse(part.trim()); + const trimmed = part.trim(); + if (!trimmed) { + continue; + } + const json = JSON.parse(trimmed); if (!is(json)) { Logger.error("TMC-langs response didn't match expected type"); Logger.debug(part); diff --git a/src/api/types.ts b/src/api/types.ts index 0a17ed13..ca2acb8d 100644 --- a/src/api/types.ts +++ b/src/api/types.ts @@ -114,12 +114,6 @@ export type CourseSettings = { organization_slug?: string | null; }; -export type CourseData = { - details: CourseDetails["course"]; - exercises: CourseExercise[]; - settings: CourseSettings; -}; - /** * GET /api/v8/core/exercises/{exercise_id} */ From 2836ce0325665c4d4843497a550230b36e8160ce Mon Sep 17 00:00:00 2001 From: Sebastian Sergelius Date: Tue, 27 Apr 2021 10:53:11 +0100 Subject: [PATCH 42/79] Implement backwards compatibility, refactor --- src/api/workspaceManager.ts | 130 +++++++++----------------- src/config/settings.ts | 176 ++++++++++++++++++++---------------- src/extension.ts | 17 +++- src/init/ui.ts | 90 +----------------- src/window/index.ts | 2 +- 5 files changed, 158 insertions(+), 257 deletions(-) diff --git a/src/api/workspaceManager.ts b/src/api/workspaceManager.ts index 9650deaf..73aa068f 100644 --- a/src/api/workspaceManager.ts +++ b/src/api/workspaceManager.ts @@ -14,7 +14,7 @@ import { WORKSPACE_SETTINGS, } from "../config/constants"; import Resources, { EditorKind } from "../config/resources"; -import { Logger, LogLevel } from "../utils"; +import { Logger } from "../utils"; export enum ExerciseStatus { Closed = "closed", @@ -66,53 +66,6 @@ export default class WorkspaceManager implements vscode.Disposable { this._onDidChangeWorkspaceFolders(e), ), vscode.workspace.onDidOpenTextDocument((e) => this._onDidOpenTextDocument(e)), - vscode.workspace.onDidChangeConfiguration(async (event) => { - /* https://github.com/microsoft/vscode/issues/58038 - Sometimes we need to force set the value to true in .code-workspace file, - because for some reason true isn't set and the key/value pair is removed - */ - if (event.affectsConfiguration("testMyCode.logLevel")) { - Logger.configure( - this.getWorkspaceSettings("testMyCode").get("logLevel"), - ); - } - if (event.affectsConfiguration("testMyCode.hideMetaFiles", this.workspaceFileUri)) { - const configuration = this.getWorkspaceSettings("testMyCode"); - const value = configuration.get("hideMetaFiles"); - if (value) { - await this._updateWorkspaceSetting("testMyCode.hideMetaFiles", value); - } - await this.excludeMetaFilesInWorkspace(value); - } - if ( - event.affectsConfiguration( - "testMyCode.downloadOldSubmission", - this.workspaceFileUri, - ) - ) { - const value = this.getWorkspaceSettings("testMyCode").get( - "downloadOldSubmission", - ); - await this._updateWorkspaceSetting("testMyCode.downloadOldSubmission", value); - } - if ( - event.affectsConfiguration( - "testMyCode.updateExercisesAutomatically", - this.workspaceFileUri, - ) - ) { - const value = this.getWorkspaceSettings("testMyCode").get( - "updateExercisesAutomatically", - ); - await this._updateWorkspaceSetting( - "testMyCode.updateExercisesAutomatically", - value, - ); - } - if (event.affectsConfiguration("testMyCode.tmcDataPath")) { - Logger.warn("Not supported."); - } - }), ]; } @@ -258,12 +211,9 @@ export default class WorkspaceManager implements vscode.Disposable { this._disposables.forEach((x) => x.dispose()); } - public async excludeMetaFilesInWorkspace(hide: boolean | undefined): Promise { - if (hide === undefined) { - return; - } + public async excludeMetaFilesInWorkspace(hide: boolean): Promise { const value = hide ? HIDE_META_FILES : SHOW_META_FILES; - await this._updateWorkspaceSetting("files.exclude", value); + await this.updateWorkspaceSetting("files.exclude", value); } /** @@ -281,10 +231,11 @@ export default class WorkspaceManager implements vscode.Disposable { public async verifyWorkspaceSettingsIntegrity(): Promise { if (this.activeCourse) { Logger.log("TMC Workspace open, verifying workspace settings integrity."); - const hideMetaFiles = this.getWorkspaceSettings("testMyCode").get( + const hideMetaFiles = this.getWorkspaceSettings("testMyCode").get( "hideMetaFiles", + true, ); - await this.excludeMetaFilesInWorkspace(hideMetaFiles ?? false); + await this.excludeMetaFilesInWorkspace(hideMetaFiles); await this.ensureSettingsAreStoredInMultiRootWorkspace(); await this._verifyWatcherPatternExclusion(); await this._forceTMCWorkspaceSettings(); @@ -295,25 +246,48 @@ export default class WorkspaceManager implements vscode.Disposable { * Ensures that settings defined in package.json are written to the multi-root * workspace file. If the key can't be found in the .code-workspace file, it will write the * setting defined in the User scope to the file. Last resort, default value. + * + * This is to ensure that workspace defined settings really overrides the user scope... * https://github.com/microsoft/vscode/issues/58038 */ public async ensureSettingsAreStoredInMultiRootWorkspace(): Promise { const extension = vscode.extensions.getExtension("moocfi.test-my-code"); const extensionDefinedSettings: Record = extension?.packageJSON?.contributes?.configuration?.properties; - Object.entries(extensionDefinedSettings).forEach(([key, value]) => { - // If not User scope setting, we write it to multi-root workspace. - if (value.scope !== "application") { - const codeSettings = this.getWorkspaceSettings().inspect(key); + for (const [key, value] of Object.entries(extensionDefinedSettings)) { + if (value.scope !== "application" && value.type === "boolean") { + const codeSettings = this.getWorkspaceSettings().inspect(key); if (codeSettings?.workspaceValue !== undefined) { - this._updateWorkspaceSetting(key, codeSettings.workspaceValue); + await this.updateWorkspaceSetting(key, codeSettings.workspaceValue); } else if (codeSettings?.globalValue !== undefined) { - this._updateWorkspaceSetting(key, codeSettings.globalValue); + await this.updateWorkspaceSetting(key, codeSettings.globalValue); } else { - this._updateWorkspaceSetting(key, codeSettings?.defaultValue); + await this.updateWorkspaceSetting(key, codeSettings?.defaultValue); } } - }); + } + } + + /** + * Updates a section for the TMC Workspace.code-workspace file, if the workspace is open. + * @param section Configuration name, supports dotted names. + * @param value The new value + */ + public async updateWorkspaceSetting(section: string, value: unknown): Promise { + const activeCourse = this.activeCourse; + if (activeCourse) { + let newValue = value; + if (value instanceof Object) { + const oldValue = this.getWorkspaceSettings(section); + newValue = { ...oldValue, ...value }; + } + await vscode.workspace + .getConfiguration( + undefined, + vscode.Uri.file(this._resources.getWorkspaceFilePath(activeCourse)), + ) + .update(section, newValue, vscode.ConfigurationTarget.Workspace); + } } /** @@ -339,9 +313,9 @@ export default class WorkspaceManager implements vscode.Disposable { * Force some settings for TMC multi-root workspaces that we want. */ private async _forceTMCWorkspaceSettings(): Promise { - await this._updateWorkspaceSetting("explorer.decorations.colors", false); - await this._updateWorkspaceSetting("explorer.decorations.badges", true); - await this._updateWorkspaceSetting("problems.decorations.enabled", false); + await this.updateWorkspaceSetting("explorer.decorations.colors", false); + await this.updateWorkspaceSetting("explorer.decorations.badges", true); + await this.updateWorkspaceSetting("problems.decorations.enabled", false); } /** @@ -473,34 +447,12 @@ export default class WorkspaceManager implements vscode.Disposable { } } - /** - * Updates a section for the TMC Workspace.code-workspace file, if the workspace is open. - * @param section Configuration name, supports dotted names. - * @param value The new value - */ - private async _updateWorkspaceSetting(section: string, value: unknown): Promise { - const activeCourse = this.activeCourse; - if (activeCourse) { - let newValue = value; - if (value instanceof Object) { - const oldValue = this.getWorkspaceSettings(section); - newValue = { ...oldValue, ...value }; - } - await vscode.workspace - .getConfiguration( - undefined, - vscode.Uri.file(this._resources.getWorkspaceFilePath(activeCourse)), - ) - .update(section, newValue, vscode.ConfigurationTarget.Workspace); - } - } - /** * Makes sure that folders and its contents aren't deleted by our watcher. * .vscode folder needs to be unwatched, otherwise adding settings to WorkspaceFolder level * doesn't work. For example defining Python interpreter for the Exercise folder. */ private async _verifyWatcherPatternExclusion(): Promise { - await this._updateWorkspaceSetting("files.watcherExclude", { ...WATCHER_EXCLUDE }); + await this.updateWorkspaceSetting("files.watcherExclude", { ...WATCHER_EXCLUDE }); } } diff --git a/src/config/settings.ts b/src/config/settings.ts index 52de8cca..05f3f746 100644 --- a/src/config/settings.ts +++ b/src/config/settings.ts @@ -1,4 +1,3 @@ -import * as path from "path"; import { Ok, Result } from "ts-results"; import * as vscode from "vscode"; @@ -9,7 +8,6 @@ import Storage, { import { Logger, LogLevel } from "../utils/logger"; import Resources from "./resources"; -import { ExtensionSettingsData } from "./types"; export interface ExtensionSettings { downloadOldSubmission: boolean; @@ -20,9 +18,14 @@ export interface ExtensionSettings { } /** - * TODO: Deprecate class + * Class to manage VSCode setting changes and trigger events based on changes. + * Remove Storage dependency once 3.0 major release is being done, as then + * we do not need to be backwards compatible. + * + * Handle multi-root workspace changes by creating callbacks in extension.ts, + * so that we can test and don't need workspaceManager dependency. */ -export default class Settings { +export default class Settings implements vscode.Disposable { private static readonly _defaultSettings: ExtensionSettings = { downloadOldSubmission: true, hideMetaFiles: true, @@ -31,12 +34,19 @@ export default class Settings { updateExercisesAutomatically: true, }; - private readonly _storage: Storage; + private _onChangeHideMetaFiles?: (value: boolean) => void; + private _onChangeDownloadOldSubmission?: (value: boolean) => void; + private _onChangeUpdateExercisesAutomatically?: (value: boolean) => void; + /** + * @deprecated Storage dependency should be removed when major 3.0 release. + */ + private readonly _storage: Storage; private readonly _resources: Resources; private _settings: ExtensionSettings; private _state: SessionState; + private _disposables: vscode.Disposable[]; constructor(storage: Storage, resources: Resources) { this._storage = storage; @@ -46,101 +56,94 @@ export default class Settings { ? Settings._deserializeExtensionSettings(storedSettings) : Settings._defaultSettings; this._state = storage.getSessionState() ?? {}; - } - - /** - * Update extension settings to storage. - * @param settings ExtensionSettings object - */ - public async updateExtensionSettingsToStorage(settings: ExtensionSettings): Promise { - await this._storage.updateExtensionSettings(settings); - } - - /** - * Updates individual setting for user and adds them to user storage. - * - * @param {ExtensionSettingsData} data ExtensionSettingsData object, for example { setting: - * 'dataPath', value: '~/newpath' } - */ - public async updateSetting(data: ExtensionSettingsData): Promise { - /* - The following below is to ensure that User scope settings match the settings - we currently store in extension context globalStorage. - */ - const workspaceFile = vscode.workspace.workspaceFile; - let isOurWorkspace: string | undefined = undefined; - if ( - workspaceFile && - path.relative(workspaceFile.fsPath, this._resources.workspaceFileFolder) === ".." - ) { - isOurWorkspace = vscode.workspace.name?.split(" ")[0]; - } - - switch (data.setting) { - case "downloadOldSubmission": - this._settings.downloadOldSubmission = data.value; - if (isOurWorkspace && workspaceFile) { - await vscode.workspace + this._disposables = [ + vscode.workspace.onDidChangeConfiguration(async (event) => { + if (event.affectsConfiguration("testMyCode.logLevel")) { + const value = vscode.workspace .getConfiguration("testMyCode") - .update("downloadOldSubmission", data.value); + .get("logLevel", LogLevel.Errors); + Logger.configure(value); + this._settings.logLevel = value; } - break; - case "hideMetaFiles": - this._settings.hideMetaFiles = data.value; - if (isOurWorkspace && workspaceFile) { - await vscode.workspace + if (event.affectsConfiguration("testMyCode.insiderVersion")) { + const value = vscode.workspace .getConfiguration("testMyCode") - .update("hideMetaFiles", data.value); + .get("insiderVersion", false); + this._settings.insiderVersion = value; } - break; - case "insiderVersion": - this._settings.insiderVersion = data.value; - await vscode.workspace - .getConfiguration("testMyCode") - .update("insiderVersion", data.value); - break; - case "logLevel": - this._settings.logLevel = data.value; - await vscode.workspace - .getConfiguration("testMyCode") - .update("logLevel", data.value); - break; - case "updateExercisesAutomatically": - this._settings.updateExercisesAutomatically = data.value; - if (isOurWorkspace && workspaceFile) { - await vscode.workspace - .getConfiguration("testMyCode") - .update("updateExercisesAutomatically", data.value); + if (event.affectsConfiguration("testMyCode.tmcDataPath")) { + Logger.warn("Not supported."); } - break; - } - Logger.log("Updated settings data", data); - await this.updateExtensionSettingsToStorage(this._settings); + + // Workspace settings + if (event.affectsConfiguration("testMyCode.hideMetaFiles")) { + const value = this._getWorkspaceSettingValue("hideMetaFiles"); + this._onChangeHideMetaFiles?.(value); + this._settings.hideMetaFiles = value; + } + if (event.affectsConfiguration("testMyCode.downloadOldSubmission")) { + const value = this._getWorkspaceSettingValue("downloadOldSubmission"); + this._onChangeDownloadOldSubmission?.(value); + this._settings.downloadOldSubmission = value; + } + if (event.affectsConfiguration("testMyCode.updateExercisesAutomatically")) { + const value = this._getWorkspaceSettingValue("updateExercisesAutomatically"); + this._onChangeUpdateExercisesAutomatically?.(value); + this._settings.updateExercisesAutomatically = value; + } + await this.updateExtensionSettingsToStorage(this._settings); + }), + ]; + } + + public set onChangeHideMetaFiles(callback: (value: boolean) => void) { + this._onChangeHideMetaFiles = callback; + } + + public set onChangeDownloadOldSubmission(callback: (value: boolean) => void) { + this._onChangeDownloadOldSubmission = callback; + } + + public set onChangeUpdateExercisesAutomatically(callback: (value: boolean) => void) { + this._onChangeUpdateExercisesAutomatically = callback; + } + + public dispose(): void { + this._disposables.forEach((x) => x.dispose()); + } + + public async updateExtensionSettingsToStorage(settings: ExtensionSettings): Promise { + await this._storage.updateExtensionSettings(settings); } public getLogLevel(): LogLevel { - return this._settings.logLevel; + return vscode.workspace + .getConfiguration("testMyCode") + .get("logLevel", LogLevel.Errors); } public getDownloadOldSubmission(): boolean { - return this._settings.downloadOldSubmission; + return this._getWorkspaceSettingValue("downloadOldSubmission"); } public getAutomaticallyUpdateExercises(): boolean { - return this._settings.updateExercisesAutomatically; + return this._getWorkspaceSettingValue("updateExercisesAutomatically"); } - /** - * Gets the extension settings from storage. - * - * @returns ExtensionSettings object or error - */ public async getExtensionSettings(): Promise> { return Ok(this._settings); } public isInsider(): boolean { - return this._settings.insiderVersion; + return vscode.workspace + .getConfiguration("testMyCode") + .get("insiderVersion", false); + } + + public async configureIsInsider(value: boolean): Promise { + this._settings.insiderVersion = value; + vscode.workspace.getConfiguration("testMyCode").update("insiderVersion", value, true); + await this.updateExtensionSettingsToStorage(this._settings); } private static _deserializeExtensionSettings( @@ -164,4 +167,19 @@ export default class Settings { logLevel, }; } + + /** + * workspaceValue is undefined in multi-root workspace if it matches defaultValue + * We want to "force" the value in the multi-root workspace, because then + * the workspace scope > user scope. + */ + private _getWorkspaceSettingValue(section: string): boolean { + const configuration = vscode.workspace.getConfiguration("testMyCode"); + const scopeSettings = configuration.inspect(section); + if (scopeSettings?.workspaceValue === undefined) { + return !!scopeSettings?.defaultValue; + } else { + return scopeSettings.workspaceValue; + } + } } diff --git a/src/extension.ts b/src/extension.ts index 1f7c9c36..a4169759 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -110,7 +110,6 @@ export async function activate(context: vscode.ExtensionContext): Promise } const resources = resourcesResult.val; - const settings = new Settings(storage, resources); Logger.configure( vscode.workspace.getConfiguration("testMyCode").get("logLevel") ?? LogLevel.Errors, @@ -148,6 +147,22 @@ export async function activate(context: vscode.ExtensionContext): Promise await workspaceManager.verifyWorkspaceSettingsIntegrity(); } + const settings = new Settings(storage, resources); + context.subscriptions.push(settings); + settings.onChangeHideMetaFiles = async (value: boolean): Promise => { + await workspaceManager.updateWorkspaceSetting("testMyCode.hideMetaFiles", value); + await workspaceManager.excludeMetaFilesInWorkspace(value); + }; + settings.onChangeDownloadOldSubmission = async (value: boolean): Promise => { + await workspaceManager.updateWorkspaceSetting("testMyCode.downloadOldSubmission", value); + }; + settings.onChangeUpdateExercisesAutomatically = async (value: boolean): Promise => { + await workspaceManager.updateWorkspaceSetting( + "testMyCode.updateExercisesAutomatically", + value, + ); + }; + const temporaryWebviewProvider = new TemporaryWebviewProvider(resources, ui); const exerciseDecorationProvider = new ExerciseDecorationProvider(userData, workspaceManager); const actionContext: ActionContext = { diff --git a/src/init/ui.ts b/src/init/ui.ts index f7454145..baee2f9d 100644 --- a/src/init/ui.ts +++ b/src/init/ui.ts @@ -18,7 +18,7 @@ import { updateCourse, } from "../actions"; import { ActionContext } from "../actions/types"; -import { formatSizeInBytes, Logger, LogLevel } from "../utils/"; +import { formatSizeInBytes, Logger } from "../utils/"; /** * Registers the various actions and handlers required for the user interface to function. @@ -27,15 +27,7 @@ import { formatSizeInBytes, Logger, LogLevel } from "../utils/"; * @param tmc The TMC API object */ export function registerUiActions(actionContext: ActionContext): void { - const { - dialog, - ui, - resources, - settings, - userData, - visibilityGroups, - workspaceManager, - } = actionContext; + const { dialog, ui, resources, settings, userData, visibilityGroups } = actionContext; Logger.log("Initializing UI Actions"); // Register UI actions @@ -320,46 +312,13 @@ export function registerUiActions(actionContext: ActionContext): void { } }); - ui.webview.registerHandler( - "changeLogLevel", - async (msg: { type?: "changeLogLevel"; data?: LogLevel }) => { - if (!(msg.type && msg.data)) { - return; - } - await settings.updateSetting({ setting: "logLevel", value: msg.data }); - Logger.configure(msg.data); - ui.webview.postMessage({ command: "setLogLevel", level: msg.data }); - }, - ); - - ui.webview.registerHandler( - "hideMetaFiles", - async (msg: { type?: "hideMetaFiles"; data?: boolean }) => { - if (!(msg.type && msg.data !== undefined)) { - return; - } - await settings.updateSetting({ setting: "hideMetaFiles", value: msg.data }); - await workspaceManager.excludeMetaFilesInWorkspace(msg.data); - ui.webview.postMessage({ - command: "setBooleanSetting", - setting: "hideMetaFiles", - enabled: msg.data, - }); - }, - ); - ui.webview.registerHandler( "insiderStatus", async (msg: { type?: "insiderStatus"; data?: boolean }) => { if (!(msg.type && msg.data !== undefined)) { return; } - await settings.updateSetting({ setting: "insiderVersion", value: msg.data }); - ui.webview.postMessage({ - command: "setBooleanSetting", - setting: "insider", - enabled: msg.data, - }); + await settings.configureIsInsider(!!msg.data); }, ); @@ -376,47 +335,4 @@ export function registerUiActions(actionContext: ActionContext): void { } vscode.commands.executeCommand("workbench.action.openExtensionLogsFolder"); }); - - ui.webview.registerHandler("openEditorDirection", (msg: { type?: "openEditorDirection" }) => { - if (!msg.type) { - return; - } - const search = "workbench.editor.openSideBySideDirection"; - // openWorkspaceSettings doesn't take search params: - // https://github.com/microsoft/vscode/issues/90086 - vscode.commands.executeCommand("workbench.action.openSettings", search); - }); - - ui.webview.registerHandler( - "downloadOldSubmissionSetting", - async (msg: { type?: "downloadOldSubmissionSetting"; data?: boolean }) => { - if (!(msg.type && msg.data !== undefined)) { - return; - } - await settings.updateSetting({ setting: "downloadOldSubmission", value: msg.data }); - ui.webview.postMessage({ - command: "setBooleanSetting", - setting: "downloadOldSubmission", - enabled: msg.data, - }); - }, - ); - - ui.webview.registerHandler( - "updateExercisesAutomaticallySetting", - async (msg: { type?: "updateExercisesAutomaticallySetting"; data?: boolean }) => { - if (!(msg.type && msg.data !== undefined)) { - return; - } - await settings.updateSetting({ - setting: "updateExercisesAutomatically", - value: msg.data, - }); - ui.webview.postMessage({ - command: "setBooleanSetting", - setting: "updateExercisesAutomatically", - enabled: msg.data, - }); - }, - ); } diff --git a/src/window/index.ts b/src/window/index.ts index 22c7bf4e..72bc7f54 100644 --- a/src/window/index.ts +++ b/src/window/index.ts @@ -49,7 +49,7 @@ function getPythonPath( } else { return actionContext.workspaceManager .getWorkspaceSettings() - ?.get("python.pythonPath"); + .get("python.pythonPath"); } } catch (error) { const message = "Error while fetching python executable string"; From 8d9f056d8c35e009768d5147bb76204e17e7334b Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Tue, 27 Apr 2021 16:23:13 +0300 Subject: [PATCH 43/79] Improve exercise download command --- src/actions/downloadNewExercisesForCourse.ts | 2 +- .../downloadOrUpdateCourseExercises.ts | 71 ------- src/actions/downloadOrUpdateExercises.ts | 74 +++++++ src/actions/index.ts | 2 +- src/api/langsSchema.ts | 14 +- .../actions/downloadOrUpdateExercises.test.ts | 200 ++++++++++++++++++ src/test/mocks/tmc.ts | 11 +- src/test/mocks/ui.ts | 26 +++ src/test/mocks/webview.ts | 24 +++ 9 files changed, 344 insertions(+), 80 deletions(-) delete mode 100644 src/actions/downloadOrUpdateCourseExercises.ts create mode 100644 src/actions/downloadOrUpdateExercises.ts create mode 100644 src/test/actions/downloadOrUpdateExercises.test.ts create mode 100644 src/test/mocks/ui.ts create mode 100644 src/test/mocks/webview.ts diff --git a/src/actions/downloadNewExercisesForCourse.ts b/src/actions/downloadNewExercisesForCourse.ts index 3da46017..5a1fe02b 100644 --- a/src/actions/downloadNewExercisesForCourse.ts +++ b/src/actions/downloadNewExercisesForCourse.ts @@ -2,7 +2,7 @@ import { Ok, Result } from "ts-results"; import { Logger } from "../utils"; -import { downloadOrUpdateExercises } from "./downloadOrUpdateCourseExercises"; +import { downloadOrUpdateExercises } from "./downloadOrUpdateExercises"; import { refreshLocalExercises } from "./refreshLocalExercises"; import { ActionContext } from "./types"; diff --git a/src/actions/downloadOrUpdateCourseExercises.ts b/src/actions/downloadOrUpdateCourseExercises.ts deleted file mode 100644 index aeba1d7a..00000000 --- a/src/actions/downloadOrUpdateCourseExercises.ts +++ /dev/null @@ -1,71 +0,0 @@ -import { concat, flatten, groupBy, partition } from "lodash"; -import * as pLimit from "p-limit"; -import { Ok, Result } from "ts-results"; - -import { WebviewMessage } from "../ui/types"; - -import { ActionContext } from "./types"; - -// Use this until using Langs version with file locks -const limit = pLimit(1); - -/** - * Downloads given exercises and opens them in TMC workspace. - * - * @param exerciseIds Exercises to download. - * @returns Exercise ids for successful downloads. - */ -export async function downloadOrUpdateExercises( - actionContext: ActionContext, - exerciseIds: number[], -): Promise> { - const { dialog, tmc, ui, userData } = actionContext; - - // TODO: How to download latest submission in new version? - const downloadResult = await dialog.progressNotification( - "Downloading exercises...", - (progress) => - limit(() => - tmc.downloadExercises(exerciseIds, (download) => { - progress.report(download); - ui.webview.postMessage({ - command: "exerciseStatusChange", - exerciseId: download.id, - status: "closed", - }); - }), - ), - ); - if (downloadResult.err) { - return downloadResult; - } - - // Some code still treats exercises by their ids, so return those instead. - // Uuunfortunately. - const successfulSlugs = concat(downloadResult.val.downloaded, downloadResult.val.skipped); - const successfulByCourse = groupBy(successfulSlugs, (x) => x["course-slug"]); - const successfulIdsByCourse = Object.keys(successfulByCourse).map((course) => { - const downloadedSlugs = new Set(successfulByCourse[course].map((x) => x["exercise-slug"])); - return userData - .getCourseByName(course) - .exercises.filter((x) => downloadedSlugs.has(x.name)) - .map((x) => x.id); - }); - const successfulIds = new Set(flatten(successfulIdsByCourse)); - const [successful, failed] = partition(exerciseIds, (x) => successfulIds.has(x)); - - ui.webview.postMessage( - ...successful.map((x) => ({ - command: "exerciseStatusChange", - exerciseId: x, - status: "opened", - })), - ...failed.map((x) => ({ - command: "exerciseStatusChange", - exerciseId: x, - status: "closed", - })), - ); - - return Ok({ successful, failed }); -} diff --git a/src/actions/downloadOrUpdateExercises.ts b/src/actions/downloadOrUpdateExercises.ts new file mode 100644 index 00000000..67493cab --- /dev/null +++ b/src/actions/downloadOrUpdateExercises.ts @@ -0,0 +1,74 @@ +import { partition } from "lodash"; +import * as pLimit from "p-limit"; +import { Ok, Result } from "ts-results"; + +import { ExerciseStatus, WebviewMessage } from "../ui/types"; +import { Logger } from "../utils"; + +import { ActionContext } from "./types"; + +// Use this until using Langs version with file locks +const limit = pLimit(1); + +/** + * Downloads given exercises and opens them in TMC workspace. + * + * @param exerciseIds Exercises to download. + * @returns Exercise ids for successful downloads. + */ +export async function downloadOrUpdateExercises( + actionContext: ActionContext, + exerciseIds: number[], +): Promise> { + const { dialog, tmc, ui } = actionContext; + if (exerciseIds.length === 0) { + return Ok({ successful: [], failed: [] }); + } + + ui.webview.postMessage(...exerciseIds.map((x) => wrapToMessage(x, "downloading"))); + + // TODO: How to download latest submission in new version? + const downloadResult = await dialog.progressNotification( + "Downloading exercises...", + (progress) => + limit(() => + tmc.downloadExercises(exerciseIds, (download) => { + progress.report(download); + ui.webview.postMessage(wrapToMessage(download.id, "closed")); + }), + ), + ); + + return downloadResult.andThen(({ downloaded, failed, skipped }) => { + skipped.length > 0 && Logger.warn(`${skipped.length} downloads were skipped.`); + const resultMap = new Map( + exerciseIds.map((x) => [x, "downloadFailed"]), + ); + downloaded.forEach((x) => resultMap.set(x.id, "closed")); + skipped.forEach((x) => resultMap.set(x.id, "closed")); + failed?.forEach((x) => { + Logger.error(`Failed to download exercise ${x[0]["exercise-slug"]}: ${x[1]}`); + resultMap.set(x[0].id, "downloadFailed"); + }); + const entries = Array.from(resultMap.entries()); + ui.webview.postMessage( + ...entries.map(([id, status]) => wrapToMessage(id, status)), + ); + const [successfulIds, failedIds] = partition( + entries, + ([, status]) => status !== "downloadFailed", + ); + return Ok({ + successful: successfulIds.map((x) => x[0]), + failed: failedIds.map((x) => x[0]), + }); + }); +} + +function wrapToMessage(exerciseId: number, status: ExerciseStatus): WebviewMessage { + return { + command: "exerciseStatusChange", + exerciseId, + status, + }; +} diff --git a/src/actions/index.ts b/src/actions/index.ts index 0f382177..f229ba2a 100644 --- a/src/actions/index.ts +++ b/src/actions/index.ts @@ -1,7 +1,7 @@ export * from "./addNewCourse"; export * from "./checkForExerciseUpdates"; export * from "./downloadNewExercisesForCourse"; -export * from "./downloadOrUpdateCourseExercises"; +export * from "./downloadOrUpdateExercises"; export * from "./moveExtensionDataPath"; export * from "./refreshLocalExercises"; export * from "./selectOrganizationAndCourse"; diff --git a/src/api/langsSchema.ts b/src/api/langsSchema.ts index ae195ed9..2f49080f 100644 --- a/src/api/langsSchema.ts +++ b/src/api/langsSchema.ts @@ -57,9 +57,9 @@ export interface ErrorResponse { } export interface FailedExerciseDownload { - completed: DownloadOrUpdateCourseExercise[]; - skipped: DownloadOrUpdateCourseExercise[]; - failed: Array<[DownloadOrUpdateCourseExercise, string[]]>; + completed: ExerciseDownload[]; + skipped: ExerciseDownload[]; + failed: Array<[ExerciseDownload, string[]]>; } export type ErrorResponseKind = @@ -78,11 +78,13 @@ export interface CombinedCourseData { } export interface DownloadOrUpdateCourseExercisesResult { - downloaded: DownloadOrUpdateCourseExercise[]; - skipped: DownloadOrUpdateCourseExercise[]; + downloaded: ExerciseDownload[]; + skipped: ExerciseDownload[]; + failed: Array<[ExerciseDownload, string]> | null; } -export interface DownloadOrUpdateCourseExercise { +export interface ExerciseDownload { + id: number; "course-slug": string; "exercise-slug": string; path: string; diff --git a/src/test/actions/downloadOrUpdateExercises.test.ts b/src/test/actions/downloadOrUpdateExercises.test.ts new file mode 100644 index 00000000..9ce1405c --- /dev/null +++ b/src/test/actions/downloadOrUpdateExercises.test.ts @@ -0,0 +1,200 @@ +import { expect } from "chai"; +import { first, last } from "lodash"; +import { Ok, Result } from "ts-results"; +import { IMock, It, Times } from "typemoq"; + +import { downloadOrUpdateExercises } from "../../actions"; +import { ActionContext } from "../../actions/types"; +import Dialog from "../../api/dialog"; +import { DownloadOrUpdateCourseExercisesResult, ExerciseDownload } from "../../api/langsSchema"; +import TMC from "../../api/tmc"; +import { ExerciseStatus, WebviewMessage } from "../../ui/types"; +import UI from "../../ui/ui"; +import TmcWebview from "../../ui/webview"; +import { createMockActionContext } from "../mocks/actionContext"; +import { createDialogMock } from "../mocks/dialog"; +import { createTMCMock, TMCMockValues } from "../mocks/tmc"; +import { createUIMock, UIMockValues } from "../mocks/ui"; +import { createWebviewMock, WebviewMockValues } from "../mocks/webview"; + +const helloWorld: ExerciseDownload = { + "course-slug": "python-course", + "exercise-slug": "hello_world", + id: 1, + path: "/tmc/vscode/test-python-course/hello_world", +}; + +const otherWorld: ExerciseDownload = { + "course-slug": "python-course", + "exercise-slug": "other_world", + id: 2, + path: "/tmc/vscode/test-python-course/other_world", +}; + +suite("downloadOrUpdateExercises action", function () { + const stubContext = createMockActionContext(); + + let dialogMock: IMock; + let tmcMock: IMock; + let tmcMockValues: TMCMockValues; + let uiMock: IMock; + let uiMockValues: UIMockValues; + let webviewMessages: WebviewMessage[]; + let webviewMock: IMock; + let webviewMockValues: WebviewMockValues; + + const actionContext = (): ActionContext => ({ + ...stubContext, + dialog: dialogMock.object, + tmc: tmcMock.object, + ui: uiMock.object, + }); + + const createDownloadResult = ( + downloaded: ExerciseDownload[], + skipped: ExerciseDownload[], + failed: Array<[ExerciseDownload, string]> | null, + ): Result => { + return Ok({ + downloaded, + failed, + skipped, + }); + }; + + setup(function () { + [dialogMock] = createDialogMock(); + [tmcMock, tmcMockValues] = createTMCMock(); + [uiMock, uiMockValues] = createUIMock(); + webviewMessages = []; + [webviewMock, webviewMockValues] = createWebviewMock(); + webviewMockValues.postMessage = (...x): number => webviewMessages.push(...x); + uiMockValues.webview = webviewMock.object; + }); + + test("should return empty results if no exercises are given", async function () { + const result = (await downloadOrUpdateExercises(actionContext(), [])).unwrap(); + expect(result.successful.length).to.be.equal(0); + expect(result.failed.length).to.be.equal(0); + }); + + test("should not call TMC-langs if no exercises are given", async function () { + await downloadOrUpdateExercises(actionContext(), []); + expect(tmcMock.verify((x) => x.downloadExercises(It.isAny(), It.isAny()), Times.never())); + }); + + test("should return ids of successful downloads", async function () { + tmcMockValues.downloadExercises = createDownloadResult([helloWorld, otherWorld], [], null); + const result = (await downloadOrUpdateExercises(actionContext(), [1, 2])).unwrap(); + expect(result.successful).to.be.deep.equal([1, 2]); + }); + + test("should return ids of skipped downloads as successful", async function () { + tmcMockValues.downloadExercises = createDownloadResult([], [helloWorld, otherWorld], null); + const result = (await downloadOrUpdateExercises(actionContext(), [1, 2])).unwrap(); + expect(result.successful).to.be.deep.equal([1, 2]); + }); + + test("should combine successful and skipped downloads", async function () { + tmcMockValues.downloadExercises = createDownloadResult([helloWorld], [otherWorld], null); + const result = (await downloadOrUpdateExercises(actionContext(), [1])).unwrap(); + expect(result.successful).to.be.deep.equal([1, 2]); + }); + + test("should return ids of failed downloads", async function () { + tmcMockValues.downloadExercises = createDownloadResult( + [], + [], + [ + [helloWorld, ""], + [otherWorld, ""], + ], + ); + const result = (await downloadOrUpdateExercises(actionContext(), [1, 2])).unwrap(); + expect(result.failed).to.be.deep.equal([1, 2]); + }); + + test("should post status updates of succeeding download", async function () { + tmcMock.reset(); + tmcMock + .setup((x) => x.downloadExercises(It.isAny(), It.isAny())) + .returns(async (_, cb) => { + // Callback is only used for successful downloads + cb({ id: helloWorld.id, percent: 0.5 }); + return createDownloadResult([helloWorld], [], null); + }); + await downloadOrUpdateExercises(actionContext(), [1]); + expect(webviewMessages.length).to.be.greaterThanOrEqual( + 2, + "expected at least two status messages", + ); + expect(first(webviewMessages)).to.be.deep.equal( + wrapToMessage(helloWorld.id, "downloading"), + 'expected first message to be "downloading"', + ); + expect(last(webviewMessages)).to.be.deep.equal( + wrapToMessage(helloWorld.id, "closed"), + 'expected last message to be "closed"', + ); + }); + + test("should post status updates for skipped download", async function () { + tmcMockValues.downloadExercises = createDownloadResult([helloWorld], [], null); + await downloadOrUpdateExercises(actionContext(), [1]); + expect(webviewMessages.length).to.be.greaterThanOrEqual( + 2, + "expected at least two status messages", + ); + expect(first(webviewMessages)).to.be.deep.equal( + wrapToMessage(helloWorld.id, "downloading"), + 'expected first message to be "downloading"', + ); + expect(last(webviewMessages)).to.be.deep.equal( + wrapToMessage(helloWorld.id, "closed"), + 'expected last message to be "closed"', + ); + }); + + test("should post status updates of failing download", async function () { + tmcMockValues.downloadExercises = createDownloadResult([], [], [[helloWorld, ""]]); + await downloadOrUpdateExercises(actionContext(), [1]); + expect(webviewMessages.length).to.be.greaterThanOrEqual( + 2, + "expected at least two status messages", + ); + expect(first(webviewMessages)).to.be.deep.equal( + wrapToMessage(helloWorld.id, "downloading"), + 'expected first message to be "downloading"', + ); + expect(last(webviewMessages)).to.be.deep.equal( + wrapToMessage(helloWorld.id, "downloadFailed"), + 'expected last message to be "downloadFailed"', + ); + }); + + test("should post status updates for exercises missing from langs response", async function () { + tmcMockValues.downloadExercises = createDownloadResult([], [], null); + await downloadOrUpdateExercises(actionContext(), [1]); + expect(webviewMessages.length).to.be.greaterThanOrEqual( + 2, + "expected at least two status messages", + ); + expect(first(webviewMessages)).to.be.deep.equal( + wrapToMessage(helloWorld.id, "downloading"), + 'expected first message to be "downloading"', + ); + expect(last(webviewMessages)).to.be.deep.equal( + wrapToMessage(helloWorld.id, "downloadFailed"), + 'expected last message to be "downloadFailed"', + ); + }); +}); + +// These kind of functions should maybe be in utils? +function wrapToMessage(exerciseId: number, status: ExerciseStatus): WebviewMessage { + return { + command: "exerciseStatusChange", + exerciseId, + status, + }; +} diff --git a/src/test/mocks/tmc.ts b/src/test/mocks/tmc.ts index 62f1c763..db7e7c7b 100644 --- a/src/test/mocks/tmc.ts +++ b/src/test/mocks/tmc.ts @@ -1,7 +1,7 @@ import { Err, Ok, Result } from "ts-results"; import { IMock, It, Mock } from "typemoq"; -import { LocalExercise } from "../../api/langsSchema"; +import { DownloadOrUpdateCourseExercisesResult, LocalExercise } from "../../api/langsSchema"; import TMC from "../../api/tmc"; import { checkExerciseUpdates, @@ -9,8 +9,11 @@ import { listLocalCourseExercisesPythonCourse, } from "../fixtures/tmc"; +const NOT_MOCKED_ERROR = Err(new Error("Method was not mocked.")); + export interface TMCMockValues { clean: Result; + downloadExercises: Result; listLocalCourseExercisesPythonCourse: Result; getSettingClosedExercises: Result; getSettingProjectsDir: Result; @@ -23,6 +26,7 @@ export interface TMCMockValues { export function createTMCMock(): [IMock, TMCMockValues] { const values: TMCMockValues = { clean: Ok.EMPTY, + downloadExercises: NOT_MOCKED_ERROR, listLocalCourseExercisesPythonCourse: Ok(listLocalCourseExercisesPythonCourse), getSettingClosedExercises: Ok(closedExercisesPythonCourse), getSettingProjectsDir: Ok("/langs/path/to/exercises"), @@ -40,6 +44,7 @@ export function createFailingTMCMock(): [IMock, TMCMockValues] { const error = Err(new Error()); const values: TMCMockValues = { clean: error, + downloadExercises: NOT_MOCKED_ERROR, listLocalCourseExercisesPythonCourse: error, getSettingClosedExercises: error, getSettingProjectsDir: error, @@ -98,5 +103,9 @@ function setupMockValues(values: TMCMockValues): IMock { async () => values.checkExerciseUpdates, ); + mock.setup((x) => x.downloadExercises(It.isAny(), It.isAny())).returns( + async () => values.downloadExercises, + ); + return mock; } diff --git a/src/test/mocks/ui.ts b/src/test/mocks/ui.ts new file mode 100644 index 00000000..3c0d2129 --- /dev/null +++ b/src/test/mocks/ui.ts @@ -0,0 +1,26 @@ +import { IMock, Mock } from "typemoq"; + +import UI from "../../ui/ui"; +import TmcWebview from "../../ui/webview"; + +import { createWebviewMock } from "./webview"; + +export interface UIMockValues { + webview: TmcWebview; +} + +export function createUIMock(): [IMock, UIMockValues] { + const values: UIMockValues = { + webview: createWebviewMock()[0].object, + }; + const mock = setupMockValues(values); + return [mock, values]; +} + +function setupMockValues(values: UIMockValues): IMock { + const mock = Mock.ofType(); + + mock.setup((x) => x.webview).returns(() => values.webview); + + return mock; +} diff --git a/src/test/mocks/webview.ts b/src/test/mocks/webview.ts new file mode 100644 index 00000000..dc904bfc --- /dev/null +++ b/src/test/mocks/webview.ts @@ -0,0 +1,24 @@ +import { IMock, Mock } from "typemoq"; + +import { WebviewMessage } from "../../ui/types"; +import TmcWebview from "../../ui/webview"; + +export interface WebviewMockValues { + postMessage: (...messages: WebviewMessage[]) => void; +} + +export function createWebviewMock(): [IMock, WebviewMockValues] { + const values: WebviewMockValues = { + postMessage: () => {}, + }; + const mock = setupMockValues(values); + return [mock, values]; +} + +function setupMockValues(values: WebviewMockValues): IMock { + const mock = Mock.ofType(); + + mock.setup((x) => x.postMessage).returns(() => values.postMessage); + + return mock; +} From 85a58edbac79cb63f509be3f5e133fcd0a87e3a4 Mon Sep 17 00:00:00 2001 From: Sebastian Sergelius Date: Tue, 27 Apr 2021 14:49:03 +0100 Subject: [PATCH 44/79] Handle changing TMC Data path via VSCode UI --- package-lock.json | 13 ----- package.json | 24 ++++++--- src/actions/moveExtensionDataPath.ts | 4 +- src/actions/user.ts | 81 ++++++++++++++-------------- src/api/workspaceManager.ts | 4 -- src/commands/changeTmcDataPath.ts | 40 ++++++++++++++ src/commands/index.ts | 1 + src/config/settings.ts | 22 ++++++-- src/extension.ts | 10 ++-- src/init/commands.ts | 7 ++- src/init/ui.ts | 44 +-------------- 11 files changed, 133 insertions(+), 117 deletions(-) create mode 100644 src/commands/changeTmcDataPath.ts diff --git a/package-lock.json b/package-lock.json index cb424a18..75d2cc8b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -3834,14 +3834,6 @@ "domhandler": "^4.0.0" } }, - "du": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/du/-/du-1.0.0.tgz", - "integrity": "sha512-w00+6XpIq924IvDLyOOx5HFO4KwH6YV6buqFx6og/ErTaJ34kVOyI+Q2f+X8pvZkDoEgT6xspA4iYSN99mqPDA==", - "requires": { - "map-async": "~0.1.1" - } - }, "duplexer2": { "version": "0.1.4", "resolved": "https://registry.npmjs.org/duplexer2/-/duplexer2-0.1.4.tgz", @@ -6078,11 +6070,6 @@ "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==", "dev": true }, - "map-async": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/map-async/-/map-async-0.1.1.tgz", - "integrity": "sha1-yJfARJ+Fhkx0taPxlu20IVZDF0U=" - }, "map-cache": { "version": "0.2.2", "resolved": "https://registry.npmjs.org/map-cache/-/map-cache-0.2.2.tgz", diff --git a/package.json b/package.json index 0014efb2..7212b89f 100644 --- a/package.json +++ b/package.json @@ -76,6 +76,11 @@ "title": "Add New Course...", "category": "TestMyCode" }, + { + "command": "tmc.changeTmcDataPath", + "title": "Change TMC data path", + "category": "TestMyCode" + }, { "command": "tmc.cleanExercise", "title": "Clean Exercise", @@ -183,6 +188,18 @@ "configuration": { "title": "TestMyCode", "properties": { + "testMyCode.dataPath.changeTmcDataPath": { + "type": "boolean", + "scope": "application", + "default": false, + "description": "Toggle this checkmark to select a new location." + }, + "testMyCode.dataPath.currentLocation": { + "type": "string", + "scope": "application", + "default": "/", + "description": "Folder where your exercises are stored on your disk. \nPlaceholder for the value, change location by toggling checkbox above." + }, "testMyCode.downloadOldSubmission": { "type": "boolean", "default": true, @@ -218,12 +235,6 @@ "type": "boolean", "default": true, "description": "Download exercise updates automatically." - }, - "testMyCode.dataPath": { - "type": "string", - "scope": "application", - "default": "/", - "description": "Folder where your exercises are stored. \nThis is just a placeholder, this can be changed on My Course page." } } }, @@ -494,7 +505,6 @@ }, "dependencies": { "del": "^6.0.0", - "du": "^1.0.0", "fs-extra": "^9.1.0", "handlebars": "^4.7.7", "lodash": "^4.17.21", diff --git a/src/actions/moveExtensionDataPath.ts b/src/actions/moveExtensionDataPath.ts index d1ab42c4..efe6a997 100644 --- a/src/actions/moveExtensionDataPath.ts +++ b/src/actions/moveExtensionDataPath.ts @@ -17,7 +17,7 @@ export async function moveExtensionDataPath( newPath: vscode.Uri, onUpdate?: (value: { percent: number; message?: string }) => void, ): Promise> { - const { resources, tmc, workspaceManager } = actionContext; + const { resources, tmc, settings } = actionContext; // This appears to be unnecessary with current VS Code version /* @@ -51,6 +51,6 @@ export async function moveExtensionDataPath( } resources.projectsDirectory = newFsPath; - await workspaceManager.setTmcDataPath(newFsPath); + await settings.setTmcDataPathPlaceholder(newFsPath); return refreshLocalExercises(actionContext); } diff --git a/src/actions/user.ts b/src/actions/user.ts index 5b6681dc..10974940 100644 --- a/src/actions/user.ts +++ b/src/actions/user.ts @@ -4,7 +4,6 @@ * ------------------------------------------------------------------------------------------------- */ -import du = require("du"); import * as fs from "fs-extra"; import * as _ from "lodash"; import { Err, Ok, Result } from "ts-results"; @@ -16,7 +15,7 @@ import { WorkspaceExercise } from "../api/workspaceManager"; import { EXAM_TEST_RESULT, NOTIFICATION_DELAY } from "../config/constants"; import { BottleneckError } from "../errors"; import { TestResultData } from "../ui/types"; -import { formatSizeInBytes, Logger, parseFeedbackQuestion } from "../utils/"; +import { Logger, parseFeedbackQuestion } from "../utils/"; import { getActiveEditorExecutablePath } from "../window"; import { downloadNewExercisesForCourse } from "./downloadNewExercisesForCourse"; @@ -447,45 +446,45 @@ export async function openWorkspace(actionContext: ActionContext, name: string): } } -/** - * Deprecated - * Settings webview - */ -export async function openSettings(actionContext: ActionContext): Promise { - const { dialog, ui, resources, settings } = actionContext; - Logger.log("Display extension settings"); - const extensionSettingsResult = await settings.getExtensionSettings(); - if (extensionSettingsResult.err) { - dialog.errorNotification("Failed to fetch settings.", extensionSettingsResult.val); - return; - } - - const extensionSettings = extensionSettingsResult.val; - ui.webview.setContentFromTemplate({ templateName: "settings" }, true, [ - { - command: "setBooleanSetting", - setting: "downloadOldSubmission", - enabled: extensionSettings.hideMetaFiles, - }, - { - command: "setBooleanSetting", - setting: "hideMetaFiles", - enabled: extensionSettings.hideMetaFiles, - }, - { command: "setBooleanSetting", setting: "insider", enabled: settings.isInsider() }, - { - command: "setBooleanSetting", - setting: "updateExercisesAutomatically", - enabled: settings.getAutomaticallyUpdateExercises(), - }, - { command: "setLogLevel", level: settings.getLogLevel() }, - { - command: "setTmcDataFolder", - diskSize: formatSizeInBytes(await du(resources.projectsDirectory)), - path: resources.projectsDirectory, - }, - ]); -} +// /** +// * Deprecated +// * Settings webview +// */ +// export async function openSettings(actionContext: ActionContext): Promise { +// const { dialog, ui, resources, settings } = actionContext; +// Logger.log("Display extension settings"); +// const extensionSettingsResult = await settings.getExtensionSettings(); +// if (extensionSettingsResult.err) { +// dialog.errorNotification("Failed to fetch settings.", extensionSettingsResult.val); +// return; +// } + +// const extensionSettings = extensionSettingsResult.val; +// ui.webview.setContentFromTemplate({ templateName: "settings" }, true, [ +// { +// command: "setBooleanSetting", +// setting: "downloadOldSubmission", +// enabled: extensionSettings.hideMetaFiles, +// }, +// { +// command: "setBooleanSetting", +// setting: "hideMetaFiles", +// enabled: extensionSettings.hideMetaFiles, +// }, +// { command: "setBooleanSetting", setting: "insider", enabled: settings.isInsider() }, +// { +// command: "setBooleanSetting", +// setting: "updateExercisesAutomatically", +// enabled: settings.getAutomaticallyUpdateExercises(), +// }, +// { command: "setLogLevel", level: settings.getLogLevel() }, +// { +// command: "setTmcDataFolder", +// diskSize: formatSizeInBytes(await du(resources.projectsDirectory)), +// path: resources.projectsDirectory, +// }, +// ]); +// } /** * Removes given course from UserData and removes its associated files. However, doesn't remove any diff --git a/src/api/workspaceManager.ts b/src/api/workspaceManager.ts index 73aa068f..1214605e 100644 --- a/src/api/workspaceManager.ts +++ b/src/api/workspaceManager.ts @@ -104,10 +104,6 @@ export default class WorkspaceManager implements vscode.Disposable { return workspaceFile; } - public async setTmcDataPath(path: string): Promise { - await vscode.workspace.getConfiguration("testMyCode").update("dataPath", path, true); - } - public async setExercises(exercises: WorkspaceExercise[]): Promise> { this._exercises = exercises; return this._refreshActiveCourseWorkspace(); diff --git a/src/commands/changeTmcDataPath.ts b/src/commands/changeTmcDataPath.ts new file mode 100644 index 00000000..7b78166b --- /dev/null +++ b/src/commands/changeTmcDataPath.ts @@ -0,0 +1,40 @@ +import * as vscode from "vscode"; + +import { moveExtensionDataPath } from "../actions"; +import { ActionContext } from "../actions/types"; +import { Logger } from "../utils"; + +/** + * Removes language specific meta files from exercise directory. + */ +export async function changeTmcDataPath(actionContext: ActionContext): Promise { + const { dialog, resources } = actionContext; + + const old = resources.projectsDirectory; + const options: vscode.OpenDialogOptions = { + canSelectFiles: false, + canSelectFolders: true, + canSelectMany: false, + openLabel: "Select folder", + }; + const newPath = (await vscode.window.showOpenDialog(options))?.[0]; + if (newPath && old) { + const res = await dialog.progressNotification( + "Moving projects directory...", + (progress) => { + return moveExtensionDataPath(actionContext, newPath, (update) => + progress.report(update), + ); + }, + ); + if (res.ok) { + Logger.log(`Moved workspace folder from ${old} to ${newPath.fsPath}`); + dialog.notification(`TMC Data was successfully moved to ${newPath.fsPath}`, [ + "OK", + (): void => {}, + ]); + } else { + dialog.errorNotification(res.val.message, res.val); + } + } +} diff --git a/src/commands/index.ts b/src/commands/index.ts index 391a1a6e..4f06bc3a 100644 --- a/src/commands/index.ts +++ b/src/commands/index.ts @@ -1,4 +1,5 @@ export * from "./addNewCourse"; +export * from "./changeTmcDataPath"; export * from "./cleanExercise"; export * from "./closeExercise"; export * from "./downloadNewExercises"; diff --git a/src/config/settings.ts b/src/config/settings.ts index 05f3f746..a0bcd89b 100644 --- a/src/config/settings.ts +++ b/src/config/settings.ts @@ -37,6 +37,7 @@ export default class Settings implements vscode.Disposable { private _onChangeHideMetaFiles?: (value: boolean) => void; private _onChangeDownloadOldSubmission?: (value: boolean) => void; private _onChangeUpdateExercisesAutomatically?: (value: boolean) => void; + private _onChangeTmcDataPath?: () => void; /** * @deprecated Storage dependency should be removed when major 3.0 release. @@ -71,8 +72,11 @@ export default class Settings implements vscode.Disposable { .get("insiderVersion", false); this._settings.insiderVersion = value; } - if (event.affectsConfiguration("testMyCode.tmcDataPath")) { - Logger.warn("Not supported."); + if (event.affectsConfiguration("testMyCode.dataPath.changeTmcDataPath")) { + this._onChangeTmcDataPath?.(); + await vscode.workspace + .getConfiguration() + .update("testMyCode.dataPath.changeTmcDataPath", false, true); } // Workspace settings @@ -96,12 +100,16 @@ export default class Settings implements vscode.Disposable { ]; } + public set onChangeDownloadOldSubmission(callback: (value: boolean) => void) { + this._onChangeDownloadOldSubmission = callback; + } + public set onChangeHideMetaFiles(callback: (value: boolean) => void) { this._onChangeHideMetaFiles = callback; } - public set onChangeDownloadOldSubmission(callback: (value: boolean) => void) { - this._onChangeDownloadOldSubmission = callback; + public set onChangeTmcDataPath(callback: () => void) { + this._onChangeTmcDataPath = callback; } public set onChangeUpdateExercisesAutomatically(callback: (value: boolean) => void) { @@ -112,6 +120,12 @@ export default class Settings implements vscode.Disposable { this._disposables.forEach((x) => x.dispose()); } + public async setTmcDataPathPlaceholder(path: string): Promise { + await vscode.workspace + .getConfiguration("testMyCode.dataPath") + .update("currentLocation", path, true); + } + public async updateExtensionSettingsToStorage(settings: ExtensionSettings): Promise { await this._storage.updateExtensionSettings(settings); } diff --git a/src/extension.ts b/src/extension.ts index a4169759..4c36eff4 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -9,6 +9,7 @@ import ExerciseDecorationProvider from "./api/exerciseDecorationProvider"; import Storage from "./api/storage"; import TMC from "./api/tmc"; import WorkspaceManager from "./api/workspaceManager"; +import * as commands from "./commands"; import { CLIENT_NAME, DEBUG_MODE, @@ -111,8 +112,7 @@ export async function activate(context: vscode.ExtensionContext): Promise const resources = resourcesResult.val; Logger.configure( - vscode.workspace.getConfiguration("testMyCode").get("logLevel") ?? - LogLevel.Errors, + vscode.workspace.getConfiguration("testMyCode").get("logLevel", LogLevel.Errors), ); const ui = new UI(context, resources, vscode.window.createStatusBarItem()); @@ -141,7 +141,6 @@ export async function activate(context: vscode.ExtensionContext): Promise const userData = new UserData(storage); const workspaceManager = new WorkspaceManager(resources); context.subscriptions.push(workspaceManager); - workspaceManager.setTmcDataPath(tmcDataPath); if (workspaceManager.activeCourse) { await vscode.commands.executeCommand("setContext", "test-my-code:WorkspaceActive", true); await workspaceManager.verifyWorkspaceSettingsIntegrity(); @@ -186,6 +185,11 @@ export async function activate(context: vscode.ExtensionContext): Promise init.registerUiActions(actionContext); init.registerCommands(context, actionContext); + await settings.setTmcDataPathPlaceholder(tmcDataPath); + settings.onChangeTmcDataPath = async (): Promise => { + await commands.changeTmcDataPath(actionContext); + }; + context.subscriptions.push( vscode.window.registerFileDecorationProvider(exerciseDecorationProvider), ); diff --git a/src/init/commands.ts b/src/init/commands.ts index fbce43e1..1b4b732d 100644 --- a/src/init/commands.ts +++ b/src/init/commands.ts @@ -48,6 +48,10 @@ export function registerCommands( commands.addNewCourse(actionContext), ), + vscode.commands.registerCommand("tmc.changeTmcDataPath", async () => + commands.changeTmcDataPath(actionContext), + ), + vscode.commands.registerCommand( "tmc.cleanExercise", async (resource: vscode.Uri | undefined) => @@ -125,7 +129,8 @@ export function registerCommands( }), vscode.commands.registerCommand("tmc.openSettings", async () => { - actions.openSettings(actionContext); + // actions.openSettings(actionContext); + vscode.commands.executeCommand("workbench.action.openSettings", "Test My Code"); }), vscode.commands.registerCommand("tmc.openTMCExercisesFolder", async () => { diff --git a/src/init/ui.ts b/src/init/ui.ts index baee2f9d..a024c0d0 100644 --- a/src/init/ui.ts +++ b/src/init/ui.ts @@ -1,4 +1,3 @@ -import du = require("du"); import { Result } from "ts-results"; import * as vscode from "vscode"; @@ -9,7 +8,6 @@ import { displayUserCourses, downloadOrUpdateExercises, login, - moveExtensionDataPath, openExercises, openWorkspace, refreshLocalExercises, @@ -18,7 +16,7 @@ import { updateCourse, } from "../actions"; import { ActionContext } from "../actions/types"; -import { formatSizeInBytes, Logger } from "../utils/"; +import { Logger } from "../utils/"; /** * Registers the various actions and handlers required for the user interface to function. @@ -27,7 +25,7 @@ import { formatSizeInBytes, Logger } from "../utils/"; * @param tmc The TMC API object */ export function registerUiActions(actionContext: ActionContext): void { - const { dialog, ui, resources, settings, userData, visibilityGroups } = actionContext; + const { dialog, ui, settings, userData, visibilityGroups } = actionContext; Logger.log("Initializing UI Actions"); // Register UI actions @@ -273,44 +271,6 @@ export function registerUiActions(actionContext: ActionContext): void { } }, ); - ui.webview.registerHandler("changeTmcDataPath", async (msg: { type?: "changeTmcDataPath" }) => { - if (!msg.type) { - return; - } - - const old = resources.projectsDirectory; - const options: vscode.OpenDialogOptions = { - canSelectFiles: false, - canSelectFolders: true, - canSelectMany: false, - openLabel: "Select folder", - }; - const newPath = (await vscode.window.showOpenDialog(options))?.[0]; - if (newPath && old) { - const res = await dialog.progressNotification( - "Moving projects directory...", - (progress) => { - return moveExtensionDataPath(actionContext, newPath, (update) => - progress.report(update), - ); - }, - ); - if (res.ok) { - Logger.log(`Moved workspace folder from ${old} to ${newPath.fsPath}`); - dialog.notification(`TMC Data was successfully moved to ${newPath.fsPath}`, [ - "OK", - (): void => {}, - ]); - } else { - dialog.errorNotification(res.val.message, res.val); - } - ui.webview.postMessage({ - command: "setTmcDataFolder", - diskSize: formatSizeInBytes(await du(resources.projectsDirectory)), - path: resources.projectsDirectory, - }); - } - }); ui.webview.registerHandler( "insiderStatus", From c5fed654ded5c2f4127febfdc2d14760ba66fc4f Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Tue, 27 Apr 2021 17:15:56 +0300 Subject: [PATCH 45/79] Fix broken type --- src/api/langsSchema.ts | 2 +- src/api/tmc.ts | 2 -- src/test-integration/tmc_langs_cli.spec.ts | 2 +- .../actions/downloadOrUpdateExercises.test.ts | 26 ++++++++++++++----- 4 files changed, 21 insertions(+), 11 deletions(-) diff --git a/src/api/langsSchema.ts b/src/api/langsSchema.ts index 2f49080f..574ed282 100644 --- a/src/api/langsSchema.ts +++ b/src/api/langsSchema.ts @@ -80,7 +80,7 @@ export interface CombinedCourseData { export interface DownloadOrUpdateCourseExercisesResult { downloaded: ExerciseDownload[]; skipped: ExerciseDownload[]; - failed: Array<[ExerciseDownload, string]> | null; + failed?: Array<[ExerciseDownload, string]>; } export interface ExerciseDownload { diff --git a/src/api/tmc.ts b/src/api/tmc.ts index 7681468e..20e271c2 100644 --- a/src/api/tmc.ts +++ b/src/api/tmc.ts @@ -927,8 +927,6 @@ export default class TMC { if (langsResponse.data?.["output-data-kind"] !== "error" && validator(langsResponse)) { return Ok(langsResponse); } - Logger.log("asd " + langsResponse.data?.["output-data-kind"] !== "error"); - Logger.log("sdf " + validator(langsResponse)); const data = langsResponse.data?.["output-data"]; if (!is(data)) { diff --git a/src/test-integration/tmc_langs_cli.spec.ts b/src/test-integration/tmc_langs_cli.spec.ts index 12490a4a..1f6db6e9 100644 --- a/src/test-integration/tmc_langs_cli.spec.ts +++ b/src/test-integration/tmc_langs_cli.spec.ts @@ -161,7 +161,7 @@ suite("TMC", function () { tmc.on("logout", () => onLoggedOutCalls++); }); - test("should succeed", async function () { + test("should deathenticate the user", async function () { const result1 = await tmc.deauthenticate(); result1.err && expect.fail(FAIL_MESSAGE + result1.val.message); expect(onLoggedOutCalls).to.be.equal(1); diff --git a/src/test/actions/downloadOrUpdateExercises.test.ts b/src/test/actions/downloadOrUpdateExercises.test.ts index 9ce1405c..61656245 100644 --- a/src/test/actions/downloadOrUpdateExercises.test.ts +++ b/src/test/actions/downloadOrUpdateExercises.test.ts @@ -53,7 +53,7 @@ suite("downloadOrUpdateExercises action", function () { const createDownloadResult = ( downloaded: ExerciseDownload[], skipped: ExerciseDownload[], - failed: Array<[ExerciseDownload, string]> | null, + failed: Array<[ExerciseDownload, string]> | undefined, ): Result => { return Ok({ downloaded, @@ -84,19 +84,31 @@ suite("downloadOrUpdateExercises action", function () { }); test("should return ids of successful downloads", async function () { - tmcMockValues.downloadExercises = createDownloadResult([helloWorld, otherWorld], [], null); + tmcMockValues.downloadExercises = createDownloadResult( + [helloWorld, otherWorld], + [], + undefined, + ); const result = (await downloadOrUpdateExercises(actionContext(), [1, 2])).unwrap(); expect(result.successful).to.be.deep.equal([1, 2]); }); test("should return ids of skipped downloads as successful", async function () { - tmcMockValues.downloadExercises = createDownloadResult([], [helloWorld, otherWorld], null); + tmcMockValues.downloadExercises = createDownloadResult( + [], + [helloWorld, otherWorld], + undefined, + ); const result = (await downloadOrUpdateExercises(actionContext(), [1, 2])).unwrap(); expect(result.successful).to.be.deep.equal([1, 2]); }); test("should combine successful and skipped downloads", async function () { - tmcMockValues.downloadExercises = createDownloadResult([helloWorld], [otherWorld], null); + tmcMockValues.downloadExercises = createDownloadResult( + [helloWorld], + [otherWorld], + undefined, + ); const result = (await downloadOrUpdateExercises(actionContext(), [1])).unwrap(); expect(result.successful).to.be.deep.equal([1, 2]); }); @@ -121,7 +133,7 @@ suite("downloadOrUpdateExercises action", function () { .returns(async (_, cb) => { // Callback is only used for successful downloads cb({ id: helloWorld.id, percent: 0.5 }); - return createDownloadResult([helloWorld], [], null); + return createDownloadResult([helloWorld], [], undefined); }); await downloadOrUpdateExercises(actionContext(), [1]); expect(webviewMessages.length).to.be.greaterThanOrEqual( @@ -139,7 +151,7 @@ suite("downloadOrUpdateExercises action", function () { }); test("should post status updates for skipped download", async function () { - tmcMockValues.downloadExercises = createDownloadResult([helloWorld], [], null); + tmcMockValues.downloadExercises = createDownloadResult([helloWorld], [], undefined); await downloadOrUpdateExercises(actionContext(), [1]); expect(webviewMessages.length).to.be.greaterThanOrEqual( 2, @@ -173,7 +185,7 @@ suite("downloadOrUpdateExercises action", function () { }); test("should post status updates for exercises missing from langs response", async function () { - tmcMockValues.downloadExercises = createDownloadResult([], [], null); + tmcMockValues.downloadExercises = createDownloadResult([], [], undefined); await downloadOrUpdateExercises(actionContext(), [1]); expect(webviewMessages.length).to.be.greaterThanOrEqual( 2, From be30b7f69ba5974925717e9a6a25777387fbc6b3 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Fri, 30 Apr 2021 11:09:48 +0300 Subject: [PATCH 46/79] Improve download action error handling --- src/actions/downloadOrUpdateExercises.ts | 65 ++++++++++++------- .../actions/downloadOrUpdateExercises.test.ts | 29 ++++++++- 2 files changed, 67 insertions(+), 27 deletions(-) diff --git a/src/actions/downloadOrUpdateExercises.ts b/src/actions/downloadOrUpdateExercises.ts index 67493cab..af0cfc8e 100644 --- a/src/actions/downloadOrUpdateExercises.ts +++ b/src/actions/downloadOrUpdateExercises.ts @@ -1,8 +1,8 @@ -import { partition } from "lodash"; import * as pLimit from "p-limit"; import { Ok, Result } from "ts-results"; import { ExerciseStatus, WebviewMessage } from "../ui/types"; +import TmcWebview from "../ui/webview"; import { Logger } from "../utils"; import { ActionContext } from "./types"; @@ -10,6 +10,11 @@ import { ActionContext } from "./types"; // Use this until using Langs version with file locks const limit = pLimit(1); +interface DownloadResults { + successful: number[]; + failed: number[]; +} + /** * Downloads given exercises and opens them in TMC workspace. * @@ -19,13 +24,14 @@ const limit = pLimit(1); export async function downloadOrUpdateExercises( actionContext: ActionContext, exerciseIds: number[], -): Promise> { +): Promise> { const { dialog, tmc, ui } = actionContext; if (exerciseIds.length === 0) { return Ok({ successful: [], failed: [] }); } ui.webview.postMessage(...exerciseIds.map((x) => wrapToMessage(x, "downloading"))); + const statuses = new Map(exerciseIds.map((x) => [x, "downloadFailed"])); // TODO: How to download latest submission in new version? const downloadResult = await dialog.progressNotification( @@ -34,35 +40,31 @@ export async function downloadOrUpdateExercises( limit(() => tmc.downloadExercises(exerciseIds, (download) => { progress.report(download); + statuses.set(download.id, "closed"); ui.webview.postMessage(wrapToMessage(download.id, "closed")); }), ), ); + if (downloadResult.err) { + postMessages(ui.webview, statuses); + return downloadResult; + } - return downloadResult.andThen(({ downloaded, failed, skipped }) => { - skipped.length > 0 && Logger.warn(`${skipped.length} downloads were skipped.`); - const resultMap = new Map( - exerciseIds.map((x) => [x, "downloadFailed"]), - ); - downloaded.forEach((x) => resultMap.set(x.id, "closed")); - skipped.forEach((x) => resultMap.set(x.id, "closed")); - failed?.forEach((x) => { - Logger.error(`Failed to download exercise ${x[0]["exercise-slug"]}: ${x[1]}`); - resultMap.set(x[0].id, "downloadFailed"); - }); - const entries = Array.from(resultMap.entries()); - ui.webview.postMessage( - ...entries.map(([id, status]) => wrapToMessage(id, status)), - ); - const [successfulIds, failedIds] = partition( - entries, - ([, status]) => status !== "downloadFailed", - ); - return Ok({ - successful: successfulIds.map((x) => x[0]), - failed: failedIds.map((x) => x[0]), - }); + const { downloaded, failed, skipped } = downloadResult.val; + skipped.length > 0 && Logger.warn(`${skipped.length} downloads were skipped.`); + downloaded.forEach((x) => statuses.set(x.id, "closed")); + skipped.forEach((x) => statuses.set(x.id, "closed")); + failed?.forEach(([exercise, reason]) => { + Logger.error(`Failed to download exercise ${exercise["exercise-slug"]}: ${reason}`); + statuses.set(exercise.id, "downloadFailed"); }); + postMessages(ui.webview, statuses); + + return Ok(sortResults(statuses)); +} + +function postMessages(webview: TmcWebview, statuses: Map): void { + webview.postMessage(...Array.from(statuses.entries()).map(([id, s]) => wrapToMessage(id, s))); } function wrapToMessage(exerciseId: number, status: ExerciseStatus): WebviewMessage { @@ -72,3 +74,16 @@ function wrapToMessage(exerciseId: number, status: ExerciseStatus): WebviewMessa status, }; } + +function sortResults(statuses: Map): DownloadResults { + const successful: number[] = []; + const failed: number[] = []; + statuses.forEach((status, id) => { + if (status !== "downloadFailed") { + successful.push(id); + } else { + failed.push(id); + } + }); + return { successful, failed }; +} diff --git a/src/test/actions/downloadOrUpdateExercises.test.ts b/src/test/actions/downloadOrUpdateExercises.test.ts index 61656245..f138f5f9 100644 --- a/src/test/actions/downloadOrUpdateExercises.test.ts +++ b/src/test/actions/downloadOrUpdateExercises.test.ts @@ -1,6 +1,6 @@ import { expect } from "chai"; import { first, last } from "lodash"; -import { Ok, Result } from "ts-results"; +import { Err, Ok, Result } from "ts-results"; import { IMock, It, Times } from "typemoq"; import { downloadOrUpdateExercises } from "../../actions"; @@ -83,6 +83,13 @@ suite("downloadOrUpdateExercises action", function () { expect(tmcMock.verify((x) => x.downloadExercises(It.isAny(), It.isAny()), Times.never())); }); + test("should return error if TMC-langs fails", async function () { + const error = new Error(); + tmcMockValues.downloadExercises = Err(error); + const result = await downloadOrUpdateExercises(actionContext(), [1, 2]); + expect(result.val).to.be.equal(error); + }); + test("should return ids of successful downloads", async function () { tmcMockValues.downloadExercises = createDownloadResult( [helloWorld, otherWorld], @@ -167,7 +174,7 @@ suite("downloadOrUpdateExercises action", function () { ); }); - test("should post status updates of failing download", async function () { + test("should post status updates for failing download", async function () { tmcMockValues.downloadExercises = createDownloadResult([], [], [[helloWorld, ""]]); await downloadOrUpdateExercises(actionContext(), [1]); expect(webviewMessages.length).to.be.greaterThanOrEqual( @@ -200,6 +207,24 @@ suite("downloadOrUpdateExercises action", function () { 'expected last message to be "downloadFailed"', ); }); + + test("should post status updates when TMC-langs operation fails", async function () { + const error = new Error(); + tmcMockValues.downloadExercises = Err(error); + await downloadOrUpdateExercises(actionContext(), [1]); + expect(webviewMessages.length).to.be.greaterThanOrEqual( + 2, + "expected at least two status messages", + ); + expect(first(webviewMessages)).to.be.deep.equal( + wrapToMessage(helloWorld.id, "downloading"), + 'expected first message to be "downloading"', + ); + expect(last(webviewMessages)).to.be.deep.equal( + wrapToMessage(helloWorld.id, "downloadFailed"), + 'expected last message to be "downloadFailed"', + ); + }); }); // These kind of functions should maybe be in utils? From 9898a8a02857ac3e47d3632823bd86756f204a07 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Fri, 30 Apr 2021 16:57:03 +0300 Subject: [PATCH 47/79] Improve langs test suite --- backend/index.ts | 14 +- src/api/tmc.ts | 6 +- src/test-integration/tmc_langs_cli.spec.ts | 757 ++++++++++----------- 3 files changed, 360 insertions(+), 417 deletions(-) diff --git a/backend/index.ts b/backend/index.ts index 65730555..f213aff8 100644 --- a/backend/index.ts +++ b/backend/index.ts @@ -122,17 +122,19 @@ app.get(`/api/v8/core/courses/${pythonCourse.id}`, (req, res: Response) => - res.json({ - exercises: [passingExercise].map((x) => ({ +app.get("/api/v8/core/exercises/details", (req, res: Response) => { + const rawIds = req.query.ids; + const ids = Array.isArray(rawIds) ? rawIds : [rawIds]; + const filtered = [passingExercise].filter((x) => ids.includes(x.id.toString())); + return res.json({ + exercises: filtered.map((x) => ({ id: x.id, checksum: x.checksum, course_name: "python-course", exercise_name: x.exercise_name, })), - }), -); + }); +}); // getExerciseDetails(1) app.get(`/api/v8/core/exercises/${passingExercise.id}`, (req, res: Response) => diff --git a/src/api/tmc.ts b/src/api/tmc.ts index 20e271c2..82964432 100644 --- a/src/api/tmc.ts +++ b/src/api/tmc.ts @@ -470,6 +470,7 @@ export default class TMC { { args: [ "download-or-update-course-exercises", + "--download-template", "--exercise-id", ...ids.map((id) => id.toString()), ], @@ -760,7 +761,7 @@ export default class TMC { } const res = await this._executeLangsCommand( { args, core: true }, - createIs>(), + createIs(), ); return res.err ? res : Ok.EMPTY; } @@ -930,7 +931,8 @@ export default class TMC { const data = langsResponse.data?.["output-data"]; if (!is(data)) { - return Err(new Error("Unexpected TMC-langs response:" + langsResponse.data)); + Logger.debug(`Unexpected TMC-langs response. ${langsResponse.data}`); + return Err(new Error("Unexpected TMC-langs response.")); } const message = langsResponse.message; diff --git a/src/test-integration/tmc_langs_cli.spec.ts b/src/test-integration/tmc_langs_cli.spec.ts index 1f6db6e9..163b5303 100644 --- a/src/test-integration/tmc_langs_cli.spec.ts +++ b/src/test-integration/tmc_langs_cli.spec.ts @@ -2,7 +2,6 @@ import { expect } from "chai"; import * as cp from "child_process"; import { sync as delSync } from "del"; import * as fs from "fs-extra"; -import { ncp } from "ncp"; import * as path from "path"; import * as kill from "tree-kill"; @@ -14,61 +13,24 @@ import { getLangsCLIForPlatform, getPlatform } from "../utils/"; // __dirname is the dist folder when executed. const PROJECT_ROOT = path.join(__dirname, ".."); -const ARTIFACT_FOLDER = path.join(PROJECT_ROOT, "test-artifacts", "tmc_langs_cli_spec"); +const ARTIFACT_FOLDER = path.join(PROJECT_ROOT, "test-artifacts"); // Use CLI from backend folder to run tests. const BACKEND_FOLDER = path.join(PROJECT_ROOT, "backend"); const CLI_PATH = path.join(BACKEND_FOLDER, "cli"); const CLI_FILE = path.join(CLI_PATH, getLangsCLIForPlatform(getPlatform(), TMC_LANGS_VERSION)); -const COURSE_PATH = path.join(BACKEND_FOLDER, "resources", "test-python-course"); -const PASSING_EXERCISE_PATH = path.join(COURSE_PATH, "part01-01_passing_exercise"); -const MISSING_EXERCISE_PATH = path.join(COURSE_PATH, "part01-404_missing_exercise"); const FEEDBACK_URL = "http://localhost:4001/feedback"; +// Example backend credentials +const USERNAME = "TestMyExtension"; +const PASSWORD = "hunter2"; + // This one is mandated by TMC-langs. const CLIENT_CONFIG_DIR_NAME = `tmc-${CLIENT_NAME}`; const FAIL_MESSAGE = "TMC-langs execution failed: "; -async function startServer(): Promise { - let ready = false; - console.log(path.join(__dirname, "..", "backend")); - const server = cp.spawn("npm", ["start"], { - cwd: path.join(__dirname, "..", "backend"), - shell: "bash", - }); - server.stdout.on("data", (chunk) => { - if (chunk.toString().startsWith("Server listening to")) { - ready = true; - } - }); - - const timeout = setTimeout(() => { - throw new Error("Failed to start server"); - }, 20000); - - while (!ready) { - await new Promise((resolve) => setTimeout(resolve, 1000)); - } - - clearTimeout(timeout); - return server; -} - -function setupProjectsDir(dirName: string): string { - const authenticatedConfigDir = path.join(ARTIFACT_FOLDER, CLIENT_CONFIG_DIR_NAME); - if (!fs.existsSync(authenticatedConfigDir)) { - fs.mkdirSync(authenticatedConfigDir, { recursive: true }); - } - const projectsDir = path.join(ARTIFACT_FOLDER, dirName); - fs.writeFileSync( - path.join(authenticatedConfigDir, "config.toml"), - `projects-dir = '${projectsDir}'\n`, - ); - return projectsDir; -} - -suite("TMC", function () { +suite("tmc langs cli spec", function () { let server: cp.ChildProcess | undefined; suiteSetup(async function () { @@ -76,92 +38,39 @@ suite("TMC", function () { server = await startServer(); }); - let tmc: TMC; - let tmcUnauthenticated: TMC; + let testDir: string; setup(function () { - const authenticatedConfigDir = path.join(ARTIFACT_FOLDER, CLIENT_CONFIG_DIR_NAME); - if (!fs.existsSync(authenticatedConfigDir)) { - fs.mkdirSync(authenticatedConfigDir, { recursive: true }); - } - fs.writeFileSync( - path.join(authenticatedConfigDir, "credentials.json"), - '{"access_token":"1234","token_type":"bearer","scope":"public"}', - ); - tmc = new TMC(CLI_FILE, CLIENT_NAME, "test", { - cliConfigDir: ARTIFACT_FOLDER, - }); - - const unauthenticatedArtifactFolder = path.join(ARTIFACT_FOLDER, "__unauthenticated"); - const unauthenticatedConfigDir = path.join( - unauthenticatedArtifactFolder, - CLIENT_CONFIG_DIR_NAME, - ); - delSync(unauthenticatedConfigDir, { force: true }); - tmcUnauthenticated = new TMC(CLI_FILE, CLIENT_NAME, "test", { - cliConfigDir: unauthenticatedConfigDir, - }); - }); - - suite("authentication", function () { - const incorrectUsername = "TestMyEkstension"; - const username = "TestMyExtension"; - const password = "hunter2"; - - let onLoggedInCalls: number; - let onLoggedOutCalls: number; - - setup(function () { - onLoggedInCalls = 0; - onLoggedOutCalls = 0; - tmcUnauthenticated.on("login", () => onLoggedInCalls++); - tmcUnauthenticated.on("logout", () => onLoggedOutCalls++); - }); - - test("should fail with empty credentials"); - - test("should fail with incorrect credentials", async function () { - const result1 = await tmcUnauthenticated.authenticate(incorrectUsername, password); - expect(result1.val).to.be.instanceOf(AuthenticationError); - expect(onLoggedInCalls).to.be.equal(0); - - const result2 = await tmcUnauthenticated.isAuthenticated(); - result2.err && expect.fail(FAIL_MESSAGE + result2.val.message); - expect(result2.val).to.be.equal(false); - - expect(onLoggedOutCalls).to.be.equal(0); - }); - - test("should succeed with correct credentials", async function () { - const result1 = await tmcUnauthenticated.authenticate(username, password); - result1.err && expect.fail(FAIL_MESSAGE + result1.val.message); - expect(onLoggedInCalls).to.be.equal(1); - - const result2 = await tmcUnauthenticated.isAuthenticated(); - result2.err && expect.fail(FAIL_MESSAGE + result2.val.message); - expect(result2.val).to.be.equal(true); - - expect(onLoggedOutCalls).to.be.equal(0); - }); - - test("should fail when already authenticated", async function () { - const result2 = await tmc.authenticate(username, password); - expect(result2.val).to.be.instanceOf(AuthenticationError); - }); + const testDirName = this.currentTest?.fullTitle().replace(/\s/g, "_"); + if (!testDirName) throw new Error("Illegal function call."); + testDir = path.join(ARTIFACT_FOLDER, testDirName); }); - suite("deauthentication", function () { + suite("authenticated user", function () { let onLoggedInCalls: number; let onLoggedOutCalls: number; + let projectsDir: string; + let tmc: TMC; setup(function () { + const configDir = path.join(testDir, CLIENT_CONFIG_DIR_NAME); + writeCredentials(configDir); onLoggedInCalls = 0; onLoggedOutCalls = 0; + projectsDir = setupProjectsDir(configDir, path.join(testDir, "tmcdata")); + tmc = new TMC(CLI_FILE, CLIENT_NAME, "test", { + cliConfigDir: testDir, + }); tmc.on("login", () => onLoggedInCalls++); tmc.on("logout", () => onLoggedOutCalls++); }); - test("should deathenticate the user", async function () { + test("should not be able to re-authenticate", async function () { + const result = await tmc.authenticate(USERNAME, PASSWORD); + expect(result.val).to.be.instanceOf(AuthenticationError); + }); + + test("should be able to deauthenticate", async function () { const result1 = await tmc.deauthenticate(); result1.err && expect.fail(FAIL_MESSAGE + result1.val.message); expect(onLoggedOutCalls).to.be.equal(1); @@ -172,375 +81,405 @@ suite("TMC", function () { expect(onLoggedInCalls).to.be.equal(0); }); - }); - suite("clean()", function () { - test("should clean the exercise", async function () { - const result = (await tmc.clean(PASSING_EXERCISE_PATH)).unwrap(); - expect(result).to.be.undefined; - }); + test("should be able to download an existing exercise", async function () { + const result = await tmc.downloadExercises([1], () => {}); + result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); + }).timeout(10000); - test("should result in RuntimeError for nonexistent exercise", async function () { - const result = await tmc.clean(MISSING_EXERCISE_PATH); - expect(result.val).to.be.instanceOf(RuntimeError); + // Missing ids are skipped for some reason + test.skip("should not be able to download a non-existent exercise", async function () { + const downloads = (await tmc.downloadExercises([404], () => {})).unwrap(); + expect(downloads.failed?.length).to.be.equal(1); }); - }); - suite("runTests()", function () { - test("should return test results", async function () { - const result = (await tmc.runTests(PASSING_EXERCISE_PATH)[0]).unwrap(); - expect(result.status).to.be.equal("PASSED"); - }).timeout(20000); + test("should get existing api data", async function () { + const data = (await tmc.getCourseData(0)).unwrap(); + expect(data.details.name).to.be.equal("python-course"); + expect(data.exercises.length).to.be.equal(2); + expect(data.settings.name).to.be.equal("python-course"); - test("should result in RuntimeError for nonexistent exercise", async function () { - const result = await tmc.runTests(MISSING_EXERCISE_PATH)[0]; - expect(result.val).to.be.instanceOf(RuntimeError); - }); - }); + const details = (await tmc.getCourseDetails(0)).unwrap().course; + expect(details.id).to.be.equal(0); + expect(details.name).to.be.equal("python-course"); - suite("downloadExercises()", function () { - this.timeout(5000); + const exercises = (await tmc.getCourseExercises(0)).unwrap(); + expect(exercises.length).to.be.equal(2); - setup(function () { - const projectsDir = setupProjectsDir("downloadExercises"); - delSync(projectsDir, { force: true }); - }); + const settings = (await tmc.getCourseSettings(0)).unwrap(); + expect(settings.name).to.be.equal("python-course"); - // Current langs version returns generic error so handling fails - test.skip("should result in AuthorizationError if not authenticated", async function () { - const result = await tmcUnauthenticated.downloadExercises([1], () => {}); - expect(result.val).to.be.instanceOf(AuthorizationError); - }); + const courses = (await tmc.getCourses("test")).unwrap(); + expect(courses.length).to.be.equal(1); + expect(courses.some((x) => x.name === "python-course")).to.be.true; - test("should download exercise", async function () { - const result = await tmc.downloadExercises([1], () => {}); - result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); - }); - }); + const exercise = (await tmc.getExerciseDetails(1)).unwrap(); + expect(exercise.exercise_name).to.be.equal("part01-01_passing_exercise"); - suite("downloadOldSubmission()", function () { - this.timeout(5000); + const submissions = (await tmc.getOldSubmissions(1)).unwrap(); + expect(submissions.length).to.be.greaterThan(0); - let exercisePath: string; + const organization = (await tmc.getOrganization("test")).unwrap(); + expect(organization.slug).to.be.equal("test"); + expect(organization.name).to.be.equal("Test Organization"); - setup(function () { - const projectsDir = setupProjectsDir("downloadOldSubmission"); - exercisePath = path.join(projectsDir, "part01-01_passing_exercise"); - if (!fs.existsSync(exercisePath)) { - fs.ensureDirSync(exercisePath); - ncp(PASSING_EXERCISE_PATH, exercisePath, () => {}); - } + const organizations = (await tmc.getOrganizations()).unwrap(); + expect(organizations.length).to.be.equal(1, "Expected to get one organization."); }); - test.skip("should result in AuthorizationError if not authenticated", async function () { - const result = await tmcUnauthenticated.downloadOldSubmission( - 1, - exercisePath, - 404, - false, - ); - expect(result.val).to.be.instanceOf(AuthorizationError); - }); + test("should encounter errors when trying to get non-existing api data", async function () { + const dataResult = await tmc.getCourseData(404); + expect(dataResult.val).to.be.instanceOf(RuntimeError); - test("should download old submission", async function () { - const result = await tmc.downloadOldSubmission(1, exercisePath, 0, false); - result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); - }); + const detailsResult = await tmc.getCourseDetails(404); + expect(detailsResult.val).to.be.instanceOf(RuntimeError); - test("should not save old state when the flag is off", async function () { - // This test is based on a side effect of making a new submission. - const submissions = (await tmc.getOldSubmissions(1)).unwrap(); - await tmc.downloadOldSubmission(1, exercisePath, 0, false); - const newSubmissions = (await tmc.getOldSubmissions(1)).unwrap(); - expect(newSubmissions.length).to.be.equal(submissions.length); - }); + const exercisesResult = await tmc.getCourseExercises(404); + expect(exercisesResult.val).to.be.instanceOf(RuntimeError); - test("should save old state when the flag is on", async function () { - // This test is based on a side effect of making a new submission. - const submissions = (await tmc.getOldSubmissions(1)).unwrap(); - await tmc.downloadOldSubmission(1, exercisePath, 0, true); - const newSubmissions = (await tmc.getOldSubmissions(1)).unwrap(); - expect(newSubmissions.length).to.be.equal(submissions.length + 1); - }); + const settingsResult = await tmc.getCourseSettings(404); + expect(settingsResult.val).to.be.instanceOf(RuntimeError); - test("should cause RuntimeError for nonexistent exercise", async function () { - const missingExercisePath = path.resolve(exercisePath, "..", "404"); - const result = await tmc.downloadOldSubmission(1, missingExercisePath, 0, false); - expect(result.val).to.be.instanceOf(RuntimeError); - }); - }); + const coursesResult = await tmc.getCourses("404"); + expect(coursesResult.val).to.be.instanceOf(RuntimeError); - suite("getCourseData()", function () { - // Fails with TMC-langs 0.15.0 because data.output-data.kind is "generic" - test.skip("should result in AuthorizationError if not authenticated", async function () { - const result = await tmcUnauthenticated.getCourseData(0); - expect(result.val).to.be.instanceOf(AuthorizationError); - }); + const exerciseResult = await tmc.getExerciseDetails(404); + expect(exerciseResult.val).to.be.instanceOf(RuntimeError); - test("should result in course data when authenticated", async function () { - const data = (await tmc.getCourseData(0)).unwrap(); - expect(data.details.name).to.be.equal("python-course"); - expect(data.exercises.length).to.be.equal(2); - expect(data.settings.name).to.be.equal("python-course"); - }); + const submissionsResult = await tmc.getOldSubmissions(404); + expect(submissionsResult.val).to.be.instanceOf(RuntimeError); - test("should result in RuntimeError for nonexistent course", async function () { - const result = await tmc.getCourseData(404); + const result = await tmc.getOrganization("404"); expect(result.val).to.be.instanceOf(RuntimeError); }); - }); - suite("getCourseDetails()", function () { - test("should result in AuthorizationError if not authenticated", async function () { - const result = await tmcUnauthenticated.getCourseDetails(0); - expect(result.val).to.be.instanceOf(AuthorizationError); - }); - - test("should return course details of given course", async function () { - const course = (await tmc.getCourseDetails(0)).unwrap().course; - expect(course.id).to.be.equal(0); - expect(course.name).to.be.equal("python-course"); + test("should be able to give feedback", async function () { + const feedback: SubmissionFeedback = { + status: [{ question_id: 0, answer: "42" }], + }; + const result = await tmc.submitSubmissionFeedback(FEEDBACK_URL, feedback); + result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); }); - test("should result in RuntimeError for nonexistent course", async function () { - const result = await tmc.getCourseDetails(404); - expect(result.val).to.be.instanceOf(RuntimeError); + suite("with a local exercise", function () { + this.timeout(20000); + + let exercisePath: string; + + setup(async function () { + delSync(projectsDir, { force: true }); + const result = await tmc.downloadExercises([1], () => {}); + exercisePath = result.unwrap().downloaded[0].path; + }); + + test("should be able to clean the exercise", async function () { + const result = (await tmc.clean(exercisePath)).unwrap(); + expect(result).to.be.undefined; + }); + + test("should be able to run tests for exercise", async function () { + const result = (await tmc.runTests(exercisePath)[0]).unwrap(); + expect(result.status).to.be.equal("PASSED"); + }); + + test("should be able to save the exercise state and revert it to an old submission", async function () { + const submissions = (await tmc.getOldSubmissions(1)).unwrap(); + const result = await tmc.downloadOldSubmission(1, exercisePath, 0, true); + result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); + + // State saving check is based on a side effect of making a new submission. + const newSubmissions = (await tmc.getOldSubmissions(1)).unwrap(); + expect(newSubmissions.length).to.be.equal(submissions.length + 1); + }); + + test("should be able to download an old submission without saving the current state", async function () { + const submissions = (await tmc.getOldSubmissions(1)).unwrap(); + const result = await tmc.downloadOldSubmission(1, exercisePath, 0, false); + result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); + + // State saving check :monis based on a side effect of making a new submission. + const newSubmissions = (await tmc.getOldSubmissions(1)).unwrap(); + expect(newSubmissions.length).to.be.equal(submissions.length); + }); + + test("should be able to save the exercise state and reset it to original template", async function () { + const submissions = (await tmc.getOldSubmissions(1)).unwrap(); + const result = await tmc.resetExercise(1, exercisePath, true); + result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); + + // State saving check is based on a side effect of making a new submission. + const newSubmissions = (await tmc.getOldSubmissions(1)).unwrap(); + expect(newSubmissions.length).to.be.equal(submissions.length + 1); + }); + + test("should be able to reset exercise without saving the current state", async function () { + const submissions = (await tmc.getOldSubmissions(1)).unwrap(); + const result = await tmc.resetExercise(1, exercisePath, false); + result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); + + // State saving check is based on a side effect of making a new submission. + const newSubmissions = (await tmc.getOldSubmissions(1)).unwrap(); + expect(newSubmissions.length).to.be.equal(submissions.length); + }); + + test("should be able to submit the exercise for evaluation", async function () { + let url: string | undefined; + const results = ( + await tmc.submitExerciseAndWaitForResults( + 1, + exercisePath, + undefined, + (x) => (url = x), + ) + ).unwrap(); + expect(results.status).to.be.equal("ok"); + !url && expect.fail("expected to receive submission url during submission."); + }); + + test("should encounter an error if trying to submit the exercise twice too soon", async function () { + const first = tmc.submitExerciseAndWaitForResults(1, exercisePath); + const second = tmc.submitExerciseAndWaitForResults(1, exercisePath); + const [, secondResult] = await Promise.all([first, second]); + expect(secondResult.val).to.be.instanceOf(BottleneckError); + }); + + test("should be able to submit the exercise to TMC-paste", async function () { + const pasteUrl = (await tmc.submitExerciseToPaste(1, exercisePath)).unwrap(); + expect(pasteUrl).to.include("localhost"); + }); + + test("should encounter an error if trying to submit to paste twice too soon", async function () { + const first = tmc.submitExerciseToPaste(1, exercisePath); + const second = tmc.submitExerciseToPaste(1, exercisePath); + const [, secondResult] = await Promise.all([first, second]); + expect(secondResult.val).to.be.instanceOf(BottleneckError); + }); + }); + + suite("with a missing local exercise", function () { + let missingExercisePath: string; + + setup(async function () { + missingExercisePath = path.join(projectsDir, "missing-course", "missing-exercise"); + }); + + test("should encounter an error when attempting to clean it", async function () { + const result = await tmc.clean(missingExercisePath); + expect(result.val).to.be.instanceOf(RuntimeError); + }); + + test("should encounter an error when attempting to run tests for it", async function () { + const result = await tmc.runTests(missingExercisePath)[0]; + expect(result.val).to.be.instanceOf(RuntimeError); + }); + + test("should encounter an error when attempting to revert to an older submission", async function () { + const result = await tmc.downloadOldSubmission(1, missingExercisePath, 0, false); + expect(result.val).to.be.instanceOf(RuntimeError); + }); + + test("should encounter an error when trying to reset it", async function () { + const result = await tmc.resetExercise(1, missingExercisePath, false); + expect(result.val).to.be.instanceOf(RuntimeError); + }); + + test("should encounter an error when trying to submit it", async function () { + const result = await tmc.submitExerciseAndWaitForResults(1, missingExercisePath); + expect(result.val).to.be.instanceOf(RuntimeError); + }); + + test("should encounter an error when trying to submit it to TMC-paste", async function () { + const result = await tmc.submitExerciseToPaste(404, missingExercisePath); + expect(result.val).to.be.instanceOf(RuntimeError); + }); }); }); - suite("getCourseExercises()", function () { - test("should result in AuthorizationError if not authenticated", async function () { - const result = await tmcUnauthenticated.getCourseExercises(0); - expect(result.val).to.be.instanceOf(AuthorizationError); - }); - - test("should return course exercises of the given course", async function () { - const exercises = (await tmc.getCourseExercises(0)).unwrap(); - expect(exercises.length).to.be.equal(2); - }); + suite("unauthenticated user", function () { + let onLoggedInCalls: number; + let onLoggedOutCalls: number; + let configDir: string; + let projectsDir: string; + let tmc: TMC; - test("should result in RuntimeError with nonexistent course", async function () { - const result = await tmc.getCourseExercises(404); - expect(result.val).to.be.instanceOf(RuntimeError); + setup(function () { + configDir = path.join(testDir, CLIENT_CONFIG_DIR_NAME); + clearCredentials(configDir); + onLoggedInCalls = 0; + onLoggedOutCalls = 0; + projectsDir = setupProjectsDir(configDir, path.join(testDir, "tmcdata")); + tmc = new TMC(CLI_FILE, CLIENT_NAME, "test", { + cliConfigDir: testDir, + }); + tmc.on("login", () => onLoggedInCalls++); + tmc.on("logout", () => onLoggedOutCalls++); }); - }); - suite("getCourses()", function () { - test("should result in AuthorizationError if not authenticated", async function () { - const result = await tmcUnauthenticated.getCourses("test"); - expect(result.val).to.be.instanceOf(AuthorizationError); - }); + // TODO: There was something fishy with this test + test("should not be able to authenticate with empty credentials"); - test("should return courses when authenticated", async function () { - const course = (await tmc.getCourses("test")).unwrap(); - expect(course.length).to.be.equal(1); - expect(course.some((x) => x.name === "python-course")).to.be.true; + test("should not be able to authenticate with incorrect credentials", async function () { + const result = await tmc.authenticate(USERNAME, "batman123"); + expect(result.val).to.be.instanceOf(AuthenticationError); }); - test("should result in RuntimeError for nonexistent organization", async function () { - const result = await tmc.getCourses("404"); - expect(result.val).to.be.instanceOf(RuntimeError); - }); - }); + test("should be able to authenticate with correct credentials", async function () { + const result1 = await tmc.authenticate(USERNAME, PASSWORD); + result1.err && expect.fail(FAIL_MESSAGE + result1.val.message); + expect(onLoggedInCalls).to.be.equal(1); - suite("getCourseSettings()", function () { - test("should result in AuthorizationError if not authenticated", async function () { - const result = await tmcUnauthenticated.getCourseSettings(0); - expect(result.val).to.be.instanceOf(AuthorizationError); - }); + const result2 = await tmc.isAuthenticated(); + result2.err && expect.fail(FAIL_MESSAGE + result2.val.message); + expect(result2.val).to.be.true; - test("should return course settings when authenticated", async function () { - const course = (await tmc.getCourseSettings(0)).unwrap(); - expect(course.name).to.be.equal("python-course"); + expect(onLoggedOutCalls).to.be.equal(0); }); - test("should result in RuntimeError with nonexistent course", async function () { - const result = await tmc.getCourseSettings(404); + test("should not be able to download an exercise", async function () { + const result = await tmc.downloadExercises([1], () => {}); expect(result.val).to.be.instanceOf(RuntimeError); }); - }); - suite("getExerciseDetails()", function () { - test("should result in AuthorizationError if not authenticated", async function () { - const result = await tmcUnauthenticated.getExerciseDetails(1); - expect(result.val).to.be.instanceOf(AuthorizationError); - }); + test("should not get existing api data in general", async function () { + const dataResult = await tmc.getCourseData(0); + expect(dataResult.val).to.be.instanceOf(RuntimeError); - test("should return exercise details when authenticated", async function () { - const exercise = (await tmc.getExerciseDetails(1)).unwrap(); - expect(exercise.exercise_name).to.be.equal("part01-01_passing_exercise"); - }); + const detailsResult = await tmc.getCourseDetails(0); + expect(detailsResult.val).to.be.instanceOf(AuthorizationError); - test("should result in RuntimeError for nonexistent exercise", async function () { - const result = await tmc.getExerciseDetails(404); - expect(result.val).to.be.instanceOf(RuntimeError); - }); - }); + const exercisesResult = await tmc.getCourseExercises(0); + expect(exercisesResult.val).to.be.instanceOf(AuthorizationError); - suite("getOldSubmissions()", function () { - test("should result in AuthorizationError if not authenticated", async function () { - const result = await tmcUnauthenticated.getOldSubmissions(1); - expect(result.val).to.be.instanceOf(AuthorizationError); - }); + const settingsResult = await tmc.getCourseSettings(0); + expect(settingsResult.val).to.be.instanceOf(AuthorizationError); - test("should return old submissions when authenticated", async function () { - const submissions = (await tmc.getOldSubmissions(1)).unwrap(); - expect(submissions.length).to.be.greaterThan(0); - }); + const coursesResult = await tmc.getCourses("test"); + expect(coursesResult.val).to.be.instanceOf(AuthorizationError); - test("should result in RuntimeError for nonexistent exercise", async function () { - const result = await tmc.getOldSubmissions(404); - expect(result.val).to.be.instanceOf(RuntimeError); - }); - }); + const exerciseResult = await tmc.getExerciseDetails(1); + expect(exerciseResult.val).to.be.instanceOf(AuthorizationError); - suite("getOrganizations()", function () { - test("should return organizations", async function () { - const result = await tmc.getOrganizations(); - expect(result.unwrap().length).to.be.equal(1, "Expected to get one organization."); + const submissionsResult = await tmc.getOldSubmissions(1); + expect(submissionsResult.val).to.be.instanceOf(AuthorizationError); }); - }); - suite("getOrganization()", function () { - test("should return given organization", async function () { + test("should be able to get valid organization data", async function () { const organization = (await tmc.getOrganization("test")).unwrap(); expect(organization.slug).to.be.equal("test"); expect(organization.name).to.be.equal("Test Organization"); + + const organizations = (await tmc.getOrganizations()).unwrap(); + expect(organizations.length).to.be.equal(1, "Expected to get one organization."); }); - test("should result in RuntimeError for nonexistent organization", async function () { + test("should encounter error if trying to get non-existing organization data", async function () { const result = await tmc.getOrganization("404"); expect(result.val).to.be.instanceOf(RuntimeError); }); - }); - - suite("resetExercise()", function () { - this.timeout(5000); - - function setupExercise(folderName: string): string { - const projectsDir = setupProjectsDir(folderName); - const exercisePath = path.join(projectsDir, "part01-01_passing_exercise"); - if (!fs.existsSync(exercisePath)) { - fs.ensureDirSync(exercisePath); - ncp(PASSING_EXERCISE_PATH, exercisePath, () => {}); - } - return exercisePath; - } - // This actually passes - test.skip("should result in AuthorizationError if not authenticated", async function () { - const exercisePath = setupExercise("resetExercise0"); - const result = await tmcUnauthenticated.resetExercise(1, exercisePath, false); + // This seems to ok? + test.skip("should not be able to give feedback", async function () { + const feedback: SubmissionFeedback = { + status: [{ question_id: 0, answer: "42" }], + }; + const result = await tmc.submitSubmissionFeedback(FEEDBACK_URL, feedback); expect(result.val).to.be.instanceOf(AuthorizationError); }); - // Windows CI can't handle this for some reason? - test.skip("should reset exercise", async function () { - const exercisePath = setupExercise("resetExercise1"); - const result = await tmc.resetExercise(1, exercisePath, false); - result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); - }); + suite("with a local exercise", function () { + this.timeout(20000); - test("should not save old state if the flag is off", async function () { - // This test is based on a side effect of making a new submission. - const exercisePath = setupExercise("resetExercise2"); - const submissions = (await tmc.getOldSubmissions(1)).unwrap(); - await tmc.resetExercise(1, exercisePath, false); - const newSubmissions = (await tmc.getOldSubmissions(1)).unwrap(); - expect(newSubmissions.length).to.be.equal(submissions.length); - }); + let exercisePath: string; - test("should save old state if the flag is on", async function () { - // This test is based on a side effect of making a new submission. - const exercisePath = setupExercise("resetExercise3"); - const submissions = (await tmc.getOldSubmissions(1)).unwrap(); - await tmc.resetExercise(1, exercisePath, true); - const newSubmissions = (await tmc.getOldSubmissions(1)).unwrap(); - expect(newSubmissions.length).to.be.equal(submissions.length + 1); - }); - }); + setup(async function () { + delSync(projectsDir, { force: true }); + writeCredentials(configDir); + const result = await tmc.downloadExercises([1], () => {}); + clearCredentials(configDir); + exercisePath = result.unwrap().downloaded[0].path; + }); - suite("submitExerciseAndWaitForResults()", function () { - test("should result in AuthorizationError if not authenticated", async function () { - const result = await tmcUnauthenticated.submitExerciseAndWaitForResults( - 1, - PASSING_EXERCISE_PATH, - ); - expect(result.val).to.be.instanceOf(AuthorizationError); - }); + test("should be able to clean the exercise", async function () { + const result = (await tmc.clean(exercisePath)).unwrap(); + expect(result).to.be.undefined; + }); - test("should make a submission and give results when authenticated", async function () { - this.timeout(5000); - const results = ( - await tmc.submitExerciseAndWaitForResults(1, PASSING_EXERCISE_PATH) - ).unwrap(); - expect(results.status).to.be.equal("ok"); - }); + test("should be able to run tests for exercise", async function () { + const result = (await tmc.runTests(exercisePath)[0]).unwrap(); + expect(result.status).to.be.equal("PASSED"); + }); - test("should return submission link during the submission process", async function () { - this.timeout(5000); - let url: string | undefined; - await tmc.submitExerciseAndWaitForResults( - 1, - PASSING_EXERCISE_PATH, - undefined, - (x) => (url = x), - ); - expect(url).to.be.ok; - }); + test("should not be able to load old submission", async function () { + const result = await tmc.downloadOldSubmission(1, exercisePath, 0, true); + expect(result.val).to.be.instanceOf(RuntimeError); + }); - test("should result in BottleneckError if called twice too soon", async function () { - this.timeout(5000); - const first = tmc.submitExerciseAndWaitForResults(1, PASSING_EXERCISE_PATH); - const second = tmc.submitExerciseAndWaitForResults(1, PASSING_EXERCISE_PATH); - const [, secondResult] = await Promise.all([first, second]); - expect(secondResult.val).to.be.instanceOf(BottleneckError); - }); + test("should not be able to reset exercise", async function () { + const result = await tmc.resetExercise(1, exercisePath, true); + expect(result.val).to.be.instanceOf(AuthorizationError); + }); - test("should result in RuntimeError for nonexistent exercise", async function () { - const result = await tmc.submitExerciseAndWaitForResults(1, MISSING_EXERCISE_PATH); - expect(result.val).to.be.instanceOf(RuntimeError); + test("should not be able to submit exercise", async function () { + const result = await tmc.submitExerciseAndWaitForResults(1, exercisePath); + expect(result.val).to.be.instanceOf(AuthorizationError); + }); + + // This actually works + test.skip("should not be able to submit exercise to TMC-paste", async function () { + const result = await tmc.submitExerciseToPaste(1, exercisePath); + expect(result.val).to.be.instanceOf(AuthorizationError); + }); }); }); - suite("submitExerciseToPaste()", function () { - // Current Langs doesn't actually check this - test.skip("should result in AuthorizationError if not authenticated", async function () { - const result = await tmcUnauthenticated.submitExerciseToPaste(1, PASSING_EXERCISE_PATH); - expect(result.val).to.be.instanceOf(AuthorizationError); - }); + suiteTeardown(function () { + server && kill(server.pid); + }); +}); - test("should make a paste submission when authenticated", async function () { - const pasteUrl = (await tmc.submitExerciseToPaste(1, PASSING_EXERCISE_PATH)).unwrap(); - expect(pasteUrl).to.include("localhost"); - }); +function writeCredentials(configDir: string): void { + if (!fs.existsSync(configDir)) { + fs.mkdirSync(configDir, { recursive: true }); + } + fs.writeFileSync( + path.join(configDir, "credentials.json"), + '{"access_token":"1234","token_type":"bearer","scope":"public"}', + ); +} - test("should result in BottleneckError if called twice too soon", async function () { - this.timeout(5000); - const first = tmc.submitExerciseAndWaitForResults(1, PASSING_EXERCISE_PATH); - const second = tmc.submitExerciseAndWaitForResults(1, PASSING_EXERCISE_PATH); - const [, secondResult] = await Promise.all([first, second]); - expect(secondResult.val).to.be.instanceOf(BottleneckError); - }); +function clearCredentials(configDir: string): void { + delSync(configDir, { force: true }); +} - test("should result in RuntimeError for nonexistent exercise", async function () { - const result = await tmc.submitExerciseToPaste(404, MISSING_EXERCISE_PATH); - expect(result.val).to.be.instanceOf(RuntimeError); - }); +function setupProjectsDir(configDir: string, projectsDir: string): string { + if (!fs.existsSync(configDir)) { + fs.mkdirSync(configDir, { recursive: true }); + } + fs.writeFileSync(path.join(configDir, "config.toml"), `projects-dir = '${projectsDir}'\n`); + return projectsDir; +} + +async function startServer(): Promise { + let ready = false; + console.log(path.join(__dirname, "..", "backend")); + const server = cp.spawn("npm", ["start"], { + cwd: path.join(__dirname, "..", "backend"), + shell: "bash", + }); + server.stdout.on("data", (chunk) => { + if (chunk.toString().startsWith("Server listening to")) { + ready = true; + } }); - suite("submitSubmissionFeedback()", function () { - const feedback: SubmissionFeedback = { - status: [{ question_id: 0, answer: "42" }], - }; + const timeout = setTimeout(() => { + throw new Error("Failed to start server"); + }, 20000); - test("should submit feedback when authenticated", async function () { - const result = await tmc.submitSubmissionFeedback(FEEDBACK_URL, feedback); - result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); - }); - }); + while (!ready) { + await new Promise((resolve) => setTimeout(resolve, 1000)); + } - suiteTeardown(function () { - server && kill(server.pid); - }); -}); + clearTimeout(timeout); + return server; +} From b7afb23cc333a8cdd07d782817641db8a2431369 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Fri, 30 Apr 2021 17:49:20 +0300 Subject: [PATCH 48/79] Re-implement latest submission auto downloading (#579) --- src/actions/downloadOrUpdateExercises.ts | 6 +-- src/api/tmc.ts | 9 ++-- src/test-integration/tmc_langs_cli.spec.ts | 10 ++--- .../actions/downloadOrUpdateExercises.test.ts | 45 +++++++++++++++++-- src/test/mocks/settings.ts | 23 ++++++++++ src/test/mocks/tmc.ts | 2 +- src/ui/templates/Settings.jsx | 6 --- 7 files changed, 80 insertions(+), 21 deletions(-) create mode 100644 src/test/mocks/settings.ts diff --git a/src/actions/downloadOrUpdateExercises.ts b/src/actions/downloadOrUpdateExercises.ts index af0cfc8e..2e6932d0 100644 --- a/src/actions/downloadOrUpdateExercises.ts +++ b/src/actions/downloadOrUpdateExercises.ts @@ -25,7 +25,7 @@ export async function downloadOrUpdateExercises( actionContext: ActionContext, exerciseIds: number[], ): Promise> { - const { dialog, tmc, ui } = actionContext; + const { dialog, settings, tmc, ui } = actionContext; if (exerciseIds.length === 0) { return Ok({ successful: [], failed: [] }); } @@ -33,12 +33,12 @@ export async function downloadOrUpdateExercises( ui.webview.postMessage(...exerciseIds.map((x) => wrapToMessage(x, "downloading"))); const statuses = new Map(exerciseIds.map((x) => [x, "downloadFailed"])); - // TODO: How to download latest submission in new version? + const downloadTemplate = !settings.getDownloadOldSubmission(); const downloadResult = await dialog.progressNotification( "Downloading exercises...", (progress) => limit(() => - tmc.downloadExercises(exerciseIds, (download) => { + tmc.downloadExercises(exerciseIds, downloadTemplate, (download) => { progress.report(download); statuses.set(download.id, "closed"); ui.webview.postMessage(wrapToMessage(download.id, "closed")); diff --git a/src/api/tmc.ts b/src/api/tmc.ts index 82964432..e1c49e63 100644 --- a/src/api/tmc.ts +++ b/src/api/tmc.ts @@ -449,28 +449,31 @@ export default class TMC { * `download-or-update-course-exercises` core command internally. * * @param ids Ids of the exercises to download. + * @param downloadTemplate Flag for downloading exercise template instead of latest submission. */ public async downloadExercises( ids: number[], - downloaded: (value: { id: number; percent: number; message?: string }) => void, + downloadTemplate: boolean, + onDownloaded: (value: { id: number; percent: number; message?: string }) => void, ): Promise> { const onStdout = (res: StatusUpdateData): void => { if ( res["update-data-kind"] === "client-update-data" && res.data?.["client-update-data-kind"] === "exercise-download" ) { - downloaded({ + onDownloaded({ id: res.data.id, percent: res["percent-done"], message: res.message ?? undefined, }); } }; + const flags = downloadTemplate ? ["--download-template"] : []; const res = await this._executeLangsCommand( { args: [ "download-or-update-course-exercises", - "--download-template", + ...flags, "--exercise-id", ...ids.map((id) => id.toString()), ], diff --git a/src/test-integration/tmc_langs_cli.spec.ts b/src/test-integration/tmc_langs_cli.spec.ts index 163b5303..0d60b532 100644 --- a/src/test-integration/tmc_langs_cli.spec.ts +++ b/src/test-integration/tmc_langs_cli.spec.ts @@ -83,13 +83,13 @@ suite("tmc langs cli spec", function () { }); test("should be able to download an existing exercise", async function () { - const result = await tmc.downloadExercises([1], () => {}); + const result = await tmc.downloadExercises([1], true, () => {}); result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); }).timeout(10000); // Missing ids are skipped for some reason test.skip("should not be able to download a non-existent exercise", async function () { - const downloads = (await tmc.downloadExercises([404], () => {})).unwrap(); + const downloads = (await tmc.downloadExercises([404], true, () => {})).unwrap(); expect(downloads.failed?.length).to.be.equal(1); }); @@ -168,7 +168,7 @@ suite("tmc langs cli spec", function () { setup(async function () { delSync(projectsDir, { force: true }); - const result = await tmc.downloadExercises([1], () => {}); + const result = await tmc.downloadExercises([1], true, () => {}); exercisePath = result.unwrap().downloaded[0].path; }); @@ -336,7 +336,7 @@ suite("tmc langs cli spec", function () { }); test("should not be able to download an exercise", async function () { - const result = await tmc.downloadExercises([1], () => {}); + const result = await tmc.downloadExercises([1], true, () => {}); expect(result.val).to.be.instanceOf(RuntimeError); }); @@ -394,7 +394,7 @@ suite("tmc langs cli spec", function () { setup(async function () { delSync(projectsDir, { force: true }); writeCredentials(configDir); - const result = await tmc.downloadExercises([1], () => {}); + const result = await tmc.downloadExercises([1], true, () => {}); clearCredentials(configDir); exercisePath = result.unwrap().downloaded[0].path; }); diff --git a/src/test/actions/downloadOrUpdateExercises.test.ts b/src/test/actions/downloadOrUpdateExercises.test.ts index f138f5f9..8f194a12 100644 --- a/src/test/actions/downloadOrUpdateExercises.test.ts +++ b/src/test/actions/downloadOrUpdateExercises.test.ts @@ -8,11 +8,13 @@ import { ActionContext } from "../../actions/types"; import Dialog from "../../api/dialog"; import { DownloadOrUpdateCourseExercisesResult, ExerciseDownload } from "../../api/langsSchema"; import TMC from "../../api/tmc"; +import Settings from "../../config/settings"; import { ExerciseStatus, WebviewMessage } from "../../ui/types"; import UI from "../../ui/ui"; import TmcWebview from "../../ui/webview"; import { createMockActionContext } from "../mocks/actionContext"; import { createDialogMock } from "../mocks/dialog"; +import { createSettingsMock, SettingsMockValues } from "../mocks/settings"; import { createTMCMock, TMCMockValues } from "../mocks/tmc"; import { createUIMock, UIMockValues } from "../mocks/ui"; import { createWebviewMock, WebviewMockValues } from "../mocks/webview"; @@ -35,6 +37,8 @@ suite("downloadOrUpdateExercises action", function () { const stubContext = createMockActionContext(); let dialogMock: IMock; + let settingsMock: IMock; + let settingsMockValues: SettingsMockValues; let tmcMock: IMock; let tmcMockValues: TMCMockValues; let uiMock: IMock; @@ -46,6 +50,7 @@ suite("downloadOrUpdateExercises action", function () { const actionContext = (): ActionContext => ({ ...stubContext, dialog: dialogMock.object, + settings: settingsMock.object, tmc: tmcMock.object, ui: uiMock.object, }); @@ -64,6 +69,7 @@ suite("downloadOrUpdateExercises action", function () { setup(function () { [dialogMock] = createDialogMock(); + [settingsMock, settingsMockValues] = createSettingsMock(); [tmcMock, tmcMockValues] = createTMCMock(); [uiMock, uiMockValues] = createUIMock(); webviewMessages = []; @@ -80,7 +86,12 @@ suite("downloadOrUpdateExercises action", function () { test("should not call TMC-langs if no exercises are given", async function () { await downloadOrUpdateExercises(actionContext(), []); - expect(tmcMock.verify((x) => x.downloadExercises(It.isAny(), It.isAny()), Times.never())); + expect( + tmcMock.verify( + (x) => x.downloadExercises(It.isAny(), It.isAny(), It.isAny()), + Times.never(), + ), + ); }); test("should return error if TMC-langs fails", async function () { @@ -133,11 +144,39 @@ suite("downloadOrUpdateExercises action", function () { expect(result.failed).to.be.deep.equal([1, 2]); }); + test("should download template if downloadOldSubmission setting is off", async function () { + tmcMockValues.downloadExercises = createDownloadResult([helloWorld], [], undefined); + settingsMockValues.getDownloadOldSubmission = false; + await downloadOrUpdateExercises(actionContext(), [1]); + tmcMock.verify( + (x) => x.downloadExercises(It.isAny(), It.isValue(true), It.isAny()), + Times.once(), + ); + tmcMock.verify( + (x) => x.downloadExercises(It.isAny(), It.isValue(false), It.isAny()), + Times.never(), + ); + }); + + test("should not necessarily download template if downloadOldSubmission setting is on", async function () { + tmcMockValues.downloadExercises = createDownloadResult([helloWorld], [], undefined); + settingsMockValues.getDownloadOldSubmission = true; + await downloadOrUpdateExercises(actionContext(), [1]); + tmcMock.verify( + (x) => x.downloadExercises(It.isAny(), It.isValue(true), It.isAny()), + Times.never(), + ); + tmcMock.verify( + (x) => x.downloadExercises(It.isAny(), It.isValue(false), It.isAny()), + Times.once(), + ); + }); + test("should post status updates of succeeding download", async function () { tmcMock.reset(); tmcMock - .setup((x) => x.downloadExercises(It.isAny(), It.isAny())) - .returns(async (_, cb) => { + .setup((x) => x.downloadExercises(It.isAny(), It.isAny(), It.isAny())) + .returns(async (_1, _2, cb) => { // Callback is only used for successful downloads cb({ id: helloWorld.id, percent: 0.5 }); return createDownloadResult([helloWorld], [], undefined); diff --git a/src/test/mocks/settings.ts b/src/test/mocks/settings.ts new file mode 100644 index 00000000..961f6e88 --- /dev/null +++ b/src/test/mocks/settings.ts @@ -0,0 +1,23 @@ +import { IMock, Mock } from "typemoq"; + +import Settings from "../../config/settings"; + +export interface SettingsMockValues { + getDownloadOldSubmission: boolean; +} + +export function createSettingsMock(): [IMock, SettingsMockValues] { + const values: SettingsMockValues = { + getDownloadOldSubmission: false, + }; + const mock = setupMockValues(values); + return [mock, values]; +} + +function setupMockValues(values: SettingsMockValues): IMock { + const mock = Mock.ofType(); + + mock.setup((x) => x.getDownloadOldSubmission()).returns(() => values.getDownloadOldSubmission); + + return mock; +} diff --git a/src/test/mocks/tmc.ts b/src/test/mocks/tmc.ts index db7e7c7b..3af8f893 100644 --- a/src/test/mocks/tmc.ts +++ b/src/test/mocks/tmc.ts @@ -103,7 +103,7 @@ function setupMockValues(values: TMCMockValues): IMock { async () => values.checkExerciseUpdates, ); - mock.setup((x) => x.downloadExercises(It.isAny(), It.isAny())).returns( + mock.setup((x) => x.downloadExercises(It.isAny(), It.isAny(), It.isAny())).returns( async () => values.downloadExercises, ); diff --git a/src/ui/templates/Settings.jsx b/src/ui/templates/Settings.jsx index 4a8b71b9..4d3f839b 100644 --- a/src/ui/templates/Settings.jsx +++ b/src/ui/templates/Settings.jsx @@ -85,12 +85,6 @@ const component = () => { Downloads the latest submission of an exercise by default, when available.

-

- - Note: this feature is currently unavailable and will be added - back in future version. - -

Date: Fri, 30 Apr 2021 18:00:29 +0300 Subject: [PATCH 49/79] Wait a second --- backend/setup.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/backend/setup.ts b/backend/setup.ts index b2215d35..c64d0640 100644 --- a/backend/setup.ts +++ b/backend/setup.ts @@ -23,7 +23,7 @@ const copyTMCPythonModules = async (): Promise => { ncp(module, target, () => {}); }); console.log("Modules copied!"); - + await new Promise((res) => setTimeout(res, 1000)); await Promise.all( pythonExercises.map(async (exercise) => { console.log(`Creating download archive for ${exercise}`); From caa4c07fae8f889a85168a0c9182561030caafef Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Fri, 30 Apr 2021 19:18:34 +0300 Subject: [PATCH 50/79] Cap artifact subfolder name length --- src/test-integration/tmc_langs_cli.spec.ts | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/test-integration/tmc_langs_cli.spec.ts b/src/test-integration/tmc_langs_cli.spec.ts index 0d60b532..1ab39d4c 100644 --- a/src/test-integration/tmc_langs_cli.spec.ts +++ b/src/test-integration/tmc_langs_cli.spec.ts @@ -41,8 +41,14 @@ suite("tmc langs cli spec", function () { let testDir: string; setup(function () { - const testDirName = this.currentTest?.fullTitle().replace(/\s/g, "_"); + let testDirName = this.currentTest?.fullTitle().replace(/\s/g, "_"); if (!testDirName) throw new Error("Illegal function call."); + if (testDirName?.length > 72) { + testDirName = + testDirName.substring(0, 40) + + ".." + + testDirName.substring(testDirName.length - 30); + } testDir = path.join(ARTIFACT_FOLDER, testDirName); }); From 6cdf4e75ac4c2db51dddc99e9640a5adec6fd000 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Tue, 4 May 2021 11:26:11 +0300 Subject: [PATCH 51/79] Settings command tests, disable poorly behaving ones --- src/api/tmc.ts | 17 ++++++----- src/test-integration/tmc_langs_cli.spec.ts | 34 ++++++++++++++++++++-- 2 files changed, 42 insertions(+), 9 deletions(-) diff --git a/src/api/tmc.ts b/src/api/tmc.ts index e1c49e63..8e18556b 100644 --- a/src/api/tmc.ts +++ b/src/api/tmc.ts @@ -372,11 +372,14 @@ export default class TMC { args: ["settings", "--client-name", this.clientName, "get", key], core: false, }, - createIs>(), + createIs(), ); - return res.andThen((x) => { - const result_1 = x.data["output-data"]; - return checker(result_1) ? Ok(result_1) : Err(new Error("Invalid object type.")); + return res.andThen((x) => { + const data = x.data?.["output-data"]; + if (data === undefined || data === null) { + return Ok(undefined); + } + return checker(data) ? Ok(data) : Err(new Error("Invalid object type.")); }); } @@ -390,7 +393,7 @@ export default class TMC { args: ["settings", "--client-name", this.clientName, "set", key, value], core: false, }, - createIs>(), + createIs(), ); return res.err ? res : Ok.EMPTY; } @@ -405,7 +408,7 @@ export default class TMC { args: ["settings", "--client-name", this.clientName, "reset"], core: false, }, - createIs>(), + createIs(), ); return res.err ? res : Ok.EMPTY; } @@ -420,7 +423,7 @@ export default class TMC { args: ["settings", "--client-name", this.clientName, "unset", key], core: false, }, - createIs>(), + createIs(), ); return res.err ? res : Ok.EMPTY; } diff --git a/src/test-integration/tmc_langs_cli.spec.ts b/src/test-integration/tmc_langs_cli.spec.ts index 1ab39d4c..d6bfd660 100644 --- a/src/test-integration/tmc_langs_cli.spec.ts +++ b/src/test-integration/tmc_langs_cli.spec.ts @@ -4,6 +4,7 @@ import { sync as delSync } from "del"; import * as fs from "fs-extra"; import * as path from "path"; import * as kill from "tree-kill"; +import { Result } from "ts-results"; import TMC from "../api/tmc"; import { SubmissionFeedback } from "../api/types"; @@ -88,6 +89,27 @@ suite("tmc langs cli spec", function () { expect(onLoggedInCalls).to.be.equal(0); }); + test("should be able to read and change settings", async function () { + const key = "test-value"; + const isString = (object: unknown): object is string => typeof object === "string"; + + const result1 = await unwrapResult(tmc.getSetting(key, isString)); + expect(result1).to.be.undefined; + + await unwrapResult(tmc.setSetting(key, "yes no yes yes")); + const result2 = await unwrapResult(tmc.getSetting(key, isString)); + expect(result2).to.be.equal("yes no yes yes"); + + await unwrapResult(tmc.unsetSetting(key)); + const result3 = await unwrapResult(tmc.getSetting(key, isString)); + expect(result3).to.be.undefined; + + await unwrapResult(tmc.setSetting(key, "foo bar biz baz")); + await unwrapResult(tmc.resetSettings()); + const result4 = await unwrapResult(tmc.getSetting(key, isString)); + expect(result4).to.be.undefined; + }); + test("should be able to download an existing exercise", async function () { const result = await tmc.downloadExercises([1], true, () => {}); result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); @@ -208,7 +230,8 @@ suite("tmc langs cli spec", function () { expect(newSubmissions.length).to.be.equal(submissions.length); }); - test("should be able to save the exercise state and reset it to original template", async function () { + // Langs fails to remove folder on Windows CI + test.skip("should be able to save the exercise state and reset it to original template", async function () { const submissions = (await tmc.getOldSubmissions(1)).unwrap(); const result = await tmc.resetExercise(1, exercisePath, true); result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); @@ -218,7 +241,8 @@ suite("tmc langs cli spec", function () { expect(newSubmissions.length).to.be.equal(submissions.length + 1); }); - test("should be able to reset exercise without saving the current state", async function () { + // Langs fails to remove folder on Windows CI + test.skip("should be able to reset exercise without saving the current state", async function () { const submissions = (await tmc.getOldSubmissions(1)).unwrap(); const result = await tmc.resetExercise(1, exercisePath, false); result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); @@ -465,6 +489,12 @@ function setupProjectsDir(configDir: string, projectsDir: string): string { return projectsDir; } +async function unwrapResult(result: Promise>): Promise { + const res = await result; + if (res.err) expect.fail(FAIL_MESSAGE + res.val.message); + return res.val; +} + async function startServer(): Promise { let ready = false; console.log(path.join(__dirname, "..", "backend")); From f895fcc820296a2a68e34cc7a229f8690dddc1d7 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Tue, 4 May 2021 12:15:26 +0300 Subject: [PATCH 52/79] Final tests + clean up --- src/api/tmc.ts | 70 +++++++------- src/test-integration/tmc_langs_cli.spec.ts | 106 +++++++++++---------- 2 files changed, 93 insertions(+), 83 deletions(-) diff --git a/src/api/tmc.ts b/src/api/tmc.ts index 8e18556b..60ad3e18 100644 --- a/src/api/tmc.ts +++ b/src/api/tmc.ts @@ -255,40 +255,6 @@ export default class TMC { return res.map((x) => x.data["output-data"]); } - /** - * Moves this instance's projects directory on disk. Uses TMC-langs `settings move-projects-dir` - * setting internally. - * - * @param newDirectory New location for projects directory. - * @param onUpdate Progress callback. - */ - public async moveProjectsDirectory( - newDirectory: string, - onUpdate?: (value: { percent: number; message?: string }) => void, - ): Promise> { - const onStdout = (res: StatusUpdateData): void => { - onUpdate?.({ - percent: res["percent-done"], - message: res.message ?? undefined, - }); - }; - const res = await this._executeLangsCommand( - { - args: [ - "settings", - "--client-name", - this.clientName, - "move-projects-dir", - newDirectory, - ], - core: false, - onStdout, - }, - createIs>(), - ); - return res.err ? res : Ok.EMPTY; - } - /** * Runs local tests for given exercise. Uses TMC-langs `run-tests` command internally. * @@ -354,7 +320,41 @@ export default class TMC { ], core: false, }, - createIs>(), + createIs(), + ); + return res.err ? res : Ok.EMPTY; + } + + /** + * Moves this instance's projects directory on disk. Uses TMC-langs `settings move-projects-dir` + * setting internally. + * + * @param newDirectory New location for projects directory. + * @param onUpdate Progress callback. + */ + public async moveProjectsDirectory( + newDirectory: string, + onUpdate?: (value: { percent: number; message?: string }) => void, + ): Promise> { + const onStdout = (res: StatusUpdateData): void => { + onUpdate?.({ + percent: res["percent-done"], + message: res.message ?? undefined, + }); + }; + const res = await this._executeLangsCommand( + { + args: [ + "settings", + "--client-name", + this.clientName, + "move-projects-dir", + newDirectory, + ], + core: false, + onStdout, + }, + createIs(), ); return res.err ? res : Ok.EMPTY; } diff --git a/src/test-integration/tmc_langs_cli.spec.ts b/src/test-integration/tmc_langs_cli.spec.ts index d6bfd660..37898d1e 100644 --- a/src/test-integration/tmc_langs_cli.spec.ts +++ b/src/test-integration/tmc_langs_cli.spec.ts @@ -26,11 +26,9 @@ const FEEDBACK_URL = "http://localhost:4001/feedback"; const USERNAME = "TestMyExtension"; const PASSWORD = "hunter2"; -// This one is mandated by TMC-langs. +// Config dir name must follow conventions mandated by TMC-langs. const CLIENT_CONFIG_DIR_NAME = `tmc-${CLIENT_NAME}`; -const FAIL_MESSAGE = "TMC-langs execution failed: "; - suite("tmc langs cli spec", function () { let server: cp.ChildProcess | undefined; @@ -54,13 +52,14 @@ suite("tmc langs cli spec", function () { }); suite("authenticated user", function () { + let configDir: string; let onLoggedInCalls: number; let onLoggedOutCalls: number; let projectsDir: string; let tmc: TMC; setup(function () { - const configDir = path.join(testDir, CLIENT_CONFIG_DIR_NAME); + configDir = path.join(testDir, CLIENT_CONFIG_DIR_NAME); writeCredentials(configDir); onLoggedInCalls = 0; onLoggedOutCalls = 0; @@ -78,13 +77,11 @@ suite("tmc langs cli spec", function () { }); test("should be able to deauthenticate", async function () { - const result1 = await tmc.deauthenticate(); - result1.err && expect.fail(FAIL_MESSAGE + result1.val.message); + await unwrapResult(tmc.deauthenticate()); expect(onLoggedOutCalls).to.be.equal(1); - const result2 = await tmc.isAuthenticated(); - result2.err && expect.fail(FAIL_MESSAGE + result2.val.message); - expect(result2.val).to.be.false; + const result = await unwrapResult(tmc.isAuthenticated()); + expect(result).to.be.false; expect(onLoggedInCalls).to.be.equal(0); }); @@ -185,8 +182,7 @@ suite("tmc langs cli spec", function () { const feedback: SubmissionFeedback = { status: [{ question_id: 0, answer: "42" }], }; - const result = await tmc.submitSubmissionFeedback(FEEDBACK_URL, feedback); - result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); + await unwrapResult(tmc.submitSubmissionFeedback(FEEDBACK_URL, feedback)); }); suite("with a local exercise", function () { @@ -196,72 +192,88 @@ suite("tmc langs cli spec", function () { setup(async function () { delSync(projectsDir, { force: true }); - const result = await tmc.downloadExercises([1], true, () => {}); - exercisePath = result.unwrap().downloaded[0].path; + const result = (await tmc.downloadExercises([1], true, () => {})).unwrap(); + exercisePath = result.downloaded[0].path; }); test("should be able to clean the exercise", async function () { - const result = (await tmc.clean(exercisePath)).unwrap(); - expect(result).to.be.undefined; + await unwrapResult(tmc.clean(exercisePath)); }); test("should be able to run tests for exercise", async function () { - const result = (await tmc.runTests(exercisePath)[0]).unwrap(); + const result = await unwrapResult(tmc.runTests(exercisePath)[0]); expect(result.status).to.be.equal("PASSED"); }); + test("should be able to migrate the exercise to langs projects directory", async function () { + // By changing projects directory path, the exercise is no longer there. Therefore + // it can be "migrated". + projectsDir = setupProjectsDir(configDir, path.join(testDir, "tmcdata2")); + fs.emptyDirSync(projectsDir); + await unwrapResult( + tmc.migrateExercise("python-course", "abc123", 1, exercisePath, "hello-world"), + ); + }); + + test("should be able to move projects directory", async function () { + const newProjectsDir = path.resolve(projectsDir, "..", "tmcdata2"); + fs.emptyDirSync(newProjectsDir); + await unwrapResult(tmc.moveProjectsDirectory(newProjectsDir)); + }); + + test("should be able to check for exercise updates", async function () { + const result = await unwrapResult(tmc.checkExerciseUpdates()); + expect(result.length).to.be.equal(0); + }); + test("should be able to save the exercise state and revert it to an old submission", async function () { - const submissions = (await tmc.getOldSubmissions(1)).unwrap(); - const result = await tmc.downloadOldSubmission(1, exercisePath, 0, true); - result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); + const submissions = await unwrapResult(tmc.getOldSubmissions(1)); + await unwrapResult(tmc.downloadOldSubmission(1, exercisePath, 0, true)); // State saving check is based on a side effect of making a new submission. - const newSubmissions = (await tmc.getOldSubmissions(1)).unwrap(); + const newSubmissions = await unwrapResult(tmc.getOldSubmissions(1)); expect(newSubmissions.length).to.be.equal(submissions.length + 1); }); test("should be able to download an old submission without saving the current state", async function () { - const submissions = (await tmc.getOldSubmissions(1)).unwrap(); - const result = await tmc.downloadOldSubmission(1, exercisePath, 0, false); - result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); + const submissions = await unwrapResult(tmc.getOldSubmissions(1)); + await unwrapResult(tmc.downloadOldSubmission(1, exercisePath, 0, false)); - // State saving check :monis based on a side effect of making a new submission. - const newSubmissions = (await tmc.getOldSubmissions(1)).unwrap(); + // State saving check is based on a side effect of making a new submission. + const newSubmissions = await unwrapResult(tmc.getOldSubmissions(1)); expect(newSubmissions.length).to.be.equal(submissions.length); }); // Langs fails to remove folder on Windows CI test.skip("should be able to save the exercise state and reset it to original template", async function () { - const submissions = (await tmc.getOldSubmissions(1)).unwrap(); - const result = await tmc.resetExercise(1, exercisePath, true); - result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); + const submissions = await unwrapResult(tmc.getOldSubmissions(1)); + await unwrapResult(tmc.resetExercise(1, exercisePath, true)); // State saving check is based on a side effect of making a new submission. - const newSubmissions = (await tmc.getOldSubmissions(1)).unwrap(); + const newSubmissions = await unwrapResult(tmc.getOldSubmissions(1)); expect(newSubmissions.length).to.be.equal(submissions.length + 1); }); // Langs fails to remove folder on Windows CI test.skip("should be able to reset exercise without saving the current state", async function () { - const submissions = (await tmc.getOldSubmissions(1)).unwrap(); - const result = await tmc.resetExercise(1, exercisePath, false); - result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); + const submissions = await unwrapResult(tmc.getOldSubmissions(1)); + await unwrapResult(tmc.resetExercise(1, exercisePath, false)); // State saving check is based on a side effect of making a new submission. - const newSubmissions = (await tmc.getOldSubmissions(1)).unwrap(); + const newSubmissions = await unwrapResult(tmc.getOldSubmissions(1)); expect(newSubmissions.length).to.be.equal(submissions.length); }); test("should be able to submit the exercise for evaluation", async function () { let url: string | undefined; - const results = ( - await tmc.submitExerciseAndWaitForResults( + const results = await unwrapResult( + tmc.submitExerciseAndWaitForResults( 1, exercisePath, undefined, (x) => (url = x), - ) - ).unwrap(); + ), + ); expect(results.status).to.be.equal("ok"); !url && expect.fail("expected to receive submission url during submission."); }); @@ -274,7 +286,7 @@ suite("tmc langs cli spec", function () { }); test("should be able to submit the exercise to TMC-paste", async function () { - const pasteUrl = (await tmc.submitExerciseToPaste(1, exercisePath)).unwrap(); + const pasteUrl = await unwrapResult(tmc.submitExerciseToPaste(1, exercisePath)); expect(pasteUrl).to.include("localhost"); }); @@ -354,13 +366,11 @@ suite("tmc langs cli spec", function () { }); test("should be able to authenticate with correct credentials", async function () { - const result1 = await tmc.authenticate(USERNAME, PASSWORD); - result1.err && expect.fail(FAIL_MESSAGE + result1.val.message); + await unwrapResult(tmc.authenticate(USERNAME, PASSWORD)); expect(onLoggedInCalls).to.be.equal(1); - const result2 = await tmc.isAuthenticated(); - result2.err && expect.fail(FAIL_MESSAGE + result2.val.message); - expect(result2.val).to.be.true; + const result2 = await unwrapResult(tmc.isAuthenticated()); + expect(result2).to.be.true; expect(onLoggedOutCalls).to.be.equal(0); }); @@ -394,11 +404,11 @@ suite("tmc langs cli spec", function () { }); test("should be able to get valid organization data", async function () { - const organization = (await tmc.getOrganization("test")).unwrap(); + const organization = await unwrapResult(tmc.getOrganization("test")); expect(organization.slug).to.be.equal("test"); expect(organization.name).to.be.equal("Test Organization"); - const organizations = (await tmc.getOrganizations()).unwrap(); + const organizations = await unwrapResult(tmc.getOrganizations()); expect(organizations.length).to.be.equal(1, "Expected to get one organization."); }); @@ -430,12 +440,12 @@ suite("tmc langs cli spec", function () { }); test("should be able to clean the exercise", async function () { - const result = (await tmc.clean(exercisePath)).unwrap(); + const result = await unwrapResult(tmc.clean(exercisePath)); expect(result).to.be.undefined; }); test("should be able to run tests for exercise", async function () { - const result = (await tmc.runTests(exercisePath)[0]).unwrap(); + const result = await unwrapResult(tmc.runTests(exercisePath)[0]); expect(result.status).to.be.equal("PASSED"); }); @@ -491,7 +501,7 @@ function setupProjectsDir(configDir: string, projectsDir: string): string { async function unwrapResult(result: Promise>): Promise { const res = await result; - if (res.err) expect.fail(FAIL_MESSAGE + res.val.message); + if (res.err) expect.fail(`TMC-langs execution failed: ${res.val.message}`); return res.val; } From 4ae9b488b0b6a8ff6f80004e17749ad4be5b517f Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Wed, 5 May 2021 14:59:31 +0300 Subject: [PATCH 53/79] Empty credentials test --- src/api/tmc.ts | 17 +++-------------- src/test-integration/tmc_langs_cli.spec.ts | 5 ++++- 2 files changed, 7 insertions(+), 15 deletions(-) diff --git a/src/api/tmc.ts b/src/api/tmc.ts index 60ad3e18..52300060 100644 --- a/src/api/tmc.ts +++ b/src/api/tmc.ts @@ -150,6 +150,9 @@ export default class TMC { * @param password Password. */ public async authenticate(username: string, password: string): Promise> { + if (!username || !password) { + return Err(new AuthenticationError("Username and password may not be empty.")); + } const res = await this._executeLangsCommand( { args: ["login", "--email", username, "--base64"], @@ -968,20 +971,6 @@ export default class TMC { ); } - // TODO: actual todo - // Special handling because it makes usage simpler - // if (is(outputDataKind)) { - // const data: Data = { - // "output-data-kind": "exercise-download", - // "output-data": { - // downloaded: outputDataKind.completed, - // skipped: outputDataKind.skipped, - // }, - // }; - - // return Ok({ ...langsResponse, data }); - // } - return Err(new RuntimeError(message, traceString)); } diff --git a/src/test-integration/tmc_langs_cli.spec.ts b/src/test-integration/tmc_langs_cli.spec.ts index 37898d1e..8055b51c 100644 --- a/src/test-integration/tmc_langs_cli.spec.ts +++ b/src/test-integration/tmc_langs_cli.spec.ts @@ -358,7 +358,10 @@ suite("tmc langs cli spec", function () { }); // TODO: There was something fishy with this test - test("should not be able to authenticate with empty credentials"); + test("should not be able to authenticate with empty credentials", async function () { + const result = await tmc.authenticate("", ""); + expect(result.val).to.be.instanceOf(AuthenticationError); + }); test("should not be able to authenticate with incorrect credentials", async function () { const result = await tmc.authenticate(USERNAME, "batman123"); From 6842e29a332a0ba1f815dca02a3304c6b70ba8da Mon Sep 17 00:00:00 2001 From: Sebastian Sergelius Date: Wed, 12 May 2021 07:44:37 +0100 Subject: [PATCH 54/79] Move settings callback registering to init --- src/extension.ts | 20 +------------------- src/init/index.ts | 1 + src/init/settings.ts | 23 +++++++++++++++++++++++ 3 files changed, 25 insertions(+), 19 deletions(-) create mode 100644 src/init/settings.ts diff --git a/src/extension.ts b/src/extension.ts index 4c36eff4..76cef8bf 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -9,7 +9,6 @@ import ExerciseDecorationProvider from "./api/exerciseDecorationProvider"; import Storage from "./api/storage"; import TMC from "./api/tmc"; import WorkspaceManager from "./api/workspaceManager"; -import * as commands from "./commands"; import { CLIENT_NAME, DEBUG_MODE, @@ -148,19 +147,6 @@ export async function activate(context: vscode.ExtensionContext): Promise const settings = new Settings(storage, resources); context.subscriptions.push(settings); - settings.onChangeHideMetaFiles = async (value: boolean): Promise => { - await workspaceManager.updateWorkspaceSetting("testMyCode.hideMetaFiles", value); - await workspaceManager.excludeMetaFilesInWorkspace(value); - }; - settings.onChangeDownloadOldSubmission = async (value: boolean): Promise => { - await workspaceManager.updateWorkspaceSetting("testMyCode.downloadOldSubmission", value); - }; - settings.onChangeUpdateExercisesAutomatically = async (value: boolean): Promise => { - await workspaceManager.updateWorkspaceSetting( - "testMyCode.updateExercisesAutomatically", - value, - ); - }; const temporaryWebviewProvider = new TemporaryWebviewProvider(resources, ui); const exerciseDecorationProvider = new ExerciseDecorationProvider(userData, workspaceManager); @@ -184,11 +170,7 @@ export async function activate(context: vscode.ExtensionContext): Promise init.registerUiActions(actionContext); init.registerCommands(context, actionContext); - - await settings.setTmcDataPathPlaceholder(tmcDataPath); - settings.onChangeTmcDataPath = async (): Promise => { - await commands.changeTmcDataPath(actionContext); - }; + init.registerSettingsCallbacks(actionContext); context.subscriptions.push( vscode.window.registerFileDecorationProvider(exerciseDecorationProvider), diff --git a/src/init/index.ts b/src/init/index.ts index 3eddf205..e6789332 100644 --- a/src/init/index.ts +++ b/src/init/index.ts @@ -2,3 +2,4 @@ export * from "./commands"; export * from "./resources"; export * from "./ui"; export * from "./downloadCorrectLangsVersion"; +export * from "./settings"; diff --git a/src/init/settings.ts b/src/init/settings.ts new file mode 100644 index 00000000..b021a8e3 --- /dev/null +++ b/src/init/settings.ts @@ -0,0 +1,23 @@ +import { ActionContext } from "../actions/types"; +import * as commands from "../commands"; + +export async function registerSettingsCallbacks(actionContext: ActionContext): Promise { + const { settings, workspaceManager, resources } = actionContext; + settings.onChangeHideMetaFiles = async (value: boolean): Promise => { + await workspaceManager.updateWorkspaceSetting("testMyCode.hideMetaFiles", value); + await workspaceManager.excludeMetaFilesInWorkspace(value); + }; + settings.onChangeDownloadOldSubmission = async (value: boolean): Promise => { + await workspaceManager.updateWorkspaceSetting("testMyCode.downloadOldSubmission", value); + }; + settings.onChangeUpdateExercisesAutomatically = async (value: boolean): Promise => { + await workspaceManager.updateWorkspaceSetting( + "testMyCode.updateExercisesAutomatically", + value, + ); + }; + await settings.setTmcDataPathPlaceholder(resources.projectsDirectory); + settings.onChangeTmcDataPath = async (): Promise => { + await commands.changeTmcDataPath(actionContext); + }; +} From 0778e582734b60bab4323b1102932ff963a63722 Mon Sep 17 00:00:00 2001 From: Sebastian Sergelius Date: Wed, 12 May 2021 07:45:43 +0100 Subject: [PATCH 55/79] Cleanup, work on change tmc datapath --- src/actions/user.ts | 40 ------------------------------------- src/api/workspaceManager.ts | 3 +++ src/config/settings.ts | 15 ++++++++++---- 3 files changed, 14 insertions(+), 44 deletions(-) diff --git a/src/actions/user.ts b/src/actions/user.ts index 10974940..e6ec8002 100644 --- a/src/actions/user.ts +++ b/src/actions/user.ts @@ -446,46 +446,6 @@ export async function openWorkspace(actionContext: ActionContext, name: string): } } -// /** -// * Deprecated -// * Settings webview -// */ -// export async function openSettings(actionContext: ActionContext): Promise { -// const { dialog, ui, resources, settings } = actionContext; -// Logger.log("Display extension settings"); -// const extensionSettingsResult = await settings.getExtensionSettings(); -// if (extensionSettingsResult.err) { -// dialog.errorNotification("Failed to fetch settings.", extensionSettingsResult.val); -// return; -// } - -// const extensionSettings = extensionSettingsResult.val; -// ui.webview.setContentFromTemplate({ templateName: "settings" }, true, [ -// { -// command: "setBooleanSetting", -// setting: "downloadOldSubmission", -// enabled: extensionSettings.hideMetaFiles, -// }, -// { -// command: "setBooleanSetting", -// setting: "hideMetaFiles", -// enabled: extensionSettings.hideMetaFiles, -// }, -// { command: "setBooleanSetting", setting: "insider", enabled: settings.isInsider() }, -// { -// command: "setBooleanSetting", -// setting: "updateExercisesAutomatically", -// enabled: settings.getAutomaticallyUpdateExercises(), -// }, -// { command: "setLogLevel", level: settings.getLogLevel() }, -// { -// command: "setTmcDataFolder", -// diskSize: formatSizeInBytes(await du(resources.projectsDirectory)), -// path: resources.projectsDirectory, -// }, -// ]); -// } - /** * Removes given course from UserData and removes its associated files. However, doesn't remove any * exercises that are on disk. diff --git a/src/api/workspaceManager.ts b/src/api/workspaceManager.ts index 1214605e..57813503 100644 --- a/src/api/workspaceManager.ts +++ b/src/api/workspaceManager.ts @@ -93,6 +93,9 @@ export default class WorkspaceManager implements vscode.Disposable { return uri && this.getExerciseByPath(uri); } + /** + * Currently active course workspace uri, or `undefined` otherwise. + */ public get workspaceFileUri(): vscode.Uri | undefined { const workspaceFile = vscode.workspace.workspaceFile; if ( diff --git a/src/config/settings.ts b/src/config/settings.ts index a0bcd89b..bbd05785 100644 --- a/src/config/settings.ts +++ b/src/config/settings.ts @@ -72,11 +72,18 @@ export default class Settings implements vscode.Disposable { .get("insiderVersion", false); this._settings.insiderVersion = value; } + // Hacky work-around, because VSCode Settings UI + // doesn't support buttons to toggle an event if (event.affectsConfiguration("testMyCode.dataPath.changeTmcDataPath")) { - this._onChangeTmcDataPath?.(); - await vscode.workspace - .getConfiguration() - .update("testMyCode.dataPath.changeTmcDataPath", false, true); + const value = vscode.workspace + .getConfiguration("testMyCode") + .get("dataPath.changeTmcDataPath", false); + if (value) { + this._onChangeTmcDataPath?.(); + await vscode.workspace + .getConfiguration() + .update("testMyCode.dataPath.changeTmcDataPath", false, true); + } } // Workspace settings From 26482ea8c87e23cbebdcd1207119c0cd7d153114 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Fri, 14 May 2021 12:47:29 +0300 Subject: [PATCH 56/79] Revert "Move ncp to main node_modules" This reverts commit 508fad22592e3617067cdc9b7ad04b2b05600949. --- backend/package-lock.json | 15 +++++++++++++++ backend/package.json | 2 ++ package-lock.json | 15 --------------- package.json | 2 -- 4 files changed, 17 insertions(+), 17 deletions(-) diff --git a/backend/package-lock.json b/backend/package-lock.json index 3d013d5f..8c24ce2a 100644 --- a/backend/package-lock.json +++ b/backend/package-lock.json @@ -77,6 +77,15 @@ "integrity": "sha512-tHq6qdbT9U1IRSGf14CL0pUlULksvY9OZ+5eEgl1N7t+OA3tGvNpxJCzuKQlsNgCVwbAs670L1vcVQi8j9HjnA==", "dev": true }, + "@types/ncp": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/@types/ncp/-/ncp-2.0.4.tgz", + "integrity": "sha512-erpimpT1pH8QfeNg77ypnjwz6CGMqrnL4DewVbqFzD9FXzSULjmG3KzjZnLNe7bzTSZm2W9DpkHyqop1g1KmgQ==", + "dev": true, + "requires": { + "@types/node": "*" + } + }, "@types/node": { "version": "14.0.19", "resolved": "https://registry.npmjs.org/@types/node/-/node-14.0.19.tgz", @@ -957,6 +966,12 @@ "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=" }, + "ncp": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ncp/-/ncp-2.0.0.tgz", + "integrity": "sha1-GVoh1sRuNh0vsSgbo4uR6d9727M=", + "dev": true + }, "negotiator": { "version": "0.6.2", "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.2.tgz", diff --git a/backend/package.json b/backend/package.json index f315f911..0017ae49 100644 --- a/backend/package.json +++ b/backend/package.json @@ -14,7 +14,9 @@ "devDependencies": { "@types/archiver": "^5.1.0", "@types/express": "^4.17.11", + "@types/ncp": "^2.0.4", "archiver": "^5.3.0", + "ncp": "^2.0.0", "ts-node-dev": "^1.1.6", "typescript": "^4.2.4" }, diff --git a/package-lock.json b/package-lock.json index 2c529c5a..cb424a18 100644 --- a/package-lock.json +++ b/package-lock.json @@ -2113,15 +2113,6 @@ "@types/node": "*" } }, - "@types/ncp": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/@types/ncp/-/ncp-2.0.4.tgz", - "integrity": "sha512-erpimpT1pH8QfeNg77ypnjwz6CGMqrnL4DewVbqFzD9FXzSULjmG3KzjZnLNe7bzTSZm2W9DpkHyqop1g1KmgQ==", - "dev": true, - "requires": { - "@types/node": "*" - } - }, "@types/node": { "version": "14.14.37", "resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.37.tgz", @@ -6394,12 +6385,6 @@ "integrity": "sha1-Sr6/7tdUHywnrPspvbvRXI1bpPc=", "dev": true }, - "ncp": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ncp/-/ncp-2.0.0.tgz", - "integrity": "sha1-GVoh1sRuNh0vsSgbo4uR6d9727M=", - "dev": true - }, "neo-async": { "version": "2.6.2", "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", diff --git a/package.json b/package.json index 1c023e6a..dd83d659 100644 --- a/package.json +++ b/package.json @@ -413,7 +413,6 @@ "@types/lodash": "^4.14.168", "@types/mocha": "^8.2.2", "@types/mock-fs": "^4.13.0", - "@types/ncp": "^2.0.4", "@types/node": "^14.14.37", "@types/node-fetch": "^2.5.10", "@types/unzipper": "^0.10.3", @@ -434,7 +433,6 @@ "lint-staged": "^10.5.4", "mocha": "^8.3.2", "mock-fs": "^4.13.0", - "ncp": "^2.0.0", "prettier": "^2.2.1", "raw-loader": "^4.0.2", "terser-webpack-plugin": "^5.1.1", From 6f78edb89a06682f0d2b02c85d5f6f5ecb4bc384 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Fri, 14 May 2021 12:49:17 +0300 Subject: [PATCH 57/79] Prettier formating changes --- src/actions/user.ts | 9 ++------- src/api/exerciseDecorationProvider.ts | 3 ++- src/config/constants.ts | 3 ++- 3 files changed, 6 insertions(+), 9 deletions(-) diff --git a/src/actions/user.ts b/src/actions/user.ts index eacbd4ac..210499a5 100644 --- a/src/actions/user.ts +++ b/src/actions/user.ts @@ -189,13 +189,8 @@ export async function submitExercise( actionContext: ActionContext, exercise: WorkspaceExercise, ): Promise> { - const { - dialog, - exerciseDecorationProvider, - temporaryWebviewProvider, - tmc, - userData, - } = actionContext; + const { dialog, exerciseDecorationProvider, temporaryWebviewProvider, tmc, userData } = + actionContext; Logger.log(`Submitting exercise ${exercise.exerciseSlug} to server`); const course = userData.getCourseByName(exercise.courseSlug); diff --git a/src/api/exerciseDecorationProvider.ts b/src/api/exerciseDecorationProvider.ts index 514dbc59..3284f6bf 100644 --- a/src/api/exerciseDecorationProvider.ts +++ b/src/api/exerciseDecorationProvider.ts @@ -7,7 +7,8 @@ import { UserData } from "../config/userdata"; * Class that adds decorations like completion icons for exercises. */ export default class ExerciseDecorationProvider - implements vscode.Disposable, vscode.FileDecorationProvider { + implements vscode.Disposable, vscode.FileDecorationProvider +{ public onDidChangeFileDecorations: vscode.Event; private static _passedExercise = new vscode.FileDecoration( diff --git a/src/config/constants.ts b/src/config/constants.ts index 8408293a..c57f03ab 100644 --- a/src/config/constants.ts +++ b/src/config/constants.ts @@ -34,7 +34,8 @@ export const EXERCISE_CHECK_INTERVAL = 30 * 60 * 1000; export const MINIMUM_SUBMISSION_INTERVAL = 5 * 1000; export const LOCAL_EXERCISE_AVAILABLE_POINTS_PLACEHOLDER = 1; -export const LOCAL_EXERCISE_AWARDED_POINTS_PLACEHOLDER = LOCAL_EXERCISE_AVAILABLE_POINTS_PLACEHOLDER; +export const LOCAL_EXERCISE_AWARDED_POINTS_PLACEHOLDER = + LOCAL_EXERCISE_AVAILABLE_POINTS_PLACEHOLDER; export const LOCAL_EXERCISE_UNAWARDED_POINTS_PLACEHOLDER = 0; export const HIDE_META_FILES = { From 7afdbb6a9c802f876689c14b8a90d24d0484315c Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Fri, 14 May 2021 15:03:23 +0300 Subject: [PATCH 58/79] Use TMC-langs version 0.18.0 --- config.js | 2 +- src/api/tmc.ts | 142 ++++++++------------- src/test-integration/tmc_langs_cli.spec.ts | 7 +- 3 files changed, 56 insertions(+), 95 deletions(-) diff --git a/config.js b/config.js index 428bbde8..91bd97c1 100644 --- a/config.js +++ b/config.js @@ -3,7 +3,7 @@ const path = require("path"); -const TMC_LANGS_RUST_VERSION = "0.17.3"; +const TMC_LANGS_RUST_VERSION = "0.18.0"; const localTMCServer = { __TMC_BACKEND__URL__: JSON.stringify("http://localhost:3000"), diff --git a/src/api/tmc.ts b/src/api/tmc.ts index 1090cf52..2d1453be 100644 --- a/src/api/tmc.ts +++ b/src/api/tmc.ts @@ -60,7 +60,6 @@ interface ExecutionOptions { interface LangsProcessArgs { args: string[]; - core: boolean; env?: { [key: string]: string }; /** Which args should be obfuscated in logs. */ obfuscate?: number[]; @@ -155,9 +154,8 @@ export default class TMC { } const res = await this._executeLangsCommand( { - args: ["login", "--email", username, "--base64"], - core: true, - obfuscate: [2], + args: ["core", "login", "--email", username, "--base64"], + obfuscate: [3], stdin: Buffer.from(password).toString("base64"), }, createIs(), @@ -179,8 +177,7 @@ export default class TMC { public async isAuthenticated(options?: ExecutionOptions): Promise> { const res = await this._executeLangsCommand( { - args: ["logged-in"], - core: true, + args: ["core", "logged-in"], processTimeout: options?.timeout, }, createIs(), @@ -202,7 +199,7 @@ export default class TMC { */ public async deauthenticate(): Promise> { const res = await this._executeLangsCommand( - { args: ["logout"], core: true }, + { args: ["core", "logout"] }, createIs(), ); return res.andThen(() => { @@ -224,10 +221,7 @@ export default class TMC { */ public async clean(exercisePath: string): Promise> { const res = await this._executeLangsCommand( - { - args: ["clean", "--exercise-path", exercisePath], - core: false, - }, + { args: ["clean", "--exercise-path", exercisePath] }, createIs(), ); return res.err ? res : Ok.EMPTY; @@ -243,16 +237,7 @@ export default class TMC { courseSlug: string, ): Promise> { const res = await this._executeLangsCommand( - { - args: [ - "list-local-course-exercises", - "--client-name", - this.clientName, - "--course-slug", - courseSlug, - ], - core: false, - }, + { args: ["list-local-course-exercises", "--course-slug", courseSlug] }, createIs>(), ); return res.map((x) => x.data["output-data"]); @@ -275,7 +260,6 @@ export default class TMC { } const { interrupt, result } = this._spawnLangsProcess({ args: ["run-tests", "--exercise-path", exercisePath], - core: false, env, onStderr: (data) => Logger.log("Rust Langs", data), processTimeout: CLI_PROCESS_TIMEOUT, @@ -307,8 +291,6 @@ export default class TMC { { args: [ "settings", - "--client-name", - this.clientName, "migrate", "--course-slug", courseSlug, @@ -321,7 +303,6 @@ export default class TMC { "--exercise-slug", exerciseSlug, ], - core: false, }, createIs(), ); @@ -347,14 +328,7 @@ export default class TMC { }; const res = await this._executeLangsCommand( { - args: [ - "settings", - "--client-name", - this.clientName, - "move-projects-dir", - newDirectory, - ], - core: false, + args: ["settings", "move-projects-dir", newDirectory], onStdout, }, createIs(), @@ -371,10 +345,7 @@ export default class TMC { checker: (object: unknown) => object is T, ): Promise> { const res = await this._executeLangsCommand( - { - args: ["settings", "--client-name", this.clientName, "get", key], - core: false, - }, + { args: ["settings", "get", key] }, createIs(), ); return res.andThen((x) => { @@ -392,10 +363,7 @@ export default class TMC { */ public async setSetting(key: string, value: string): Promise> { const res = await this._executeLangsCommand( - { - args: ["settings", "--client-name", this.clientName, "set", key, value], - core: false, - }, + { args: ["settings", "set", key, JSON.stringify(value)] }, createIs(), ); return res.err ? res : Ok.EMPTY; @@ -407,10 +375,7 @@ export default class TMC { */ public async resetSettings(): Promise> { const res = await this._executeLangsCommand( - { - args: ["settings", "--client-name", this.clientName, "reset"], - core: false, - }, + { args: ["settings", "reset"] }, createIs(), ); return res.err ? res : Ok.EMPTY; @@ -422,10 +387,7 @@ export default class TMC { */ public async unsetSetting(key: string): Promise> { const res = await this._executeLangsCommand( - { - args: ["settings", "--client-name", this.clientName, "unset", key], - core: false, - }, + { args: ["settings", "unset", key] }, createIs(), ); return res.err ? res : Ok.EMPTY; @@ -443,7 +405,7 @@ export default class TMC { options?: CacheOptions, ): Promise, Error>> { const res = await this._executeLangsCommand( - { args: ["check-exercise-updates"], core: true }, + { args: ["core", "check-exercise-updates"] }, createIs>>(), { forceRefresh: options?.forceRefresh, key: TMC._exerciseUpdatesCacheKey }, ); @@ -478,12 +440,12 @@ export default class TMC { const res = await this._executeLangsCommand( { args: [ + "core", "download-or-update-course-exercises", ...flags, "--exercise-id", ...ids.map((id) => id.toString()), ], - core: true, onStdout, }, createIs>(), @@ -514,6 +476,7 @@ export default class TMC { ): Promise> { const flags = saveOldState ? ["--save-old-state"] : []; const args = [ + "core", "download-old-submission", ...flags, "--exercise-id", @@ -529,10 +492,7 @@ export default class TMC { `${TMC_BACKEND_URL}/api/v8/core/exercises/${exerciseId}/submissions`, ); } - const res = await this._executeLangsCommand( - { args, core: true }, - createIs(), - ); + const res = await this._executeLangsCommand({ args }, createIs()); return res.err ? res : Ok.EMPTY; } @@ -548,7 +508,7 @@ export default class TMC { options?: CacheOptions, ): Promise> { const res = await this._executeLangsCommand( - { args: ["get-courses", "--organization", organization], core: true }, + { args: ["core", "get-courses", "--organization", organization] }, createIs>(), { forceRefresh: options?.forceRefresh, @@ -597,7 +557,7 @@ export default class TMC { ]; }; const res = await this._executeLangsCommand>( - { args: ["get-course-data", "--course-id", courseId.toString()], core: true }, + { args: ["core", "get-course-data", "--course-id", courseId.toString()] }, createIs>(), { forceRefresh: options?.forceRefresh, key: `course-${courseId}-data`, remapper }, ); @@ -616,7 +576,7 @@ export default class TMC { options?: CacheOptions, ): Promise> { const res = await this._executeLangsCommand( - { args: ["get-course-details", "--course-id", courseId.toString()], core: true }, + { args: ["core", "get-course-details", "--course-id", courseId.toString()] }, createIs>(), { forceRefresh: options?.forceRefresh, key: `course-${courseId}-details` }, ); @@ -635,7 +595,7 @@ export default class TMC { options?: CacheOptions, ): Promise> { const res = await this._executeLangsCommand( - { args: ["get-course-exercises", "--course-id", courseId.toString()], core: true }, + { args: ["core", "get-course-exercises", "--course-id", courseId.toString()] }, createIs>(), { forceRefresh: options?.forceRefresh, key: `course-${courseId}-exercises` }, ); @@ -654,7 +614,7 @@ export default class TMC { options?: CacheOptions, ): Promise> { const res = await this._executeLangsCommand( - { args: ["get-course-settings", "--course-id", courseId.toString()], core: true }, + { args: ["core", "get-course-settings", "--course-id", courseId.toString()] }, createIs>(), { forceRefresh: options?.forceRefresh, key: `course-${courseId}-settings` }, ); @@ -673,10 +633,7 @@ export default class TMC { options?: CacheOptions, ): Promise> { const res = await this._executeLangsCommand( - { - args: ["get-exercise-details", "--exercise-id", exerciseId.toString()], - core: true, - }, + { args: ["core", "get-exercise-details", "--exercise-id", exerciseId.toString()] }, createIs>(), { forceRefresh: options?.forceRefresh, key: `exercise-${exerciseId}-details` }, ); @@ -692,10 +649,7 @@ export default class TMC { */ public async getOldSubmissions(exerciseId: number): Promise> { const res = await this._executeLangsCommand( - { - args: ["get-exercise-submissions", "--exercise-id", exerciseId.toString()], - core: true, - }, + { args: ["core", "get-exercise-submissions", "--exercise-id", exerciseId.toString()] }, createIs>(), ); return res.map((x) => x.data["output-data"]); @@ -713,7 +667,7 @@ export default class TMC { options?: CacheOptions, ): Promise> { const res = await this._executeLangsCommand( - { args: ["get-organization", "--organization", organizationSlug], core: true }, + { args: ["core", "get-organization", "--organization", organizationSlug] }, createIs>(), { forceRefresh: options?.forceRefresh, key: `organization-${organizationSlug}` }, ); @@ -734,7 +688,7 @@ export default class TMC { ]); }; const res = await this._executeLangsCommand( - { args: ["get-organizations"], core: true }, + { args: ["core", "get-organizations"] }, createIs>(), { forceRefresh: options?.forceRefresh, key: "organizations", remapper }, ); @@ -755,6 +709,7 @@ export default class TMC { ): Promise> { const flags = saveOldState ? ["--save-old-state"] : []; const args = [ + "core", "reset-exercise", ...flags, "--exercise-id", @@ -768,10 +723,7 @@ export default class TMC { `${TMC_BACKEND_URL}/api/v8/core/exercises/${exerciseId}/submissions`, ); } - const res = await this._executeLangsCommand( - { args, core: true }, - createIs(), - ); + const res = await this._executeLangsCommand({ args }, createIs()); return res.err ? res : Ok.EMPTY; } @@ -811,8 +763,14 @@ export default class TMC { const res = await this._executeLangsCommand( { - args: ["submit", "--submission-path", exercisePath, "--submission-url", submitUrl], - core: true, + args: [ + "core", + "submit", + "--submission-path", + exercisePath, + "--submission-url", + submitUrl, + ], onStdout, }, createIs>(), @@ -843,8 +801,14 @@ export default class TMC { const submitUrl = `${TMC_BACKEND_URL}/api/v8/core/exercises/${exerciseId}/submissions`; const res = await this._executeLangsCommand( { - args: ["paste", "--submission-path", exercisePath, "--submission-url", submitUrl], - core: true, + args: [ + "core", + "paste", + "--submission-path", + exercisePath, + "--submission-url", + submitUrl, + ], }, createIs>(), ); @@ -867,10 +831,7 @@ export default class TMC { [], ); const res = await this._executeLangsCommand( - { - args: ["send-feedback", ...feedbackArgs, "--feedback-url", feedbackUrl], - core: true, - }, + { args: ["core", "send-feedback", ...feedbackArgs, "--feedback-url", feedbackUrl] }, createIs>(), ); return res.map((x) => x.data["output-data"]); @@ -980,10 +941,8 @@ export default class TMC { * @returns Rust process runner. */ private _spawnLangsProcess(commandArgs: LangsProcessArgs): LangsProcessRunner { - const { args, core, env, obfuscate, onStderr, onStdout, stdin, processTimeout } = - commandArgs; - const CORE_ARGS = [ - "core", + const { args, env, obfuscate, onStderr, onStdout, stdin, processTimeout } = commandArgs; + const clientInfo = [ "--client-name", this.clientName, "--client-version", @@ -993,12 +952,13 @@ export default class TMC { let theResult: UncheckedOutputData | undefined; let stdoutBuffer = ""; - const executableArgs = core ? CORE_ARGS.concat(args) : args; + const executableArgs = clientInfo.concat(args); const obfuscatedArgs = args.map((x, i) => (obfuscate?.includes(i) ? "***" : x)); - const logableArgs = core ? CORE_ARGS.concat(obfuscatedArgs) : obfuscatedArgs; - Logger.log( - "Run: " + [this.cliPath, ...logableArgs].map((x) => JSON.stringify(x)).join(" "), - ); + const logableCommand = [this.cliPath] + .concat(clientInfo, obfuscatedArgs) + .map((x) => JSON.stringify(x)) + .join(" "); + Logger.log(`Run: ${logableCommand}`); let active = true; let interrupted = false; diff --git a/src/test-integration/tmc_langs_cli.spec.ts b/src/test-integration/tmc_langs_cli.spec.ts index 8055b51c..fd522edc 100644 --- a/src/test-integration/tmc_langs_cli.spec.ts +++ b/src/test-integration/tmc_langs_cli.spec.ts @@ -12,7 +12,7 @@ import { CLIENT_NAME, TMC_LANGS_VERSION } from "../config/constants"; import { AuthenticationError, AuthorizationError, BottleneckError, RuntimeError } from "../errors"; import { getLangsCLIForPlatform, getPlatform } from "../utils/"; -// __dirname is the dist folder when executed. +// __dirname is the dist folder when built. const PROJECT_ROOT = path.join(__dirname, ".."); const ARTIFACT_FOLDER = path.join(PROJECT_ROOT, "test-artifacts"); @@ -112,7 +112,7 @@ suite("tmc langs cli spec", function () { result.err && expect.fail(`Expected operation to succeed: ${result.val.message}`); }).timeout(10000); - // Missing ids are skipped for some reason + // Ids missing from the server are missing from the response. test.skip("should not be able to download a non-existent exercise", async function () { const downloads = (await tmc.downloadExercises([404], true, () => {})).unwrap(); expect(downloads.failed?.length).to.be.equal(1); @@ -315,7 +315,8 @@ suite("tmc langs cli spec", function () { expect(result.val).to.be.instanceOf(RuntimeError); }); - test("should encounter an error when attempting to revert to an older submission", async function () { + // Downloads exercise on Langs 0.18 + test.skip("should encounter an error when attempting to revert to an older submission", async function () { const result = await tmc.downloadOldSubmission(1, missingExercisePath, 0, false); expect(result.val).to.be.instanceOf(RuntimeError); }); From f57b951e3f8f68879b5771e352020a4408640354 Mon Sep 17 00:00:00 2001 From: Jori Lampi Date: Fri, 14 May 2021 16:19:54 +0300 Subject: [PATCH 59/79] Add tests for listing local course exercises --- src/test-integration/tmc_langs_cli.spec.ts | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/src/test-integration/tmc_langs_cli.spec.ts b/src/test-integration/tmc_langs_cli.spec.ts index fd522edc..d945ea02 100644 --- a/src/test-integration/tmc_langs_cli.spec.ts +++ b/src/test-integration/tmc_langs_cli.spec.ts @@ -2,6 +2,7 @@ import { expect } from "chai"; import * as cp from "child_process"; import { sync as delSync } from "del"; import * as fs from "fs-extra"; +import { first } from "lodash"; import * as path from "path"; import * as kill from "tree-kill"; import { Result } from "ts-results"; @@ -200,6 +201,12 @@ suite("tmc langs cli spec", function () { await unwrapResult(tmc.clean(exercisePath)); }); + test("should be able to list local exercises", async function () { + const result = await unwrapResult(tmc.listLocalCourseExercises("python-course")); + expect(result.length).to.be.equal(1); + expect(first(result)?.["exercise-path"]).to.be.equal(exercisePath); + }); + test("should be able to run tests for exercise", async function () { const result = await unwrapResult(tmc.runTests(exercisePath)[0]); expect(result.status).to.be.equal("PASSED"); @@ -438,9 +445,9 @@ suite("tmc langs cli spec", function () { setup(async function () { delSync(projectsDir, { force: true }); writeCredentials(configDir); - const result = await tmc.downloadExercises([1], true, () => {}); + const result = (await tmc.downloadExercises([1], true, () => {})).unwrap(); clearCredentials(configDir); - exercisePath = result.unwrap().downloaded[0].path; + exercisePath = result.downloaded[0].path; }); test("should be able to clean the exercise", async function () { @@ -448,6 +455,12 @@ suite("tmc langs cli spec", function () { expect(result).to.be.undefined; }); + test("should be able to list local exercises", async function () { + const result = await unwrapResult(tmc.listLocalCourseExercises("python-course")); + expect(result.length).to.be.equal(1); + expect(first(result)?.["exercise-path"]).to.be.equal(exercisePath); + }); + test("should be able to run tests for exercise", async function () { const result = await unwrapResult(tmc.runTests(exercisePath)[0]); expect(result.status).to.be.equal("PASSED"); @@ -492,7 +505,7 @@ function writeCredentials(configDir: string): void { } function clearCredentials(configDir: string): void { - delSync(configDir, { force: true }); + delSync(path.join(configDir, "credentials.json"), { force: true }); } function setupProjectsDir(configDir: string, projectsDir: string): string { From 3b075707fc6812956148591bb8568079e0caccea Mon Sep 17 00:00:00 2001 From: Sebastian Sergelius Date: Mon, 31 May 2021 14:53:51 +0300 Subject: [PATCH 60/79] Deprecation comments & remove resources dependency --- src/config/settings.ts | 30 +++++++++++++++++++----------- src/extension.ts | 2 +- 2 files changed, 20 insertions(+), 12 deletions(-) diff --git a/src/config/settings.ts b/src/config/settings.ts index bbd05785..454cd2fd 100644 --- a/src/config/settings.ts +++ b/src/config/settings.ts @@ -1,4 +1,3 @@ -import { Ok, Result } from "ts-results"; import * as vscode from "vscode"; import Storage, { @@ -7,8 +6,9 @@ import Storage, { } from "../api/storage"; import { Logger, LogLevel } from "../utils/logger"; -import Resources from "./resources"; - +/** + * @deprecated Default values are now implemented in package.json / VSCode settings. + */ export interface ExtensionSettings { downloadOldSubmission: boolean; hideMetaFiles: boolean; @@ -26,6 +26,9 @@ export interface ExtensionSettings { * so that we can test and don't need workspaceManager dependency. */ export default class Settings implements vscode.Disposable { + /** + * @deprecated Default values are now implemented in package.json / VSCode settings. + */ private static readonly _defaultSettings: ExtensionSettings = { downloadOldSubmission: true, hideMetaFiles: true, @@ -43,16 +46,19 @@ export default class Settings implements vscode.Disposable { * @deprecated Storage dependency should be removed when major 3.0 release. */ private readonly _storage: Storage; - private readonly _resources: Resources; + /** + * @deprecated Values will be stored in VSCode Settings + */ private _settings: ExtensionSettings; private _state: SessionState; private _disposables: vscode.Disposable[]; - constructor(storage: Storage, resources: Resources) { + constructor(storage: Storage) { this._storage = storage; - this._resources = resources; + // Remove on major 3.0 const storedSettings = storage.getExtensionSettings(); + // Remove on major 3.0 this._settings = storedSettings ? Settings._deserializeExtensionSettings(storedSettings) : Settings._defaultSettings; @@ -133,6 +139,9 @@ export default class Settings implements vscode.Disposable { .update("currentLocation", path, true); } + /** + * @deprecated Storage dependency should be removed when major 3.0 release. + */ public async updateExtensionSettingsToStorage(settings: ExtensionSettings): Promise { await this._storage.updateExtensionSettings(settings); } @@ -151,10 +160,6 @@ export default class Settings implements vscode.Disposable { return this._getWorkspaceSettingValue("updateExercisesAutomatically"); } - public async getExtensionSettings(): Promise> { - return Ok(this._settings); - } - public isInsider(): boolean { return vscode.workspace .getConfiguration("testMyCode") @@ -163,10 +168,13 @@ export default class Settings implements vscode.Disposable { public async configureIsInsider(value: boolean): Promise { this._settings.insiderVersion = value; - vscode.workspace.getConfiguration("testMyCode").update("insiderVersion", value, true); + await vscode.workspace.getConfiguration("testMyCode").update("insiderVersion", value, true); await this.updateExtensionSettingsToStorage(this._settings); } + /** + * @deprecated To be removed aswell when Storage dependency removed in major 3.0. + */ private static _deserializeExtensionSettings( settings: SerializedExtensionSettings, ): ExtensionSettings { diff --git a/src/extension.ts b/src/extension.ts index 76cef8bf..1fad2d53 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -145,7 +145,7 @@ export async function activate(context: vscode.ExtensionContext): Promise await workspaceManager.verifyWorkspaceSettingsIntegrity(); } - const settings = new Settings(storage, resources); + const settings = new Settings(storage); context.subscriptions.push(settings); const temporaryWebviewProvider = new TemporaryWebviewProvider(resources, ui); From 849fd51e9da4b3f0f4c6c7ba1e8d1638b51ed82f Mon Sep 17 00:00:00 2001 From: Sebastian Sergelius Date: Tue, 1 Jun 2021 08:31:18 +0300 Subject: [PATCH 61/79] Change TMC Data path functionality to My Courses, depr comments --- package.json | 2 +- src/actions/webview.ts | 17 ++++++++++-- src/api/storage.ts | 3 +++ src/commands/changeTmcDataPath.ts | 10 +++++-- src/config/settings.ts | 2 -- src/extension.ts | 11 ++++---- src/init/ui.ts | 7 +++++ src/ui/templates/MyCourses.jsx | 45 ++++++++++++++++++++++++------- 8 files changed, 75 insertions(+), 22 deletions(-) diff --git a/package.json b/package.json index 7c66a310..5f8932d4 100644 --- a/package.json +++ b/package.json @@ -192,7 +192,7 @@ "type": "boolean", "scope": "application", "default": false, - "description": "Toggle this checkmark to select a new location." + "description": "Toggle this checkmark to select a new location for your TMC exercises." }, "testMyCode.dataPath.currentLocation": { "type": "string", diff --git a/src/actions/webview.ts b/src/actions/webview.ts index 3d765e35..665dbc6f 100644 --- a/src/actions/webview.ts +++ b/src/actions/webview.ts @@ -4,11 +4,19 @@ * ------------------------------------------------------------------------------------------------- */ +import du = require("du"); + import { Exercise } from "../api/types"; import { ExerciseStatus } from "../api/workspaceManager"; import * as UITypes from "../ui/types"; import { WebviewMessage } from "../ui/types"; -import { dateToString, Logger, parseDate, parseNextDeadlineAfter } from "../utils/"; +import { + dateToString, + formatSizeInBytes, + Logger, + parseDate, + parseNextDeadlineAfter, +} from "../utils/"; import { checkForExerciseUpdates } from "./checkForExerciseUpdates"; import { ActionContext } from "./types"; @@ -17,7 +25,7 @@ import { ActionContext } from "./types"; * Displays a summary page of user's courses. */ export async function displayUserCourses(actionContext: ActionContext): Promise { - const { userData, tmc, ui } = actionContext; + const { userData, tmc, ui, resources } = actionContext; Logger.log("Displaying My Courses view"); const courses = userData.getCourses(); @@ -35,6 +43,11 @@ export async function displayUserCourses(actionContext: ActionContext): Promise< ui.webview.setContentFromTemplate({ templateName: "my-courses", courses }, false, [ ...newExercisesCourses, ...disabledStatusCourses, + { + command: "setTmcDataFolder", + diskSize: formatSizeInBytes(await du(resources.projectsDirectory)), + path: resources.projectsDirectory, + }, ]); const now = new Date(); diff --git a/src/api/storage.ts b/src/api/storage.ts index bf3f637c..1ae3d653 100644 --- a/src/api/storage.ts +++ b/src/api/storage.ts @@ -64,6 +64,9 @@ export default class Storage { return this._context.globalState.get(Storage._userDataKey); } + /** + * @deprecated Extension Settings will be stored in VSCode, remove on major 3.0 release. + */ public getExtensionSettings(): ExtensionSettings | undefined { return this._context.globalState.get(Storage._extensionSettingsKey); } diff --git a/src/commands/changeTmcDataPath.ts b/src/commands/changeTmcDataPath.ts index 7b78166b..6d89fd5d 100644 --- a/src/commands/changeTmcDataPath.ts +++ b/src/commands/changeTmcDataPath.ts @@ -1,14 +1,15 @@ +import du = require("du"); import * as vscode from "vscode"; import { moveExtensionDataPath } from "../actions"; import { ActionContext } from "../actions/types"; -import { Logger } from "../utils"; +import { formatSizeInBytes, Logger } from "../utils"; /** * Removes language specific meta files from exercise directory. */ export async function changeTmcDataPath(actionContext: ActionContext): Promise { - const { dialog, resources } = actionContext; + const { dialog, resources, ui } = actionContext; const old = resources.projectsDirectory; const options: vscode.OpenDialogOptions = { @@ -36,5 +37,10 @@ export async function changeTmcDataPath(actionContext: ActionContext): Promise } const resources = resourcesResult.val; - Logger.configure( - vscode.workspace.getConfiguration("testMyCode").get("logLevel", LogLevel.Errors), - ); + + const settings = new Settings(storage); + context.subscriptions.push(settings); + + Logger.configure(settings.getLogLevel()); const ui = new UI(context, resources, vscode.window.createStatusBarItem()); const loggedIn = ui.treeDP.createVisibilityGroup(authenticated); @@ -145,9 +147,6 @@ export async function activate(context: vscode.ExtensionContext): Promise await workspaceManager.verifyWorkspaceSettingsIntegrity(); } - const settings = new Settings(storage); - context.subscriptions.push(settings); - const temporaryWebviewProvider = new TemporaryWebviewProvider(resources, ui); const exerciseDecorationProvider = new ExerciseDecorationProvider(userData, workspaceManager); const actionContext: ActionContext = { diff --git a/src/init/ui.ts b/src/init/ui.ts index a024c0d0..b62c4de8 100644 --- a/src/init/ui.ts +++ b/src/init/ui.ts @@ -97,6 +97,13 @@ export function registerUiActions(actionContext: ActionContext): void { displayUserCourses(actionContext); }); + ui.webview.registerHandler("changeTmcDataPath", async (msg: { type?: "changeTmcDataPath" }) => { + if (!msg.type) { + return; + } + await vscode.commands.executeCommand("tmc.changeTmcDataPath"); + }); + ui.webview.registerHandler( "clearNewExercises", (msg: { type?: "clearNewExercises"; courseId?: number }) => { diff --git a/src/ui/templates/MyCourses.jsx b/src/ui/templates/MyCourses.jsx index 33c8d819..1e751778 100644 --- a/src/ui/templates/MyCourses.jsx +++ b/src/ui/templates/MyCourses.jsx @@ -108,15 +108,31 @@ const component = (props) => { return (
-

My Courses

-
- +
+
+

My Courses

+
+ +
+
+
+
TMC Data
+
+ Currently your TMC data () is located at: +
+

+ +

+ +
{courses.length > 0 ? ( courses.map(mapCourse).join("") @@ -135,6 +151,10 @@ const script = () => { document.getElementById("add-new-course").addEventListener("click", () => { vscode.postMessage({ type: "addCourse" }); }); + const changeTMCDataPathButton = document.getElementById("change-tmc-datapath-btn"); + changeTMCDataPathButton.addEventListener("click", () => { + vscode.postMessage({ type: "changeTmcDataPath" }); + }); /** * @param {number} courseId @@ -218,6 +238,8 @@ const script = () => { }); } + const tmcDataPath = document.getElementById("tmc-data-path"); + const tmcDataSize = document.getElementById("tmc-data-size"); window.addEventListener("message", (event) => { for (let i = 0; i < event.data.length; i++) { /**@type {import("../types").WebviewMessage} */ @@ -240,6 +262,11 @@ const script = () => { setCourseDisabledStatus(message.courseId, message.disabled); break; } + case "setTmcDataFolder": { + tmcDataPath.innerText = message.path; + tmcDataSize.innerText = message.diskSize; + break; + } } } }); From 19bb118cbddc092a2d744cac4c5057d9547199d8 Mon Sep 17 00:00:00 2001 From: Sebastian Sergelius Date: Tue, 1 Jun 2021 08:39:45 +0300 Subject: [PATCH 62/79] Remove Settings.jsx webview page --- src/ui/templates/Settings.d.ts | 2 - src/ui/templates/Settings.jsx | 279 --------------------------------- 2 files changed, 281 deletions(-) delete mode 100644 src/ui/templates/Settings.d.ts delete mode 100644 src/ui/templates/Settings.jsx diff --git a/src/ui/templates/Settings.d.ts b/src/ui/templates/Settings.d.ts deleted file mode 100644 index 214b10f7..00000000 --- a/src/ui/templates/Settings.d.ts +++ /dev/null @@ -1,2 +0,0 @@ -export function component(): unknown; -export function script(): void; diff --git a/src/ui/templates/Settings.jsx b/src/ui/templates/Settings.jsx deleted file mode 100644 index 4d3f839b..00000000 --- a/src/ui/templates/Settings.jsx +++ /dev/null @@ -1,279 +0,0 @@ -// Required for compilation, even if not referenced -// eslint-disable-next-line @typescript-eslint/no-unused-vars -const createElement = require("./templateUtils").createElement; - -/*eslint-env browser*/ - -// Provided by VSCode vebview at runtime -/*global acquireVsCodeApi*/ - -/** - * Template for Settings page. - * @param {import("./Settings").SettingsProps} props - */ -const component = () => { - return ( -
-
-
-

TMC Settings

-
Here you can change TMC extension settings.
-

Settings are saved automatically.

-
-
-
-
-
-
-
TMC Data
-
- Currently your TMC data () is located at: -
-

- -

- -
-
-
-
-
Extension logging
- - -
- - -
-
-
-
-
-
Hide Exercise Meta Files
-

- Hides exercise meta files, i.e. .available_points.json, - .tmc_test_result.json, tmc, etc. -

-
- - -
-
-
-
-
-
Download old submission
-

- Downloads the latest submission of an exercise by default, when - available. -

-
- - -
-
-
-
-
-
Update exercises automatically
-

- Downloads any available updates to exercises automatically. If - turned off, shows a notification instead. -

-
- - -
-
-
-
-
-
Editor: Open Side By Side Direction
-

- Controls the default direction of editors that are opened side by - side (e.g. from the explorer). By default, editors will open on the - right hand side of the currently active one. If changed to down, the - editors will open below the currently active one. -

- -
-
-
-
-
Insider version
-

- Toggle this on if you wish to use and test TestMyCode extension - upcoming features and enhancements. New features might not be - visible by eye and might crash the extension. You can always opt-out - if something isn't working and use the stable version. -

-

- If you encounter any issues, please report them to our Github{" "} - - issues - - . -

-
- - -
-
-
-
-
-
- ); -}; - -const script = () => { - const vscode = acquireVsCodeApi(); - - const changeTMCDataPathButton = document.getElementById("change-tmc-datapath-btn"); - changeTMCDataPathButton.addEventListener("click", () => { - vscode.postMessage({ type: "changeTmcDataPath" }); - }); - - const logLevelSelect = document.getElementById("log-level"); - logLevelSelect.addEventListener("input", () => { - const level = logLevelSelect.options[logLevelSelect.selectedIndex].value; - vscode.postMessage({ type: "changeLogLevel", data: level }); - }); - - const showLogsButton = document.getElementById("show-logs-btn"); - showLogsButton.addEventListener("click", () => { - vscode.postMessage({ type: "showLogsToUser" }); - }); - - const openLogsFolderButton = document.getElementById("open-logs-btn"); - openLogsFolderButton.addEventListener("click", () => { - vscode.postMessage({ type: "openLogsFolder" }); - }); - - const hideMetaFilesToggle = document.getElementById("check-meta-files"); - hideMetaFilesToggle.addEventListener("click", (event) => { - hideMetaFilesToggle.disabled = true; - vscode.postMessage({ type: "hideMetaFiles", data: event.target.checked }); - }); - - const downloadOldSubmissionToggle = document.getElementById("download-old-submission"); - downloadOldSubmissionToggle.addEventListener("click", (event) => { - downloadOldSubmissionToggle.disabled = true; - vscode.postMessage({ type: "downloadOldSubmissionSetting", data: event.target.checked }); - }); - - const updateExercisesAutomaticallyToggle = document.getElementById( - "update-exercises-automatically", - ); - updateExercisesAutomaticallyToggle.addEventListener("click", (event) => { - updateExercisesAutomaticallyToggle.disabled = true; - vscode.postMessage({ - type: "updateExercisesAutomaticallySetting", - data: event.target.checked, - }); - }); - - const openDirectionButton = document.getElementById("open-direction-btn"); - openDirectionButton.addEventListener("click", () => { - updateExercisesAutomaticallyToggle.disabled = true; - vscode.postMessage({ type: "openEditorDirection" }); - }); - - const insiderToggle = document.getElementById("insider-version-toggle"); - insiderToggle.addEventListener("click", (event) => { - insiderToggle.disabled = true; - vscode.postMessage({ type: "insiderStatus", data: event.target.checked }); - }); - - const tmcDataPath = document.getElementById("tmc-data-path"); - const tmcDataSize = document.getElementById("tmc-data-size"); - window.addEventListener("message", (event) => { - for (let i = 0; i < event.data.length; i++) { - /**@type {import("../types").WebviewMessage} */ - const message = event.data[i]; - switch (message.command) { - case "setBooleanSetting": - switch (message.setting) { - case "downloadOldSubmission": - downloadOldSubmissionToggle.checked = message.enabled; - downloadOldSubmissionToggle.disabled = false; - break; - case "hideMetaFiles": - hideMetaFilesToggle.checked = message.enabled; - hideMetaFilesToggle.disabled = false; - break; - // No insider versions available - // case "insider": - // insiderToggle.checked = message.enabled; - // insiderToggle.disabled = false; - // break; - case "updateExercisesAutomatically": - updateExercisesAutomaticallyToggle.checked = message.enabled; - updateExercisesAutomaticallyToggle.disabled = false; - break; - } - break; - case "setLogLevel": { - console.log(message.level); - for (let i = 0; i < logLevelSelect.options.length; i++) { - if (logLevelSelect.options[i].value === message.level) { - logLevelSelect.selectedIndex = i; - break; - } - } - break; - } - case "setTmcDataFolder": - tmcDataPath.innerText = message.path; - tmcDataSize.innerText = message.diskSize; - break; - } - } - }); -}; - -export { component, script }; From 2dc5b7f87e98e98fe8c2f8307f5f2660baca9af5 Mon Sep 17 00:00:00 2001 From: Sebastian Sergelius Date: Tue, 1 Jun 2021 08:44:10 +0300 Subject: [PATCH 63/79] Add du dependency back --- package-lock.json | 13 +++++++++++++ package.json | 1 + 2 files changed, 14 insertions(+) diff --git a/package-lock.json b/package-lock.json index adefbbf9..f5e3737f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -3847,6 +3847,14 @@ "domhandler": "^4.2.0" } }, + "du": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/du/-/du-1.0.0.tgz", + "integrity": "sha512-w00+6XpIq924IvDLyOOx5HFO4KwH6YV6buqFx6og/ErTaJ34kVOyI+Q2f+X8pvZkDoEgT6xspA4iYSN99mqPDA==", + "requires": { + "map-async": "~0.1.1" + } + }, "duplexer2": { "version": "0.1.4", "resolved": "https://registry.npmjs.org/duplexer2/-/duplexer2-0.1.4.tgz", @@ -6005,6 +6013,11 @@ "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==", "dev": true }, + "map-async": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/map-async/-/map-async-0.1.1.tgz", + "integrity": "sha1-yJfARJ+Fhkx0taPxlu20IVZDF0U=" + }, "map-cache": { "version": "0.2.2", "resolved": "https://registry.npmjs.org/map-cache/-/map-cache-0.2.2.tgz", diff --git a/package.json b/package.json index 5f8932d4..15faaf6f 100644 --- a/package.json +++ b/package.json @@ -507,6 +507,7 @@ }, "dependencies": { "del": "^6.0.0", + "du": "^1.0.0", "fs-extra": "^10.0.0", "handlebars": "^4.7.7", "lodash": "^4.17.21", From c3ec668b05dde20fa7e35aa0454f1c8d30a424c1 Mon Sep 17 00:00:00 2001 From: Sebastian Sergelius Date: Tue, 1 Jun 2021 08:46:34 +0300 Subject: [PATCH 64/79] Eslint --- src/ui/templates/index.ts | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/ui/templates/index.ts b/src/ui/templates/index.ts index cd30adc6..32cc1089 100644 --- a/src/ui/templates/index.ts +++ b/src/ui/templates/index.ts @@ -1,8 +1,7 @@ import * as CourseDetails from "./CourseDetails.jsx"; import * as Login from "./Login.jsx"; import * as MyCourses from "./MyCourses.jsx"; -import * as Settings from "./Settings.jsx"; import * as Webview from "./Webview.jsx"; import * as Welcome from "./Welcome.jsx"; -export { CourseDetails, Login, MyCourses, Settings, Webview, Welcome }; +export { CourseDetails, Login, MyCourses, Webview, Welcome }; From 1bd6f4d007c418e8a6b741154f1558dcfb108cab Mon Sep 17 00:00:00 2001 From: Sebastian Sergelius Date: Tue, 1 Jun 2021 08:49:23 +0300 Subject: [PATCH 65/79] Seriously remove Settings.jsx webview.. --- src/ui/templateEngine.ts | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/src/ui/templateEngine.ts b/src/ui/templateEngine.ts index 7f519e3c..303d9227 100644 --- a/src/ui/templateEngine.ts +++ b/src/ui/templateEngine.ts @@ -12,7 +12,7 @@ import { TMC_BACKEND_URL } from "../config/constants"; import Resources from "../config/resources"; import { getProgressBar, parseTestResultsText } from "../utils/"; -import { CourseDetails, Login, MyCourses, Settings, Webview, Welcome } from "./templates"; +import { CourseDetails, Login, MyCourses, Webview, Welcome } from "./templates"; import { TemplateData } from "./types"; export default class TemplateEngine { @@ -283,13 +283,6 @@ export default class TemplateEngine { cspSource: webview.cspSource, script: MyCourses.script, }); - case "settings": - return Webview.render({ - children: Settings.component(), - cssBlob, - cspSource: webview.cspSource, - script: Settings.script, - }); case "welcome": return Webview.render({ children: Welcome.component({ From 876025153ef8cf9f8e4d0ee0aeae98cc9f3bc948 Mon Sep 17 00:00:00 2001 From: Sebastian Sergelius Date: Tue, 1 Jun 2021 09:59:52 +0300 Subject: [PATCH 66/79] Styling, remove tmc data path from vscode settings --- package.json | 12 ------------ src/actions/moveExtensionDataPath.ts | 3 +-- src/config/settings.ts | 19 ------------------- src/init/commands.ts | 3 +-- src/init/settings.ts | 3 +-- src/ui/templates/MyCourses.jsx | 12 ++++++------ 6 files changed, 9 insertions(+), 43 deletions(-) diff --git a/package.json b/package.json index 15faaf6f..83e45e8c 100644 --- a/package.json +++ b/package.json @@ -188,18 +188,6 @@ "configuration": { "title": "TestMyCode", "properties": { - "testMyCode.dataPath.changeTmcDataPath": { - "type": "boolean", - "scope": "application", - "default": false, - "description": "Toggle this checkmark to select a new location for your TMC exercises." - }, - "testMyCode.dataPath.currentLocation": { - "type": "string", - "scope": "application", - "default": "/", - "description": "Folder where your exercises are stored on your disk. \nPlaceholder for the value, change location by toggling checkbox above." - }, "testMyCode.downloadOldSubmission": { "type": "boolean", "default": true, diff --git a/src/actions/moveExtensionDataPath.ts b/src/actions/moveExtensionDataPath.ts index efe6a997..9bcc5674 100644 --- a/src/actions/moveExtensionDataPath.ts +++ b/src/actions/moveExtensionDataPath.ts @@ -17,7 +17,7 @@ export async function moveExtensionDataPath( newPath: vscode.Uri, onUpdate?: (value: { percent: number; message?: string }) => void, ): Promise> { - const { resources, tmc, settings } = actionContext; + const { resources, tmc } = actionContext; // This appears to be unnecessary with current VS Code version /* @@ -51,6 +51,5 @@ export async function moveExtensionDataPath( } resources.projectsDirectory = newFsPath; - await settings.setTmcDataPathPlaceholder(newFsPath); return refreshLocalExercises(actionContext); } diff --git a/src/config/settings.ts b/src/config/settings.ts index 381e6e5f..4d087185 100644 --- a/src/config/settings.ts +++ b/src/config/settings.ts @@ -76,19 +76,6 @@ export default class Settings implements vscode.Disposable { .get("insiderVersion", false); this._settings.insiderVersion = value; } - // Hacky work-around, because VSCode Settings UI - // doesn't support buttons to toggle an event - if (event.affectsConfiguration("testMyCode.dataPath.changeTmcDataPath")) { - const value = vscode.workspace - .getConfiguration("testMyCode") - .get("dataPath.changeTmcDataPath", false); - if (value) { - this._onChangeTmcDataPath?.(); - await vscode.workspace - .getConfiguration() - .update("testMyCode.dataPath.changeTmcDataPath", false, true); - } - } // Workspace settings if (event.affectsConfiguration("testMyCode.hideMetaFiles")) { @@ -131,12 +118,6 @@ export default class Settings implements vscode.Disposable { this._disposables.forEach((x) => x.dispose()); } - public async setTmcDataPathPlaceholder(path: string): Promise { - await vscode.workspace - .getConfiguration("testMyCode.dataPath") - .update("currentLocation", path, true); - } - /** * @deprecated Storage dependency should be removed when major 3.0 release. */ diff --git a/src/init/commands.ts b/src/init/commands.ts index 1b4b732d..102746fd 100644 --- a/src/init/commands.ts +++ b/src/init/commands.ts @@ -129,8 +129,7 @@ export function registerCommands( }), vscode.commands.registerCommand("tmc.openSettings", async () => { - // actions.openSettings(actionContext); - vscode.commands.executeCommand("workbench.action.openSettings", "Test My Code"); + vscode.commands.executeCommand("workbench.action.openSettings", "TestMyCode"); }), vscode.commands.registerCommand("tmc.openTMCExercisesFolder", async () => { diff --git a/src/init/settings.ts b/src/init/settings.ts index b021a8e3..8e80791f 100644 --- a/src/init/settings.ts +++ b/src/init/settings.ts @@ -2,7 +2,7 @@ import { ActionContext } from "../actions/types"; import * as commands from "../commands"; export async function registerSettingsCallbacks(actionContext: ActionContext): Promise { - const { settings, workspaceManager, resources } = actionContext; + const { settings, workspaceManager } = actionContext; settings.onChangeHideMetaFiles = async (value: boolean): Promise => { await workspaceManager.updateWorkspaceSetting("testMyCode.hideMetaFiles", value); await workspaceManager.excludeMetaFilesInWorkspace(value); @@ -16,7 +16,6 @@ export async function registerSettingsCallbacks(actionContext: ActionContext): P value, ); }; - await settings.setTmcDataPathPlaceholder(resources.projectsDirectory); settings.onChangeTmcDataPath = async (): Promise => { await commands.changeTmcDataPath(actionContext); }; diff --git a/src/ui/templates/MyCourses.jsx b/src/ui/templates/MyCourses.jsx index 1e751778..9a3c430a 100644 --- a/src/ui/templates/MyCourses.jsx +++ b/src/ui/templates/MyCourses.jsx @@ -108,8 +108,8 @@ const component = (props) => { return (
-
-
+
+

My Courses

{ />
-
-
TMC Data
+
+
TMC Exercises
- Currently your TMC data () is located at: + Currently your exercises () are located at:

- + 


                     

                     

                 

                 

-                    
TMC Exercises

+                    
TMC Exercises Location

                     

                         Currently your exercises () are located at:
                     


From b32d905578f3f2bf1574c498970dd1f26a0688b6 Mon Sep 17 00:00:00 2001
From: Jori Lampi 
Date: Wed, 2 Jun 2021 16:28:52 +0300
Subject: [PATCH 69/79] Preliminary langs 0.20 version bump

---
 config.js                                     |  2 +-
 src/api/langsSchema.ts                        |  2 +-
 src/api/tmc.ts                                | 22 ++++---------------
 src/test-integration/tmc_langs_cli.spec.ts    |  6 ++---
 .../actions/downloadOrUpdateExercises.test.ts |  8 +++----
 5 files changed, 13 insertions(+), 27 deletions(-)

diff --git a/config.js b/config.js
index 91bd97c1..d8c927e9 100644
--- a/config.js
+++ b/config.js
@@ -3,7 +3,7 @@
 
 const path = require("path");
 
-const TMC_LANGS_RUST_VERSION = "0.18.0";
+const TMC_LANGS_RUST_VERSION = "0.20.0";
 
 const localTMCServer = {
     __TMC_BACKEND__URL__: JSON.stringify("http://localhost:3000"),
diff --git a/src/api/langsSchema.ts b/src/api/langsSchema.ts
index 574ed282..7e422d47 100644
--- a/src/api/langsSchema.ts
+++ b/src/api/langsSchema.ts
@@ -80,7 +80,7 @@ export interface CombinedCourseData {
 export interface DownloadOrUpdateCourseExercisesResult {
     downloaded: ExerciseDownload[];
     skipped: ExerciseDownload[];
-    failed?: Array<[ExerciseDownload, string]>;
+    failed?: Array<[ExerciseDownload, string[]]>;
 }
 
 export interface ExerciseDownload {
diff --git a/src/api/tmc.ts b/src/api/tmc.ts
index 2d1453be..2376b4eb 100644
--- a/src/api/tmc.ts
+++ b/src/api/tmc.ts
@@ -486,12 +486,6 @@ export default class TMC {
             "--submission-id",
             submissionId.toString(),
         ];
-        if (saveOldState) {
-            args.push(
-                "--submission-url",
-                `${TMC_BACKEND_URL}/api/v8/core/exercises/${exerciseId}/submissions`,
-            );
-        }
         const res = await this._executeLangsCommand({ args }, createIs());
         return res.err ? res : Ok.EMPTY;
     }
@@ -717,12 +711,6 @@ export default class TMC {
             "--exercise-path",
             exercisePath,
         ];
-        if (saveOldState) {
-            args.push(
-                "--submission-url",
-                `${TMC_BACKEND_URL}/api/v8/core/exercises/${exerciseId}/submissions`,
-            );
-        }
         const res = await this._executeLangsCommand({ args }, createIs());
         return res.err ? res : Ok.EMPTY;
     }
@@ -750,7 +738,6 @@ export default class TMC {
             this._nextSubmissionAllowedTimestamp = now + MINIMUM_SUBMISSION_INTERVAL;
         }
 
-        const submitUrl = `${TMC_BACKEND_URL}/api/v8/core/exercises/${exerciseId}/submissions`;
         const onStdout = (res: StatusUpdateData): void => {
             progressCallback?.(100 * res["percent-done"], res.message ?? undefined);
             if (
@@ -766,10 +753,10 @@ export default class TMC {
                 args: [
                     "core",
                     "submit",
+                    "--exercise-id",
+                    exerciseId.toString(),
                     "--submission-path",
                     exercisePath,
-                    "--submission-url",
-                    submitUrl,
                 ],
                 onStdout,
             },
@@ -798,16 +785,15 @@ export default class TMC {
         } else {
             this._nextSubmissionAllowedTimestamp = now + MINIMUM_SUBMISSION_INTERVAL;
         }
-        const submitUrl = `${TMC_BACKEND_URL}/api/v8/core/exercises/${exerciseId}/submissions`;
         const res = await this._executeLangsCommand(
             {
                 args: [
                     "core",
                     "paste",
+                    "--exercise-id",
+                    exerciseId.toString(),
                     "--submission-path",
                     exercisePath,
-                    "--submission-url",
-                    submitUrl,
                 ],
             },
             createIs>(),
diff --git a/src/test-integration/tmc_langs_cli.spec.ts b/src/test-integration/tmc_langs_cli.spec.ts
index d945ea02..8ccd1b0e 100644
--- a/src/test-integration/tmc_langs_cli.spec.ts
+++ b/src/test-integration/tmc_langs_cli.spec.ts
@@ -179,7 +179,7 @@ suite("tmc langs cli spec", function () {
             expect(result.val).to.be.instanceOf(RuntimeError);
         });
 
-        test("should be able to give feedback", async function () {
+        test.skip("should be able to give feedback", async function () {
             const feedback: SubmissionFeedback = {
                 status: [{ question_id: 0, answer: "42" }],
             };
@@ -387,8 +387,8 @@ suite("tmc langs cli spec", function () {
         });
 
         test("should not be able to download an exercise", async function () {
-            const result = await tmc.downloadExercises([1], true, () => {});
-            expect(result.val).to.be.instanceOf(RuntimeError);
+            const result = (await tmc.downloadExercises([1], true, () => {})).unwrap();
+            expect(result.failed?.length).to.be.equal(1);
         });
 
         test("should not get existing api data in general", async function () {
diff --git a/src/test/actions/downloadOrUpdateExercises.test.ts b/src/test/actions/downloadOrUpdateExercises.test.ts
index 8f194a12..ae9aaac2 100644
--- a/src/test/actions/downloadOrUpdateExercises.test.ts
+++ b/src/test/actions/downloadOrUpdateExercises.test.ts
@@ -58,7 +58,7 @@ suite("downloadOrUpdateExercises action", function () {
     const createDownloadResult = (
         downloaded: ExerciseDownload[],
         skipped: ExerciseDownload[],
-        failed: Array<[ExerciseDownload, string]> | undefined,
+        failed: Array<[ExerciseDownload, string[]]> | undefined,
     ): Result => {
         return Ok({
             downloaded,
@@ -136,8 +136,8 @@ suite("downloadOrUpdateExercises action", function () {
             [],
             [],
             [
-                [helloWorld, ""],
-                [otherWorld, ""],
+                [helloWorld, [""]],
+                [otherWorld, [""]],
             ],
         );
         const result = (await downloadOrUpdateExercises(actionContext(), [1, 2])).unwrap();
@@ -214,7 +214,7 @@ suite("downloadOrUpdateExercises action", function () {
     });
 
     test("should post status updates for failing download", async function () {
-        tmcMockValues.downloadExercises = createDownloadResult([], [], [[helloWorld, ""]]);
+        tmcMockValues.downloadExercises = createDownloadResult([], [], [[helloWorld, [""]]]);
         await downloadOrUpdateExercises(actionContext(), [1]);
         expect(webviewMessages.length).to.be.greaterThanOrEqual(
             2,

From 7f11e4679ec9829479f73120e6fe0cd17109ec74 Mon Sep 17 00:00:00 2001
From: Jori Lampi 
Date: Thu, 3 Jun 2021 11:06:30 +0300
Subject: [PATCH 70/79] Fix double stringify when writing settings to langs

---
 src/actions/workspace.ts                     | 4 ++--
 src/api/tmc.ts                               | 2 +-
 src/migrate/migrateExerciseData.ts           | 2 +-
 src/test/migrate/migrateExerciseData.test.ts | 2 +-
 4 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/src/actions/workspace.ts b/src/actions/workspace.ts
index e3dd1d6a..4720c25b 100644
--- a/src/actions/workspace.ts
+++ b/src/actions/workspace.ts
@@ -38,7 +38,7 @@ export async function openExercises(
         .map((x) => x.exerciseSlug);
     const settingsResult = await tmc.setSetting(
         `closed-exercises-for:${courseName}`,
-        JSON.stringify(closedExerciseNames),
+        closedExerciseNames,
     );
     if (settingsResult.err) {
         return settingsResult;
@@ -81,7 +81,7 @@ export async function closeExercises(
         .map((x) => x.exerciseSlug);
     const settingsResult = await tmc.setSetting(
         `closed-exercises-for:${courseName}`,
-        JSON.stringify(closedExerciseNames),
+        closedExerciseNames,
     );
     if (settingsResult.err) {
         return settingsResult;
diff --git a/src/api/tmc.ts b/src/api/tmc.ts
index 2376b4eb..469960eb 100644
--- a/src/api/tmc.ts
+++ b/src/api/tmc.ts
@@ -361,7 +361,7 @@ export default class TMC {
      * Sets a value for given key in stored settings. Uses TMC-langs `settings set` command
      * internally.
      */
-    public async setSetting(key: string, value: string): Promise> {
+    public async setSetting(key: string, value: unknown): Promise> {
         const res = await this._executeLangsCommand(
             { args: ["settings", "set", key, JSON.stringify(value)] },
             createIs(),
diff --git a/src/migrate/migrateExerciseData.ts b/src/migrate/migrateExerciseData.ts
index 55385d6e..d99b4392 100644
--- a/src/migrate/migrateExerciseData.ts
+++ b/src/migrate/migrateExerciseData.ts
@@ -151,7 +151,7 @@ async function exerciseDataFromV0toV1(
     for (const key of Object.keys(closedExercises)) {
         const closeExercisesResult = await tmc.setSetting(
             `closed-exercises-for:${key}`,
-            JSON.stringify(closedExercises[key]),
+            closedExercises[key],
         );
         if (closeExercisesResult.err) {
             Logger.error("Failed to migrate status of closed exercises.", closeExercisesResult.val);
diff --git a/src/test/migrate/migrateExerciseData.test.ts b/src/test/migrate/migrateExerciseData.test.ts
index 2b8e42d2..86bb00e4 100644
--- a/src/test/migrate/migrateExerciseData.test.ts
+++ b/src/test/migrate/migrateExerciseData.test.ts
@@ -87,7 +87,7 @@ suite("Exercise data migration", function () {
             await memento.update(UNSTABLE_EXTENSION_SETTINGS_KEY, { dataPath: "/tmcdata" });
             await memento.update(EXERCISE_DATA_KEY_V0, exerciseData.v0_3_0);
             await migrateExerciseData(memento, dialogMock.object, tmcMock.object);
-            const testValue = JSON.stringify(["other_world"]);
+            const testValue = ["other_world"];
             tmcMock.verify(
                 (x) =>
                     x.setSetting(

From b97e86561bc4bbc6147588f49b3ef01796736974 Mon Sep 17 00:00:00 2001
From: Jori Lampi 
Date: Wed, 9 Jun 2021 15:57:06 +0300
Subject: [PATCH 71/79] Bump TMC-langs from version 0.20.0 to 0.21.0-beta-4

---
 config.js                                  | 2 +-
 src/test-integration/tmc_langs_cli.spec.ts | 8 ++++----
 2 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/config.js b/config.js
index d8c927e9..e9af239c 100644
--- a/config.js
+++ b/config.js
@@ -3,7 +3,7 @@
 
 const path = require("path");
 
-const TMC_LANGS_RUST_VERSION = "0.20.0";
+const TMC_LANGS_RUST_VERSION = "0.21.0-beta-4";
 
 const localTMCServer = {
     __TMC_BACKEND__URL__: JSON.stringify("http://localhost:3000"),
diff --git a/src/test-integration/tmc_langs_cli.spec.ts b/src/test-integration/tmc_langs_cli.spec.ts
index 8ccd1b0e..9eb1acea 100644
--- a/src/test-integration/tmc_langs_cli.spec.ts
+++ b/src/test-integration/tmc_langs_cli.spec.ts
@@ -179,7 +179,7 @@ suite("tmc langs cli spec", function () {
             expect(result.val).to.be.instanceOf(RuntimeError);
         });
 
-        test.skip("should be able to give feedback", async function () {
+        test("should be able to give feedback", async function () {
             const feedback: SubmissionFeedback = {
                 status: [{ question_id: 0, answer: "42" }],
             };
@@ -387,8 +387,8 @@ suite("tmc langs cli spec", function () {
         });
 
         test("should not be able to download an exercise", async function () {
-            const result = (await tmc.downloadExercises([1], true, () => {})).unwrap();
-            expect(result.failed?.length).to.be.equal(1);
+            const result = await tmc.downloadExercises([1], true, () => {});
+            expect(result.val).to.be.instanceOf(RuntimeError);
         });
 
         test("should not get existing api data in general", async function () {
@@ -429,7 +429,7 @@ suite("tmc langs cli spec", function () {
         });
 
         // This seems to ok?
-        test.skip("should not be able to give feedback", async function () {
+        test("should not be able to give feedback", async function () {
             const feedback: SubmissionFeedback = {
                 status: [{ question_id: 0, answer: "42" }],
             };

From af4c5e17ae7e8a4bb064d6a472fa64a3dd2d9c18 Mon Sep 17 00:00:00 2001
From: Sebastian Sergelius 
Date: Mon, 28 Jun 2021 16:56:14 +0300
Subject: [PATCH 72/79] Update changelog and readme

---
 CHANGELOG.md | 17 ++++++++++++++++-
 README.md    |  2 +-
 2 files changed, 17 insertions(+), 2 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 5a006ae4..f1b67ec9 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,7 +1,22 @@
 # Changelog
 
-## [2.1.0] - Unreleased
+## [2.1.0] - 2021-07-05
 
+#### Added
+
+- Exercise decorations: Show completed, expired, partially completed and missing in course workspace file tree.
+- Automatically download old submission (disabled since version 2.0.0).
+
+#### Changed
+- Bumped TMC-langs to version 0.21.0-beta-4.
+- Moved Extension Settings behind VSCode Settings API. [Read more...](https://code.visualstudio.com/docs/getstarted/settings)
+- Moved TMC folder selection to My Courses page.
+
+#### Removed
+- Custom Settings webview.
+
+#### Security
+- Updated dependencies.
 
 ## [2.0.2] - 2021-04-13
 
diff --git a/README.md b/README.md
index c2e298d1..96aa2076 100644
--- a/README.md
+++ b/README.md
@@ -12,7 +12,7 @@ Students of its various organizations can download, complete and return course e
 
 ## Prerequisites
 
-* Visual Studio Code version 1.40.xx or above
+* Visual Studio Code version 1.52.xx or above
 * [TestMyCode](https://tmc.mooc.fi/) account
 * Course-specific system environment   
 

From f3fc053a8c47d7a5292bc62f0e977e1f10cdeecc Mon Sep 17 00:00:00 2001
From: Sebastian Sergelius 
Date: Tue, 29 Jun 2021 11:39:06 +0300
Subject: [PATCH 73/79] Initial welcome page

---
 media/welcome_exercise_decorations.png | Bin 0 -> 31418 bytes
 src/commands/showWelcome.ts            |   7 +---
 src/ui/templateEngine.ts               |   3 +-
 src/ui/templates/Welcome.d.ts          |   3 +-
 src/ui/templates/Welcome.jsx           |  56 +++++++++++++------------
 5 files changed, 33 insertions(+), 36 deletions(-)
 create mode 100644 media/welcome_exercise_decorations.png

diff --git a/media/welcome_exercise_decorations.png b/media/welcome_exercise_decorations.png
new file mode 100644
index 0000000000000000000000000000000000000000..6d3cda10b50c70fbbaaac00d1264ee63db4b7341
GIT binary patch
literal 31418
zcmagGWmKHY(l#6%g1ft0a1HKGaQEQu?(R--cXtTxBoN%)g1gHg?S?y9c3>goyqA}0?25$EHF4Yrbb59yg$z(Ob|Nm)^-T}XT=W_&s|CtY9>zPYlxld!F|
zwXuy8@Z*OM!Vbm;PR3t}T+N-#h{PpjzkK~<4E5my(FaKpL1j1HlTHwA<%P7jm*bE~
z`!AtGX|i}PUu&`J{TC$I~_y~Jo7rtc?G^8*Hb^B>VwMYuOgdSTjRU(HT28)!9>}DGUa$(m0YfY
z-etouf>88;|6es_=;yW4*}mj=Wx(p5pmcb{-k1(x|J3sP(}a;5T%9up!L&N~T?aea
z0>4^qK{$Xl{F#I{2`|>HMO&pYSMeWz86fbe9yzYg#oq44C
zGeJKXk>C%o!=?IPNrCSLriDsgKD2kW;EV5mAehdg^4cP3m0u513I4vQ(S}LM8~9ta
zxhdVhxv6C@&+gRmAsMYtci14wrn2v+fUgi*@b&U_(fQi*m_@Pn@1Pq`E^H9R>4vCi+zp}g{KUD!`jk-^qnl=EExT%kg=NW
zv>T2&BqCwYWLMUkN+;3soYM02{FO>IuUU_{KV-R+tL_)}v9b`7z0t$I?i3SY5hkc3`LylyP&KINh=G9a80lV1;7IKXu|
zz9rpyU5y*ak$;UfGS5!zy^phsEbW6Cw;?q^2J^U^5m)4z?=!Pg+8FMQgT>+)mtifI
zki86c)w>>H)TB~c=iz;N*^ps{?tv}gNZ3CfZ60P>CgLM090wJQv6SIT!cey`X!8w>
z{n+QEvN87?=;g0hrjb&8x;FcA3*HEbug0*oQ@Ww~w{x{Kx-%pDUmR)(tUY1t>h9p4
z98SbsOK=giSdQ-Ja(m|i&@&YDLhBK9WEpT_v8N#wYcVMyILdQPLcOF#hHIaCqkLTF
z4Q7@tsKN@#(2!c9+@5r5bzWfAUl0vugsB*Q2IwZ?)^c4w6&pJJzTM45JFcq{Rg~kq
zV%{Sm&W3hs+jQZ!tF)lC_?>KE#UEplA+lr7b(K;~vQ#RLcbhY69_s8%PD5{6nt$;U
zSr}T^zzKE<64jI@pJ%ATJgM#9F)jAvmHCxDqVC8{RL2s&
z=pAg+ZzRN=gv6k^U=#5hf=l=7d65Tlm71QICK4>UDk6m~rN1u)+HTtyJ1)rXl2o?c
zHiJ1P)1L?qRaYA(qj@&~YIx@xRQ43%i%k>sLsblKOb_ttNYE{nFX$exi7S}VbEn1pG-|?w5f&LbX%KnJFr+PEF*E7mfomYQZ^2KEiC+MprXi(
zG8&;^A3%^TiD;mtfMGJ!W_P5HAJf_>Atx=Yxekd1uce^9w5;}gq!e#m-HV_YmOfj=
z2s?#kvm9(E6LR5}ztWa9E_2zN#O9#0QhTMdS)PAYj^rr^E>XN4D_pT}U{lRo
z*Eq)PLSkldU3#*NQG-60W>BtL`==jb=XOqcyI~O4+lHtB>+ww^$&3heY)Gd>JM^~e
z5$kUky#!LUH6)kn2V&+wGmsp-I5YOh*V7sHS&+$XO
z7NYn}M@-lApvjgzbK{;Tg4!d_LUk(h?M2DSS;@6
ziHLHGl3-0e{a70Njci3^;pYmRd%whoigdz+b0dm6(%93bk))bGs?)9*bOg=@T|>L5
zWc6@Oz$nw6Pi6TRk+Gxh7%v`ID4Ze&D+E!VP>l6o6$v$dx2t@{J|XfaZ{}|208MS?
z!3EH>@tU-?w4v4E)veSb_;ND(*YEOd#s`pm#={ub2&&)!oYQo0WkPLI=+KN~(^7A<{%deX$
zWSvjS$%ht?Jw=MfC0CWqn5V>R-{KT{F**dy&SQ%t#kDmRApp$aZjuKLtd!oWev(f~
z5W1(+a^yGG-CIc}5Q#5#gNd|FT<7v@yUZ@k_Q-*_D=jIK9o$YPCe$9!)kNxQ$*JF~
z0!TImEx))NO*6-%Ekw^7&HKm*<)Ge@q8Vu2_WA0o#BOQXCyMmhGxkMVRr(zA*K$vC
zP2^k-jf;PI?k)2FL|e8W40c~}l4d{A!qmNEjMh!E)BX}vaNj76#zj9&%V9Ira?TaC
z9cZdjdCUJ>RvuH)W0?WVw&?DLIi8wVXXxValo~OphcSlvG9t?EzUGXVRd!dB0d`mO8a}6F>$(cFT-q
zpo-Rl>Jm}?#DOY`Wg3CzY(#(Oj2oAo8uhteru1%a%6pIp?Pn9o;N_J}kWi9{!=oS-s3xQ=E9Q
z!@HEuLNCc61f&>{rt&wO$fPDu0T$wLBAUw9mVy~bipYAH-or+t
z)hbkn3MabkLJyS1SchQnqK^Py=4(vs!yFQbXQCoMPi+#x`_)bGEQj)E0vEn|BfGMd
zUTCFNzmO=j#Qgq%bVy&3k74Zv
zAB5#y6j4gWh3*UMWK6QXVQ#DDlVTCGrWsQUy$?VXXRYyIdaKA6OLY?{II6IBXCU6
zKjRf;Kx`u;)gLWJOv
zf4}P^{PLw)4pGoo2?dP75lAh>G4l?|1%E_7f>e#e^W^8tVa|efbdKrJUO`b=0Pc2o
z+8^h9C(6$?reHtzL3Zg=`U)x)!At%nSo)7wZa#!N85|KKPo*3XN=Y0uDr>8aZ}AJA~aLzX{mEiNfWj(B|js)@B#+tfEDPT#ua
z6oH=v>dYNVL?&Wk=X$=KiiQ&Nnv55N!O7jg#4--nf+j
zanb~^rz=1z)6m@L5K&-M2R!%1*H6}*3shy~2ak?P{L&1s6w}lfHuywMj!G>B%>Xhg
zHBu+@Ow+8+Qm-fxr1kQ7V1mVLbwyy8YCG*H%NfV5@%%ige7w*lA`4*(@-vw@2fYpP
zmKD38#jPlQw4oqU@?o(k^9y*?iH%5>GuK#PRA@sTf~u4b;CF&za>(ApnkPdr$>6+f
z{OAitglW0;y0Wuzw{laeJTX_gnI`BvwUb1#8ilmlJ?7*)tmaiUWL>;*L6+0`du=U4f3D10-j?0j~
zwxE^kK|O0b_?ZtCGn`wMpT#UH(>YAFLr^P;N@AJ6~goUo2W|
z|^l+V`6mLn%7r3P9*_v(%T1W3e*~l*f#)?$T<#o*uE*`!=nl(?n
zIq)sdk$RwPq&ts+`B(dc6&3kR84e#&_6
z_?(yD@{x$Ds#2UgPamB=saoXeS$iHkFYrcd=iPv^&j@@2y&LF@t3#oc?Go=`kXlM>
zL)fKdHM6eETO*$VEki3R9!JRF=&LeOy4hIAD4g6*O?swZ%rq==nTi9B5}xIm9A-@R
zQc;+;LT${Sh|!M57er>t0}QKaM7!xh%DlIvOA-|i;Y%%vNeqL1#RyUsY(<(Vr;h{n
zV)m+o#%sh+(Y$R>)Sw0#S42zWpBM#O^R(4aejV%Pa@C`((*p>aIVOtGFM?aaRFkTf
zWA>7q7gfwcPBK7|oQZccJl&q-eQHh>j&pkPaLc_P;l`Z~>_(%RI6V}3kEqt1P)(dN
zdviiT#UJibI`2y4GY(XQW9Xi@PXx@Yqt@I%x#W5i!(3_%5Sci2t-{BDa+V%Ke5r
zJE_uY_f|+Q6dmd=a^VtOtq=c}&FmLO%`JA+4C}ewn@>lE;M7vm?vKt>oPkL4?X^aS
z)O=^&$jS_I%_tJZw?jtDr;p-!M09NM>ghs`n1O{WoiDqd`104t9{BRk6UT19=hvvH
zo!#_?g|Asr51o0k#+5k5U^B}t09B=T9FZjcO|MOY#A-ca;{x)uo#(go9Vj)o$O)N5|St()pqcM=0$Y;7Sc$eG+ju>Myw_PzMkEtB!1R8J4
zUmCoj46nZ_{nmImFlx{WQ
zsrdUy!w=Nz-x_$lXM$7PkCWNT856wl*XQ5S&vuI9Cv4%qF8Pj^
zykWtNJd#nWQNx;aoZCO^U6DkUBI!V~uX(
zsO%#k;z||9cS(#wa2Iwg*zv{i6ZCGU<}KbYkWX>UTIoh(i;pV!TqF_^a#GMnLM(hL
zbl(W{#+T>p?!!l%7Sz$nfm#}E{|ls$is#x6*#AB<7zKh2+DxD>CpDEJNrE*3DDkI)
z^e+SfGbAL-{E8Gogx<8HryxpL9=f8WGdvbjT2S7|&D|bP6yFf!;}$L_zqgBw;Py9e
zC`}L^?yh&|-LqmCvUEyrCkKXJt`D0^3dr?Gx2(nl-_s2Vtqm)iV4d5+4T+a^PdvvE
z`|T_JGZ}e5(iqZ-R7-tO)F6S{^F)FNHvjdSJFPG#j$x+SZ-s}gx7C1y6&;&iS(X9X
zL*v#7uPDTrF8{#L(5K|U8v^mCz09UaVehfc&5fNO$ipxW=JqUUJy;|?$iqyt*e4%R
zu{OY|G+SQv>P)>j`i?uj5C}UIB;WFvur9AIN-lqlPBs2){yUcf>CJPo7VhfkchHiI
zeh12?@~zt`*Ifn>nSqh_Q<_8dfoA+b!FUADxy^a>p2FV
z+M^<)e|NHk+;sN)XEsA{Y$*?>;UCBe?%M}(yin=53DZBH{=vL@z=?bM>;s%wITGKE
z-cJrJYz2SxdN+g&5)c-nln{4h`Fo82(*vV6u<-xeC8O6?sjPT!n{7`aHeX%g^M0-6
z8qe#{{8qtN*#8Xu0X2-&|Dt&*PPl1g-qpZ&-GVRQeWZeq|PhZ#m>sVO!+
z%Sk3l-?~0#@I1_$&n)DzZbZ2`_3aXaIlz{G^aW9Sg{7LEHR#TaC^7+KC4iz+`CPkT
zF6JZ1u4rPh$u$=?QomN)=6!3C5SNt`c!EaSNM^!ogBx?Q8j(Iv%*p;xe1ZLEX8s1q
zoA;auu!K3kfP#cZX*GGeIefdnIDJFke>3YXd%&yIVL~sVBiwq{gEDOzwdtjtnK5ut
z*{&;b$!k8t&!oWhxHeq1&W2GtZFo40d4nI_Z`skiYGCr+bI0>?!PQ;d2(rX@h3!h#
zAI6=Rzf}7ra92!d;C=!`44?5B<~kz!$M!ED2U!j-;KnIG0hbeKK2gBCo_864>VUiSGpiWsO}?BFFvgUdRqcvUZ3$x>x!{z`O+K$tI6-C~{EzTuL_ihLVsyRg
zWejB#^4oeuU7Qo1uWi>3Qg|;~J?_J3hzF^ir8M!2+COjF$qk(SW@mYatNw--QQ(wf
zG_e&hD98V7o?YPm+e@{H4p=t;0kX=1iSK_`Sprl6CB{F$4yOuvoSe0=TExdiQQm2K
zZ3#xwwx^ag=LH()#N%ttD`djJ2-Y%d2wAFAAX)$5yM5RL{)7}3V277(R#?akx99Y=
z2*-RV-_>!p`y*_3o%f5z1GOj-Hw{s4l-sQO!2#<{{Qrakqt
z{QW!EHTcVi!kn}wXHw6A6m2quEp5L4g5{~H;3021b4JN4vs$%u=X`WB9Rvwp1ils?
z@N8_pJtcg;H90wvnKc=V$4|$(y-hBJDfJoS+
zTDOMGQ+a}I8rE`lrkAcc0fL{$bKbU(Y(BTd09UIby+;Md{+apAgA)>;_{s|=sg=Pl=9*I)GqvdiT!V?-n4D{{P5)u>^PS5R?#N&+8Fd|n3D
z1cn3w>z?&B@rx3PXfbuy*~l#Z@B(rE5WQ=$H9p+0pr}a#zkY#})wIHgw;VC5;6|oe
zz9KLsvZZo+VxW8*7rx4x@i-GkMMLKJWBKi6^ns^K>dz$A&KoWvs6#_WcV_hOXl>xt
z8G*asrS;`H5EAWS_T@TJk$T%P!bh*-8i+tSXCVYlqR(v%{C`zT}DVed5a6>Dlr=*Y6!-rAu8313PW3ctLbidM*svK+T)u8?sVS4Y}4=80+iRjflIchMb;fcQQ)mT<00hSXCXVHIz(LCzu;;Br*`;)U|!LMH?%C(|g-?!I6BZIa*6;ztOs9fv5ynArdW
z`zw;X)oOGB69{rgT4Y><9rOCDC{woEcIZRzkZIk0Rrieu6ho#(&sk1{5r1DwIs2*r
ziK9lo8r1Nw^zcK6&#%8Hq!SS_R79t&|7`sg3Ypy*-RKgokIwK)>*RC?hT
z6^B-KgB>L?dahSJ-1IaoJ`9NQte^$fB$Udb6tBc?9UP{qU(9u%Qxhg;h9v!D$Fsfy
zkdAjl_%63Y$X9Lz;LvoR)KS(N-i0o9K8C7y@3LifKW3;SI}sSep{RwK9YNqNUXdEM
zL9}aC_jktb8TcF^DDMx7r}YGpBEi1!uuUC6UAaz@O@#Q21c42}n}Et}(hxC=3^;fEJapmpDegqUApD8z#_8e=045<`ulVxQYQva*N
z;17m5uMqp@>zk~X)>?_~$P1B8H>hh?^DRHF>8er;P{uD3uf0CoC#G
zsFSUuWERGcpr62@bu`TEsnx$J>B$tAf$oD%Pk%Ef;s2h6^9oE_m^P
zf#QJd^Jkehxg>()#5__PB+ReClxqMIbTJ8utw*j~)FZs^Fp89`q6KS|85+8FmmM;u
zK%ab=$XiF}p>OQ5L}8}t&5W_v^36vd$u}exbQry{!G2o8o)SXd*y7(%wGO?;C!Q{m
zwp|8rd;CvIba(DPY17mDg<4D*`OcJHheu^eUD;xe#PWb+Ma$hsNGtcoJiTz2h*jCa
z+Xe{<1?4YG#T!Amh1X_WRrzsqN7%pWq#IL<9+?T+j#Ym>qmIoz-(XoRLmCNG(cKOf
z{Y>@Aa>I|4=NZxt#Vxh{lxZ|oDi#yVDCL>xhV`;k$HO
z&WsHWGV{{qonAC5d%;I>X0cz0_-xl1SCa^T1ISACc|vs43hO-H*Y`;PQA#c)7X3(_
zzV~KDP>=@q(~+QL!d+DE*Dtt;0f-<_No9OqUU*p5LIVopc%y27cxCHwnB%-ru9fu!
zhOmO9Bo}?i^cWD!5%Z1O==LUPIRB1#U0o2+nEI9Y(evfd$W4nb?9#fg_@Ts#Y2og5
zUF&ODx6V*m%X(laMmLX$BmUdX{Ab=844nMl^_fpA7cSSLWb4Nv^FzIl8?-6;zg&P7uq5!i>T;jULC6}S{IGA2e44-PJ5#kJV6tFcSXH{CTBtv`
zJf5oA#p%{utJ}wuQ1Lc`KHlVfBK}_T`qpbu&l|nI^DvMCIN*)hX5;caocny2J$p7A
z9GlO&FzYC`-s~$*uv}Xcrur!qy1t3f4S6o{kT(X`HzK+5O1%=)_i}JZ7sU0&(28!n
z58kID);doO^ru;#^8NLe9tw7LwmR9hIV4lv)@`;Z)0RA}UVzA97iJyDJxFD4GjCyK
zdGl7Z-Yev=a4ocLqBJn@65C9G9dGa*Y)nJ;B6!;d%{)b}_yq%*01T8FzCld#Igw9!f|lNeI*-AS)n40Gu$oK!W^m@gJ4
ziVEZ&`}uN=zt@?1z-ySHZPTL!g0L)X2>CWP`mg^TB1yzuc4WY9f15)PSeSYHLmK94
znZRS?H}1r1{r%v&pn%F_FXLrdWcNOJtV~7d#C9z0A)&BDPSilB4>RAoJVn!jZM$~(-qSifs
zc=yVf%VTH}<*y3?hs^1GR1ntjeJ|aTgl0GxC>4Fse&UNkOud^-zN@||Yr#%yuz3uS
zU2-ylg3^0F?$;YT&WrEwgrpBj18$T3w!_%{yxHliBGM?x%?omO%mgJiQXl#_8!6JB5l411oIxS(
zvwlOC!4_5uF6Lj-%0IzH&krQ5qA;VH>v}ryJaB4l&l5mhr;w1G3y74tee{XdVBHIl
zpHb@u7a9}$UgTuZQHBEw0Zg7?AC*oQCCe;47w3Q2sh8JvKG;`k-g1uM_%#N26LTqfGSfbxf1#qS^;5k$POqiv}9Ta)h1Af?+UXJ5VEnbw&BmMR*Z^U|H2qie#K
zLi3(d?qlivr#f6hu1>I)=3_H&E1Ieb7OKtGp~NLQAtQz?8pWYH`M&g>l91t(i
zt~nwSY20|C4N^_&zNX6)smH70-&n&J$hCy-w(V*!$_OB0+RBLa7tnDVD!y
zpZKl%%^Xe#SCDFqP`L+mz5=VrG$}m?qB~?&!hFgayE+Zc)Il-77}3#z*E!j;t)5>Y
zu|U)vwb4&Z-xW}AZmd&Cs5%Y|Y;b$Wp6aPR)*g`cUhrxn|M+$rhJwp|wujw8h*B?a
z5R+_o+}O(MUiqk4gKM61BRZE5n0x-V5BG$tq1Fc2A}hL!AH{Qf&{kb0GLdUnHh!}`
z92MWXZJp_UXEdLtk_hFqiBi=9v}C;@i0S|K)XRt{qGp$pUl74CzwtEZ51Ni9*8RRy
z+~KU;GI2Q`-yorp;3sKt;?mR^yFK<6`~*z*%-9Odmji0u!^b_dcgUKptA@|l9k+x|
znjWNvNIJgoKs8)&;pCKLEM=5j{`@|g%1R3IU4A|EwoEBt7UN*l)NHj2k)PKMqonM2
zV;RS0`vgx|XtL*^vG&6S6@mK^70$$mhSKVNj>try|IB64g$G_lfL?52tlmsp4j%lB~0&J_Ab9kIM3mQ
zK~n37-_QGD=-wMF?44^HfH(aeCRiQfnr|0({kI038&GU9VCgfhTv(%2caL#HHSQuneIknYHYW=>CiQwBeBpKS&OQ?l*VL}w^WmgBUevu_;3Wf8zrlBZ
z2Bq_f;aiRL{4oom?s%`j<6aB@#y(NF>T5f~xI^*eo;i}I^-xeRx}uv?E~NL_VqtqL
ze>AWoHiC7ZwudElYr{shog&b&^@oUH+yiUbac_e`Hyqt
zqx(G&Uevy~dnj+)JoX^Z6!=n}D|}K0ytU{>1)T4~YK33baMyX*U|lx|AjKEVtvt7p
zmb)ME@z!}^k@`+A^>!#>ZpvKcpqgJU&{@~JK)YYkB#|Qt6I*XSGN5>en^=wg6hv9;
z;P*L2uOx|2xmrPQU12DEhDW>!KH-09M&S3^6)aTx{s{_3qPzaoAurqT7lSg!7DU_Q
z8(B9bzxPbg2>Cj$pM|&1{sl&O-Nvg2@*{O~gWKh$H)nQwAdqpTUI=?cDSsk76*YX(
z$Ln+n^^lYuAGmsdU~$F0xPPGG;V0s;
zJ@LLE>+Y&wb+PcnI4W6R*Wr2QmV+YK22w|jEe*oZ%DH@x{8WiGtiAp{%F)b(-31i7
zo6`b(1ZS%Ay|skLq4z9mKfoLAo*-Os-mxLh$B_}x^$N$@Cuj`GoUW5AET!
zsfKuZ#KI2c#;?!g6LUXTjmZZ1onb*3a_h~w(`qX{9eAhG_~aF4qjP!}mki*N2YI&Yrn1aNQViT-i$CP{oAC>!~RD;mkL
z7eDtryc}E+d_IX3961If+!MNPWy8KM3-e+2M@{gpBkp+M%r=ZKj3eFebqT0E6P|RE
z7YM)ban@2oHJK*uaUzVAl%k(m6hLnxx)>mj{q)>~LVL7upmsED8=#CnJ*QRRF$PSA
zm`FLUF6j;2-UspJ&AF}xuyHk@336JG3q8$xV&B%p7a>-0x}9NE`X<>J3a!evVQ@@E
zkI~}Q6eac1li>_P;00!+(22~?&bU!7e#{flGyM5W6qD~Uj3l+Ma0_zvcO(upK%>G7
zxuXoGmEY(i-{a)&HK&Ys;&xoJqt^LY%Cd@ZSB*xp0HTLNtXToV@P^g(IB`T!>;>fn
zCOl)@kAj2VLU&kuU(hD^1OyFi?yHHGA0o*r-LFJ?XB-LYJXhbRo2&0j5e?0A+=xQ9
z3rzHy5I2UkbR0`hIjE4M%&)sbLNUQtokB+?PoKY7U*4KM5YCp|0{~7RF_doZ`{M7X
zXyh_Kxn&LYl9C0OAA3whv=mSCMJNWX&JKOU5jL<(NEuqdGo}OK{*{AC$jBZzyXeb9
zvihJ>C*Ku(+#k14yA2>3vX3iF>fSU7
z8(Q^8_c?5bNicB|b^(Oat$?vDRi
zFb@CL5o}|gsv2iX;2CMMrz2rbA5SO%2v>L>rXG2JSx1qqdfiMQWxSka0_`LhQNY_U4K2I{Vs5>sI|UZ_idW
zg7r+)myV*f&Ef-;lQ~$^PE3VPV@!2_Ia|*z(9JZ}g77GFO#1=jzHNOpR1(0Xxzo+gj(R$WTeeB2^{)W^4
ziM&SMd1h>_dvN;G+alaiJJrU%uon0ZN09d*M-!j&_mIvmalRM^xC5y8r_*-Pii!3R
z&f@k1Zn*B-9YRC8b@nho&=D4lf$ytRvQLf>B3B!wPKQL*Wppwu*{i^PXKu@?Pc#AJ
z89UrWHuucrLQJb|g+@32epZUZKsccY84d$0*m_nhWI+_p6`-DtS&6pF(#+Df2
zn^7_yWSL^=SDbd&ZnE;QM}F9B!_xzRCO~fkeL5Ok>Y0nF@xA#FY$?{
z)JqRG5`CFCzIR=GdU64fUFq?ABlx_Ipscd@+-RJ@3{kG)<%76*xXLIRiCR6~hw=p~
zR!z)MmNr{XNgQ6-p55^03SVfTv@s|HzTBL<+rD}5D{E5-$|9B=cXT0sOMH6t<1^C(
zJkj{IyuLzRPQCd1tt82llpG2p5AcvK56JEY9H{BlnGaly=MWC|##Rr0PH|g(gAO0-
zu||3+8?x&GE4QVGKJxUnM|F9=W5Ky7+0M`;EZ6Se@;cW$?rF}v!+_DpuHsW`H<<+p
zd!-g4T7eKMGB^SF^`Eq6-hQh6n7W8g1)zY
z!mpFHKy*$oTcUCvD3z6jO;^=Ho_}28i&}G}eA^SNQAi4?fpl!#;-p8Cl)orI&ha?D
zq>bdLT7bf$PkA^hM63(!yCFew-6|+pyrc*pZbdKsRH7olFcZ$HxJ}VnN=l4{aaM-BnfY2FXbga-J3d%v-t7cEd
zXK|+jutVsINL;kMY#O^H?zHQw;6P{Bmb2IowU8d@Xup`xe(M8}kT_nl`rM+3nqbCl
z-rY};8KxffWtY6d4%-&jEwkj9L;qRkQX`U!j^3D!9>@KlW8q{=x5X|f1K_d(O+OH>
zY{C9~G4I(0NDG`cz|dSRZVvu)4jlTfl}E>axtn{^iQ0hM+>}=JlHnMrj$JSIWH7d-
zN>~@ah^!1DSp`Jwf{aBscY>goox+~lWugcE13z-Oy~)A
z+9UhC!qGRkzp!SnKj(2!<+JMs%$2bZfsKaZ@CTO3S5=obz&YC9waCuB39f7PtwD)q
z?aLLs@~?Q5oIo5WA_0WFf}jSwgr28TyC{*<@=Hi7q%0h
z@>S-#hjiLS(t}i0_|t?dp1_B2YhO+8^DK{v=|)KE#EJEdRhm-wB^-%;8*?E=-?Z}z
zZA-9CiOKa7S_qFn=e^CJp9~3V}jF%
zbANN#bYK5UPe1&}m5W#GbfNfo(HXqwc#SDPtccbPA^G)td)%dC*%i1veidwllT*QS
z?3)MpQUk?QK0Jkuz`7{aoX{?l;<9FHg73#&Aua4P+UM!isZtBK&s>^b`Sa8k3o3>8
zFl;#oV9t|(Wv8qW?}Q-+9l*xMGmfeWeqS&(tL>A*Tj#<`>ioX1zp=``7d^n&?pUx5
z;q}n~PZ!e-{{a_x2gE`EKnUwhf5*TP);;Hj*e7$5Zy2+qx+--K$fjpPb?z=c)DhS1
zpE)1vi>>H%Ouq$&qLt6yZcowRn(AfDcY&&f%)s4%Xy8?hSSnvsZPoziX?yp%WXLk^
zJ|&}n6-qRDfBB2jjDK3}_@Q?(!X}#6@HZ4x+gGg%;rP=mj&m1QwoXiqEvl3@FO4Db
z;T(eE!HLWEVOl$$eI_f}&S@MEy2tHd?q$Ac7w>*NKHd^N^X@@fLIi{5iH`@#STxoS
z9nny#&0D={4jr_!DiK%26i8hDw7jpR_fEf(ep}lAavJ=>jk4A0{xu7$+4=J7o}ud@
ze|UT@s~jQn*zrKI;X=Q4;UcIBH5&8}n&2t6QZiM|fb&9O6$RDJu=9dLyL_nQs=uA^57-WM``x8xm#GU;|EO_3nouz3(A*F1$HezquqMhXe-kf$bm{ZfV)!M(@dcKv
zwcGU7E-vCx6Am=kHJSqyl}Ckly)E+PJ$8413h{v#;ahep$f=u-cs1o+zlZ+K
zp#QlZCIS=HVK-Y`pufhUKMmK6&l1em
zK31Qs1ww~{PM(v06mytal4IMnqXTGM3Z{tB${;1VEaP$v0(40QQ+Vw(X%!T=hOX#w
z4{*h|iQ2W}4*5;jT+kLE0Z%DYAQMf0A4Ui{mDkgyRM`72hi3^#f$P)2-&{Y2e|#(_
zP4-CboQ)_~_LUd`DN^iwgyIuU0lh?}UTgwnY)vQkR}7mTMR)#@k2xV@Rie`)@Kkh~
zFs55JjW{W!{L+C#3F2QYDT%2M^_dg=2C$XC%@P@yQlv}!1Zj#lUew|L2g&t=k--Bc
z1KjmqJTO&h@7>yQ5cDyPk%9+FC-cxd&MwhLJ%u}
z;bvk}Jo6iK5j)xaUpc0Ni&1Yc9v9KU+EWVR1neZJhCZm1)<@J1&0Zo3;Z0f!u5Smcw!uAO2VRmO
z-{!P)1fq{wuY%KkNh*GQ0bZP%r5y|>KP(%en0I*pg-C(>DJ-ams;C@H)QC;D$0T_T4TV{G#LFUWWzt2Fw_
zY25g)
zX#P~5+*JAMu{6gp5zI&NDH)+WfvU(E^(&ClqU1Qq2ftxvr)iFwAQa+f38<5
z+1Ay(lR|3%u(___gEreANd5mH?IBbUjF_FWmPNI9&9w!A&1;Cfs(}f)|2)}FIFPk+
zIjeO-`>uI45wN)$5}(>%4%I*1`d^9wa{+Eg^mobcnybYDo6|z)RQ#31Ki&4YkuYBM
zDP+V1IB)n#vZ&Mj|JaEC;jwKZW4>ee0Hu=%ZYZ`+i`~3jMKuhG5-Z?-2s9&GmTZ`4
z#I(d1if8OVJo(4n%c8c0@O(2N>69kC>6Jqv4qIFnWv#C`gr*E)o_;VkWHcNl{zg{;
zGJ+mk0u%nDyR-rOA(3FnijAPkp^ZB4*2^Z!zry=#1$99Si10*3eJ&rA2ezj)6(T%#
zFv#X>#3cjuwy=My(#e=pbE-BIpd-L5!m{V(nz2}o0qP1aFztp+^X+D&eivyeEKBU0
zE7cX7k>3o{d{JHwLeKycMp+6M=(r;KpGQ0(XS^yq%5Hm?O2BepaOzjk3x@n0F7zF2
zo|OK=Oq)~H*kAa>fpz-_bx+(um0(6QG<7{h@|+NBgcPq`V{>0`pZyQs9?JhFi%=7L
zs6L7_=xb06Qb;B-6FlwN-|nRb^J=*C;uC>)s<>HB9&dw`;E(624V(VA8Bh*L{y+*F
zO4JhWmsE>kx%7QALh|Qv1k79x0e-1ld$xCy0y3PU671m6qUX$_%@iV_FV?mpu;&JJB$OXZ!
zVAof}s0wbL%PlQbDWWDum^${Okz)NZIw5}esmfNxnbaluif0&Uz>VYGh7CY@P&C{g
z^M&;w>&pUWz+#Gv?}feCSpU`7Kc+IQr#86YsKSlJ!5{YTwSa%m<0vT5exN?*#h;MA
zd+5}j3!ss};}dTFH#zu+I|m~ORMVgX6C1L3RYU%ePej2KtXRk>sF6@9@*H
z+!Oq`SHq5)arcZS?c9rS#rLkJNNCSRcZDWUp}pvjXmx|fQ1MIh4Mjg=a#dW%C4coJ
z`)trKn_E8(8amNR{9^Fil(OG!k`zHTsb(1=60h0>U-23?F2f=~H(_dh*{?i{jdKfQ
zUy{*;FKD&$YbshsmfdnC=a(j2_`BMWewAOtKzU--fLEslwWf|9oIC|+<_@aayg^Bv
z%0BFrY}@{GQ++40=YllG2KLCBT3zb~J~beuzZx6~zaDmh2<(cMXBdCKBBf9jRtC)}naO{}u1m;84noc85adDO1#F_Co_P
zP-0@qeyN~>Jd@R1OyznO)G1-uub#0qz1@GY_zo*
zi8y0!n<^1WQC6h;#ecZ~sL8A(j$^_<bpYALcp&vY9bE%zG_ujl#edefsNP5C!AY>B>>3gq@r9OdKhK$eC$>j_JPl1
z(cVR$CnuNgOTXq)*(o60oU7(mK7s!(w9O@A$atRoa?=FXObV!L7z&7Cd?B0O3BJUb
zb;*dc2ov|pg!9xPAF16|5CYp0p~vVf|Z&&Q6nCq
z@^K%|QZ!GfP=>og^Rw8oB);xZxC?tGOhI?9LT2zY$P%=jy0o%ElEFC>{A%-9aOxsN^&hWnsaRqqSicC~Mj1iBRyIQ?jSi%x~|^0qdtV3Qoz#7QDmU>I?@0-?}!F_%~%B~gMz}6mc}1~NJX1*()C?or^pI+MBtA!
znVR@FOBizB=(|C_|+Mlff%<3-zFX;>i78jx)~~
z&)Z}Hz>Aa?8!whsM;51k*go=6h*baB$QLqZx!GW7~gb5`u03Ghx-GY&SM!O^0XG>4xqj%B|aS89j~^FVq#xmfz|UW~u<~lUmx0PT8|r%-PrBJQ_I<)EN65>
z&X|zH5D(ttZ~V6F%YT?DIpFzJc;+hhcaUhs%XNu+T;+0yq^k8R@R)-gH$wlft+Nb@
zqg$hOaCdi`;LhOgE`w+A;1JwBxVr{-*Wm6Jf?KfQ4haq+0q!K?C3u)cRFg1@~HPr&uGf^0AJlxt|MGZyiR!>^06w$2>4RDM3-c_mHs$%FDr|;f+
zU(Hh>;iH5A6AV<661L+MGqQT&6?bhx>aJrXZfOUF`M#6y-K#qK5kB-~ymmyh@PG1O
z_ZqacT5TjiitjiVK
zXs>AGXXjUYDh{~-k^?F~)=1&kj55?iiz_%QNjp}FvSpB#W&22FPS(QZZ?NU8vclca
zve7YJN)gqSQqk;JX&<(PmS$*jQ?8}VG(na-WiKAXW(hTTZn6T#;1=u(0fEQ^VhiNW
z^V|Gp%1@<=eyFeEBBQLT^UL#=EdqWJ3;~B>R6$udlk&I~I9d1yB^IAiag#nh+k>+u
zT?p>S$5_3Q`Q@L~_f$|A72NX|b>Hu}9RmjBlY7??^?U`K)93W1AN82CFF)o#MNJmi
zHxV9gG}xwfCe#xSW$(N@CIrHF2eD5v-&)&u3hxy;vlDJlNXl
zzB#!0*_B@c#Lw%YwW@}r-_g4QcbSRnqQ33RKqhhpN@T22stB3T7BX&gLCV?6lgUnU
z>Xj`6Edv=4*K0ZYj~AQLj;BJ!Odiq08cVI5g`vz5C4nilPC_3y@bF-D`q`-KIY2}_eP@)wN_5s4PI#yCj~X4MyC@kN
z%6j2p=DLBt;I2X|XRC{3p5v?j^kDW|+4Xr+Iil6JAE5Yhgh($mT29B6C(@}_`cub_
z!T+b_DeSkD`6hElPo|WrpY~hNLL!c+%0LxZ&UG2cdyKF_T98IB*X}?!`pmE^L5m0e
zF4&<6AIX}tS_@g{+<>4Pu%rv8;&oCmvrK_QU&X3iv=8-%YGUc|FS!3|Q}$9MR8cMA
z(yY;`KazKZ0+Nx7?-enP|IjBzg;}DthyzE^`geyFPCCSLMy}njJO3q7QKKLS#kY3`
z{;RGb(mCUIR8D2R=P>Q>D3u!IAUZMu!QX~;=y%iB&Yf^;_Fu9+m>P0Wt*wpy-*fGQ
zrDcT}W1QCS?fZXy4k0e&VDJF9dT8v}${o`?1&pgnPRZ)Ilo!&wYDKiG8g@w_-_U##
zvSD8>_qD_$)dz~f+8hiT28o}hB?ed>B&l!xh$j2ySb*A`&7g)!ng7auRLCvpbyoXV
zciS=hN#?k-I%^+NF^#{HcOS5*5H~M@L#H5kB`RtcNUmnE&HH)nSiRFN3R^A_bFLG=6a(1=YIb!msNyY6ZA7lQQA!t62cz6_0!AY25-Xo|q$
z64|9y2!(SsF}6u`MoIx>s{T)b*R3J`lKcF(BBk39yLI*B?lQGYUjhnR?lPH~yr2!nJ
z(3g(}RlphHZRcD|&YuE#eOTJUK3F
zFN2L*xS7L4T2X;W-n?k>R>O;yl)HxAtZYzfMX$96N^s&7tM@IMbXY84bHi$*7sedO
zlTv!3p4jWn|5=9E1^f0xBc5y}quMS8NfozNn$KD>2h9X?LGvfUr4
zWgZjJT%zjPqzp@H%67qX1(Oea^A$Dj{@735lFPAF6b_rf$J>m?8Hfa$F>}erGLkA-;p|!Q2dzOtn?>A4zj+bFB
zDL2mSTqVH^k;hUL#uD0f#uoTb)>QcFch>as=-U3bJt-G}5)>A6bJ3ae0^qJ5^)D-M
zj$4Ho+6PbOrI%`~y9=%p<6ygrof=DJQ-q|!=7+&9SG<>PZww7trUoP!VTwd4w<1EC
zDF)>#0jxauwP}nA7LmU5QdW+)GmB;^*M|>?w|A}i$cf~s;JD;!W!DkYFuXCv=
z=ow#6UjaUeX+lkR7Ao@5M#DrTjkiv=x$Z=4euVV#Rnmc&*72?tpj5!5&X{a{I0YU3
zXgb&BEsn8DL%#1k4M0eFY*Xqm9k9I+xItg(n!xTy_}W&R`gEfVRCeP-w|c@_q+Ywku(Mg|LEd^(%06SfAMnH$sK!{K@3!9_MMeWgN
zA-IbZhr4KFMLkQOJHRQRvXEb!D)lOou0ftUMQXM{rS}uApzsavq{RYyMp0=twtvw~
zOhS#{J9RQM{3P7^@{%GbbLmr1lM|CWIbYa;g>X7?#0jx+QG|IBCw#n5o1&YHoY1LeMX&!o)vbjRT&S
z!uLC>ncB^ga!VG?kzRXyqQz_}<;IyUm-NtlEILqKQ(Fpka-}Jvq8(WaK-~Q#nRxF_
zmo)de=Najn^n*)50`@nJUb@tQDu~kBxc#@cg
z#MFKD-_Pzq4k=0ntkJLd#
z!FzSEFO7!6<(Fs11>F$Oh5qd1@Dkt;{qHzINwjHmafVKmK8vI~LwU~#oe{5+TwSBB
z6x)>V(cY~<3}A`=Uk32v7-Ju^dAs%+{LgY8!s4oFNKjj%p{`HHGNpYZ#rB%y%)Qjrx=o&m9QPD})X0yDtg(XD-y{izU
z-&D*byE@2c=w4YD7#*{^LKTlS;pN;*q!*oi9te^9g|o
z>78M+REv+3O%kj`GDVfinpAi5b%=>hN9Ge
z9IFbj>Jzy*y~F!JM?t{nNu%JB%Vv58fxTE)MHi4-5A7L3j^PBggj}MS56ek#$&_T9
zaaC(yGe4O%fDg^XYPMr~C#&};EP3^;;ak3@zatf~)Z3pnNCCAG154U7*)jr>h5W-_
zz!FopS~6Rv;F_X1_&m&4v_s!|(Q8w?+PodR+JKP9lWEXDj&+vFbD(8PUpxN~wA36^&vmdjE3!tn7m&v;veVJA+)ozp^5
zf338PA?+kLF2-lgJr*37PsAzw=FiI5iJ<)oX8*?k4EmYFW$gvBHN3RO`-P31H{N#v9>p=xAcVyC3)z7>4*MgW7SLO54FdX_iW`Np$m}G>0
zMIB|po^ZmQEwrl2(QKq1rLSyao|ogI@zZPDr8>=r!;@8c#lZg(;A4rqw&Zs3BOqDd
zO|pb)jj9ueM`QI3BbO%6TaQ84ba(|}H56S9DKEA9eDWdaQVU5q8oUHlT~=zm=9pB}
z3}^{FykK1!Wzh@_e0PcOwZFtnsLpHK=4V#aHlnPhfju>YW(q0_9azD$%A7xQ6xB=3
z)QexQrk#C%73ccB{eIoW|8RZ%2I6LY6T)zf!t_2)NjlA!B=A
z1x(euVLC49|6(CaQlo4qWmD>}J;&gUgjtd}e{vKOOFG(-ycCDd1ULMdZ4ohQMZ2&|
zZZ|WiLx}YYa6!eH5=CD8tamgYlehJ}qEJ!M7E9RR8d3A~Vlp(F_N~;p>z^)2-=03f4>sCr{9J}1f@4nw84?(zf$)5BotUwV
zGDK9HKtNQbh}$N?U)sr(N;yL>P@X7^q-X9~_BH9I!
z;;8tsbI5~th(bMnIdJ%#lnJ`5zUxQt9lJ)H%9`bUhR+7tWlxtiWTrHLz{@&J0pW$$
zv#)#wqAJOSqEV=k!BScX)5a}?gpGq0cpt55%p<68uF1PNf58jw)QC&XPdJ4flVtm-
z0-7YKzQ7Az_f351-dc4>kY|YWK9{u@U2kfkN
zEcbQvcRa!hHLzPSuKl%=Do-h=zCsb=kqMxTM=vweUb6v>EqqBb^A;DgDav(l!e0z!
zfiwsttH^tTwiqDBakge*F51`Gl;3pzGXTlY1@7?jdOG2aKLL|q#E9P-PwgLk_8#%f
zfRA%T05Kvz80jWmWK`WhjGD&xMCpV$WB1lw6wu6v&Ce|CbOCd9IQ(mC8IZ-2
z5XJ6|UguLnM=Q(d7Da<84f(*rrwv5%%1&C}Ep*tPhXUT_~3k{LO%)LP8zN1k}OQ`#9Z@IV^)fKA*&?w6=6a`$)w
zVRtUnq#z6&6vU~J`lK~OQ>25hNHNdNSQU!Fd_+_4M2)|%eIh=PbQ!a_H`MfdEd;kb
z1Pi9FGx050m`%NdI^O4pEonA*W*B(18I=9sWxUVr`${&dkDFMG7fi#}-{rteD=ZL>
zFcXJJ`!nFZ$fI8Wo6{=76K;nNV-hc-h98u^1$;awd-l$;eYTUkS6^%$@AF2WNeRhC
zqRvb6%-s7;4Z^c)TK5E))ciB9uogu-dWXCl{M(1H@wLAN>3)Tyg+yo8b)c11w*)us
zq`%+4uz0@&6Wx_%T^#wf~lO7*`_i=i8E7w*1yQ
z1X*Tps|49h*ijY)RhVeoSGn%a_dsmi&@0nMLJa*P8f8axQc26IhJe^(PajGaGT;{UXGk^N<%jy3Yj3ax+vPzG!`(R~=t6q!ULGSi4Oa+|^ZxtQyO}
zVD0Cag$h4rlyGh!97jzbMdrsH>hM9VaZ9xiIz3aJ!S0N3wdFmdMN7FsJ}8CJ<)#R}
z$0La$4qXkv(wJ9-Th>(4nszlg-*XBXlWF!02s1Ij-A41~BXXPJW=c4;+{U2Oqy-~_+B9+C#eM4ZCPH>YaC%T4
z3F^f;ZU?yT?VV(~S%KqslfElU*;=WNi-foclOVG24z8F`5%6K~bD|jOiXY}9kXgVK
zuQMK4mSQU4>Z>bfp#%%NXT)j}R2m2nNn0HVy&bka&o(+LTN)yrqZL#VAmjfeI<%09
zmg{em7dgVwEwn$6#0(FE2w7j*fe7t!DzEQQ33C%Ow)AbGe@2Ft*PR2yw
zHE={4N^m_GI3?IUI%CdVX{UWfRBf0!w16GBu;wvbRI9iDitNVCg-L%&_VU!0VyoA1
zLeknFd%AZf?8WQ}=6P*#bKAp+G=IcV>kkK(hDO7TD=bd(^nF4fDnc^YLna?L0O&Xd
zl4svg5|dLSutg^W9@I6o;HDmRkOF0d``@r#euzA}k1y|!IXoS8i`LS9LWf-S4^`StU@
z-OpDBUS429cp2{kz3h>TJ!EG9Ux$>a&m3VcJ{wd@CVIi5D_ogME*+?fN?Z`iA&=~G
z+=?oo?2)LtUU426Hbv>+Y+|+$eYpgn?&r9f*JZ!Y9f&9+ncXGOa-wBmU`80-E)!2!
zo@CMO$W?;)lQe`&_O(|W4Q9T{>Y5M#3s-Ui?n1?%=kVHLMn
zEkpJsAbR}0M}SijvL=0i;|!GfH{j!8#cgSkYd}jfI~y9JaP}bGOv&ed-e0Bw7tQ;x
zIE1Co3K)5^1G-P-3m!LfkE^gF2m!@C+48Od8JUW)8)Wg7=R)s^;)##ouG+Iae}1>8
z)WVM7ZH#!1C-nC^@^Yp?YxCreRmCt~Yx@LwUI?wj-ic^+kE=$E&R>k$-8gpmJ>Kzr
z-jm>u*;~z_f$$36AH^qIC5ulxR#f;|CY*^VC0JQ|r2tVzWZ6s$!#0^hPy{#Jhg8f1
zoST^f!k`-sB~WjMgkuYR
z#J3|x5;^H0T}<}!nucL5Y@RpR{7tMHX9_GPPO&llY3De*t*jr#ZCMYaP?S?OQLC(l
zBUdFhzLhhg3F+Fp3{)m0lR~JBRcfFE!$5W!@T5ZUU2Jt2fmOiIvynN|ysh-9>Ov>w64ht*Wls_@`aT11noIeDTupHCodwG6ZIbpF{7resw%!>^=47KF8%0D87IuM>euGN$AH}6=CDTmMw=Tc|6RMGbu4A>axM^@n2
z+@1_%IY&2d4*7mwWaSr@X*jGX$@OjzmUJFt&O%L^PFd_BS)h5
zQ@WtJz%7RAcHNhJMV&$e14+0smo=JjRhJDlaHknaOSf)Mr+gko0F?-w;eL&hakLKp
zaq_xxt*`)y@0wV3ObId~q*xI7Xke-bpYPpZ#}KazKyM8nYEBVb-w9Dp7ITbd-0+{O
zvCGM2O;WLg_l?Z{6%JH6-Vw0LroQ6RyPmJmdk3h=UA31u{6ca>-x<^9qa(fH(T3on
z2&F`#f8-oLV4h(0NmK^XoPInkE4I!Oe_|)B%TJuq^GF8}tP3-&YLM05+~$Dk1|z67F4f$Em3z)(No;R1sT+W9@7R+7pLaSQ^|ceC<}yVd
zWv`9dJv=$iZYi6+i9uBeU)|yQFL#G;!>~zd90Jq6R>&7vA2*r7usBIp^Fhk&$F?jr
zpd~08T
zuM5aOm`J8qj%1^ZqvCt#E$7aJnfKNAvV76<&07@bl~4qO?BlQzv7n5RcFcJj|0?|b
z)(jPoi9l^ZE8mZ{p4YsUfE)J9|3|$bv
zd>gp(9N?ekPq3D%4t*U>lwtHO)IgO^UbUa$MCEigEkt2Te|WEtvIavi668-Qc+6-#nuZrMJo;b7#?xWSUy|MT*#?o`2e6&ZXF{2ijeLm3i5x<3%q^FtR)n?zp
zPS3jP!$=%;wx}Cq%n1mX&@|T776UNfObxE?OY2lQQsQLMdew+bbV=F*+|X}a@pKiM
zMjF_stVIpscT{M}CX5hKTH}fXCfpJhi9vxpj^t3tM=MIrkIap)dQ~N{P9-yrX`R~qvZH-_
zv4R)MEb&fUuzrvlF`drGABph8wE4__cd1~rrWO!rCN4O>!c$LN{4O5+4bJtJY*1`_
zGA?L(2N8Y<1$%?QXAeZs)+~r13(VCuniiC(eQC#ozhuR*y12VU+X~_^~f7GvO2Eyy+Qi*gKK&_V%Mjh
zY$he^c8FZxn0e@GZTwLBBNtYJ_)YbRte@Z};G&sXOW#vfl0j!00bZ2j;gyAPCQ?P=I(cql^H
za7Sfwv^d*kwwe!|yw14WeyW;6p`&6@NVhw+UTzD?Y>2+^y!lQZAp?5Se~W~|^b4Wx
z^z2jkR=rR+vw^fy?GK(C%=)%;Wnb8^fG3@Y6NeY_UfjY&)~AeT_FSK-7>B6k8#YnN
zlWxM=fOCG`o`(CEr>_%fm(733Q4oZQ$X?kcZF61h!bZyWiONrzc26@tp&Xr`_G3kp
z6YnL`Ub;;5&-d*Rzc0&K7mkIMF8K9@c?4$pNDe0(W^`u7hIwyaBO-j-)Llg0Dv=i(oehq@%bRT$$!a0bRUp)RaRQop9U!mnrKsE?2=iGa2+lje?H7@4I7B(pk
znPWyRHDHrb29zS`(dcdlVqUWfwrnDCZ-i2}$4lG-vW_6Tmt|CvFNV$V;%U{fd?3AO
z>onoA9e0|f!NW-21@AS~3@7;^9(wa&g6+c^2PN!n$eqpbd+LLx#4!Y-mb3CcNYGQQ
zvi7fY!>S_OqA3r`E1)~SLl0beUF?41vkQvxT%D5{vg{0!#(55qTRmJBjMfAI1
ztn@r4JlTNB-GHbho|ZNi=`+I)J^{SX89NEeXjw8S#A1p@dtp1XCFlB-R4k#~@GBMp
z>UY?!&Nk@be*ppezkmRhoBOJ{(9jQ9YRw}+H+per^CK%OqcZnB_myM}+YI6C+V(Ml
z(ve}&;MFlKelS#sg1c9D?AES3?TpzFmuhLE=l7-4qr<#s82^`kg0^;RHvce^-e*~%
z>vS2RyL;X*ZtEZD4d@|~2PL`k5w*^R+&Aj>AQZsh=RIun#NhN{
zd2C+>4PGQ1w6qZ;N!>Qu-&i04Dl|n8%~YTb`i&6In)h)R)Q!Gq+)9W<;W%utGuilD
z7ceI&*?bRZL0Wig5xGI=0>+6U#+I`k_Ob@W-Y_DS6!A&jN{p{?@Ue65Qua%{wPOkU
zp@uk1wg`#3z@s#e|Aqrp2NaT`3@*v1urk7|L%R-d%{z7HS2@_{P&RgeVRSkP$)ATZ
zzj*()_5+;~oVq6Ir4?*{8Td$z4ss6e`&{bT<=CUk=mnjWIS&2IY#E6NtD+p(*($=L
zG^daH;tst^Cyca~dW#h{0V|r#cj(Jtn|Gt^J3PPP#4eMU)$m;(lIO=!EM2IxZ-z~!
z(1hfjVWhVqOIBg_1~GvQ4|>QNi^1j^i{RIx`&)d!fb3Vq-V8)Sfr0)+gS#k|38^-F
z4h|M2c4(3FiQC*`bG=WuRxAB7puex2)!jjeGG|@2!v5K9N4DF?!9b
izB48
z&mZNLk#mrh_|%appPDoIUYcv*^Z8G~{vGyK@GJN>DumFR}x4Yn!Fw+%$J$wb~*IMk#c_GG2E<sL$FnbH60+kZXcJw=9DNp>dFZN<
z+gquyV}qa?(2SzQ8(NB*SDk}y`379O96PVZ5eqrVGEix<>Gj$EvFLB?P;T8^p_l-~
zi{x_BP7Kt8Uu^m}FotLPR>kejnTtEj2i7KsSl_a$u)c0DDU8SE^Z|z9H{n7!F=IiG
zv8LkN%mDca8K+k)Cc15;(o^rG6%(~;e%b8f-|;3wJ-704e}VUMM@^Ohs)s#GBYghx
zS|7p{YO9LVG)LDRL+&8cPRaFe3m^Z-!Y`&9m}%Ez;uV4x7{iD337v*fZK;wh4rv|j
zH(<#V$%oU878;#F1wG!d%4okt9XC?PdKOB?P$ass>HiTina*l8!L%Y$J;&Y;z=R={wUP=r`J|Y^
z^wOC!3BIGWm~iCep(53&VCQ
zi$mK7qfP1%Di-G>z`_?TOo(w5Y_+^8TZCRHb+{-xR$u{^6*0wYOr|JS7G)z_YnHuR
z@6rk`9mkJ{pITHB6F=FS00>a_9xKLYkc(2pyTGrYBhee?Dk?H{nHF1VqwTaR8a_;!
zH6+FjcnE2>Q!rLc5}VtPFHwXp+e+JblZt>5%LS}*L<6Ut=t9>8w7YC07Bt;E0I)C6-jtHOuf}}cmc{(XPwYA(!25AFd4<%9d8jWD&ob^+b_nFhp&O~
z*tI~J(D!vry;@ZQT_sdC^IE66NOrkUuEzs}6zyQghY}voCm3#{3r3zu4{f@Hl60fV
zMs}VO$K55)(X}`SP7yTagC`b^)mE}0!9N=2XM$KTt->ei-QmiqskFNZMZk&Dk*lDb
zF9=<^GinpfIc12_j>PDFQS4Ce$zy`<7(N->Y6@hX17l&d5Bju;0PyCb2}3ej1tPu~
z%j&o^=WL^9Vc)C!35()%0v?LF6R!axE$N(xH;)D^A0-rw{W)N+C%WrTj{(OFe9{}%
z-W^+!VE+gS0yVp?L>?Z^2h=?5(VYVTA1;GauHlj^D;34H@{#)fe$PbD9)#+
z2}f}IODO{FW0T0vd+r3KPR;d+$&WRY+nP)Piu;TX2@x1E^WJL71g4Vc-u%=J_fyzO
z0tnt6$bQt&mdK_lkV(wJYIMSGn0&FRplVlbQN*hBvIa3+quYFp!`*d2CXS{|24`$8
zDUC5=!N2NwLi88%#LKD9SjzhFXm4zQi(J2hzeW%C$JyJht3Nl*1MzL;il%rANpsy6BJ)iWe{<8NsWU^Rr->yNFstvd~
zD@X)z7KE;oR;yz>kS@Od@o1YI4;60RGvBN8_M6D!-)7zDw^^rNk~VWfw#5Q_c>SF9
z=#kBpb^IFBbIH5)ISKRgKgoh=@Ae@f=@<0D^A~=hg+tIL21C9%dSfEhO?=c{Dbk3T6Cr9-LikE*UaK
zD5#fJ2O#_D`samFZyt9-a=Fhf@v}-~Km2LnH*ol>FuAbDsxGcBeA%6OY9~swBp)5U
zkYeo#=HXng4^@R&U!Y!IVbE3>uzquz}h8iG2{*r4N&
zb4MDd2`^*mfSyX9&wX=8mBHzmN?+-J0#)|~C`5eQoJU%^zxNth|ByB)yZTee4m7~}
z(z%bFw;q|Jbp%^vuyu(=O13sKGK_Z1cwOwD}V{l4G>RMU(=NB%?Z=93C89~b8m+@n0j%hu
zax3lWRaha+BM=_jN=?%Z#&$^he {
         {
             templateName: "welcome",
             version: resources.extensionVersion,
-            newTreeView: vscode.Uri.file(
-                path.join(resources.mediaFolder, "welcome_new_treeview.png"),
-            ),
-            actionsExplorer: vscode.Uri.file(
-                path.join(resources.mediaFolder, "welcome_actions_jupyter.png"),
+            exerciseDecorations: vscode.Uri.file(
+                path.join(resources.mediaFolder, "welcome_exercise_decorations.png"),
             ),
             tmcLogoFile: vscode.Uri.file(path.join(resources.mediaFolder, "TMC.png")),
         },
diff --git a/src/ui/templateEngine.ts b/src/ui/templateEngine.ts
index 303d9227..5319ae61 100644
--- a/src/ui/templateEngine.ts
+++ b/src/ui/templateEngine.ts
@@ -287,8 +287,7 @@ export default class TemplateEngine {
                 return Webview.render({
                     children: Welcome.component({
                         ...templateData,
-                        newTreeView: webview.asWebviewUri(templateData.newTreeView),
-                        actionsExplorer: webview.asWebviewUri(templateData.actionsExplorer),
+                        exerciseDecorations: webview.asWebviewUri(templateData.exerciseDecorations),
                         tmcLogoFile: webview.asWebviewUri(templateData.tmcLogoFile),
                     }),
                     cspSource: webview.cspSource,
diff --git a/src/ui/templates/Welcome.d.ts b/src/ui/templates/Welcome.d.ts
index e1cbb31a..ad860700 100644
--- a/src/ui/templates/Welcome.d.ts
+++ b/src/ui/templates/Welcome.d.ts
@@ -3,8 +3,7 @@ import { Uri } from "vscode";
 interface WelcomeProps {
     /** Version if the plugin to show to the user. */
     version: string;
-    newTreeView: Uri;
-    actionsExplorer: Uri;
+    exerciseDecorations: Uri;
     tmcLogoFile: Uri;
 }
 
diff --git a/src/ui/templates/Welcome.jsx b/src/ui/templates/Welcome.jsx
index f2686b8f..aab886f7 100644
--- a/src/ui/templates/Welcome.jsx
+++ b/src/ui/templates/Welcome.jsx
@@ -11,7 +11,7 @@ const createElement = require("./templateUtils").createElement;
 /**
  * @param {import("./Welcome").WelcomeProps} props
  */
-function component({ version }) {
+function component({ version, exerciseDecorations }) {
     return (
         

             

@@ -47,10 +47,10 @@ function component({ version }) {
             

 
             

-                
What's new in 2.0?

+                
What's new in 2.1?

                 

                     

-                        Here is a little overview of latest features. To see all the changes for
+                        Here is a short overview of latest features. To see all the changes for
                         version {version}, please refer to the{" "}
                         
                             CHANGELOG
@@ -59,39 +59,41 @@ function component({ version }) {
                     

                 

                 

-                    

-                        Caution! It is not recommended to downgrade the extension version to below
-                        2.0!
-                    

-                

-                

-                    
Exercise management

-                    

-                        The main focus of this release is to introduce a new management system for
-                        exercises on disk. These features have been moved to TMC-langs that is the
-                        centralized utility for main TestMyCode related functions. This new
-                        architecture reduces previously existing major overheads and allows for some
-                        performance optimizations.
-                    

+                    
Exercise Decorations

                     

-                        Unfortunately this change required for all exercises to be migrated to a new
-                        default location. If you would like to, you may now move them back again
-                        from the settings view.
+                        You can now see completed and partially completed (i.e. received some
+                        points) exercises with an icon on the course workspace.
+                        

+                        We also implemented showing if the deadline has exceeded and if the exercise
+                        has been removed or renamed in the course. By hovering on an exercise with
+                        an icon, you should see an information message explaining the status.
                     

+                    
                 

                 

-                    
Improved exercise downloads

+                    
Migrated to VSCode Settings

                     

-                        Following the change to exercise management, downloading new exercises is
-                        now significantly faster.
+                        We removed our own Settings webview and migrated the user and course
+                        specific settings to the VSCode Settings page. 

+                        With this change, users can now specify course specific settings when having
+                        the course workspace open in VSCode by going to Settings and selecting the
+                        Workspace tab. 

+                        Settings defined in the Workspace tab are of higher priority than those
+                        defined in the User scope. When adding a new course, it will copy the
+                        settings defined in the User scope to the Workspace.
                     

                 

                 

-                    
Improvements to TMC workspace

+                    
Automatically download old submissions

                     

-                        TMC Workspace files have now been located in a consistent location separate
-                        from where exercises are. This allows for more user-friendly experience when
-                        moving the exercises folder or using the extension data wipe command.
+                        Since TMC VSCode version 2.0.0 we had to disable automatically downloading
+                        latest submission. 

+                        This feature has been re-enabled and the extension automatically downloads
+                        your latest submission if enabled in settings.
                     

                 

             


From 46d9354ddbf64a13f11c27355e56a7827c46df35 Mon Sep 17 00:00:00 2001
From: Sebastian <39335537+sebazai@users.noreply.github.com>
Date: Tue, 29 Jun 2021 13:38:42 +0300
Subject: [PATCH 74/79] Update src/ui/templates/Welcome.jsx

Co-authored-by: Jori Lampi 
---
 src/ui/templates/Welcome.jsx | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/ui/templates/Welcome.jsx b/src/ui/templates/Welcome.jsx
index aab886f7..c1bd4f99 100644
--- a/src/ui/templates/Welcome.jsx
+++ b/src/ui/templates/Welcome.jsx
@@ -64,7 +64,7 @@ function component({ version, exerciseDecorations }) {
                         You can now see completed and partially completed (i.e. received some
                         points) exercises with an icon on the course workspace.
                         

-                        We also implemented showing if the deadline has exceeded and if the exercise
+                        You can also see if the deadline has been exceeded and if the exercise
                         has been removed or renamed in the course. By hovering on an exercise with
                         an icon, you should see an information message explaining the status.
                     


From ebec9ec884d0ebe511d87932cdb4bc64532a10ee Mon Sep 17 00:00:00 2001
From: Sebastian Sergelius 
Date: Tue, 29 Jun 2021 13:07:15 +0300
Subject: [PATCH 75/79] Open exercises after succesfully downloading them

---
 src/actions/downloadOrUpdateExercises.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/actions/downloadOrUpdateExercises.ts b/src/actions/downloadOrUpdateExercises.ts
index 2e6932d0..96b32d7e 100644
--- a/src/actions/downloadOrUpdateExercises.ts
+++ b/src/actions/downloadOrUpdateExercises.ts
@@ -52,7 +52,7 @@ export async function downloadOrUpdateExercises(
 
     const { downloaded, failed, skipped } = downloadResult.val;
     skipped.length > 0 && Logger.warn(`${skipped.length} downloads were skipped.`);
-    downloaded.forEach((x) => statuses.set(x.id, "closed"));
+    downloaded.forEach((x) => statuses.set(x.id, "opened"));
     skipped.forEach((x) => statuses.set(x.id, "closed"));
     failed?.forEach(([exercise, reason]) => {
         Logger.error(`Failed to download exercise ${exercise["exercise-slug"]}: ${reason}`);

From 94003ef7ae204aa2ad983456041a2b9197420282 Mon Sep 17 00:00:00 2001
From: Sebastian Sergelius 
Date: Tue, 29 Jun 2021 13:41:33 +0300
Subject: [PATCH 76/79] Better texts

---
 src/ui/templates/Welcome.jsx | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/src/ui/templates/Welcome.jsx b/src/ui/templates/Welcome.jsx
index c1bd4f99..c2ff84b6 100644
--- a/src/ui/templates/Welcome.jsx
+++ b/src/ui/templates/Welcome.jsx
@@ -64,9 +64,9 @@ function component({ version, exerciseDecorations }) {
                         You can now see completed and partially completed (i.e. received some
                         points) exercises with an icon on the course workspace.
                         

-                        You can also see if the deadline has been exceeded and if the exercise
-                        has been removed or renamed in the course. By hovering on an exercise with
-                        an icon, you should see an information message explaining the status.
+                        You can also see if the deadline has been exceeded and if the exercise has
+                        been removed or renamed in the course. By hovering on an exercise with an
+                        icon, you should see an information message explaining the status.
                     

                     
                     
Migrated to VSCode Settings

                     

-                        We removed our own Settings webview and migrated the user and course
-                        specific settings to the VSCode Settings page. 

+                        Old custom settings view has been removed in favor of VS Code's native
+                        settings page. 

                         With this change, users can now specify course specific settings when having
                         the course workspace open in VSCode by going to Settings and selecting the
                         Workspace tab. 

@@ -90,8 +90,9 @@ function component({ version, exerciseDecorations }) {
                 

                     
Automatically download old submissions

                     

-                        Since TMC VSCode version 2.0.0 we had to disable automatically downloading
-                        latest submission. 

+                        Prior to version 2.0.0, downloaded exercises were restored to the state of
+                        their latest submission.
+                        

                         This feature has been re-enabled and the extension automatically downloads
                         your latest submission if enabled in settings.
                     


From 7f6434dea73e37b0e23e03538166114b1403c991 Mon Sep 17 00:00:00 2001
From: Sebastian Sergelius 
Date: Tue, 29 Jun 2021 13:49:43 +0300
Subject: [PATCH 77/79] Resolve tests

---
 src/test/actions/downloadOrUpdateExercises.test.ts | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/src/test/actions/downloadOrUpdateExercises.test.ts b/src/test/actions/downloadOrUpdateExercises.test.ts
index ae9aaac2..3f6b83f0 100644
--- a/src/test/actions/downloadOrUpdateExercises.test.ts
+++ b/src/test/actions/downloadOrUpdateExercises.test.ts
@@ -191,13 +191,13 @@ suite("downloadOrUpdateExercises action", function () {
             'expected first message to be "downloading"',
         );
         expect(last(webviewMessages)).to.be.deep.equal(
-            wrapToMessage(helloWorld.id, "closed"),
-            'expected last message to be "closed"',
+            wrapToMessage(helloWorld.id, "opened"),
+            'expected last message to be "opened"',
         );
     });
 
     test("should post status updates for skipped download", async function () {
-        tmcMockValues.downloadExercises = createDownloadResult([helloWorld], [], undefined);
+        tmcMockValues.downloadExercises = createDownloadResult([], [helloWorld], undefined);
         await downloadOrUpdateExercises(actionContext(), [1]);
         expect(webviewMessages.length).to.be.greaterThanOrEqual(
             2,

From 9e2749e10b4d1fb23a27cdb6eaf0656374b3f0c7 Mon Sep 17 00:00:00 2001
From: Sebastian Sergelius 
Date: Tue, 29 Jun 2021 14:33:08 +0300
Subject: [PATCH 78/79] remove unneeded pictures

---
 media/welcome_actions_jupyter.png | Bin 12963 -> 0 bytes
 media/welcome_new_treeview.png    | Bin 12895 -> 0 bytes
 2 files changed, 0 insertions(+), 0 deletions(-)
 delete mode 100644 media/welcome_actions_jupyter.png
 delete mode 100644 media/welcome_new_treeview.png

diff --git a/media/welcome_actions_jupyter.png b/media/welcome_actions_jupyter.png
deleted file mode 100644
index 91d21178d1d5d00c7f8062c180c6a7f1f3e2a617..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001

literal 12963
zcmb_@XH-+swl2L&5fB6f=~X~bqzM?B^j@T^bdVZ)RjNn}T}tS^cL-HfI)vUrC?XI#
zNDG}8@SJhZJLA6l?vMK;BRgyCz1G@u&H2qazc~}GuKJpYfQA4K4UI@aUPcoQ4Sf{#
zd5VXD8nJ@Fw@_c`K+V@uXcf>$8>k;xRsa;pIDQ)Ngzzd3_)n8u5?Y4|#_`Oed
zuiHJ6h3?R;E{%WdBA2=#YH43pee*jj(
zv-w;oz5qbm=*O
zQ;}|;&x*@sUGA+rz58|CGYQ$EpA~#Txk4%xns8LXV-5qSSu3}&A{;W(P1EUy`+q-+
z@Dfk=v9zrn-V0NndKRy>M~(2``t^DWn4u)k#o{F{B-f(8ayfDBD`iVje5hM4GjzE^
zki;g!5%-Z>o%wiBibXaTdQIT+ZM
z8z}4fbq-mrx&SPHr8qB+K!Ky-Q&uI3#2URnOhP!a`xZ9N-0)wa-ja7i6gdkyEF^Yw
ztALDcN=(rDSiYq%feNZVhY}g+@NqU_btEan^@R(QdDVjtmq#FT?)%=njK!d}`j9AG
zwRB0r$qSg&pB-I(GaiWpglUAEt3#nz1)$5g+f9>T4s>WFHOAVxH^LN5$aM%G^zIUz
z{p#faA)nL5ucY-H2^aKFVHNQhNGcBo>97m)m$IzE<$qzUYgYaejnX|bFx=QWuKD=q
z!>`3Zv%Uv*6+Bo?p@|CBg)8tmdM{5}1SFV6+5p;Sw!9P1{~bGpiT#kT<;$7P+IyBz9%Rgy8%DBRgQ=Me${cg$`^24YMKw6
z!vibHzh9DBdwDkv3y!M!-wFSVD{~6ZoAbrj0mqK3
zs~tDPH#?0TS3Lf<-!}uvQ=s;IQKHDTFw@h@j&
zre}Sm=(N|FHy1Z6@*~ov<34m7M%LP*GV+q*v@opadtRW3$}7uU&Q4_J^|g>N$LeZL6W_r~^$29+lMu!CNohhTnSGZSl?98TWDf3(x{LbF)L920
z8}TO;>(R=XS~)Owf9vMd^h1<-TI-V~8PyLNbJ2)v(W7hgRiDsfDR09!Z-jk34;4kJ
zaH*qRD7N3(0;`TL7q7vCR>$ikuL{I*odWxm0p2)oSPt>h<0~@^KntW}jHv@FMOrs`
zS6DqCKVouvRyxbSa_7jso+<8nh}hJ~>up{#-Owi+p-g-e%%&N0da-yJ#FvODm(K;_
zb~KCxBCdIlEr|;n{d)L}JdZ~QA!oHyK|+qN%G6d9KxX#^!Re*(R0*Z*Xx}u&y|y(X
z%ulB)WMgGH){EaK$7N&gS?*M$AGIabTwB(MMSTVS+N766FDpQZ>q~-_`@*q
zC6C`$OmdK|!z~~gE&an+vW%7vTL-MIR!VL2ey7_IGatP*?}{rHYZ9%?I_M;G`}qBE
zWf8AD;3PMJ%ljEstaAKR5F_@U5qthV
zk%}X?@G!PFXjYoiDx@uxcF!mw7QR|Ex$vP8BQ-1gVah#bPqkwMo^OVndj)=#K|hKM
zfs3LyLN1Rmj@YhniAJ#^_T!*Ce67w&&=N@`6+S<-zMD$1t^C`u(Uwu`Pe5ocrA7L^
z+2fCk88>qs8Kd=nwN`<6j`VTVt!t;GjZO6R}cy^TzMHc0Eh-E(PYq37I2Ob
zg-_likev|JbmC)o0Kgi|^6LE|oFelgO)|*kK}t%B*PpJwtQvOO7rs{h{{Fs3d$TV{
z#XNRj`kg;Nzqe@z5YUavM0wFtRqts^O`qMp26o~yN6QRCRbUMY?ej}ou~
zdkvg+F{vVS^-ev8W@6ys+df{!oej8ZDMOylt+yLO*(qPAveWzbIT7VFE){rsJ`1&0
zYRM^_V5KpJ$-NOW-`%|fjF7fJ-L#*w-#)iiYQvfAPei9EC@ieTqYW;u{(9dA#IR{0
z9UDGU!^S|Zo9G?Q7Ua*>N2VL{A^XkXiYe#N=ktl+)$e7xg`CZ~(9LDj8Px9mIj;6!yjHCNeHsc4Li6
z1XqpFPwpGKjZqV98kN6J<*IM^z+Fyi2MAQo*NMOojb(fn`&Gk^1%PX#myMc-PGqxd
zX$k@e3x2Nn9;&hj>1Y%`fD@**Pi-$Ez5`s0>*Jy7>cH8R5-a;zT?0mUsmq7vIbP$3
z@GNO58de?z+bMi8jQEj=z|=R?0}^4-VSQ@`#A3i
z&<=in9$?MHz!rda(e^n~h9ag}z3z&_hsg}&b7`xdmfX0kB^eq7?qE{jXul~3?mT1I
z&gIa(9|^2D_?%_%;;WU8b(V+}0YKt~Ze|wa+c0@<8PH?bisA3;;eM^8)S6TINIC=C
z;Vb)Y$WsPYpW~&UKV>4rMbQZ-M1>aExG}q_H;h=V1CwVQ58fyb-4A2>2|3X8z!NAe
zEDZAXqXDtJwxs}%Kz=}H-e{t17iC^Q=4f0T7>EHBAN_KlXfSoULnQF-Edg2O8Nkd96h}x*-tQb}*_!9ah1SqXvxAuX4m8~meB6nF9{YP}e0DzLx@a~v`3&kJFvU!C)RO%(
zET$Ku&Vg@T3}nOT?u|v8;*fvH+7{=WQ)MY}M7LoqzV>raTZdyj2qWkUJU2iXkON33
zL*M6TY0{J=+5$f~))V~DoKpna`qZvhmA7Ke^7<8H8GcC?cu_`i?9FIs(r-c#s@KKF
z?Oqy01St5BMdxnMo_7^l1`PWs2aY(@RW<$?uP?E%j3o!yaH7$%+lznSe(YKBE9V(Wx~JpfvLPW8Hn-}j~$YJn2HZ{
zJ8!|>c)grrm7$UNraVh1Gd4g}&ToX)1cr4fLmV2cqtxb#UDBrST53T)q9~x#t^?w{
z0GQe~&S0MUGDKiR!K!EHOO@SU6pa0yo4NGlkgNHt{1$WC_Bi~Jn3l|&2{7lAsgaIkNg{lchWy|
zEeyU#tj#8v%Xg-|X&Z9BS5LGW{lf)l-gZ&d`hmnoM5qgK{bJL|NACm0zRN7wPVdtj
z7`|L6-pokH>{cVFIZiFkZOP+L_pwDpV3v_I1g?qgTZj8%@UC(NeO`LupM|Kr4
zy$so8Yhx37VmAT7T5m$K^C)
zHw<7Gh}+n(DUUTJ!?Ougd=Budx3?#an@!zRX!LFI#gJ^Axag`6#^sElW75@##~u)IaaShn?=(w&?o`|@@V9YoH%V;e_n
zyeP#?j@*DUZ17wzmArs%wgtAJdmXoX(VhJifN39X1=81_>|+Zv9eZuN_~M=&jM1+L
zrke?jzUt-YX?s`0Y*w_xQY2&PB*E}H6)DCthUFcMb&M8K1`P6e9V1O~sSy{}{<}BK
zz1+)QT02MW=!00}o|r&=B!U^eI;jm3c9J5duzBL?IBZEAwDhMMMSU{G+$@k-X~)JMApkJZx{+89^riibLt
z=w9udF<=%=O`OQ-e%usedXfx87mf9uQ(ttR6CwM^!k{%kVCzkRk%5X)XYdI)+UkCJ?xK&f
zYNc@~w(#0zkKG*ek&k(;EZ^TdU0QDsO*6U;d%6W+6=Z&f^CicXCXTA--Y6qAT$;{t#mUc4$0(R81|sl?UFgQ>5l}XG!_a#Q{5~43Ru`8&l%$L
zN4p^DQDiwNGqYd?+YRBJ^`~pwtvG8Ijj}7EOhbUSsb$lMWxb9j!kkkSpl4kX!$%(e
zSnPy`%fh`3Gk(pQW2>a0e2R38%m4x3s_cmUxK(k1m^ShGAvkSxlUQlwH*2AX?Krpe
z29a|wB7Ay(oZ!A@P{+13=BM&e-`2=<#O7vQINe9x95l0%&hlb*Ha2z8uh|AEd&lMk
z&}0bIo|AjY=rd=UAZ2{#H&c#pb~?qKt|c1l_mpH~!Rg#~fEgQs$QY2rA9Cf$JhFy^z(J`M>_2_4-85LR*p*miWg~{)^0FKo^)#>^fo^P)
z0fLD-Nv3_KN-Nr}q724X1jOd&YcAP|0wtjgCn3?5_hX^CB4LCA;Ms#j8iRK*+J_@t
zW150liMeHj5EPEi#NR)A+KhGiR;OwBObC4}A2o?dtKg
z?yw}n2!VQNqRf{NmjG6V4rQJ
zUj_2rd_(*+^Y*bl`5rQToe10wZ42vee{90S8hnpa!DKjU)S;j&s4{(^ASc4g6e4Mw
zcSof{ax0s>wr1nmE$)Bk2?-!8Hq&(eIHsqCLQTm7Qccec8gwSY8k?FO7xK12Aga_cRkn1dyIX4EU9lFb?Z
zKT~HOrW=0t*-a}3gZvROmuJ)O>A;2=DQjBOF2j}*c23}g??TU^$A|De@pE|Wyhnhz
z=NulRv|`|5wk#f1!q9qQQJ0|ph);&$E{kJC@I!>bZ^HbA%VRjtFumx(O6H+s7oI}M
z&vaT&Bec$0zRD6U7);T$G8sEEm(Z+Pac?#!9xYz0;;2nr(C1fMpO0e`TN>iv4m@}e
z4w=3P?MNp;f&5hgcjlZoRf{k(!gLA>tS#pL{zfOKNg_=!w&+1cmdNMU@;&=^@7|ph
zo=e_GF7}{utT=*V|FEg}G2AoC?>ExSEDG!Jq+8OJ#nnOSHhYVUb#s`zy&w~9%tx`c
zET~9LbIhp%&LdQ`O?X5K2Q`Y(Zf0{f~$uaDLNTr20=a
zFKim-gyV8QN1%co7r#)p^#O=G`ygVtr_5rXh*9RRZ>S#*2ZaHiwCK{f@M77Db6+Pe
zQvZQI_+^XmIoU35&|EjFG5QNu
zci*OHB7cnQ;e&nwE*@8|X-kYq(%%z_7*AxQdGJJW<}kT-reYZbQS?=*z;IVz89OBF
zMZ))~a>Huv09*Dcydn)|B|VOH&9sjazr>LDMX5|d)U85O74zVCxbF
zx1f*r@4C#dUxmGoijw|lQRzgz6=%W*7!~--5cM++F^s!&&**-M)=$PUyzgp=jbFo*
zmtC&iFKl7+l&cQ_2-7ocNJRVHSyUI0^?O3c8bH31zti8&Y2K6tys#LUNa;$sk{vqz
z@Iv87u!W0~?z7zvt5M-+^&)D2fzat>e+>oZ1Yg&~3A1>V+mDVK3PlN?rnbt|Bn3Se
z#IXHI)evw@%r%Os8>ZNrK>e6Yy!U*s+gF4ZuF_Ua9j`t|Bh5$32xeQQQ{prua
zn~OYX#$r;_Idcw%?>HOePrmk3&6HR0D0S}IZ>aZFwlS(ueuDW~T)f5ri{-)H>OCvI(puoQHX2Tk2>X
znNl0TR>t4ti=U~rxwHGjYM5?r4*oKkw1z9s#s1gkj#eSYj^%f8FYAj*1GBygw1=gX
zrfPg!M+@aKmg5k4{*%Q@wdYI!KS}rv6yu8V*ifsfVTr?Lde}(}kIMYe
z=)tnCvS-wuz*7<(#M-p&r#q}K2M!QGe}Y4R%?~^z=!m`N1ia!_$D>J!^d*sHp0Ey4#@
zF*v7x(ZC4r8*CV&3JSlr57THa4f#<{{Ao=OAc>{9!^zh#4aM%o$0uc!@*
zC+|?XsmkW7Xt{r~+@`fRI)C2F9qyB&KZ~w+r
z50nT`F9bAPwVp1o7_Ewk2iH-fg66W1z~gH;9^}x299oa0dcCgFgij4Xq2O2@P&UN&
zm8Uz3OlCxEl9S?5JKqi$0mUGKMPb|)E+uLq0D!Hz$rC~Oc;yQ?O+G5kRe1%=`M6*{
zRt{cb$GN4hiV_xy4ty{e?UHq-??O$SzmqUl!nm{56Gio+*kTT)$Zr{FOua85UE#U~
z1e6K|Idorisx`|yHOpntyJa%R2$Xb=?s7u`sX5)E9hGFVnlHE6r40gyo??m3xq>o}
z-dzic4-5LN#$|^crYs~lB$XdNC{#oGY`L(XMp7dtI7_HZHtvD3pg-)_B#P+5*Ow*p
z*d>r4@jScB=MH9#q_;yuuiZ?{z!AFZx;&g&;cRczi;o)&@h9FOrb@K*qVnJH8H9V?
z5=X&hOg3U3_`{e`hey1z^V&i!F{j$@hK63d(#}8N86LfKpvkt3xxNfr+k`F;B_OZv
zC*?Aw4>O!SqEu&bWivXML&d02^9AU-)!tTojh`Cx?5_IRd=M0us)ho8WyJ|BVsEJSWshxV-jPoIanip!S>>_z{HXM@&
zbUf=D2smD&6>N1`N>V)dvYdf-bl${W>drscb~MIkC_LtM_%v0NyJ60&Qz<&039hmd|xN~`n0p*s|cWp%G8&?lBbRUVbrFPXRSBrbGDjn
z>aH&dzn<8hizmTOOv=E&5BGLD*-54+;CcXp+nbA|&%Nn%EILE~b*9__ZcS42$(
zHcV&NcXtI<`9;!;C3p29ghc49w*7QANqbJ3Q(s4XiI;3CO^+9XA6@nVD|aWAZNA1<
zV*J@$Xsxm2(KGTw48uW2v&RKn1Vv@d1>MM{_q%6pl46|3**7_AEQ8_!R-p74bveyO
z;I6m7Dwo*a7lI0*$7l2$d%ScyJ%b2D!PJr@d?Eg62Pa7xxkP91i^nn$D-5
zd9G&)J-SNvh^3zU_F3_v`0ueNa$^v?8>e}m#k0e7Hz8wkwuD~ouSz4~Iu7Q$z6LK{
z=jWG<+{#D}IMeOes$}!G^tlU-vY!tVHC^n_5>oL#T1-w>Q(M^C6jIA*M@21`eO{Nx
zt*sUZ+abSWE*f}W(@-8)IQ{y*6=N6p{JD6*Mu}ffOJx^p3q8GL21!|fMZ>SN2vY~Yjkb_!WcJhR^Y1NutKwG22b$!sIIRYh
z_S%tgv}p<)E+=j6AReMPu`*WLF(tmXmi>hYy2rY8js>lC4o~w{2AUJu44e{lOZpyG
z&3)0#cQ9CBQQNKJcC~r1qSTl_9}-IFGTWAws$XWTr)^Wz*Gd0ko%qR~!cPAlx&jEQ
zl;SnqsY<+;mj_Ug@Ql?3pS9phsl)o0}^k#h!
zt}_o_0IF=pq`f@O=Es=FFE@GI?{}|#7ZRF3-znKfA-;PcWu1v=A7Ph|UVq)i(00^V
zJKeoKGC3m@b(FEB{sKCA*ptrlE?Rt+rO^985Be#RRb)CNzy3$5p^w*P>i9cp(K6Z4
z;AgD`Hz40}Cif7o+!gHFv63e_?$HxRk4o(G&sOJG1*e|@Z|;Q}2rc*_GH_=RqPdWB-?NWD){)c?)uE(C0lxUM4)N_+zW-r1f2_dIuxjR2)ekkr=mmxhSY{^Z7$F
zQZddG%wAoMZJmpV&imEC6`LV9J3g}(7a!^V{Hu-4Q3aW`)4>$#EF$26P&2&zhog%#
z%ld+QX>a^|$+5jl-?L}6T@s^g#AQqat}3n_?|3@Balf?$-={)>N9s-ZjGqrk>tn5}
zzb#phHKq4^J!sN)La&q>PTKE&uLLrd?Y_5U_vq@FEFO2IB*pYhYfooHsa)@3XxOjk
zJdaGR|H^2gWETpCXy(*y9gMKm{L&xtAY+Tgy!`h|aZ&>f8E
zwn)NV`_anBD?*+VT<0dP2NshQNkpobVKl8-8rFqlmiAIwv{;wSWUiVT+)0zr#Bd!S
z8lO*}b@q#XD!$?yafm=@IvhIisxQw%*CWO&`RQ^Xbf<3&oHq2tHG2H9aHnGRguiam
zdwTZj=ksMn0J!paw~H!TGBVl03h}-%xuA_Z(gUBFcO9PbqzeLV;MF};erOW+713`I
zw))(&9JuOn=%SLJ9C~*X$|b+@yjufB*98AxLrl&nZZx&~R+uPC(ww1H>7g?!jFiIp
z{{I__Z3a5}oc~M(Un_H!4qT_J5mg((XzEvrW
zrUsCWheJ-GJ1T5X`gpqyxfO2*$DK9g1KCsB@fBooaoZnmmqGD5&mVFE-*0#P-nCuY
zu;prm)4DO@kA?JbcBP_wIJl*vprVqqoKKb@=sriVB|RNL2X?4?JfY*?SCc
z&%D^$)t3-k<(}Vhp5N&^bXibz$k_V6=z`k*&wp&+AYk}vh`!F`<;R{Rzi9FbiA29I
zP*&!MyMyY3_`O8xtwDYp_sg$odEueop7z5;J3>EHmr)^*|JTj|NKr}-?-sWre|lJ7
zNg{>1A?XORlD|jprK=br=Llxcj;E)nEVh6t=B6@70AN9
zlv6ni4MOTn;|ZVjGLGGA3E%Ie`UH1sz6eR%^IQ}`HuMCZL+?$tIU|Rk3>y!jxGC+s
z!)Qgdu`aBqU%(sN4fQARQI!CRf5>6J?!rVEIoM7cc&-|`RqNYjF&i~l=$n5rk;y*8
zjkb!5HX!akuY*y1a4z@btXLtL(?gEWp=0Z@(?%6iWtzSYXD01LLgVPIze2*!hU00P
zj_R3jV{>b!@1!fQKG)su79fjrevi{HrZDY-&Uq8oAStIZa_{GIwt-wEXq4cye5l28
zeHkPbR#(%mh49vE?tlNXLLhT8TFo*f)vJO|vVRsf&!t$w*FTmHWmW3BRggY0WHn~X
zLZ<)v4EUWNl@tONZdD%{$VMoa9R2cH8shxygUy3DX1=XB<1l>--jUYC++CPdMrKM~
z$plOQtd#WSR*y72cK5DUHrj8jv-uEHo==?|9KL;nRHdm
zAbHexl57Tc9O2$(K^mJSjbwq@9b
zg`J=2gOKW5`Y5s{_$cUht7GoFX1MhI*TN_!JwV7vyHl|zeC&E&N(d3CoTa~#xlUzO
z$gullqW0I5dTR@Ft7f;&;auy_SdSM9C5Sp$wm~(MDaFshN;E%i#b+aiT-$T-wA*~W
zCyBI@Y-Tf>U`PS};Iw7gFKAnPidL`3j;HT`_r~YP@X5Dmh$-W0W3q=qDTicZ47aD6
z1x(IFIeue;S5JaC=5+#>Yxo#dexu%*5Cu~Lq5oq+;4eEdakl!
zA|8ixQ7$an3zsp2
z@rX>rwX?tOCURdi8LHSjx*&p66c#LE>u7H8V{yOj!A>DUS_uULzWQ{oE7$r`?Qdsy
zSS@74%i=XsT=OK9bj!3W&L&|RwFe_V_&H`&cr*;ft(vq+yl(tHm<;Zz{Yt$k$qd$`
zu~qeAAzMQNDC6RH6f(;q2Fs@`R$QJfU$bAEzqzwO@5Su$dH;2ay1BCogA}?*9m4F>
zz_j5n3<3egd)qImzz<2*NbH_A*GX_`9h!%oFI)~}K#88%G%(THKmE|rwi?RzT94{p
z?nF%1+&X2k=3&&qp{pdl-foq2FX;9-A}GKY+we23u*fGE{V&R%(fH;;brL5c6uu1@
zsih2%c5w-y$_?9EFQ{5W`=M=T$@AbXRzk(JwMHiO!ZLpAH~pP>wW?fOJbOf-O5Qgi
z(H#@gIsI&^f*>d17k(~mT-BA8D<=&gRX0cZJh3(lH%)rpk?Q1V&cpeWud9)c2l
z+VJVoJEl@q64B~zs!i|l{40^hIDPuiwPc#mu_xpXpLbFJ697oHD{a94`oBJ5AqDKBXlfHaHh4+lPggB3H!rxHJ2~tq&Yz^3K9I#G2fhKo-=yKj(gnG*q6j^<{Ou$PUe6ERDLJ~i97E+j`1v2eOGL=w3}HMF~k
zoXH4)SRpYNJCL}NQopMGysl<2(>nZe9Y@r#99bC6IquZ573kP%(Uallv>Ahp5%(P4
z3D7i~q`g@=@u7b-z}9hbvfY$#x`*?x2T;j;s~^J5f%sw_Gi~~;B)Zz+5HqG(WY0{@
saZjnGlNQz2LV&^(e&>z+o5zVlzl7G&o}HuqSc0Y?t143=^)~ST0C6+uSO5S3

diff --git a/media/welcome_new_treeview.png b/media/welcome_new_treeview.png
deleted file mode 100644
index 81d547d50ca48f20cf156a93cf6b28d4ed2f4e70..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001

literal 12895
zcmaL8byOU|w>3&|ch}$~xVyW%yGw9)f(`BjA6$dGLtwDr?vmi{u5a@D?tAy%^{w^(
z80qess_O1Jb@thNca(~fGzuaiA_N2kimZ%;8U(~ATk!W`cv$fJ8eyRY_~VnCnzR^1
z%_Q*=cmvv6R8bTHqCNrX)f5K2jo>V!>jnXV+W+tM35QPZI|Kylt*nHohPTlf5Y1g<
zq5Gnj2HI>kn3c6%H4=ICJ7K8ql@ufSg2|UO5yPtb>?!+noPOvLJ(Ev6!Da7x1x=(%0SR6m2PIttXMo
zSplZAKSJ}2RLm6^EGj;bK`aW0{S*@{$SM7GGVI8pVwRi~D|{;hg!Gi2JGFQ`#hinP
zssFSB{jXLGv*4XykYhOhb@1c0`4`o6B$N^m5)5JX~AwP|3{xe^GaL6|lqv
z+btQcJZH5vOs^({yc-sph$x{hd)x7<$$lQG{yHlrpm`%u`l2s|DuRE+^^M>4bJQ)Vr<)#Q=8)`-x5Gp3CG|I3m
zJf}p;s5j-Lu;VmZ8;27)T5B7czFbTC;NB|LJD|vE@&rC=;P>i2WU=ckG}wx_dANrfWjty
z`+mU(Tz^&`=KHA=OkQ5S>a51-&9;>UC`Q{>bug>o_M^4DVNCP@wh-9Oae9C=I{=l2wp5E%M88Wx*d`GLT7&x
zYNYR1z+g=^o{;^@;zausC2n2(XZG>=AT@`0i?M9a1aXIZ|L>vlf&gn`8!=7@MOn~l
z2>U))DIJhEbnIa3OAHbl8d44W-YH$K!>RZkn;S`e0^gq{s%a{#H7D`B7U4=#vHXMX
z2MgzS<-zp`F4H@YpZH%^`_6K`ok)8c-!RDA5iwQW^tFSvBm`k4N1iC2ovWsJoRCxC
zZ%v$!=WVzB?u?5?9`1lcZc}H8g$n+ceP8U?ABF!syp&{ETPr8s&|;Z0&GOFGN-5e3
z0V1To+hZQ
zbh+tr3i*CfkoeM4D}|KH$xJig*E{f>?q1(2j+bmqmKVBaIG7w3L`14vNaJC~3#*M7
z4C)0*x2}KN$~83$lkn;bnKC_JXLEOV-+tNp_>`3u$UKZjDiBt!9~7%Bbc6>9WR%Qt
zUHDxByY<$JS9h}2LqDWo223X&5=zcZLz_ZI6KFq1F!$t24j>#3;~lFHc;PbFk>7qm
zY)M8JYC_32k3&Y1cYbxYDSmx+>tGKjP!tZ?YrT!Kr0Vh72JjAF#ZwN7jMIM^$b5Lu
zr_hW`A^RJSQA}KqHOC4sHkls9=j8rL%?+PM
ztD&J(=L>3d{#4G<@Y9Xd=2ND1ZVF_;)wU!yj$wSzb6M@5pOtc!5`vkLfgJPEJ2jmy
z4;#;aLZul!%W(XR{V|yBKuJce5wTw)17DbKKq1<#qen|IWVmLT8G8HUl%{WBwP?oWE`7|`%4*cG4~8kqX3
zblENSc8U^wt8t0(n2pfA4#cm8n;+>Ifz$_6S)B4pvE^CJiHrytCY6XBleF8L-4*Gqm>c3nj
z-7q}kRf?`1CW}FQb`H8Vd#lLb{yE0lUCYnWueHt_ger9GsZSWE6Hm@oYrlfBj^k_E
z*%h|)jfO8+L_}(w#(FAQ1g?y^`&R9#x2{fQzn&ILRe~>~0jrH=J|?YIugMg`78^^M
zM>_9?M5yE3Xx&K0tjtPEqC|vrR?>k~tF{~O#zLcWJ=e7$BGwD1a8Odf@>@bb?kQ@D
z5Nm!;)B7LR)W?KAgc8AlaK*~ju0QJy0^YG~Te&t*;}&6I8Kk&sN_@f}?4~dotBTo4
z?$Xi`kuB1@j~1q`)K1A!x#mAAQ0(HZlw$reEg(|T81*@l3y^VURg;>1SEHx0TNJv0
zG2&9kQr8n
zs3Tfb9N2`U$qFN7njP}K5_=C#&725{vcHEct6XLvcOrfY-IN)>iOf!RA7ATrZ3XLRM|to`(rCOe*t9C<-De|!-QW}K9bPTDoTdY
z0xxT?e>fBNT*YasYxd)c>_fXHsdOIpZL7Bz
z+~~
z3G*4RCQ#ZL2{@mi0%U`>&tRD6WYkXLDS4Jx!-K#4G>*rQc(nx`23(kkLH21sU^;?sniCjHl;ol@9@_g9$H=O;c^+<3n_+a;vO!PQIoBGtxw+f&T7
zZ1KW97G!qb5%{D@`b!GsxCmOb&5)6A%LtLZat!(?
zm7@e3`BWQ6{^jbb*dH3`gKff@Um1{-nxS320%QRa*SPthxL9l3J(#9fO%Q5DQE=1t
z`nKM?vQR_OH{b?g^7~>NTD?rpvsCK6EL)Z@P*=4gg?^MspPnoPlH3rf)Xp-x*H^&Z
zm)~ixCy;RwWP>kWi-nXD-z8t*;}%e?8d@)McCuMm)O_8kE(HSW$6YBz$~2?{if4g?
z&~mUypF({q%ijFBq5J
ztkQ~v9)xsEe_we(vD}$Ae^juJ7107Pj9;DfQG#(X++QIb
zrn^co-dFadI68ll{wU)l=diT{MEcYxQk<_6vMvU5_e&M{TuLceMMOVd^@y1De+hfc
z_WSOe*-Gkz(DUj5_K
zwXPT2(fkle*Th2=&1HkzzY*Hrx`NyYTH()@d{BJH?EsW!e-Bs<7ropbl
zZ!Rk%{JzVTPq#S&fTFX&TOv0st0pI6HLR}IEk{jtb4eRz&#=vGLyOq6ZpEU**eGao
zMQUHOO>1lmA0v)c-wk>4oV%FH9^Z>#*x*Hn7E)x8m>|O9{mz%h-ZK||>HBBC6T6cy
zGmHABg=?%>ikK8fm>Tm;ecQ+1SZ}WVEl}WCE?tG%i4u*VT^?*JUY@)=Z)Ss_{n!iS;R-jO!Y!{qL#(o$2?yp?$^ejB;T|Wopu<
z1?4{-$~!v!OflE(ha65T<+@FR3HMl{P=FtM9n#dikWWe4T9m!wQI5k30!8RY0;vmH
zpo8B-&KDS`YfB-Mo6cIaZ_>2tm2JOo5
z!AZh;m~I%qk@1f(<~n}vYccbU)7d0MCVE8R(pHX^m_I4C3zHp-1)iE2TfmA~Iygc7
z)S_2)uS`*besCjaF(nz{l&LGZ3f80LC^2aR;UCDT@MGam`x952&wVChaUuSMg910!
zL}o40DKZqzvAr-TcixL}!oAKc42RtGdk3X7b^TrzFV7dd)v+;N@NmF!`@UVG5SASY
za&&nazxBxkz)4Jlxe=cUkBN7*@`EB|vTx)&8KWX_TN*PQO@HRqh#Al*DG^{8p7=N(
z%20zW(bOQc?C~W^l*(Rp8Wn@Qaz-T#KXJ#alRS}}f)c~b3Xv{z7d2xus(#`3!kYkq
z%+t*)!P5Q&w%UAg}0uc$1_J2UG*$L^El(s;M*`2y
z4PFTlMJ&=GPx1B6uw8fELwA2z$eUzJblM$pJ2oQm&~tnsu})?x+c3-kxuCTOXT#2j
z1CqpP=WUL1PlFT}R69+P
z#@F7SC++;X6DKIW7Ag7A{sH&lgN(|6zQPgExgyQmc~dkI9rbpnEi0DfStzy0aGtYiFP`%G-Y3cW
zjB@5IBZ@{e>7K%ikcF5h&WMxNYLg_fB5B-M6~!#o{QYK4=LJ?y`&UbMgVVVD(7q$I
zkcQ8W<*vIXo6V8@nSePd;31Qp;{n$lP~M%N21n-7GVR1=ExlIq?-u{n_B$Bv#u_w3
z$bZyBQ<8D~UEtn{0nP1Lrj372S)V%Eb|uSI6wx5Cx&rqu}2XQslGL
zZ7od@yd1t!a3u>d^-brv20@AlU9Rnsz?hnWuAh1gMm-Rg=?7-JDNIeIk#Bo=U@Wab
z+vhIL;z9m$=4}nVr@2Q5B&X(2y$Ly2qe^O6h-5P-}%H^HZwlaVQw|B1VUn+Jz~
zxif9V$ktN@eIqB&D#(qOyN-bj4Pbdx#e03TwN7E^3UVmV)sL)F?z}p`
zK+AViVZ?{~2jzcrY>&zwOjQ4X1iH0&t;75S1Xxjq#kJ*P6CRQy1O(rEo1^~iwIYsG
zEWR02(ccR_NG8ASSt1tCwgG@!6G-6MVjiy1t8h5rcVG0xm&RKNKw4xBB$05o-$_rf
zq{Pypp`xIP7m*K>pE>}SaVL*%|0MG7$r>MeTt2VN54#`tqAG2%kL~H-$5b!qdL(^g
zpmwwHGhPubueF_1=&v`5wZuPAP)w}O*aQ_+Bm0qHZ7`)oV#<2$)CLj#`n9zwc>|5a
z0gC0NLhLjW@geh}DTR74(KRhv@Oo6AFRAv3AP>{NH?4Wb*_sO-)%<%dg#00Scv8&@
z^cZN+WKAWX)c48T-;&wL)dQevpdEKC>R45p7p__27aew*zserS@YxTTbQIXkKvi42
zfBGrSO#!g=I118{A~NDgCW^N8@hI$TkS@GF4m-Tn(CoK9U&1X2ORJW)4qk+HPhI%L
zPZv_iw@}cl`KnXtZ^xhaP0-<`l%T-~zNU6T{k*Xb$^qubEaL``^n}i%8%WSFp&`~I
zoM)!RG=9rR;JN+b!WJSeSzI=(e4K&ZY_~K>s1IKKJZ9W;&m{?h@QqzP;MVtW7;DNW
zI?~AL*)gfUx|w9bviX^Kfgz+t7e>H504|QtFMIqVKd>fej_GjgB+wnUuI^N=(wD`E5JwTU~{f}oyTR_Qg;snWcUrjc#7MO#7)
zb0?{3)E)mQDZHlvb0BfY$pd>iyTmL7+K=#|o?>*Vin3;>hPN!mQb<5}3a`TnOVGW6
zi;_*IOFZeiWFcnGB2e+Pjo%?9{{(gKY_AVVZkwlY>Wn0#vTzD`a@3Y8-!}1magRSg
z@
zSA_$djyJL9opcYDsfq^dxnp`sjX2s^Oyf#nhxRG6@l-t6D_wQH{6HX2`k+l?hr7oM
zD*k{+ZoeqTmD(MeSX$;{KSY
zfr2Oa?+#^>L`q9n$nFpmg650-(UUK7EaZz_T|pMXk*e8f9vql&$3c7#FDY`O9~c_U
zL((p-I>p-eWWM-Ho)R_Ol+Bi)-?^OJtR+gl?K!rOIJ`D_TtEuMUev;YE$Si(jO1$B+o4Obp+PTH(f833Yci>?W5Gw8N}yJyzHg6R4dy{8d+|NQVP{9(dV^rY#4n4{U$3Urx
zd1`X27aDHqi!IsOD3rS7$N6A0jF${8U>5e1Xks%|Q9j_ZH6ri`fz1bH*)<2dFZ+b3
z^{?oG4Q4Q(Y6sEPqFYyiTXw{#Z{y&1^zi3DP;+5Pcv`IjtiYfS%GJnpebY1kYp>6u
z0|)NLx)Gy3(t!2;m1N_Nw2K3i)QjaEo@qXG&k>mUzxI7
zIbhvxAt^UX!-Qwf*pP9LsLa=&=g=s;E9HHr^VM(dyp`9A=rXS}42j)`OJ7UQv=(A=
z>3EM&tF-p!dMMij=NvBYxv=#oXZBP4&0WB-hx6bNPa<^@pPVngHFsxf@{Xco$#8lt
zB{8LRrv)g^I7J*Sei{yX~$M6z0c$aKzT
z8IrHw{pdIYQakXH-*4UnDY*#}jyFZV@l%k=RhILDXN=+)l76ltfz{l;Y?EKA%*xRz
zhj-|YfPuutYo0L=ptPl-aL=}H=8^T2aBu&qCQr|*a12Uv??~B|(G&VJt50gfY*OMf#hGLG06*c;iYe{qlG7Llak7yc9iy>Lv0+<-=9BIR&QfJ9RRg!LW?A<2GA?
zcz@itTJrf;h=DkZgHk{!0+)j#>wNgZ_yCghc@;2>C_icW$b8>1vO={m7HQhj6-!>192UmV5N?F&S)
z(+`h-_2pE#2;!p4^$GLTsA|IKnaZwNI0WOZ2b!mysWI>%T?1EcNc?Hnd*H{YbM_ZZ
z3eX+qs=NM%q1`P$u|Vt9>I-|I*4lR-_G3*-MKhV*!H9KfX41e^D=BX&gedX?N_$+^aVEZl&eRp4
zqHn)1n7bsC!zXZMb3*U>c8ZbW!rj%EMltb1$)pr(>4u%hn)N?37VVoAP!CWva9zOK
z{~Pb>-*{Z+Q=`9=^VsTd!B#x(Cna>Ke_C>ya?{Yw*5*Uy
z$P?2bhN8!hD&M}L(foG&GH@h7lN0}Um+qWqK&kaAYHxcmh8z@*gy%hyA1ukYqLO+%
zQ`9sfgC?Y}fk!pla9GX}%8|i&vs;=Wb^V0Y0w&cI=Rf7#8zX;2nK2q-Kv|t{V809A
zX90MC!(kv+gLwxl(PMt)2*ewBDJdy?VG~lCk6#o(_grp+!levAR`jaJvP3n182rlW
z#WCudYT6*FCXv{;5&}DG#LU@3SvjKe8I|N62%|>N=H(ztuBz5fA!+ff6uYCsAA5cO
zhKX@|E)VSKFC+$O+a4(KnMr#)CPE%U0)PAnKRvZ)Rp?9oB4DwKu6=@f!MRZ0b1&yz
zY6-RdQ%K-ayNS%cuU@pdA3sG4OtEX+aSf!Q{J>O^e}uGY)FYSBv69MQLL16CD+ZqZ
za5%}iMEWZ+ZLnzfRG=q#=s|{lf*5tNg;ClZeS;6vU@76%osnRIgxH>&<#{@0voTZN
zj9#Ay)mvVPrUxeA{Q6x2%bCC!c$%@#!pHN4Rj;)xU^@%z7*a9mX1+pw0TT>2b&GHI
z7q{byq7&KK!h+}C@UxC3`(h0&^3Dd605tAD?}jj2rp(wr8Rk#r2`9)icWW@3vL)fq
zkx0@#B#Auiylq|dZI(jWthT~MC`F_D>S6d#wr=192ym!orIcJHCQR9W;7fKulNNv|
z^W1lo$trb2&Rcy&>m3~570h8lEVBKPrLyIj<1|u9qyv{MiGmZ9W_EG(u8HCwAcM1;
z=uzjLkhQwD8r+3FA@2o$fN3G+t?rw0HeN_3D}_{&5TIsGTqF?TC!RqF)XJxmd&;rv9CKmF~W9{nbA$wRzd%M}lJkppZLh@jE)
zi#@ekl0e`Z$JC5MDJg!kzK0zjquyOsQL23=b)KKtyvvY_9+({t)hfX}Bg>3zk4zC!wI5nRqaXUn!!LGFXwD7P
z;j=nc7N6K0CAdW_zxn6c0fO5+c3&sLbHR{w!u!I#w?K0Y5DPLEdlA;rn15T3-6zLR
zkjyt7&@7nF8x1`zFnVqG5b(W|5id8-gC`A}|DCXb{+W0lrlP2|yV&GbP|&ya%;E=#
zB~u=fG(uCyzZK0#T)ZtYo2aLGXoLmU_wDf}FFv0>N^rMC6HdNma}~b3m0vVtb7_0{
zl$K8c&10O7#dn*i`^DRAFXIh9Pgpp%(RvEZDihctfQ1=iS!<-=$>%1#i{5TB=AOsG
z0B>9Fds3Mikusclhf>g;-{3v!xFJZDI%Rb{ixWv%=*eQ5KpL4t@n$Ybn$%~&lYs;1
zI6xrl2NpCimZs=aYeT(y-}q2-@OvYIZ7*<@wjJ&f9HeHm)kZ
zCsuoy&9k|{We6egdF=Z0qN=B^-cwjNnVsM)nzkbp-{`TX@RVq)gRYcmQPVTq@qt!6
z;T9#6miz(D=Rt!`K`;8R``oo7KG|G?fS#VY54?ifhJ%{Dj(%<{&d8y(-mTy(?
zZ1g&u?<6^=QZAug2%WzZsK|+Xv2ahByW`!s7j$=%gone}jgkVBzh_TBKJ+{YzHZ|w
z>yPbE#Y>y;mE{*R^n+btUnu}5KamOX;mXnn0`@`a~6u^jR{TgZ2
zb9h*#mOnUhwj3>g=eIs3)FL7&3?mKwT3}pH2wa=^9=Sd)GrLft*KWw2fnm+Qd5E0f
zM%9H3t4EZ|lH{Oq*i;Wh$GsL_FN)Hc+p)pk)<37n3SP9=s9S^V`=nBW3tAu(|O6zOBSOjU`A*hd+hZIN6lH*U?O0KO9M_%8BaZ=rRd2D
z2oimH8rALzSu*ltG}Cp&#=(i=j}v^{=e|gv)9~Vh{Tj2cYG_OL{5muwwI1~Gw&*e_
z7fTU<5?yK?qu;{B(Yrt$C=`;A@K;5j8&*=nkmtm%9kB3zD)eCAYjmsf$CCO_>JTE_}Bt?YqNfEqwBFz
zXDZmWNsz&NBiGEqWrlrZgsisYHCHRq>@hPcepD@)e;^Z@m&0bo3W?Y1Y@4cQ-x;2O
zB8SA|`m1QD&G3P7!F9U%M1^}T;XV}u52JlCd)OdUT3ZtmIB~tMDhH!kNeTZGwS=RI
zBmR+?L0pe0NsSCc2&#ildc3-fyVLWHpQ-bdjo!Elsg0NCrl%fVNkZ1XvokJth0e9K
zyrt_E*8kD8RrCFi$uGI23=jZ?Xpaqxy+0lohkp=w>~_B1-j)!akAzghTkeR2$J8{5
z$Eh)W@_bht1d6UQr?&PY-BuZF*Tr_rG82hn@v|?
zt<$6W4N@Yw^&(R|O8`pMZ>
z4;kv8uHWA_nC23tR^9Z=FPClDtXnJ
zJy&0EZyf`Cukbh};0dOcAp+(U4!zb0HevxYrDdiBo07k
zm@Sg<-4b6j03Fp|S>(9T7_~?-d;Ng9PQU
zmUE84td4UyW{TI>TAWDb?z_$fYgOvWK(w3ip3Rc$>~#sg+sCfj`6_0(X@*9GzLx@~
zOvVMMaeY4Cl!ky2J^1{GHEW7F>agCs|3Jn0Xlf)oCfCXMSu04Nr`qqPr<(sqBnOoIlLl5|*)~`s
z)q{=(P14{>xS9HAr?m4qj2X?qKa-lElYE8*pmG0Q*lH;_Nip3uG6EbkGl-tO&gM5`
zgYkL_%WofN9&cpE7fY;7s&5%lF^)axqC?iZJUWWd8%c*a318#bS
zAKu@J=Btx_{NRT-r?8F%*npH+9Ni?!9naAn-OUI*eB(gMt^5jBlE4+!RP4dUfJ5yn(RqvH
ze;Lr)T~`*$YraY!#S)u%Ll|DPq`_yOEthDQ&|u3t2@
z0W3-pgKx8W&~oUTlh<~w9UtN5x1aUiPZX&i;!INSfrt)pS)&B>m(89u(Qy9|#XipQ#x0Z^B4v|zlo~F$>Jqg`$~6p*t_)8!
zPz}%e$%bu+h#WW{cb)(nEFYtyr5XB@KJ0NE=OpUG^ICwkH!f$i|Zp#Rt2k0>>6YFU;zybJAViiUdM|
z4mrVC3w*0ti~^4cG^8}G0xD~W04N{2TO*MR{+H=_QyKfsb-i^Laf}8Dcka{!$#-XN
zy$9m&T?M`Nq`2$;jB?kF(hFH2*<&!3p|65&MUUtggY4^V{jI(JnDtceXWGz82goSR
zC<0>j-d)6>*n7wwrd2QLKW08J3a-8}`f9LW>WhHbH`eutNnsLk6}#@X=OH%i{m2;%
z@`36Jn2!O8iqnfR}zkzC85iZlu04y|Yur5pX%Ix+eRA%OI&K
zTa$%2rQ$_@Ps~CZt@?6wB0QI1e$f?2Db|$oyBO1!Kr@um5MWAysaYJCt~L30UjG7M
z``d-O=3_WBW7QA3Gn;QOr*Kvc*~`Ng!|Ph+ThgMjMH2LMi{LuaztUWkBGMfPck4{u
zArsDElOfg;xXZdSO9DPJ6FJ?n!=VH`6?+i5P1llw?U?bnPF)TG*Zs0I7!s=qUR!p3
z!M&=t$H88KHk7qpPeb~lP(l3P(^@w<^*q58FN-YY=okZaIUP$!_06;6V4Sc1A-&^3
zwNO#n;cEzDJ;rsd{4>|jNrz6K;~^)(#-$WniOAw9lfzS9
Date: Tue, 29 Jun 2021 15:09:59 +0300
Subject: [PATCH 79/79] Don't care about type change

---
 src/test-integration/tmc_langs_cli.spec.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/test-integration/tmc_langs_cli.spec.ts b/src/test-integration/tmc_langs_cli.spec.ts
index 9eb1acea..0001f550 100644
--- a/src/test-integration/tmc_langs_cli.spec.ts
+++ b/src/test-integration/tmc_langs_cli.spec.ts
@@ -490,7 +490,7 @@ suite("tmc langs cli spec", function () {
     });
 
     suiteTeardown(function () {
-        server && kill(server.pid);
+        server && kill(server.pid as number);
     });
 });