HCK-13213: fix issue with replacing query statement with env vars and add query to error log (#59)

<!--do not remove this marker, its needed to replace info when ticket
title is updated -->
<!--jira-description-action-hidden-marker-start-->

<table>
<td>
<a href="https://hackolade.atlassian.net/browse/HCK-13213"
title="HCK-13213" target="_blank"><img alt="Sub-task"
src="https://hackolade.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10316?size=medium"
/>HCK-13213</a> 1. Investigate incident
  </td></table>
  <br />
 

<!--jira-description-action-hidden-marker-end-->
## Content

- Fixed an issue on Windows cmd.exe where parts of a query statement
could be replaced by environment variables.
- Added database version logging at the start of the connection process,
before fetching the list of schemas.
- Included the failed query (from the Java Db2 client) in error
objects-now it's logged and visible in the extended error stack trace.
- Simplified the Maven build configuration.

...

Author: VitaliiBedletskyi

constants/constants.js

@@ -13,8 +13,11 @@ const TABLE_TYPE = {
 
 const INLINE_COMMENT = '--';
 
+const PERSENT = '__PERCENT__';
+
 module.exports = {
 	ERROR_MESSAGE,
 	TABLE_TYPE,
 	INLINE_COMMENT,
+	PERSENT,
 };

reverse_engineering/api.js

@@ -101,10 +101,13 @@ const getDbCollectionsNames = async (connectionInfo, appLogger, callback, app) =
 	});
 
 	try {
+		const connection = await connectionHelper.connect({ connectionInfo, logger });
+		const dbVersion = await instanceHelper.getDbVersion({ connection });
+		logger.info('Db version: ' + dbVersion);
+
 		logger.info('Get table and schema names');
 		logger.info(connectionInfo);
 
-		const connection = await connectionHelper.connect({ connectionInfo, logger });
 		const tableNames = await instanceHelper.getDatabasesWithTableNames({
 			connection,
 			tableType: TABLE_TYPE.table,

shared/Db2Client/build.sh

@@ -1,3 +1,3 @@
 #!/bin/bash
 
-mvn clean compile assembly:single
+mvn clean package

shared/Db2Client/pom.xml

@@ -18,19 +18,29 @@
 
     <build>
         <plugins>
-            <plugin>
-                <artifactId>maven-assembly-plugin</artifactId>
-                <configuration>
-                    <archive>
-                        <manifest>
-                            <mainClass>org.db2.App</mainClass>
-                        </manifest>
-                    </archive>
-                    <descriptorRefs>
-                        <descriptorRef>jar-with-dependencies</descriptorRef>
-                    </descriptorRefs>
-                </configuration>
-            </plugin>
+			<plugin>
+				<artifactId>maven-assembly-plugin</artifactId>
+				<version>3.7.1</version>
+				<configuration>
+					<archive>
+						<manifest>
+							<mainClass>org.db2.App</mainClass>
+						</manifest>
+					</archive>
+					<descriptorRefs>
+						<descriptorRef>jar-with-dependencies</descriptorRef>
+					</descriptorRefs>
+				</configuration>
+				<executions>
+					<execution>
+						<id>make-assembly</id>
+						<phase>package</phase>
+						<goals>
+							<goal>single</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
         </plugins>
     </build>
 

shared/Db2Client/readme.md

@@ -19,13 +19,9 @@ For compiling client Using Maven plugin execute:
 Lifecycle methods:
 
 -   `mvn clean`
--   `mvn compile`
-
-Plugins:
-
--   `mvn assembly:single`
+-   `mvn package`
 
 ### Built artifacts
 
-The built JAR file you can find following by `./target/Db2Client-1.0-jar-with-dependencies.jar`
+The built JAR file you can find following by `./target/Db2Client-1.0-jar-with-dependencies.jar`, **NOT `Db2Client-1.0.jar`!!!**
 For use in Db2 plugin rename this JAR file to `Db2Client.jar` and put to `shared/addons/Db2Client.jar`

shared/Db2Client/src/main/java/org/db2/App.java

@@ -37,6 +37,7 @@ public static void main(String[] args) {
 			JSONObject errorObj = new JSONObject();
 			errorObj.put("message", e.getMessage());
 			errorObj.put("stack", e.getStackTrace());
+			errorObj.put("query", query);
 
 			result.put("error", errorObj);
 		} finally {
@@ -46,7 +47,7 @@ public static void main(String[] args) {
 	}
 
 	private static String cleanStringValue(String value) {
-		return value.replace("<\\$>", "\"");
+		return value.replace("__PERCENT__", "%");
 	}
 
 	private static String findArgument(String[] args, Argument argument) {

shared/addons/Db2Client.jar

@@ -1,4 +1,4 @@
-const { TABLE_TYPE } = require('../../constants/constants');
+const { TABLE_TYPE, PERSENT } = require('../../constants/constants');
 
 /**
  * @param {{ query: string }}
@@ -11,14 +11,18 @@ const cleanUpQuery = ({ query = '' }) => query.replaceAll(/\s+/g, ' ');
  * @returns {string}
  */
 const getNonSystemSchemaWhereClause = ({ query, schemaNameKeyword }) => {
-	const whereClause = ` 
-  WHERE ${schemaNameKeyword} NOT LIKE 'SYS%'
-  AND ${schemaNameKeyword} NOT LIKE '%SYSCAT%'
-  AND ${schemaNameKeyword} NOT LIKE '%SYSIBM%'
-  AND ${schemaNameKeyword} NOT LIKE '%SYSSTAT%'
-  AND ${schemaNameKeyword} NOT LIKE '%SYSTOOLS%'
-  AND ${schemaNameKeyword} NOT LIKE '%NULLID%'
-  AND ${schemaNameKeyword} NOT LIKE '%SQLJ%';`;
+	// On Windows (cmd.exe), environment variables can be referenced using syntax like %PATH%.
+	// When a command contains such patterns, cmd.exe automatically replaces them with the corresponding environment variable values.
+	// To prevent this automatic substitution, a placeholder string (PERSENT) is used here instead,
+	// which will later be replaced with the % symbol inside the Db2Client Java client.
+	const whereClause = `
+	  WHERE ${schemaNameKeyword} NOT LIKE 'SYS${PERSENT}'
+	  AND ${schemaNameKeyword} NOT LIKE '${PERSENT}SYSCAT${PERSENT}'
+	  AND ${schemaNameKeyword} NOT LIKE '${PERSENT}SYSIBM${PERSENT}'
+	  AND ${schemaNameKeyword} NOT LIKE '${PERSENT}SYSSTAT${PERSENT}'
+	  AND ${schemaNameKeyword} NOT LIKE '${PERSENT}SYSTOOLS${PERSENT}'
+	  AND ${schemaNameKeyword} NOT LIKE '${PERSENT}NULLID${PERSENT}'
+	  AND ${schemaNameKeyword} NOT LIKE '${PERSENT}SQLJ${PERSENT}';`;
 
 	const clause = query.includes('WHERE') ? whereClause.replace('WHERE', 'AND') : whereClause;