feat: Remove all optional parameters with null value

* feat: Remove all optional parameters with null value

* test: Add unit tests to verify that the transport removes all optional parameters with null value

Author: vladimir-rangelov

.github/workflows/check-pr.yml

@@ -150,7 +150,7 @@ jobs:
           REPO_NAME="firebolt-apis"
           RUN_ID="${{ env.CPP_RUN_ID }}"
           MAX_POLLS=30  # Max polls before timeout
-          POLL_INTERVAL=50  # In seconds
+          POLL_INTERVAL=180  # In seconds
 
 
           # Poll the specific run ID for status
@@ -173,7 +173,7 @@ jobs:
           done
 
           if [ "$i" -eq "$MAX_POLLS" ]; then
-            echo "Timeout reached while waiting for JavaScript SDK generation."
+            echo "Timeout reached while waiting for CPP SDK generation."
             exit 1
           fi
 

languages/javascript/src/shared/Transport/index.mjs

@@ -103,6 +103,29 @@ export default class Transport {
     return Transport.get()._sendAndGetId(module, method, params, transforms)
   }
 
+  static removeNullOptionalParams(params, numOfOptionalParams) {
+
+    // Iterate over all params starting backwrods and if the param is null remove it from the params object. 
+    // If it is undefined that means the param is not provided, which is Ok.
+    // We should not get a call with numOfOptionalParams === 0, but if we do, just return the params as are.
+    const keys = Object.keys(params)
+    let paramsIndex = keys.length - 1
+    while (paramsIndex >= 0 && numOfOptionalParams > 0) {
+      const key = keys[paramsIndex]
+      if (params[key] === null) {
+        delete params[key]
+        console.warn('WARNING: null values for optional params will be disallowed in a future Firebolt version. Parameter: ' + key)
+      } else if (params[key] === undefined) {
+        // undefined means the param is not provided, we should continue.
+      } else {
+        // if an optional param is provided we should stop removing params as if we continue we will change the order of the params
+        break
+      }
+      paramsIndex--
+      numOfOptionalParams--
+    }
+    return params
+  }
   _send (module, method, params, transforms) {
     if (Array.isArray(module) && !method && !params) {
       return this._batch(module)

languages/javascript/templates/methods/default.js

@@ -3,5 +3,10 @@ function ${method.name}(${method.params.list}) {
 
   const transforms = ${method.transforms}
 
-  return Transport.send('${info.title}', '${method.name}', { ${method.params.list} }, transforms)
+  let params = { ${method.params.list} }${if.optionalParams}
+
+  // remove the null params if they are optional
+  params = Transport.removeNullOptionalParams(params, ${optionalParams})${end.if.optionalParams}
+
+  return Transport.send('${info.title}', '${method.name}', params, transforms)
 }

src/macrofier/engine.mjs

@@ -1427,6 +1427,18 @@ function insertMethodMacros(template, methodObj, json, templates, type = '', exa
     signature = ''
   }
 
+  //callculate the number of optional params
+  let optionalParams = 0
+  if (methodObj.params && methodObj.params.length) {
+    // Count the number of optional parameters starting from the last and stop when a required parameter is found
+    for (let i = methodObj.params.length - 1; i >= 0; i--) {
+      if (methodObj.params[i].required) {
+        break; // Stop counting when a required parameter is found
+      }
+      optionalParams++;
+    }
+  }
+
   template = insertExampleMacros(template, examples[methodObj.name] || [], methodObj, json, templates)
   template = template.replace(/\$\{method\.name\}/g, method.name)
     .replace(/\$\{method\.rpc\.name\}/g, methodObj.rpc_name || methodObj.name)
@@ -1441,6 +1453,8 @@ function insertMethodMacros(template, methodObj, json, templates, type = '', exa
     .replace(/\$\{method\.params\.list\}/g, method.params)
     .replace(/\$\{method\.params\.array\}/g, JSON.stringify(methodObj.params.map(p => p.name)))
     .replace(/\$\{method\.params\.count}/g, methodObj.params ? methodObj.params.length : 0)
+    .replace(/\$\{if\.optionalParams\}(.*?)\$\{end\.if\.optionalParams\}/gms, optionalParams > 0 ? '$1' : '')
+    .replace(/\$\{optionalParams\}/g, optionalParams)
     .replace(/\$\{if\.params\}(.*?)\$\{end\.if\.params\}/gms, method.params.length ? '$1' : '')
     .replace(/\$\{if\.result\}(.*?)\$\{end\.if\.result\}/gms, resultType ? '$1' : '')
     .replace(/\$\{if\.result.nonvoid\}(.*?)\$\{end\.if\.result.nonvoid\}/gms, resultType && resultType !== 'void' ? '$1' : '')