Unified ElasticSearch Utility Module by chethann007 · Pull Request #644 · Sunbird-Lern/lms-service

chethann007 · 2026-01-29T08:01:59Z

Summary

Re-architected and rewrote the ElasticSearch utility layer into a single, unified core/sunbird-es-utils module. This new implementation consolidates disparate ElasticSearch handling logic from across all microservices into one central library.

Key Changes

New Core Module: Created core/sunbird-es-utils as the single source of truth for all ElasticSearch operations.
Cleanup: Removed the legacy ‎course-mw/sunbird-util/sunbird-es-utils module and refactored all dependent services (Actors, DAOs) to use the new unified implementation.

Impact

Eliminates code duplication across microservices, enforces a standardized database access pattern, and simplifies future maintenance and upgrades.

Copilot

Pull request overview

This pull request consolidates the ElasticSearch utility layer by moving it from course-mw/sunbird-util/sunbird-es-utils to a new unified core/sunbird-es-utils module. This architectural change standardizes ElasticSearch access patterns across all microservices and eliminates code duplication.

Changes:

Created new core/sunbird-es-utils module with improved implementation and documentation
Removed legacy course-mw/sunbird-util/sunbird-es-utils module completely
Updated ElasticSearchService interface with reordered parameters (RequestContext moved to last position)
Refactored all dependent services (actors, DAOs, tests) to use new method signatures
Centralized dependency version management in parent POM

Reviewed changes

Copilot reviewed 78 out of 80 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
core/sunbird-es-utils/*	New unified ES utils module with improved connection management, comprehensive documentation, and better error handling
core/pom.xml	Added new module and centralized all dependency version properties
course-mw/sunbird-util/pom.xml	Removed reference to old sunbird-es-utils module
course-mw/sunbird-util/sunbird-es-utils/*	Complete removal of legacy ES utils implementation
course-mw/**/JsonKey.java	Added new constants: SEARCH_FUZZY and REST
course-mw/*/Actor*.java	Updated all ES service method calls to new signature order
course-mw/*/Test*.java	Updated all mock expectations to match new method signatures

Comments suppressed due to low confidence (2)

core/sunbird-es-utils/src/main/java/org/sunbird/dto/SearchDTO.java:226

getGroupQuery exposes the internal representation stored in field groupQuery. The value may be modified after this call to getGroupQuery.
getGroupQuery exposes the internal representation stored in field groupQuery. The value may be modified after this call to getGroupQuery.
core/sunbird-es-utils/src/main/java/org/sunbird/dto/SearchDTO.java:134
getAdditionalProperties exposes the internal representation stored in field additionalProperties. The value may be modified after this call to getAdditionalProperties.
getAdditionalProperties exposes the internal representation stored in field additionalProperties. The value may be modified after this call to getAdditionalProperties.
getAdditionalProperties exposes the internal representation stored in field additionalProperties. The value may be modified after this call to getAdditionalProperties.
getAdditionalProperties exposes the internal representation stored in field additionalProperties. The value may be modified after this call to getAdditionalProperties.
getAdditionalProperties exposes the internal representation stored in field additionalProperties. The value may be modified after this call to getAdditionalProperties.
getAdditionalProperties exposes the internal representation stored in field additionalProperties. The value may be modified after this call to getAdditionalProperties.
getAdditionalProperties exposes the internal representation stored in field additionalProperties. The value may be modified after this call to getAdditionalProperties.
getAdditionalProperties exposes the internal representation stored in field additionalProperties. The value may be modified after this call to getAdditionalProperties.
getAdditionalProperties exposes the internal representation stored in field additionalProperties. The value may be modified after this call to getAdditionalProperties.
getAdditionalProperties exposes the internal representation stored in field additionalProperties. The value may be modified after this call to getAdditionalProperties.
getAdditionalProperties exposes the internal representation stored in field additionalProperties. The value may be modified after this call to getAdditionalProperties.
getAdditionalProperties exposes the internal representation stored in field additionalProperties. The value may be modified after this call to getAdditionalProperties.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-03T11:42:31Z

core/sunbird-es-utils/src/main/java/org/sunbird/common/ElasticSearchRestHighImpl.java

+    long startTime = System.currentTimeMillis();
+    Promise<String> promise = Futures.promise();
+
+    logger.debug(requestContext, "ElasticSearchRestHighImpl:save: method started at ==" + startTime + " for Index " + index);
+
+    if (StringUtils.isBlank(identifier) || StringUtils.isBlank(index)) {
+      logger.info(requestContext, "ElasticSearchRestHighImpl:save: Identifier or Index value is null or empty, identifier : " 
+          + identifier + ", index: " + index + ", not able to save data.");
+      promise.failure(ProjectUtil.createClientException(ResponseCode.invalidData));
+      return promise.future();
+    }
+
+    try {


The save method now throws an exception for invalid input instead of returning "ERROR" as a string. This is an API behavior change that could break existing error handling code that checks for the "ERROR" string return value. The old implementation (based on the removed test) returned "ERROR" on validation failure, but the new implementation throws an exception via promise.failure().

Consider adding migration documentation or checking if all callers handle exceptions properly instead of checking for "ERROR" string.

Suggested change

long startTime = System.currentTimeMillis();

Promise<String> promise = Futures.promise();

logger.debug(requestContext, "ElasticSearchRestHighImpl:save: method started at ==" + startTime + " for Index " + index);

if (StringUtils.isBlank(identifier) || StringUtils.isBlank(index)) {

logger.info(requestContext, "ElasticSearchRestHighImpl:save: Identifier or Index value is null or empty, identifier : "

+ identifier + ", index: " + index + ", not able to save data.");

promise.failure(ProjectUtil.createClientException(ResponseCode.invalidData));

return promise.future();

}

try {

long startTime = System.currentTimeMillis();

Promise<String> promise = Futures.promise();

logger.debug(requestContext, "ElasticSearchRestHighImpl:save: method started at ==" + startTime + " for Index " + index);

if (StringUtils.isBlank(identifier) || StringUtils.isBlank(index)) {

logger.info(

requestContext,

"ElasticSearchRestHighImpl:save: Identifier or Index value is null or empty, identifier : "

+ identifier

+ ", index: "

+ index

+ ", not able to save data.");

// Maintain backward-compatible behavior: return "ERROR" instead of throwing an exception.

promise.success(ERROR);

return promise.future();

}

try {

Copilot · 2026-02-03T11:42:32Z

core/sunbird-es-utils/src/main/java/org/sunbird/helper/ConnectionManager.java

+      String[] splitedHost = hostName.split(",");
+      for (String host : splitedHost) {
+        String trimmedHost = host.trim();
+        if (StringUtils.isNotBlank(trimmedHost)) {
+          hosts.add(trimmedHost);
+        }
+      }
+
+      // Parse comma-separated ports (currently stored but not used)
+      String[] splitedPort = port.split(",");


Inconsistent use of "splited" instead of "split" in variable names. While this is existing code being moved, consider using proper English grammar: splitedHost should be splitHost or hostArray, and splitedPort should be splitPort or portArray.

Copilot · 2026-02-03T11:42:32Z

core/sunbird-es-utils/src/main/java/org/sunbird/helper/ConnectionManager.java

+      // Parse comma-separated ports (currently stored but not used)
+      String[] splitedPort = port.split(",");
+      for (String portStr : splitedPort) {
+        String trimmedPort = portStr.trim();
+        if (StringUtils.isNotBlank(trimmedPort)) {
+          try {
+            ports.add(Integer.parseInt(trimmedPort));
+          } catch (NumberFormatException e) {
+            logger.warn(null, "Invalid port number in SUNBIRD_ES_PORT: " + trimmedPort, null);
+          }
+        }
+      }


The ports list is populated from environment variables but never actually used. The hardcoded port 9200 is always used on line 155. Either remove the unused ports list and related parsing logic (lines 76-87), or use the parsed port values instead of hardcoding 9200. The comment on line 27 acknowledges this but it should be addressed.

Copilot · 2026-02-03T11:42:32Z

core/sunbird-es-utils/src/main/java/org/sunbird/helper/ConnectionManager.java

+  /** List of Elasticsearch ports (populated from env but currently unused). */
+  private static final List<Integer> ports = new ArrayList<>();
+


The contents of this container are never accessed.

Suggested change

/** List of Elasticsearch ports (populated from env but currently unused). */

private static final List<Integer> ports = new ArrayList<>();

sonarqubecloud · 2026-02-05T03:01:42Z

Quality Gate passed

Issues
23 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
2.0% Duplication on New Code

See analysis details on SonarQube Cloud

sonarqubecloud · 2026-02-05T03:06:30Z

Quality Gate failed

Failed conditions
10 Security Hotspots
9.5% Coverage on New Code (required ≥ 80%)
6.6% Duplication on New Code (required ≤ 3%)
E Reliability Rating on New Code (required ≥ A)
D Security Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

chethann007 added 5 commits January 24, 2026 10:57

cleanup: delete old elasticsearch utility implementation

b7bbe07

feat: add rewritten standardized ES utility to core module

07063df

build: integrate sunbird-es-utils into core module hierarchy

2834583

build: unregister legacy ES utils from course-mw POM

c814afa

refactor: update actors and services to use new standardized ES core

3978bcd

pallakartheekreddy approved these changes Feb 2, 2026

View reviewed changes

maheshkumargangula requested a review from Copilot February 3, 2026 11:33

Copilot started reviewing on behalf of maheshkumargangula February 3, 2026 11:33 View session

Copilot AI reviewed Feb 3, 2026

View reviewed changes

chethann007 force-pushed the es-utils branch from aec8ed6 to 3978bcd Compare February 5, 2026 02:59

maheshkumargangula approved these changes Feb 5, 2026

View reviewed changes

maheshkumargangula merged commit 6bde042 into develop Feb 5, 2026
9 of 11 checks passed

maheshkumargangula deleted the es-utils branch February 5, 2026 10:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Unified ElasticSearch Utility Module#644

Unified ElasticSearch Utility Module#644
maheshkumargangula merged 5 commits intodevelopfrom
es-utils

chethann007 commented Jan 29, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 3, 2026

Uh oh!

Copilot AI Feb 3, 2026

Uh oh!

Copilot AI Feb 3, 2026

Uh oh!

Copilot AI Feb 3, 2026

Uh oh!

sonarqubecloud bot commented Feb 5, 2026

Uh oh!

sonarqubecloud bot commented Feb 5, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		/** List of Elasticsearch ports (populated from env but currently unused). */
		private static final List<Integer> ports = new ArrayList<>();

Conversation

chethann007 commented Jan 29, 2026

Summary

Key Changes

Impact

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Feb 5, 2026

Quality Gate passed

Uh oh!

sonarqubecloud bot commented Feb 5, 2026

Quality Gate failed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants