feat: Adds getMigrations to RepoFacade. (#5)

ryasmi · web-flow · commit bedc4b7147cb · 2018-03-13T17:37:46.000Z
BREAKING CHANGE: Adds `getMigrations` to `RepoFacade`.
diff --git a/readme.md b/readme.md
@@ -3,3 +3,14 @@
 
 ### Usage
 1. Install it with `npm i @js-migrations/core`.
+1. [Use the factory to create the service facade](#use-the-factory).
+
+### Use the factory
+```typescript
+import migrationsServiceFactory from '@js-migrations/core/dist/factory';
+
+const migrationsServiceFacade = migrationsServiceFactory({
+  log: console.log.bind(console),
+  repo: migrationsRepoFacade,
+});
+```
diff --git a/src/FacadeConfig.ts b/src/FacadeConfig.ts
@@ -1,8 +1,6 @@
 import RepoFacade from './RepoFacade';
-import MigrationDictionary from './utils/types/MigrationDictionary';
 
 export default interface FacadeConfig {
   readonly repo: RepoFacade;
   readonly log: (message: string) => void;
-  readonly migrations: MigrationDictionary;
 }
diff --git a/src/RepoFacade.ts b/src/RepoFacade.ts
@@ -1,6 +1,8 @@
+import MigrationDictionary from './utils/types/MigrationDictionary';
 import ProcessedMigration from './utils/types/ProcessedMigration';
 
 export default interface RepoFacade {
+  readonly getMigrations: () => Promise<MigrationDictionary>;
   readonly getProcessedMigrations: () => Promise<ProcessedMigration[]>;
   readonly updateProcessedMigration: (migration: ProcessedMigration) => Promise<void>;
   readonly removeProcessedMigration: (key: string) => Promise<void>;
diff --git a/src/factory.test.ts b/src/factory.test.ts
@@ -8,31 +8,36 @@ import ProcessedMigration from './utils/types/ProcessedMigration';
 let processedMigrations: ProcessedMigration[] = []; // tslint:disable-line:no-let
 let hasLockedMigrations = false; // tslint:disable-line:no-let
 
-factoryTest({
-  clearMigrations: async () => {
-    processedMigrations = [];
-  },
-  getProcessedMigrations: async () => {
-    return processedMigrations;
-  },
-  lockMigrations: async () => {
-    if (hasLockedMigrations) {
-      throw new LockedMigrationsError();
-    }
-    hasLockedMigrations = true;
-  },
-  removeProcessedMigration: async (key) => {
-    processedMigrations = processedMigrations.filter((processedMigration) => {
-      return processedMigration.key !== key;
-    });
-  },
-  unlockMigrations: async () => {
-    hasLockedMigrations = false;
-  },
-  updateProcessedMigration: async (migration) => {
-    const unmatchedMigrations = processedMigrations.filter((processedMigration) => {
-      return processedMigration.key !== migration.key;
-    });
-    processedMigrations = [...unmatchedMigrations, migration];
-  },
+factoryTest((migrations) => {
+  return {
+    clearMigrations: async () => {
+      processedMigrations = [];
+    },
+    getMigrations: async () => {
+      return migrations;
+    },
+    getProcessedMigrations: async () => {
+      return processedMigrations;
+    },
+    lockMigrations: async () => {
+      if (hasLockedMigrations) {
+        throw new LockedMigrationsError();
+      }
+      hasLockedMigrations = true;
+    },
+    removeProcessedMigration: async (key) => {
+      processedMigrations = processedMigrations.filter((processedMigration) => {
+        return processedMigration.key !== key;
+      });
+    },
+    unlockMigrations: async () => {
+      hasLockedMigrations = false;
+    },
+    updateProcessedMigration: async (migration) => {
+      const unmatchedMigrations = processedMigrations.filter((processedMigration) => {
+        return processedMigration.key !== migration.key;
+      });
+      processedMigrations = [...unmatchedMigrations, migration];
+    },
+  };
 });
diff --git a/src/factoryTest.ts b/src/factoryTest.ts
@@ -1,18 +1,20 @@
 import migrateTest from './migrate/test';
 import migrateByKeyTest from './migrateByKey/test';
-import RepoFacade from './RepoFacade';
 import rollbackTest from './rollback/test';
 import rollbackByKeyTest from './rollbackByKey/test';
+import TestFactory from './utils/tests/TestFactory';
 
-export default (repo: RepoFacade) => {
+const testFactory: TestFactory = (repoFactory) => {
   describe('factory', () => {
     beforeEach(async () => {
-      await repo.clearMigrations();
+      await repoFactory({}).clearMigrations();
     });
 
-    migrateTest(repo);
-    migrateByKeyTest(repo);
-    rollbackTest(repo);
-    rollbackByKeyTest(repo);
+    migrateTest(repoFactory);
+    migrateByKeyTest(repoFactory);
+    rollbackTest(repoFactory);
+    rollbackByKeyTest(repoFactory);
   });
 };
+
+export default testFactory;
diff --git a/src/migrate/test.ts b/src/migrate/test.ts
@@ -2,20 +2,20 @@ import * as assert from 'assert';
 import * as assertRejects from 'assert-rejects';
 import 'mocha'; // tslint:disable-line:no-import-side-effect
 import factory from '../factory';
-import RepoFacade from '../RepoFacade';
 import FailingMigrationError from '../utils/errors/FailingMigrationError';
 import assertLocked from '../utils/tests/assertLocked';
 import createMigrationProcess from '../utils/tests/createMigrationProcess';
 import createTestUpMigration from '../utils/tests/createTestUpMigration';
+import TestFactory from '../utils/tests/TestFactory';
 import MigrationDictionary from '../utils/types/MigrationDictionary';
 
-export default (repo: RepoFacade) => {
+const testMigrate: TestFactory = (repoFactory) => {
   const successfulMigration = createTestUpMigration();
   const failingMigration = createTestUpMigration(() => { throw new Error(); });
 
   const createService = (migrations: MigrationDictionary) => {
     const log = () => null;
-    return factory({ log, migrations, repo });
+    return factory({ log, repo: repoFactory(migrations) });
   };
 
   describe('migrate', () => {
@@ -79,3 +79,5 @@ export default (repo: RepoFacade) => {
     });
   });
 };
+
+export default testMigrate;
diff --git a/src/migrateByKey/test.ts b/src/migrateByKey/test.ts
@@ -2,22 +2,22 @@ import * as assert from 'assert';
 import * as assertRejects from 'assert-rejects';
 import 'mocha'; // tslint:disable-line:no-import-side-effect
 import factory from '../factory';
-import RepoFacade from '../RepoFacade';
 import FailingMigrationError from '../utils/errors/FailingMigrationError';
 import MissingMigrationError from '../utils/errors/MissingMigrationError';
 import ProcessedMigrationError from '../utils/errors/ProcessedMigrationError';
 import assertLocked from '../utils/tests/assertLocked';
 import createMigrationProcess from '../utils/tests/createMigrationProcess';
 import createTestUpMigration from '../utils/tests/createTestUpMigration';
+import TestFactory from '../utils/tests/TestFactory';
 import MigrationDictionary from '../utils/types/MigrationDictionary';
 
-export default (repo: RepoFacade) => {
+const testMigrateByKey: TestFactory = (repoFactory) => {
   const successfulMigration = createTestUpMigration();
   const failingMigration = createTestUpMigration(() => { throw new Error(); });
 
   const createService = (migrations: MigrationDictionary) => {
     const log = () => null;
-    return factory({ log, migrations, repo });
+    return factory({ log, repo: repoFactory(migrations) });
   };
 
   describe('migrateByKey', () => {
@@ -66,3 +66,5 @@ export default (repo: RepoFacade) => {
     });
   });
 };
+
+export default testMigrateByKey;
diff --git a/src/rollback/test.ts b/src/rollback/test.ts
@@ -2,21 +2,21 @@ import * as assert from 'assert';
 import * as assertRejects from 'assert-rejects';
 import 'mocha'; // tslint:disable-line:no-import-side-effect
 import factory from '../factory';
-import RepoFacade from '../RepoFacade';
 import FailingMigrationError from '../utils/errors/FailingMigrationError';
 import MissingMigrationError from '../utils/errors/MissingMigrationError';
 import assertLocked from '../utils/tests/assertLocked';
 import createMigrationProcess from '../utils/tests/createMigrationProcess';
 import createTestDownMigration from '../utils/tests/createTestDownMigration';
+import TestFactory from '../utils/tests/TestFactory';
 import MigrationDictionary from '../utils/types/MigrationDictionary';
 
-export default (repo: RepoFacade) => {
+const testRollback: TestFactory = (repoFactory) => {
   const successfulMigration = createTestDownMigration();
   const failingMigration = createTestDownMigration(() => { throw new Error(); });
 
   const createService = (migrations: MigrationDictionary) => {
     const log = () => null;
-    return factory({ log, migrations, repo });
+    return factory({ log, repo: repoFactory(migrations) });
   };
 
   describe('rollback', () => {
@@ -91,3 +91,5 @@ export default (repo: RepoFacade) => {
     });
   });
 };
+
+export default testRollback;
diff --git a/src/rollbackByKey/test.ts b/src/rollbackByKey/test.ts
@@ -2,21 +2,21 @@ import * as assert from 'assert';
 import * as assertRejects from 'assert-rejects';
 import 'mocha'; // tslint:disable-line:no-import-side-effect
 import factory from '../factory';
-import RepoFacade from '../RepoFacade';
 import FailingMigrationError from '../utils/errors/FailingMigrationError';
 import UnprocessedMigrationError from '../utils/errors/UnprocessedMigrationError';
 import assertLocked from '../utils/tests/assertLocked';
 import createMigrationProcess from '../utils/tests/createMigrationProcess';
 import createTestDownMigration from '../utils/tests/createTestDownMigration';
+import TestFactory from '../utils/tests/TestFactory';
 import MigrationDictionary from '../utils/types/MigrationDictionary';
 
-export default (repo: RepoFacade) => {
+const testRollbackByKey: TestFactory = (repoFactory) => {
   const successfulMigration = createTestDownMigration();
   const failingMigration = createTestDownMigration(() => { throw new Error(); });
 
   const createService = (migrations: MigrationDictionary) => {
     const log = () => null;
-    return factory({ log, migrations, repo });
+    return factory({ log, repo: repoFactory(migrations) });
   };
 
   describe('rollbackByKey', () => {
@@ -66,3 +66,5 @@ export default (repo: RepoFacade) => {
     });
   });
 };
+
+export default testRollbackByKey;
diff --git a/src/utils/getUnprocessedKeys.ts b/src/utils/getUnprocessedKeys.ts
@@ -3,7 +3,8 @@ import FacadeConfig from '../FacadeConfig';
 
 export default async (config: FacadeConfig) => {
   const processedMigrations = await config.repo.getProcessedMigrations();
+  const migrations = await config.repo.getMigrations();
   const processedKeys = processedMigrations.map(({ key }) => key);
-  const migrationKeys = Object.keys(config.migrations);
+  const migrationKeys = Object.keys(migrations);
   return difference(migrationKeys, processedKeys);
 };
diff --git a/src/utils/migrateKey.ts b/src/utils/migrateKey.ts
@@ -10,7 +10,8 @@ export interface Opts {
 }
 
 export default async ({ config, key, batchStart }: Opts) => {
-  const selectedMigration = getMigrationByKey(config.migrations, key);
+  const migrations = await config.repo.getMigrations();
+  const selectedMigration = getMigrationByKey(migrations, key);
   config.log(`Starting to migrate with ${key}`);
   const migrationStart = new Date();
   try {
diff --git a/src/utils/rollbackKey.ts b/src/utils/rollbackKey.ts
@@ -8,7 +8,8 @@ export interface Opts {
 }
 
 export default async ({ config, key }: Opts) => {
-  const migration = getMigrationByKey(config.migrations, key);
+  const migrations = await config.repo.getMigrations();
+  const migration = getMigrationByKey(migrations, key);
   config.log(`Starting to rollback with ${key}`);
   try {
     await migration.down();
diff --git a/src/utils/tests/TestFactory.ts b/src/utils/tests/TestFactory.ts
@@ -0,0 +1,6 @@
+import RepoFacade from '../../RepoFacade';
+import MigrationDictionary from '../types/MigrationDictionary';
+
+type TestFactory = (repoFactory: (migrations: MigrationDictionary) => RepoFacade) => void;
+
+export default TestFactory;

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,6 @@`
`1`	`1`	`import RepoFacade from './RepoFacade';`
`2`		`-import MigrationDictionary from './utils/types/MigrationDictionary';`
`3`	`2`
`4`	`3`	`export default interface FacadeConfig {`
`5`	`4`	`readonly repo: RepoFacade;`
`6`	`5`	`readonly log: (message: string) => void;`
`7`		`- readonly migrations: MigrationDictionary;`
`8`	`6`	`}`