fix: make postgres adapter work

Author: clouedoc

src/adapters/postgresql-adapter.ts

@@ -2,72 +2,65 @@ import postgres, { JSONValue } from "postgres";
 import { IDatabaseAdapter } from "../interfaces/database-adapter";
 
 export class PostgreSQLAdapter implements IDatabaseAdapter {
-	private _url: string | undefined;
-	private _sql: postgres.Sql<{}> | undefined;
+	private async _connect(url: string): Promise<postgres.Sql<{}>> {
+		// note(clouedoc): there is a bug where postgres:// URLs are not working in Obsidian env, for some reason.
+		// (I think the issue is that the protocol is not recognized)
+		url = url.replace("postgres://", "http://");
+		url = url.replace("postgresql://", "http://");
 
-	public async ensureConnection(url: string): Promise<void> {
-		console.log("Connecting to PostgreSQL database at " + url);
-		if (this._url === url && this._sql) {
-			return;
-		}
-
-		this._url = url;
-		if (this._sql) {
-			await this._sql.end();
-			this._sql = undefined;
-		}
+		console.log("Connecting to URL: " + url);
+		const connUrl: URL = new URL(url);
 
-		this._sql = postgres(url, {
+		console.log(connUrl);
+		return postgres(url, {
 			prepare: false,
 			types: {
 				bigint: postgres.BigInt,
 			},
 		});
-		console.log("Connected to PostgreSQL database at " + url);
 	}
 
 	/**
 	 * Create the initial schema if not existing already.
 	 */
-	public async createInitialSchema(): Promise<void> {
+	public async migrate(url: string): Promise<void> {
 		console.log("Creating initial schema");
-		if (!this._sql) {
-			throw new Error("Not connected");
-		}
-		await this._sql`CREATE SCHEMA IF NOT EXISTS obsidian`;
-		await this._sql`CREATE TABLE IF NOT EXISTS obsidian.file (
+		// eslint-disable-next-line @typescript-eslint/typedef
+		const sql = await this._connect(url);
+		try {
+			await sql`CREATE SCHEMA IF NOT EXISTS obsidian`;
+			await sql`CREATE TABLE IF NOT EXISTS obsidian.file (
 					path text PRIMARY KEY,
 					dataview_data json
 			);`;
-		console.log("Created initial schema");
+			console.log("Created initial schema");
+		} finally {
+			await sql.end();
+		}
 	}
 
 	public async insertPage(
+		url: string,
 		path: string,
 		data: Record<string, unknown>
 	): Promise<void> {
-		console.log("Inserting page " + path);
-		if (!this._sql) {
-			throw new Error("Not connected");
-		}
+		// eslint-disable-next-line @typescript-eslint/typedef
+		const sql = await this._connect(url);
 
-		await this._sql`INSERT INTO obsidian.file
-			${this._sql({
+		try {
+			await sql`INSERT INTO obsidian.file
+			${sql({
 				path,
-				dataview_data: this._sql.json(data as JSONValue),
+				dataview_data: sql.json(data as JSONValue),
 			})}
 			ON CONFLICT (path)
 			DO
 				UPDATE SET dataview_data = EXCLUDED.dataview_data
 			;
 			`;
-		console.log("Inserted page " + path);
-	}
-
-	public async end(): Promise<void> {
-		if (this._sql) {
-			await this._sql.end();
-			this._sql = undefined;
+			console.log("Inserted page " + path);
+		} finally {
+			await sql.end();
 		}
 	}
 }

src/classes/postgresql-plugin.ts

@@ -21,7 +21,9 @@ export class PostgreSQLPlugin extends Plugin {
 			name: "PostgreSQL: upload current file information",
 			callback: async () => {
 				// ensure that an adapter is connected
-				const adapter: IDatabaseAdapter = await this._ensureAdapter();
+				const adapter: IDatabaseAdapter = await constructAdapter(
+					this.settings.adapterName
+				);
 
 				const dv: DataviewApi | undefined = getAPI();
 				if (!dv) {
@@ -52,7 +54,12 @@ export class PostgreSQLPlugin extends Plugin {
 				delete dataviewData.position;
 
 				try {
-					await adapter.insertPage(filepath, dataviewData);
+					await adapter.migrate(this.settings.connectionUrl);
+					await adapter.insertPage(
+						this.settings.connectionUrl,
+						filepath,
+						dataviewData
+					);
 					// eslint-disable-next-line no-new
 					new Notice(`${this.settings.adapterName}: Inserted page`);
 				} catch (err) {
@@ -63,10 +70,6 @@ export class PostgreSQLPlugin extends Plugin {
 		});
 	}
 
-	public async onunload(): Promise<void> {
-		await this._disconnectAdapter();
-	}
-
 	public async loadSettings(): Promise<void> {
 		this.settings = Object.assign(
 			{},
@@ -75,39 +78,8 @@ export class PostgreSQLPlugin extends Plugin {
 		);
 	}
 
-	/**
-	 * Disconnect the underlying database adapter.
-	 * Note: won't do anything if the adapter is not connected.
-	 */
-	private async _disconnectAdapter(): Promise<void> {
-		if (this._adapter) {
-			await this._adapter.end();
-			this._adapter = undefined;
-		}
-	}
-
-	/**
-	 * Ensure that a database adapter is connected.
-	 */
-	private async _ensureAdapter(): Promise<IDatabaseAdapter> {
-		await this._disconnectAdapter();
-		this._adapter = await constructAdapter(
-			this.settings.adapterName,
-			this.settings.connectionUrl
-		);
-		return this._adapter;
-	}
-
 	public async saveSettings(): Promise<void> {
 		// FIXME: debounce this function
 		await this.saveData(this.settings);
-		try {
-			await this._ensureAdapter();
-		} catch (err) {
-			// eslint-disable-next-line no-new
-			new Notice(
-				`${this.settings.adapterName} instantiation error: ${err}`
-			);
-		}
 	}
 }

src/functions/construct-adapter.spec.ts

@@ -3,9 +3,6 @@ import { constructAdapter } from "./construct-adapter";
 
 it.skip("can construct a PostgreSQL adapter", async () => {
 	await expect(
-		constructAdapter(
-			AdapterName.PostgreSQL,
-			"postgres://gitpod:1234@localhost:5432/postgres"
-		)
+		constructAdapter(AdapterName.PostgreSQL)
 	).resolves.not.toThrow();
 });

src/functions/construct-adapter.ts

@@ -11,19 +11,8 @@ const adapters: Record<AdapterName, IDatabaseAdapter> = {
  * @returns
  */
 export async function constructAdapter(
-	name: AdapterName,
-	url: string
+	name: AdapterName
 ): Promise<IDatabaseAdapter> {
 	const adapter: IDatabaseAdapter = adapters[name];
-	try {
-		await adapter.ensureConnection(url);
-	} catch (err) {
-		throw new Error("Error while ensuring connection: " + err);
-	}
-	try {
-		await adapter.createInitialSchema();
-	} catch (err) {
-		throw new Error("Error while creating initial schema: " + err);
-	}
 	return adapter;
 }

src/interfaces/database-adapter.ts

@@ -2,7 +2,7 @@ export interface IDatabaseAdapter {
 	/**
 	 * Create the initial schema of the database, if required
 	 */
-	createInitialSchema: (url: string) => Promise<void>;
+	migrate: (url: string) => Promise<void>;
 	/**
 	 * Insert a page into the database
 	 */