Update GetEngineUsageReactor.java

[EJV20]

adding parameter info into the usage section for functions

[github-actions]

@CodiumAI-Agent /describe

[QodoAI-Agent]

Title

Update GetEngineUsageReactor.java

---

User description

adding parameter info into the usage section for functions

---

PR Type

Enhancement

---

Description

• Added detailed parameter information for function usage.

• Enhanced getFunctionUsage to include parameter metadata.

• Updated fillMap to support parameter info inclusion.

• Improved code examples for Python and Java usage.

---

Changes walkthrough 📝

	Relevant files
Enhancement	GetEngineUsageReactor.java Add parameter metadata and enhance usage examples                src/prerna/reactor/utils/GetEngineUsageReactor.java Added logic to retrieve and process function parameters. Enhanced getFunctionUsage to include parameter metadata. Modified fillMap to support parameter info as a new field. Updated code examples for Python and Java to include parameter mapping. +76/-3

---

Need help?

Type /help how to ... in the comments thread for any questions about PR-Agent usage.

Check out the documentation for more information.

[github-actions]

@CodiumAI-Agent /review

[QodoAI-Agent]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 4 🔵🔵🔵🔵⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Possible NullPointerException The method getFunctionUsage assumes that Utility.getFunctionEngine(engineId) will always return a non-null IFunctionEngine. If it returns null, this could lead to a NullPointerException when calling methods like getParameters() or getRequiredParameters(). private List<Map<String, Object>> getFunctionUsage(String engineId) { List<Map<String, Object>> usage = new ArrayList<>(); IFunctionEngine ife = Utility.getFunctionEngine(engineId); List<FunctionParameter> fps = ife.getParameters(); if (fps == null) { fps = new ArrayList<>(); } List<Map<String, Object>> paramInfo = new ArrayList<>(); List<String> requiredParams = ife.getRequiredParameters(); if (requiredParams == null) { requiredParams = new ArrayList<>(); } Inefficient String Concatenation The code uses String concatenation in a loop to build the mapParams string. This could lead to performance issues due to the immutability of String. Consider using a StringBuilder for better performance. String mapParams = ""; for (FunctionParameter fp : fps) { Map<String, Object> pinfo = new HashMap<>(); String name = fp.getParameterName(); String type = fp.getParameterType(); String description = fp.getParameterDescription(); if (requiredParams.contains(name)) { pinfo.put("required", true); } else { pinfo.put("required", false); } pinfo.put("name", name); pinfo.put("type", type); pinfo.put("description", description); paramInfo.add(pinfo); if (first) { mapParams = mapParams + "{"; first = false; } else { mapParams = mapParams + ", "; } mapParams = mapParams + "\"" + name + "\":"; if (type.equalsIgnoreCase("string")) { mapParams = mapParams + "\"string\""; } else { mapParams = mapParams + type; } } if (fps.size() == 0) { mapParams = ""; } else { mapParams = mapParams + "}"; Redundant Parameter Initialization The initialization of fps and requiredParams to empty lists when null could be redundant if ife.getParameters() and ife.getRequiredParameters() are guaranteed to return non-null values. This should be verified. List<FunctionParameter> fps = ife.getParameters(); if (fps == null) { fps = new ArrayList<>(); } List<Map<String, Object>> paramInfo = new ArrayList<>(); List<String> requiredParams = ife.getRequiredParameters(); if (requiredParams == null) { requiredParams = new ArrayList<>();

[github-actions]

@CodiumAI-Agent /improve

[QodoAI-Agent]

PR Code Suggestions ✨

Category	Suggestion	Score
Possible issue	Add null check for ife object Add a null check for ife after calling Utility.getFunctionEngine(engineId) to prevent potential NullPointerException if the method returns null. src/prerna/reactor/utils/GetEngineUsageReactor.java [335-336] IFunctionEngine ife = Utility.getFunctionEngine(engineId); +if (ife == null) { + return usage; // or handle appropriately +} List<FunctionParameter> fps = ife.getParameters(); Suggestion importance[1-10]: 9 Why: Adding a null check for ife is crucial to prevent a potential NullPointerException if Utility.getFunctionEngine(engineId) returns null. This suggestion addresses a critical issue that could lead to runtime errors.	9
	Add null checks for FunctionParameter fields Ensure that fp.getParameterName(), fp.getParameterType(), and fp.getParameterDescription() are not null before using them to avoid potential NullPointerException. src/prerna/reactor/utils/GetEngineUsageReactor.java [350-352] -String name = fp.getParameterName(); -String type = fp.getParameterType(); -String description = fp.getParameterDescription(); +String name = fp.getParameterName() != null ? fp.getParameterName() : ""; +String type = fp.getParameterType() != null ? fp.getParameterType() : ""; +String description = fp.getParameterDescription() != null ? fp.getParameterDescription() : ""; Suggestion importance[1-10]: 8 Why: Ensuring that fp.getParameterName(), fp.getParameterType(), and fp.getParameterDescription() are not null before usage is important to avoid potential NullPointerException. This suggestion improves code robustness.	8
General	Validate type for supported values Validate the type variable in the mapParams construction loop to ensure it only contains supported data types, avoiding potential runtime errors. src/prerna/reactor/utils/GetEngineUsageReactor.java [374-377] if (type.equalsIgnoreCase("string")) { mapParams = mapParams + "\"string\""; +} else if (type.equalsIgnoreCase("int") || type.equalsIgnoreCase("float")) { + mapParams = mapParams + type; } else { - mapParams = mapParams + type; + mapParams = mapParams + "\"unsupported\""; // or handle appropriately } Suggestion importance[1-10]: 7 Why: Validating the type variable ensures that only supported data types are used, preventing potential runtime errors. This suggestion enhances the reliability of the mapParams construction logic.	7
	Use immutable lists for null initialization Avoid using mutable ArrayList for paramInfo and requiredParams initialization when null; use Collections.emptyList() for better immutability and performance. src/prerna/reactor/utils/GetEngineUsageReactor.java [337-343] if (fps == null) { - fps = new ArrayList<>(); + fps = Collections.emptyList(); } ... if (requiredParams == null) { - requiredParams = new ArrayList<>(); + requiredParams = Collections.emptyList(); } Suggestion importance[1-10]: 6 Why: Using Collections.emptyList() instead of mutable ArrayList for null initialization improves immutability and performance. While not critical, this suggestion enhances code quality and maintainability.	6

[github-actions]

@CodiumAI-Agent /update_changelog

[QodoAI-Agent]

Changelog updates: 🔄

2025-05-08 #417

Changed

• Add function parameter information to engine usage outputs in GetEngineUsageReactor.

to commit the new content to the CHANGELOG.md file, please type:
'/update_changelog --pr_update_changelog.push_changelog_changes=true'