Skip to content

Fix metadata requests (Fixes #1102) #1103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
devgianlu merged 1 commit into from
Nov 7, 2025
+51 −31
Merged

Fix metadata requests (Fixes #1102) #1103

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 51 additions & 31 deletions lib/src/main/java/xyz/gianlu/librespot/dealer/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import com.spotify.clienttoken.http.v0.ClientToken;
import com.spotify.connectstate.Connect;
import com.spotify.extendedmetadata.ExtendedMetadata;
import com.spotify.extendedmetadata.ExtensionKindOuterClass;
import com.spotify.metadata.Metadata;
import com.spotify.playlist4.Playlist4ApiProto;
import okhttp3.*;
Expand Down Expand Up @@ -98,7 +99,7 @@ public void sendAsync(@NotNull String method, @NotNull String suffix, @Nullable
* Sends a request to the Spotify API.
*
* @param method The request method
* @param suffix The suffix to be appended to {@link #baseUrl} also know as path
* @param suffix The suffix to be appended to {@link #baseUrl} also known as path
* @param headers Additional headers
* @param body The request body
* @param tries How many times the request should be reattempted (0 = none)
Expand Down Expand Up @@ -143,57 +144,47 @@ else if (resp.code() != 200)

@NotNull
public Metadata.Track getMetadata4Track(@NotNull TrackId track) throws IOException, TokenProvider.TokenException {
try (Response resp = send("GET", "/metadata/4/track/" + track.hexId(), null, null)) {
StatusCodeException.checkStatus(resp);
ExtendedMetadata.BatchedExtensionResponse response = getExtendedMetadata(ExtensionKindOuterClass.ExtensionKind.TRACK_V4, track);

ResponseBody body;
if ((body = resp.body()) == null) throw new IOException();
return Metadata.Track.parseFrom(body.byteStream());
}
checkExtendedMetadataResponse(response);

return Metadata.Track.parseFrom(response.getExtendedMetadata(0).getExtensionData(0).getExtensionData().getValue());
}

@NotNull
public Metadata.Episode getMetadata4Episode(@NotNull EpisodeId episode) throws IOException, TokenProvider.TokenException {
try (Response resp = send("GET", "/metadata/4/episode/" + episode.hexId(), null, null)) {
StatusCodeException.checkStatus(resp);
ExtendedMetadata.BatchedExtensionResponse response = getExtendedMetadata(ExtensionKindOuterClass.ExtensionKind.EPISODE_V4, episode);

ResponseBody body;
if ((body = resp.body()) == null) throw new IOException();
return Metadata.Episode.parseFrom(body.byteStream());
}
checkExtendedMetadataResponse(response);

return Metadata.Episode.parseFrom(response.getExtendedMetadata(0).getExtensionData(0).getExtensionData().getValue());
}

@NotNull
public Metadata.Album getMetadata4Album(@NotNull AlbumId album) throws IOException, TokenProvider.TokenException {
try (Response resp = send("GET", "/metadata/4/album/" + album.hexId(), null, null)) {
StatusCodeException.checkStatus(resp);
ExtendedMetadata.BatchedExtensionResponse response = getExtendedMetadata(ExtensionKindOuterClass.ExtensionKind.ALBUM_V4, album);

ResponseBody body;
if ((body = resp.body()) == null) throw new IOException();
return Metadata.Album.parseFrom(body.byteStream());
}
checkExtendedMetadataResponse(response);

return Metadata.Album.parseFrom(response.getExtendedMetadata(0).getExtensionData(0).getExtensionData().getValue());
}

@NotNull
public Metadata.Artist getMetadata4Artist(@NotNull ArtistId artist) throws IOException, TokenProvider.TokenException {
try (Response resp = send("GET", "/metadata/4/artist/" + artist.hexId(), null, null)) {
StatusCodeException.checkStatus(resp);
ExtendedMetadata.BatchedExtensionResponse response = getExtendedMetadata(ExtensionKindOuterClass.ExtensionKind.ARTIST_V4, artist);

ResponseBody body;
if ((body = resp.body()) == null) throw new IOException();
return Metadata.Artist.parseFrom(body.byteStream());
}
checkExtendedMetadataResponse(response);

return Metadata.Artist.parseFrom(response.getExtendedMetadata(0).getExtensionData(0).getExtensionData().getValue());
}

@NotNull
public Metadata.Show getMetadata4Show(@NotNull ShowId show) throws IOException, TokenProvider.TokenException {
try (Response resp = send("GET", "/metadata/4/show/" + show.hexId(), null, null)) {
StatusCodeException.checkStatus(resp);
ExtendedMetadata.BatchedExtensionResponse response = getExtendedMetadata(ExtensionKindOuterClass.ExtensionKind.SHOW_V4, show);

ResponseBody body;
if ((body = resp.body()) == null) throw new IOException();
return Metadata.Show.parseFrom(body.byteStream());
}
checkExtendedMetadataResponse(response);

return Metadata.Show.parseFrom(response.getExtendedMetadata(0).getExtensionData(0).getExtensionData().getValue());
}

@NotNull
Expand All @@ -207,6 +198,17 @@ public EntityCanvazResponse getCanvases(@NotNull EntityCanvazRequest req) throws
}
}

public void checkExtendedMetadataResponse(ExtendedMetadata.BatchedExtensionResponse response) throws IOException {
if (response.getExtendedMetadataCount() == 0)
throw new IOException("No metadata in BatchedExtensionResponse");

if (response.getExtendedMetadata(0).getExtensionDataCount() == 0)
throw new IOException("No metadata in ExtendedMetadata in BatchedExtensionResponse");

if (response.getExtendedMetadata(0).getExtensionData(0).getHeader().getStatusCode() != 200)
throw new IOException("Bad status code for metadata: " + response.getExtendedMetadata(0).getExtensionData(0).getHeader().getStatusCode());
}

@NotNull
public ExtendedMetadata.BatchedExtensionResponse getExtendedMetadata(@NotNull ExtendedMetadata.BatchedEntityRequest req) throws IOException, TokenProvider.TokenException {
try (Response resp = send("POST", "/extended-metadata/v0/extended-metadata", null, protoBody(req))) {
Expand All @@ -218,6 +220,24 @@ public ExtendedMetadata.BatchedExtensionResponse getExtendedMetadata(@NotNull Ex
}
}

@NotNull
public ExtendedMetadata.BatchedExtensionResponse getExtendedMetadata(@NotNull ExtensionKindOuterClass.ExtensionKind extensionKind, @NotNull SpotifyId spotifyId) throws IOException, TokenProvider.TokenException {
try (Response resp = send("POST", "/extended-metadata/v0/extended-metadata", null, protoBody(ExtendedMetadata.BatchedEntityRequest.newBuilder()
.addEntityRequest(ExtendedMetadata.EntityRequest.newBuilder()
.setEntityUri(spotifyId.toSpotifyUri())
.addQuery(ExtendedMetadata.ExtensionQuery.newBuilder()
.setExtensionKind(extensionKind)
.build())
.build())
.build()))) {
StatusCodeException.checkStatus(resp);

ResponseBody body;
if ((body = resp.body()) == null) throw new IOException();
return ExtendedMetadata.BatchedExtensionResponse.parseFrom(body.byteStream());
}
}

@NotNull
public Playlist4ApiProto.SelectedListContent getPlaylist(@NotNull PlaylistId id) throws IOException, TokenProvider.TokenException {
try (Response resp = send("GET", "/playlist/v2/playlist/" + id.id(), null, null)) {
Expand Down