@celerispay/hazelcast-client 3.12.5

package/FAILOVER_FIXES.md

@@ -0,0 +1,284 @@
+# Hazelcast Node.js Client 3.12.5 - Connection Failover Fixes
+
+## Overview
+
+This document describes the critical fixes applied to resolve connection failover issues in the Hazelcast Node.js client version 3.12.5, published by CelerisPay. These fixes address the problem where the client would get stuck in invocation service errors and fail to properly failover to healthy nodes when partition owners go down.
+
+## Problem Description
+
+The original client had several critical issues:
+
+1. **Connection Leakage**: When a partition owner went down, the client would continue trying to use broken connections, leading to increasing connection counts
+2. **Poor Failover Logic**: The client didn't properly detect node failures and switch to healthy nodes
+3. **Inadequate Retry Mechanism**: The retry logic didn't handle partition ownership changes properly
+4. **Missing Health Checks**: No active connection health monitoring
+5. **Hanging Invocations**: Invocations would hang indefinitely instead of failing gracefully
+6. **Repeated Failures**: Client would repeatedly attempt to connect to known failed nodes
+
+## Root Causes
+
+### 1. ClientConnectionManager Issues
+- No connection health checking
+- Failed connections weren't properly cleaned up
+- No retry mechanism with backoff
+- Connection failures weren't tracked
+
+### 2. ClusterService Failover Problems
+- Poor handling of connection failures
+- No cooldown between failover attempts
+- Missing partition table refresh on failures
+- Inadequate error handling
+- No address blocking for failed nodes
+
+### 3. PartitionService Limitations
+- No partition table clearing on failures
+- Missing refresh rate limiting
+- Poor error handling during partition updates
+
+### 4. InvocationService Retry Issues
+- No maximum retry limits
+- Poor handling of partition-specific failures
+- Missing exponential backoff for partition failures
+
+## Fixes Applied
+
+### 1. Enhanced ClientConnectionManager
+
+#### Connection Health Monitoring
+```typescript
+private startConnectionHealthCheck(): void {
+    this.connectionHealthCheckInterval = setInterval(() => {
+        this.checkConnectionHealth();
+    }, 5000);
+}
+```
+
+#### Connection Retry with Backoff
+```typescript
+private retryConnection(address: Address, asOwner: boolean, retryCount: number = 0): Promise<ClientConnection> {
+    return this.createConnection(address, asOwner).then((connection) => {
+        this.failedConnections.delete(address.toString());
+        return connection;
+    }).catch((error) => {
+        if (retryCount < this.maxConnectionRetries) {
+            // Retry with delay
+            return new Promise((resolve) => {
+                setTimeout(() => {
+                    this.retryConnection(address, asOwner, retryCount + 1).then(resolve).catch(resolve);
+                }, this.connectionRetryDelay);
+            });
+        } else {
+            this.failedConnections.add(address.toString());
+            throw error;
+        }
+    });
+}
+```
+
+#### Failed Connection Tracking
+```typescript
+private failedConnections: Set<string> = new Set();
+```
+
+### 2. Improved ClusterService Failover
+
+#### Failover Cooldown
+```typescript
+private readonly failoverCooldown: number = 5000; // 5 seconds cooldown between failover attempts
+```
+
+#### Address Blocking System
+```typescript
+private downAddresses: Map<string, number> = new Map(); // address -> timestamp when marked down
+private readonly addressBlockDuration: number = 30000; // 30 seconds block duration for down addresses
+
+private isAddressKnownDown(address: Address): boolean {
+    const addressStr = address.toString();
+    const downTime = this.downAddresses.get(addressStr);
+    
+    if (!downTime) {
+        return false;
+    }
+    
+    const now = Date.now();
+    const timeSinceDown = now - downTime;
+    
+    // If address has been down for longer than block duration, unblock it
+    if (timeSinceDown > this.addressBlockDuration) {
+        this.downAddresses.delete(addressStr);
+        return false;
+    }
+    
+    // Address is still blocked
+    return true;
+}
+
+private markAddressAsDown(address: Address): void {
+    const addressStr = address.toString();
+    const now = Date.now();
+    
+    this.downAddresses.set(addressStr, now);
+    
+    // Schedule cleanup of this address after block duration
+    setTimeout(() => {
+        if (this.downAddresses.has(addressStr)) {
+            this.downAddresses.delete(addressStr);
+        }
+    }, this.addressBlockDuration);
+}
+```
+
+#### Structured Failover Process
+```typescript
+private triggerFailover(): void {
+    if (this.failoverInProgress || (now - this.lastFailoverAttempt) < this.failoverCooldown) {
+        return;
+    }
+    
+    this.failoverInProgress = true;
+    this.client.getPartitionService().clearPartitionTable();
+    this.connectToCluster()
+        .then(() => this.logger.info('Failover completed successfully'))
+        .catch((error) => this.client.shutdown())
+        .finally(() => this.failoverInProgress = false);
+}
+```
+
+### 3. Enhanced PartitionService
+
+#### Partition Table Clearing
+```typescript
+clearPartitionTable(): void {
+    this.partitionMap = {};
+    this.partitionCount = 0;
+    this.lastRefreshTime = 0;
+}
+```
+
+#### Refresh Rate Limiting
+```typescript
+private readonly minRefreshInterval: number = 2000; // Minimum 2 seconds between refreshes
+```
+
+### 4. Improved InvocationService
+
+#### Maximum Retry Limits
+```typescript
+private readonly maxRetryAttempts: number = 10;
+```
+
+#### Partition Failure Handling
+```typescript
+if (invocation.hasPartitionId()) {
+    return this.client.getPartitionService().refresh().then(() => {
+        return this.doInvoke(invocation);
+    });
+}
+```
+
+#### Enhanced Backoff Strategy
+```typescript
+let retryDelay = this.getInvocationRetryPauseMillis();
+if (invocation.hasPartitionId() && error instanceof IOError) {
+    retryDelay = this.partitionFailureBackoff;
+}
+```
+
+### 5. Configuration Improvements
+
+#### Enhanced Default Properties
+```typescript
+properties: Properties = {
+    // ... existing properties ...
+    'hazelcast.client.connection.health.check.interval': 5000,
+    'hazelcast.client.connection.max.retries': 3,
+    'hazelcast.client.connection.retry.delay': 1000,
+    'hazelcast.client.failover.cooldown': 5000,
+    'hazelcast.client.partition.refresh.min.interval': 2000,
+    'hazelcast.client.invocation.max.retries': 10,
+    'hazelcast.client.partition.failure.backoff': 2000,
+};
+```
+
+#### Network Configuration Improvements
+```typescript
+connectionAttemptLimit: number = 5; // Increased from 2
+connectionTimeout: number = 10000;  // Increased from 5000
+redoOperation: boolean = true;      // Changed from false
+```
+
+## Configuration Options
+
+### Connection Management
+- `hazelcast.client.connection.health.check.interval`: Connection health check interval (ms)
+- `hazelcast.client.connection.max.retries`: Maximum connection retry attempts
+- `hazelcast.client.connection.retry.delay`: Delay between connection retries (ms)
+
+### Failover Control
+- `hazelcast.client.failover.cooldown`: Cooldown period between failover attempts (ms)
+- `hazelcast.client.partition.refresh.min.interval`: Minimum interval between partition refreshes (ms)
+
+### Retry Behavior
+- `hazelcast.client.invocation.max.retries`: Maximum invocation retry attempts
+- `hazelcast.client.partition.failure.backoff`: Backoff delay for partition failures (ms)
+
+## Testing
+
+A comprehensive test suite has been added to verify the fixes:
+
+```bash
+npm test -- --grep "Connection Failover Test"
+```
+
+## Expected Behavior After Fixes
+
+1. **Graceful Failure Handling**: When a partition owner goes down, the client will detect the failure and failover to healthy nodes
+2. **Connection Cleanup**: Failed connections are properly cleaned up, preventing connection leakage
+3. **Automatic Recovery**: The client automatically refreshes partition information and retries operations
+4. **Limited Retries**: Operations have a maximum retry limit to prevent infinite loops
+5. **Health Monitoring**: Active connection health checking prevents use of broken connections
+6. **Address Blocking**: Failed addresses are temporarily blocked (30 seconds) to prevent repeated failures
+
+## Migration Notes
+
+### Breaking Changes
+- None - all changes are backward compatible
+
+### Performance Impact
+- Minimal overhead from health checking (5-second intervals)
+- Improved performance due to better connection management
+- Reduced memory usage from proper connection cleanup
+- Reduced network traffic by blocking failed addresses
+
+### Monitoring
+- Enhanced logging for connection failures and failover events
+- Connection health metrics available
+- Failover attempt tracking
+- Address blocking information in logs
+
+## Production Recommendations
+
+1. **Enable Statistics**: Set `hazelcast.client.statistics.enabled` to `true` for monitoring
+2. **Adjust Timeouts**: Increase `connectionTimeout` for slower networks
+3. **Monitor Logs**: Watch for failover events, connection health warnings, and address blocking
+4. **Load Testing**: Test failover scenarios under load to ensure stability
+
+## Future Enhancements
+
+1. **Circuit Breaker Pattern**: Implement circuit breaker for failed addresses
+2. **Metrics Collection**: Enhanced metrics for connection health and failover events
+3. **Configurable Health Checks**: Make health check intervals configurable per connection type
+4. **Advanced Retry Policies**: Configurable retry policies with different backoff strategies
+5. **Configurable Address Blocking**: Make block duration configurable per address type
+
+## Support
+
+For issues or questions regarding these fixes, please refer to the test suite and configuration examples provided in this repository.
+
+## Version Information
+
+- **Package Name**: `@celerispay/hazelcast-client`
+- **Version**: `3.12.5`
+- **Type**: Patch release with critical fixes
+- **Compatibility**: 100% backward compatible with 3.12.x
+- **Publisher**: CelerisPay

package/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   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.
+

package/QUICK_START.md

@@ -0,0 +1,143 @@
+# Quick Start - Fixed Hazelcast Node.js Client 3.12.5
+
+## Installation
+
+```bash
+# Install the fixed version
+npm install @celerispay/hazelcast-client@3.12.5
+
+# Or if you're using yarn
+yarn add @celerispay/hazelcast-client@3.12.5
+```
+
+## Basic Usage
+
+```javascript
+const { HazelcastClient } = require('@celerispay/hazelcast-client');
+
+async function createClient() {
+    const client = await HazelcastClient.newHazelcastClient({
+        networkConfig: {
+            addresses: ['10.0.20.30:5701', '10.0.20.31:5701'],
+            connectionAttemptLimit: 5,
+            connectionTimeout: 10000,
+            redoOperation: true,
+            smartRouting: true
+        },
+        properties: {
+            'hazelcast.client.connection.health.check.interval': 5000,
+            'hazelcast.client.connection.max.retries': 3,
+            'hazelcast.client.failover.cooldown': 5000,
+            'hazelcast.client.invocation.max.retries': 10
+        }
+    });
+    
+    return client;
+}
+```
+
+## Key Improvements
+
+✅ **Connection Health Monitoring** - Active health checks every 5 seconds  
+✅ **Automatic Failover** - Seamless switching to healthy nodes  
+✅ **Connection Cleanup** - No more connection leakage  
+✅ **Smart Retry Logic** - Intelligent retry with backoff  
+✅ **Partition Table Refresh** - Automatic partition ownership updates  
+✅ **Address Blocking** - Temporary blocking of failed addresses to prevent repeated failures  
+
+## Configuration
+
+### Essential Properties
+
+```javascript
+properties: {
+    // Connection health monitoring
+    'hazelcast.client.connection.health.check.interval': 5000,
+    'hazelcast.client.connection.max.retries': 3,
+    'hazelcast.client.connection.retry.delay': 1000,
+    
+    // Failover control
+    'hazelcast.client.failover.cooldown': 5000,
+    'hazelcast.client.partition.refresh.min.interval': 2000,
+    
+    // Retry behavior
+    'hazelcast.client.invocation.max.retries': 10,
+    'hazelcast.client.partition.failure.backoff': 2000
+}
+```
+
+### Network Configuration
+
+```javascript
+networkConfig: {
+    addresses: ['node1:5701', 'node2:5701'],
+    connectionAttemptLimit: 5,        // Increased from 2
+    connectionTimeout: 10000,         // Increased from 5000
+    redoOperation: true,              // Changed from false
+    smartRouting: true
+}
+```
+
+## Testing the Fix
+
+```bash
+# Run the failover tests
+npm test -- --grep "Connection Failover Test"
+
+# Run all tests
+npm test
+```
+
+## Migration from Previous Versions
+
+1. **Update package.json**:
+   ```json
+   "dependencies": {
+     "@celerispay/hazelcast-client": "3.12.5"
+   }
+   ```
+
+2. **Update import statement**:
+   ```javascript
+   // Before
+   const { HazelcastClient } = require('hazelcast-client');
+   
+   // After
+   const { HazelcastClient } = require('@celerispay/hazelcast-client');
+   ```
+
+3. **No other code changes required** - All fixes are backward compatible
+
+## What's Fixed
+
+- ❌ **Before**: Client hangs on partition owner failure
+- ✅ **After**: Automatic failover to healthy nodes
+
+- ❌ **Before**: Connection count keeps increasing
+- ✅ **After**: Failed connections are properly cleaned up
+
+- ❌ **Before**: Invocations hang indefinitely
+- ✅ **After**: Operations fail gracefully with retry limits
+
+- ❌ **Before**: No health monitoring
+- ✅ **After**: Active connection health checking
+
+- ❌ **Before**: Repeated attempts to failed nodes
+- ✅ **After**: Temporary blocking of failed addresses (30 seconds)
+
+## Production Recommendations
+
+1. **Enable Statistics**: `'hazelcast.client.statistics.enabled': true`
+2. **Monitor Logs**: Watch for failover events and address blocking
+3. **Load Test**: Verify failover behavior under load
+4. **Health Checks**: Use connection health metrics
+
+## Support
+
+- **Documentation**: See `FAILOVER_FIXES.md` for detailed information
+- **Tests**: Run test suite to verify functionality
+- **Issues**: Report problems in the repository
+
+---
+
+**Note**: This version (3.12.5) includes critical connection failover fixes and is published by CelerisPay. Consider upgrading to Hazelcast 4.x or 5.x for long-term support.