@vlasky/zongji 0.6.0 → 0.7.0

package/.tap/test-results/test_await_end.js.tap

@@ -1,19 +0,0 @@
-Test file starting
-TAP version 14
-Invalid host test starting
-Got error: ENOTFOUND
-# Subtest: Connect to an invalid host
-    ok 1 - should be equal
-Invalid host test ending
-    1..1
-ok 1 - Connect to an invalid host # time=112.602ms
-
-MySQL test starting
-Query callback! err: null
-# Subtest: Simple MySQL query
-    ok 1 - query worked
-MySQL test ending
-    1..1
-ok 2 - Simple MySQL query # time=11.899ms
-
-1..2

package/.tap/test-results/test_await_end2.js.tap

@@ -1,27 +0,0 @@
-TAP version 14
-# Subtest: Connect to an invalid host
-    ok 1 - should be equal
-    1..1
-ok 1 - Connect to an invalid host # time=11.133ms
-
-# Subtest: Simple MySQL query
-    not ok 1 - test unfinished
-      ---
-      at:
-        fileName: test_await_end2.js
-        lineNumber: 35
-        columnNumber: 5
-        isToplevel: true
-      stack: |
-        test_await_end2.js:35:5
-      test: Simple MySQL query
-      source: |
-        });
-      
-        tap.test('Simple MySQL query', async test => {
-        ----^
-          const conn = mysql.createConnection(settings);
-      ...
-    
-    Bail out! test unfinished
-Bail out! test unfinished

package/.tap/test-results/test_debug_init.js.tap

@@ -1,23 +0,0 @@
-Test file starting
-TAP version 14
-Invalid host test starting
-Got error: ENOTFOUND
-# Subtest: Connect to an invalid host
-    ok 1 - should be equal
-    1..1
-Teardown called
-ok 1 - Connect to an invalid host # time=10.054ms
-
-MySQL connection test starting
-Connection object created
-Running query...
-Query issued, waiting for callback...
-Query callback received
-Query result: [ { test: 1 } ]
-Connection destroyed
-# Subtest: Create MySQL connection
-    ok 1 - connection worked
-    1..1
-ok 2 - Create MySQL connection # time=11.332ms
-
-1..2

package/.tap/test-results/test_debug_init2.js.tap

@@ -1,35 +0,0 @@
-Test file starting
-TAP version 14
-Invalid host test starting
-Got error: ENOTFOUND
-# Subtest: Connect to an invalid host
-    ok 1 - should be equal
-    1..1
-Teardown called
-ok 1 - Connect to an invalid host # time=9.46ms
-
-Init db test starting
-Creating connection...
-Connection created, running querySequence...
-querySequence called, waiting for callback...
-# Subtest: Init db with querySequence
-    not ok 1 - test unfinished
-      ---
-      at:
-        fileName: test_debug_init2.js
-        lineNumber: 37
-        columnNumber: 5
-        isToplevel: true
-      stack: |
-        test_debug_init2.js:37:5
-      test: Init db with querySequence
-      source: |
-        });
-      
-        tap.test('Init db with querySequence', async test => {
-        ----^
-          console.log('Init db test starting');
-      ...
-    
-    Bail out! test unfinished
-Bail out! test unfinished

package/.tap/test-results/test_invalid_host.js.tap

@@ -1,34 +0,0 @@
-Test file starting at: 1769661151919
-TAP version 14
-Invalid host test starting at: 1769661151922
-ZongJi.start() called at: 1769661151927
-Got error at: 1769661151930 ENOTFOUND
-# Subtest: Connect to an invalid host
-    ok 1 - should be equal
-    1..1
-Teardown called at: 1769661151931
-ok 1 - Connect to an invalid host # time=10.183ms
-
-Init db test starting at: 1769661151932
-# Subtest: Initialise testing db
-    not ok 1 - test unfinished
-      ---
-      at:
-        fileName: test_invalid_host.js
-        lineNumber: 30
-        columnNumber: 5
-        isToplevel: true
-      stack: |
-        test_invalid_host.js:30:5
-      test: Initialise testing db
-      source: |
-        });
-      
-        tap.test('Initialise testing db', async test => {
-        ----^
-          console.log('Init db test starting at:', Date.now());
-          try {
-      ...
-    
-    Bail out! test unfinished
-Bail out! test unfinished

package/.tap/test-results/test_minimal.js.tap

@@ -1,26 +0,0 @@
-Test file starting
-TAP version 14
-Invalid host test starting
-Calling zongji.start()
-zongji.start() returned
-Got error: ENOTFOUND
-# Subtest: Connect to an invalid host
-    ok 1 - should be equal
-Calling test.end()
-    1..1
-Teardown starting
-Teardown completed
-ok 1 - Connect to an invalid host # time=10.599ms
-
-MySQL test starting
-Calling conn.query()
-conn.query() returned, waiting...
-test.end() returned
-Query callback! err: null
-# Subtest: Simple MySQL query
-    ok 1 - query worked
-Timeout reached
-    1..1
-ok 2 - Simple MySQL query # time=5001.569ms
-
-1..2

package/.tap/test-results/test_queryseq.js.tap

@@ -1,14 +0,0 @@
-Test file starting
-TAP version 14
-Init db test starting
-Creating connection...
-Connection created, running querySequence...
-querySequence called, waiting for callback...
-querySequence callback received, error: null
-Init complete
-# Subtest: Init db with querySequence
-    ok 1 - init worked
-    1..1
-ok 1 - Init db with querySequence # time=18.904ms
-
-1..1

package/.tap/test-results/test_timing.js.tap

@@ -1,17 +0,0 @@
-Test file starting at: 1769661140028
-TAP version 14
-Test 1 starting at: 1769661140031
-Test 1 ending at: 1769661140132
-# Subtest: Test 1
-    ok 1 - test 1 done
-    1..1
-ok 1 - Test 1 # time=103.078ms
-
-Test 2 starting at: 1769661140135
-Test 2 init complete at: 1769661140170
-# Subtest: Test 2 - init db
-    ok 1 - database initialized
-    1..1
-ok 2 - Test 2 - init db # time=35.205ms
-
-1..2

package/.tap/test-results/test_unref.js.tap

@@ -1,15 +0,0 @@
-TAP version 14
-# Subtest: Connect to an invalid host - with explicit cleanup
-    ok 1 - should be equal
-    not ok 2 - getaddrinfo ENOTFOUND wronghost
-      ---
-      errno: -3008
-      code: ENOTFOUND
-      syscall: getaddrinfo
-      hostname: wronghost
-      fatal: true
-      tapCaught: unhandledRejection
-      ...
-    
-    Bail out! getaddrinfo ENOTFOUND wronghost
-Bail out! getaddrinfo ENOTFOUND wronghost

package/.travis.yml

@@ -1,15 +0,0 @@
-language: node_js
-sudo: required
-dist: trusty
-node_js:
-  - "8"
-  - "12"
-services:
-  - docker
-before_script:
-  - npm run lint
-  - docker run -p 3355:3306 --name mysql-55 -e MYSQL_ROOT_PASSWORD=numtel -d mysql:5.5 --server-id=1 --log-bin=/var/lib/mysql/mysql-bin.log --binlog-format=row
-  - docker run -p 3356:3306 --name mysql-56 -e MYSQL_ROOT_PASSWORD=numtel -d mysql:5.6 --server-id=1 --log-bin=/var/lib/mysql/mysql-bin.log --binlog-format=row
-  - docker run -p 3357:3306 --name mysql-57 -e MYSQL_ROOT_PASSWORD=numtel -d mysql:5.7 --server-id=1 --log-bin=/var/lib/mysql/mysql-bin.log --binlog-format=row
-script:
-  - ./test/travis/runner.sh

package/CLAUDE.md

@@ -1,99 +0,0 @@
-# CLAUDE.md
-
-This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
-
-## Project Overview
-
-@vlasky/zongji is a MySQL binlog listener for Node.js that supports MySQL 5.7-8.4. It provides real-time change data capture (CDC) by listening to MySQL binary log events.
-
-The library uses `mysql2` for connections and authentication while implementing custom binlog protocol parsing.
-
-## Development Commands
-
-```bash
-# Install dependencies
-npm install
-
-# Run zongji tests (requires Docker)
-npm test
-
-# Run linter
-npm run lint
-
-# Check TypeScript definitions and JS type errors
-npm run checkjs
-```
-
-## Docker MySQL Client Command
-
-- Use this command to launch the mysql client:  docker exec -it docker-mysql mysql -u root -psecret
-
-## Architecture Overview
-
-The codebase follows an event-driven architecture with these key components:
-
-1. **Main Entry**: `index.js` - ZongJi class extending EventEmitter
-2. **Dual Connection Pattern**:
-   - Control connection for queries/metadata
-   - Binlog connection for streaming events
-3. **Event Processing Pipeline**:
-   - Custom `Command` class in `lib/sequence/binlog.js` for mysql2 integration
-   - Binary protocol parsing via `Parser` class in `lib/reader.js`
-   - Event type definitions in `lib/binlog_event.js`
-   - Row event handling in `lib/rows_event.js`
-   - Type-specific decoders (datetime, JSON) in lib/
-
-## Key Implementation Details
-
-- **Module System**: Uses ES modules (ESM) with import/export syntax
-- **TypeScript Support**: Includes TypeScript definitions (index.d.ts)
-- **MySQL Driver**: Uses `mysql2` for connections, authentication (including caching_sha2_password), and base protocol
-- **Custom Binlog Command**: Implements COM_BINLOG_DUMP (0x12) via custom `Command` class compatible with mysql2's command queue
-- **Parser Compatibility**: Custom `Parser` class in `lib/reader.js` provides mysql2 packet parsing interface
-- **Event Filtering**: Schema and event-type filtering before emission
-- **Position Tracking**: Maintains binlog filename and position for resumable processing
-- **Table Metadata**: Caches table structures for efficient row decoding
-- **Checksum Support**: Automatic detection and handling of binlog checksums (CRC32)
-- **Timezone Support**: Datetime decoders respect mysql2's `timezone` connection option
-- **GTID Support**: Parses Gtid, AnonymousGtid, and PreviousGtids events
-
-## Testing
-
-Tests use Docker Compose with MySQL containers:
-- Configuration in `docker-compose.yml`
-- Test database setup in `test/helpers/`
-- Event-specific tests in `test/` directory
-- Uses `tap` test framework (v21+)
-
-**Before running tests**, always:
-1. Ensure Docker containers are running: `docker-compose up -d` (or specific services e.g. `docker-compose up -d mysql80 mysql84`)
-2. Note: MySQL 5.7 image does not support ARM64 (Apple Silicon) — skip it on those machines
-3. Wait for MySQL to be ready before running tests (containers need ~10-15 seconds to initialise)
-
-When modifying binlog parsing or adding event support, ensure tests cover:
-- Event parsing correctness
-- Position tracking accuracy
-- Error handling scenarios
-- MySQL version compatibility
-
-## Common Development Tasks
-
-1. **Adding new event types**: Update `lib/binlog_event.js` and `lib/code_map.js`
-2. **Supporting new MySQL types**: Modify type parsing in `lib/rows_event.js` and `lib/common.js`
-3. **Protocol changes**: Update `lib/sequence/binlog.js` for command handling, `lib/reader.js` for parsing
-4. **Connection handling**: Modify `index.js` for connection lifecycle changes
-
-## Requirements
-
-- Node.js >= 18.0
-- MySQL 5.7, 8.0, or 8.4 with binlog enabled
-
-## Development Principles
-
-- **Avoid Duplicate Code**: Avoid creating duplicate code or duplicate functionality
-
-# important-instruction-reminders
-Do what has been asked; nothing more, nothing less.
-NEVER create files unless they're absolutely necessary for achieving your goal.
-ALWAYS prefer editing an existing file to creating a new one.
-NEVER proactively create documentation files (*.md) or README files. Only create documentation files if explicitly requested by the User.

package/GTID.md

@@ -1,54 +0,0 @@
-# GTID discussion
-
-This file summarizes our discussion about GTID handling in zongji and possible
-exposure patterns for application use.
-
-## Current behavior
-
-- GTID-related binlog events are parsed and emitted as their own events:
-  - `Gtid`
-  - `AnonymousGtid`
-  - `PreviousGtids`
-- The GTID event objects contain:
-  - `event.gtid` (string: `uuid:sequence`)
-  - `event.sid` (UUID string)
-  - `event.gno` (sequence number)
-  - For `PreviousGtids`: `event.sids` and `event.gtidSet`
-- Row events (`WriteRows`, `UpdateRows`, `DeleteRows`) do not currently include
-  GTID information.
-
-## Practical uses for GTID
-
-- Checkpointing: store the latest GTID and resume from it after restart/failover.
-- Deduplication / exactly-once: use GTID as a unique transaction ID.
-- Auditing / debugging: correlate binlog events with replication state.
-
-## Transaction boundaries
-
-- Start of a GTID transaction:
-  - `Gtid` event (when `gtid_mode=ON`).
-- Start of a non-GTID transaction:
-  - `Query` event with `BEGIN`.
-- End (commit) of row-based transactions:
-  - `Xid` event.
-- End (commit/rollback) of statement-based transactions:
-  - `Query` event with `COMMIT` or `ROLLBACK`.
-
-## Open questions / options
-
-1) Add `zongji.lastGtid`:
-   - Updated when a `Gtid` or `AnonymousGtid` event is received.
-   - Useful for external checkpointing without subscribing to GTID events.
-
-2) Attach `event.gtid` to row events:
-   - Copied from `zongji.lastGtid`.
-   - Lets users compare row events to see when GTID changes.
-   - Only reliable when `gtid_mode=ON` (undefined for non-GTID transactions).
-
-3) Add high-level transaction boundary events:
-   - Emit `transactionStart`/`transactionCommit`/`transactionRollback` with
-     GTID and event metadata.
-
-Notes:
-- Adding `event.gtid` and/or `zongji.lastGtid` is additive and should be
-  backward-compatible, but it depends on GTID mode being enabled in MySQL.

package/TODO.md

@@ -1,43 +0,0 @@
-# TODO: MySQL 8 binlog events and partial JSON support
-
-This note summarizes the discussion about additional MySQL 8 binlog events and
-partial JSON handling.
-
-## Events not currently supported
-
-- PARTIAL_UPDATE_ROWS_EVENT
-- TRANSACTION_PAYLOAD_EVENT
-- HEARTBEAT_LOG_EVENT_V2
-
-Currently these events are not mapped in `lib/code_map.js`, so they arrive as
-`Unknown` and are effectively ignored.
-
-## Practical impact
-
-- PARTIAL_UPDATE_ROWS_EVENT:
-  - Emitted when `binlog_row_value_options=PARTIAL_JSON`.
-  - Encodes JSON diffs instead of full JSON values.
-  - Only appears if partial JSON is enabled.
-- TRANSACTION_PAYLOAD_EVENT:
-  - Used with transaction compression (MySQL 8.0.20+).
-  - Wraps multiple events in a compressed payload.
-  - Only appears if transaction compression is enabled.
-- HEARTBEAT_LOG_EVENT_V2:
-  - Replication keepalive/monitoring; no data changes.
-
-## Possible support approach
-
-1) Add event mappings and parsers:
-   - Update `lib/code_map.js` to map event IDs.
-   - Implement parser classes in `lib/binlog_event.js` (and any helpers).
-2) Extend tests:
-   - Add targeted tests that enable the corresponding MySQL settings.
-   - Assert event emission and basic payload shape.
-
-## Partial JSON strategy options
-
-- Option A: expose raw JSON diff data from PARTIAL_UPDATE_ROWS_EVENT.
-  - Lowest effort; consumers apply patches.
-- Option B: reconstruct full JSON values.
-  - Requires FULL row image or a row-state cache to apply diffs.
-  - More complex but produces complete row values.

package/docker-compose.yml

@@ -1,33 +0,0 @@
----
-services:
-  mysql57:
-    image: mysql:5.7
-    command: [ "--server-id=1", "--log-bin=/var/lib/mysql/mysql-bin.log", "--binlog-format=row"]
-    networks:
-      default:
-        aliases:
-          - mysql57
-    environment:
-      MYSQL_ROOT_PASSWORD: secret
-
-  mysql80:
-    image: mysql:8.0
-    command: [ "--server-id=1", "--log-bin=/var/lib/mysql/mysql-bin.log", "--binlog-format=row"]
-    networks:
-      default:
-        aliases:
-          - mysql80
-    environment:
-      MYSQL_ROOT_PASSWORD: secret
-
-  mysql84:
-    image: mysql:8.4
-    command: [ "--server-id=1", "--log-bin=/var/lib/mysql/mysql-bin.log", "--binlog-format=row"]
-    ports:
-      - "3306:3306"
-    networks:
-      default:
-        aliases:
-          - mysql84
-    environment:
-      MYSQL_ROOT_PASSWORD: secret

package/docker-test.sh

@@ -1,11 +0,0 @@
-#!/bin/bash
-MYSQL_HOSTS="mysql57 mysql80 mysql84"
-
-for hostname in ${MYSQL_HOSTS}; do
-  echo $hostname + node 18
-  docker run -it --network=zongji_default -e MYSQL_HOST=$hostname -w /build -v $PWD:/build node:18 npm test
-  echo $hostname + node 20
-  docker run -it --network=zongji_default -e MYSQL_HOST=$hostname -w /build -v $PWD:/build node:20 npm test
-  echo $hostname + node 22
-  docker run -it --network=zongji_default -e MYSQL_HOST=$hostname -w /build -v $PWD:/build node:22 npm test
-done

package/eslint.config.js

@@ -1,35 +0,0 @@
-import js from '@eslint/js';
-
-export default [
-  { ignores: ['.tap/'] },
-  js.configs.recommended,
-  {
-    languageOptions: {
-      ecmaVersion: 2022,
-      sourceType: 'module',
-      globals: {
-        Buffer: 'readonly',
-        clearImmediate: 'readonly',
-        clearInterval: 'readonly',
-        clearTimeout: 'readonly',
-        console: 'readonly',
-        process: 'readonly',
-        setImmediate: 'readonly',
-        setInterval: 'readonly',
-        setTimeout: 'readonly',
-      },
-    },
-    rules: {
-      'comma-dangle': ['warn', 'only-multiline'],
-      'eol-last': ['error'],
-      'keyword-spacing': ['error', { before: true }],
-      'no-console': 'off',
-      'no-trailing-spaces': ['error', { skipBlankLines: true }],
-      'no-unused-vars': 'warn',
-      'no-var': 'warn',
-      'quotes': ['warn', 'single', 'avoid-escape'],
-      'semi': ['error', 'always'],
-      'space-before-blocks': 'error',
-    },
-  },
-];

package/jsconfig.json

@@ -1,15 +0,0 @@
-{
-  "compilerOptions": {
-    "checkJs": true,
-    "allowJs": true,
-    "noEmit": true,
-    "target": "ES2022",
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext",
-    "skipDefaultLibCheck": true,
-    "maxNodeModuleJsDepth": 0,
-    "types": ["node"]
-  },
-  "include": ["index.js", "index.d.ts", "lib/**/*.js"],
-  "exclude": ["node_modules", ".tap"]
-}

package/lib/packet/combinlog.js

@@ -1,27 +0,0 @@
-class ComBinlog {
-  constructor({ serverId, nonBlock, filename, position }) {
-    this.command = 0x12;
-    this.position = position || 4;
-
-    // will send eof package if there is no more binlog event
-    // https://dev.mysql.com/doc/internals/en/com-binlog-dump.html#binlog-dump-non-block
-    this.flags = nonBlock ? 1 : 0;
-
-    this.serverId = serverId || 1;
-    this.filename = filename || '';
-  }
-
-  write(writer) {
-    writer.writeUnsignedNumber(1, this.command);
-    writer.writeUnsignedNumber(4, this.position);
-    writer.writeUnsignedNumber(2, this.flags);
-    writer.writeUnsignedNumber(4, this.serverId);
-    writer.writeNullTerminatedString(this.filename);
-  }
-
-  parse() {
-    throw new Error('should never be called here');
-  }
-}
-
-export default ComBinlog;

package/lib/packet/index.js

@@ -1,66 +0,0 @@
-import ComBinlog from './combinlog.js';
-import initBinlogPacketClass from './binlog.js';
-
-// from npm package mysql
-class EofPacket {
-  constructor(options = {}) {
-    this.fieldCount = undefined;
-    this.warningCount = options.warningCount;
-    this.serverStatus = options.serverStatus;
-    this.protocol41 = options.protocol41;
-  }
-
-  parse(parser) {
-    this.fieldCount = parser.parseUnsignedNumber(1);
-    if (this.protocol41) {
-      this.warningCount = parser.parseUnsignedNumber(2);
-      this.serverStatus = parser.parseUnsignedNumber(2);
-    }
-  }
-
-  write(writer) {
-    writer.writeUnsignedNumber(1, 0xfe);
-    if (this.protocol41) {
-      writer.writeUnsignedNumber(2, this.warningCount);
-      writer.writeUnsignedNumber(2, this.serverStatus);
-    }
-  }
-}
-
-// from npm package mysql
-class ErrorPacket {
-  constructor(options = {}) {
-    this.fieldCount = options.fieldCount;
-    this.errno = options.errno;
-    this.sqlStateMarker = options.sqlStateMarker;
-    this.sqlState = options.sqlState;
-    this.message = options.message;
-  }
-
-  parse(parser) {
-    this.fieldCount = parser.parseUnsignedNumber(1);
-    this.errno = parser.parseUnsignedNumber(2);
-
-    // sqlStateMarker ('#' = 0x23) indicates error packet format
-    if (parser.peak() === 0x23) {
-      this.sqlStateMarker = parser.parseString(1);
-      this.sqlState = parser.parseString(5);
-    }
-
-    this.message = parser.parsePacketTerminatedString();
-  }
-
-  write(writer) {
-    writer.writeUnsignedNumber(1, 0xff);
-    writer.writeUnsignedNumber(2, this.errno);
-
-    if (this.sqlStateMarker) {
-      writer.writeString(this.sqlStateMarker);
-      writer.writeString(this.sqlState);
-    }
-
-    writer.writeString(this.message);
-  }
-}
-
-export { EofPacket, ErrorPacket, ComBinlog, initBinlogPacketClass };