Adding sort options to the myengines reactor

[rithvik-doshi]

Test: MyEngines ( sort = [ { "DATECREATED" : "ASC", "ENGINENAME": "DESC" } ] , engineTypes = [ "MODEL" ] ) ;

Supported sort fields: DATECREATED, ENGINENAME. Requires a FE hookup before merge

[github-actions]

@CodiumAI-Agent /describe

[QodoAI-Agent]

Title

Adding sort options to the myengines reactor

---

PR Type

Enhancement

---

Description

• Added sorting functionality to getUserEngineList with validation.

• Enhanced MyEnginesReactor to support dynamic sorting options.

• Introduced TypeReference class for generic type handling.

• Refactored utility methods for cleaner and reusable code.

---

Changes walkthrough 📝

Relevant files

Enhancement

SecurityEngineUtils.java Add sorting functionality to `getUserEngineList`                  src/prerna/auth/utils/SecurityEngineUtils.java Added sortFields parameter to getUserEngineList. Implemented sorting logic with validation for supported fields. Default sorting applied when no sort fields are provided. Throws exception for invalid sort parameters. +17/-4    MyEnginesReactor.java Enhance `MyEnginesReactor` with sorting and refactoring    src/prerna/reactor/security/MyEnginesReactor.java Added support for dynamic sorting via sortFields. Refactored methods to improve code reuse and readability. Integrated new sorting logic into the reactor's execution flow. Added utility methods for generic map and list handling. +105/-73 TypeReference.java Add `TypeReference` class for generic type handling            src/prerna/security/TypeReference.java Introduced TypeReference class for handling generic types. Provides a mechanism to retrieve type information at runtime. +21/-0

---

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 Issue The sortFields validation logic in the getUserEngineList method might throw an exception if unsupported sort keys are passed. Ensure this behavior is intended and properly handled in the calling code. if (sortFields == null || sortFields.isEmpty()) { // Default Sorting qs1.addOrderBy(new QueryColumnOrderBySelector("low_database_name")); } else { Set<String> sortKeys = sortFields.keySet(); Set<String> validSorts = new HashSet<>(Arrays.asList("ENGINENAME", "DATECREATED")); if (!validSorts.containsAll(sortKeys)) { throw new SemossPixelException("Invalid Sort Parameters passed: Only \"ENGINENAME\" and \"DATECREATED\" are supported"); } for (String s: sortKeys) { qs1.addOrderBy("ENGINE__" + s, sortFields.getOrDefault(s, "ASC")); } Code Duplication The logic for handling IRawSelectWrapper instances is duplicated in multiple places. Consider refactoring to improve maintainability and reduce redundancy. wrapper = SecurityEngineUtils.getEngineMetadataWrapper(index.keySet(), getMetaKeys(), true); while (wrapper.hasNext()) { Object[] data = wrapper.next().getValues(); String databaseId = (String) data[0]; String metaKey = (String) data[1]; String metaValue = (String) data[2]; if (metaValue == null) { continue; } int indexToFind = index.get(databaseId); Map<String, Object> res = engineInfo.get(indexToFind); // whatever it is, if it is single send a single value, if it is multi send as // array if (res.containsKey(metaKey)) { Object obj = res.get(metaKey); if (obj instanceof List) { ((List) obj).add(metaValue); } else { List<Object> newList = new ArrayList<>(); newList.add(obj); newList.add(metaValue); res.put(metaKey, newList); } } else { res.put(metaKey, metaValue); } } } catch (Exception e) { classLogger.error(Constants.STACKTRACE, e); } finally { if (wrapper != null) { try { wrapper.close(); } catch (IOException e) { classLogger.error(Constants.STACKTRACE, e); } } } } if (includeUserT && Utility.isUserTrackingEnabled()) { IRawSelectWrapper wrapper = null; try { wrapper = UserCatalogVoteUtils.getAllVotesWrapper(index.keySet()); while (wrapper.hasNext()) { Object[] data = wrapper.next().getValues(); String databaseId = (String) data[0]; int upvotes = ((Number) data[1]).intValue(); int indexToFind = index.get(databaseId); Map<String, Object> res = engineInfo.get(indexToFind); res.put("upvotes", upvotes); } } catch (Exception e) { classLogger.error(Constants.STACKTRACE, e); } finally { if (wrapper != null) { try { wrapper.close(); } catch (IOException e) { classLogger.error(Constants.STACKTRACE, e); } } } Map<String, Boolean> voted = UserCatalogVoteUtils .userEngineVotes(User.getUserIdAndType(this.insight.getUser()), index.keySet()); for (String ks : index.keySet()) { Default Sorting Behavior The default sorting behavior in getSortFields is not clearly documented. Ensure that the default behavior aligns with user expectations and is consistent across the application. private Map<String, String> getSortFields() { // key: sortField, value: direction return getGenericMap(ReactorKeysEnum.SORT.getKey(), new TypeReference<Map<String, String>>() { });

[github-actions]

@CodiumAI-Agent /improve

[QodoAI-Agent]

PR Code Suggestions ✨

Latest suggestions up to e3a8e4a

Category	Suggestion	Impact
Possible issue	Validate sort order directions Validate the sort order values to allow only "ASC" or "DESC" before applying them. src/prerna/auth/utils/SecurityEngineUtils.java [2401-2403] for (String s: sortKeys) { - qs1.addOrderBy("ENGINE__" + s, sortFields.getOrDefault(s, "ASC")); + String sortOrder = sortFields.getOrDefault(s, "ASC"); + if (!"ASC".equalsIgnoreCase(sortOrder) && !"DESC".equalsIgnoreCase(sortOrder)) { + throw new SemossPixelException("Invalid sort order: " + sortOrder + ". Only 'ASC' and 'DESC' are allowed."); + } + qs1.addOrderBy("ENGINE__" + s, sortOrder); } Suggestion importance[1-10]: 7 __ Why: The suggestion improves robustness by ensuring the sort order is either "ASC" or "DESC", preventing invalid inputs; it adds a useful check although the existing code already validates sort keys.	Medium

---

Previous suggestions

Suggestions up to commit d66b269

Category	Suggestion	Impact
Possible issue	Validate data type in getGenericMap Ensure that the getGenericMap method handles cases where the mapInputs list contains unexpected or invalid data types, which could lead to runtime exceptions. src/prerna/reactor/security/MyEnginesReactor.java [194-196] List<NounMetadata> mapInputs = this.curRow.getNounsOfType(PixelDataType.MAP); if (mapInputs != null && !mapInputs.isEmpty()) { - return (Map<K, V>) mapInputs.get(0).getValue(); + Object value = mapInputs.get(0).getValue(); + if (!(value instanceof Map)) { + throw new IllegalArgumentException("Expected a Map type but found: " + value.getClass().getName()); + } + return (Map<K, V>) value; } Suggestion importance[1-10]: 9 __ Why: Validating the data type in getGenericMap prevents runtime exceptions by ensuring the expected type is present. This is a critical improvement for maintaining type safety and avoiding unexpected behavior.	High
	Add null validation for sort parameters Validate the sortFields map to ensure it does not contain null keys or values before processing, as this could lead to unexpected behavior or runtime exceptions. src/prerna/auth/utils/SecurityEngineUtils.java [2376-2387] if (sortFields == null || sortFields.isEmpty()) { // Default Sorting qs1.addOrderBy(new QueryColumnOrderBySelector("low_database_name")); } else { + if (sortFields.containsKey(null) || sortFields.containsValue(null)) { + throw new SemossPixelException("Sort parameters cannot contain null keys or values"); + } Set<String> sortKeys = sortFields.keySet(); Set<String> validSorts = new HashSet<>(Arrays.asList("ENGINENAME", "DATECREATED")); if (!validSorts.containsAll(sortKeys)) { throw new SemossPixelException("Invalid Sort Parameters passed: Only \"ENGINENAME\" and \"DATECREATED\" are supported"); } for (String s: sortKeys) { qs1.addOrderBy("ENGINE__" + s, sortFields.getOrDefault(s, "ASC")); } } Suggestion importance[1-10]: 8 __ Why: Adding null validation for sort parameters ensures robustness by preventing potential runtime exceptions caused by null keys or values in the sortFields map. This is a significant improvement in terms of error handling and code reliability.	Medium
	Add null check for engineInfo Add a null check for the engineInfo list before iterating over it to avoid potential NullPointerException. src/prerna/reactor/security/MyEnginesReactor.java [85-89] -if (!engineInfo.isEmpty() && (!noMeta || includeUserT)) { +if (engineInfo != null && !engineInfo.isEmpty() && (!noMeta || includeUserT)) { Map<String, Integer> index = new HashMap<>(engineInfo.size()); int size = engineInfo.size(); for (int i = 0; i < size; i++) { Map<String, Object> engine = engineInfo.get(i); Suggestion importance[1-10]: 7 __ Why: Adding a null check for engineInfo enhances the code's robustness by preventing potential NullPointerException. This is a valuable improvement for handling edge cases gracefully.	Medium
General	Prevent resource leaks in wrapper.close Ensure that the wrapper.close() method is called in a finally block even if an exception occurs during the while (wrapper.hasNext()) loop to prevent resource leaks. src/prerna/reactor/security/MyEnginesReactor.java [98-136] try { wrapper = SecurityEngineUtils.getEngineMetadataWrapper(index.keySet(), getMetaKeys(), true); - while (wrapper.hasNext()) { - Object[] data = wrapper.next().getValues(); - String databaseId = (String) data[0]; - String metaKey = (String) data[1]; - String metaValue = (String) data[2]; - if (metaValue == null) { - continue; + try { + while (wrapper.hasNext()) { + Object[] data = wrapper.next().getValues(); + String databaseId = (String) data[0]; + String metaKey = (String) data[1]; + String metaValue = (String) data[2]; + if (metaValue == null) { + continue; + } + int indexToFind = index.get(databaseId); + Map<String, Object> res = engineInfo.get(indexToFind); + if (res.containsKey(metaKey)) { + Object obj = res.get(metaKey); + if (obj instanceof List) { + ((List) obj).add(metaValue); + } else { + List<Object> newList = new ArrayList<>(); + newList.add(obj); + res.put(metaKey, newList); + } + } else { + res.put(metaKey, metaValue); + } } - int indexToFind = index.get(databaseId); - Map<String, Object> res = engineInfo.get(indexToFind); - if (res.containsKey(metaKey)) { - Object obj = res.get(metaKey); - if (obj instanceof List) { - ((List) obj).add(metaValue); - } else { - List<Object> newList = new ArrayList<>(); - newList.add(obj); - res.put(metaKey, newList); - } - } else { - res.put(metaKey, metaValue); + } finally { + if (wrapper != null) { + wrapper.close(); } } } catch (Exception e) { classLogger.error(Constants.STACKTRACE, e); -} finally { - if (wrapper != null) { - try { - wrapper.close(); - } catch (IOException e) { - classLogger.error(Constants.STACKTRACE, e); - } - } } Suggestion importance[1-10]: 6 __ Why: Ensuring that wrapper.close() is always called, even if an exception occurs during the loop, helps prevent resource leaks. While the existing code already handles this in a finally block, the suggestion introduces a nested try-finally for added clarity and safety.	Low

[memisrose]

FE PR:
SEMOSS/semoss-ui#679

[github-actions]

@CodiumAI-Agent /update_changelog

[QodoAI-Agent]

Changelog updates: 🔄

[2025-05-07][*][https://github.com//pull/479]

Added

• support for custom sort options (DATECREATED, ENGINENAME) in MyEnginesReactor
• overload in SecurityEngineUtils to accept and validate sort parameters with default ordering
• new TypeReference helper for generic map deserialization

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