Make images nullable (change in spotify responses?)

Author: adamint

build.gradle.kts

@@ -2,6 +2,7 @@
 
 import com.fasterxml.jackson.databind.json.JsonMapper
 import org.jetbrains.dokka.gradle.DokkaTask
+import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi
 import org.jetbrains.kotlin.gradle.plugin.KotlinJsCompilerType
 import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget
 import org.jetbrains.kotlin.gradle.targets.js.webpack.KotlinWebpackOutput.Target
@@ -46,7 +47,7 @@ version = libraryVersion
 
 android {
     namespace = "com.adamratzman.spotify"
-    compileSdk = 30
+    compileSdk = 31
     compileOptions {
         sourceCompatibility = JavaVersion.VERSION_17
         targetCompatibility = JavaVersion.VERSION_17
@@ -56,7 +57,7 @@ android {
     }
     defaultConfig {
         minSdk = 23
-        setCompileSdkVersion(30)
+        setCompileSdkVersion(31)
         testInstrumentationRunner = "android.support.test.runner.AndroidJUnitRunner"
     }
 
@@ -81,6 +82,10 @@ val dokkaJar: TaskProvider<Jar> by tasks.registering(Jar::class) {
 }
 
 kotlin {
+    @OptIn(ExperimentalKotlinGradlePluginApi::class)
+    compilerOptions { 
+        freeCompilerArgs.add("-Xexpect-actual-classes")
+    }
     explicitApiWarning()
     jvmToolchain(17)
 

gradle.properties

@@ -21,6 +21,6 @@ kotlinxCoroutinesVersion=1.7.3
 androidBuildToolsVersion=8.2.2
 androidSpotifyAuthVersion=2.1.1
 androidCryptoVersion=1.1.0-alpha06
-androidxCompatVersion=1.6.1
+androidxCompatVersion=1.7.0-alpha03
 
 sparkVersion=2.9.4

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

@@ -41,7 +41,7 @@ public data class SimpleAlbum(
     override val uri: SpotifyUri,
 
     val artists: List<SimpleArtist>,
-    val images: List<SpotifyImage>,
+    val images: List<SpotifyImage>? = null,
     val name: String,
     val type: String,
     val restrictions: Restrictions? = null,
@@ -142,7 +142,7 @@ public data class Album(
     val artists: List<SimpleArtist>,
     val copyrights: List<SpotifyCopyright>,
     val genres: List<String>,
-    val images: List<SpotifyImage>,
+    val images: List<SpotifyImage>? = null,
     val label: String,
     val name: String,
     val popularity: Double,

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

@@ -59,7 +59,7 @@ public data class Artist(
 
     val followers: Followers,
     val genres: List<String>,
-    val images: List<SpotifyImage>,
+    val images: List<SpotifyImage>? = null,
     val name: String? = null,
     val popularity: Double,
     val type: String

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

@@ -96,7 +96,7 @@ public data class Episode(
     @SerialName("external_urls") override val externalUrlsString: Map<String, String>,
     override val href: String,
     override val id: String,
-    val images: List<SpotifyImage>,
+    val images: List<SpotifyImage>? = null,
     @SerialName("is_externally_hosted") val isExternallyHosted: Boolean,
     @SerialName("is_playable") val isPlayable: Boolean,
     @Deprecated("This field is deprecated and might be removed in the future. Please use the languages field instead")
@@ -148,7 +148,7 @@ public data class SimpleEpisode(
     @SerialName("external_urls") override val externalUrlsString: Map<String, String>,
     override val href: String,
     override val id: String,
-    val images: List<SpotifyImage>,
+    val images: List<SpotifyImage>? = null,
     @SerialName("is_externally_hosted") val isExternallyHosted: Boolean,
     @SerialName("is_playable") val isPlayable: Boolean,
     @Deprecated("This field is deprecated and might be removed in the future. Please use the languages field instead")

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

@@ -39,7 +39,7 @@ public data class SimplePlaylist(
     override val uri: SpotifyUri,
 
     val collaborative: Boolean,
-    val images: List<SpotifyImage>,
+    val images: List<SpotifyImage>? = null,
     val name: String,
     val description: String? = null,
     val owner: SpotifyPublicUser,
@@ -126,7 +126,7 @@ public data class Playlist(
     val description: String? = null,
     val followers: Followers,
     @SerialName("primary_color") val primaryColor: String? = null,
-    val images: List<SpotifyImage>,
+    val images: List<SpotifyImage>? = null,
     val name: String,
     val owner: SpotifyPublicUser,
     val public: Boolean? = null,

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

@@ -76,8 +76,8 @@ public interface ISpotifyUri {
  */
 @Serializable(with = SpotifyUriSerializer::class)
 public sealed class SpotifyUri(input: String, public val type: String, allowColon: Boolean = false) : ISpotifyUri {
-    public override val uri: String
-    public override val id: String
+    public final override val uri: String
+    public final override val id: String
 
     init {
         input.replace(" ", "").also {

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

@@ -40,7 +40,7 @@ public data class SpotifyUserInformation(
     @SerialName("display_name") val displayName: String? = null,
     val email: String? = null,
     val followers: Followers,
-    val images: List<SpotifyImage>,
+    val images: List<SpotifyImage>? = null,
     val product: String? = null,
     @SerialName("explicit_content") val explicitContentSettings: ExplicitContentSettings? = null,
     val type: String

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

@@ -21,7 +21,7 @@ internal suspend inline fun <T> catch(catchInternalServerError: Boolean = false,
     return try {
         function()
     } catch (e: SpotifyException.BadRequestException) {
-        if (e.statusCode !in listOf(400, 404)) throw e
+        if (e.statusCode !in listOf(400, 404) && (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/priv/ClientPlaylistApiTest.kt

@@ -130,7 +130,7 @@ class ClientPlaylistApiTest : AbstractTest<SpotifyClientApi>() {
         assertTrue(updatedPlaylist.public == false)
         assertEquals("test playlist", updatedPlaylist.name)
         //assertEquals("description 2", fullPlaylist.description)  <-- spotify is flaky about actually having description set
-        assertTrue(updatedPlaylist.tracks.total == 2 && updatedPlaylist.images.isNotEmpty())
+        assertTrue(updatedPlaylist.tracks.total == 2 && updatedPlaylist.images?.isNotEmpty() == true)
 
         api.playlists.reorderClientPlaylistPlayables(updatedPlaylist.id, 1, insertionPoint = 0)
 

src/jsMain/kotlin/com/adamratzman/spotify/webplayer/WebPlaybackSdk.kt

@@ -13,7 +13,7 @@ import kotlin.js.Promise
 public external interface Album {
     public var uri: String
     public var name: String
-    public var images: Array<Image>
+    public var images: Array<Image>?
 }
 
 public external interface Artist {