Merge pull request #3 from FeernandoOFF/main

Added :: Networking Module & Updated Docs

Author: FeernandoOFF

LOGS_DEMO.gif

@@ -362,6 +362,80 @@ Fragment/Activity:
 
 </details>
 
+<details>
+<summary>Network Module</summary>
+The network module allows you to monitor network requests in the debug menu as well as copying the request body to the
+clipboard or multiple requests at once.
+
+**Adding the module**
+
+```kotlin
+DebugMenuAttacher.attach(
+    this,
+    modules = listOf(
+        NetworkModule()
+        // Rest of your modules...
+    ),
+)
+// or
+DebugMenuOverlay(
+    modules = listOf(
+        NetworkModule()
+        // Rest of your modules...
+    )
+)
+```
+
+**Intercepting Network Requests**
+> Note: This library does not include out-of-the-box integration with OkHttp or any other networking library. Instead,
+> you need to intercept the requests yourself and add them to the `DebugNetworkRequests` singleton.
+
+
+- OKHttp Interceptor (Example):
+```kotlin
+object DebugMenuInterceptor : Interceptor {
+    override fun intercept(chain: Interceptor.Chain): Response {
+        val request = chain.request()
+        val startTime = System.currentTimeMillis()
+        val response = chain.proceed(request)
+        val duration = System.currentTimeMillis() - startTime
+        var responseBodyString: String? = null
+        response.body?.let { responseBody ->
+            val source = responseBody.source()
+            source.request(Long.MAX_VALUE)
+            val buffer = source.buffer
+            responseBodyString = buffer.clone().readString(responseBody.contentType()?.charset() ?: Charsets.UTF_8)
+        }
+
+        val debugRequest = DebugNetworkRequest(
+            url = request.url.toString(),
+            method = request.method,
+            headers = request.headers.toMap(),
+            responseHeaders = response.headers.toMap(),
+            body = request.body?.toString() ?: "",
+            timestamp = startTime,
+            duration = duration,
+            isSuccessful = response.isSuccessful,
+            code = response.code,
+            error = if (!response.isSuccessful) response.message else null,
+            response = responseBodyString,
+            requestSize = request.body?.contentLength() ?: 0
+        )
+
+        DebugNetworkRequests.add(debugRequest)
+        return response
+    }
+}
+
+// Add the interceptor to your OkHttp client
+
+val okHttpClient = OkHttpClient.Builder()
+    .addInterceptor(DebugMenuInterceptor)
+    .build()
+```
+
+</details>
+
 ### Creating your own Module
 
 You can create custom modules to display any debugging information specific to your app. For example, a network request

NETWORK_DEMO.gif

@@ -26,7 +26,11 @@ import com.tapadoo.debugmenu.dynamic.DynamicAction
 import com.tapadoo.debugmenu.dynamic.DynamicModule
 import com.tapadoo.debugmenu.logs.DebugLogs
 import com.tapadoo.debugmenu.logs.LoggingModule
+import com.tapadoo.debugmenu.network.DebugNetworkEvents
+import com.tapadoo.debugmenu.network.DebugNetworkRequest
+import com.tapadoo.debugmenu.network.NetworkModule
 import timber.log.Timber
+import kotlin.random.Random
 
 class MainActivity : ComponentActivity() {
     private lateinit var viewModel: DemoViewModel
@@ -84,6 +88,12 @@ class MainActivity : ComponentActivity() {
                                 globalActions = listOf(
                                     DynamicAction("Global Action 1") {
                                           // Perform global action
+                                    },
+                                    DynamicAction("Add API Call") {
+                                        // Mocking API call / Intercept
+                                        DebugNetworkEvents.addEvent(
+                                            DebugNetworkRequest.random()
+                                        )
                                     }
                                 )
                             ),
@@ -94,10 +104,36 @@ class MainActivity : ComponentActivity() {
                                     this@MainActivity.applicationContext.demoDataStore
                                 )
                             ),
+                            NetworkModule()
                         ),
                     )
                 }
             }
         }
     }
-}
+}
+
+private fun DebugNetworkRequest.Companion.random(): DebugNetworkRequest {
+    val methods = listOf("GET", "POST", "PUT", "DELETE")
+    val urls = listOf(
+        "https://api.example.com/users",
+        "https://api.example.com/products",
+        "https://api.example.com/orders"
+    )
+    val successful = Random.nextBoolean()
+
+    return DebugNetworkRequest(
+        url = urls.random(),
+        method = methods.random(),
+        headers = mapOf("Content-Type" to "application/json"),
+        responseHeaders = mapOf("Content-Type" to "application/json"),
+        body = """{"id": ${Random.nextInt(1000)}}""",
+        timestamp = System.currentTimeMillis(),
+        durationMs = Random.nextLong(100, 2000),
+        isSuccessful = successful,
+        code = if (successful) 200 else 400,
+        error = if (!successful) "Bad Request" else null,
+        response = if (successful) """{"status": "success"}""" else null,
+        requestSize = Random.nextLong(100, 5000)
+    )
+}

README.md

@@ -60,6 +60,10 @@ fun DebugMenuOverlay(
 
 
     var showContent by remember { mutableStateOf(false) }
+    val scope = rememberCoroutineScope()
+    var selected by remember { mutableStateOf<DebugMenuModule>(modules.first()) }
+    val selectedIndex by remember { derivedStateOf { modules.indexOf(selected) } }
+
 
     // Shake detector
     if (enableShake) {
@@ -91,9 +95,6 @@ fun DebugMenuOverlay(
             }
         }
         if (showContent) {
-            val scope = rememberCoroutineScope()
-            var selected by remember { mutableStateOf<DebugMenuModule>(modules.first()) }
-            val selectedIndex by remember { derivedStateOf { modules.indexOf(selected) } }
 
             ModalBottomSheet(
                 onDismissRequest = {

app/src/main/java/com/tapado/debugmenuDemo/MainActivity.kt

@@ -4,7 +4,7 @@ import androidx.compose.runtime.Composable
 import com.tapadoo.debugmenu.module.DebugMenuModule
 import com.tapadoo.debugmenu.ui.AnalyticsScreen
 
-class AnalyticsModule : DebugMenuModule{
+class AnalyticsModule : DebugMenuModule {
 
     override val title = "Analytics"
 

debugMenu/src/main/java/com/tapadoo/debugmenu/DebugMenu.kt

@@ -0,0 +1,29 @@
+package com.tapadoo.debugmenu.network
+
+import androidx.compose.runtime.mutableStateListOf
+import androidx.compose.runtime.snapshots.SnapshotStateList
+
+
+data class DebugNetworkRequest(
+    val url: String,
+    val method: String,
+    val headers: Map<String, String>,
+    val responseHeaders: Map<String, String>,
+    val body: String,
+    val timestamp: Long,
+    val durationMs: Long,
+    val isSuccessful: Boolean,
+    val code: Int,
+    val error: String? = null,
+    val response: String? = null,
+    val requestSize: Long = 0,
+) {
+    companion object
+}
+
+
+object DebugNetworkEvents {
+    val events: SnapshotStateList<DebugNetworkRequest> = mutableStateListOf()
+
+    fun addEvent(event: DebugNetworkRequest) = events.add(event)
+}

debugMenu/src/main/java/com/tapadoo/debugmenu/analytics/AnalyticsModule.kt

@@ -0,0 +1,37 @@
+package com.tapadoo.debugmenu.network
+
+import androidx.activity.compose.BackHandler
+import androidx.compose.foundation.ExperimentalFoundationApi
+import androidx.compose.foundation.background
+import androidx.compose.foundation.layout.Arrangement
+import androidx.compose.foundation.layout.Box
+import androidx.compose.foundation.layout.Row
+import androidx.compose.foundation.layout.fillMaxSize
+import androidx.compose.foundation.layout.fillMaxWidth
+import androidx.compose.foundation.layout.padding
+import androidx.compose.foundation.lazy.LazyColumn
+import androidx.compose.foundation.lazy.items
+import androidx.compose.material.icons.Icons
+import androidx.compose.material.icons.outlined.Delete
+import androidx.compose.material3.Icon
+import androidx.compose.material3.IconButton
+import androidx.compose.material3.MaterialTheme
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.getValue
+import androidx.compose.runtime.mutableStateOf
+import androidx.compose.runtime.remember
+import androidx.compose.runtime.setValue
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.unit.dp
+import com.tapadoo.debugmenu.module.DebugMenuModule
+
+
+class NetworkModule : DebugMenuModule {
+    override val title: String = "Network"
+
+    @OptIn(ExperimentalFoundationApi::class)
+    @Composable
+    override fun Content() {
+        NetworkScreen()
+    }
+}