outline/server/utils/startup.ts

import { execSync } from "child_process";
import chalk from "chalk";
import { isEmpty } from "lodash";
import env from "@server/env";
import Logger from "@server/logging/Logger";
import AuthenticationProvider from "@server/models/AuthenticationProvider";
import Team from "@server/models/Team";

function getPendingMigrations() {
  const commandResult = execSync(
    `yarn sequelize db:migrate:status${
      env.PGSSLMODE === "disable" ? " --env=production-ssl-disabled" : ""
    }`
  );
  const commandResultArray = Buffer.from(commandResult)
    .toString("utf-8")
    .split("\n");

  const pendingMigrations = commandResultArray.filter((line) =>
    line.startsWith("down")
  );

  return pendingMigrations;
}

function runMigrations() {
  Logger.info("database", "Running migrations...");
  const cmdResult = execSync(
    `yarn db:migrate${
      env.PGSSLMODE === "disable" ? " --env=production-ssl-disabled" : ""
    }`
  );
  const cmdOutput = Buffer.from(cmdResult).toString("utf-8");
  Logger.info("database", cmdOutput);
  Logger.info("database", "Done.");
}

function logMigrations(migrations: string[]) {
  Logger.warn("You have pending migrations");
  Logger.warn(
    migrations
      .map((line, i) => `${i + 1}. ${line.replace("down ", "")}`)
      .join("\n")
  );
}

export async function checkPendingMigrations() {
  try {
    const pending = getPendingMigrations();
    if (!isEmpty(pending)) {
      if (env.isCloudHosted()) {
        logMigrations(pending);
        process.exit(1);
      } else {
        runMigrations();
      }
    }
    await checkDataMigrations();
  } catch (err) {
    if (err.message.includes("ECONNREFUSED")) {
      Logger.warn(
        chalk.red(
          `Could not connect to the database. Please check your connection settings.`
        )
      );
    } else {
      Logger.warn(chalk.red(err.message));
    }
    process.exit(1);
  }
}

export async function checkDataMigrations() {
  if (env.isCloudHosted()) {
    return;
  }

  const isProduction = env.ENVIRONMENT === "production";
  const teams = await Team.count();
  const providers = await AuthenticationProvider.count();

  if (isProduction && teams && !providers) {
    Logger.warn(`
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
`);
    process.exit(1);
  }
}

export async function checkEnv() {
  await env.validate().then((errors) => {
    if (errors.length > 0) {
      Logger.warn(
        "Environment configuration is invalid, please check the following:\n\n"
      );
      for (const error of errors) {
        Logger.warn("- " + Object.values(error.constraints ?? {}).join(", "));
      }
      process.exit(1);
    }
  });

  if (env.ENVIRONMENT === "production") {
    Logger.info(
      "lifecycle",
      chalk.green(`
Is your team enjoying Outline? Consider supporting future development by sponsoring the project:\n\nhttps://github.com/sponsors/outline
`)
    );
  } else if (env.ENVIRONMENT === "development") {
    Logger.warn(
      `Running Outline in ${chalk.bold(
        "development mode"
      )}. To run Outline in production mode set the ${chalk.bold(
        "NODE_ENV"
      )} env variable to "production"`
    );
  }
}