hub: centralize db singleton access

Author: haraldschilly

src/packages/hub/hub.ts

@@ -20,7 +20,6 @@ import {
   pgdatabase,
   pghost,
   pguser,
-  data,
 } from "@cocalc/backend/data";
 import { trimLogFileSize } from "@cocalc/backend/logger";
 import port from "@cocalc/backend/port";
@@ -50,15 +49,14 @@ import { stripe_sync } from "@cocalc/server/stripe/sync";
 import { callback2, retry_until_success } from "@cocalc/util/async-utils";
 import { set_agent_endpoint } from "./health-checks";
 import { getLogger } from "./logger";
-import initDatabase from "./servers/database";
+import initDatabase, { getDatabase } from "./servers/database";
 import initExpressApp from "./servers/express-app";
 
 import initHttpRedirect from "./servers/http-redirect";
 
 import { addErrorListeners } from "@cocalc/server/metrics/error-listener";
 import * as MetricsRecorder from "@cocalc/server/metrics/metrics-recorder";
 import { migrateBookmarksToConat } from "./migrate-bookmarks";
-import { PostgreSQL } from "@cocalc/database/postgres";
 
 // Logger tagged with 'hub' for this file.
 const logger = getLogger("hub");
@@ -69,15 +67,6 @@ export { program };
 
 const REGISTER_INTERVAL_S = 20;
 
-let database: PostgreSQL | undefined = undefined;
-
-function getDatabase(): PostgreSQL {
-  if (database == null) {
-    throw new Error("database not initialized yet");
-  }
-  return database;
-}
-
 async function reset_password(email_address: string): Promise<void> {
   try {
     await callback2(getDatabase().reset_password, { email_address });
@@ -256,6 +245,8 @@ async function startServer(): Promise<void> {
       key: program.httpsKey,
     });
 
+    const database = getDatabase();
+
     // The express app create via initExpressApp above **assumes** that init_passport is done
     // or complains a lot. This is obviously not really necessary, but we leave it for now.
     await callback2(init_passport, {
@@ -453,7 +444,7 @@ async function main(): Promise<void> {
   try {
     // Everything we do here requires the database to be initialized. Once
     // initDatabase returns, database is the initialized singleton.
-    database = initDatabase();
+    const database = initDatabase();
     database._concurrent_warn = program.dbConcurrentWarn;
 
     if (program.passwd) {

src/packages/hub/proxy/check-for-access-to-project.ts

@@ -1,7 +1,7 @@
 import LRU from "lru-cache";
 import { callback2 } from "@cocalc/util/async-utils";
 import getLogger from "../logger";
-import { database } from "../servers/database";
+import { getDatabase } from "../servers/database";
 const {
   user_has_write_access_to_project,
   user_has_read_access_to_project,
@@ -128,6 +128,7 @@ async function checkForRememberMeAccess({
   type,
   dbg,
 }): Promise<{ access: boolean; error?: string }> {
+  const database = getDatabase();
   dbg("get remember_me message");
   const x = remember_me.split("$");
   const hash = generateHash(x[0], x[1], parseInt(x[2]), x[3]);

src/packages/hub/proxy/target.ts

@@ -9,7 +9,7 @@ to this target or the target project isn't running.
 import LRU from "lru-cache";
 
 import getLogger from "@cocalc/hub/logger";
-import { database } from "@cocalc/hub/servers/database";
+import { getDatabase } from "@cocalc/hub/servers/database";
 import { ProjectControlFunction } from "@cocalc/server/projects/control";
 import { reuseInFlight } from "@cocalc/util/reuse-in-flight";
 import { NamedServerName } from "@cocalc/util/types/servers";
@@ -91,6 +91,7 @@ export async function getTarget({
     throw Error(`user does not have write access to project`);
   }
 
+  const database = getDatabase();
   const project = projectControl(project_id);
   let state = await project.state();
   let host = state.ip;
@@ -184,6 +185,7 @@ async function _namedServerPort(
   if (p) {
     return p;
   }
+  const database = getDatabase();
   const project = hub_projects.new_project(
     // NOT @cocalc/server/projects/control like above...
     project_id,

src/packages/hub/servers/app/blob-upload.ts

@@ -8,7 +8,7 @@ allows for attaching files to github issue comments.
 
 import { Router } from "express";
 import { callback2 } from "@cocalc/util/async-utils";
-import { database } from "../database";
+import { getDatabase } from "../database";
 const { save_blob } = require("@cocalc/hub/blobs");
 import { getLogger } from "@cocalc/hub/logger";
 import {
@@ -27,14 +27,15 @@ function dbg(...args): void {
 }
 
 export default function init(router: Router) {
+  const database = getDatabase();
   router.post("/blobs", async (req, res) => {
     const account_id = await getAccount(req);
     if (!account_id) {
       res.status(500).send("user must be signed in to upload files");
       return;
     }
     const { project_id, ttl } = req.query;
-    if (typeof project_id == 'string' && project_id) {
+    if (typeof project_id == "string" && project_id) {
       if (!(await isCollaborator({ account_id, project_id }))) {
         res.status(500).send("user must be collaborator on project");
         return;

src/packages/hub/servers/app/blobs.ts

@@ -1,12 +1,13 @@
 import { Router } from "express";
-import { database } from "../database";
+import { getDatabase } from "../database";
 import { is_valid_uuid_string } from "@cocalc/util/misc";
 import { database_is_working } from "@cocalc/server/metrics/hub_register";
 import { callback2 } from "@cocalc/util/async-utils";
 import { getLogger } from "@cocalc/hub/logger";
 
 const logger = getLogger("hub:servers:app:blobs");
 export default function init(router: Router) {
+  const database = getDatabase();
   // return uuid-indexed blobs (mainly used for graphics)
   router.get("/blobs/*", async (req, res) => {
     logger.debug(`${JSON.stringify(req.query)}, ${req.path}`);

src/packages/hub/servers/app/customize.ts

@@ -5,9 +5,10 @@
 
 import { send as sendManifest } from "@cocalc/hub/manifest";
 import { WebappConfiguration } from "@cocalc/hub/webapp-configuration";
-import { database } from "../database";
+import { getDatabase } from "../database";
 
 export default function init(router, isPersonal: boolean) {
+  const database = getDatabase();
   const webappConfig = new WebappConfiguration({ db: database });
 
   router.get("/customize", async (req, res) => {

src/packages/hub/servers/app/next.ts

@@ -15,7 +15,7 @@ import basePath from "@cocalc/backend/base-path";
 import { getLogger } from "@cocalc/hub/logger";
 import handleRaw from "@cocalc/next/lib/share/handle-raw";
 import { callback2 } from "@cocalc/util/async-utils";
-import { database } from "../database";
+import { getDatabase } from "../database";
 import createLandingRedirect from "./landing-redirect";
 import shareRedirect from "./share-redirect";
 import { separate_file_extension } from "@cocalc/util/misc";
@@ -123,6 +123,7 @@ function parseURL(req: Request, base): { id: string; path: string } {
 }
 
 async function runShareServer(): Promise<boolean> {
+  const database = getDatabase();
   const { rows } = await callback2(database._query, {
     query: "SELECT value FROM server_settings WHERE name='share_server'",
   });

src/packages/hub/servers/app/stats.ts

@@ -1,9 +1,10 @@
 import { Router } from "express";
 import { callback2 } from "@cocalc/util/async-utils";
 import { database_is_working } from "@cocalc/server/metrics/hub_register";
-import { database } from "../database";
+import { getDatabase } from "../database";
 
 export default function init(router: Router) {
+  const database = getDatabase();
   // Return global status information about CoCalc
   router.get("/stats", async (_req, res) => {
     if (!database_is_working()) {

src/packages/hub/servers/database.ts

@@ -8,6 +8,13 @@ import { enableDbAdminAlerts } from "@cocalc/server/messages/admin-alert";
 // object gets used.
 let database: PostgreSQL | undefined = undefined;
 
+export function getDatabase(): PostgreSQL {
+  if (database == null) {
+    throw new Error("database not initialized yet");
+  }
+  return database;
+}
+
 export default function init(): PostgreSQL {
   if (database != null) {
     throw Error("only call database init once");

src/packages/hub/servers/express-app.ts

@@ -25,7 +25,7 @@ import initCustomize from "./app/customize";
 import { initMetricsEndpoint, setupInstrumentation } from "./app/metrics";
 import initNext from "./app/next";
 import initStats from "./app/stats";
-import { database } from "./database";
+import { getDatabase } from "./database";
 import initHttpServer from "./http";
 import initRobots from "./robots";
 import basePath from "@cocalc/backend/base-path";
@@ -57,6 +57,7 @@ export default async function init(opts: Options): Promise<{
 }> {
   const winston = getLogger("express-app");
   winston.info("creating express app");
+  const database = getDatabase();
 
   // Create an express application
   const app = express();