@powersync/service-module-mysql 0.0.0-dev-20241021185145 → 0.0.0-dev-20241022094219

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # @powersync/service-module-mysql
 
-## 0.0.0-dev-20241021185145
+## 0.0.0-dev-20241022094219
 
 ### Patch Changes
 
@@ -12,7 +12,7 @@
 - Updated dependencies [d2ece1b]
 - Updated dependencies [d51921f]
 - Updated dependencies [4ecaee2]
-  - @powersync/service-core@0.0.0-dev-20241021185145
-  - @powersync/lib-services-framework@0.0.0-dev-20241021185145
-  - @powersync/service-sync-rules@0.0.0-dev-20241021185145
-  - @powersync/service-types@0.0.0-dev-20241021185145
+  - @powersync/service-core@0.0.0-dev-20241022094219
+  - @powersync/lib-services-framework@0.0.0-dev-20241022094219
+  - @powersync/service-sync-rules@0.0.0-dev-20241022094219
+  - @powersync/service-types@0.0.0-dev-20241022094219

package/dist/index.d.ts

@@ -1,3 +1 @@
-import { MySQLModule } from './module/MySQLModule.js';
-export declare const module: MySQLModule;
-export default module;
+export * from './module/MySQLModule.js';

package/dist/index.js

@@ -1,4 +1,2 @@
-import { MySQLModule } from './module/MySQLModule.js';
-export const module = new MySQLModule();
-export default module;
+export * from './module/MySQLModule.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAEtD,MAAM,CAAC,MAAM,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC;AAExC,eAAe,MAAM,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC"}

package/dist/module/MySQLModule.d.ts

@@ -1,5 +1,6 @@
 import { api, replication, system, TearDownOptions } from '@powersync/service-core';
 import * as types from '../types/types.js';
+import { MySQLConnectionConfig } from '../types/types.js';
 export declare class MySQLModule extends replication.ReplicationModule<types.MySQLConnectionConfig> {
     constructor();
     initialize(context: system.ServiceContextContainer): Promise<void>;
@@ -10,4 +11,5 @@ export declare class MySQLModule extends replication.ReplicationModule<types.MyS
      */
     private resolveConfig;
     teardown(options: TearDownOptions): Promise<void>;
+    testConnection(config: MySQLConnectionConfig): Promise<void>;
 }

package/dist/module/MySQLModule.js

@@ -4,6 +4,8 @@ import { BinLogReplicator } from '../replication/BinLogReplicator.js';
 import { MySQLErrorRateLimiter } from '../replication/MySQLErrorRateLimiter.js';
 import * as types from '../types/types.js';
 import { MySQLConnectionManagerFactory } from '../replication/MySQLConnectionManagerFactory.js';
+import { checkSourceConfiguration } from '../common/check-source-configuration.js';
+import { MySQLConnectionManager } from '../replication/MySQLConnectionManager.js';
 export class MySQLModule extends replication.ReplicationModule {
     constructor() {
         super({
@@ -42,5 +44,20 @@ export class MySQLModule extends replication.ReplicationModule {
     async teardown(options) {
         // No specific teardown required for MySQL
     }
+    async testConnection(config) {
+        this.decodeConfig(config);
+        const normalisedConfig = this.resolveConfig(this.decodedConfig);
+        const connectionManager = new MySQLConnectionManager(normalisedConfig, {});
+        const connection = await connectionManager.getConnection();
+        try {
+            const errors = await checkSourceConfiguration(connection);
+            if (errors.length > 0) {
+                throw new Error(errors.join('\n'));
+            }
+        }
+        finally {
+            await connectionManager.end();
+        }
+    }
 }
 //# sourceMappingURL=MySQLModule.js.map

package/dist/module/MySQLModule.js.map

@@ -1 +1 @@
-{"version":3,"file":"MySQLModule.js","sourceRoot":"","sources":["../../src/module/MySQLModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,kCAAkC,EAAE,WAAW,EAA2B,MAAM,yBAAyB,CAAC;AAExH,OAAO,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AACtE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAE,qBAAqB,EAAE,MAAM,yCAAyC,CAAC;AAChF,OAAO,KAAK,KAAK,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,6BAA6B,EAAE,MAAM,iDAAiD,CAAC;AAEhG,MAAM,OAAO,WAAY,SAAQ,WAAW,CAAC,iBAA8C;IACzF;QACE,KAAK,CAAC;YACJ,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,KAAK,CAAC,qBAAqB;YACjC,YAAY,EAAE,KAAK,CAAC,qBAAqB;SAC1C,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,OAAuC;QACtD,MAAM,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAES,qBAAqB;QAC7B,OAAO,IAAI,oBAAoB,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,aAAc,CAAC,CAAC,CAAC;IAC3E,CAAC;IAES,gBAAgB,CAAC,OAA8B;QACvD,MAAM,gBAAgB,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,aAAc,CAAC,CAAC;QACjE,MAAM,gBAAgB,GAAG,IAAI,kCAAkC,CAAC,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAClG,MAAM,iBAAiB,GAAG,IAAI,6BAA6B,CAAC,gBAAgB,CAAC,CAAC;QAE9E,OAAO,IAAI,gBAAgB,CAAC;YAC1B,EAAE,EAAE,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,QAAQ,CAAC;YAChD,gBAAgB,EAAE,gBAAgB;YAClC,aAAa,EAAE,OAAO,CAAC,aAAa;YACpC,iBAAiB,EAAE,iBAAiB;YACpC,WAAW,EAAE,IAAI,qBAAqB,EAAE;SACzC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACK,aAAa,CAAC,MAAmC;QACvD,OAAO;YACL,GAAG,MAAM;YACT,GAAG,KAAK,CAAC,yBAAyB,CAAC,MAAM,CAAC;SAC3C,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,OAAwB;QACrC,0CAA0C;IAC5C,CAAC;CACF"}
+{"version":3,"file":"MySQLModule.js","sourceRoot":"","sources":["../../src/module/MySQLModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,kCAAkC,EAAE,WAAW,EAA2B,MAAM,yBAAyB,CAAC;AAExH,OAAO,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AACtE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAE,qBAAqB,EAAE,MAAM,yCAAyC,CAAC;AAChF,OAAO,KAAK,KAAK,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,6BAA6B,EAAE,MAAM,iDAAiD,CAAC;AAEhG,OAAO,EAAE,wBAAwB,EAAE,MAAM,yCAAyC,CAAC;AACnF,OAAO,EAAE,sBAAsB,EAAE,MAAM,0CAA0C,CAAC;AAElF,MAAM,OAAO,WAAY,SAAQ,WAAW,CAAC,iBAA8C;IACzF;QACE,KAAK,CAAC;YACJ,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,KAAK,CAAC,qBAAqB;YACjC,YAAY,EAAE,KAAK,CAAC,qBAAqB;SAC1C,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,OAAuC;QACtD,MAAM,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAES,qBAAqB;QAC7B,OAAO,IAAI,oBAAoB,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,aAAc,CAAC,CAAC,CAAC;IAC3E,CAAC;IAES,gBAAgB,CAAC,OAA8B;QACvD,MAAM,gBAAgB,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,aAAc,CAAC,CAAC;QACjE,MAAM,gBAAgB,GAAG,IAAI,kCAAkC,CAAC,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAClG,MAAM,iBAAiB,GAAG,IAAI,6BAA6B,CAAC,gBAAgB,CAAC,CAAC;QAE9E,OAAO,IAAI,gBAAgB,CAAC;YAC1B,EAAE,EAAE,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,QAAQ,CAAC;YAChD,gBAAgB,EAAE,gBAAgB;YAClC,aAAa,EAAE,OAAO,CAAC,aAAa;YACpC,iBAAiB,EAAE,iBAAiB;YACpC,WAAW,EAAE,IAAI,qBAAqB,EAAE;SACzC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACK,aAAa,CAAC,MAAmC;QACvD,OAAO;YACL,GAAG,MAAM;YACT,GAAG,KAAK,CAAC,yBAAyB,CAAC,MAAM,CAAC;SAC3C,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,OAAwB;QACrC,0CAA0C;IAC5C,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,MAA6B;QAChD,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAC1B,MAAM,gBAAgB,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,aAAc,CAAC,CAAC;QACjE,MAAM,iBAAiB,GAAG,IAAI,sBAAsB,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;QAC3E,MAAM,UAAU,GAAG,MAAM,iBAAiB,CAAC,aAAa,EAAE,CAAC;QAC3D,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,wBAAwB,CAAC,UAAU,CAAC,CAAC;YAC1D,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACtB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YACrC,CAAC;QACH,CAAC;gBAAS,CAAC;YACT,MAAM,iBAAiB,CAAC,GAAG,EAAE,CAAC;QAChC,CAAC;IACH,CAAC;CACF"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@powersync/service-module-mysql",
   "repository": "https://github.com/powersync-ja/powersync-service",
   "types": "dist/index.d.ts",
-  "version": "0.0.0-dev-20241021185145",
+  "version": "0.0.0-dev-20241022094219",
   "license": "FSL-1.1-Apache-2.0",
   "main": "dist/index.js",
   "type": "module",
@@ -29,10 +29,10 @@
     "ts-codec": "^1.2.2",
     "uri-js": "^4.4.1",
     "uuid": "^9.0.1",
-    "@powersync/lib-services-framework": "0.0.0-dev-20241021185145",
-    "@powersync/service-core": "0.0.0-dev-20241021185145",
-    "@powersync/service-sync-rules": "0.0.0-dev-20241021185145",
-    "@powersync/service-types": "0.0.0-dev-20241021185145"
+    "@powersync/lib-services-framework": "0.0.0-dev-20241022094219",
+    "@powersync/service-core": "0.0.0-dev-20241022094219",
+    "@powersync/service-sync-rules": "0.0.0-dev-20241022094219",
+    "@powersync/service-types": "0.0.0-dev-20241022094219"
   },
   "devDependencies": {
     "@types/semver": "^7.5.4",

package/src/common/check-source-configuration.ts

@@ -1,7 +1,7 @@
 import mysqlPromise from 'mysql2/promise';
 import * as mysql_utils from '../utils/mysql_utils.js';
 
-export async function checkSourceConfiguration(connection: mysqlPromise.Connection) {
+export async function checkSourceConfiguration(connection: mysqlPromise.Connection): Promise<string[]> {
   const errors: string[] = [];
   const [[result]] = await mysql_utils.retriedQuery({
     connection,

package/src/index.ts

@@ -1,5 +1 @@
-import { MySQLModule } from './module/MySQLModule.js';
-
-export const module = new MySQLModule();
-
-export default module;
+export * from './module/MySQLModule.js';

package/src/module/MySQLModule.ts

@@ -5,6 +5,9 @@ import { BinLogReplicator } from '../replication/BinLogReplicator.js';
 import { MySQLErrorRateLimiter } from '../replication/MySQLErrorRateLimiter.js';
 import * as types from '../types/types.js';
 import { MySQLConnectionManagerFactory } from '../replication/MySQLConnectionManagerFactory.js';
+import { MySQLConnectionConfig } from '../types/types.js';
+import { checkSourceConfiguration } from '../common/check-source-configuration.js';
+import { MySQLConnectionManager } from '../replication/MySQLConnectionManager.js';
 
 export class MySQLModule extends replication.ReplicationModule<types.MySQLConnectionConfig> {
   constructor() {
@@ -50,4 +53,19 @@ export class MySQLModule extends replication.ReplicationModule<types.MySQLConnec
   async teardown(options: TearDownOptions): Promise<void> {
     // No specific teardown required for MySQL
   }
+
+  async testConnection(config: MySQLConnectionConfig): Promise<void> {
+    this.decodeConfig(config);
+    const normalisedConfig = this.resolveConfig(this.decodedConfig!);
+    const connectionManager = new MySQLConnectionManager(normalisedConfig, {});
+    const connection = await connectionManager.getConnection();
+    try {
+      const errors = await checkSourceConfiguration(connection);
+      if (errors.length > 0) {
+        throw new Error(errors.join('\n'));
+      }
+    } finally {
+      await connectionManager.end();
+    }
+  }
 }