FINERACT 2120: Add new command parameters withdrawToLinkedAccount and disburseToLinkedAccount and integrate with PHEE #4046

kaibalya-fynarfin · 2024-09-04T07:55:09Z

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.

…nkedAccount

adamsaghy · 2024-09-04T16:37:56Z

fineract-provider/build.gradle

@@ -28,6 +28,13 @@ apply plugin: 'com.google.cloud.tools.jib'
 apply plugin: 'org.springframework.boot'
 apply plugin: 'se.thinkcode.cucumber-runner'

+
+repositories {


Please remove this repository!

This repository is required for this dependency implementation 'org.pheesdk:PaymentHubSDK:1.0.0'

You cannot put your own repository into a community project. If the payment hub sdk is not available on a public repository that is not controlled by your organization, it has absolutely no place in opersource, community Fineract.

Would it be possible to load the Payment Hub SDK dependency at runtime if it's hosted in a private JFrog Artifactory?

This is absolutely a no-go. If Payment Hub SDK is needed, let's fix it over there to be published to a publicly accessed repository, for example Maven central.

adamsaghy · 2024-09-04T16:38:39Z

fineract-provider/build.gradle

@@ -164,15 +171,15 @@ configurations.driver.each {File file ->
 task createDB {
    description= "Creates the MariaDB Database. Needs database name to be passed (like: -PdbName=someDBname)"
    doLast {
-        def sql = Sql.newInstance( 'jdbc:mariadb://localhost:3306/', mysqlUser, mysqlPassword, 'org.mariadb.jdbc.Driver' )
+        def sql = Sql.newInstance( 'jdbc:mariadb://localhost:3307/', mysqlUser, mysqlPassword, 'org.mariadb.jdbc.Driver' )


Please reverse these changes!

will do that

This comment shouldn't be resolved since the changes weren't yet made.

adamsaghy · 2024-09-04T16:38:43Z

fineract-provider/build.gradle

        sql.execute( 'CREATE DATABASE '+"`$dbName` CHARACTER SET utf8mb4" )
    }
 }

 task dropDB {
    description= "Drops the specified MariaDB database. The database name has to be passed (like: -PdbName=someDBname)"
    doLast {
-        def sql = Sql.newInstance( 'jdbc:mariadb://localhost:3306/', mysqlUser, mysqlPassword, 'org.mariadb.jdbc.Driver' )
+        def sql = Sql.newInstance( 'jdbc:mariadb://localhost:3307/', mysqlUser, mysqlPassword, 'org.mariadb.jdbc.Driver' )


Please reverse these changes!

will do that

This comment shouldn't be resolved since the changes weren't yet made.

adamsaghy · 2024-09-04T16:45:47Z

fineract-core/src/main/java/org/apache/fineract/infrastructure/core/api/JsonCommand.java

@@ -52,6 +53,7 @@
 */

 @Getter
+@Setter


Why do we need Setter annotation here?

Why was this resolved?

adamsaghy · 2024-09-04T16:47:57Z

...act-core/src/main/java/org/apache/fineract/portfolio/paymentdetail/domain/PaymentDetail.java

@@ -35,6 +36,7 @@

 @Entity
 @Getter
+@Setter


Why did introduced setters here?

Why was this resolved?

adamsaghy · 2024-09-04T16:50:49Z

fineract-provider/build.gradle

@@ -225,6 +232,7 @@ bootRun {
    dependencies {
        implementation 'org.mariadb.jdbc:mariadb-java-client'
        implementation 'org.postgresql:postgresql'
+        implementation 'org.pheesdk:PaymentHubSDK:1.0.0'


I dont think it is right to be here. Would you move to the dependencies.gradle? Also it might be better to have it in a separate module. Most of the ppl would not need payment hub support...
@vidakovic What do you think?

The version shouldn't be here that's for sure. In terms of packaging the PaymentHubSDK with Fineract, there are 2 options:

bundle with Fineract as it is

extract into a separate module where the payment hub dependency is there - in this case there needs to be build adjustments so that Fineract is published in 2 versions, with and without payment hub

I'm not sure how much extra weight the Payment Hub SDK is, but if it's just DTOs and API classes, I'd say it's acceptable to be bundled with Fineract.

adamsaghy · 2024-09-04T16:51:21Z

...apache/fineract/portfolio/loanaccount/handler/DisburseLoanToLinkedAccountCommandHandler.java

+@Service
+@RequiredArgsConstructor
+@CommandType(entity = "LOAN", action = "DISBURSETOLINKEDACCOUNT")
+public class DisburseLoanToLinkedAccountCommandHandler implements NewCommandSourceHandler {


Would you consider moving payment hub ee related stuff to a separate module?

adamsaghy · 2024-09-04T16:54:22Z

...n/java/org/apache/fineract/portfolio/loanaccount/serialization/LoanApplicationValidator.java

@@ -2123,6 +2126,7 @@ public static void validateOrThrow(String resource, Consumer<DataValidatorBuilde
        baseDataValidator.accept(dataValidatorBuilder);

        if (!dataValidationErrors.isEmpty()) {
+            logger.info(dataValidationErrors.toString());


Please remove this! Exception handler can decide whether they are logging something or not. Also dont use "INFO" level logging for logging out exceptions!

Why was this comment resolved?

adamsaghy · 2024-09-04T16:55:25Z

...apache/fineract/portfolio/loanaccount/service/LoanWritePlatformServiceJpaRepositoryImpl.java

@@ -295,6 +303,139 @@ public CommandProcessingResult disburseLoan(Long loanId, JsonCommand command, Bo
        return disburseLoan(loanId, command, isAccountTransfer, false);
    }

+    @Transactional
+    @Override
+    public CommandProcessingResult disburseLoanToLinkedAccount(Long loanId, JsonCommand command, Boolean isAccountTransfer) {


Most of the part of this method is duplication. Would you consider extracting into methods the common logics?

...apache/fineract/portfolio/loanaccount/service/LoanWritePlatformServiceJpaRepositoryImpl.java

adamsaghy · 2024-09-04T16:58:47Z

...apache/fineract/portfolio/loanaccount/service/LoanWritePlatformServiceJpaRepositoryImpl.java

+        InteropIdentifier identifier1 = interopService.getIdentifierByAccountId(portfolioAccountData.getId());
+        String payerIdentifierType = InteropIdentifierType.ACCOUNT_ID.toString();
+        String payerIdentifierValue = loan.getAccountNumber();
+        String payeeIdentifierType = identifier1.getType().toString();


Please dont use the toString of an enum. There is no explicit toString for this enum so it is basically give you the value of name(). Please use that if that's the information you are looking for. Anyone who override the toString method of this enum in the future will effectively break you logic.

adamsaghy · 2024-09-04T16:59:00Z

...apache/fineract/portfolio/loanaccount/service/LoanWritePlatformServiceJpaRepositoryImpl.java

+        }
+
+        InteropIdentifier identifier1 = interopService.getIdentifierByAccountId(portfolioAccountData.getId());
+        String payerIdentifierType = InteropIdentifierType.ACCOUNT_ID.toString();


Please dont use the toString of an enum. There is no explicit toString for this enum so it is basically give you the value of name(). Please use that if that's the information you are looking for. Anyone who override the toString method of this enum in the future will effectively break you logic.

adamsaghy · 2024-09-04T17:02:14Z

...apache/fineract/portfolio/loanaccount/service/LoanWritePlatformServiceJpaRepositoryImpl.java

+        try {
+            String id = sdkDisbursalService.processDisbursal(payerIdentifierType, payerIdentifierValue, payeeIdentifierType,
+                    payeeIdentifierValue, amount, currency);
+            logger.info("Payment hub transaction started with transaction id: " + id);


Please dont log info that something was started or finished. It has no additional value. If you need this operation log, mark it as debug hence info is the default level.

As an extra, please use placeholders instead of concatenating the parameters.

adamsaghy · 2024-09-04T17:03:08Z

...apache/fineract/portfolio/loanaccount/service/LoanWritePlatformServiceJpaRepositoryImpl.java

+                    payeeIdentifierValue, amount, currency);
+            logger.info("Payment hub transaction started with transaction id: " + id);
+        } catch (Exception e) {
+            logger.error(e.getMessage());


Please dont just silently swallow the outcome. How can the disbursement action be successful when the sdkDisbursalService failed for any reason...

Please review this logic!

adamsaghy · 2024-09-04T17:04:42Z

...src/main/java/org/apache/fineract/portfolio/loanaccount/service/SdkDisbursalServiceImpl.java

+        String id = null;
+        try {
+            id = transferService.processPayment(payerType, payerId, payeeType, payeeId, amount, currencyCode);
+            logger.info(id);


Please remove this info log from here. If you want it for debug purposes, please use debug level and also use proper descriptive messages. Logging the value of the id field without any messages is useless.

adamsaghy · 2024-09-04T17:05:37Z

...src/main/java/org/apache/fineract/portfolio/loanaccount/service/SdkDisbursalServiceImpl.java

+            id = transferService.processPayment(payerType, payerId, payeeType, payeeId, amount, currencyCode);
+            logger.info(id);
+        } catch (SdkApiException e) {
+            logger.error("Error status code: " + e.getStatusCode());


Please have proper exception handling. Logging out the error is not effective and deciding whether something was successful or not merely whether the returned id is null or not is not recommended!

Also, use placeholders.

adamsaghy · 2024-09-04T17:05:50Z

...src/main/java/org/apache/fineract/portfolio/loanaccount/service/SdkDisbursalServiceImpl.java

+        } catch (SdkApiException e) {
+            logger.error("Error status code: " + e.getStatusCode());
+            logger.error("Error status code: " + e.getResponseBody());
+            System.out.println(e.getResponseBody());


Please remove the System.out.println.

adamsaghy · 2024-09-04T17:06:03Z

...src/main/java/org/apache/fineract/portfolio/loanaccount/service/SdkDisbursalServiceImpl.java

+            logger.error("Error status code: " + e.getResponseBody());
+            System.out.println(e.getResponseBody());
+        } catch (Exception e) {
+            logger.error(e.getMessage());


Some as above.

adamsaghy · 2024-09-04T17:08:55Z

...src/main/java/org/apache/fineract/portfolio/loanaccount/service/SdkDisbursalServiceImpl.java

+
+    @Override
+    public String processDisbursal(String payerType, String payerId, String payeeType, String payeeId, String amount, String currencyCode)
+            throws SdkValidationException, SdkApiException {


Since you are catching Exception, i dont really understand how would this method throw any of these exceptions....

adamsaghy · 2024-09-04T17:10:02Z

...c/main/java/org/apache/fineract/portfolio/savings/domain/SavingsAccountDomainServiceJpa.java

@@ -67,7 +70,7 @@ public SavingsAccountDomainServiceJpa(final SavingsAccountRepositoryWrapper savi
            final JournalEntryWritePlatformService journalEntryWritePlatformService,
            final ConfigurationDomainService configurationDomainService, final PlatformSecurityContext context,
            final DepositAccountOnHoldTransactionRepository depositAccountOnHoldTransactionRepository,
-            final BusinessEventNotifierService businessEventNotifierService) {
+            final BusinessEventNotifierService businessEventNotifierService, @Lazy final InteropService interopService) {


adamsaghy · 2024-09-04T17:10:46Z

.../fineract/portfolio/savings/service/SavingsAccountWritePlatformServiceJpaRepositoryImpl.java

+    @Transactional
+    @Override
+    public CommandProcessingResult withdrawToLinkedAccount(final Long savingsId, final JsonCommand command) {
+


It seems majorly a copy-paste of existing functionality, i kindly asking you to extract the common logic into methods and reuse them.

.../fineract/portfolio/savings/service/SavingsAccountWritePlatformServiceJpaRepositoryImpl.java

adamsaghy · 2024-09-04T17:11:42Z

.../fineract/portfolio/savings/service/SavingsAccountWritePlatformServiceJpaRepositoryImpl.java

+        changes.put(PaymentDetailConstants.routingCodeParamName, identifierType);
+        changes.put(PaymentDetailConstants.accountNumberParamName, identifierValue);
+
+        paymentDetail.setRoutingCode(identifierType.toString());


Please dont use toString. Use explicitly the method or field value that you need!

adamsaghy · 2024-09-04T17:12:40Z

.../fineract/portfolio/savings/service/SavingsAccountWritePlatformServiceJpaRepositoryImpl.java

+
+        this.savingsAccountTransactionDataValidator.validateTransactionWithPivotDate(transactionDate, account);
+
+        SdkWithdrawalService sdkWithdrawalService = new SdkWithdrawalServiceImpl();


Please rework this to be a Spring bean, so if someone wanna override it eventually, they can...

adamsaghy · 2024-09-04T17:12:57Z

.../fineract/portfolio/savings/service/SavingsAccountWritePlatformServiceJpaRepositoryImpl.java

+        this.savingsAccountTransactionDataValidator.validateTransactionWithPivotDate(transactionDate, account);
+
+        SdkWithdrawalService sdkWithdrawalService = new SdkWithdrawalServiceImpl();
+        String id = sdkWithdrawalService.processWithdrawal(identifierType.toString(), identifierValue, paymentDetail.getRoutingCode(),


Please dont use toString method values...

.../fineract/portfolio/savings/service/SavingsAccountWritePlatformServiceJpaRepositoryImpl.java

adamsaghy · 2024-09-04T17:13:58Z

.../fineract/portfolio/savings/service/SavingsAccountWritePlatformServiceJpaRepositoryImpl.java

@@ -405,6 +414,58 @@ public CommandProcessingResult withdrawal(final Long savingsId, final JsonComman
                .build();
    }

+    @Transactional
+    @Override
+    public CommandProcessingResult withdrawToLinkedAccount(final Long savingsId, final JsonCommand command) {


Would you consider moving this into a separate, standalone module?

...er/src/main/java/org/apache/fineract/portfolio/savings/service/SdkWithdrawalServiceImpl.java

adamsaghy · 2024-09-04T17:15:42Z

fineract-provider/src/main/resources/application.properties

@@ -26,7 +26,7 @@ fineract.security.oauth.enabled=${FINERACT_SECURITY_OAUTH_ENABLED:false}
 fineract.security.2fa.enabled=${FINERACT_SECURITY_2FA_ENABLED:false}

 fineract.tenant.host=${FINERACT_DEFAULT_TENANTDB_HOSTNAME:localhost}
-fineract.tenant.port=${FINERACT_DEFAULT_TENANTDB_PORT:3306}
+fineract.tenant.port=${FINERACT_DEFAULT_TENANTDB_PORT:3307}


Please reverse this change!

adamsaghy · 2024-09-04T17:15:47Z

fineract-provider/src/main/resources/application.properties

@@ -355,7 +355,7 @@ server.tomcat.threads.min-spare=${FINERACT_SERVER_TOMCAT_THREADS_MIN_SPARE:10}
 spring.security.oauth2.resourceserver.jwt.issuer-uri=${FINERACT_SERVER_OAUTH_RESOURCE_URL:http://localhost:9000/auth/realms/fineract}

 spring.datasource.hikari.driverClassName=${FINERACT_HIKARI_DRIVER_SOURCE_CLASS_NAME:org.mariadb.jdbc.Driver}
-spring.datasource.hikari.jdbcUrl=${FINERACT_HIKARI_JDBC_URL:jdbc:mariadb://localhost:3306/fineract_tenants}
+spring.datasource.hikari.jdbcUrl=${FINERACT_HIKARI_JDBC_URL:jdbc:mariadb://localhost:3307/fineract_tenants}


Please reverse this change!

...rovider/src/main/resources/db/changelog/tenant/parts/0147_enable_payment_hub_integration.xml

adamsaghy · 2024-09-04T17:16:05Z

integration-tests/build.gradle

@@ -20,6 +20,12 @@ description = 'Fineract Integration Tests'

 apply plugin: 'com.bmuschko.cargo'

+repositories {


Please reverse this change!

adamsaghy

Kindly see my review!

Also please dont forget the execute code formatting and static code analysis:
./gradlew spotlessApply spotbugsMain spotbugsTest checkstyleMain checkstyleTest

Also, i dont see any integration tests or unit tests to cover any of the functionalities which is an important aspect of any contribution!

adamsaghy · 2024-09-04T17:28:56Z

...er/src/main/java/org/apache/fineract/portfolio/savings/service/SdkWithdrawalServiceImpl.java

+    public String processWithdrawal(String payerType, String payerId, String payeeType, String payeeId, String amount, String currencyCode)
+            throws SdkValidationException, SdkApiException {
+        String id = null;
+        transferService.setPlatformTenantId("gorilla");


Please remove this hardcoded values!

Let's hold off on these PRs... until we get some additional discussion. An SDK does not belong here.

@kaibalya-fynarfin would you please announce these intended changes and the pr on the Fineract DEV mail list? we have a feeling it should be discussed over there with the community!

...er/src/main/java/org/apache/fineract/portfolio/savings/service/SdkWithdrawalServiceImpl.java

adamsaghy · 2024-09-04T17:29:16Z

...src/main/java/org/apache/fineract/portfolio/loanaccount/service/SdkDisbursalServiceImpl.java

+    @Override
+    public String processDisbursal(String payerType, String payerId, String payeeType, String payeeId, String amount, String currencyCode)
+            throws SdkValidationException, SdkApiException {
+        transferService.setBaseUrl("http://localhost:1111");


Please remove this hardcoded values!

adamsaghy · 2024-09-04T17:29:20Z

...src/main/java/org/apache/fineract/portfolio/loanaccount/service/SdkDisbursalServiceImpl.java

+    public String processDisbursal(String payerType, String payerId, String payeeType, String payeeId, String amount, String currencyCode)
+            throws SdkValidationException, SdkApiException {
+        transferService.setBaseUrl("http://localhost:1111");
+        transferService.setPlatformTenantId("gorilla");


Please remove this hardcoded values!

adamsaghy · 2024-09-04T17:30:42Z

@kaibalya-fynarfin Would you mind to announce this PR and new functionality of "Add features like withdrawal to linked account and disburse to linked account to increase interoperability between FSPs using Payment Hub APIs and Interop table" on the Fineract DEV mail list?

galovics · 2024-09-17T09:18:27Z

fineract-core/src/main/java/org/apache/fineract/infrastructure/core/api/JsonCommand.java

@@ -52,6 +53,7 @@
 */

 @Getter
+@Setter


Why was this resolved?

galovics · 2024-09-17T09:19:21Z

...che/fineract/infrastructure/core/exceptionmapper/ConfigurationNotEnabledExceptionMapper.java

+
+@Provider
+@Component
+@Scope("singleton")


Not needed.

galovics · 2024-09-17T09:19:52Z

...act-core/src/main/java/org/apache/fineract/portfolio/paymentdetail/domain/PaymentDetail.java

@@ -35,6 +36,7 @@

 @Entity
 @Getter
+@Setter


Why was this resolved?

galovics · 2024-09-17T09:20:49Z

fineract-provider/build.gradle

@@ -28,6 +28,13 @@ apply plugin: 'com.google.cloud.tools.jib'
 apply plugin: 'org.springframework.boot'
 apply plugin: 'se.thinkcode.cucumber-runner'

+
+repositories {


This is absolutely a no-go. If Payment Hub SDK is needed, let's fix it over there to be published to a publicly accessed repository, for example Maven central.

galovics · 2024-09-17T09:21:20Z

fineract-provider/build.gradle

@@ -164,15 +171,15 @@ configurations.driver.each {File file ->
 task createDB {
    description= "Creates the MariaDB Database. Needs database name to be passed (like: -PdbName=someDBname)"
    doLast {
-        def sql = Sql.newInstance( 'jdbc:mariadb://localhost:3306/', mysqlUser, mysqlPassword, 'org.mariadb.jdbc.Driver' )
+        def sql = Sql.newInstance( 'jdbc:mariadb://localhost:3307/', mysqlUser, mysqlPassword, 'org.mariadb.jdbc.Driver' )


This comment shouldn't be resolved since the changes weren't yet made.

galovics · 2024-09-17T09:38:53Z

...der/src/main/java/org/apache/fineract/portfolio/loanaccount/service/SdkDisbursalService.java

+
+public interface SdkDisbursalService {
+
+    String processDisbursal(String payerType, String payerId, String payeeType, String payeeId, String amount, String currencyCode)


I really don't like this method signature. Everything is a string. Please use a DTO instead so you can't mess up the order of parameters.

Also, the amount is a String? Why?

galovics · 2024-09-17T09:39:03Z

...src/main/java/org/apache/fineract/portfolio/loanaccount/service/SdkDisbursalServiceImpl.java

+
+public class SdkDisbursalServiceImpl implements SdkDisbursalService {
+
+    private static final Logger logger = LoggerFactory.getLogger(SdkWithdrawalServiceImpl.class);


Use Lombok instead.

galovics · 2024-09-17T09:39:21Z

...src/main/java/org/apache/fineract/portfolio/loanaccount/service/SdkDisbursalServiceImpl.java

+    private TransferService transferService;
+
+    public SdkDisbursalServiceImpl() {
+        TransferService transferService = new TransferService();
+        this.transferService = transferService;
+
+    }


Should not be used like this, but rather as a Spring Bean.

galovics · 2024-09-17T09:39:54Z

...src/main/java/org/apache/fineract/portfolio/loanaccount/service/SdkDisbursalServiceImpl.java

+            id = transferService.processPayment(payerType, payerId, payeeType, payeeId, amount, currencyCode);
+            logger.info(id);
+        } catch (SdkApiException e) {
+            logger.error("Error status code: " + e.getStatusCode());


Also, use placeholders.

galovics · 2024-09-17T09:41:05Z

...ovider/src/main/java/org/apache/fineract/portfolio/savings/service/SdkWithdrawalService.java

+
+public interface SdkWithdrawalService {
+
+    String processWithdrawal(String payerType, String payerId, String payeeType, String payeeId, String amount, String currencyCode)


Same as for the other.

galovics · 2024-10-08T09:28:03Z

@kaibalya-fynarfin are you planning to fix this PR?

kaibalya-fynarfin added 4 commits September 4, 2024 13:10

added new command parameters withdrawToLinkedAccount and disburseToLi…

1aed130

…nkedAccount

added lincenses to newly added files

1c410ab

fixed spotless and port pipeline build failed issues

308efb3

reabased

2aef648