FINERACT-2380: create feign client #5082

budaidev · 2025-10-06T04:52:47Z

Description

Describe the changes made and why they were made.

Ignore if these details are present on the associated Apache Fineract JIRA ticket.

Checklist

Please make sure these boxes are checked before submitting your pull request - thanks!

Write the commit message as per https://github.com/apache/fineract/#pull-requests
Acknowledge that we will not review PRs that are not passing the build ("green") - it is your responsibility to get a proposed PR to pass the build, not primarily the project's maintainers.
Create/update unit or integration tests for verifying the changes made.
Follow coding conventions at https://cwiki.apache.org/confluence/display/FINERACT/Coding+Conventions.
Add required Swagger annotation and update API documentation at fineract-provider/src/main/resources/static/legacy-docs/apiLive.htm with details of any API changes
Submission is not a "code dump". (Large changes can be made "in repository" via a branch. Ask on the developer mailing list for guidance, if required.)

FYI our guidelines for code reviews are at https://cwiki.apache.org/confluence/display/FINERACT/Code+Review+Guide.

adamsaghy · 2025-10-08T12:14:28Z

fineract-client-feign/build.gradle

+
+    doFirst {
+        delete fileTree(tempDir) {
+            include "src/main/java/org/apache/fineract/client/auth/OAuthOkHttpClient.java"


Is this still needed?

adamsaghy · 2025-10-08T12:14:47Z

fineract-client-feign/build.gradle

+            into targetDir
+            filter { line ->
+                line
+                    .replaceAll("import org\\.joda\\.time\\.\\*;", "")


is this still needed?

removed, we don't need to support java 8 anyway

adamsaghy · 2025-10-08T12:15:16Z

fineract-client-feign/build.gradle

+java {
+    sourceCompatibility = JavaVersion.VERSION_1_8
+    targetCompatibility = JavaVersion.VERSION_1_8
+}
+
+tasks.withType(JavaCompile).configureEach {
+    options.encoding = 'UTF-8'
+    options.compilerArgs << '-parameters'
+    options.errorprone {
+        excludedPaths = '.*/build/generated/java/src/main/java/.*'
+    }


Is this still needed?

...-client-feign/src/main/java/org/apache/fineract/client/feign/services/DocumentsApiFixed.java

fineract-client-feign/src/main/java/org/apache/fineract/client/feign/services/ImagesApi.java

...ract-client-feign/src/main/java/org/apache/fineract/client/feign/services/RunReportsApi.java

adamsaghy · 2025-10-08T12:21:58Z

fineract-client-feign/src/main/java/org/apache/fineract/client/services/DocumentsApiFixed.java

+ * Swagger YAML generation from the JAX RS and OpenAPI annotation to have the correct notation for binary document files
+ * and images, then this could be removed again.
+ */
+public interface DocumentsApiFixed {


removed duplicate

adamsaghy · 2025-10-08T12:22:05Z

fineract-client-feign/src/main/java/org/apache/fineract/client/services/ImagesApi.java

+ * in DefaultApi (see <a href="https://issues.apache.org/jira/browse/FINERACT-1222">FINERACT-1222</a>), but fixed for
+ * bugs in the code generation (see <a href="https://issues.apache.org/jira/browse/FINERACT-1227">FINERACT-1227</a>).
+ */
+public interface ImagesApi {


removed duplicate

adamsaghy · 2025-10-08T12:22:16Z

fineract-client-feign/src/main/java/org/apache/fineract/client/services/RunReportsApi.java

+import java.util.Map;
+import org.apache.fineract.client.models.RunReportsResponse;
+
+public interface RunReportsApi {


removed duplicate

adamsaghy · 2025-10-08T12:22:26Z

...t-client-feign/src/main/java/org/apache/fineract/client/util/CallFailedRuntimeException.java

+ */
+@Slf4j
+@Getter
+public class CallFailedRuntimeException extends RuntimeException {


removed duplicate

adamsaghy · 2025-10-08T12:22:35Z

fineract-client-feign/src/main/java/org/apache/fineract/client/util/FeignCalls.java

+/**
+ * Extension methods for Feign calls. This class is recommended to be statically imported.
+ */
+public final class FeignCalls {


removed duplicate

adamsaghy · 2025-10-08T12:23:00Z

fineract-client-feign/src/main/java/org/apache/fineract/client/util/Parts.java

+ * {@link DocumentsApiFixed#updateDocument(String, Long, Long, File, String, String)} and
+ * {@link ImagesApi#create(String, Long, File)} and {@link ImagesApi#update(String, Long, File)}.
+ */
+public final class Parts {


Is this still required?

No, removed it

adamsaghy · 2025-10-08T12:26:51Z

...a/org/apache/fineract/infrastructure/core/domain/AbstractAuditableWithUTCDateTimeCustom.java

    private static final long serialVersionUID = 141481953116476081L;

    @Column(name = CREATED_BY_DB_FIELD, updatable = false, nullable = false)
-    @Setter(onMethod_ = @Override)


any reason to remove these?

adamsaghy · 2025-10-08T12:27:38Z

integration-tests/build.gradle

+String waitForFineractTimeoutSeconds = project.findProperty('waitForFineractTimeoutSeconds') ?: '600'
+String waitForFineractCommand = "timeout ${waitForFineractTimeoutSeconds} bash -c 'until curl -k -s --fail \"https://localhost:8443/fineract-provider/actuator/health\" > /dev/null; do sleep 5; echo \"Waiting for Fineract startup...\"; done'"
+
+tasks.register('waitForFineract') {
+    doLast {
+        exec {
+            commandLine 'bash', '-lc', waitForFineractCommand
+        }
+    }
+}


Any reason for this?

For integration tests we need to wait for the cargo instance to be start, if it is not included it will send the request before the service started. The Retrofit based client worked because it kept retrying

This would not work if someone tries to run it on windows, no?

Can we have something like this instead?

import java.net.HttpURLConnection import java.net.URL tasks.register('waitForFineract') { doLast { int timeoutSeconds = (project.findProperty('waitForFineractTimeoutSeconds') ?: '600') as int int waited = 0 int interval = 5 URL url = new URL("https://localhost:8443/fineract-provider/actuator/health") println "Waiting for Fineract startup (timeout: ${timeoutSeconds}s)..." while (waited < timeoutSeconds) { try { HttpURLConnection connection = (HttpURLConnection) url.openConnection() connection.setConnectTimeout(2000) connection.setReadTimeout(2000) connection.setRequestMethod("GET") int responseCode = connection.getResponseCode() if (responseCode == 200) { println "Fineract is up!" return } } catch (Exception ignored) { } sleep(interval * 1000) waited += interval println "Still waiting..." } throw new GradleException("Fineract did not start within ${timeoutSeconds} seconds") } }

adamsaghy · 2025-10-08T12:30:16Z

integration-tests/dependencies.gradle

+    // Retrofit client for existing tests
+    testImplementation project(path: ':fineract-client', configuration: 'runtimeElements')
+
+    // Feign client - exclude services to avoid conflicts with Retrofit client


if you exclude the generated services, how can any of the integration tests using this client?

I clarified the comment we don't actually excluded it

adamsaghy

LGTM

budaidev force-pushed the FINERACT-2380/create-feign-client branch from a1ab808 to 06c3fc3 Compare October 7, 2025 12:52

budaidev marked this pull request as ready for review October 7, 2025 13:01

adamsaghy reviewed Oct 8, 2025

View reviewed changes

...-client-feign/src/main/java/org/apache/fineract/client/feign/services/DocumentsApiFixed.java Show resolved Hide resolved

adamsaghy reviewed Oct 8, 2025

View reviewed changes

fineract-client-feign/src/main/java/org/apache/fineract/client/feign/services/ImagesApi.java Show resolved Hide resolved

adamsaghy reviewed Oct 8, 2025

View reviewed changes

...ract-client-feign/src/main/java/org/apache/fineract/client/feign/services/RunReportsApi.java Show resolved Hide resolved

adamsaghy reviewed Oct 8, 2025

View reviewed changes

budaidev force-pushed the FINERACT-2380/create-feign-client branch 7 times, most recently from 1dfd973 to 860fce4 Compare October 10, 2025 13:37

FINERACT-2380: create feign client

5aa67c8

budaidev force-pushed the FINERACT-2380/create-feign-client branch from 860fce4 to 5aa67c8 Compare October 13, 2025 16:13

budaidev requested a review from adamsaghy October 15, 2025 13:03

adamsaghy approved these changes Oct 15, 2025

View reviewed changes

FINERACT-2380: create feign client #5082

Are you sure you want to change the base?

FINERACT-2380: create feign client #5082

Uh oh!

Conversation

budaidev commented Oct 6, 2025

Description

Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adamsaghy Oct 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adamsaghy left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

adamsaghy Oct 8, 2025 •

edited

Loading