@deterministic-code/migraters 0.0.4 → 0.0.6

package/typescript/src/migrater.ts

@@ -7,7 +7,7 @@ import type {
   SetupArg,
   UpArg,
 } from './abstractions/migrater.ts';
-import type { ISqlDialect } from './abstractions/sql-dialect.ts';
+import type { IDatasourceProvider } from './abstractions/datasource-provider.ts';
 import { isMigrationName, nextSequence, pad4 } from './create-sequence.ts';
 import { applyOneDown, applyOneUp, discoverMigrations } from './datasource-migrate.ts';
 import { defaultDialectFactory } from './infrastructure/default-factory.ts';
@@ -16,56 +16,40 @@ import { fillTemplate, loadMessage, loadScaffold } from './infrastructure/messag
 const invalidNameTpl = await loadMessage('errors/invalid-name');
 
 export class Migrater implements IMigrater {
-  constructor(private readonly dialect: ISqlDialect) {}
+  constructor(private readonly provider: IDatasourceProvider) {}
 
   get name(): string {
-    return this.dialect.name;
+    return this.provider.name;
   }
 
   async setup({ connection, migrationsPath }: SetupArg): Promise<void> {
-    await this.dialect.prepareSetup(connection);
-    const client = await this.dialect.createClient(connection);
-    try {
-      await client.exec(this.dialect.migratesDdl);
-      await client.exec(this.dialect.migrateLogsDdl);
-      await mkdir(migrationsPath, { recursive: true });
-    } finally {
-      await client.close();
-    }
+    await this.provider.prepareSetup(connection);
+    await this.provider.setup(connection);
+    await mkdir(migrationsPath, { recursive: true });
   }
 
   async up({ connection, migrationsPath, one = false }: UpArg): Promise<string[]> {
-    const client = await this.dialect.createClient(connection);
-    try {
-      const migrations = await discoverMigrations({
-        migratePath: migrationsPath,
-        dialect: this.dialect.name,
-      });
-      const applied: string[] = [];
-      for (;;) {
-        const result = await applyOneUp({ client, migrations });
-        if (!result.applied || result.name == null) break;
-        applied.push(result.name);
-        if (one) break;
-      }
-      return applied;
-    } finally {
-      await client.close();
+    const migrations = await discoverMigrations({
+      migratePath: migrationsPath,
+      dialect: this.provider.name,
+    });
+    const applied: string[] = [];
+    for (;;) {
+      const result = await applyOneUp({ provider: this.provider, connection, migrations });
+      if (!result.applied || result.name == null) break;
+      applied.push(result.name);
+      if (one) break;
     }
+    return applied;
   }
 
   async down({ connection, migrationsPath }: DownArg): Promise<string | null> {
-    const client = await this.dialect.createClient(connection);
-    try {
-      const migrations = await discoverMigrations({
-        migratePath: migrationsPath,
-        dialect: this.dialect.name,
-      });
-      const result = await applyOneDown({ client, migrations });
-      return result.rolledBack ? result.name : null;
-    } finally {
-      await client.close();
-    }
+    const migrations = await discoverMigrations({
+      migratePath: migrationsPath,
+      dialect: this.provider.name,
+    });
+    const result = await applyOneDown({ provider: this.provider, connection, migrations });
+    return result.rolledBack ? result.name : null;
   }
 
   async create({ name, migrationsPath }: CreateArg): Promise<CreateResponse> {
@@ -79,11 +63,16 @@ export class Migrater implements IMigrater {
     } catch (err) {
       if (!(err instanceof Error && 'code' in err && err.code === 'ENOENT')) throw err;
     }
-    const seq = pad4(nextSequence(entries));
-    const upName = `${seq}_${name}_up.sql`;
-    const downName = `${seq}_${name}_down.sql`;
-    await writeFile(`${migrationsPath}/${upName}`, await loadScaffold('up', { name }));
-    await writeFile(`${migrationsPath}/${downName}`, await loadScaffold('down', { name }));
+    const seq = nextSequence(entries);
+    const prefix = pad4(seq);
+    const upName = `${prefix}_${name}_up.sql`;
+    const downName = `${prefix}_${name}_down.sql`;
+    const [upBody, downBody] = await Promise.all([
+      loadScaffold('up', { name }),
+      loadScaffold('down', { name }),
+    ]);
+    await writeFile(`${migrationsPath}/${upName}`, upBody);
+    await writeFile(`${migrationsPath}/${downName}`, downBody);
     return { upName, downName };
   }
 }

package/typescript/src/setup-sql.test.ts

@@ -3,10 +3,12 @@ import { getMigrater } from './migrater.ts';
 import { defaultDialectFactory } from './infrastructure/default-factory.ts';
 
 describe('IMigrater setup bookkeeping', () => {
-  it('loads the shared DDL templates for every dialect', () => {
-    for (const dialect of defaultDialectFactory.all()) {
-      expect(dialect.migratesDdl).toMatch(/migrates/i);
-      expect(dialect.migrateLogsDdl).toMatch(/migrate_logs/i);
+  it('loads a provider that implements setup for every dialect', () => {
+    for (const provider of defaultDialectFactory.all()) {
+      expect(provider.name).toBeTruthy();
+      expect(typeof provider.setup).toBe('function');
+      expect(typeof provider.applied).toBe('function');
+      expect(typeof provider.migrateUp).toBe('function');
     }
   });
 

package/typescript/tsconfig.build.json

@@ -15,6 +15,6 @@
     "strict": true,
     "forceConsistentCasingInFileNames": true
   },
-  "include": ["src/**/*.ts", "dialects/*/src/**/*.ts"],
-  "exclude": ["src/**/*.test.ts", "src/generate-help.ts", "dialects/**/*.test.ts"]
+  "include": ["src/**/*.ts", "providers/*/src/**/*.ts", "providers/sql/**/*.ts"],
+  "exclude": ["src/**/*.test.ts", "src/generate-help.ts", "providers/**/*.test.ts"]
 }

package/csharp/Abstractions/ISqlDialect.cs

@@ -1,23 +0,0 @@
-namespace Deterministic.MigrateRunner;
-
-public interface ISqlDialect
-{
-    string Name { get; }
-    IReadOnlyList<string> ConnectionEnvironmentVariables { get; }
-    string MigratesDdl { get; }
-    string MigrateLogsDdl { get; }
-    string SelectAppliedChecksumSql { get; }
-    string InsertAppliedSql { get; }
-    string DeleteAppliedSql { get; }
-    bool UseTransaction { get; }
-    string NowExpr { get; }
-    string LimitClause(int n);
-    string QuoteIdent(string ident);
-    string Placeholder(string name);
-    string NormalizeConnectionString(string connection);
-    DbConnection CreateConnection(string connectionString);
-    string? PrerequisiteError(string connection);
-    void PrepareSetup(string connection);
-    void AddParameter(DbCommand command, string name, object value);
-    Task CreateDatabaseIfMissingAsync(string connection);
-}

package/csharp/Abstractions/ISqlDialectFactory.cs

@@ -1,7 +0,0 @@
-namespace Deterministic.MigrateRunner;
-
-internal interface ISqlDialectFactory
-{
-    bool TryGet(string name, out ISqlDialect dialect);
-    IReadOnlyList<ISqlDialect> All();
-}

package/csharp/Abstractions/SqlDialectFactory.cs

@@ -1,24 +0,0 @@
-namespace Deterministic.MigrateRunner;
-
-internal sealed class SqlDialectFactory(IEnumerable<ISqlDialect> dialects) : ISqlDialectFactory
-{
-    private readonly ISqlDialect[] _all =
-    [
-        .. CliSpec.Providers.Select(name => dialects.FirstOrDefault(d => d.Name == name)).OfType<ISqlDialect>(),
-    ];
-    private readonly IReadOnlyDictionary<string, ISqlDialect> _byName = dialects.ToDictionary(
-        d => d.Name,
-        StringComparer.Ordinal
-    );
-
-    public IReadOnlyList<ISqlDialect> All() => _all;
-
-    public bool TryGet(string name, out ISqlDialect dialect)
-    {
-        var key = MigrateCli.NormalizeProvider(name);
-        if (key is not null && _byName.TryGetValue(key, out dialect!))
-            return true;
-        dialect = null!;
-        return false;
-    }
-}

package/csharp/Dialects/Mysql/MysqlDialect.cs

@@ -1,44 +0,0 @@
-using MySqlConnector;
-
-namespace Deterministic.MigrateRunner;
-
-public static class MysqlDialect
-{
-    // MySQL DDL auto-commits, so wrapping apply + catalog write gives no atomicity.
-    public static readonly ISqlDialect Instance = new SqlDialect(
-        "mysql",
-        ["MYSQL_URL", "DATABASE_URL"],
-        useTransaction: false,
-        NormalizeConnection,
-        s => new MySqlConnection(s),
-        (cmd, n, v) => SqlDialect.Bind(cmd, $"@{n}", v),
-        ident => $"`{ident}`",
-        name => $"@{name}",
-        createDatabase: MysqlCreateDatabase.IfMissingAsync
-    );
-
-    private static string NormalizeConnection(string connection)
-    {
-        if (ConnectionStringUrl.TryUri(connection, "mysql") is not { } url)
-            return connection;
-        var uri = new Uri(url);
-        var b = new MySqlConnectionStringBuilder
-        {
-            Server = uri.Host,
-            Port = (uint)(uri.Port > 0 ? uri.Port : 3306),
-        };
-        ConnectionStringUrl.ApplyUriParts(
-            uri,
-            (u, p) =>
-            {
-                if (u is not null)
-                    b.UserID = u;
-                if (p is not null)
-                    b.Password = p;
-            },
-            db => b.Database = db,
-            (k, v) => b[k] = v
-        );
-        return b.ConnectionString;
-    }
-}

package/csharp/Dialects/Mysql/bin/Debug/net9.0/MigrateMysql.deps.json

@@ -1,213 +0,0 @@
-{
-  "runtimeTarget": {
-    "name": ".NETCoreApp,Version=v9.0",
-    "signature": ""
-  },
-  "compilationOptions": {},
-  "targets": {
-    ".NETCoreApp,Version=v9.0": {
-      "MigrateMysql/1.0.0": {
-        "dependencies": {
-          "MigrateCore": "1.0.0",
-          "MySqlConnector": "2.4.0",
-          "MigrateCore.Reference": "1.0.0.0"
-        },
-        "runtime": {
-          "MigrateMysql.dll": {}
-        }
-      },
-      "DotNetEnv/3.2.0": {
-        "dependencies": {
-          "Microsoft.Extensions.Configuration": "1.1.2",
-          "Microsoft.Extensions.Configuration.Abstractions": "1.1.2",
-          "Superpower": "3.0.0"
-        },
-        "runtime": {
-          "lib/netstandard2.0/DotNetEnv.dll": {
-            "assemblyVersion": "3.2.0.0",
-            "fileVersion": "3.2.0.0"
-          }
-        }
-      },
-      "Microsoft.Extensions.Configuration/1.1.2": {
-        "dependencies": {
-          "Microsoft.Extensions.Configuration.Abstractions": "1.1.2"
-        },
-        "runtime": {
-          "lib/netstandard1.1/Microsoft.Extensions.Configuration.dll": {
-            "assemblyVersion": "1.1.2.0",
-            "fileVersion": "1.1.2.30427"
-          }
-        }
-      },
-      "Microsoft.Extensions.Configuration.Abstractions/1.1.2": {
-        "dependencies": {
-          "Microsoft.Extensions.Primitives": "1.1.1"
-        },
-        "runtime": {
-          "lib/netstandard1.0/Microsoft.Extensions.Configuration.Abstractions.dll": {
-            "assemblyVersion": "1.1.2.0",
-            "fileVersion": "1.1.2.30427"
-          }
-        }
-      },
-      "Microsoft.Extensions.DependencyInjection/9.0.0": {
-        "dependencies": {
-          "Microsoft.Extensions.DependencyInjection.Abstractions": "9.0.0"
-        },
-        "runtime": {
-          "lib/net9.0/Microsoft.Extensions.DependencyInjection.dll": {
-            "assemblyVersion": "9.0.0.0",
-            "fileVersion": "9.0.24.52809"
-          }
-        }
-      },
-      "Microsoft.Extensions.DependencyInjection.Abstractions/9.0.0": {
-        "runtime": {
-          "lib/net9.0/Microsoft.Extensions.DependencyInjection.Abstractions.dll": {
-            "assemblyVersion": "9.0.0.0",
-            "fileVersion": "9.0.24.52809"
-          }
-        }
-      },
-      "Microsoft.Extensions.Logging.Abstractions/8.0.2": {
-        "dependencies": {
-          "Microsoft.Extensions.DependencyInjection.Abstractions": "9.0.0"
-        },
-        "runtime": {
-          "lib/net8.0/Microsoft.Extensions.Logging.Abstractions.dll": {
-            "assemblyVersion": "8.0.0.0",
-            "fileVersion": "8.0.1024.46610"
-          }
-        }
-      },
-      "Microsoft.Extensions.Primitives/1.1.1": {
-        "runtime": {
-          "lib/netstandard1.0/Microsoft.Extensions.Primitives.dll": {
-            "assemblyVersion": "1.1.1.0",
-            "fileVersion": "1.1.1.30427"
-          }
-        }
-      },
-      "MySqlConnector/2.4.0": {
-        "dependencies": {
-          "Microsoft.Extensions.DependencyInjection.Abstractions": "9.0.0",
-          "Microsoft.Extensions.Logging.Abstractions": "8.0.2"
-        },
-        "runtime": {
-          "lib/net9.0/MySqlConnector.dll": {
-            "assemblyVersion": "2.0.0.0",
-            "fileVersion": "2.4.0.0"
-          }
-        }
-      },
-      "Superpower/3.0.0": {
-        "runtime": {
-          "lib/net5.0/Superpower.dll": {
-            "assemblyVersion": "1.0.0.0",
-            "fileVersion": "3.0.0.0"
-          }
-        }
-      },
-      "MigrateCore/1.0.0": {
-        "dependencies": {
-          "DotNetEnv": "3.2.0",
-          "Microsoft.Extensions.DependencyInjection": "9.0.0"
-        },
-        "runtime": {
-          "MigrateCore.dll": {
-            "fileVersion": "0.0.0.0"
-          }
-        }
-      },
-      "MigrateCore.Reference/1.0.0.0": {
-        "runtime": {
-          "MigrateCore.dll": {
-            "assemblyVersion": "1.0.0.0",
-            "fileVersion": "1.0.0.0"
-          }
-        }
-      }
-    }
-  },
-  "libraries": {
-    "MigrateMysql/1.0.0": {
-      "type": "project",
-      "serviceable": false,
-      "sha512": ""
-    },
-    "DotNetEnv/3.2.0": {
-      "type": "package",
-      "serviceable": true,
-      "sha512": "sha512-2q+PD+aJcRW9QuRcIv4F8WbvEDxI6cwxzZJec2i45cBY4cAKCAoW4ZPkApJ7H82wr6Yfmxx/0kb1nLnRmZrGZA==",
-      "path": "dotnetenv/3.2.0",
-      "hashPath": "dotnetenv.3.2.0.nupkg.sha512"
-    },
-    "Microsoft.Extensions.Configuration/1.1.2": {
-      "type": "package",
-      "serviceable": true,
-      "sha512": "sha512-eK5BHx/pHLGGO/WDo7CS070MGgx3N7B/ORO/oKeS0qgCyv+ZAR47YWKXmG5aF+lIrAJd3uJjMTdTKgXTU2UDWw==",
-      "path": "microsoft.extensions.configuration/1.1.2",
-      "hashPath": "microsoft.extensions.configuration.1.1.2.nupkg.sha512"
-    },
-    "Microsoft.Extensions.Configuration.Abstractions/1.1.2": {
-      "type": "package",
-      "serviceable": true,
-      "sha512": "sha512-I1BRk2OCjOondHFc0flHFMxLTbsOPQdB0CxexkZOHcAD1oAWC2KcpxvmmQ07kLUcYKbtSdtvPkm7YPdw8bdJ9Q==",
-      "path": "microsoft.extensions.configuration.abstractions/1.1.2",
-      "hashPath": "microsoft.extensions.configuration.abstractions.1.1.2.nupkg.sha512"
-    },
-    "Microsoft.Extensions.DependencyInjection/9.0.0": {
-      "type": "package",
-      "serviceable": true,
-      "sha512": "sha512-MCPrg7v3QgNMr0vX4vzRXvkNGgLg8vKWX0nKCWUxu2uPyMsaRgiRc1tHBnbTcfJMhMKj2slE/j2M9oGkd25DNw==",
-      "path": "microsoft.extensions.dependencyinjection/9.0.0",
-      "hashPath": "microsoft.extensions.dependencyinjection.9.0.0.nupkg.sha512"
-    },
-    "Microsoft.Extensions.DependencyInjection.Abstractions/9.0.0": {
-      "type": "package",
-      "serviceable": true,
-      "sha512": "sha512-+6f2qv2a3dLwd5w6JanPIPs47CxRbnk+ZocMJUhv9NxP88VlOcJYZs9jY+MYSjxvady08bUZn6qgiNh7DadGgg==",
-      "path": "microsoft.extensions.dependencyinjection.abstractions/9.0.0",
-      "hashPath": "microsoft.extensions.dependencyinjection.abstractions.9.0.0.nupkg.sha512"
-    },
-    "Microsoft.Extensions.Logging.Abstractions/8.0.2": {
-      "type": "package",
-      "serviceable": true,
-      "sha512": "sha512-nroMDjS7hNBPtkZqVBbSiQaQjWRDxITI8Y7XnDs97rqG3EbzVTNLZQf7bIeUJcaHOV8bca47s1Uxq94+2oGdxA==",
-      "path": "microsoft.extensions.logging.abstractions/8.0.2",
-      "hashPath": "microsoft.extensions.logging.abstractions.8.0.2.nupkg.sha512"
-    },
-    "Microsoft.Extensions.Primitives/1.1.1": {
-      "type": "package",
-      "serviceable": true,
-      "sha512": "sha512-MrsHOyFpwT+LBzGWp/Oq3pV1Vku8FYE6hgO+2XR0WBRtoI9EaJcpRbtBabS7pXYrkIN1/LOXACpZ9Stqmbrs6A==",
-      "path": "microsoft.extensions.primitives/1.1.1",
-      "hashPath": "microsoft.extensions.primitives.1.1.1.nupkg.sha512"
-    },
-    "MySqlConnector/2.4.0": {
-      "type": "package",
-      "serviceable": true,
-      "sha512": "sha512-78M+gVOjbdZEDIyXQqcA7EYlCGS3tpbUELHvn6638A2w0pkPI625ixnzsa5staAd3N9/xFmPJtkKDYwsXpFi/w==",
-      "path": "mysqlconnector/2.4.0",
-      "hashPath": "mysqlconnector.2.4.0.nupkg.sha512"
-    },
-    "Superpower/3.0.0": {
-      "type": "package",
-      "serviceable": true,
-      "sha512": "sha512-bjKbAYWePooCAvPxQq+3KnmcLfRggMyRoXmtBMlmCG71bdwBHrO6rmRJ2DRIodg5aztNcxeZXBUVWT+H+MZUhw==",
-      "path": "superpower/3.0.0",
-      "hashPath": "superpower.3.0.0.nupkg.sha512"
-    },
-    "MigrateCore/1.0.0": {
-      "type": "project",
-      "serviceable": false,
-      "sha512": ""
-    },
-    "MigrateCore.Reference/1.0.0.0": {
-      "type": "reference",
-      "serviceable": false,
-      "sha512": ""
-    }
-  }
-}