Use modern enum entries call vs values(), update test settings, coerce input values for total

Author: adamint

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

@@ -38,6 +38,7 @@ private suspend fun buildSpotifyApiInternal(): GenericSpotifyApi? {
 
     val optionsCreator: (SpotifyApiOptions.() -> Unit) = {
         this.enableDebugMode = logHttp
+        retryOnInternalServerErrorTimes = 0
     }
 
     return when {

src/commonMain/kotlin/com.adamratzman.spotify/endpoints/pub/EpisodeApi.kt

@@ -3,6 +3,7 @@ package com.adamratzman.spotify.endpoints.pub
 
 import com.adamratzman.spotify.GenericSpotifyApi
 import com.adamratzman.spotify.SpotifyAppApi
+import com.adamratzman.spotify.SpotifyClientApi
 import com.adamratzman.spotify.SpotifyException.BadRequestException
 import com.adamratzman.spotify.SpotifyScope
 import com.adamratzman.spotify.http.SpotifyEndpoint
@@ -60,7 +61,7 @@ public open class EpisodeApi(api: GenericSpotifyApi) : SpotifyEndpoint(api) {
      * Users can view the country that is associated with their account in the account settings. Required for [SpotifyAppApi], but **you may use [Market.FROM_TOKEN] to get the user market**
      *
      * @return List of possibly-null [Episode] objects.
-     * @throws BadRequestException If any invalid show id is provided
+     * @throws BadRequestException If any invalid show id is provided, if this is a [SpotifyClientApi]
      */
     public suspend fun getEpisodes(vararg ids: String, market: Market): List<Episode?> {
         checkBulkRequesting(50, ids.size)

src/commonMain/kotlin/com.adamratzman.spotify/endpoints/pub/SearchApi.kt

@@ -338,7 +338,7 @@ public open class SearchApi(api: GenericSpotifyApi) : SpotifyEndpoint(api) {
         market: Market,
         language: Language? = null
     ): SpotifySearchResult =
-        search(query, filters = filters, searchTypes = SearchType.values(), limit = limit, offset = offset, market = market)
+        search(query, filters = filters, searchTypes = SearchType.entries.toTypedArray(), limit = limit, offset = offset, market = market, language = language)
 
     protected fun build(
         query: String,

src/commonMain/kotlin/com.adamratzman.spotify/models/Albums.kt

@@ -54,14 +54,14 @@ public data class SimpleAlbum(
 
     val albumType: AlbumResultType
         get() = albumTypeString.let { _ ->
-            AlbumResultType.values().first { it.id.equals(albumTypeString, true) }
+            AlbumResultType.entries.first { it.id.equals(albumTypeString, true) }
         }
 
     val releaseDate: ReleaseDate? get() = releaseDateString?.let { getReleaseDate(releaseDateString) }
 
     val albumGroup: AlbumResultType?
         get() = albumGroupString?.let { _ ->
-            AlbumResultType.values().find { it.id == albumGroupString }
+            AlbumResultType.entries.find { it.id == albumGroupString }
         }
 
     /**
@@ -157,7 +157,7 @@ public data class Album(
 
     val externalIds: List<ExternalId> get() = externalIdsString.map { ExternalId(it.key, it.value) }
 
-    val albumType: AlbumResultType get() = AlbumResultType.values().first { it.id == albumTypeString }
+    val albumType: AlbumResultType get() = AlbumResultType.entries.first { it.id == albumTypeString }
 
     val releaseDate: ReleaseDate get() = getReleaseDate(releaseDateString)
 
@@ -181,7 +181,7 @@ public data class SpotifyCopyright(
             .removePrefix("(C)")
             .trim()
 
-    val type: CopyrightType get() = CopyrightType.values().match(typeString)!!
+    val type: CopyrightType get() = CopyrightType.entries.toTypedArray().match(typeString)!!
 }
 
 @Serializable

src/commonMain/kotlin/com.adamratzman.spotify/models/Authentication.kt

@@ -33,7 +33,7 @@ public data class Token(
     val expiresAt: Long get() = getCurrentTimeMs() + expiresIn * 1000
 
     val scopes: List<SpotifyScope>? get() = scopeString?.let { str ->
-        str.split(" ").mapNotNull { scope -> SpotifyScope.values().find { it.uri.equals(scope, true) } }
+        str.split(" ").mapNotNull { scope -> SpotifyScope.entries.find { it.uri.equals(scope, true) } }
     }
 
     public fun shouldRefresh(): Boolean = getCurrentTimeMs() > expiresAt

src/commonMain/kotlin/com.adamratzman.spotify/models/Player.kt

@@ -24,7 +24,7 @@ public data class SpotifyContext(
     val uri: ContextUri,
     @SerialName("type") val typeString: String
 ) {
-    val type: SpotifyContextType get() = SpotifyContextType.values().match(typeString)!!
+    val type: SpotifyContextType get() = SpotifyContextType.entries.toTypedArray().match(typeString)!!
     val externalUrls: List<ExternalUrl> get() = getExternalUrls(externalUrlsString)
 }
 
@@ -64,7 +64,7 @@ public data class Device(
     @SerialName("type") val typeString: String,
     @SerialName("volume_percent") val volumePercent: Int
 ) : IdentifiableNullable() {
-    val type: DeviceType get() = DeviceType.values().first { it.identifier.equals(typeString, true) }
+    val type: DeviceType get() = DeviceType.entries.first { it.identifier.equals(typeString, true) }
 
     override val href: String? = null
 }
@@ -118,7 +118,7 @@ public data class CurrentlyPlayingContext(
     val context: SpotifyContext? = null
 ) {
     val repeatState: ClientPlayerApi.PlayerRepeatState
-        get() = ClientPlayerApi.PlayerRepeatState.values().match(repeatStateString)!!
+        get() = ClientPlayerApi.PlayerRepeatState.entries.toTypedArray().match(repeatStateString)!!
 }
 
 /**
@@ -146,7 +146,7 @@ public data class CurrentlyPlayingObject(
     val actions: PlaybackActions
 ) {
     val currentlyPlayingType: CurrentlyPlayingType
-        get() = CurrentlyPlayingType.values().match(currentlyPlayingTypeString)!!
+        get() = CurrentlyPlayingType.entries.toTypedArray().match(currentlyPlayingTypeString)!!
 }
 
 /**
@@ -162,7 +162,7 @@ public data class PlaybackActions(
     val disallows: List<DisallowablePlaybackAction>
         get() = disallowsString.map {
             DisallowablePlaybackAction(
-                PlaybackAction.values().match(it.key)!!,
+                PlaybackAction.entries.toTypedArray().match(it.key)!!,
                 it.value ?: false
             )
         }

src/commonMain/kotlin/com.adamratzman.spotify/models/Playlist.kt

@@ -150,7 +150,7 @@ public data class Playlist(
 @Serializable
 public data class PlaylistTrackInfo(
     val href: String,
-    val total: Int
+    val total: Int? = null
 )
 
 @Serializable

src/commonMain/kotlin/com.adamratzman.spotify/models/serialization/SerializationUtils.kt

@@ -23,6 +23,7 @@ internal val nonstrictJson =
         ignoreUnknownKeys = true
         allowSpecialFloatingPointValues = true
         useArrayPolymorphism = true
+        coerceInputValues = true
     }
 
 // Parse function that catches on parse exception

src/commonMain/kotlin/com.adamratzman.spotify/utils/Locale.kt

@@ -806,7 +806,7 @@ public enum class Locale(public val language: Language, public val country: Mark
 
     public companion object {
         public fun from(language: Language, country: Market): Locale? {
-            return values().find { locale -> locale.language == language && locale.country == country }
+            return entries.find { locale -> locale.language == language && locale.country == country }
         }
     }
 }

src/commonMain/kotlin/com.adamratzman.spotify/utils/Utils.kt

@@ -21,7 +21,9 @@ internal suspend inline fun <T> catch(catchInternalServerError: Boolean = false,
     return try {
         function()
     } catch (e: SpotifyException.BadRequestException) {
-        if (e.statusCode !in listOf(400, 404) && (e.statusCode !in 500..599) || catchInternalServerError) throw e
+        if (e.statusCode !in listOf(400, 404)) throw e
+        else if (e.statusCode in 500..599 && catchInternalServerError) throw e
+        
         // we should only ignore the exception if it's 400 or 404. Otherwise, it's a larger issue
         null
     }

src/commonTest/kotlin/com.adamratzman/spotify/AbstractTest.kt

@@ -37,7 +37,7 @@ abstract class AbstractTest<T : GenericSpotifyApi> {
         return if (apiInitialized) {
             true
         } else {
-            println("Api is not initialized. buildSpotifyApi returns ${buildSpotifyApi(testClassQualifiedName, "n/a")}")
+            println("Api is not initialized or does not match the expected type. buildSpotifyApi returns ${buildSpotifyApi(testClassQualifiedName, "n/a")}")
             false
         }
     }

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

@@ -30,8 +30,9 @@ class ClientEpisodeApiTest : AbstractTest<SpotifyClientApi>() {
         buildApi<SpotifyClientApi>(::testGetEpisodes.name)
         if (!isApiInitialized()) return@runTestOnDefaultDispatcher
 
-        assertEquals(listOf(null, null), api.episodes.getEpisodes("hi", "dad"))
-        assertEquals(null, api.episodes.getEpisodes("1cfOhXP4GQCd5ZFHoSF8gg", "j")[1])
+        assertFailsWith<BadRequestException> { api.episodes.getEpisodes("hi", "dad") }
+        assertFailsWith<BadRequestException> { api.episodes.getEpisodes("1cfOhXP4GQCd5ZFHoSF8gg", "j")[1] }
+
         assertEquals(
             listOf("The Great Inflation (Classic)"),
             api.episodes.getEpisodes("3lMZTE81Pbrp0U12WZe27l").map { it?.name }

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

@@ -85,8 +85,8 @@ class ClientPlaylistApiTest : AbstractTest<SpotifyClientApi>() {
 
         api.spotifyApiOptions.allowBulkRequests = true
 
-        suspend fun calculatePlaylistSize() = api.playlists.getClientPlaylist(createdPlaylist!!.id)!!.tracks.total
-        val sizeBefore = calculatePlaylistSize()
+        suspend fun calculatePlaylistSize(): Int? = api.playlists.getClientPlaylist(createdPlaylist!!.id)!!.tracks.total
+        val sizeBefore = calculatePlaylistSize() ?: 0
         api.playlists.addPlayablesToClientPlaylist(createdPlaylist!!.id, playables = tracks.toTypedArray())
         assertEquals(sizeBefore + tracks.size, calculatePlaylistSize())
         api.playlists.removePlayablesFromClientPlaylist(createdPlaylist!!.id, playables = tracks.toTypedArray())
@@ -98,6 +98,7 @@ class ClientPlaylistApiTest : AbstractTest<SpotifyClientApi>() {
     }
 
     @Test
+    @Ignore // ignored because Spotify currently broke the ability to change `public` field
     fun testEditPlaylists(): TestResult = runTestOnDefaultDispatcher {
         buildApi<SpotifyClientApi>(::testEditPlaylists.name)
         if (!isApiInitialized()) return@runTestOnDefaultDispatcher

src/commonTest/kotlin/com.adamratzman/spotify/pub/SearchApiTest.kt

@@ -23,7 +23,7 @@ class SearchApiTest : AbstractTest<GenericSpotifyApi>() {
     fun testSearchMultiple(): TestResult = runTestOnDefaultDispatcher {
         buildApi(::testSearchMultiple.name)
 
-        val query = api.search.search("lo", *SearchApi.SearchType.values(), market = Market.US)
+        val query = api.search.search("lo", *SearchApi.SearchType.entries.toTypedArray(), market = Market.US)
         assertTrue(
             query.albums?.items?.isNotEmpty() == true && query.tracks?.items?.isNotEmpty() == true && query.artists?.items?.isNotEmpty() == true &&
                 query.playlists?.items?.isNotEmpty() == true && query.shows?.items?.isNotEmpty() == true && query.episodes?.items?.isNotEmpty() == true

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

@@ -27,7 +27,7 @@ class PkceTest {
 
             println(
                 getSpotifyPkceAuthorizationUrl(
-                    *SpotifyScope.values(),
+                    *SpotifyScope.entries.toTypedArray(),
                     clientId = clientId,
                     redirectUri = serverRedirectUri,
                     codeChallenge = getSpotifyPkceCodeChallenge(pkceCodeVerifier),