samchinmaya opened a new pull request, #6630: URL: https://github.com/apache/fineract/pull/6630
## Description JIRA: [FINERACT-2931](https://issues.apache.org/jira/browse/FINERACT-2931) Creating a hook with the **Web** template fails with HTTP 500 when the Payload URL doesn't end with a slash, which is the usual form of a webhook URL (e.g. `https://example.com/hook`): ``` java.lang.IllegalArgumentException: baseUrl must end in /: https://example.com/hook at ...hooks.processor.ProcessorHelper.createWebHookService(ProcessorHelper.java:118) at ...hooks.service.HookWritePlatformServiceImpl.validateHookRules(HookWritePlatformServiceImpl.java:242) ``` Cause: `WebHookService` uses `@POST(".")` / `@GET(".")`, so `ProcessorHelper.createWebHookService(url)` passes the Payload URL to Retrofit as the *base* URL, and Retrofit requires a base URL that ends with "/". `validateHookRules()` only catches `IOException`, so the `IllegalArgumentException` became a 500. For the same reason a malformed URL also gave a 500 instead of a validation error. Change: - `WebHookService`: the hook URL is passed to each request with Retrofit's `@Url` (`sendEmptyRequest`, `sendJsonRequest`, `sendFormRequest`, `sendSmsBridgeRequest`). `sendSmsBridgeConfigRequest` (`@POST("/configuration")`) is unchanged. - `ProcessorHelper.createWebHookService(url)`: the base URL is only the scheme, host and port of the hook URL (`HttpUrl.get(url).resolve("/")`). URLs that already end with "/" are sent to exactly the same address as before, and the SMS Bridge configuration request still goes to `/configuration` on the bridge host. - `HookWritePlatformServiceImpl.validateHookRules()`: an invalid URL (`IllegalArgumentException`) is reported as `url.invalid` (400). - The Web, Elastic Search and SMS Bridge processors pass the URL to the calls. - Tests: `ProcessorHelperTest` checks the request URL for a URL without a trailing slash (JSON, form and ping requests), a URL with a trailing slash and one with a query string (unchanged), the SMS Bridge configuration request (host root), and that an invalid URL is rejected. Verification: - `ProcessorHelperTest` passes (4/4); `spotlessJavaCheck`, `checkstyleMain` and `checkstyleTest` pass. - Real API, on a Fineract image built from this branch (with a small HTTP receiver at `http://host.docker.internal:9911/hook`): - `POST /hooks` with Payload URL `http://host.docker.internal:9911/hook` returns 200 (on develop: 500 as above). The ping on creation arrives as `GET /hook`. - Creating a client then delivers `POST /hook` with `X-Fineract-Entity: CLIENT` and `X-Fineract-Action: CREATE`, once per event (checked with one and with two registered hooks). - A hook with a trailing-slash URL still works, and Payload URL `abc` now returns 400 `url.invalid` (on develop: 500). ## Checklist Please make sure these boxes are checked before submitting your pull request - thanks! - [x] Write the commit message as per [our guidelines](https://github.com/apache/fineract/blob/develop/CONTRIBUTING.md#pull-requests) - [x] 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. - [x] Create/update [unit or integration tests](https://fineract.apache.org/docs/current/#_testing) for verifying the changes made. - [x] Follow our [coding conventions](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 (no API change) - [x] [This PR must not be a "code dump"](https://cwiki.apache.org/confluence/display/FINERACT/Pull+Request+Size+Limit). Large changes can be made in a branch, with assistance. Ask for help on the [developer mailing list](https://fineract.apache.org/#contribute). - [x] If merging this PR resolves a JIRA issue, I will mark that issue as resolved and set "Fix Version/s" appropriately. - [x] I followed the [AI Policy](https://github.com/apache/fineract/blob/develop/CONTRIBUTING.md#ai-policy). Your assigned reviewer(s) will follow our [guidelines for code reviews](https://cwiki.apache.org/confluence/display/FINERACT/Code+Review+Guide). -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
