Upd migration, added tests

Author: Yadro

.vscode/settings.json

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

src/base/MigrationRunner.test.ts

@@ -5,6 +5,15 @@ import MigrationErrorCodes from '../types/MigrationErrorCodes';
 
 describe('MigrationRunner tests', () => {
   describe('Constructor tests', () => {
+    test(`Should be fine`, () => {
+      expect(
+        new MigrationRunner([
+          { version: 0, schema: {} },
+          { version: 1, schema: {}, migration: () => null },
+        ])
+      ).toBeDefined();
+    });
+
     test(`Throw ErrorCode=${MigrationErrorCodes.NoMigrations} NoMigrations`, () => {
       expect(() => new MigrationRunner([])).toThrow(
         `schemaMigrations can't be empty`
@@ -29,66 +38,79 @@ describe('MigrationRunner tests', () => {
   });
 
   describe('Migration tests', () => {
-    test('Test migration with 3 iterations', () => {
-      type TypeV0 = { data: number };
-      type TypeV1 = { data: number[]; __version: number };
-      type TypeV2 = {
-        data: number[];
-        additionalData: string;
-        __version: number;
-      };
-      const schemaV0: JSONSchemaType<TypeV0> = {
-        type: 'object',
-        properties: {
-          data: { type: 'number' },
+    type TypeV0 = { data: number };
+    type TypeV1 = { data: number[]; __version: number };
+    type TypeV2 = {
+      data: number[];
+      additionalData: string;
+      __version: number;
+    };
+    const schemaV0: JSONSchemaType<TypeV0> = {
+      type: 'object',
+      properties: {
+        data: { type: 'number' },
+      },
+      required: ['data'],
+    };
+    const schemaV1: JSONSchemaType<TypeV1> = {
+      type: 'object',
+      properties: {
+        __version: { type: 'number' },
+        data: { type: 'array', items: { type: 'number' } },
+      },
+      required: ['data', '__version'],
+    };
+    const schemaV2: JSONSchemaType<TypeV2> = {
+      type: 'object',
+      properties: {
+        __version: { type: 'number' },
+        data: { type: 'array', items: { type: 'number' } },
+        additionalData: { type: 'string' },
+      },
+      required: ['data', '__version', 'additionalData'],
+    };
+    const migrations: SchemaMigration[] = [
+      { version: 0, schema: schemaV0 },
+      {
+        version: 1,
+        schema: schemaV1,
+        migration(item: TypeV0): TypeV1 {
+          return {
+            data: [item.data],
+            __version: 1,
+          };
         },
-        required: ['data'],
-      };
-      const schemaV1: JSONSchemaType<TypeV1> = {
-        type: 'object',
-        properties: {
-          __version: { type: 'number' },
-          data: { type: 'array', items: { type: 'number' } },
-        },
-        required: ['data', '__version'],
-      };
-      const schemaV2: JSONSchemaType<TypeV2> = {
-        type: 'object',
-        properties: {
-          __version: { type: 'number' },
-          data: { type: 'array', items: { type: 'number' } },
-          additionalData: { type: 'string' },
+      },
+      {
+        version: 2,
+        schema: schemaV2,
+        migration(item: TypeV1): TypeV2 {
+          return {
+            data: item.data,
+            additionalData: 'test',
+            __version: 2,
+          };
         },
-        required: ['data', '__version', 'additionalData'],
+      },
+    ];
+
+    test('Test migration with 3 iterations', () => {
+      const dataV0: TypeV0 = { data: 777 };
+      const expectedData: TypeV2 = {
+        data: [777],
+        additionalData: 'test',
+        __version: 2,
       };
-      const migrations: SchemaMigration[] = [
-        { version: 0, schema: schemaV0 },
-        {
-          version: 1,
-          schema: schemaV1,
-          migration(item: TypeV0): TypeV1 {
-            return {
-              data: [item.data] as number[],
-              __version: 1,
-            };
-          },
-        },
-        {
-          version: 2,
-          schema: schemaV2,
-          migration(item: TypeV1): TypeV2 {
-            return {
-              data: item.data,
-              additionalData: 'test',
-              __version: 2,
-            };
-          },
-        },
-      ];
+      const mr = new MigrationRunner(migrations);
 
-      const dataV0: TypeV0 = { data: 77 };
+      const resultData = mr.runMigration(dataV0);
+      expect(resultData).toStrictEqual(expectedData);
+    });
+
+    test('Test continue migration', () => {
+      const dataV0: TypeV1 = { data: [777], __version: 1 };
       const expectedData: TypeV2 = {
-        data: [77],
+        data: [777],
         additionalData: 'test',
         __version: 2,
       };
@@ -97,7 +119,9 @@ describe('MigrationRunner tests', () => {
       const resultData = mr.runMigration(dataV0);
       expect(resultData).toStrictEqual(expectedData);
     });
+  });
 
+  describe('Migration errors', () => {
     test(`Throw ErrorCode=${MigrationErrorCodes.ValidationFailed} ValidationFailed`, () => {
       type TypeV0 = { data: number; text: string; prop: { test: 1 } };
 
@@ -123,15 +147,15 @@ describe('MigrationRunner tests', () => {
 
       expect(() => mr.runMigration(dataV0)).toThrow(
         [
-          'Migration to version=0. Schema validation error. Found next errors:',
+          'Migration to version=1. Schema validation error. Found next errors:',
           '"/": "must have required property \'data\'"',
           '"/text": "must be string"',
           '"/prop": "must have required property \'test\'"',
         ].join('\n')
       );
     });
 
-    test(`Throw ErrorCode=${MigrationErrorCodes.MigrationNotFound} MigrationNotFound`, () => {
+    test(`Throw ErrorCode=${MigrationErrorCodes.MigrationNotFound} MigrationNotFound - no migration for version=1`, () => {
       type TypeV0 = { data: number };
 
       const schemaV0: JSONSchemaType<TypeV0> = {
@@ -152,7 +176,7 @@ describe('MigrationRunner tests', () => {
       const mr = new MigrationRunner(migrations);
 
       expect(() => mr.runMigration(dataV0)).toThrow(
-        /Migration {undefined->\d} not found/
+        /Migration {\d->\d} not found/
       );
     });