fix: improved validation, error message, add test

forcedotcom · Feb 4, 2021 · 63e6c4d · 63e6c4d
1 parent 1455204
commit 63e6c4d
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 2 deletions.
diff --git a/messages/config.json b/messages/config.json
@@ -5,7 +5,7 @@
   "InvalidApiVersion": "Specify a valid Salesforce API version, for example, 42.0",
   "InvalidIsvDebuggerSid": "Specify a valid Debugger SID",
   "InvalidIsvDebuggerUrl": "Specify a valid Debugger URL",
-  "InvalidNumberConfigValue": "Specify a valid number, for example, 150000",
+  "InvalidNumberConfigValue": "Specify a valid positive integer, for example, 150000",
   "InvalidBooleanConfigValue": "The config value can only be set to true or false.",
   "InvalidProjectWorkspace": "This directory does not contain a valid Salesforce DX project",
   "SchemaValidationWarning": "The config file: %s is not schema valid\nDue to: %s",

diff --git a/src/config/config.ts b/src/config/config.ts
@@ -181,7 +181,9 @@ export class Config extends ConfigFile<ConfigFile.Options> {
     {
       key: Config.MAX_QUERY_LIMIT,
       input: {
-        validator: (value) => !isNaN(Number(value)),
+        // the bit shift will remove the negative bit, and any decimal numbers
+        // then the parseFloat will handle converting it to a number from a string
+        validator: (value) => (value as number) >>> 0 === parseFloat(value as string),
         get failedMessage() {
           return Config.messages?.getMessage('InvalidNumberConfigValue');
         },

diff --git a/test/unit/config/configTest.ts b/test/unit/config/configTest.ts
@@ -165,6 +165,35 @@ describe('Config', () => {
             expect(err).to.have.property('name', 'InvalidConfigValue');
           }
         });
+
+        it('will throw an error when value is negative', async () => {
+          const config: Config = await Config.create(Config.getDefaultOptions(true));
+          try {
+            config.set('maxQueryLimit', '-123');
+            assert.fail('Expected an error to be thrown.');
+          } catch (err) {
+            expect(err).to.have.property('name', 'InvalidConfigValue');
+          }
+        });
+
+        it('will throw an error when value is negative decimal', async () => {
+          const config: Config = await Config.create(Config.getDefaultOptions(true));
+          try {
+            config.set('maxQueryLimit', '-123.456');
+            assert.fail('Expected an error to be thrown.');
+          } catch (err) {
+            expect(err).to.have.property('name', 'InvalidConfigValue');
+          }
+        });
+        it('will throw an error when value is negative integer', async () => {
+          const config: Config = await Config.create(Config.getDefaultOptions(true));
+          try {
+            config.set('maxQueryLimit', '-123');
+            assert.fail('Expected an error to be thrown.');
+          } catch (err) {
+            expect(err).to.have.property('name', 'InvalidConfigValue');
+          }
+        });
         it('will set config value with stringified number', async () => {
           const config: Config = await Config.create(Config.getDefaultOptions(true));
           const res = config.set('maxQueryLimit', '123');