aboviq/emigrate
1
0
Fork 0
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions

feat(types): move Emigrate types to separate package and improve types (#41)

Browse source 
* feat(types): move Emigrate types to separate package

Also refactor the types to use discriminating unions for easier error handling and such.
Errors passed to storage plugins should now be serialized and storage plugins are expected to return already serialized errors on failed history entries.

* fix(mysql): handle the new type changes

* fix(storage-fs): handle the new type changes

* feat(cli): better error handling and types

Adapt to the new types from the @emigrate/types package, like discriminating union types and serializing and deserializing errors
This commit is contained in:
Joakim Carlstein 2023-12-15 13:03:35 +01:00 • committed by GitHub
parent afe56594c5
commit cae6d11d53
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
38 changed files with 630 additions and 259 deletions
Download patch file Download diff file Expand all files Collapse all files

1
packages/mysql/package.json
View file

@ -38,6 +38,7 @@
"license": "MIT",
"dependencies": {
"@emigrate/plugin-tools": "workspace:*",
"@emigrate/types": "workspace:*",
"mysql2": "3.6.5"
},
"devDependencies": {

28
packages/mysql/src/index.ts
View file

@ -10,6 +10,7 @@ import {
type ResultSetHeader,
type RowDataPacket,
} from 'mysql2/promise';
import { getTimestampPrefix, sanitizeMigrationName } from '@emigrate/plugin-tools';
import {
type MigrationMetadata,
type EmigrateStorage,
@ -19,8 +20,8 @@ import {
type MigrationMetadataFinished,
type GenerateMigrationFunction,
type GeneratorPlugin,
} from '@emigrate/plugin-tools/types';
import { getTimestampPrefix, sanitizeMigrationName, serializeError } from '@emigrate/plugin-tools';
type SerializedError,
} from '@emigrate/types';
const defaultTable = 'migrations';
@ -87,7 +88,7 @@ type HistoryEntry = {
name: string;
status: MigrationStatus;
date: Date;
error?: unknown;
error?: SerializedError;
};
const lockMigration = async (pool: Pool, table: string, migration: MigrationMetadata) => {
@ -117,7 +118,12 @@ const unlockMigration = async (pool: Pool, table: string, migration: MigrationMe
return result.affectedRows === 1;
};
const finishMigration = async (pool: Pool, table: string, migration: MigrationMetadataFinished) => {
const finishMigration = async (
pool: Pool,
table: string,
migration: MigrationMetadataFinished,
_error?: SerializedError,
) => {
const [result] = await pool.execute<ResultSetHeader>({
sql: `
UPDATE
@ -208,12 +214,20 @@ export const createMysqlStorage = ({ table = defaultTable, connection }: MysqlSt
});
for (const row of rows) {
if (row.status === 'failed') {
yield {
name: row.name,
status: row.status,
date: new Date(row.date),
error: row.error ?? { name: 'Error', message: 'Unknown error' },
};
continue;
}
yield {
name: row.name,
status: row.status,
date: new Date(row.date),
// FIXME: Migrate the migrations table to support the error column
error: row.status === 'failed' ? serializeError(new Error('Unknown error reason')) : undefined,
};
}
},
@ -221,7 +235,7 @@ export const createMysqlStorage = ({ table = defaultTable, connection }: MysqlSt
await finishMigration(pool, table, migration);
},
async onError(migration, error) {
await finishMigration(pool, table, { ...migration, status: 'failed', error });
await finishMigration(pool, table, migration, error);
},
async end() {
await pool.end();