Skip to content
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

Jump to bottom

chore: add more debug information for sync #WPB-11603 #3066

Open
wants to merge 3 commits into
base: release/candidate
Choose a base branch
from
Open

chore: add more debug information for sync #WPB-11603 #3066

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
927ac72
chore: add more debug information for sync #WPB-11603
damian-kaczmarek Oct 17, 2024
19d821e
Merge branch 'refs/heads/release/candidate' into chore/debug-informat…
damian-kaczmarek Oct 17, 2024
1531aa6
use logStructuredJson
damian-kaczmarek Oct 18, 2024
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
55 changes: 45 additions & 10 deletions logic/src/androidMain/kotlin/com/wire/kalium/logic/network/NetworkStateObserverImpl.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import android.content.Context
import android.net.ConnectivityManager
import android.net.Network
import android.net.NetworkCapabilities
import android.os.Build
import com.wire.kalium.logic.kaliumLogger
import com.wire.kalium.network.NetworkState
import com.wire.kalium.network.NetworkStateObserver
Expand Down Expand Up @@ -56,7 +57,8 @@ internal actual class NetworkStateObserverImpl(

init {
val initialDefaultNetworkData = connectivityManager.activeNetwork?.let {
val defaultNetworkCapabilities = connectivityManager.getNetworkCapabilities(connectivityManager.activeNetwork)
val defaultNetworkCapabilities =
connectivityManager.getNetworkCapabilities(connectivityManager.activeNetwork)
DefaultNetworkData.Connected(it, defaultNetworkCapabilities)
} ?: DefaultNetworkData.NotConnected
defaultNetworkDataStateFlow = MutableStateFlow(initialDefaultNetworkData)
Expand All @@ -76,14 +78,46 @@ internal actual class NetworkStateObserverImpl(

val callback = object : ConnectivityManager.NetworkCallback() {

override fun onCapabilitiesChanged(network: Network, networkCapabilities: NetworkCapabilities) {
override fun onCapabilitiesChanged(
network: Network,
networkCapabilities: NetworkCapabilities
) {
super.onCapabilitiesChanged(network, networkCapabilities)
kaliumLogger.i(
"${NetworkStateObserver.TAG} capabilities changed " +
"internet:${networkCapabilities.hasCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET)} " +
"validated:${networkCapabilities.hasCapability(NetworkCapabilities.NET_CAPABILITY_VALIDATED)}"
)
defaultNetworkDataStateFlow.update { DefaultNetworkData.Connected(network, networkCapabilities) }
val loggerMessage = buildString {
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion: We can try to log in json format, so we can later parse it and do some filtering in Datadog

You can take a look at this utility:

kalium/logic/src/commonMain/kotlin/com/wire/kalium/logic/CoreLogger.kt

Line 63 in a2f0ead

internal fun KaliumLogger.logStructuredJson(

Copy link
Contributor Author

@damian-kaczmarek damian-kaczmarek Oct 18, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

thanks, added. Good to know we have such method

append("${NetworkStateObserver.TAG} capabilities changed ")
append("internet:${networkCapabilities.hasCapability(NetworkCapabilities.NET_CAPABILITY_INTERNET)} ")
append("validated:${networkCapabilities.hasCapability(NetworkCapabilities.NET_CAPABILITY_VALIDATED)} ")
append("not restricted:${networkCapabilities.hasCapability(NetworkCapabilities.NET_CAPABILITY_NOT_RESTRICTED)} ")

if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) {
append("foreground:${networkCapabilities.hasCapability(NetworkCapabilities.NET_CAPABILITY_FOREGROUND)} ")
append(
"not congested:${
networkCapabilities.hasCapability(
NetworkCapabilities.NET_CAPABILITY_NOT_CONGESTED
)
} "
)
append(
"not suspended:${
networkCapabilities.hasCapability(
NetworkCapabilities.NET_CAPABILITY_NOT_SUSPENDED
)
} "
)
}

if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
append("signalStrength:${networkCapabilities.signalStrength}")
}
}
kaliumLogger.i(loggerMessage)
defaultNetworkDataStateFlow.update {
DefaultNetworkData.Connected(
network,
networkCapabilities
)
}
}

override fun onLost(network: Network) {
Expand Down Expand Up @@ -112,8 +146,7 @@ internal actual class NetworkStateObserverImpl(
override fun onBlockedStatusChanged(network: Network, blocked: Boolean) {
kaliumLogger.i("${NetworkStateObserver.TAG} block connection changed to $blocked")
defaultNetworkDataStateFlow.update {
kaliumLogger.d("${NetworkStateObserver.TAG} block connection changed to $blocked current state is $it")
when (it) {
val updatedValue = when (it) {
is DefaultNetworkData.Connected -> {
it.copy(isBlocked = blocked)
}
Expand All @@ -123,6 +156,8 @@ internal actual class NetworkStateObserverImpl(
else DefaultNetworkData.Connected(network)
}
}
kaliumLogger.d("${NetworkStateObserver.TAG} default network state $it changed to $updatedValue")
updatedValue
}
super.onBlockedStatusChanged(network, blocked)
}
Expand Down
2 changes: 1 addition & 1 deletion network-util/src/commonMain/kotlin/com/wire/kalium/network/NetworkStateObserver.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ interface NetworkStateObserver {
// Delay which will be completed earlier if there is a reconnection in the meantime.
suspend fun delayUntilConnectedWithInternetAgain(delay: Duration) {
// Delay for given amount but break it if reconnected again.
kaliumUtilLogger.i("$TAG delayUntilConnectedWithInternetAgain")
kaliumUtilLogger.i("$TAG delayUntilConnectedWithInternetAgain for $delay")
withTimeoutOrNull(delay) {
// Drop the current value, so it will complete only if the connection changed again to connected during that time.
observeNetworkState()
Expand Down
Loading