Improved globalstorage versioning

src/actions/addNewCourse.ts

@@ -1,4 +1,4 @@
-import { LocalCourseData } from "../api/storage";
+import { v2 as storage } from "../storage/data";
 import { Logger } from "../utilities";
 import { combineApiExerciseData } from "../utilities/apiData";
 import { refreshLocalExercises } from "./refreshLocalExercises";
@@ -32,7 +32,7 @@ export async function addNewCourse(
         awardedPoints += x.awarded_points.length;
     });
 
-    const localData: LocalCourseData = {
+    const localData: storage.LocalCourseData = {
         description: courseData.details.description || "",
         exercises: combineApiExerciseData(courseData.details.exercises, courseData.exercises),
         id: courseData.details.id,

src/actions/user.ts

@@ -3,12 +3,12 @@
  * Group of actions that respond to the user.
  * -------------------------------------------------------------------------------------------------
  */
-import { LocalCourseData } from "../api/storage";
 import { WorkspaceExercise } from "../api/workspaceManager";
 import { EXAM_TEST_RESULT, NOTIFICATION_DELAY } from "../config/constants";
 import { BottleneckError } from "../errors";
 import { randomPanelId, TmcPanel } from "../panels/TmcPanel";
 import { ExerciseSubmissionPanel, ExerciseTestsPanel, TestResultData } from "../shared/shared";
+import { v2 as storage } from "../storage/data";
 import { Logger, parseFeedbackQuestion } from "../utilities/";
 import { getActiveEditorExecutablePath } from "../window";
 import { downloadNewExercisesForCourse } from "./downloadNewExercisesForCourse";
@@ -257,7 +257,7 @@ export async function submitExercise(
 
     const courseData = userData.val.getCourseByName(
         exercise.courseSlug,
-    ) as Readonly<LocalCourseData>;
+    ) as Readonly<storage.LocalCourseData>;
     await checkForCourseUpdates(actionContext, courseData.id);
     vscode.commands.executeCommand("tmc.updateExercises", "silent");
 
@@ -321,13 +321,13 @@ export async function checkForCourseUpdates(
     const courses = courseId ? [userData.val.getCourse(courseId)] : userData.val.getCourses();
     const filteredCourses = courses.filter((c) => c.notifyAfter <= Date.now());
     Logger.info(`Checking for course updates for courses ${filteredCourses.map((c) => c.name)}`);
-    const updatedCourses: LocalCourseData[] = [];
+    const updatedCourses: storage.LocalCourseData[] = [];
     for (const course of filteredCourses) {
         await updateCourse(actionContext, course.id);
         updatedCourses.push(userData.val.getCourse(course.id));
     }
 
-    const handleDownload = async (course: LocalCourseData): Promise<void> => {
+    const handleDownload = async (course: storage.LocalCourseData): Promise<void> => {
         const downloadResult = await downloadNewExercisesForCourse(actionContext, course.id);
         if (downloadResult.err) {
             dialog.errorNotification(

src/commands/switchWorkspace.ts

@@ -1,6 +1,6 @@
 import * as actions from "../actions";
 import { ActionContext } from "../actions/types";
-import { LocalCourseData } from "../api/storage";
+import { v2 as storage } from "../storage/data";
 import { Logger } from "../utilities";
 import * as vscode from "vscode";
 
@@ -16,7 +16,7 @@ export async function switchWorkspace(actionContext: ActionContext): Promise<voi
     const currentWorkspace = vscode.workspace.name?.split(" ")[0];
     const courseWorkspace = await dialog.selectItem(
         "Select a course workspace to open",
-        ...courses.map<[string, LocalCourseData]>((c) => [
+        ...courses.map<[string, storage.LocalCourseData]>((c) => [
             c.name === currentWorkspace ? `${c.name} (Currently open)` : c.name,
             c,
         ]),

src/config/settings.ts

@@ -1,4 +1,5 @@
-import Storage, { SessionState } from "../api/storage";
+import Storage from "../storage";
+import { v2 as storage } from "../storage/data";
 import { Logger, LogLevel } from "../utilities/logger";
 import * as vscode from "vscode";
 
@@ -31,7 +32,7 @@ export default class Settings implements vscode.Disposable {
      */
     private readonly _storage: Storage;
 
-    private _state: SessionState;
+    private _state: storage.SessionState;
     private _disposables: vscode.Disposable[];
 
     constructor(storage: Storage) {

src/config/userdata.ts

@@ -1,10 +1,11 @@
-import Storage, { LocalCourseData, LocalCourseExercise } from "../api/storage";
+import Storage from "../storage";
+import { v2 as storage } from "../storage/data";
 import { Logger } from "../utilities/logger";
 import * as _ from "lodash";
 import { Err, Ok, Result } from "ts-results";
 
 export class UserData {
-    private _courses: Map<number, LocalCourseData>;
+    private _courses: Map<number, storage.LocalCourseData>;
     private _passedExercises: Set<number> = new Set();
     private _storage: Storage;
     constructor(storage: Storage) {
@@ -25,23 +26,23 @@ export class UserData {
         this._storage = storage;
     }
 
-    public getCourses(): LocalCourseData[] {
+    public getCourses(): storage.LocalCourseData[] {
         return Array.from(this._courses.values());
     }
 
-    public getCourse(id: number): Readonly<LocalCourseData> {
+    public getCourse(id: number): Readonly<storage.LocalCourseData> {
         const course = this._courses.get(id);
-        return course as LocalCourseData;
+        return course as storage.LocalCourseData;
     }
 
-    public getCourseByName(name: string): Readonly<LocalCourseData> {
+    public getCourseByName(name: string): Readonly<storage.LocalCourseData> {
         return this.getCourses().filter((x) => x.name === name)[0];
     }
 
     public getExerciseByName(
         courseSlug: string,
         exerciseName: string,
-    ): Readonly<LocalCourseExercise> | undefined {
+    ): Readonly<storage.LocalCourseExercise> | undefined {
         for (const course of this._courses.values()) {
             if (course.name === courseSlug) {
                 return course.exercises.find((x) => x.name === exerciseName);
@@ -62,7 +63,7 @@ export class UserData {
         }
     }
 
-    public addCourse(data: LocalCourseData): void {
+    public addCourse(data: storage.LocalCourseData): void {
         if (this._courses.has(data.id)) {
             throw new Error("Trying to add an already existing course");
         }
@@ -76,7 +77,7 @@ export class UserData {
         this._updatePersistentData();
     }
 
-    public async updateCourse(data: LocalCourseData): Promise<void> {
+    public async updateCourse(data: storage.LocalCourseData): Promise<void> {
         if (!this._courses.has(data.id)) {
             throw new Error("Trying to fetch course that doesn't exist.");
         }
@@ -86,7 +87,7 @@ export class UserData {
 
     public async updateExercises(
         courseId: number,
-        exercises: LocalCourseExercise[],
+        exercises: storage.LocalCourseExercise[],
     ): Promise<Result<void, Error>> {
         const courseData = this._courses.get(courseId);
         if (!courseData) {

src/extension.ts

@@ -2,7 +2,6 @@ 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";
 import TMC from "./api/tmc";
 import WorkspaceManager from "./api/workspaceManager";
 import {
@@ -16,8 +15,8 @@ import Settings from "./config/settings";
 import { UserData } from "./config/userdata";
 import { EmptyLangsResponseError, HaltForReloadError } from "./errors";
 import * as init from "./init";
-import { migrateExtensionDataFromPreviousVersions } from "./migrate";
 import { randomPanelId, TmcPanel } from "./panels/TmcPanel";
+import Storage from "./storage";
 import UI from "./ui/ui";
 import { cliFolder, Logger, LogLevel, semVerCompare } from "./utilities";
 import * as path from "path";
@@ -109,9 +108,8 @@ async function activateInner(context: vscode.ExtensionContext): Promise<void> {
     // migrate data between versions
     const storage = new Storage(context);
     if (tmc.ok) {
-        const migrationResult = await migrateExtensionDataFromPreviousVersions(
+        const migrationResult = await storage.migrateToLatest(
             context,
-            storage,
             dialog,
             tmc.val,
             vscode.workspace.getConfiguration(),

src/init/resources.ts

@@ -1,6 +1,6 @@
-import Storage from "../api/storage";
 import { EXTENSION_ID, WORKSPACE_ROOT_FILE_TEXT, WORKSPACE_SETTINGS } from "../config/constants";
 import Resources from "../config/resources";
+import Storage from "../storage";
 import { Logger } from "../utilities/logger";
 import * as fs from "fs-extra";
 import * as path from "path";

src/migrate/index.ts

@@ -1,5 +1,4 @@
 import Dialog from "../api/dialog";
-import Storage from "../api/storage";
 import TMC from "../api/tmc";
 import {
     WORKSPACE_ROOT_FILE_NAME,
@@ -8,7 +7,7 @@ import {
     WORKSPACE_SETTINGS,
 } from "../config/constants";
 import { HaltForReloadError } from "../errors";
-import migrateExerciseData from "./migrateExerciseData";
+import migrateExerciseDataToLatest from "../storage/migration/exerciseData";
 import migrateExtensionSettings from "./migrateExtensionSettings";
 import migrateSessionState from "./migrateSessionState";
 import migrateUserData from "./migrateUserData";
@@ -50,7 +49,7 @@ export async function migrateExtensionDataFromPreviousVersions(
         const migratedUserData = migrateUserData(memento);
 
         // Workspace data migration - this one is a bit more tricky so do it last.
-        const migratedExerciseData = await migrateExerciseData(memento, dialog, tmc);
+        const migratedExerciseData = await migrateExerciseDataToLatest(memento, dialog, tmc);
 
         await storage.updateExtensionSettings(migratedExtensionSettings.data);
         await storage.updateSessionState(migratedSessionState.data);

src/migrate/migrateExtensionSettings.ts

@@ -1,6 +1,5 @@
+import validateData, { MigratedData } from "../storage/migration";
 import { semVerCompare } from "../utilities";
-import { MigratedData } from "./types";
-import validateData from "./validateData";
 import { createIs } from "typia";
 import * as vscode from "vscode";
 

src/migrate/migrateSessionState.ts

@@ -1,5 +1,4 @@
-import { MigratedData } from "./types";
-import validateData from "./validateData";
+import validateData, { MigratedData } from "../storage/migration";
 import { createIs } from "typia";
 import * as vscode from "vscode";
 

src/migrate/migrateUserData.ts

@@ -1,11 +1,10 @@
-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";
+import { LocalCourseData } from "../storage/data";
+import validateData, { MigratedData } from "../storage/migration";
 import { createIs } from "typia";
 import * as vscode from "vscode";