feat(pfapi): prepare backwards migrations

Author: johannesjo

Diff for: src/app/pfapi/api/migration/migration.service.ts

@@ -67,8 +67,28 @@ export class MigrationService<MD extends ModelCfgs> {
       };
     }
     if (dataInCrossModelVersion > codeModelVersion) {
-      throw new ImpossibleError('Saved model version is higher than current one');
+      // TODO implement migrate down
+      // if (cfg?.crossModelBackwardMigrations) {
+      //   // ...
+      // }
+      throw new ImpossibleError(
+        'Saved model version is higher than current one and no backwards migrations available',
+      );
     }
+
+    return this._migrateUp(codeModelVersion, dataInCrossModelVersion, dataIn);
+  }
+
+  private async _migrateUp(
+    codeModelVersion: number,
+    dataInCrossModelVersion: number,
+    dataIn: AllSyncModels<MD>,
+  ): Promise<{
+    dataAfter: AllSyncModels<MD>;
+    versionAfter: number;
+    wasMigrated: boolean;
+  }> {
+    const cfg = this._pfapiMain.cfg;
     if (!cfg?.crossModelMigrations) {
       throw new ImpossibleError('No migration function provided');
     }
@@ -115,12 +135,5 @@ export class MigrationService<MD extends ModelCfgs> {
       pfLog(0, `Migration functions failed to execute`, { error });
       throw new ModelMigrationError('Error running migration functions', error);
     }
-
-    // TODO single model migration
-    // const modelIds = Object.keys(this.m);
-    // for (const modelId of modelIds) {
-    //   const modelCtrl = this.m[modelId];
-    //
-    // }
   }
 }

Diff for: src/app/pfapi/api/pfapi.model.ts

@@ -56,6 +56,11 @@ export interface CrossModelMigrations {
   [version: number]: CrossModelMigrateFn;
 }
 
+export type CrossModelBackwardsMigrateFn = <R, F>(fullData: F) => R;
+export interface CrossModelBackwardsMigrations {
+  [version: number]: CrossModelBackwardsMigrateFn;
+}
+
 export interface PfapiBaseCfg<T extends ModelCfgs> {
   dbAdapter?: DatabaseAdapter;
   onDbError?: (err: any) => void;
@@ -66,6 +71,7 @@ export interface PfapiBaseCfg<T extends ModelCfgs> {
   isCreateBackups?: boolean;
   crossModelVersion?: number;
   crossModelMigrations?: CrossModelMigrations;
+  crossModelBackwardMigrations?: CrossModelBackwardsMigrations;
   validate?: (data: AllModelData<T>) => IValidation<AllModelData<T>>;
   repair?: <R>(data: R | unknown) => AllModelData<T>;
 

Diff for: src/app/pfapi/api/sync/sync.service.ts

@@ -111,13 +111,13 @@ export class SyncService<const MD extends ModelCfgs> {
       switch (status) {
         case SyncStatus.UpdateLocal:
           if (this.IS_DO_CROSS_MODEL_MIGRATIONS) {
-            const mcr = modelVersionCheck({
+            const mvcR = modelVersionCheck({
               // TODO check for problems
               clientVersion:
                 this._pfapiMain.cfg?.crossModelVersion || localMeta.crossModelVersion,
               toImport: remoteMeta.crossModelVersion,
             });
-            switch (mcr) {
+            switch (mvcR) {
               case ModelVersionCheckResult.MinorUpdate:
               case ModelVersionCheckResult.MajorUpdate:
                 alert('Downloading all since cross model version changed');