/* Copyright 2017-2021 Norman Breau Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ import {IDatabaseConnection} from './IDatabaseConnection'; import {getInstance} from './instance'; import {Readable} from 'stream'; import { Query } from './Query'; import { IsolationLevel } from './IsolationLevel'; import { IDatabasePosition } from './IDatabasePosition'; import { IQueryable } from './IQueryable'; import { TransactionAccessLevel } from './TransactionAccessLevel'; const TAG: string = 'ManagedDatabaseConnection'; export class ManagedDatabaseConnection implements IDatabaseConnection { private $connection: IDatabaseConnection; /** * When true, this class will not close the connection or * allow transaction starts or ends. Methods for these actions * will be a no-op. */ private $managed: boolean; private $requiresWrite: boolean; private $instantionStack: string; public constructor(requiresWrite: boolean = false) { this.$managed = false; this.$requiresWrite = requiresWrite; this.$instantionStack = new Error().stack; } public isMaster(): boolean { throw new Error('Method not implemented.'); } public isReplication(): boolean { throw new Error('Method not implemented.'); } public hasReplicationEnabled(): boolean { throw new Error('Method not implemented.'); } public formatQuery(query: IQueryable): string { throw new Error('Unsupported API call'); } // TODO(Breaking): Turn this API into async public setConnection(connection: IDatabaseConnection): void { if (this.$connection) { // Store original connection because of async, // but we don't really need to wait for the async operations // to complete to set the new connection object. let oldConnection: IDatabaseConnection = this.$connection; /** * If the old connection has a transaction, only care about it * if this particular instance of managed connections has write access. */ if (this.$requiresWrite && oldConnection.isTransaction()) { getInstance().getLogger().warn(TAG, 'Rolling back a transaction because setConnection was called on a ManagedDatabaseConnection in a transaction in progress.'); getInstance().getLogger().trace(TAG, new Error('Stacktrace')); oldConnection.rollback().then(() => { return oldConnection.close(); }).catch((error: any) => { getInstance().getLogger().error(TAG, error); void oldConnection.close(true); }); } else { void oldConnection.close(); } } this.$connection = connection; this.$managed = true; } public isClosed(): boolean { if (this.$connection) { return this.$connection.isClosed(); } else { return true; } } public async getCurrentDatabasePosition(): Promise { let conn: IDatabaseConnection = await this.$getConnection(); return await conn.getCurrentDatabasePosition(); } public isWriteRequired(): boolean { return this.$requiresWrite; } public isManaged(): boolean { return this.$managed; } public hasConnection(): boolean { return !!this.$connection; } public setInstantiationStack(stack: string): void { if (this.hasConnection()) { this.$connection.setInstantiationStack(stack); } else { this.$instantionStack = stack; } } public getInstantiationStack(): string { if (this.hasConnection()) { return this.$connection.getInstantiationStack(); } else { return this.$instantionStack; } } public isReadOnly(): boolean { if (this.hasConnection()) { return this.$connection.isReadOnly(); } else { return true; } } // TODO: Turn this into a promise -- but the public interface also needs to change public setTimeout(timeout: number): void { this.$getConnection().then((connection: IDatabaseConnection) => { connection.setTimeout(timeout); }).catch((error: unknown) => { console.error(error); }); } public getTimeout(): number { if (this.hasConnection()) { return this.$connection.getTimeout(); } else { return null; } } public query(query: Query, params?: any): Promise { return new Promise((resolve, reject) => { this.$getConnection().then((connection: IDatabaseConnection) => { connection.query(query, params).then(resolve).catch(reject); }).catch(reject); }) } public stream(query: Query, params?: any, streamOptions?: any): Readable { throw new Error('stream is not supported on Managed Connections'); } public close(forceClose?: boolean): Promise { return new Promise((resolve, reject) => { if (this.hasConnection() && !this.isManaged()) { this.$connection.close(forceClose).then(() => { this.$connection = null; this.$managed = false; resolve(); }).catch(reject); } else { resolve(); } }); } public startTransaction(isolationLevel?: IsolationLevel, accessLevel?: TransactionAccessLevel): Promise { return new Promise((resolve, reject) => { this.$getConnection().then((connection: IDatabaseConnection) => { if (!this.isManaged()) { connection.startTransaction(isolationLevel, accessLevel).then(resolve).catch(reject); } else { resolve(); } }).catch(reject); }); } public isTransaction(): boolean { if (this.hasConnection()) { return this.$connection.isTransaction(); } else { return false; } } public commit(): Promise { return new Promise((resolve, reject) => { this.$getConnection().then((connection: IDatabaseConnection) => { if (!this.isManaged()) { connection.commit().then(resolve).catch(reject); } else { resolve(); } }).catch(reject); }); } public rollback(): Promise { return new Promise((resolve, reject) => { this.$getConnection().then((connection: IDatabaseConnection) => { if (!this.isManaged()) { connection.rollback().then(resolve).catch(reject); } else { resolve(); } }).catch(reject); }); } private $getConnection(): Promise { return new Promise((resolve, reject) => { let promise: Promise = null; let shouldSetInstantationStack: boolean = false; if (!this.$connection) { promise = getInstance().getDB().getConnection(this.$requiresWrite); shouldSetInstantationStack = true; } else { promise = Promise.resolve(this.$connection); } promise.then((connection: IDatabaseConnection) => { if (shouldSetInstantationStack) { connection.setInstantiationStack(this.$instantionStack); } this.$connection = connection; resolve(this.$connection); }).catch(reject); }); } public getAPI(): any { if (this.hasConnection()) { return this.$connection.getAPI(); } else { return null; } } }