ordinality
Version:
Universal migrations tools
72 lines (70 loc) • 11.1 kB
JavaScript
import { existsSync } from 'fs';
import path from 'path';
import { z } from 'zod';
import { mkdir, readFile, writeFile } from 'fs/promises';
// TODO: lock file and wait unlock to ensure consistent state when multiple instances in run
export class MigrationFileStorage {
filename;
options;
constructor(filename, options = {}) {
this.filename = filename;
this.options = options;
}
getCodec() {
return (this.options.codec ?? {
encode(data) {
return Buffer.from(JSON.stringify(data, undefined, 2));
},
decode(buffer) {
return JSON.parse(buffer.toString('utf-8'));
},
});
}
getMigrationScheme() {
return z.object({
name: z.string(),
meta: this.options.metaScheme ?? z.void().nullish().optional(),
});
}
getStorageScheme() {
return z.object({
migrations: this.getMigrationScheme().array(),
});
}
async fetchState() {
if (!existsSync(this.filename))
return { migrations: [] };
const fileBuffer = await readFile(this.filename);
const jsonState = this.getCodec().decode(fileBuffer);
return this.getStorageScheme().parse(jsonState);
}
async list() {
const state = await this.fetchState();
return state.migrations.map((migration) => migration.name);
}
async log(uid, context) {
const newState = await this.fetchState();
// Ensure unique name
for (const migration of newState.migrations) {
if (migration.name === uid)
throw new Error(`Migration with name ${uid} is already applied`);
}
// Add and validate
newState.migrations.push({ name: uid, meta: context.meta });
await mkdir(path.dirname(this.filename), { recursive: true });
const verifiedState = this.getStorageScheme().parse(newState);
await writeFile(this.filename, this.getCodec().encode(verifiedState));
}
async unlog(uid) {
const state = await this.fetchState();
// Update migrations list
const filteredMigrations = state.migrations.filter((migration) => migration.name === uid);
if (state.migrations.length === filteredMigrations.length)
throw new Error(`Migration with name ${uid} is not found`);
state.migrations = filteredMigrations;
await mkdir(path.dirname(this.filename), { recursive: true });
const verifiedState = this.getStorageScheme().parse(state);
await writeFile(this.filename, this.getCodec().encode(verifiedState));
}
}
//# sourceMappingURL=data:application/json;charset=utf8;base64,{"version":3,"sources":["storage/MigrationFileStorage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAChC,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAezD,4FAA4F;AAC5F,MAAM,OAAO,oBAAoB;IAId;IACA;IAFlB,YACkB,QAAgB,EAChB,UAYb,EAAE;QAbW,aAAQ,GAAR,QAAQ,CAAQ;QAChB,YAAO,GAAP,OAAO,CAYlB;IACJ,CAAC;IAEM,QAAQ;QACjB,OAAO,CACN,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI;YACrB,MAAM,CAAC,IAAI;gBACV,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;YACxD,CAAC;YACD,MAAM,CAAC,MAAM;gBACZ,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YAC7C,CAAC;SACD,CACD,CAAC;IACH,CAAC;IAES,kBAAkB;QAC3B,OAAO,CAAC,CAAC,MAAM,CAAC;YACf,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;YAChB,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;SAC9D,CAAC,CAAC;IACJ,CAAC;IAES,gBAAgB;QACzB,OAAO,CAAC,CAAC,MAAM,CAAC;YACf,UAAU,EAAE,IAAI,CAAC,kBAAkB,EAAE,CAAC,KAAK,EAAE;SAC7C,CAAC,CAAC;IACJ,CAAC;IAES,KAAK,CAAC,UAAU;QACzB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC;YAAE,OAAO,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;QAE1D,MAAM,UAAU,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACjD,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAErD,OAAO,IAAI,CAAC,gBAAgB,EAAE,CAAC,KAAK,CAAC,SAAS,CAAqB,CAAC;IACrE,CAAC;IAED,KAAK,CAAC,IAAI;QACT,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QAEtC,OAAO,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC5D,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW,EAAE,OAAU;QAChC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QAEzC,qBAAqB;QACrB,KAAK,MAAM,SAAS,IAAI,QAAQ,CAAC,UAAU,EAAE;YAC5C,IAAI,SAAS,CAAC,IAAI,KAAK,GAAG;gBACzB,MAAM,IAAI,KAAK,CAAC,uBAAuB,GAAG,qBAAqB,CAAC,CAAC;SAClE;QAED,mBAAmB;QACnB,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;QAE5D,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAE9D,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAqB,CAAC;QAClF,MAAM,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC;IACvE,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,GAAW;QACtB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QAEtC,yBAAyB;QACzB,MAAM,kBAAkB,GAAG,KAAK,CAAC,UAAU,CAAC,MAAM,CACjD,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,KAAK,GAAG,CACrC,CAAC;QACF,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,KAAK,kBAAkB,CAAC,MAAM;YACxD,MAAM,IAAI,KAAK,CAAC,uBAAuB,GAAG,eAAe,CAAC,CAAC;QAE5D,KAAK,CAAC,UAAU,GAAG,kBAAkB,CAAC;QAEtC,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAE9D,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC,KAAK,CAAC,KAAK,CAAqB,CAAC;QAC/E,MAAM,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC;IACvE,CAAC;CACD","file":"storage/MigrationFileStorage.js","sourcesContent":["import { existsSync } from 'fs';\nimport path from 'path';\nimport { z } from 'zod';\n\nimport { MigrationContext } from '../Migration';\nimport { mkdir, readFile, writeFile } from 'fs/promises';\nimport type { MigrationStorage } from './MigrationStorage';\n\nexport type Codec<T> = {\n\tencode: (data: T) => Buffer;\n\tdecode: (buffer: Buffer) => T;\n};\n\nexport type State<M = void> = {\n\tmigrations: {\n\t\tname: string;\n\t\tmeta: M;\n\t}[];\n};\n\n// TODO: lock file and wait unlock to ensure consistent state when multiple instances in run\nexport class MigrationFileStorage<C extends MigrationContext<any, any>>\n\timplements MigrationStorage<C>\n{\n\tconstructor(\n\t\tprivate readonly filename: string,\n\t\tprivate readonly options: {\n\t\t\t/**\n\t\t\t * Scheme validator for a migration meta\n\t\t\t */\n\t\t\tmetaScheme?: C['meta'] extends z.TypeOf<infer X> ? X : never;\n\n\t\t\t/**\n\t\t\t * Custom logic to encode/decode data\n\t\t\t *\n\t\t\t * By default data will be encoded as JSON string\n\t\t\t */\n\t\t\tcodec?: Codec<State<C['meta']>>;\n\t\t} = {},\n\t) {}\n\n\tprotected getCodec(): Codec<State<C['meta']>> {\n\t\treturn (\n\t\t\tthis.options.codec ?? {\n\t\t\t\tencode(data) {\n\t\t\t\t\treturn Buffer.from(JSON.stringify(data, undefined, 2));\n\t\t\t\t},\n\t\t\t\tdecode(buffer) {\n\t\t\t\t\treturn JSON.parse(buffer.toString('utf-8'));\n\t\t\t\t},\n\t\t\t}\n\t\t);\n\t}\n\n\tprotected getMigrationScheme() {\n\t\treturn z.object({\n\t\t\tname: z.string(),\n\t\t\tmeta: this.options.metaScheme ?? z.void().nullish().optional(),\n\t\t});\n\t}\n\n\tprotected getStorageScheme() {\n\t\treturn z.object({\n\t\t\tmigrations: this.getMigrationScheme().array(),\n\t\t});\n\t}\n\n\tprotected async fetchState() {\n\t\tif (!existsSync(this.filename)) return { migrations: [] };\n\n\t\tconst fileBuffer = await readFile(this.filename);\n\t\tconst jsonState = this.getCodec().decode(fileBuffer);\n\n\t\treturn this.getStorageScheme().parse(jsonState) as State<C['meta']>;\n\t}\n\n\tasync list(): Promise<string[]> {\n\t\tconst state = await this.fetchState();\n\n\t\treturn state.migrations.map((migration) => migration.name);\n\t}\n\n\tasync log(uid: string, context: C): Promise<void> {\n\t\tconst newState = await this.fetchState();\n\n\t\t// Ensure unique name\n\t\tfor (const migration of newState.migrations) {\n\t\t\tif (migration.name === uid)\n\t\t\t\tthrow new Error(`Migration with name ${uid} is already applied`);\n\t\t}\n\n\t\t// Add and validate\n\t\tnewState.migrations.push({ name: uid, meta: context.meta });\n\n\t\tawait mkdir(path.dirname(this.filename), { recursive: true });\n\n\t\tconst verifiedState = this.getStorageScheme().parse(newState) as State<C['meta']>;\n\t\tawait writeFile(this.filename, this.getCodec().encode(verifiedState));\n\t}\n\n\tasync unlog(uid: string): Promise<void> {\n\t\tconst state = await this.fetchState();\n\n\t\t// Update migrations list\n\t\tconst filteredMigrations = state.migrations.filter(\n\t\t\t(migration) => migration.name === uid,\n\t\t);\n\t\tif (state.migrations.length === filteredMigrations.length)\n\t\t\tthrow new Error(`Migration with name ${uid} is not found`);\n\n\t\tstate.migrations = filteredMigrations;\n\n\t\tawait mkdir(path.dirname(this.filename), { recursive: true });\n\n\t\tconst verifiedState = this.getStorageScheme().parse(state) as State<C['meta']>;\n\t\tawait writeFile(this.filename, this.getCodec().encode(verifiedState));\n\t}\n}\n"]}