oodikone/scripts/functions_for_setup.sh

#!/usr/bin/env bash

# This file includes functions that are used to setup Oodikone
# File doesn't run anything by itself and should be sourced from other scripts

# === Config ===

# Set up constants
## Folders
PROJECT_ROOT="$(git rev-parse --show-toplevel)"
DUMP_DIR="$PROJECT_ROOT/.databasedumps"
S3_CONFIG_FILE=~/.s3cfg
S3_BUCKET="s3://psyduck"

## Following the naming convention in docker compose, these are names for database
## services. The real data databases inside service will have names suffixed by "-real".
KONE_DB_NAME="kone-db"
SIS_DB_NAME="sis-db"
SIS_IMPORTER_DB_NAME="sis-importer-db"
USER_DB_NAME="user-db"
JAMI_DB_NAME="jami-db"
DATABASES=("$KONE_DB_NAME" "$SIS_DB_NAME" "$SIS_IMPORTER_DB_NAME" "$USER_DB_NAME" "$JAMI_DB_NAME")

## Urls should be in same order as databases as both are iterated through by indexes.
KONE_DB_S3_PATH="oodikone_kone"
SIS_DB_S3_PATH="oodikone_updater"
SIS_IMPORTER_DB_S3_PATH="sis_importer"
USER_DB_S3_PATH="oodikone_user"
JAMI_DB_S3_PATH="jami"
S3_PATHS=("$KONE_DB_S3_PATH" "$SIS_DB_S3_PATH" "$SIS_IMPORTER_DB_S3_PATH" "$USER_DB_S3_PATH" "$JAMI_DB_S3_PATH")

# Source utility functions
source "$PROJECT_ROOT"/scripts/utils.sh

# === Function ===

draw_mopo() {
  # Some hacks to print mopo as green, since colours from common config don't work when
  # catting images. Please feel free to fix this. And tell otahontas how you did it!
  local mopogreen
  mopogreen=$(tput setaf 34)
  local normal
  normal=$(tput sgr0)
  if [ "$(tput cols)" -gt "100" ]; then
    while IFS="" read -r p || [ -n "$p" ]; do
      printf '%40s\n' "${mopogreen}$p${normal}"
    done < "$PROJECT_ROOT"/scripts/assets/mopo.txt
  fi
}

retry() {
  sleep 5
  for i in {1..60}; do
    "$@" && break || warningmsg "Retry attempt $i failed, waiting..." && sleep 5;
  done
}

download_real_dump() {
  local database=$1
  local dump_destination="$DUMP_DIR/$database.sql.gz"
  local s3_path=$2
  local selection_flag=$3

  rm -f "$dump_destination"

  if [ "$selection_flag" = "true" ]; then
    local backup_files
    mapfile -t backup_files < <(s3cmd -c "$S3_CONFIG_FILE" ls "$S3_BUCKET/$s3_path/" | sort -rk1,2 | awk '{print $4}')

    if [ ${#backup_files[@]} -eq 0 ]; then
      die "No backup files found in $S3_BUCKET bucket $s3_path path!"
    fi

    infomsg "Available backups:"
    PS3="Select backup (or 0 to go back): "
    select chosen_backup in "${backup_files[@]}"; do
      if [ "$REPLY" = "0" ] || [ "$chosen_backup" = "Go back" ]; then
        infomsg "Going back to previous menu."
        break
      elif [ -n "$chosen_backup" ]; then
        infomsg "You selected: $chosen_backup"
        local FILE_NAME
        FILE_NAME=$(basename "$chosen_backup")
        infomsg "Fetching the selected dump: $FILE_NAME"
        s3cmd -c "$S3_CONFIG_FILE" get "$chosen_backup" "$dump_destination"
        if [ ! -f "$dump_destination" ]; then
          die "Download failed or file not found: $dump_destination"
        fi
        echo "$dump_destination"
        break
      else
        warningmsg "Invalid selection. Please select a valid backup number."
      fi
    done
  else
    local current_date
    current_date=$(date +"%Y%m%d")
    s3cmd -c "$S3_CONFIG_FILE" get "s3://psyduck/${s3_path}/${s3_path}_${current_date}.sql.gz" "$dump_destination"
  fi
}

check_if_postgres_is_ready() {
  local container=$1
  local database=$2
  retry docker exec -u postgres "$container" pg_isready --dbname="$database"
}

reset_databases() {
  local databases=("$@")
  local database_dump_dir=$DUMP_DIR

  infomsg "Restoring PostgreSQL dumps from backups. This might take a while."

  npm run docker:down
  docker compose up -d "${databases[@]}"

  for database in "${databases[@]}"; do
    local database_dump="$database_dump_dir/$database.sql.gz"
    local database_container="oodikone-$database"
    local database_name="$database-real"

    infomsg "Attempting to create database $database_name from dump $database_dump inside container $database_container"

    infomsg "Trying to remove possibly existing previous version of database"
    check_if_postgres_is_ready "$database_container" "$database_name"
    docker exec -u postgres "$database_container" dropdb "$database_name" || warningmsg "This is okay, continuing"

    infomsg "Trying to create new database"
    check_if_postgres_is_ready "$database_container" "$database_name"
    docker exec -u postgres "$database_container" createdb "$database_name" || warningmsg "This is okay, continuing"

    infomsg "Restoring database from dump database"
    msg "Writing database..."
    docker exec -i "$database_container" /bin/bash  -c "gunzip | psql -U postgres -d $database_name" < "$database_dump" 2> /dev/null
    msg ""
  done

  successmsg "Database setup finished"
}

reset_all_data() {
  infomsg "Downloading real data dumps"
  for i in ${!DATABASES[*]}; do
    local database="${DATABASES[$i]}"
    local url="${S3_PATHS[$i]}"
    download_real_dump "$database" "$url" false
  done
  reset_databases "${DATABASES[@]}"
}

restore_data_from_dumps() {
  infomsg "Restoring earlier-downloaded dumps to databases"
  reset_databases "${DATABASES[@]}"
}

reset_single_database() {
  # Define custom shell prompt for the nested interactive select loop
  PS3="Please enter which database to reset: "

  options=(
    "kone-db"
    "sis-db"
    "sis-importer-db"
    "user-db"
    "jami-db"
    "Return to main menu."
  )

  local database=""
  local url=""
  local selection_flag=true

  while true; do
    select opt in "${options[@]}"; do
      case $opt in
        "kone-db")
          local database=$KONE_DB_NAME
          local url=$KONE_DB_S3_PATH
          break 2;;
        "sis-db")
          local database=$SIS_DB_NAME
          local url=$SIS_DB_S3_PATH
          break 2;;
        "sis-importer-db")
          local database=$SIS_IMPORTER_DB_NAME
          local url=$SIS_IMPORTER_DB_S3_PATH
          break 2;;
        "user-db")
          local database=$USER_DB_NAME
          local url=$USER_DB_S3_PATH
          break 2;;
        "jami-db")
          local database=$JAMI_DB_NAME
          local url=$JAMI_DB_S3_PATH
          break 2;;
        "Return to main menu.")
          break 2;;
        *) msg "${RED}Invalid option:${NOFORMAT} $REPLY
  ";;
      esac
      break
    done
  done

  if [ -n "$database" ]; then
    infomsg "Downloading $database dump"
    download_real_dump $database $url $selection_flag
    reset_databases $database
  fi
}

nuke_node_modules() {
  folders_to_set_up=(
    "$PROJECT_ROOT"
    "$PROJECT_ROOT/services/frontend"
    "$PROJECT_ROOT/services/backend"
    "$PROJECT_ROOT/services/shared"
    "$PROJECT_ROOT/updater/sis-updater-scheduler"
    "$PROJECT_ROOT/updater/sis-updater-worker"
  )

  named_volumes=(
    "oodikone-shared-nodemod"
    "oodikone-frontend-nodemod"
    "oodikone-backend-nodemod"
    "oodikone-updater-worker-nodemod"
    "oodikone-updater-scheduler-nodemod"
  )

  infomsg "Running docker compose down"
  "$PROJECT_ROOT"/run.sh both down --remove-orphans || infomsg "brr"
  for folder in "${folders_to_set_up[@]}"; do
    cd "$folder" || die "Couldn't change directory to folder $folder"
    rm -rf node_modules || die "Couldn't remove node_modules in folder $folder"
  done

  for volume in "${named_volumes[@]}"; do
    docker volume rm "$volume" || infomsg "Couldn't delete volume $volume (already gone?)"
  done

  infomsg "Installing npm packages locally to root and each subfolder to enable linting and formatting (and LSP)"

  for folder in "${folders_to_set_up[@]}"; do
    cd "$folder" || die "Couldn't change directory to folder $folder"
    ([[ -d node_modules ]] && die "$folder already has node_modules, exiting!") || npm ci
  done

  cd "$PROJECT_ROOT" || die "Couldn't change directory to project root"

  successmsg "Node_module nuke performed"
}

set_up_oodikone_from_scratch() {
  draw_mopo
  folders_to_set_up=(
    "$PROJECT_ROOT"
    "$PROJECT_ROOT/services/frontend"
    "$PROJECT_ROOT/services/backend"
    "$PROJECT_ROOT/services/shared"
    "$PROJECT_ROOT/updater/sis-updater-scheduler"
    "$PROJECT_ROOT/updater/sis-updater-worker"
  )

  infomsg "Cleaning up docker setup and node_modules from possible previous installations"
  "$PROJECT_ROOT"/run.sh both down --remove-orphans --volumes --rmi all || infomsg "Cleaning errored, but will continue"
  for folder in "${folders_to_set_up[@]}"; do
    cd "$folder" || die "Couldn't change directory to folder $folder"
    rm -rf node_modules || die "Couldn't remove node_modules in folder $folder"
  done

  infomsg "Installing npm packages locally to root and each subfolder to enable linting and formatting"

  for folder in "${folders_to_set_up[@]}"; do
    cd "$folder" || die "Couldn't change directory to folder $folder"
    ([[ -d node_modules ]] && die "$folder already has node_modules, exiting!") || npm ci
  done
  cd "$PROJECT_ROOT" || die "Couldn't change directory to project root"

  infomsg "Setting up husky for pre-commit linting"
  npm run prepare

  infomsg "Pulling images"
  "$PROJECT_ROOT"/run.sh both anon pull

  infomsg "Building images"
  "$PROJECT_ROOT"/run.sh both anon build

  successmsg "Setup ready, Oodikone can be started! See README for more info."
}

docker_prune() {
  infomsg "Running: docker system prune -a && docker volume prune -a"
  docker system prune -a && docker volume prune -a
}

init_dirs() {
  if [[ ! -d "$DUMP_DIR" ]]; then
    infomsg "Creating directory for dumps"
    mkdir "$DUMP_DIR"
  fi
}

# If username is not set, get username from data file.
# Ask user to provide username, if username was not found from data file.
get_s3_config() {
  if [ ! -f "$S3_CONFIG_FILE" ]; then
    warningmsg "No username provided, config file is required. The \".s3cfg\" config file can be found on toska/dokumentaatio repo."
    return 0
  fi

  infomsg "Using your config $S3_CONFIG_FILE - for getting database dumps"
}