Add more logging.

Author: devoxin

README.md

@@ -184,7 +184,7 @@ Currently, the following clients are available for use:
 
 - `MUSIC`
   - ✔ Provides support for searching YouTube music (`ytmsearch:`).
-  - ❌ No playback support. 
+  - ❌ Cannot be used for playback, or playlist/mix/livestream loading.
 - `WEB`
   - ✔ Opus formats.
 - `WEBEMBEDDED`
@@ -194,13 +194,13 @@ Currently, the following clients are available for use:
   - ❌ Heavily restricted, frequently dysfunctional.
 - `ANDROID_TESTSUITE`
   - ✔ Opus formats.
-  - ❌ No mix/playlist/livestream support. Advised to use in conjunction with other clients.
+  - ❌ No mix/playlist/livestream support.
 - `ANDROID_LITE`
   - ❌ No Opus formats (requires transcoding).
-  - ❌ Restricted similarly to `ANDROID_TESTSUITE` (except livestreams are playable).
+  - ❌ No mix/playlist/livestream support.
 - `ANDROID_MUSIC`
   - ✔ Opus formats.
-  - ❌ No playlist support.
+  - ❌ No playlist/livestream support.
 - `MEDIA_CONNECT`
   - ❌ No Opus formats (requires transcoding).
   - ❌ No mix/playlist/search support.

common/build.gradle.kts

@@ -20,6 +20,8 @@ dependencies {
     compileOnly(libs.annotations)
 
     testImplementation(libs.lavaplayer.v1)
+    testImplementation("org.apache.logging.log4j:log4j-core:2.19.0")
+    testImplementation("org.apache.logging.log4j:log4j-slf4j2-impl:2.19.0")
 }
 
 mavenPublishing {

common/src/main/java/dev/lavalink/youtube/clients/skeleton/Client.java

@@ -27,13 +27,13 @@
 public interface Client {
     String WATCH_URL = "https://www.youtube.com/watch?v=";
     String API_BASE_URL = "https://youtubei.googleapis.com/youtubei/v1";
-    String PLAYER_URL = API_BASE_URL + "/player";
-    String SEARCH_URL = API_BASE_URL + "/search";
-    String NEXT_URL = API_BASE_URL + "/next";
-    String BROWSE_URL = API_BASE_URL + "/browse";
+    String PLAYER_URL = API_BASE_URL + "/player?prettyPrint=false";
+    String SEARCH_URL = API_BASE_URL + "/search?prettyPrint=false";
+    String NEXT_URL = API_BASE_URL + "/next?prettyPrint=false";
+    String BROWSE_URL = API_BASE_URL + "/browse?prettyPrint=false";
 
     String MUSIC_API_BASE_URL = "https://music.youtube.com/youtubei/v1";
-    String MUSIC_SEARCH_URL = MUSIC_API_BASE_URL + "/search";
+    String MUSIC_SEARCH_URL = MUSIC_API_BASE_URL + "/search?prettyPrint=false";
 
     // Should be videos only, whilst also bypassing YouTube's filter
     // for queries that trigger the suicide/self-harm warning.

common/src/main/java/dev/lavalink/youtube/clients/skeleton/NonMusicClient.java

@@ -12,15 +12,18 @@
 import dev.lavalink.youtube.cipher.SignatureCipherManager.CachedPlayerScript;
 import dev.lavalink.youtube.clients.ClientConfig;
 import dev.lavalink.youtube.track.TemporalInfo;
+import org.apache.http.HttpEntity;
 import org.apache.http.client.methods.CloseableHttpResponse;
 import org.apache.http.client.methods.HttpPost;
 import org.apache.http.entity.StringEntity;
+import org.apache.http.util.EntityUtils;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.io.IOException;
+import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Objects;
@@ -54,13 +57,22 @@ public abstract class NonMusicClient implements Client {
     protected JsonBrowser loadJsonResponse(@NotNull HttpInterface httpInterface,
                                            @NotNull HttpPost request,
                                            @NotNull String context) throws IOException {
+        if (request.getEntity() instanceof StringEntity) {
+            log.debug("Requesting {} ({}) with payload {}", request.getURI(), context, EntityUtils.toString(request.getEntity(), StandardCharsets.UTF_8));
+        } else {
+            log.debug("Requesting {} ({})", context, request.getURI());
+        }
+
         try (CloseableHttpResponse response = httpInterface.execute(request)) {
             HttpClientTools.assertSuccessWithContent(response, context);
             // todo: flag for checking json content type?
             //       from my testing, json is always returned so might not be necessary.
             HttpClientTools.assertJsonContentType(response);
 
-            return JsonBrowser.parse(response.getEntity().getContent());
+            String json = EntityUtils.toString(response.getEntity());
+            log.trace("Response from {} ({}) {}", request.getURI(), context, json);
+
+            return JsonBrowser.parse(json);
         }
     }
 
@@ -89,8 +101,6 @@ protected JsonBrowser loadTrackInfoFromInnertube(@NotNull YoutubeAudioSourceMana
             .setAttributes(httpInterface)
             .toJsonString();
 
-        log.debug("Requesting {} with payload {}", PLAYER_URL, payload);
-
         HttpPost request = new HttpPost(PLAYER_URL);
         request.setEntity(new StringEntity(payload, "UTF-8"));
 
@@ -131,13 +141,14 @@ protected JsonBrowser loadTrackInfoFromInnertube(@NotNull YoutubeAudioSourceMana
     @NotNull
     protected JsonBrowser loadSearchResults(@NotNull HttpInterface httpInterface,
                                             @NotNull String searchQuery) {
-        ClientConfig clientConfig = getBaseClientConfig(httpInterface)
+        String payload = getBaseClientConfig(httpInterface)
             .withRootField("query", searchQuery)
             .withRootField("params", SEARCH_PARAMS)
-            .setAttributes(httpInterface);
+            .setAttributes(httpInterface)
+            .toJsonString();
 
         HttpPost request = new HttpPost(SEARCH_URL); // This *had* a key parameter. Doesn't seem needed though.
-        request.setEntity(new StringEntity(clientConfig.toJsonString(), "UTF-8"));
+        request.setEntity(new StringEntity(payload, "UTF-8"));
 
         try {
             return loadJsonResponse(httpInterface, request, "search response");