1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
/*
Spacebar: A FOSS re-implementation and extension of the Discord.com backend.
Copyright (C) 2023 Spacebar and Spacebar Contributors
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import path from "node:path";
import fs from "node:fs";
import { green, red, yellow } from "picocolors";
import { DataSource } from "typeorm";
import { ProcessLifecycle } from "../util/util/ProcessLifecycle";
// UUID extension option is only supported with postgres
// We want to generate all id's with Snowflakes that's why we have our own BaseEntity class
export let dbConnection: DataSource | undefined;
let isHeadlessProcess = false;
// For typeorm cli
if (!process.env) {
isHeadlessProcess = true;
require("dotenv").config({ quiet: true });
}
if (process.argv[1]?.endsWith("scripts/openapi.js")) isHeadlessProcess = true;
if (!process.env.DATABASE && !isHeadlessProcess) {
console.log(
red(
"DATABASE environment variable not set! Please set it to your database connection string.\n" + "Example for postgres: postgres://user:password@localhost:5432/database",
),
);
process.exit(1);
}
const dbConnectionString = process.env.DATABASE!;
export const DatabaseType = isHeadlessProcess ? "postgres" : dbConnectionString.split(":")[0]?.replace("+srv", "");
const applyMigrations = process.env.APPLY_DB_MIGRATIONS !== "false";
const MIGRATIONLOCK = 1;
export const DataSourceOptions = isHeadlessProcess
? (undefined as unknown as DataSource)
: new DataSource({
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
//@ts-ignore type 'string' is not 'sqlite' | 'postgres' | etc etc
type: DatabaseType,
charset: "utf8mb4",
url: process.env.DATABASE,
entities: [path.join(__dirname, "entities", "*.js")],
synchronize: !!process.env.DB_SYNC,
logging: !!process.env.DB_LOGGING,
bigNumberStrings: false,
supportBigNumbers: true,
name: "default",
migrations: applyMigrations ? [path.join(__dirname, "migration", DatabaseType, "*.js")] : [],
invalidWhereValuesBehavior: {
null: "sql-null",
undefined: "ignore",
},
});
// Gets the existing database connection
export function getDatabase(): DataSource | null {
// if (!dbConnection) throw new Error("Tried to get database before it was initialised");
if (!dbConnection) return null;
return dbConnection;
}
// Called once on server start
export async function initDatabase(): Promise<DataSource> {
if (dbConnection) return dbConnection;
if (!process.env.DB_SYNC) {
const supported = ["postgres"];
if (!supported.includes(DatabaseType)) {
console.log(
"[Database]" +
red(
` We don't have migrations for DB type '${DatabaseType}'` +
` To ignore, set DB_SYNC=true in your env. https://docs.spacebar.chat/setup/server/configuration/env/`,
),
);
process.exit(1);
}
}
console.log(`[Database] ${yellow(`Connecting to ${DatabaseType} db`)}`);
dbConnection = await DataSourceOptions.initialize();
// Crude way of detecting if the migrations table exists.
const dbExists = async () => {
try {
// do not globally import to avoid circular references
await require("./entities/Config").ConfigEntity.count();
return true;
} catch (e) {
return false;
}
};
if (applyMigrations) {
const qr = dbConnection.createQueryRunner();
/*
The advisory lock ensures that exactly one server is attempting to run migrations at a time.
It is session-specific, so should be released if a crash occurs. It is also blocking, so all
servers can run their logic.
*/
await qr.query(`Select pg_advisory_lock(${MIGRATIONLOCK})`);
if (!(await dbExists())) {
console.log("[Database] This appears to be a fresh database. Running initial DDL.");
const initialPath = path.join(__dirname, "migration", DatabaseType + "-initial.js");
if (fs.existsSync(initialPath)) {
console.log("[Database] Found initial migration file, running it.");
await new (require(`./migration/${DatabaseType}-initial`).initial0)().up(qr);
} else console.log("[Database] No initial migration file found at '", initialPath, "', skipping.");
}
console.log("[Database] Applying missing migrations, if any.", process.env.APPLY_DB_MIGRATIONS);
await dbConnection.runMigrations();
await qr.query(`Select pg_advisory_unlock(${MIGRATIONLOCK})`);
await qr.release();
} else {
console.log("[Database] Skipping migrations as per config.");
while (!(await dbExists())) {
console.log("[Database] Database does not exist, and we are not running migrations... Waiting 1 seconds...");
await new Promise((r) => void setTimeout(r, 5000));
}
}
ProcessLifecycle.eventEmitter.on("stopped", async () => await closeDatabase());
console.log(`[Database] ${green("Connected")}`);
return dbConnection;
}
export async function closeDatabase() {
if (DataSourceOptions.isInitialized) await DataSourceOptions.destroy();
if (dbConnection?.isInitialized) await dbConnection?.destroy();
}
|
