@breautek/storm 8.0.0 → 8.1.0

package/src/private/ConnectionReplicationWaiter.ts

@@ -0,0 +1,110 @@
+
+/*
+   Copyright 2017-2024 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 { IDatabasePosition } from '../IDatabasePosition';
+import { InternalError } from '../InternalError';
+import { TimeoutError } from '../TimeoutError';
+
+export class ConnectionReplicationWaiter {
+    /**
+     * The default retry delay in milliseconds.
+     * Defaults to 1 second.
+     * 
+     * This is the value used in between status query iterations.
+     */
+    public static readonly DEFAULT_RETRY_DELAY: number = 1000;
+
+    /**
+     * The default timeout delay. Defaults to 120 seconds.
+     * If the connection could not reach the target position in time,
+     * then the wait will timeout
+     * 
+     * Using `Infinity` will disable the timeout
+     */
+    public static readonly DEFAULT_TIMEOUT = 120 * 1000; // 120 seconds in ms
+
+    private $conn: IDatabaseConnection;
+    private $retryDelay: number;
+
+    public constructor(conn: IDatabaseConnection, retryDelay: number = ConnectionReplicationWaiter.DEFAULT_RETRY_DELAY) {
+        this.$conn = conn;
+        this.$retryDelay = retryDelay;
+    }
+
+    private $sleep(timeout: number): Promise<void> {
+        return new Promise((resolve, reject) => {
+            setTimeout(() => {
+                resolve();
+            }, timeout);
+        });
+    }
+
+    public async wait(target: IDatabasePosition, timeout: number = ConnectionReplicationWaiter.DEFAULT_TIMEOUT): Promise<void> {
+        if (!this.$conn.isReadOnly()) {
+            return;
+        }
+
+        let shouldTimeout: boolean = false;
+        let didTimeout: boolean = false;
+
+        let timeoutTimer = setTimeout(() => {
+            shouldTimeout = true;
+        }, timeout);
+
+        // eslint-disable-next-line no-constant-condition
+        while (true) {
+            if (shouldTimeout) {
+                didTimeout = true;
+                break;
+            }
+
+            let currentPos: IDatabasePosition = await this.$conn.getCurrentDatabasePosition();
+
+            if (currentPos === null || (currentPos && !currentPos.page === null) || (currentPos && !currentPos.position === null)) {
+                throw new InternalError('Database Position not supported');
+            }
+
+            // If the current page is greater than the target page,
+            // then the position doesn't matter, we are ahead of the
+            // desired target position.
+            if (currentPos.page > target.page) {
+                break;
+            }
+
+            // If the pages are equal, we need to check the position
+            // and ensure we are at or greater than the target.
+            if (currentPos.page === target.page && currentPos.position >= target.position) {
+                break;
+            }
+
+            // If we made it here, it means the position state checks failed
+            // so wait a short while and then re-iterate
+            await this.$sleep(this.$retryDelay);
+        }
+
+        if (didTimeout) {
+            // If the while loop exited due to the timeout,
+            // then throw a timeout error
+            throw new TimeoutError();
+        }
+
+        // Otherwise we are good to go!
+        clearTimeout(timeoutTimer);
+    }
+}
+

package/src/private/GetBinLogPositionQuery.ts

@@ -0,0 +1,59 @@
+/*
+   Copyright 2017-2024 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 {Query} from '../Query';
+import {IDatabasePosition} from '../IDatabasePosition';
+import { IDatabaseConnection } from '../IDatabaseConnection';
+
+/**
+ * @since 8.1.0
+ */
+export abstract class GetBinLogPositionQuery<TStatusRow = unknown> extends Query<void, TStatusRow[], IDatabasePosition> {
+    protected abstract _getQuery(): string;
+
+    protected abstract _getFile(row: TStatusRow): string;
+    protected abstract _getPosition(row: TStatusRow): string;
+    
+    public async onPostProcess(connection: IDatabaseConnection, resultSet: TStatusRow[]): Promise<IDatabasePosition> {
+        let row: TStatusRow = null;
+        if (resultSet.length > 0) {
+            row = resultSet[0];
+        }
+
+        if (!row) {
+            return null;
+        }
+
+        let pageParts: string[] = this._getFile(row).split('.');
+        let strPage: string = pageParts[pageParts.length - 1];
+
+        let page: number = parseInt(strPage);
+
+        if (isNaN(page)) {
+            return null;
+        }
+
+        let position: number = parseInt(this._getPosition(row));
+        if (isNaN(position)) {
+            return null;
+        }
+
+        return {
+            page: page,
+            position: position
+        };
+    }
+}

package/src/private/GetMasterPositionQuery.ts

@@ -0,0 +1,37 @@
+/*
+   Copyright 2017-2024 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 { GetBinLogPositionQuery } from './GetBinLogPositionQuery';
+
+interface IStatus {
+    File: string;
+    Position: string;
+}
+
+export class GetMasterPositionQuery extends GetBinLogPositionQuery<IStatus> {
+
+    protected override _getQuery(): string {
+        return 'SHOW MASTER STATUS';
+    }
+
+    protected override _getFile(row: IStatus): string {
+        return row.File;
+    }
+
+    protected override _getPosition(row: IStatus): string {
+        return row.Position;
+    }
+}

package/src/private/GetSlavePositionQuery.ts

@@ -0,0 +1,37 @@
+/*
+   Copyright 2017-2024 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 { GetBinLogPositionQuery } from './GetBinLogPositionQuery';
+
+interface IStatus {
+    Master_Log_File: string;
+    Read_Master_Log_Pos: string;
+}
+
+export class GetSlavePositionQuery extends GetBinLogPositionQuery<IStatus> {
+
+    protected override _getQuery(): string {
+        return 'SHOW SLAVE STATUS';
+    }
+
+    protected override _getFile(row: IStatus): string {
+        return row.Master_Log_File;
+    }
+
+    protected override _getPosition(row: IStatus): string {
+        return row.Read_Master_Log_Pos;
+    }
+}