mirror of
https://github.com/outline/outline.git
synced 2026-11-20 21:23:06 +03:00
143 lines
4.1 KiB
TypeScript
143 lines
4.1 KiB
TypeScript
import "./bootstrap";
|
|
import { styleText } from "node:util";
|
|
import type { Transaction } from "sequelize";
|
|
import { isEmpty } from "es-toolkit/compat";
|
|
import { toError, errToString } from "@shared/utils/error";
|
|
import { Second } from "@shared/utils/time";
|
|
import { sleep } from "@shared/utils/timers";
|
|
import env from "@server/env";
|
|
import Logger from "@server/logging/Logger";
|
|
import AuthenticationProvider from "@server/models/AuthenticationProvider";
|
|
import Team from "@server/models/Team";
|
|
import {
|
|
checkConnection,
|
|
migrations,
|
|
sequelize,
|
|
} from "@server/storage/database";
|
|
import { LockHelper } from "@server/storage/LockHelper";
|
|
import { getArg } from "@server/utils/args";
|
|
import { ShutdownHelper } from "@server/utils/ShutdownHelper";
|
|
|
|
/**
|
|
* Checks for pending database migrations and runs them, unless the
|
|
* --no-migrate flag was passed in which case the process exits with an error.
|
|
*/
|
|
async function checkPendingMigrations() {
|
|
let lock: Transaction | undefined;
|
|
try {
|
|
lock = await acquireMigrationsLock();
|
|
|
|
const pending = await migrations.pending();
|
|
if (!isEmpty(pending)) {
|
|
if (getArg("no-migrate")) {
|
|
Logger.fatal(
|
|
styleText(
|
|
"red",
|
|
`Database migrations are pending and were not run because the --no-migrate flag was passed.\nRun the migrations with "yarn db:migrate".`
|
|
),
|
|
new Error("Migrations pending")
|
|
);
|
|
} else {
|
|
Logger.info("database", "Running migrations…");
|
|
await migrations.up();
|
|
}
|
|
}
|
|
await checkDataMigrations();
|
|
} catch (err) {
|
|
const message = errToString(err);
|
|
const error = toError(err);
|
|
if (message.includes("ECONNREFUSED")) {
|
|
Logger.fatal(
|
|
styleText(
|
|
"red",
|
|
`Could not connect to the database. Please check your connection settings.`
|
|
),
|
|
error
|
|
);
|
|
} else {
|
|
Logger.fatal(styleText("red", message), error);
|
|
}
|
|
} finally {
|
|
await lock?.rollback().catch((err) => {
|
|
Logger.warn("Failed to release migrations lock", toError(err));
|
|
});
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Acquires the migrations lock, waiting while another instance holds it. The
|
|
* lock is held by the returned transaction until it ends, while the migrations
|
|
* themselves run on other connections.
|
|
*
|
|
* @returns the transaction that holds the lock.
|
|
*/
|
|
async function acquireMigrationsLock(): Promise<Transaction> {
|
|
let isWaiting = false;
|
|
|
|
for (;;) {
|
|
const transaction = await sequelize.transaction();
|
|
try {
|
|
if (await LockHelper.tryAcquire(sequelize, "migrations", transaction)) {
|
|
return transaction;
|
|
}
|
|
} catch (err) {
|
|
await transaction.rollback();
|
|
throw err;
|
|
}
|
|
|
|
// Poll instead of blocking, a blocked statement holds a snapshot that
|
|
// CREATE INDEX CONCURRENTLY in the lock holder's migrations waits on.
|
|
await transaction.rollback();
|
|
if (!isWaiting) {
|
|
isWaiting = true;
|
|
Logger.info(
|
|
"database",
|
|
"Waiting for another instance to run migrations…"
|
|
);
|
|
}
|
|
await sleep(Second.ms);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Checks whether a required data migration has been completed for self-hosted
|
|
* installations, exiting the process with instructions if it has not.
|
|
*/
|
|
async function checkDataMigrations() {
|
|
if (env.isCloudHosted) {
|
|
return;
|
|
}
|
|
|
|
const team = await Team.findOne();
|
|
const provider = await AuthenticationProvider.findOne();
|
|
|
|
if (
|
|
env.isProduction &&
|
|
team &&
|
|
team.createdAt < new Date("2024-01-01") &&
|
|
!provider
|
|
) {
|
|
Logger.fatal(
|
|
`
|
|
This version of Outline cannot start until a data migration is complete.
|
|
Backup your database, run the database migrations and the following script:
|
|
(Note: script run needed only when upgrading to any version between 0.54.0 and 0.61.1, including both)
|
|
|
|
$ node ./build/server/scripts/20210226232041-migrate-authentication.js
|
|
`,
|
|
new Error("Data migration required")
|
|
);
|
|
}
|
|
}
|
|
|
|
void (async () => {
|
|
await checkConnection(sequelize);
|
|
await checkPendingMigrations();
|
|
|
|
// Skip the success exit when a Logger.fatal above is already shutting the
|
|
// process down with a non-zero code.
|
|
if (!ShutdownHelper.isShuttingDown) {
|
|
process.exit(0);
|
|
}
|
|
})();
|