fix infinite loops where put/delete methods return no content

Author: adamint

src/commonMain/kotlin/com.adamratzman.spotify/http/Endpoints.kt

@@ -84,19 +84,19 @@ public abstract class SpotifyEndpoint(public val api: GenericSpotifyApi) {
     }
 
     internal open suspend fun post(url: String, body: String? = null, contentType: String? = null): String {
-        return execute(url, body, HttpRequestMethod.POST, contentType = contentType)
+        return execute(url, body, HttpRequestMethod.POST, contentType = contentType, retryOnNull = false)
     }
 
     internal open suspend fun put(url: String, body: String? = null, contentType: String? = null): String {
-        return execute(url, body, HttpRequestMethod.PUT, contentType = contentType)
+        return execute(url, body, HttpRequestMethod.PUT, contentType = contentType, retryOnNull = false)
     }
 
     internal suspend fun delete(
         url: String,
         body: String? = null,
         contentType: String? = null
     ): String {
-        return execute(url, body, HttpRequestMethod.DELETE, contentType = contentType)
+        return execute(url, body, HttpRequestMethod.DELETE, contentType = contentType, retryOnNull = false)
     }
 
     @Suppress("UNCHECKED_CAST")
@@ -134,7 +134,7 @@ public abstract class SpotifyEndpoint(public val api: GenericSpotifyApi) {
 
                     handleResponse(document, cacheState, spotifyRequest, retry202) ?: run {
                         if (retryOnNull) {
-                            execute<ReturnType>(url, body, method, false, contentType)
+                            execute<ReturnType>(url, body, method, false, contentType, retryOnNull)
                         } else {
                             null
                         }
@@ -149,7 +149,8 @@ public abstract class SpotifyEndpoint(public val api: GenericSpotifyApi) {
                             method,
                             retry202,
                             contentType,
-                            true
+                            true,
+                            retryOnNull
                         )
                     } else throw e
                 }

src/commonMain/kotlin/com.adamratzman.spotify/http/HttpRequest.kt

@@ -105,6 +105,7 @@ public class HttpRequest constructor(
                 val respCode = response.status.value
 
                 if (respCode in 500..599 && (retryIfInternalServerErrorLeft == null || retryIfInternalServerErrorLeft == -1 || retryIfInternalServerErrorLeft > 0)) {
+                    if (api?.spotifyApiOptions?.enableDebugMode == true) Console.debug("Received internal server error ${respCode}, attempting to retry (${retryIfInternalServerErrorLeft} tries left)")
                     return@let execute(
                         additionalHeaders,
                         retryIfInternalServerErrorLeft =
@@ -115,6 +116,7 @@ public class HttpRequest constructor(
                 // otherwise, if it's 5xx and retryIfInternalServerErrorLeft == 0 we just continue and fail
 
                 if (respCode == 429) {
+                    if (api?.spotifyApiOptions?.enableDebugMode == true) Console.debug("Received 429, attempting to retry")
                     val ratelimit = response.headers["Retry-After"]!!.toLong() + 1L
                     if (api?.spotifyApiOptions?.retryWhenRateLimited == true) {
                         delay(ratelimit * 1000)
@@ -140,7 +142,7 @@ public class HttpRequest constructor(
                     )
                 }
 
-                val response = HttpResponse(
+                val httpResponseToReturn = HttpResponse(
                     responseCode = respCode,
                     body = body,
                     headers = response.headers.entries().map { (key, value) ->
@@ -153,11 +155,11 @@ public class HttpRequest constructor(
 
                 api?.spotifyApiOptions?.httpResponseSubscriber?.let { subscriber ->
                     launch(currentCoroutineContext()) {
-                        subscriber(this, response)
+                        subscriber(this, httpResponseToReturn)
                     }
                 }
 
-                return response
+                return httpResponseToReturn
             }
         } catch (e: CancellationException) {
             throw e

src/commonTest/kotlin/com.adamratzman/spotify/priv/ClientPlayerApiTest.kt

@@ -86,7 +86,7 @@ class ClientPlayerApiTest : AbstractTest<SpotifyClientApi>() {
 
         val device = api.player.getDevices().first()
 
-        val trackId = "7lPN2DXiMsVn7XUKtOW1CS"
+        val trackId = "1VsVY1ySdH3nVSWnLT5vCf"
         api.player.startPlayback(
             playableUrisToPlay = listOf(PlayableUri("spotify:track:$trackId")),
             deviceId = device.id
@@ -117,7 +117,7 @@ class ClientPlayerApiTest : AbstractTest<SpotifyClientApi>() {
         val device = api.player.getDevices().first()
         val playlist = api.playlists.getPlaylist("098OivbzwUNzzDShgF6U4A")!!
         api.player.startPlayback(playlistId = playlist.id) // two tracks
-        val trackId = "7lPN2DXiMsVn7XUKtOW1CS"
+        val trackId = "1VsVY1ySdH3nVSWnLT5vCf"
         api.player.addItemToEndOfQueue(trackId.toTrackUri(), device.id)
         delay(1000)
         api.player.skipForward() // skip first
@@ -139,7 +139,7 @@ class ClientPlayerApiTest : AbstractTest<SpotifyClientApi>() {
 
         val device = api.player.getDevices().first()
 
-        val trackId = "7lPN2DXiMsVn7XUKtOW1CS"
+        val trackId = "1VsVY1ySdH3nVSWnLT5vCf"
         val track = api.tracks.getTrack(trackId)!!
         api.player.startPlayback(
             playableUrisToPlay = listOf(PlayableUri("spotify:track:$trackId")),
@@ -226,7 +226,7 @@ class ClientPlayerApiTest : AbstractTest<SpotifyClientApi>() {
         api.player.startPlayback(
             playableUrisToPlay = trackUris
         )
-        delay(1000)
+        delay(2500)
         assertEquals(trackUris.first().id, api.player.getCurrentlyPlaying()?.item?.id)
         api.player.skipForward()
         delay(1000)
@@ -301,7 +301,7 @@ class ClientPlayerApiTest : AbstractTest<SpotifyClientApi>() {
         val toDevice = devices[1]
 
         api.player.startPlayback(
-            playableUrisToPlay = listOf(PlayableUri("spotify:track:7lPN2DXiMsVn7XUKtOW1CS")),
+            playableUrisToPlay = listOf(PlayableUri("spotify:track:1VsVY1ySdH3nVSWnLT5vCf")),
             deviceId = fromDevice.id
         )
         delay(1000)

src/jvmTest/kotlin/com/adamratzman/spotify/CommonImpl.kt

@@ -19,10 +19,11 @@ actual suspend fun buildSpotifyApi(): GenericSpotifyApi? {
 
     val optionsCreator: (SpotifyApiOptions.() -> Unit) = {
         this.enableDebugMode = logHttp
+        this.enableLogger = true
         this.httpResponseSubscriber = { request, response ->
-            println("=== request ${requestNumber} ===")
+            /*println("=== request ${requestNumber} ===")
             println(request)
-            println(response)
+            println(response)*/
             requestNumber++
         }
     }