style: unify Bash code style

packages/data-api/scripts/buildAnalyticsMaterializedView.sh

@@ -1,16 +1,17 @@
-#!/bin/bash -e
+#!/usr/bin/env bash
+set -e
 
 DIR=$(pwd "$0")
-source "$DIR/../../scripts/bash/mergeEnvForDB.sh" 
+. "$DIR/../../scripts/bash/mergeEnvForDB.sh"
 
 # Set default port in case it wasn't in .env
 : "${DB_PORT:=5432}"
 
 cd scripts
 export PGPASSWORD=$DB_PASSWORD
-if [[ "$1" == "--force" || "$1" == "-f" ]]; then
-  psql -p $DB_PORT -h $DB_URL -d $DB_NAME -U $DB_USER -tc "SELECT build_analytics_table(true);"
+if [[ $1 = '--force' || $1 = '-f' ]]; then
+    psql -p "$DB_PORT" -h "$DB_URL" -d "$DB_NAME" -U "$DB_USER" -tc "SELECT build_analytics_table(true);"
 else
-  psql -p $DB_PORT -h $DB_URL -d $DB_NAME -U $DB_USER -tc "SELECT build_analytics_table();"
+    psql -p "$DB_PORT" -h "$DB_URL" -d "$DB_NAME" -U "$DB_USER" -tc "SELECT build_analytics_table();"
 fi
-psql -p $DB_PORT -h $DB_URL -d $DB_NAME -U $DB_USER -tc "SELECT create_analytics_table_indexes();"
+psql -p "$DB_PORT" -h "$DB_URL" -d "$DB_NAME" -U "$DB_USER" -tc "SELECT create_analytics_table_indexes();"

packages/data-api/scripts/dropAnalyticsMaterializedView.sh

@@ -1,12 +1,13 @@
-#!/bin/bash -e
+#!/usr/bin/env bash
+set -e
 
 DIR=$(pwd "$0")
-source "$DIR/../../scripts/bash/mergeEnvForDB.sh" 
+. "$DIR/../../scripts/bash/mergeEnvForDB.sh"
 
 # Set default port in case it wasn't in .env
 : "${DB_PORT:=5432}"
 
 cd scripts
 export PGPASSWORD=$DB_PASSWORD
-psql -p $DB_PORT -h $DB_URL -d $DB_NAME -U $DB_USER -tc "SELECT drop_analytics_table();"
-psql -p $DB_PORT -h $DB_URL -d $DB_NAME -U $DB_USER -tc "SELECT drop_analytics_log_tables();"
+psql -p "$DB_PORT" -h "$DB_URL" -d "$DB_NAME" -U "$DB_USER" -tc "SELECT drop_analytics_table();"
+psql -p "$DB_PORT" -h "$DB_URL" -d "$DB_NAME" -U "$DB_USER" -tc "SELECT drop_analytics_log_tables();"

packages/data-api/scripts/fastRefreshAnalyticsTable.sh

@@ -1,12 +1,14 @@
-#!/bin/bash -e
-echo "Fast refreshing analytics table"
+#!/usr/bin/env bash
+set -e
+
+echo 'Fast refreshing analytics table'
 
 DIR=$(pwd "$0")
-source "$DIR/../../scripts/bash/mergeEnvForDB.sh" 
+. "$DIR/../../scripts/bash/mergeEnvForDB.sh"
 
 # Set default port in case it wasn't in .env
 : "${DB_PORT:=5432}"
 
 cd scripts
 export PGPASSWORD=$DB_PASSWORD
-psql -p $DB_PORT -h $DB_URL -d $DB_NAME -U $DB_USER -tc "SELECT mv\$refreshMaterializedView('analytics', 'public', true);"
+psql -p "$DB_PORT" -h "$DB_URL" -d "$DB_NAME" -U "$DB_USER" -tc "SELECT mv\$refreshMaterializedView('analytics', 'public', true);"

packages/data-api/scripts/fullRefreshAnalyticsTable.sh

@@ -1,14 +1,16 @@
-#!/bin/bash -e
-echo "Fully refreshing analytics table"
+#!/usr/bin/env bash
+set -e
+
+echo 'Fully refreshing analytics table'
 
 DIR=$(pwd "$0")
-source "$DIR/../../scripts/bash/mergeEnvForDB.sh" 
+. "$DIR/../../scripts/bash/mergeEnvForDB.sh"
 
 # Set default port in case it wasn't in .env
 : "${DB_PORT:=5432}"
 
 cd scripts
 export PGPASSWORD=$DB_PASSWORD
-psql -p $DB_PORT -h $DB_URL -d $DB_NAME -U $DB_USER -tc "SELECT drop_analytics_table_indexes();"
-psql -p $DB_PORT -h $DB_URL -d $DB_NAME -U $DB_USER -tc "SELECT mv\$refreshMaterializedView('analytics', 'public');"
-psql -p $DB_PORT -h $DB_URL -d $DB_NAME -U $DB_USER -tc "SELECT create_analytics_table_indexes();"
+psql -p "$DB_PORT" -h "$DB_URL" -d "$DB_NAME" -U "$DB_USER" -tc "SELECT drop_analytics_table_indexes();"
+psql -p "$DB_PORT" -h "$DB_URL" -d "$DB_NAME" -U "$DB_USER" -tc "SELECT mv\$refreshMaterializedView('analytics', 'public');"
+psql -p "$DB_PORT" -h "$DB_URL" -d "$DB_NAME" -U "$DB_USER" -tc "SELECT create_analytics_table_indexes();"

packages/data-api/scripts/installMvRefreshModule.sh

@@ -1,6 +1,4 @@
 #!/bin/bash
-DIR=$(dirname "$0")
-
 
 DIR=$(pwd "$0")
 source "$DIR/../../scripts/bash/mergeEnvForDB.sh" 
@@ -9,10 +7,10 @@ source "$DIR/../../scripts/bash/mergeEnvForDB.sh"
 : "${DB_PORT:=5432}"
 
 export PGPASSWORD=$DB_PG_PASSWORD
-MV_REFRESH_EXISTS=`psql -p $DB_PORT -X -A -h $DB_URL -d $DB_NAME -U $DB_PG_USER -t -c "SELECT schema_name FROM information_schema.schemata WHERE schema_name = '$DB_MV_USER'"`
+MV_REFRESH_EXISTS=$(psql -p "$DB_PORT" -X -A -h "$DB_URL" -d "$DB_NAME" -U "$DB_PG_USER" -t -c "SELECT schema_name FROM information_schema.schemata WHERE schema_name = '$DB_MV_USER'")
 
-if [ "$MV_REFRESH_EXISTS" == "$DB_MV_USER" ]; then
-    echo "Fast Refresh module already exists, skipping installation"
+if [[ $MV_REFRESH_EXISTS = "$DB_MV_USER" ]]; then
+    echo 'Fast Refresh module already exists, skipping installation'
 else
     git submodule update --init scripts/pg-mv-fast-refresh
     cd scripts/pg-mv-fast-refresh/
@@ -23,4 +21,4 @@ else
 fi
 
 export PGPASSWORD=$DB_PG_PASSWORD
-psql -p $DB_PORT --set=db_user="$DB_USER" --set=mv_user="$DB_MV_USER" --set=db_name="$DB_NAME" -h $DB_URL -d $DB_NAME -U $DB_PG_USER -f scripts/grantMvRefreshPermissions.sql
+psql -p "$DB_PORT" --set=db_user="$DB_USER" --set=mv_user="$DB_MV_USER" --set=db_name="$DB_NAME" -h "$DB_URL" -d "$DB_NAME" -U "$DB_PG_USER" -f scripts/grantMvRefreshPermissions.sql

packages/data-api/scripts/patchMvRefreshModule.sh

@@ -1,42 +1,43 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 DIR=$(pwd "$0")
-source "$DIR/../../scripts/bash/mergeEnvForDB.sh" 
+. "$DIR/../../scripts/bash/mergeEnvForDB.sh"
+. "$DIR/../../scripts/bash/ansiControlSequences.sh"
 
 COMMAND=$1
 
-if [[ "$COMMAND" == "" ]]; then
-    echo "Error: missing patch command! Must be one of: up, down, create"
+if [[ $COMMAND = '' ]]; then
+    echo "${RED}Error: missing patch command! Must be one of: up, down, create${RESET}"
     exit 1
 fi
 
-if [[ "$COMMAND" == "create" ]]; then
-    echo "Enter patch name: "
+if [[ $COMMAND = create ]]; then
+    echo 'Enter patch name: '
     read PATCH_NAME
 fi
 
 VERSION=$2
 
-if [[ "$VERSION" == "" ]]; then
-    echo "Version unspecified, defaulting to database mvrefresh version"
+if [[ $VERSION = '' ]]; then
+    echo 'Version unspecified, defaulting to database mvrefresh version'
 
     # Set default port in case it wasn't in .env
     : "${DB_PORT:=5432}"
 
     export PGPASSWORD=$DB_PASSWORD
     VERSION_SQL_FUNC="SELECT mv\$version()"
-    VERSION=`psql -p $DB_PORT -X -A -h $DB_URL -d $DB_NAME -U $DB_USER -t -c "$VERSION_SQL_FUNC"`
+    VERSION=$(psql -p "$DB_PORT" -X -A -h "$DB_URL" -d "$DB_NAME" -U "$DB_USER" -t -c "$VERSION_SQL_FUNC")
 
-    if [[ "$VERSION" == "" ]]; then
-        echo "Error: failed to detect mvrefresh version from database"
+    if [[ $VERSION = '' ]]; then
+        echo "${RED}Error: failed to detect mvrefresh version from database${RESET}"
         exit 1
     fi
 
-    echo "Using version: $VERSION"
+    echo "Using version: ${BOLD}${GREEN}$VERSION${RESET}"
 fi
 
-if [[ ! -d "./scripts/patches/$VERSION" && ! "$COMMAND" == "create" ]]; then
+if [[ ! -d ./scripts/patches/$VERSION && $COMMAND != create ]]; then
     echo "No patches exist for version: $VERSION, skipping"
 else
-    ts-node ./scripts/patchMvRefresh.ts $COMMAND:$VERSION $PATCH_NAME --migrations-dir "./scripts/patches"  --table "patches" -v --config-file "../../babel.config.json"
+    ts-node ./scripts/patchMvRefresh.ts $COMMAND:$VERSION $PATCH_NAME --migrations-dir './scripts/patches'  --table 'patches' -v --config-file '../../babel.config.json'
 fi

packages/data-api/scripts/refreshAnalyticsTable.sh

@@ -1,6 +1,7 @@
-#!/bin/bash -e
+#!/usr/bin/env bash
+set -e
 
-if [[ "$1" == "--full" || "$1" == "-f" ]]; then
+if [[ $1 = '--full' || $1 = '-f' ]]; then
   ./scripts/fullRefreshAnalyticsTable.sh
 else
   ./scripts/fastRefreshAnalyticsTable.sh

packages/data-api/scripts/uninstallMvRefreshModule.sh

@@ -1,16 +1,17 @@
-#!/bin/bash
+#!/usr/bin/env bash
+set -e
 
 DIR=$(pwd "$0")
-source "$DIR/../../scripts/bash/mergeEnvForDB.sh" 
+. "$DIR/../../scripts/bash/mergeEnvForDB.sh"
 
 # Set default port in case it wasn't in .env
 : "${DB_PORT:=5432}"
 
 export PGPASSWORD=$DB_PG_PASSWORD
-MV_REFRESH_EXISTS=`psql -X -A -p $DB_PORT -h $DB_URL -d $DB_NAME -U $DB_PG_USER -t -c "SELECT schema_name FROM information_schema.schemata WHERE schema_name = '$DB_MV_USER'"`
+MV_REFRESH_EXISTS=$(psql -X -A -p "$DB_PORT" -h "$DB_URL" -d "$DB_NAME" -U "$DB_PG_USER" -t -c "SELECT schema_name FROM information_schema.schemata WHERE schema_name = '$DB_MV_USER'")
 
-if [ "$MV_REFRESH_EXISTS" != "$DB_MV_USER" ]; then
-    echo "Fast Refresh module does not exist, skipping uninstallation"
+if [[ $MV_REFRESH_EXISTS != "$DB_MV_USER" ]]; then
+    echo 'Fast Refresh module does not exist, skipping uninstallation'
 else
     git submodule update --init scripts/pg-mv-fast-refresh
     cd scripts/pg-mv-fast-refresh/
@@ -19,5 +20,5 @@ else
     cd ../..
     git submodule deinit scripts/pg-mv-fast-refresh
     export PGPASSWORD=$DB_PG_PASSWORD
-    psql -p $DB_PORT -h $DB_URL -d $DB_NAME -U $DB_PG_USER -tc "REVOKE ALL PRIVILEGES on schema public FROM $DB_MV_USER; DROP ROLE IF EXISTS $DB_MV_USER;"
+    psql -p "$DB_PORT" -h "$DB_URL" -d "$DB_NAME" -U "$DB_PG_USER" -tc "REVOKE ALL PRIVILEGES on schema public FROM $DB_MV_USER; DROP ROLE IF EXISTS $DB_MV_USER;"
 fi

packages/data-lake-api/scripts/checkTestDataLakeExists.sh

@@ -1,15 +1,22 @@
-#!/bin/bash -e
+#!/usr/bin/env bash
+set -e
 
 DIR=$(pwd "$0")
-source "$DIR/../../scripts/bash/mergeEnvForDB.sh" 
+. "$DIR/../../scripts/bash/mergeEnvForDB.sh"
+. "$DIR/../../scripts/bash/ansiControlSequences.sh"
 
 # Set default port in case it wasn't in .env
 : "${DATA_LAKE_DB_PORT:=5432}"
 
-if [ "$(PGPASSWORD=$DB_PG_PASSWORD psql -p $DATA_LAKE_DB_PORT -X -A -h $DATA_LAKE_DB_URL -U $DB_PG_USER -t -c "SELECT 1 FROM pg_database WHERE datname='$DATA_LAKE_DB_NAME'" )" = '1' ]
-then
+if [[ "$(PGPASSWORD=$DB_PG_PASSWORD psql -p $DATA_LAKE_DB_PORT -X -A -h $DATA_LAKE_DB_URL -U $DB_PG_USER -t -c "SELECT 1 FROM pg_database WHERE datname='$DATA_LAKE_DB_NAME'" )" = '1' ]]; then
     exit 0
 fi
 
-echo -e "Error: $DATA_LAKE_DB_NAME database does not exist!\n\nTo create it, please get the .env file from Bitwarden then run:\nyarn workspace @tupaia/data-lake-api setup-test-data-lake\n"
+echo -e "${RED}Error: $DATA_LAKE_DB_NAME database does not exist!${RESET}"
+echo    'To create it, make sure you have the environment variables from Bitwarden and run:'
+echo
+echo -e "  ${BOLD}yarn workspace @tupaia/data-lake-api setup-test-data-lake${RESET}"
+echo
+echo -e "If you’re missing environment variables, see ${MAGENTA}https://beyond-essential.slab.com/posts/tupaia-monorepo-setup-v5egpdpq#hvfnz-set-environment-variables${RESET}."
+
 exit 1

packages/data-lake-api/scripts/setupTestDataLake.sh

@@ -1,14 +1,15 @@
-#!/bin/bash -e
+#!/usr/bin/env bash
+set -e
 
 DIR=$(pwd "$0")
-source "$DIR/../../scripts/bash/mergeEnvForDB.sh" 
+. "$DIR/../../scripts/bash/mergeEnvForDB.sh"
 
 # Set default port in case it wasn't in .env
 : "${DATA_LAKE_DB_PORT:=5432}"
 
 TUPAIA_USER_EXISTS=`PGPASSWORD=$DB_PG_PASSWORD psql -p $DATA_LAKE_DB_PORT -X -A -h $DATA_LAKE_DB_URL -U $DB_PG_USER -t -c "SELECT rolname FROM pg_catalog.pg_roles WHERE rolname = '$DATA_LAKE_DB_USER'"`
 
-if [ -z "$TUPAIA_USER_EXISTS" ]; then
+if [[ -z $TUPAIA_USER_EXISTS ]]; then
     PGPASSWORD=$DB_PG_PASSWORD psql -h $DATA_LAKE_DB_URL -p $DATA_LAKE_DB_PORT -U $DB_PG_USER -c "CREATE ROLE $DATA_LAKE_DB_USER LOGIN PASSWORD '$DATA_LAKE_DB_PASSWORD'"
 fi
 

packages/database/scripts/checkTestDatabaseExists.sh

@@ -1,20 +1,22 @@
-#!/bin/bash -e
+#!/usr/bin/env bash
+set -e
 
 DIR=$(pwd "$0")
-source "$DIR/../../scripts/bash/mergeEnvForDB.sh" 
+. "$DIR/../../scripts/bash/ansiControlSequences.sh"
+. "$DIR/../../scripts/bash/mergeEnvForDB.sh"
 
 # Set default port in case it wasn't in .env
 : "${DB_PORT:=5432}"
 
-if [ "$(PGPASSWORD=$DB_PG_PASSWORD psql -p $DB_PORT -X -A -h $DB_URL -U $DB_PG_USER -t -c "SELECT 1 FROM pg_database WHERE datname='$DB_NAME'" )" = '1' ]
-then
+if [ "$(PGPASSWORD=$DB_PG_PASSWORD psql -p $DB_PORT -X -A -h $DB_URL -U $DB_PG_USER -t -c "SELECT 1 FROM pg_database WHERE datname='$DB_NAME'" )" = '1' ]; then
     exit 0
 fi
 
-echo -e "\033[31mError: $DB_NAME database does not exist!\033[m"
-echo    "To create it, get the .env file from Bitwarden then run:"
-echo    ""
-echo -e "  \033[1myarn workspace @tupaia/database setup-test-database\033[m"
-echo    ""
+echo -e "${RED}Error: $DB_NAME database does not exist!${RESET}"
+echo    'To create it, make sure you have the environment variables from Bitwarden and run:'
+echo
+echo -e "  ${BOLD}yarn workspace @tupaia/database setup-test-database${RESET}"
+echo
+echo -e "If you’re missing environment variables, see ${MAGENTA}https://beyond-essential.slab.com/posts/tupaia-monorepo-setup-v5egpdpq#hvfnz-set-environment-variables${RESET}."
 
 exit 1

packages/database/scripts/dumpDatabase.sh

@@ -1,4 +1,5 @@
-#!/bin/bash -e
+#!/usr/bin/env bash
+set -e
 
 function print_help() {
     cat <<EOF
@@ -13,32 +14,33 @@ EOF
 
 # https://stackoverflow.com/questions/12498304/using-bash-to-display-a-progress-indicator
 function show_loading_spinner() {
-    eval $2 &
+    eval "$2" &
     pid=$! # Process Id of the previous running command
 
     spin='-\|/'
 
     i=0
-    while kill -0 $pid 2>/dev/null
+    while kill -0 "$pid" 2>/dev/null
     do
     i=$(( (i+1) %4 ))
     printf "\r$1 ${spin:$i:1}"
     sleep .5
     done
     printf "\r$1  "
-    echo "" # reset prompt
+    echo # reset prompt
 }
 
 DIR=$(pwd "$0")
-source "$DIR/../../scripts/bash/mergeEnvForDB.sh" 
+. "$DIR/../../scripts/bash/mergeEnvForDB.sh"
+. "$DIR/../../scripts/bash/ansiControlSequences.sh"
 
-DUMP_FILE_NAME="dump.sql"
+DUMP_FILE_NAME='dump.sql'
 
-identity_file=""
-server="dev"
-target_dir="."
+identity_file=''
+server='dev'
+target_dir='.'
 
-while [ "$1" != "" ]; do
+while [[ $1 != '' ]]; do
     case $1 in
     -s | --server)
         shift
@@ -55,7 +57,7 @@ while [ "$1" != "" ]; do
         exit
         ;;
     *)
-        if [ "$identity_file" == "" ]; then
+        if [[ $identity_file = '' ]]; then
             identity_file=$1
             shift
         else
@@ -66,13 +68,13 @@ while [ "$1" != "" ]; do
     esac
 done
 
-if [ "$identity_file" == "" ]; then
+if [[ $identity_file = '' ]]; then
     print_help
     exit 1
 fi
 
-if [ "$DB_PG_USER" == "" ] || [ "$DB_PG_PASSWORD" == "" ]; then
-    echo "Missing postgres user credential env vars in @tupaia/database .env file. Check Bitwarden for variables and add them to the .env file"
+if [[ $DB_PG_USER = '' || $DB_PG_PASSWORD = '' ]]; then
+    echo -e "${RED}Missing Postgres user credential env vars in @tupaia/database .env file.${RESET} Check Bitwarden for variables and add them to the .env file"
     exit 1
 fi
 
@@ -86,6 +88,5 @@ target_zip_path="$target_path.gz"
 show_loading_spinner "Dumping database to $target_zip_path" "PGPASSWORD=$DB_PG_PASSWORD pg_dump \"host=$host user=$DB_PG_USER dbname=tupaia sslmode=require sslkey=$identity_file\" -Z1 -f $target_zip_path"
 show_loading_spinner "Unzipping $target_zip_path" "gunzip -f $target_zip_path"
 
-echo "Dump file available at $target_path"
-
-echo "Done!"
+echo    "Dump file available at $target_path"
+echo -e "${GREEN}Done!${RESET}"

packages/database/scripts/migrateCreate.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 read -p "Enter migration name: " MIGRATION_NAME
 read -p "Enter the scope of this migration ('schema' or 'data'): " MIGRATION_SCOPE