@xenon-device-management/xenon 2.15.0 → 2.16.0

package/lib/test/unit/run-migrations-fail-fast.test.js

@@ -8,8 +8,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const chai_1 = require("chai");
+const os_1 = __importDefault(require("os"));
+const path_1 = __importDefault(require("path"));
 const run_migrations_1 = require("../../src/scripts/run-migrations");
 const config_1 = require("../../src/config");
 /**
@@ -22,51 +27,60 @@ const config_1 = require("../../src/config");
  * runMigrations must fail fast, and say what actually happened.
  */
 describe('runMigrations failure handling', () => {
+    // runMigrations reads the database before it chooses a command. A file that
+    // isn't there has no history and is never opened, so nothing here reaches
+    // the server's own database.
+    const scratchFile = path_1.default.join(os_1.default.tmpdir(), `xenon-fail-fast-${process.pid}-absent.db`);
     let originalAutoMigrate;
-    let originalProvider;
+    let originalUrl;
     beforeEach(() => {
         originalAutoMigrate = config_1.config.autoMigrate;
-        originalProvider = config_1.config.databaseProvider;
+        originalUrl = config_1.config.databaseUrl;
         config_1.config.autoMigrate = true;
-        config_1.config.databaseProvider = 'sqlite';
+        config_1.config.databaseUrl = `file:${scratchFile}`;
     });
     afterEach(() => {
         config_1.config.autoMigrate = originalAutoMigrate;
-        config_1.config.databaseProvider = originalProvider;
+        config_1.config.databaseUrl = originalUrl;
     });
+    function failureOf(stderr) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const failingRunner = () => {
+                throw Object.assign(new Error('Command failed'), { stderr: Buffer.from(stderr) });
+            };
+            try {
+                yield (0, run_migrations_1.runMigrations)(failingRunner);
+            }
+            catch (e) {
+                return e;
+            }
+            throw new Error('runMigrations must not swallow the failure');
+        });
+    }
     it('throws instead of swallowing when the schema sync fails', () => __awaiter(void 0, void 0, void 0, function* () {
-        const prismaErr = new Error('Command failed');
-        prismaErr.stderr = Buffer.from('We found changes that cannot be executed:\n' +
+        const thrown = yield failureOf('We found changes that cannot be executed:\n' +
             '  - Added the required column `userId` to the `ApiKey` table without a default value.');
-        const failingRunner = () => {
-            throw prismaErr;
-        };
-        let thrown;
-        try {
-            yield (0, run_migrations_1.runMigrations)(failingRunner);
-        }
-        catch (e) {
-            thrown = e;
-        }
-        (0, chai_1.expect)(thrown, 'runMigrations must not swallow the failure').to.be.an('Error');
+        (0, chai_1.expect)(thrown).to.be.an('Error');
         // The message has to carry the real cause, not just "sync failed".
         (0, chai_1.expect)(thrown.message).to.match(/userId/);
         (0, chai_1.expect)(thrown.message).to.match(/ApiKey/);
+        (0, chai_1.expect)(thrown.message).to.match(/adds a required column to a table that already has rows/);
     }));
     it('names the database so the operator knows what to back up', () => __awaiter(void 0, void 0, void 0, function* () {
-        const failingRunner = () => {
-            throw Object.assign(new Error('Command failed'), { stderr: Buffer.from('boom') });
-        };
-        let thrown;
-        try {
-            yield (0, run_migrations_1.runMigrations)(failingRunner);
-        }
-        catch (e) {
-            thrown = e;
-        }
+        const thrown = yield failureOf('boom');
         (0, chai_1.expect)(thrown).to.be.an('Error');
+        (0, chai_1.expect)(thrown.message).to.include(scratchFile);
         (0, chai_1.expect)(thrown.message).to.match(/XENON_AUTO_MIGRATE/);
     }));
+    // Through 2.15.0 every failure was put down to a required column, P3005
+    // ("The database schema is not empty") included.
+    it("doesn't blame a required column when that isn't the cause", () => __awaiter(void 0, void 0, void 0, function* () {
+        const thrown = yield failureOf('Error: P3005\n\nThe database schema is not empty. Read more about how to baseline an ' +
+            'existing production database: https://pris.ly/d/migrate-baseline');
+        (0, chai_1.expect)(thrown.message).to.not.match(/required column/i);
+        (0, chai_1.expect)(thrown.message).to.match(/P3005/);
+        (0, chai_1.expect)(thrown.message).to.match(/could not bring the database at .* up to date/);
+    }));
     it('resolves normally when the schema sync succeeds', () => __awaiter(void 0, void 0, void 0, function* () {
         let called = false;
         yield (0, run_migrations_1.runMigrations)(() => {