Skip to content

FINERACT-2165: Migrate Schedulerjobhelper internals to typed Feign cl… #6115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
elnafateh wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

FINERACT-2165: Migrate Schedulerjobhelper internals to typed Feign cl… #6115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions ...er/src/main/java/org/apache/fineract/infrastructure/jobs/api/SchedulerJobApiResource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,8 +180,9 @@ public Response executeJobByShortName(
@Consumes({ MediaType.APPLICATION_JSON })
@Operation(summary = "Update a Job", description = "Updates the details of a job.")
@RequestBody(required = true, content = @Content(schema = @Schema(implementation = SchedulerJobApiResourceSwagger.PutJobsJobIDRequest.class)))
@ApiResponse(responseCode = "200", description = "OK")
public String updateJobDetail(@PathParam(SchedulerJobApiConstants.JOB_ID) @Parameter(description = "jobId") final Long jobId,
@ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = CommandProcessingResult.class)))
public CommandProcessingResult updateJobDetail(
@PathParam(SchedulerJobApiConstants.JOB_ID) @Parameter(description = "jobId") final Long jobId,
@Parameter(hidden = true) final String jsonRequestBody) {
return updateJobDetail(IdTypeResolver.resolveDefault(), Objects.toString(jobId, null), jsonRequestBody);
}
Expand All @@ -191,8 +192,8 @@ public String updateJobDetail(@PathParam(SchedulerJobApiConstants.JOB_ID) @Param
@Consumes({ MediaType.APPLICATION_JSON })
@Operation(summary = "Update a Job", description = "Updates the details of a job.")
@RequestBody(required = true, content = @Content(schema = @Schema(implementation = SchedulerJobApiResourceSwagger.PutJobsJobIDRequest.class)))
@ApiResponse(responseCode = "200", description = "OK")
public String updateJobDetailByShortName(
@ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = CommandProcessingResult.class)))
public CommandProcessingResult updateJobDetailByShortName(
@PathParam("shortName") @Parameter(required = true, description = SchedulerJobApiConstants.SHORT_NAME_PARAM) final String shortName,
@Parameter(hidden = true) final String jsonRequestBody) {
return updateJobDetail(IdTypeResolver.resolve(SHORT_NAME_PARAM), shortName, jsonRequestBody);
Expand Down Expand Up @@ -250,7 +251,7 @@ private Response executeJob(@NotNull IdTypeResolver.IdType idType, String identi
return response;
}

private String updateJobDetail(@NotNull IdTypeResolver.IdType idType, String identifier, String jsonRequestBody) {
private CommandProcessingResult updateJobDetail(@NotNull IdTypeResolver.IdType idType, String identifier, String jsonRequestBody) {
Long jobId = schedulerJobRunnerReadService.retrieveId(idType, identifier);
final CommandWrapper commandRequest = new CommandWrapperBuilder() //
.updateJobDetail(jobId) //
Expand All @@ -261,6 +262,6 @@ private String updateJobDetail(@NotNull IdTypeResolver.IdType idType, String ide
|| result.getChanges().containsKey(SchedulerJobApiConstants.cronExpressionParamName))) {
this.jobRegisterService.rescheduleJob(jobId);
}
return this.toApiJsonSerializer.serialize(result);
return result;
}
}
5 changes: 3 additions & 2 deletions .../java/org/apache/fineract/integrationtests/LoanCOBCatchUpInstanceModeIntegrationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,9 +117,10 @@ public void testSchedulerWorksWhenInBatchManagerMode() {
@ConfigureInstanceMode(readEnabled = true, writeEnabled = true, batchWorkerEnabled = true, batchManagerEnabled = false)
@Test
public void testSchedulerDoesNotWorksWhenNotInBatchManagerMode() {
CallFailedRuntimeException exception = assertThrows(CallFailedRuntimeException.class,
org.apache.fineract.client.feign.util.CallFailedRuntimeException exception = assertThrows(
org.apache.fineract.client.feign.util.CallFailedRuntimeException.class,
() -> schedulerJobHelper.updateSchedulerStatus(false));
assertEquals(405, exception.getResponse().code());
assertEquals(405, exception.getStatus());
}

@AfterEach
Expand Down
182 changes: 75 additions & 107 deletions ...n-tests/src/test/java/org/apache/fineract/integrationtests/common/SchedulerJobHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,175 +18,132 @@
*/
package org.apache.fineract.integrationtests.common;

import static org.apache.fineract.infrastructure.jobs.api.SchedulerJobApiConstants.SHORT_NAME_PARAM;
import static org.apache.fineract.client.feign.util.FeignCalls.executeVoid;
import static org.apache.fineract.client.feign.util.FeignCalls.ok;
import static org.awaitility.Awaitility.await;
import static org.hamcrest.core.Is.is;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.fail;

import com.google.gson.Gson;
import io.restassured.builder.ResponseSpecBuilder;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonPrimitive;
import com.google.gson.JsonSerializer;
import io.restassured.specification.RequestSpecification;
import io.restassured.specification.ResponseSpecification;
import java.time.Duration;
import java.util.HashMap;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.OffsetDateTime;
import java.time.format.DateTimeFormatter;
import java.util.List;
import java.util.Map;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import org.apache.fineract.client.models.CommandProcessingResult;
import org.apache.fineract.client.models.ExecuteJobRequest;
import org.apache.fineract.client.models.GetJobsResponse;
import org.apache.fineract.client.models.GetSchedulerResponse;
import org.apache.fineract.client.models.PutJobsJobIDRequest;
import org.apache.fineract.client.util.Calls;
import org.hamcrest.MatcherAssert;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
* Feign-based. Still instance-shaped (see constructor) purely for source compatibility with existing call sites; a
* follow-up PR will static-ify this class and update all callers in one mechanical pass.
*/
public class SchedulerJobHelper {

private static final Logger LOG = LoggerFactory.getLogger(SchedulerJobHelper.class);
private final RequestSpecification requestSpec;
private final ResponseSpecification response200Spec;
private static final Gson GSON = new GsonBuilder()

@adamsaghy adamsaghy Jul 20, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We dont need GSON... we are moving away from this. use typed objects

.registerTypeAdapter(OffsetDateTime.class,
(JsonSerializer<OffsetDateTime>) (src, type, ctx) -> src == null ? null
: new JsonPrimitive(DateTimeFormatter.ISO_INSTANT.format(src.toInstant())))
.registerTypeAdapter(LocalDateTime.class,
(JsonSerializer<LocalDateTime>) (src, type, ctx) -> src == null ? null
: new JsonPrimitive(DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss").format(src)))
.registerTypeAdapter(LocalDate.class,
(JsonSerializer<LocalDate>) (src, type, ctx) -> src == null ? null : new JsonPrimitive(src.toString()))
.create();

// TODO: Rewrite to use fineract-client instead!
// Example: org.apache.fineract.integrationtests.common.loans.LoanTransactionHelper.disburseLoan(java.lang.Long,
// org.apache.fineract.client.models.PostLoansLoanIdRequest)
@Deprecated(forRemoval = true)
/**
* @deprecated the {@code requestSpec} parameter is unused now that this Helper is Feign-based. Retained only so
* existing {@code new SchedulerJobHelper(requestSpec)} call sites keep compiling; prefer relying on
* static usage once callers are migrated in a follow-up PR.
*/
@Deprecated
public SchedulerJobHelper(final RequestSpecification requestSpec) {
this.requestSpec = requestSpec;
this.response200Spec = new ResponseSpecBuilder().expectStatusCode(200).build();
// no-op: retained for source compatibility with existing callers
}

// TODO: Rewrite to use fineract-client instead!
// Example: org.apache.fineract.integrationtests.common.loans.LoanTransactionHelper.disburseLoan(java.lang.Long,
// org.apache.fineract.client.models.PostLoansLoanIdRequest)
@Deprecated(forRemoval = true)
private List<Map<String, Object>> getAllSchedulerJobs() {
final String GET_ALL_SCHEDULER_JOBS_URL = "/fineract-provider/api/v1/jobs?" + Utils.TENANT_IDENTIFIER;
private List<GetJobsResponse> getAllSchedulerJobs() {
LOG.info("------------------------ RETRIEVING ALL SCHEDULER JOBS -------------------------");
List<Map<String, Object>> response = Utils.performServerGet(requestSpec, response200Spec, GET_ALL_SCHEDULER_JOBS_URL, "");
List<GetJobsResponse> response = ok(
() -> FineractFeignClientHelper.getFineractFeignClient().schedulerJob().retrieveAllSchedulerJobs());
assertNotNull(response);
return response;
}

private <T> List<T> getAllSchedulerJobDetails(Function<Map<String, Object>, T> mapper) {
private <T> List<T> getAllSchedulerJobDetails(Function<GetJobsResponse, T> mapper) {
return getAllSchedulerJobs().stream().map(mapper).collect(Collectors.toList());
}

public List<Integer> getAllSchedulerJobIds() {
return getAllSchedulerJobDetails(map -> (Integer) map.get("jobId"));
return getAllSchedulerJobDetails(job -> job.getJobId().intValue());
}

public List<String> getAllSchedulerJobNames() {
return getAllSchedulerJobDetails(map -> (String) map.get("displayName"));
return getAllSchedulerJobDetails(GetJobsResponse::getDisplayName);
}

// TODO: Rewrite to use fineract-client instead!
// Example: org.apache.fineract.integrationtests.common.loans.LoanTransactionHelper.disburseLoan(java.lang.Long,
// org.apache.fineract.client.models.PostLoansLoanIdRequest)
@Deprecated(forRemoval = true)
public Map<String, Object> getSchedulerJobById(int jobId) {
final String GET_SCHEDULER_JOB_BY_ID_URL = "/fineract-provider/api/v1/jobs/" + jobId + "?" + Utils.TENANT_IDENTIFIER;
LOG.info("------------------------ RETRIEVING SCHEDULER JOB BY ID -------------------------");
final Map<String, Object> response = Utils.performServerGet(requestSpec, response200Spec, GET_SCHEDULER_JOB_BY_ID_URL, "");
LOG.info("{}", response.toString());
GetJobsResponse response = ok(
() -> FineractFeignClientHelper.getFineractFeignClient().schedulerJob().retrieveOneSchedulerJob((long) jobId));
assertNotNull(response);
return response;
LOG.info("{}", response);
return toMap(response);

@adamsaghy adamsaghy Jul 20, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Return the real object, do not map with gson

}

// TODO: Rewrite to use fineract-client instead!
// Example: org.apache.fineract.integrationtests.common.loans.LoanTransactionHelper.disburseLoan(java.lang.Long,
// org.apache.fineract.client.models.PostLoansLoanIdRequest)
@Deprecated(forRemoval = true)
public Boolean getSchedulerStatus() {
final String GET_SCHEDULER_STATUS_URL = "/fineract-provider/api/v1/scheduler?" + Utils.TENANT_IDENTIFIER;
LOG.info("------------------------ RETRIEVING SCHEDULER STATUS -------------------------");
final Map<String, Object> response = Utils.performServerGet(requestSpec, response200Spec, GET_SCHEDULER_STATUS_URL, "");
return (Boolean) response.get("active");
GetSchedulerResponse response = ok(() -> FineractFeignClientHelper.getFineractFeignClient().scheduler().retrieveSchedulerStatus());
return response.getActive();
}

public void updateSchedulerStatus(final boolean on) {
String command = on ? "start" : "stop";
Calls.ok(FineractClientHelper.getFineractClient().jobsScheduler.handleCommandsScheduler(command));
executeVoid(() -> FineractFeignClientHelper.getFineractFeignClient().scheduler().handleCommandsScheduler(command));
}

// TODO: Rewrite to use fineract-client instead!
// Example: org.apache.fineract.integrationtests.common.loans.LoanTransactionHelper.disburseLoan(java.lang.Long,
// org.apache.fineract.client.models.PostLoansLoanIdRequest)
@Deprecated(forRemoval = true)
public Map<String, Object> updateSchedulerJob(int jobId, final boolean active) {
final String UPDATE_SCHEDULER_JOB_URL = "/fineract-provider/api/v1/jobs/" + jobId + "?" + Utils.TENANT_IDENTIFIER;
LOG.info("------------------------ UPDATING SCHEDULER JOB -------------------------");
final Map<String, Object> response = Utils.performServerPut(requestSpec, response200Spec, UPDATE_SCHEDULER_JOB_URL,
updateSchedulerJobAsJSON(active), "changes");
return response;
CommandProcessingResult response = ok(() -> FineractFeignClientHelper.getFineractFeignClient().schedulerJob()
.updateJobDetail((long) jobId, new PutJobsJobIDRequest().active(active)));
return response.getChanges();
}

public void updateSchedulerJob(long jobId, PutJobsJobIDRequest request) {
Calls.ok(FineractClientHelper.getFineractClient().jobs.updateJobDetail(jobId, request));
}

// TODO: Rewrite to use fineract-client instead!
// Example: org.apache.fineract.integrationtests.common.loans.LoanTransactionHelper.disburseLoan(java.lang.Long,
// org.apache.fineract.client.models.PostLoansLoanIdRequest)
@Deprecated(forRemoval = true)
private static String updateSchedulerJobAsJSON(final boolean active) {
final Map<String, String> map = new HashMap<>();
map.put("active", Boolean.toString(active));
LOG.info("map : {}", map);
return new Gson().toJson(map);
ok(() -> FineractFeignClientHelper.getFineractFeignClient().schedulerJob().updateJobDetail(jobId, request));
}

public void runSchedulerJob(int jobId) {
Calls.ok(FineractClientHelper.getFineractClient().jobs.executeJob((long) jobId, "executeJob"));
executeVoid(() -> FineractFeignClientHelper.getFineractFeignClient().schedulerJob().executeJob((long) jobId, "executeJob",
new ExecuteJobRequest()));
}

// TODO: Rewrite to use fineract-client instead!
// Example: org.apache.fineract.integrationtests.common.loans.LoanTransactionHelper.disburseLoan(java.lang.Long,
// org.apache.fineract.client.models.PostLoansLoanIdRequest)
@Deprecated(forRemoval = true)
public void runSchedulerJob(int jobId, ResponseSpecification responseSpec) {
final String RUN_SCHEDULER_JOB_URL = "/fineract-provider/api/v1/jobs/" + jobId + "?command=executeJob&" + Utils.TENANT_IDENTIFIER;
LOG.info("------------------------ RUN SCHEDULER JOB -------------------------");
Utils.performServerPost(requestSpec, responseSpec, RUN_SCHEDULER_JOB_URL, runSchedulerJobAsJSON(), null);
}

// TODO: Rewrite to use fineract-client instead!
// Example: org.apache.fineract.integrationtests.common.loans.LoanTransactionHelper.disburseLoan(java.lang.Long,
// org.apache.fineract.client.models.PostLoansLoanIdRequest)
@Deprecated(forRemoval = true)
public void runSchedulerJobByShortName(String shortName) {
final ResponseSpecification responseSpec = new ResponseSpecBuilder().expectStatusCode(202).build();
runSchedulerJobByShortName(shortName, responseSpec);
}

// TODO: Rewrite to use fineract-client instead!
// Example: org.apache.fineract.integrationtests.common.loans.LoanTransactionHelper.disburseLoan(java.lang.Long,
// org.apache.fineract.client.models.PostLoansLoanIdRequest)
@Deprecated(forRemoval = true)
public void runSchedulerJobByShortName(String shortName, ResponseSpecification responseSpec) {
final String RUN_SCHEDULER_JOB_URL = "/fineract-provider/api/v1/jobs/" + SHORT_NAME_PARAM + "/" + shortName + "?command=executeJob&"
+ Utils.TENANT_IDENTIFIER;
LOG.info("------------------------ RUN SCHEDULER JOB -------------------------");
Utils.performServerPost(requestSpec, responseSpec, RUN_SCHEDULER_JOB_URL, runSchedulerJobAsJSON(), null);
}

// TODO: Rewrite to use fineract-client instead!
// Example: org.apache.fineract.integrationtests.common.loans.LoanTransactionHelper.disburseLoan(java.lang.Long,
// org.apache.fineract.client.models.PostLoansLoanIdRequest)
@Deprecated(forRemoval = true)
private static String runSchedulerJobAsJSON() {
final Map<String, String> map = new HashMap<>();
String runSchedulerJob = new Gson().toJson(map);
LOG.info(runSchedulerJob);
return runSchedulerJob;
executeVoid(() -> FineractFeignClientHelper.getFineractFeignClient().schedulerJob().executeJobByShortName(shortName, "executeJob",
new ExecuteJobRequest()));
}

public int getSchedulerJobIdByName(String jobName) {
List<Map<String, Object>> allSchedulerJobsData = getAllSchedulerJobs();
for (Integer jobIndex = 0; jobIndex < allSchedulerJobsData.size(); jobIndex++) {
if (allSchedulerJobsData.get(jobIndex).get("displayName").equals(jobName)) {
return (Integer) allSchedulerJobsData.get(jobIndex).get("jobId");
List<GetJobsResponse> allSchedulerJobsData = getAllSchedulerJobs();
for (GetJobsResponse job : allSchedulerJobsData) {
if (jobName.equals(job.getDisplayName())) {
return job.getJobId().intValue();
}
}
throw new IllegalArgumentException(
Expand All @@ -195,7 +152,7 @@ public int getSchedulerJobIdByName(String jobName) {

public Long getSchedulerJobIdByShortName(String shortName) {
LOG.info("------------------------ RETRIEVING SCHEDULER JOB ID BY SHORT NAME -------------------------");
GetJobsResponse job = Calls.ok(FineractClientHelper.getFineractClient().jobs.retrieveByShortName(shortName));
GetJobsResponse job = ok(() -> FineractFeignClientHelper.getFineractFeignClient().schedulerJob().retrieveByShortName(shortName));
assertNotNull(job);
return job.getJobId();
}
Expand Down Expand Up @@ -265,7 +222,7 @@ private void awaitJob(long jobId, Long previousRunHistoryId) {
// (if any)
String status = (String) finalRunHistory.get("status");
if (!status.equals("success")) {
fail("Job status is not success: " + finalRunHistory.toString());
fail("Job status is not success for jobId=" + jobId + ": " + finalRunHistory.toString());
}
}

Expand All @@ -285,14 +242,25 @@ private Long getRunHistoryId(Map<String, Object> runHistory) {

@SuppressWarnings("unchecked")
private Map<String, Object> getLatestJobRunHistory(long jobId) {
final String GET_LATEST_SCHEDULER_JOB_RUN_HISTORY_URL = "/fineract-provider/api/v1/jobs/" + jobId
+ "/runhistory?offset=0&limit=1&orderBy=id&sortOrder=DESC&" + Utils.TENANT_IDENTIFIER;
LOG.info("------------------------ RETRIEVING LATEST SCHEDULER JOB RUN HISTORY -------------------------");
Map<String, Object> response = Utils.performServerGet(requestSpec, response200Spec, GET_LATEST_SCHEDULER_JOB_RUN_HISTORY_URL, "");
List<Map<String, Object>> pageItems = (List<Map<String, Object>>) response.get("pageItems");
Object response = ok(
() -> FineractFeignClientHelper.getFineractFeignClient().schedulerJob().retrieveHistory(jobId, 0, 1, "id", "DESC"));
Map<String, Object> responseMap = toMap(response);
List<Map<String, Object>> pageItems = (List<Map<String, Object>>) responseMap.get("pageItems");
if (pageItems == null || pageItems.isEmpty()) {
return null;
}
return pageItems.get(0);
}

/**
* Converts a typed Feign response into a plain {@code Map<String, Object>} via a JSON round-trip, preserving the
* exact field-name contract that callers previously relied on when this Helper deserialized raw RestAssured JSON
* responses into generic maps. Uses a Gson instance with explicit {@code java.time} serializers (rather than a bare
* {@code new Gson()}) so date/time fields round-trip as plain ISO-8601 strings, matching what the original raw
* server JSON produced, instead of Gson's default reflective (and much uglier) field-by-field breakdown.
*/
private static Map<String, Object> toMap(Object typedResponse) {
return GSON.fromJson(GSON.toJson(typedResponse), Map.class);
}
}
Loading