@noego/proper 0.2.1 → 0.3.0

package/bin/cli.mjs

@@ -121,7 +121,7 @@ var init_MigrationFilter = __esm({
 });
 
 // framework/errors.ts
-var MigrationError, ConfigurationError, DatabaseConnectionError, MigrationExecutionError, PatchError, PatchValidationError, PatchIntegrityError, PatchConflictError, PatchExecutionError, CLIError;
+var MigrationError, ConfigurationError, DatabaseConnectionError, MigrationStampError, MigrationExecutionError, PatchError, PatchValidationError, PatchIntegrityError, PatchConflictError, PatchExecutionError, CLIError;
 var init_errors = __esm({
   "framework/errors.ts"() {
     MigrationError = class _MigrationError extends Error {
@@ -187,6 +187,16 @@ var init_errors = __esm({
         return new _DatabaseConnectionError(`Authentication failed for ${dbType} database`);
       }
     };
+    MigrationStampError = class _MigrationStampError extends MigrationError {
+      constructor(migrationKey) {
+        super(
+          `Migration '${migrationKey}' cannot be migrated: its timestamp ends in "000", so it does not look like it was generated by 'proper create'. Recreate it with 'proper create <name>' and move the SQL into the generated files.`
+        );
+        this.migrationKey = migrationKey;
+        this.name = "MigrationStampError";
+        Object.setPrototypeOf(this, _MigrationStampError.prototype);
+      }
+    };
     MigrationExecutionError = class _MigrationExecutionError extends MigrationError {
       constructor(message, migrationName, sql, originalError) {
         let fullMessage = `Migration Execution Error${migrationName ? ` in '${migrationName}'` : ""}: ${message}`;
@@ -317,6 +327,79 @@ ${originalError.message}` : message, patchFile, patchKey);
   }
 });
 
+// framework/MigrationManifest.ts
+import fs from "fs";
+import path from "path";
+function isMigrationFile(fileName) {
+  return MIGRATION_FILE_REGEX.test(fileName);
+}
+function canonicalMigrationKey(value) {
+  return value.replace(MIGRATION_FILE_REGEX, "").toLowerCase();
+}
+function mintMigrationStamp(now = Date.now()) {
+  return now % 10 === 0 ? now + 1 : now;
+}
+function isHandStampedKey(key) {
+  const stamp = key.split("_")[0];
+  return /^\d+$/.test(stamp) && /000$/.test(stamp);
+}
+function resolveMigrationFile(directory, baseName, direction, dialect) {
+  const dialectExt = dialect === "sql" ? "mysql" : dialect;
+  const dialectFile = path.join(directory, `${baseName}.${dialectExt}.${direction}.sql`);
+  if (fs.existsSync(dialectFile)) return dialectFile;
+  const genericFile = path.join(directory, `${baseName}.${direction}.sql`);
+  if (fs.existsSync(genericFile)) return genericFile;
+  return null;
+}
+function loadMigrationManifest(directory, dialect) {
+  const manifest = /* @__PURE__ */ new Map();
+  if (!fs.existsSync(directory)) return manifest;
+  const files = fs.readdirSync(directory, { withFileTypes: true }).filter((f) => f.isFile()).map((f) => f.name).filter(isMigrationFile);
+  const uniqueKeys = /* @__PURE__ */ new Set();
+  files.forEach((file) => uniqueKeys.add(canonicalMigrationKey(file)));
+  uniqueKeys.forEach((key) => {
+    manifest.set(key, {
+      key,
+      upFile: resolveMigrationFile(directory, key, "up", dialect),
+      downFile: resolveMigrationFile(directory, key, "down", dialect)
+    });
+  });
+  return manifest;
+}
+var MIGRATION_FILE_REGEX;
+var init_MigrationManifest = __esm({
+  "framework/MigrationManifest.ts"() {
+    MIGRATION_FILE_REGEX = /(?:\.(mysql|sqlite|pg))?\.(up|down)\.(sql|js)$/i;
+  }
+});
+
+// framework/MigrationConfig.ts
+function validateLegacyMigrationKeys(value) {
+  if (value === void 0) {
+    return;
+  }
+  if (!Array.isArray(value) || value.some((key) => !isExactCanonicalMigrationKey(key))) {
+    throw new ConfigurationError(
+      "legacy_migration_keys must be an array of nonempty exact canonical migration keys; filenames, paths, wildcards, and nonstrings are not allowed"
+    );
+  }
+}
+function isExactCanonicalMigrationKey(value) {
+  if (typeof value !== "string" || value.length === 0 || value !== value.trim()) {
+    return false;
+  }
+  if (value.includes("/") || value.includes("\\") || ["*", "?", "[", "]", "{", "}"].some((token) => value.includes(token))) {
+    return false;
+  }
+  return !isMigrationFile(value) && canonicalMigrationKey(value) === value;
+}
+var init_MigrationConfig = __esm({
+  "framework/MigrationConfig.ts"() {
+    init_errors();
+    init_MigrationManifest();
+  }
+});
+
 // framework/MigrationNode.ts
 var MigrationNode, SqlMigrationNode;
 var init_MigrationNode = __esm({
@@ -460,45 +543,6 @@ var init_SqlMigrationBuilder = __esm({
   }
 });
 
-// framework/MigrationManifest.ts
-import fs from "fs";
-import path from "path";
-function isMigrationFile(fileName) {
-  return MIGRATION_FILE_REGEX.test(fileName);
-}
-function canonicalMigrationKey(value) {
-  return value.replace(MIGRATION_FILE_REGEX, "").toLowerCase();
-}
-function resolveMigrationFile(directory, baseName, direction, dialect) {
-  const dialectExt = dialect === "sql" ? "mysql" : dialect;
-  const dialectFile = path.join(directory, `${baseName}.${dialectExt}.${direction}.sql`);
-  if (fs.existsSync(dialectFile)) return dialectFile;
-  const genericFile = path.join(directory, `${baseName}.${direction}.sql`);
-  if (fs.existsSync(genericFile)) return genericFile;
-  return null;
-}
-function loadMigrationManifest(directory, dialect) {
-  const manifest = /* @__PURE__ */ new Map();
-  if (!fs.existsSync(directory)) return manifest;
-  const files = fs.readdirSync(directory, { withFileTypes: true }).filter((f) => f.isFile()).map((f) => f.name).filter(isMigrationFile);
-  const uniqueKeys = /* @__PURE__ */ new Set();
-  files.forEach((file) => uniqueKeys.add(canonicalMigrationKey(file)));
-  uniqueKeys.forEach((key) => {
-    manifest.set(key, {
-      key,
-      upFile: resolveMigrationFile(directory, key, "up", dialect),
-      downFile: resolveMigrationFile(directory, key, "down", dialect)
-    });
-  });
-  return manifest;
-}
-var MIGRATION_FILE_REGEX;
-var init_MigrationManifest = __esm({
-  "framework/MigrationManifest.ts"() {
-    MIGRATION_FILE_REGEX = /(?:\.(mysql|sqlite|pg))?\.(up|down)\.(sql|js)$/i;
-  }
-});
-
 // framework/MigrationDirectoryReader.ts
 import fs2 from "fs";
 var MigrationDirectoryReader;
@@ -1375,6 +1419,7 @@ var MAX_NAME_LENGTH, SCAFFOLD, PatchCreator;
 var init_PatchCreator = __esm({
   "framework/PatchCreator.ts"() {
     init_errors();
+    init_MigrationManifest();
     MAX_NAME_LENGTH = 120;
     SCAFFOLD = `version: 1
 description: TODO
@@ -1421,7 +1466,7 @@ operations: []
         if (!fs5.existsSync(this.patchFolder)) {
           fs5.mkdirSync(this.patchFolder, { recursive: true });
         }
-        let stamp = Date.now();
+        let stamp = mintMigrationStamp();
         for (let attempt = 0; attempt < 1e3; attempt++) {
           const filePath = path4.join(this.patchFolder, `${stamp}_${normalized}.yaml`);
           try {
@@ -1429,7 +1474,7 @@ operations: []
             return filePath;
           } catch (error) {
             if (error && error.code === "EEXIST") {
-              stamp += 1;
+              stamp = mintMigrationStamp(stamp + 1);
               continue;
             }
             throw error;
@@ -1780,6 +1825,7 @@ function makeRunner(database, conn) {
 var MigrationRunnerFactory, MySQLMigrationRunner, FileMigrationConfigReader, MigrationCreator;
 var init_MigrationRunner = __esm({
   "framework/MigrationRunner.ts"() {
+    init_MigrationConfig();
     init_MigrationDirectoryReader();
     init_MigrationSetup();
     init_MigrationFilter();
@@ -1787,6 +1833,8 @@ var init_MigrationRunner = __esm({
     init_PatchRunner();
     init_PatchCreator();
     init_PatchTypes();
+    init_MigrationManifest();
+    init_errors();
     init_SQLRunner();
     init_errors();
     MigrationRunnerFactory = class _MigrationRunnerFactory {
@@ -1934,6 +1982,7 @@ var init_MigrationRunner = __esm({
          */
         this.preflightPromise = null;
         this.lastPatchResults = [];
+        validateLegacyMigrationKeys(config.legacy_migration_keys);
       }
       setup() {
         return __async(this, null, function* () {
@@ -2039,7 +2088,17 @@ var init_MigrationRunner = __esm({
       }
       migrate(migrationNodes, forward) {
         return __async(this, null, function* () {
+          var _a;
           yield this.setup();
+          if (forward) {
+            const legacyMigrationKeys = new Set((_a = this.config.legacy_migration_keys) != null ? _a : []);
+            for (const node of migrationNodes) {
+              const key = node.get_key();
+              if (isHandStampedKey(key) && !legacyMigrationKeys.has(key) && !(yield node.status()).completed) {
+                throw new MigrationStampError(key);
+              }
+            }
+          }
           for (let node of migrationNodes) {
             try {
               if (forward) {
@@ -2135,6 +2194,7 @@ var init_MigrationRunner = __esm({
         try {
           const fileContent = fs6.readFileSync(this.configFile);
           const config = JSON.parse(fileContent.toString());
+          validateLegacyMigrationKeys(config.legacy_migration_keys);
           if (!config.migration_folder) {
             throw ConfigurationError.missingRequiredProperty("migration_folder");
           }
@@ -2177,7 +2237,7 @@ var init_MigrationRunner = __esm({
           if (!fs6.existsSync(this.config.migration_folder)) {
             fs6.mkdirSync(this.config.migration_folder, { recursive: true });
           }
-          const now_timestamp = Date.now();
+          const now_timestamp = mintMigrationStamp();
           const filename_up = `${now_timestamp}_${name}.up.sql`;
           const filename_down = `${now_timestamp}_${name}.down.sql`;
           fs6.writeFileSync(`${this.config.migration_folder}/${filename_up}`, `