Skip to content

feat: Api response extensions #754

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
benjaminVadon wants to merge 5 commits into
base: main
Choose a base branch
from
Open

feat: Api response extensions #754

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ed2c0c8
chore: Add isError method
benjaminVadon Apr 22, 2026
f99509c
feat: Add ApiResponse extension methods to simplify success and failu…
benjaminVadon Apr 22, 2026
2f71fd2
chore: Add a toString to ApiResponse
benjaminVadon Apr 23, 2026
65d5bca
feat: Remove map method as they need more reflection on real usage an…
benjaminVadon Apr 23, 2026
0572199
fix: Prevent usage for nullable types
benjaminVadon Apr 30, 2026
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
8 changes: 7 additions & 1 deletion Network/Models/src/main/java/com/infomaniak/core/network/models/ApiResponse.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* Infomaniak Core - Android
* Copyright (C) 2022-2025 Infomaniak Network SA
* Copyright (C) 2022-2026 Infomaniak Network SA
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
Expand Down Expand Up @@ -52,4 +52,10 @@ open class ApiResponse<T>(
var headers: ResponseHeaders = ResponseHeaders()

fun isSuccess() = result == ApiResponseStatus.SUCCESS

fun isError() = result == ApiResponseStatus.ERROR

override fun toString(): String {
return "ApiResponse(result=$result, data=$data, uri=$uri, error=$error, responseAt=$responseAt )"
}
}
22 changes: 22 additions & 0 deletions Network/src/main/kotlin/com/infomaniak/core/network/utils/apiResponse/ApiErrorException.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
/*
* Infomaniak Core - Android
* Copyright (C) 2026 Infomaniak Network SA
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package com.infomaniak.core.network.utils.apiResponse

import com.infomaniak.core.network.models.ApiResponse

class ApiErrorException(response: ApiResponse<*>) : Exception("Error is null but required for an error $response")
Comment thread
benjaminVadon marked this conversation as resolved.

@LouisCAD LouisCAD May 28, 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.

The name ApiErrorException doesn't really reflect what it's always about (according to the exception message). Same for ApiResponseException.
Nothing in the class name tells you that it's about missing data.

I have multiple suggestions:

  1. Merge these 2 exceptions into one, with the name of any of them, and error message as a constructor parameter
  2. Create a sealed class hierarchy with the name ApiResponseException for the base class, and 2 nested subclasses named something like MissingErrorField and MissingDataField.

22 changes: 22 additions & 0 deletions ...ork/src/main/kotlin/com/infomaniak/core/network/utils/apiResponse/ApiResponseException.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
/*
* Infomaniak Core - Android
* Copyright (C) 2026 Infomaniak Network SA
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package com.infomaniak.core.network.utils.apiResponse

import com.infomaniak.core.network.models.ApiResponse

class ApiResponseException(response: ApiResponse<*>) : Exception("Data is null but required for a success $response")
Comment thread
benjaminVadon marked this conversation as resolved.
39 changes: 39 additions & 0 deletions Network/src/main/kotlin/com/infomaniak/core/network/utils/apiResponse/ApiResponseExt.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
/*
* Infomaniak Core - Android
* Copyright (C) 2026 Infomaniak Network SA
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package com.infomaniak.core.network.utils.apiResponse
Comment thread
benjaminVadon marked this conversation as resolved.

import com.infomaniak.core.network.models.ApiError
import com.infomaniak.core.network.models.ApiResponse
import io.sentry.Sentry

inline fun <T : Any> ApiResponse<T>.onSuccess(block: T.() -> Unit): ApiResponse<T> = apply {
if (isSuccess()) {
data?.run(block) ?: Sentry.captureException(ApiResponseException(this))
}
}

inline fun <T : Any> ApiResponse<T>.onError(block: ApiError.() -> Unit): ApiResponse<T> = apply {
if (isError()) {
error?.run(block) ?: Sentry.captureException(ApiErrorException(this))
}
}

inline fun <T : Any> ApiResponse<T>.on(

@LouisCAD LouisCAD May 28, 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.

Will we really need this function?

I feel like its usages would not look idiomatic, and a bit redundant with repetition of the word on:

someResponse.on(
    onSuccess = { whatever() },
    onFailure = { somethingElse() }

I think onSuccess and onError are good enough for our use cases.

onSuccess: T.() -> Unit,
onError: ApiError.() -> Unit
): ApiResponse<T> = onSuccess(onSuccess).onError(onError)
Loading