Migrations WIP

Author: Yadro

.vscode/settings.json

@@ -36,5 +36,5 @@
     "*.{css,sass,scss}.d.ts": true
   },
 
-  "cSpell.words": ["Popconfirm", "Sider", "Yadro"]
+  "cSpell.words": ["autorun", "Popconfirm", "Sider", "Yadro"]
 }

src/base/AbstractFactory.ts

@@ -1,9 +1,11 @@
+// ConstructorParameters<typeof SomeClass>
+
 export default abstract class AbstractFactory {
   create<T>(Model: any, data: any): T {
     return new Model(data);
   }
 
-  createList<T>(Model: any, data: any): T[] {
+  createList<M, T>(Model: M, data: any): T[] {
     let items: T[] = [];
 
     data.forEach((json: any) => {

src/base/MigrationRunner.ts

@@ -29,7 +29,7 @@ function migrationAssertShowValidationErrors(
   );
 }
 
-export default class MigrationRunner {
+export default class MigrationRunner<TRes extends SchemaType> {
   private schemaMigrations: SchemaMigration[] = [];
   private ajv: Ajv;
 
@@ -63,7 +63,7 @@ export default class MigrationRunner {
     this.ajv = new Ajv({ allErrors: true });
   }
 
-  runMigration<T extends SchemaType>(data: T) {
+  runMigration<T extends SchemaType>(data: T): TRes {
     let newData: T = data;
     let fromVersion = newData.__version || 0;
     let toVersion = fromVersion !== undefined ? fromVersion + 1 : 1;
@@ -92,7 +92,7 @@ export default class MigrationRunner {
 
     while (true) {
       if (toVersion > latestVersion) {
-        return newData;
+        return newData as TRes;
       }
 
       const migration = this.schemaMigrations.find(

src/base/repositories/AbstractFileRepository.ts

@@ -7,6 +7,7 @@ import { ipcRenderer } from 'electron';
 import FsHelper from '../../helpers/FsHelper';
 import PromiseQueue from '../../helpers/PromiseQueueHelper';
 import { SchemaMigration } from '../../types/SchemaMigration';
+import MigrationRunner from '../MigrationRunner';
 
 const APP_DIR =
   process.env.NODE_ENV === 'development'
@@ -15,19 +16,24 @@ const APP_DIR =
 
 let _appDataPath: string = '';
 
-export default abstract class AbstractFileRepository<T = any> {
+export default abstract class AbstractFileRepository<T = unknown> {
   dirWithProfileData: string = 'profile1';
   fileName: string = 'defaultFileName.json';
   saveInRoot: boolean = false;
   schemaMigrations: SchemaMigration[] = [];
 
   private writeFileQueue = new PromiseQueue();
+  private migrationRunner: MigrationRunner<T>;
 
   private get logPrefix() {
     const filePath = !this.saveInRoot ? this.dirWithProfileData : '';
     return `FileRepository [${filePath}/${this.fileName}]:`;
   }
 
+  constructor() {
+    this.migrationRunner = new MigrationRunner(this.schemaMigrations);
+  }
+
   static get appDataFolder() {
     if (_appDataPath) {
       return _appDataPath;
@@ -58,6 +64,7 @@ export default abstract class AbstractFileRepository<T = any> {
       const data = fs.readFileSync(this.filePath, { encoding: 'utf-8' });
       // TODO handle parse error. Backup file with issues and return defaultValue
       const parsedData = JSON.parse(data);
+      return this.migrationRunner.runMigration(parsedData);
     }
     return defaultValue;
   }

src/modules/projects/ProjectFactory.ts

@@ -2,12 +2,12 @@ import AbstractFactory from '../../base/AbstractFactory';
 import ProjectModel, {
   DEFAULT_PROJECT_ID,
   DEFAULT_PROJECTS,
-  IJsonProjectItem,
 } from './models/ProjectModel';
 import { Features } from '../../config';
+import { ProjectTypeV1 } from './types/ProjectTypeV1';
 
 export default class ProjectFactory extends AbstractFactory {
-  createProjects(projectItems: IJsonProjectItem[]): ProjectModel[] {
+  createProjects(projectItems: ProjectTypeV1[]): ProjectModel[] {
     if (Features.myDay) {
       const hasMyDay = projectItems.find(
         (p) => p.key === DEFAULT_PROJECT_ID.MyDay

src/modules/projects/ProjectRepository.ts

@@ -1,8 +1,10 @@
 import AbstractFileRepository from '../../base/repositories/AbstractFileRepository';
-import { IJsonProjectItem } from './models/ProjectModel';
+import { schemaMigrations } from './migrations';
+import { ProjectDataV1 } from './types';
 
 export default class ProjectRepository extends AbstractFileRepository<
-  IJsonProjectItem[]
+  ProjectDataV1
 > {
   fileName = 'projects.json';
+  schemaMigrations = schemaMigrations;
 }

src/modules/projects/ProjectService.ts

@@ -1,23 +1,22 @@
-import ProjectModel, {
-  DEFAULT_PROJECTS,
-  IJsonProjectItem,
-} from './models/ProjectModel';
+import { toJS } from 'mobx';
+import ProjectModel, { IJsonProjectItem } from './models/ProjectModel';
 import ProjectFactory from './ProjectFactory';
 import ProjectRepository from './ProjectRepository';
 import AbstractServiceWithProfile from '../../base/AbstractServiceWithProfile';
 import TreeModelHelper from '../../helpers/TreeModelHelper';
-import { toJS } from 'mobx';
+import DEFAULT_PROJECTS from './models/DefaultProjects';
+import { ProjectDataV0, ProjectDataV1 } from './types';
 
 export default class ProjectService extends AbstractServiceWithProfile<
-  ProjectModel[]
+  ProjectDataV0
 > {
   private factory = new ProjectFactory();
   protected repository = new ProjectRepository();
 
   getAll(): ProjectModel[] {
     const data = this.repository.restore(DEFAULT_PROJECTS);
     ProjectService.fillParent(data);
-    return this.factory.createProjects(data);
+    return this.factory.createProjects(data.data);
   }
 
   save(data: ProjectModel[]): void {
@@ -26,8 +25,8 @@ export default class ProjectService extends AbstractServiceWithProfile<
     this.repository.save(copyData);
   }
 
-  private static fillParent(data: IJsonProjectItem[]) {
-    TreeModelHelper.fillParent(data);
+  private static fillParent(data: ProjectDataV1) {
+    TreeModelHelper.fillParent(data.data);
   }
 
   private static clearParent(data: ProjectModel[]) {

src/modules/projects/ProjectStore.ts

@@ -30,7 +30,10 @@ export default class ProjectStore {
 
   set(projects: ProjectModel[]) {
     this.projects = projects;
-    this.projectService.save(this.projects);
+    this.projectService.save({
+      __version: 1,
+      data: this.projects,
+    });
   }
 
   setEditableProject(project?: ProjectModel) {

src/modules/projects/ProjectTypes.ts

@@ -0,0 +1,4 @@
+export enum DEFAULT_PROJECT_ID {
+  MyDay = '0',
+  Inbox = '1',
+}