@breautek/storm 9.2.0 → 9.2.2

package/src/MySQLConnection.ts

@@ -37,6 +37,8 @@ import { GetMasterPositionQuery } from './private/GetMasterPositionQuery';
 import { IQueryable } from './IQueryable';
 import { TransactionAccessLevel } from './TransactionAccessLevel';
 import { GetProcessList, IGetProcessListOutput } from './private/GetProcessList';
+import { GetMySQLVersion, IGetMySQLVersionResult } from './GetMySQLVersion';
+import { GetPrimaryPositionQuery } from './private/GetPrimaryPositionQuery';
 
 const DEFAULT_HIGH_WATERMARK: number = 512; // in number of result objects
 const TAG: string = 'MySQLConnection';
@@ -64,29 +66,47 @@ export class MySQLConnection extends DatabaseConnection<MySQL.PoolConnection> {
     private $opened: boolean;
     private $hasReplicationEnabled: boolean;
     private $isMasterConnection: boolean;
+    private $version: IGetMySQLVersionResult;
 
     public constructor(connection: MySQL.PoolConnection, instantiationStack: string, isReadOnly: boolean = true) {
         connection.config.namedPlaceholders = true;
+
+        if (!getInstance().getConfig().enableMySQL2BreakingChanges) {
+            connection.config.typeCast = function (field: MySQL.TypeCastField, next: MySQL.TypeCastNext): any {
+                // TODO: Expose a setting to opt out of these backwards-compatibility type casting
+                // So we can have a chance of a rolling refactor.
+                if (
+                    [
+                        'DECIMAL',
+                        'NEWDECIMAL',
+                        'DOUBLE'
+                    ].indexOf(field.type) > -1
+                ) {
+                    let parsed: number = parseFloat(field.string());
+                    if (isNaN(parsed)) {
+                        return null;
+                    }
+                    return parsed;
+                }
+                else if (
+                    ([
+                        'JSON'
+                    ]).indexOf(field.type) > -1
+                ) {
+                    return field.string();
+                }
+                else {
+                    return next();
+                }
+            };
+        }
+
         super(connection, isReadOnly, instantiationStack);
 
         this.$hasReplicationEnabled = false;
         this.$opened = true;
         this.$transaction = false;
         this.$isMasterConnection = null;
-
-        // connection.config.queryFormat = queryFormatter.bind(this);
-
-        // connection.config.queryFormat = function(query: string, values: any) {
-        //     if (!values) return query;
-
-        //     return query.replace(/:(\w+)/g, function(this: any, txt: string, key: string): string {
-        //         // eslint-disable-next-line no-prototype-builtins
-        //         if (values.hasOwnProperty(key)) {
-        //             return this.escape(values[key]);
-        //         }
-        //         return txt;
-        //     }.bind(this));
-        // };
     }
 
     /**
@@ -113,6 +133,14 @@ export class MySQLConnection extends DatabaseConnection<MySQL.PoolConnection> {
         }
     }
 
+    public async getVersion(): Promise<IGetMySQLVersionResult> {
+        if (!this.$version) {
+            this.$version = await new GetMySQLVersion().execute(this);
+        }
+
+        return {...this.$version};
+    }
+
     public override formatQuery(query: IQueryable<any>): string {
         return this.getAPI().format(query.getQuery(this), query.getParametersForQuery());
     }
@@ -148,7 +176,19 @@ export class MySQLConnection extends DatabaseConnection<MySQL.PoolConnection> {
     }
 
     public override async getCurrentDatabasePosition(): Promise<IDatabasePosition> {
-        let statusQuery: GetBinLogPositionQuery = this.isReplication() ? new GetSlavePositionQuery() : new GetMasterPositionQuery();
+        let version: IGetMySQLVersionResult = await this.getVersion();
+        let statusQuery: GetBinLogPositionQuery = null;
+
+        if (
+            (version.major === 8 && version.minor >= 4) || version.major >= 9
+        ) {
+            // >= 8.4 we need to use a different setof master/slave queries
+            statusQuery = this.isReplication() ? new GetSlavePositionQuery() : new GetPrimaryPositionQuery();
+        }
+        else {
+            statusQuery = this.isReplication() ? new GetSlavePositionQuery() : new GetMasterPositionQuery();
+        }
+
         return await statusQuery.execute(this);
     }
 

package/src/api.ts

@@ -43,6 +43,7 @@ export {Transaction} from './Transaction';
 export {IOKPacket} from './IOKPacket';
 export {IStoredProcedureResult} from './IStoredProcedureResult';
 export {TransactionAccessLevel} from './TransactionAccessLevel';
+export {GetMySQLVersion, IGetMySQLVersionResult, IGetMySQLVersionRow} from './GetMySQLVersion';
 
 // Errors
 export {ErrorCode} from './ErrorCode';

package/src/mysql/queryFormatter.ts

@@ -1,6 +1,17 @@
 
 import * as MySQL from 'mysql2';
 
+/**
+ * Formats a query by resolving named parameters.
+ * 
+ * With older `mysql` driver, this was used to facilitate actual named parameters.
+ * @since 9.2.0 - this is now only used for logging/debugging purposes, as `mysql2`
+ * driver has built-in named parameter support.
+ * 
+ * @param query 
+ * @param values 
+ * @returns 
+ */
 export function queryFormatter(query: string, values: any): string {
     if (!values) return query;
 

package/src/private/GetMasterPositionQuery.ts

@@ -21,6 +21,10 @@ interface IStatus {
     Position: string;
 }
 
+/**
+ * For use with MySQL 8.0 and earlier. Obsolete since MySQL 8.4
+ * @deprecated
+ */
 export class GetMasterPositionQuery extends GetBinLogPositionQuery<IStatus> {
 
     protected override _getQuery(): string {

package/src/private/GetPrimaryPositionQuery.ts

@@ -0,0 +1,40 @@
+/*
+   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;
+}
+
+/**
+ * For use with MySQL 8.4 and later
+ */
+export class GetPrimaryPositionQuery extends GetBinLogPositionQuery<IStatus> {
+
+    protected override _getQuery(): string {
+        return 'SHOW BINARY LOG STATUS';
+    }
+
+    protected override _getFile(row: IStatus): string {
+        return row.File;
+    }
+
+    protected override _getPosition(row: IStatus): string {
+        return row.Position;
+    }
+}