Allow usage of named parameters

Author: mat02

server/node-service/src/plugins/firebirdsql/i18n/en.ts

@@ -13,5 +13,7 @@ export const en = {
   blobAsText: "Get blob as text, only affects blob subtype 1",
 
   actions: "Actions",
-  actionName: "SQL Query",
+  actionName: "Query",
+  sqlInputField: "SQL Query",
+  paramsInputField: "Query Parameters",
 };

server/node-service/src/plugins/firebirdsql/queryConfig.ts

@@ -8,13 +8,18 @@ function getQueryConfig(i18n: FirebirdI18nTranslator) {
     actions: [
       {
         actionName: "Query",
-        label: "Query",
+        label: i18n.trans("actionName"),
         params: [
           {
-            label: i18n.trans("actionName"),
+            label: i18n.trans("sqlInputField"),
             key: "sql",
             type: "sqlInput",
           },
+          {
+            label: i18n.trans("paramsInputField"),
+            key: "params",
+            type: "jsonInput",
+          },
         ],
       },
     ],

server/node-service/src/plugins/firebirdsql/run.ts

@@ -1,6 +1,7 @@
 import { DataSourceDataType } from "./dataSourceConfig";
 import { ActionDataType } from "./queryConfig";
 import { FirebirdI18nTranslator } from "./i18n";
+import { ServiceError } from "../../common/error";
 import _ from "lodash";
 import Firebird from "node-firebird";
 
@@ -39,11 +40,41 @@ export async function validateDataSourceConfig(dataSourceConfig: DataSourceDataT
   }
 }
 
+async function prepareQueryParameters(stmt: string, parameters: object) {
+  const re : RegExp = /(:)([_a-zA-Z0-9\[\]\.]+)/gm;
+
+  const placeholdersInStmt = stmt.matchAll(re);
+
+  let parametersArray = [];
+
+  for(const match of placeholdersInStmt) {
+    const paramName: string = match[2];
+    if (_.isNil(paramName)) {
+      continue;
+    }
+    if (!_.has(parameters, paramName)) {
+      throw new ServiceError(`Named parameter "${paramName}" not found in Query Parameters object.`);
+    }
+    parametersArray.push(_.get(parameters, paramName));
+  }
+
+  const modifiedStmt = stmt.replaceAll(re, "?");
+
+  return {
+    stmt: modifiedStmt,
+    parametersArray: parametersArray
+  }
+}
+
 export default async function run(action: ActionDataType, dataSourceConfig: DataSourceDataType, i18n: FirebirdI18nTranslator) {
   if (action.actionName === "Query") {
     let db = await fbdAsync.attachAsync(getFirebirdOptions(dataSourceConfig));
     promisifyAll(db);
-    const results = await db.queryAsync(action.sql);
+
+    const { stmt, parametersArray } = await prepareQueryParameters(action.sql, action.params);
+    
+    const results = db.queryAsync(stmt, parametersArray);
+
     db.detachAsync();
     return results;
   }