API-668 Document and Validate Properties (#1001)

hazelcast · Aug 17, 2021 · 19cc638 · 19cc638
1 parent cb07e21
commit 19cc638
Show file tree

Hide file tree

Showing 142 changed files with 219 additions and 245 deletions.
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
diff --git a/scripts/test-runner.js b/scripts/test-runner.js
@@ -128,9 +128,22 @@ const startRC = async () => {
     throw `Could not reach to Hazelcast Remote Controller (127.0.0.1:9701) after trying ${retryCount} times.`;
 };
 
-const shutdownProcesses = () => {
-    console.log('Stopping remote controller and test processes...');
-    shutdownRC();
+const shutdown = async () => {
+    if (testProcess && testProcess.exitCode === null) {
+        stopTestProcess();
+    }
+
+    if (rcProcess && rcProcess.exitCode === null) {
+        await stopRC();
+    }
+
+    if (testProcess && testProcess.exitCode !== null) {
+        process.exit(testProcess.exitCode);
+    }
+};
+
+const stopTestProcess = () => {
+    console.log('Stopping test process');
     if (ON_WINDOWS) {
         spawnSync('taskkill', ['/pid', testProcess.pid, '/f', '/t']); // simple sigkill not enough on windows
     } else {
@@ -140,7 +153,8 @@ const shutdownProcesses = () => {
     }
 };
 
-const shutdownRC = async () => {
+const stopRC = async () => {
+    console.log('Stopping cluster and remote controller');
     if (cluster) {
         const RC = getRC();
         await RC.terminateCluster(cluster.id);
@@ -206,11 +220,11 @@ if (!fs.existsSync('./lib')) {
 // If running unit test, no need to start rc.
 if (testType === 'unit') {
     console.log(`Running unit tests... Test command: ${testCommand}`);
-    spawnSync(testCommand, [], {
+    const subprocess = spawnSync(testCommand, [], {
         stdio: ['ignore', 'inherit', 'inherit'],
         shell: true
     });
-    process.exit(0);
+    process.exit(subprocess.status);
 }
 
 // For other tests, download rc files if needed.
@@ -221,9 +235,9 @@ try {
     throw err;
 }
 
-process.on('SIGINT', shutdownProcesses);
-process.on('SIGTERM', shutdownProcesses);
-process.on('SIGHUP', shutdownProcesses);
+process.on('SIGINT', shutdown);
+process.on('SIGTERM', shutdown);
+process.on('SIGHUP', shutdown);
 
 startRC().then(async () => {
     console.log('Hazelcast Remote Controller is started!');
@@ -233,17 +247,20 @@ startRC().then(async () => {
             stdio: ['ignore', 'inherit', 'inherit'],
             shell: true
         });
-        testProcess.on('exit', shutdownRC);
+        testProcess.on('exit', shutdown);
     } else if (testType === 'check-code-samples') {
         const RC = getRC();
         cluster = await RC.createClusterKeepClusterName(null, DEV_CLUSTER_CONFIG);
+        let exitCode = 0;
         try {
             await codeSampleChecker.main(cluster);
         } catch (e) {
             console.error(e);
-            process.exit(1);
+            exitCode = 1;
         } finally {
-            await shutdownRC();
+            await shutdown();
+            // testProcess is undefined `shutdown` won't exit the process, so we exit with non-zero error code
+            process.exit(exitCode);
         }
     }
 }).catch(err => {

diff --git a/src/config/Config.ts b/src/config/Config.ts
@@ -154,7 +154,10 @@ export interface ClientConfig {
 
 }
 
-/** @internal */
+/**
+ * If you are adding a new property, don't forget to add its validation in `handleProperties`.
+ * @internal
+ */
 const DEFAULT_PROPERTIES: Properties = {
     'hazelcast.client.heartbeat.interval': 5000,
     'hazelcast.client.heartbeat.timeout': 60000,
@@ -179,9 +182,6 @@ const DEFAULT_PROPERTIES: Properties = {
     'hazelcast.discovery.public.ip.enabled': null,
 };
 
-/** @internal */
-export const PROPERTY_SET = new Set(Object.keys(DEFAULT_PROPERTIES));
-
 /** @internal */
 export class ClientConfigImpl implements ClientConfig {
     properties: Properties = {...DEFAULT_PROPERTIES}; // Create a new object

diff --git a/src/config/ConfigBuilder.ts b/src/config/ConfigBuilder.ts
@@ -25,7 +25,7 @@ import {
     tryGetNumber,
     tryGetString
 } from '../util/Util';
-import {ClientConfig, ClientConfigImpl, PROPERTY_SET} from './Config';
+import {ClientConfig, ClientConfigImpl} from './Config';
 import {EvictionPolicy} from './EvictionPolicy';
 import {FlakeIdGeneratorConfigImpl} from './FlakeIdGeneratorConfig';
 import {InMemoryFormat} from './InMemoryFormat';
@@ -35,6 +35,7 @@ import {ReliableTopicConfigImpl} from './ReliableTopicConfig';
 import {JsonStringDeserializationPolicy} from './JsonStringDeserializationPolicy';
 import {ReconnectMode} from './ConnectionStrategyConfig';
 import {LoadBalancerType} from './LoadBalancerConfig';
+import {LogLevel} from '../logging';
 
 /**
  * Responsible for user-defined config validation. Builds the effective config with necessary defaults.
@@ -223,10 +224,76 @@ export class ConfigBuilder {
 
     private handleProperties(jsonObject: any): void {
         for (const key in jsonObject) {
-            if (!PROPERTY_SET.has(key)) {
-                throw new RangeError(`Unexpected property '${key}' is passed to the Hazelcast Client`);
+            let value = jsonObject[key];
+            try {
+                switch (key) {
+                    case 'hazelcast.client.heartbeat.interval':
+                        value = tryGetNumber(value);
+                        break;
+                    case 'hazelcast.client.heartbeat.timeout':
+                        value = tryGetNumber(value);
+                        break;
+                    case 'hazelcast.client.invocation.retry.pause.millis':
+                        value = tryGetNumber(value);
+                        break;
+                    case 'hazelcast.client.invocation.timeout.millis':
+                        value = tryGetNumber(value);
+                        break;
+                    case 'hazelcast.client.internal.clean.resources.millis':
+                        value = tryGetNumber(value);
+                        break;
+                    case 'hazelcast.client.cloud.url':
+                        value = tryGetString(value);
+                        break;
+                    case 'hazelcast.client.statistics.enabled':
+                        value = tryGetBoolean(value);
+                        break;
+                    case 'hazelcast.client.statistics.period.seconds':
+                        value = tryGetNumber(value);
+                        break;
+                    case 'hazelcast.invalidation.reconciliation.interval.seconds':
+                        value = tryGetNumber(value);
+                        break;
+                    case 'hazelcast.invalidation.max.tolerated.miss.count':
+                        value = tryGetNumber(value);
+                        break;
+                    case 'hazelcast.invalidation.min.reconciliation.interval.seconds':
+                        value = tryGetNumber(value);
+                        break;
+                    case 'hazelcast.logging.level':
+                        tryGetEnum(LogLevel, value);
+                        break;
+                    case 'hazelcast.client.autopipelining.enabled':
+                        value = tryGetBoolean(value);
+                        break;
+                    case 'hazelcast.client.autopipelining.threshold.bytes':
+                        value = tryGetNumber(value);
+                        break;
+                    case 'hazelcast.client.socket.no.delay':
+                        value = tryGetBoolean(value);
+                        break;
+                    case 'hazelcast.client.shuffle.member.list':
+                        value = tryGetBoolean(value);
+                        break;
+                    case 'hazelcast.client.operation.backup.timeout.millis':
+                        value = tryGetNumber(value);
+                        break;
+                    case 'hazelcast.client.operation.fail.on.indeterminate.state':
+                        value = tryGetBoolean(value);
+                        break;
+                    case 'hazelcast.discovery.public.ip.enabled':
+                        if (value !== null && typeof value !== 'boolean') {
+                            throw new RangeError(`${value} is not null or a boolean.`);
+                        }
+                        break;
+                    default:
+                        throw new RangeError(`Unexpected property '${key}' is passed to the Hazelcast Client`);
+                }
+            } catch (e) {
+                throw new RangeError(`Property validation error: Property: ${key}, value: ${value}. Error: ${e}`);
             }
-            this.effectiveConfig.properties[key] = jsonObject[key];
+
+            this.effectiveConfig.properties[key] = value;
         }
     }
 

diff --git a/test/.eslintrc b/test/.eslintrc
@@ -17,7 +17,8 @@
         "max-len": ["warn", 130],
         "mocha/prefer-arrow-callback": ["error", {
             "allowNamedFunctions": true
-        }]
+        }],
+        "padded-blocks": ["error", "never"]
     },
     "parserOptions": {
         "ecmaVersion": 11

diff --git a/test/TestUtil.js b/test/TestUtil.js
@@ -200,7 +200,6 @@ exports.randomString = function (length) {
 };
 
 class CountingMembershipListener {
-
     constructor(expectedAdds, expectedRemoves) {
         this.adds = 0;
         this.expectedAdds = expectedAdds;
@@ -230,7 +229,6 @@ class CountingMembershipListener {
         }
         this._resolve();
     }
-
 }
 
 exports.CountingMembershipListener = CountingMembershipListener;

diff --git a/test/integration/ClientShutdownTest.js b/test/integration/ClientShutdownTest.js
@@ -31,7 +31,6 @@ const { ConnectionManager } = require('../../lib/network/ConnectionManager');
 const { InvocationService } = require('../../lib/invocation/InvocationService');
 
 describe('ClientShutdownTest', function () {
-
     let cluster;
 
     afterEach(async function () {

diff --git a/test/integration/ConnectionManagerTest.js b/test/integration/ConnectionManagerTest.js
@@ -31,7 +31,6 @@ const { promiseWaitMilliseconds } = require('../TestUtil');
  * Basic tests for `ConnectionManager`.
  */
 describe('ConnectionManagerTest', function () {
-
     let cluster;
     let client;
     let server;

diff --git a/test/integration/ConnectionManagerTranslateTest.js b/test/integration/ConnectionManagerTranslateTest.js
@@ -30,7 +30,6 @@ const { EndpointQualifier, ProtocolType } = require('../../lib/core/EndpointQual
  * Tests address translation done by `ConnectionManager`.
  */
 describe('ConnectionManagerTranslateTest', function () {
-
     const PROPERTY_DISCOVERY_PUBLIC_IP_ENABLED = 'hazelcast.discovery.public.ip.enabled';
     const REACHABLE_HOST = '127.0.0.1';
     const UNREACHABLE_HOST = '192.168.0.1';

diff --git a/test/integration/backward_compatible/AutoPipeliningDisabledTest.js b/test/integration/backward_compatible/AutoPipeliningDisabledTest.js
@@ -20,7 +20,6 @@ const RC = require('../RC');
 const { Client } = require('../../../');
 
 describe('AutoPipeliningDisabledTest', function () {
-
     let cluster;
     let client;
     let map;

diff --git a/test/integration/backward_compatible/ClientBackupAcksTest.js b/test/integration/backward_compatible/ClientBackupAcksTest.js
@@ -32,7 +32,6 @@ const { ClientLocalBackupListenerCodec } = require('../../../lib/codec/ClientLoc
  * so there is no need for additional member side configuration.
  */
 describe('ClientBackupAcksTest', function () {
-
     let cluster;
     let client;
 

diff --git a/test/integration/backward_compatible/ClientFailoverTest.js b/test/integration/backward_compatible/ClientFailoverTest.js
@@ -64,7 +64,6 @@ function createClientConfig({ clusterName, lifecycleListener, connectTimeoutMs }
  * Tests blue/green failover support for OSS.
  */
 describe('ClientFailoverTest - community', function () {
-
     let cluster1;
     let cluster2;
 
@@ -101,7 +100,6 @@ describe('ClientFailoverTest - community', function () {
  * Tests blue/green failover support for EE.
  */
 describe('ClientFailoverTest - enterprise', function () {
-
     let cluster1;
     let member1;
     let cluster2;

diff --git a/test/integration/backward_compatible/ClientHotRestartEventTest.js b/test/integration/backward_compatible/ClientHotRestartEventTest.js
@@ -26,7 +26,6 @@ const TestUtil = require('../../TestUtil');
  * This test assumes cluster with a single member.
  */
 describe('ClientHotRestartEventTest', function () {
-
     let client;
     let cluster;
 

diff --git a/test/integration/backward_compatible/ClientLabelTest.js b/test/integration/backward_compatible/ClientLabelTest.js
@@ -21,7 +21,6 @@ const RC = require('./../RC');
 const { Client } = require('../../../');
 
 describe('ClientLabelTest', function () {
-
     let cluster;
     let client;
 
@@ -50,5 +49,4 @@ describe('ClientLabelTest', function () {
         expect(res.result).to.not.be.null;
         expect(res.result.toString()).to.equal('testLabel');
     });
-
 });
diff --git a/test/integration/backward_compatible/ClientReconnectAdvancedTest.js b/test/integration/backward_compatible/ClientReconnectAdvancedTest.js
@@ -25,7 +25,6 @@ const TestUtil = require('../../TestUtil');
  * Advanced tests for reconnection to cluster scenarios.
  */
 describe('ClientReconnectAdvancedTest', function () {
-
     let cluster;
     let client;
 
@@ -95,7 +94,6 @@ describe('ClientReconnectAdvancedTest', function () {
             const member = members[0];
             expect(member.uuid.toString()).to.be.equal(newMember.uuid);
         });
-
     }
 
     async function testListenersAfterClientDisconnected(memberAddress, clientAddress) {

diff --git a/test/integration/backward_compatible/ClientReconnectTest.js b/test/integration/backward_compatible/ClientReconnectTest.js
@@ -24,7 +24,6 @@ const { markClientVersionAtLeast } = require('../../TestUtil');
  * Basic tests for reconnection to cluster scenarios.
  */
 describe('ClientReconnectTest', function () {
-
     let cluster;
     let client;
 

diff --git a/test/integration/backward_compatible/ClientRedoEnabledTest.js b/test/integration/backward_compatible/ClientRedoEnabledTest.js
@@ -27,7 +27,6 @@ const {
 } = require('../../../');
 
 describe('ClientRedoEnabledTest', function () {
-
     let cluster;
     let client;
 

diff --git a/test/integration/backward_compatible/ClusterServiceTest.js b/test/integration/backward_compatible/ClusterServiceTest.js
@@ -23,7 +23,6 @@ const RC = require('../RC');
 const { Client } = require('../../../');
 
 describe('ClusterServiceTest', function () {
-
     let cluster;
     let member1;
     let client;

diff --git a/test/integration/backward_compatible/ConnectionStrategyTest.js b/test/integration/backward_compatible/ConnectionStrategyTest.js
@@ -32,7 +32,6 @@ const { LifecycleState } = require('../../../lib/LifecycleService');
 const TestUtil = require('../../TestUtil');
 
 describe('ConnectionStrategyTest', function () {
-
     let cluster;
     let client;
 

diff --git a/test/integration/backward_compatible/DistributedObjectsTest.js b/test/integration/backward_compatible/DistributedObjectsTest.js
@@ -26,7 +26,6 @@ const { Client } = require('../../../');
 const TestUtil = require('../../TestUtil');
 
 describe('DistributedObjectsTest', function () {
-
     let cluster;
     let client;
 

diff --git a/test/integration/backward_compatible/HazelcastClientTest.js b/test/integration/backward_compatible/HazelcastClientTest.js
@@ -22,7 +22,6 @@ const { deferredPromise } = require('../../../lib/util/Util');
 const TestUtil = require('../../TestUtil');
 
 class ManagedObjects {
-
     constructor() {
         this.managedObjects = [];
     }
@@ -53,7 +52,6 @@ class ManagedObjects {
         });
         return deferred.promise;
     }
-
 }
 
 const dummyConfig = {
@@ -75,7 +73,6 @@ const configParams = [
 
 configParams.forEach((cfg) => {
     describe('HazelcastClientTest[smart=' + cfg.network.smartRouting + ']', function () {
-
         let cluster;
         let client;
         let managed;

diff --git a/test/integration/backward_compatible/InitialMembershipListenerTest.js b/test/integration/backward_compatible/InitialMembershipListenerTest.js
@@ -26,7 +26,6 @@ const { Client } = require('../../../');
 const { deferredPromise } = require('../../../lib/util/Util');
 
 describe('InitialMembershipListenerTest', function () {
-
     let cluster;
     let initialMember;
     let client;