Handle improperly formatted mysql version strings (#124)

Handled MySQL version checks better and enabled tests for MySQL 5.7

Author: Rentacookie

.changeset/gentle-icons-try.md

@@ -0,0 +1,5 @@
+---
+'@powersync/service-module-mysql': patch
+---
+
+Fixed MySQL version checking to better handle non-semantic version strings

.github/workflows/test.yml

@@ -152,7 +152,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        mysql-version: [8.0, 8.4]
+        mysql-version: [5.7, 8.0, 8.4]
 
     steps:
       - uses: actions/checkout@v4
@@ -167,7 +167,8 @@ jobs:
           -d mysql:${{ matrix.mysql-version }} \
           --log-bin=/var/lib/mysql/mysql-bin.log \
           --gtid_mode=ON \
-          --enforce_gtid_consistency=ON
+          --enforce_gtid_consistency=ON \
+          --server-id=1
 
       - name: Start MongoDB
         uses: supercharge/[email protected]

modules/module-mysql/src/api/MySQLRouteAPIAdapter.ts

@@ -4,7 +4,7 @@ import * as sync_rules from '@powersync/service-sync-rules';
 import * as service_types from '@powersync/service-types';
 import mysql from 'mysql2/promise';
 import * as common from '../common/common-index.js';
-import * as mysql_utils from '../utils/mysql_utils.js';
+import * as mysql_utils from '../utils/mysql-utils.js';
 import * as types from '../types/types.js';
 import { toExpressionTypeFromMySQLType } from '../common/common-index.js';
 
@@ -326,7 +326,7 @@ export class MySQLRouteAPIAdapter implements api.RouteAPI {
             name: result.schema_name,
             tables: []
           });
- 
+
         const columns = JSON.parse(result.columns).map((column: { data_type: string; column_name: string }) => ({
           name: column.column_name,
           type: column.data_type,

modules/module-mysql/src/common/ReplicatedGTID.ts

@@ -1,6 +1,6 @@
 import mysql from 'mysql2/promise';
 import * as uuid from 'uuid';
-import * as mysql_utils from '../utils/mysql_utils.js';
+import * as mysql_utils from '../utils/mysql-utils.js';
 
 export type BinLogPosition = {
   filename: string;

modules/module-mysql/src/common/check-source-configuration.ts

@@ -1,8 +1,16 @@
 import mysqlPromise from 'mysql2/promise';
-import * as mysql_utils from '../utils/mysql_utils.js';
+import * as mysql_utils from '../utils/mysql-utils.js';
+
+const MIN_SUPPORTED_VERSION = '5.7.0';
 
 export async function checkSourceConfiguration(connection: mysqlPromise.Connection): Promise<string[]> {
   const errors: string[] = [];
+
+  const version = await mysql_utils.getMySQLVersion(connection);
+  if (!mysql_utils.isVersionAtLeast(version, MIN_SUPPORTED_VERSION)) {
+    errors.push(`MySQL versions older than ${MIN_SUPPORTED_VERSION} are not supported. Your version is: ${version}.`);
+  }
+
   const [[result]] = await mysql_utils.retriedQuery({
     connection,
     query: `
@@ -48,12 +56,3 @@ export async function checkSourceConfiguration(connection: mysqlPromise.Connecti
 
   return errors;
 }
-
-export async function getMySQLVersion(connection: mysqlPromise.Connection): Promise<string> {
-  const [[versionResult]] = await mysql_utils.retriedQuery({
-    connection,
-    query: `SELECT VERSION() as version`
-  });
-
-  return versionResult.version as string;
-}

modules/module-mysql/src/common/get-replication-columns.ts

@@ -1,6 +1,6 @@
 import { storage } from '@powersync/service-core';
 import mysqlPromise from 'mysql2/promise';
-import * as mysql_utils from '../utils/mysql_utils.js';
+import * as mysql_utils from '../utils/mysql-utils.js';
 
 export type GetReplicationColumnsOptions = {
   connection: mysqlPromise.Connection;

modules/module-mysql/src/common/read-executed-gtid.ts

@@ -1,26 +1,22 @@
 import mysqlPromise from 'mysql2/promise';
-import * as mysql_utils from '../utils/mysql_utils.js';
-import { gte } from 'semver';
-
+import * as mysql_utils from '../utils/mysql-utils.js';
 import { ReplicatedGTID } from './ReplicatedGTID.js';
-import { getMySQLVersion } from './check-source-configuration.js';
 
 /**
  * Gets the current master HEAD GTID
  */
 export async function readExecutedGtid(connection: mysqlPromise.Connection): Promise<ReplicatedGTID> {
-  const version = await getMySQLVersion(connection);
+  const version = await mysql_utils.getMySQLVersion(connection);
+
   let binlogStatus: mysqlPromise.RowDataPacket;
-  if (gte(version, '8.4.0')) {
-    // Get the BinLog status
+  if (mysql_utils.isVersionAtLeast(version, '8.4.0')) {
+    // Syntax for the below query changed in 8.4.0
     const [[binLogResult]] = await mysql_utils.retriedQuery({
       connection,
       query: `SHOW BINARY LOG STATUS`
     });
     binlogStatus = binLogResult;
   } else {
-    // TODO Check if this works for version 5.7
-    // Get the BinLog status
     const [[binLogResult]] = await mysql_utils.retriedQuery({
       connection,
       query: `SHOW MASTER STATUS`

modules/module-mysql/src/replication/BinLogStream.ts

@@ -11,7 +11,7 @@ import * as zongji_utils from './zongji/zongji-utils.js';
 import { MySQLConnectionManager } from './MySQLConnectionManager.js';
 import { isBinlogStillAvailable, ReplicatedGTID, toColumnDescriptors } from '../common/common-index.js';
 import mysqlPromise from 'mysql2/promise';
-import { createRandomServerId } from '../utils/mysql_utils.js';
+import { createRandomServerId } from '../utils/mysql-utils.js';
 
 export interface BinLogStreamOptions {
   connections: MySQLConnectionManager;

modules/module-mysql/src/replication/MySQLConnectionManager.ts

@@ -1,7 +1,7 @@
 import { NormalizedMySQLConnectionConfig } from '../types/types.js';
 import mysqlPromise from 'mysql2/promise';
 import mysql, { FieldPacket, RowDataPacket } from 'mysql2';
-import * as mysql_utils from '../utils/mysql_utils.js';
+import * as mysql_utils from '../utils/mysql-utils.js';
 import ZongJi from '@powersync/mysql-zongji';
 import { logger } from '@powersync/lib-services-framework';
 

…es/module-mysql/src/utils/mysql_utils.ts …es/module-mysql/src/utils/mysql-utils.tsmodules/module-mysql/src/utils/mysql_utils.ts renamed to modules/module-mysql/src/utils/mysql-utils.ts modules/module-mysql/src/utils/mysql_utils.ts renamed to modules/module-mysql/src/utils/mysql-utils.ts

@@ -2,6 +2,7 @@ import { logger } from '@powersync/lib-services-framework';
 import mysql from 'mysql2';
 import mysqlPromise from 'mysql2/promise';
 import * as types from '../types/types.js';
+import { coerce, gte } from 'semver';
 
 export type RetriedQueryOptions = {
   connection: mysqlPromise.Connection;
@@ -60,3 +61,24 @@ export function createPool(config: types.NormalizedMySQLConnectionConfig, option
 export function createRandomServerId(syncRuleId: number): number {
   return Number.parseInt(`${syncRuleId}00${Math.floor(Math.random() * 10000)}`);
 }
+
+export async function getMySQLVersion(connection: mysqlPromise.Connection): Promise<string> {
+  const [[versionResult]] = await retriedQuery({
+    connection,
+    query: `SELECT VERSION() as version`
+  });
+
+  return versionResult.version as string;
+}
+
+/**
+ *  Check if the current MySQL version is newer or equal to the target version.
+ *  @param version
+ *  @param minimumVersion
+ */
+export function isVersionAtLeast(version: string, minimumVersion: string): boolean {
+  const coercedVersion = coerce(version);
+  const coercedMinimumVersion = coerce(minimumVersion);
+
+  return gte(coercedVersion!, coercedMinimumVersion!, { loose: true });
+}