fix(logging): add additional logs to identify issues

vexdev · vexdev · commit ecf86b4b15e3 · 2023-11-03T18:34:31.000+01:00
diff --git a/src/main/kotlin/jamule/AmuleClient.kt b/src/main/kotlin/jamule/AmuleClient.kt
@@ -34,7 +34,7 @@ class AmuleClient(
         logger.info("Getting stats...")
         return when (val response = amuleConnection.sendRequest(StatsRequest())) {
             is StatsResponse -> Result.success(response).also { logger.info("Stats: $response") }
-            else -> Result.failure(CommunicationException("Unable to get stats"))
+            else -> Result.failure(CommunicationException("Unable to get stats, got response: $response"))
         }
     }
 
@@ -50,7 +50,7 @@ class AmuleClient(
         return when (val response = amuleConnection.sendRequest(SearchRequest(query, searchType, filters))) {
             is StringsResponse -> Result.success(response.string).also { logger.info("Search started") }
             is ErrorResponse -> Result.failure(response)
-            else -> Result.failure(CommunicationException("Unable to start search"))
+            else -> Result.failure(CommunicationException("Unable to start search, got response: $response"))
         }
     }
 
@@ -63,7 +63,7 @@ class AmuleClient(
             is SearchStatusResponse -> Result.success(response.status)
                 .also { logger.info("Search status: ${response.status}") }
 
-            else -> Result.failure(CommunicationException("Unable to get search status"))
+            else -> Result.failure(CommunicationException("Unable to get search status, got response: $response"))
         }
     }
 
@@ -76,7 +76,7 @@ class AmuleClient(
             is SearchResultsResponse -> Result.success(response)
                 .also { logger.info("Found ${response.files} results") }
 
-            else -> Result.failure(CommunicationException("Unable to get search results"))
+            else -> Result.failure(CommunicationException("Unable to get search results, got response: $response"))
         }
     }
 
@@ -112,9 +112,9 @@ class AmuleClient(
      */
     fun searchStop(): Result<Unit> {
         logger.info("Stopping search...")
-        return when (amuleConnection.sendRequest(SearchStopRequest())) {
+        return when (val response = amuleConnection.sendRequest(SearchStopRequest())) {
             is MiscDataResponse -> Result.success(Unit).also { logger.info("Search stopped") }
-            else -> Result.failure(CommunicationException("Unable to stop search"))
+            else -> Result.failure(CommunicationException("Unable to stop search, got response: $response"))
         }
     }
 
@@ -123,9 +123,9 @@ class AmuleClient(
      */
     fun downloadSearchResult(hash: ByteArray): Result<Unit> {
         logger.info("Downloading search result...")
-        return when (amuleConnection.sendRequest(DownloadSearchResultRequest(hash))) {
+        return when (val response = amuleConnection.sendRequest(DownloadSearchResultRequest(hash))) {
             is StringsResponse -> Result.success(Unit).also { logger.info("Search result downloaded") }
-            else -> Result.failure(CommunicationException("Unable to download search result"))
+            else -> Result.failure(CommunicationException("Unable to download search result, got response: $response"))
         }
     }
 
@@ -138,7 +138,7 @@ class AmuleClient(
         return when (val response = amuleConnection.sendRequest(AddLinkRequest(link))) {
             is NoopResponse -> Result.success(Unit).also { logger.info("Ed2k link downloaded") }
             is ErrorResponse -> Result.failure(response)
-            else -> Result.failure(CommunicationException("Unable to download ed2k link"))
+            else -> Result.failure(CommunicationException("Unable to download ed2k link, got response: $response"))
         }
     }
 
@@ -149,7 +149,7 @@ class AmuleClient(
         logger.info("Getting download queue...")
         return when (val response = amuleConnection.sendRequest(DownloadQueueRequest())) {
             is DownloadQueueResponse -> Result.success(response.partFiles)
-            else -> Result.failure(CommunicationException("Unable to get download queue"))
+            else -> Result.failure(CommunicationException("Unable to get download queue, got response: $response"))
         }
     }
 
@@ -160,7 +160,7 @@ class AmuleClient(
         logger.info("Getting shared files list...")
         return when (val response = amuleConnection.sendRequest(SharedFilesRequest())) {
             is SharedFilesResponse -> Result.success(response.sharedFiles)
-            else -> Result.failure(CommunicationException("Unable to get shared files list"))
+            else -> Result.failure(CommunicationException("Unable to get shared files list, got response: $response"))
         }
     }
 
@@ -172,7 +172,7 @@ class AmuleClient(
         return when (val response = amuleConnection.sendRequest(CreateCategoryRequest(category))) {
             is NoopResponse -> Result.success(Unit)
             is ErrorResponse -> Result.failure(response)
-            else -> Result.failure(CommunicationException("Unable to create category"))
+            else -> Result.failure(CommunicationException("Unable to create category, got response: $response"))
         }
     }
 
@@ -184,7 +184,7 @@ class AmuleClient(
         return when (val response = amuleConnection.sendRequest(GetPreferencesRequest(EcPrefs.EC_PREFS_CATEGORIES))) {
             is PrefsCategoriesResponse -> Result.success(response.categories)
             is EmptyPreferencesResponse -> Result.success(emptyList())
-            else -> Result.failure(CommunicationException("Unable to get categories"))
+            else -> Result.failure(CommunicationException("Unable to get categories, got response: $response"))
         }
     }
 
@@ -205,7 +205,7 @@ class AmuleClient(
             when (val response = amuleConnection.sendRequest(SetFileCategoryRequest(hash, categoryId))) {
                 is NoopResponse -> Unit
                 is ErrorResponse -> throw response
-                else -> throw CommunicationException("Unable to set file category")
+                else -> throw CommunicationException("Unable to set file category, got response: $response")
             }
         }
     }
@@ -218,7 +218,7 @@ class AmuleClient(
         return when (val response = amuleConnection.sendRequest(DownloadCommandRequest(hash, command))) {
             is NoopResponse -> Result.success(Unit)
             is ErrorResponse -> Result.failure(response)
-            else -> Result.failure(CommunicationException("Unable to send download command"))
+            else -> Result.failure(CommunicationException("Unable to send download command, got response: $response"))
         }
     }
 
diff --git a/src/test/kotlin/jamule/ec/packet/SamplePackets.kt b/src/test/kotlin/jamule/ec/packet/SamplePackets.kt
@@ -90,8 +90,7 @@ internal class SamplePackets {
                 listOf(
                     StringTag(EC_TAG_STRING, "eD2k search can't be done if eD2k is not connected"),
                 )
-            )
-
+            ),
         )
 
         val statusResponse = ("000000220000008c0c10d08003021664d082020100d484020100d4860302" +
diff --git a/src/test/kotlin/jamule/response/SharedFilesResponseTest.kt b/src/test/kotlin/jamule/response/SharedFilesResponseTest.kt

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ class AmuleClient(`
`34`	`34`	`logger.info("Getting stats...")`
`35`	`35`	`return when (val response = amuleConnection.sendRequest(StatsRequest())) {`
`36`	`36`	`is StatsResponse -> Result.success(response).also { logger.info("Stats: $response") }`
`37`		`- else -> Result.failure(CommunicationException("Unable to get stats"))`
	`37`	`+ else -> Result.failure(CommunicationException("Unable to get stats, got response: $response"))`
`38`	`38`	`}`
`39`	`39`	`}`
`40`	`40`
`@@ -50,7 +50,7 @@ class AmuleClient(`
`50`	`50`	`return when (val response = amuleConnection.sendRequest(SearchRequest(query, searchType, filters))) {`
`51`	`51`	`is StringsResponse -> Result.success(response.string).also { logger.info("Search started") }`
`52`	`52`	`is ErrorResponse -> Result.failure(response)`
`53`		`- else -> Result.failure(CommunicationException("Unable to start search"))`
	`53`	`+ else -> Result.failure(CommunicationException("Unable to start search, got response: $response"))`
`54`	`54`	`}`
`55`	`55`	`}`
`56`	`56`
`@@ -63,7 +63,7 @@ class AmuleClient(`
`63`	`63`	`is SearchStatusResponse -> Result.success(response.status)`
`64`	`64`	`.also { logger.info("Search status: ${response.status}") }`
`65`	`65`
`66`		`- else -> Result.failure(CommunicationException("Unable to get search status"))`
	`66`	`+ else -> Result.failure(CommunicationException("Unable to get search status, got response: $response"))`
`67`	`67`	`}`
`68`	`68`	`}`
`69`	`69`
`@@ -76,7 +76,7 @@ class AmuleClient(`
`76`	`76`	`is SearchResultsResponse -> Result.success(response)`
`77`	`77`	`.also { logger.info("Found ${response.files} results") }`
`78`	`78`
`79`		`- else -> Result.failure(CommunicationException("Unable to get search results"))`
	`79`	`+ else -> Result.failure(CommunicationException("Unable to get search results, got response: $response"))`
`80`	`80`	`}`
`81`	`81`	`}`
`82`	`82`
`@@ -112,9 +112,9 @@ class AmuleClient(`
`112`	`112`	`*/`
`113`	`113`	`fun searchStop(): Result<Unit> {`
`114`	`114`	`logger.info("Stopping search...")`
`115`		`- return when (amuleConnection.sendRequest(SearchStopRequest())) {`
	`115`	`+ return when (val response = amuleConnection.sendRequest(SearchStopRequest())) {`
`116`	`116`	`is MiscDataResponse -> Result.success(Unit).also { logger.info("Search stopped") }`
`117`		`- else -> Result.failure(CommunicationException("Unable to stop search"))`
	`117`	`+ else -> Result.failure(CommunicationException("Unable to stop search, got response: $response"))`
`118`	`118`	`}`
`119`	`119`	`}`
`120`	`120`
`@@ -123,9 +123,9 @@ class AmuleClient(`
`123`	`123`	`*/`
`124`	`124`	`fun downloadSearchResult(hash: ByteArray): Result<Unit> {`
`125`	`125`	`logger.info("Downloading search result...")`
`126`		`- return when (amuleConnection.sendRequest(DownloadSearchResultRequest(hash))) {`
	`126`	`+ return when (val response = amuleConnection.sendRequest(DownloadSearchResultRequest(hash))) {`
`127`	`127`	`is StringsResponse -> Result.success(Unit).also { logger.info("Search result downloaded") }`
`128`		`- else -> Result.failure(CommunicationException("Unable to download search result"))`
	`128`	`+ else -> Result.failure(CommunicationException("Unable to download search result, got response: $response"))`
`129`	`129`	`}`
`130`	`130`	`}`
`131`	`131`
`@@ -138,7 +138,7 @@ class AmuleClient(`
`138`	`138`	`return when (val response = amuleConnection.sendRequest(AddLinkRequest(link))) {`
`139`	`139`	`is NoopResponse -> Result.success(Unit).also { logger.info("Ed2k link downloaded") }`
`140`	`140`	`is ErrorResponse -> Result.failure(response)`
`141`		`- else -> Result.failure(CommunicationException("Unable to download ed2k link"))`
	`141`	`+ else -> Result.failure(CommunicationException("Unable to download ed2k link, got response: $response"))`
`142`	`142`	`}`
`143`	`143`	`}`
`144`	`144`
`@@ -149,7 +149,7 @@ class AmuleClient(`
`149`	`149`	`logger.info("Getting download queue...")`
`150`	`150`	`return when (val response = amuleConnection.sendRequest(DownloadQueueRequest())) {`
`151`	`151`	`is DownloadQueueResponse -> Result.success(response.partFiles)`
`152`		`- else -> Result.failure(CommunicationException("Unable to get download queue"))`
	`152`	`+ else -> Result.failure(CommunicationException("Unable to get download queue, got response: $response"))`
`153`	`153`	`}`
`154`	`154`	`}`
`155`	`155`
`@@ -160,7 +160,7 @@ class AmuleClient(`
`160`	`160`	`logger.info("Getting shared files list...")`
`161`	`161`	`return when (val response = amuleConnection.sendRequest(SharedFilesRequest())) {`
`162`	`162`	`is SharedFilesResponse -> Result.success(response.sharedFiles)`
`163`		`- else -> Result.failure(CommunicationException("Unable to get shared files list"))`
	`163`	`+ else -> Result.failure(CommunicationException("Unable to get shared files list, got response: $response"))`
`164`	`164`	`}`
`165`	`165`	`}`
`166`	`166`
`@@ -172,7 +172,7 @@ class AmuleClient(`
`172`	`172`	`return when (val response = amuleConnection.sendRequest(CreateCategoryRequest(category))) {`
`173`	`173`	`is NoopResponse -> Result.success(Unit)`
`174`	`174`	`is ErrorResponse -> Result.failure(response)`
`175`		`- else -> Result.failure(CommunicationException("Unable to create category"))`
	`175`	`+ else -> Result.failure(CommunicationException("Unable to create category, got response: $response"))`
`176`	`176`	`}`
`177`	`177`	`}`
`178`	`178`
`@@ -184,7 +184,7 @@ class AmuleClient(`
`184`	`184`	`return when (val response = amuleConnection.sendRequest(GetPreferencesRequest(EcPrefs.EC_PREFS_CATEGORIES))) {`
`185`	`185`	`is PrefsCategoriesResponse -> Result.success(response.categories)`
`186`	`186`	`is EmptyPreferencesResponse -> Result.success(emptyList())`
`187`		`- else -> Result.failure(CommunicationException("Unable to get categories"))`
	`187`	`+ else -> Result.failure(CommunicationException("Unable to get categories, got response: $response"))`
`188`	`188`	`}`
`189`	`189`	`}`
`190`	`190`
`@@ -205,7 +205,7 @@ class AmuleClient(`
`205`	`205`	`when (val response = amuleConnection.sendRequest(SetFileCategoryRequest(hash, categoryId))) {`
`206`	`206`	`is NoopResponse -> Unit`
`207`	`207`	`is ErrorResponse -> throw response`
`208`		`- else -> throw CommunicationException("Unable to set file category")`
	`208`	`+ else -> throw CommunicationException("Unable to set file category, got response: $response")`
`209`	`209`	`}`
`210`	`210`	`}`
`211`	`211`	`}`
`@@ -218,7 +218,7 @@ class AmuleClient(`
`218`	`218`	`return when (val response = amuleConnection.sendRequest(DownloadCommandRequest(hash, command))) {`
`219`	`219`	`is NoopResponse -> Result.success(Unit)`
`220`	`220`	`is ErrorResponse -> Result.failure(response)`
`221`		`- else -> Result.failure(CommunicationException("Unable to send download command"))`
	`221`	`+ else -> Result.failure(CommunicationException("Unable to send download command, got response: $response"))`
`222`	`222`	`}`
`223`	`223`	`}`
`224`	`224`
Original file line number	Diff line number	Diff line change
`@@ -90,8 +90,7 @@ internal class SamplePackets {`
`90`	`90`	`listOf(`
`91`	`91`	`StringTag(EC_TAG_STRING, "eD2k search can't be done if eD2k is not connected"),`
`92`	`92`	`)`
`93`		`- )`
`94`		`-`
	`93`	`+ ),`
`95`	`94`	`)`
`96`	`95`
`97`	`96`	`val statusResponse = ("000000220000008c0c10d08003021664d082020100d484020100d4860302" +`