Close the public api down

AngelMunoz · Mar 30, 2024 · cfdbe30 · cfdbe30
1 parent b7ff942
commit cfdbe30
Show file tree

Hide file tree

Showing 15 changed files with 123 additions and 298 deletions.
diff --git a/src/Migrondi.Core/Database.fs b/src/Migrondi.Core/Database.fs
@@ -24,7 +24,7 @@ open IcedTasks
 
 
 [<Interface>]
-type IMiDatabaseHandler =
+type internal IMiDatabaseHandler =
 
   /// <summary>
   /// Creates the required tables in the database.
@@ -151,7 +151,6 @@ type IMiDatabaseHandler =
     [<Optional>] ?cancellationToken: CancellationToken ->
       Task<MigrationRecord IReadOnlyList>
 
-
 [<RequireQualifiedAccess>]
 module Queries =
   let createTable driver tableName =
@@ -183,7 +182,7 @@ CREATE TABLE dbo.%s{tableName}(
 );
 GO"""
 
-module internal MigrationsImpl =
+module MigrationsImpl =
 
   let getConnection (connectionString: string, driver: MigrondiDriver) =
     match driver with
@@ -666,7 +665,7 @@ module MigrationsAsyncImpl =
     }
 
 [<Class>]
-type MiDatabaseHandler(logger: ILogger, config: MigrondiConfig) =
+type internal MiDatabaseHandler(logger: ILogger, config: MigrondiConfig) =
 
   interface IMiDatabaseHandler with
 

diff --git a/src/Migrondi.Core/Database.fsi b/src/Migrondi.Core/Database.fsi
@@ -17,7 +17,7 @@ open Migrondi.Core
 /// This service also provides both sync and async methods to list, apply and rollback migrations.
 /// </summary>
 [<Interface>]
-type IMiDatabaseHandler =
+type internal IMiDatabaseHandler =
 
   /// <summary>
   /// Creates the required tables in the database.
@@ -141,7 +141,7 @@ module internal MigrationsImpl =
   val getConnection: connectionString: string * driver: MigrondiDriver -> IDbConnection
 
 [<Class>]
-type MiDatabaseHandler =
+type internal MiDatabaseHandler =
 
   /// <summary>
   /// Generates a new database service, this can be further customized by passing in a custom logger

diff --git a/src/Migrondi.Core/FileSystem.fs b/src/Migrondi.Core/FileSystem.fs
@@ -32,157 +32,47 @@ open Units
 
 
 [<Interface>]
-type IMiFileSystem =
-
-  /// <summary>
-  /// Take the path to a configuration source, reads and transforms it into a configuration object
-  /// </summary>
-  /// <param name="readFrom">A path Relative to the RootPath that targets to the configuration file</param>
-  /// <returns>A <see cref="Migrondi.Core.MigrondiConfig">MigrondiConfig</see> object</returns>
-  /// <exception cref="Migrondi.Core.FileSystem.SourceNotFound">
-  /// Thrown when the source is not found
-  /// </exception>
-  /// <exception cref="Migrondi.Core.FileSystem.MalformedSource">
-  /// Thrown when the source is found but can't be deserialized from disk
-  /// </exception>
+type internal IMiFileSystem =
   abstract member ReadConfiguration: readFrom: string -> MigrondiConfig
 
-  /// <summary>
-  /// Take the path to a configuration source, reads and transforms it into a configuration object
-  /// </summary>
-  /// <param name="readFrom">A path Relative to the RootPath that targets to the configuration file</param>
-  /// <param name="cancellationToken">A cancellation token that can be used to cancel the operation</param>
-  /// <returns>
-  /// A Result that may contain a <see cref="Migrondi.Core.MigrondiConfig">MigrondiConfig</see> object
-  /// or a <see cref="Migrondi.Core.FileSystem.ReadFileError">ReadFileError</see>
-  /// </returns>
-  /// <exception cref="Migrondi.Core.FileSystem.SourceNotFound">
-  /// Thrown when the file is not found
-  /// </exception>
-  /// <exception cref="Migrondi.Core.FileSystem.MalformedSource">
-  /// Thrown when the file is found but can't be deserialized from the source
-  /// </exception>
   abstract member ReadConfigurationAsync:
     readFrom: string * [<Optional>] ?cancellationToken: CancellationToken ->
       Task<MigrondiConfig>
 
-  /// <summary>
-  /// Take a configuration object and writes it to a location dictated by the `writeTo` parameter
-  /// </summary>
-  /// <param name="config">The configuration object</param>
-  /// <param name="writeTo">The path to the configuration file</param>
   abstract member WriteConfiguration:
     config: MigrondiConfig * writeTo: string -> unit
 
-  /// <summary>
-  /// Take a configuration object and writes it to a file
-  /// </summary>
-  /// <param name="config">The configuration object</param>
-  /// <param name="writeTo">The path to the configuration file</param>
-  /// <param name="cancellationToken">A cancellation token that can be used to cancel the operation</param>
-  /// <returns>
-  /// A unit result object that means that the operation was successful
-  /// or a <see cref="Migrondi.Core.FileSystem.ReadFileError">ReadFileError</see>
-  /// </returns>
   abstract member WriteConfigurationAsync:
     config: MigrondiConfig *
     writeTo: string *
     [<Optional>] ?cancellationToken: CancellationToken ->
       Task
 
-  /// <summary>
-  /// Takes a path to a migration, reads its contents and transforms it into a Migration object
-  /// </summary>
-  /// <param name="migrationName">A path Relative to the RootPath that targets to the migration</param>
-  /// <returns>
-  /// A Result that may contain a <see cref="Migrondi.Core.Migration">Migration</see> object
-  /// or a <see cref="Migrondi.Core.FileSystem.ReadFileError">ReadFileError</see>
-  /// </returns>
-  /// <exception cref="Migrondi.Core.FileSystem.SourceNotFound">
-  /// Thrown when the file is not found
-  /// </exception>
-  /// <exception cref="Migrondi.Core.FileSystem.MalformedSource">
-  /// Thrown when the file is found but can't be deserialized from the source
-  /// </exception>
   abstract member ReadMigration: migrationName: string -> Migration
 
-  /// <summary>
-  /// Takes a path to a migration, reads its contents and transforms it into a Migration object
-  /// </summary>
-  /// <param name="migrationName">A path Relative to the RootPath that targets to the migration</param>
-  /// <param name="cancellationToken">A cancellation token that can be used to cancel the operation</param>
-  /// <returns>
-  /// A Result that may contain a <see cref="Migrondi.Core.Migration">Migration</see> object
-  /// or a <see cref="Migrondi.Core.FileSystem.ReadFileError">ReadFileError</see>
-  /// </returns>
-  /// <exception cref="Migrondi.Core.FileSystem.SourceNotFound">
-  ///  Thrown when the file is not found
-  /// </exception>
   abstract member ReadMigrationAsync:
     migrationName: string * [<Optional>] ?cancellationToken: CancellationToken ->
       Task<Migration>
 
-  /// <summary>
-  /// Takes a migration and serializes its contents into a location dictated by the path
-  /// </summary>
-  /// <param name="migration">The migration object</param>
-  /// <param name="migrationName">The path to the migration file</param>
-  /// <returns>
-  /// A unit result object that means that the operation was successful
-  /// </returns>
   abstract member WriteMigration:
     migration: Migration * migrationName: string -> unit
 
-  /// <summary>
-  /// Takes a migration and serializes its contents into a location dictated by the path
-  /// </summary>
-  /// <param name="migration">The migration object</param>
-  /// <param name="migrationName">The path to the migration file</param>
-  /// <param name="cancellationToken">A cancellation token that can be used to cancel the operation</param>
-  /// <returns>
-  /// A unit result object that means that the operation was successful
-  /// </returns>
   abstract member WriteMigrationAsync:
     migration: Migration *
     migrationName: string *
     [<Optional>] ?cancellationToken: CancellationToken ->
       Task
 
-  /// <summary>
-  /// Takes a path to a directory-like source, and reads the sql scripts inside it
-  /// </summary>
-  /// <param name="migrationsLocation">A path Relative to the RootPath that targets to the migration.</param>
-  /// <returns>
-  /// A Result that may contain a <see cref="Migrondi.Core.Migration">Migration</see> object
-  /// or a <see cref="Migrondi.Core.FileSystem.ReadFileError">ReadFileError</see>
-  /// </returns>
-  /// <exception cref="System.AggregateException">
-  /// A list of exceptions in case the sources were not readable or malformed
-  /// This normally includes exceptions of the type <see cref="Migrondi.Core.FileSystem.MalformedSource">MalformedSource</see>
-  /// </exception>
   abstract member ListMigrations:
     migrationsLocation: string -> Migration IReadOnlyList
 
-  /// <summary>
-  /// Takes a path to a directory-like source, and reads the sql scripts inside it
-  /// </summary>
-  /// <param name="migrationsLocation">A path Relative to the RootPath that targets to the migration</param>
-  /// <param name="cancellationToken">A cancellation token that can be used to cancel the operation</param>
-  /// <returns>
-  /// A Result that may contain a <see cref="Migrondi.Core.Migration">Migration</see> object
-  /// or a <see cref="Migrondi.Core.FileSystem.ReadFileError">ReadFileError</see>
-  /// </returns>
   abstract member ListMigrationsAsync:
     migrationsLocation: string *
     [<Optional>] ?cancellationToken: CancellationToken ->
       Task<Migration IReadOnlyList>
 
-
-
 module PhysicalFileSystemImpl =
 
-  let nameSchema = Regex(MigrationNameSchema)
-
   let readConfiguration
     (
       serializer: IMiConfigurationSerializer,
@@ -437,10 +327,11 @@ module PhysicalFileSystemImpl =
       let files =
         directory.GetFileSystemInfos()
         |> Array.Parallel.choose(fun file ->
-          if (nameSchema.IsMatch(file.Name)) then
-            Some(file.Name, file.FullName |> File.ReadAllText)
-          else
-            None
+
+          match file.Name with
+          | V0Name _
+          | V1Name _ -> Some(file.Name, file.FullName |> File.ReadAllText)
+          | _ -> None
         )
         |> Array.toList
 
@@ -482,7 +373,10 @@ module PhysicalFileSystemImpl =
         let! files =
           directory.GetFileSystemInfos()
           |> Array.Parallel.choose(fun file ->
-            if (nameSchema.IsMatch(file.Name)) then Some file else None
+            match file.Name with
+            | V1Name _
+            | V0Name _ -> Some file
+            | _ -> None
           )
           |> Array.Parallel.map(fun file -> async {
             let! token = Async.CancellationToken
@@ -517,7 +411,7 @@ module PhysicalFileSystemImpl =
     }
 
 [<Class>]
-type MiFileSystem
+type internal MiFileSystem
   (
     logger: ILogger,
     configurationSerializer: IMiConfigurationSerializer,

diff --git a/src/Migrondi.Core/FileSystem.fsi b/src/Migrondi.Core/FileSystem.fsi
@@ -17,7 +17,7 @@ open Migrondi.Core.Serialization
 /// It provides both sync and async methods to read and write migrondi specific files.
 /// </summary>
 [<Interface>]
-type IMiFileSystem =
+type internal IMiFileSystem =
 
   /// <summary>
   /// Take the path to a configuration source, reads and transforms it into a configuration object
@@ -151,7 +151,7 @@ type IMiFileSystem =
 
 
 [<Class>]
-type MiFileSystem =
+type internal MiFileSystem =
   /// <summary>
   /// Generates a new file system service, this can be further customized by passing in a custom serializer
   /// an absolute Uri to the project root and a relative Uri to the migrations root.