getSearchSuggestion now returns the corrected query if isCorrectedSearch() is true

B0pol · B0pol · commit e8d58e09c9be · 2020-05-07T15:40:41.000+02:00
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/search/SearchExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/search/SearchExtractor.java
@@ -25,6 +25,16 @@ public String getSearchString() {
         return getLinkHandler().getSearchString();
     }
 
+    /**
+     * The search suggestion provided by the service.
+     * <p>
+     * This method may also return the corrected query,
+     * see {@link SearchExtractor#isCorrectedSearch()}.
+     *
+     * @return a suggestion to another query, the corrected query, or an empty String.
+     * @throws ParsingException
+     */
+    @Nonnull
     public abstract String getSearchSuggestion() throws ParsingException;
 
     @Override
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/media_ccc/extractors/MediaCCCSearchExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/media_ccc/extractors/MediaCCCSearchExtractor.java
@@ -11,6 +11,7 @@
 import org.schabi.newpipe.extractor.channel.ChannelInfoItemExtractor;
 import org.schabi.newpipe.extractor.downloader.Downloader;
 import org.schabi.newpipe.extractor.exceptions.ExtractionException;
+import org.schabi.newpipe.extractor.exceptions.ParsingException;
 import org.schabi.newpipe.extractor.linkhandler.SearchQueryHandler;
 import org.schabi.newpipe.extractor.search.InfoItemsSearchCollector;
 import org.schabi.newpipe.extractor.search.SearchExtractor;
@@ -42,9 +43,10 @@ public MediaCCCSearchExtractor(final StreamingService service,
         }
     }
 
+    @Nonnull
     @Override
-    public String getSearchSuggestion() {
-        return null;
+    public String getSearchSuggestion() throws ParsingException {
+        return "";
     }
 
     @Override
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/peertube/extractors/PeertubeSearchExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/peertube/extractors/PeertubeSearchExtractor.java
@@ -19,6 +19,7 @@
 import org.schabi.newpipe.extractor.utils.Parser;
 import org.schabi.newpipe.extractor.utils.Parser.RegexException;
 
+import javax.annotation.Nonnull;
 import java.io.IOException;
 
 public class PeertubeSearchExtractor extends SearchExtractor {
@@ -35,9 +36,10 @@ public PeertubeSearchExtractor(StreamingService service, SearchQueryHandler link
         super(service, linkHandler);
     }
 
+    @Nonnull
     @Override
     public String getSearchSuggestion() throws ParsingException {
-        return null;
+        return "";
     }
 
     @Override
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/soundcloud/extractors/SoundcloudSearchExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/soundcloud/extractors/SoundcloudSearchExtractor.java
@@ -33,9 +33,10 @@ public SoundcloudSearchExtractor(StreamingService service, SearchQueryHandler li
         super(service, linkHandler);
     }
 
+    @Nonnull
     @Override
     public String getSearchSuggestion() {
-        return null;
+        return "";
     }
 
     @Override
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeMusicSearchExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeMusicSearchExtractor.java
@@ -18,6 +18,7 @@
 import org.schabi.newpipe.extractor.search.InfoItemsSearchCollector;
 import org.schabi.newpipe.extractor.search.SearchExtractor;
 import org.schabi.newpipe.extractor.services.youtube.YoutubeParsingHelper;
+import org.schabi.newpipe.extractor.utils.JsonUtils;
 import org.schabi.newpipe.extractor.utils.Utils;
 
 import java.io.IOException;
@@ -124,15 +125,27 @@ public String getUrl() throws ParsingException {
         return super.getUrl();
     }
 
+    @Nonnull
     @Override
     public String getSearchSuggestion() throws ParsingException {
-        final JsonObject didYouMeanRenderer = initialData.getObject("contents").getObject("sectionListRenderer")
-                .getArray("contents").getObject(0).getObject("itemSectionRenderer")
-                .getArray("contents").getObject(0).getObject("didYouMeanRenderer");
-        if (!didYouMeanRenderer.has("correctedQuery")) {
+        final JsonObject itemSectionRenderer = initialData.getObject("contents").getObject("sectionListRenderer")
+                .getArray("contents").getObject(0).getObject("itemSectionRenderer");
+        if (itemSectionRenderer == null) {
+            return "";
+        }
+
+        final JsonObject didYouMeanRenderer = itemSectionRenderer.getArray("contents")
+                .getObject(0).getObject("didYouMeanRenderer");
+        final JsonObject showingResultsForRenderer = itemSectionRenderer.getArray("contents").getObject(0)
+                .getObject("showingResultsForRenderer");
+
+        if (didYouMeanRenderer != null) {
+            return getTextFromObject(didYouMeanRenderer.getObject("correctedQuery"));
+        } else if (showingResultsForRenderer != null) {
+            return JsonUtils.getString(showingResultsForRenderer, "correctedQueryEndpoint.searchEndpoint.query");
+        } else {
             return "";
         }
-        return getTextFromObject(didYouMeanRenderer.getObject("correctedQuery"));
     }
 
     @Override
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeSearchExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeSearchExtractor.java
@@ -61,17 +61,25 @@ public String getUrl() throws ParsingException {
         return super.getUrl() + "&gl=" + getExtractorContentCountry().getCountryCode();
     }
 
+    @Nonnull
     @Override
     public String getSearchSuggestion() throws ParsingException {
-        final JsonObject didYouMeanRenderer = initialData.getObject("contents")
+        final JsonObject itemSectionRenderer = initialData.getObject("contents")
                 .getObject("twoColumnSearchResultsRenderer").getObject("primaryContents")
                 .getObject("sectionListRenderer").getArray("contents").getObject(0)
-                .getObject("itemSectionRenderer").getArray("contents").getObject(0)
+                .getObject("itemSectionRenderer");
+        final JsonObject didYouMeanRenderer = itemSectionRenderer.getArray("contents").getObject(0)
                 .getObject("didYouMeanRenderer");
-        if (didYouMeanRenderer == null) {
+        final JsonObject showingResultsForRenderer = itemSectionRenderer.getArray("contents").getObject(0)
+                .getObject("showingResultsForRenderer");
+
+        if (didYouMeanRenderer != null) {
+            return JsonUtils.getString(didYouMeanRenderer, "correctedQueryEndpoint.searchEndpoint.query");
+        } else if (showingResultsForRenderer != null) {
+            return getTextFromObject(showingResultsForRenderer.getObject("correctedQuery"));
+        } else {
             return "";
         }
-        return JsonUtils.getString(didYouMeanRenderer, "correctedQueryEndpoint.searchEndpoint.query");
     }
 
     @Override
diff --git a/extractor/src/test/java/org/schabi/newpipe/extractor/services/youtube/search/YoutubeMusicSearchExtractorTest.java b/extractor/src/test/java/org/schabi/newpipe/extractor/services/youtube/search/YoutubeMusicSearchExtractorTest.java
@@ -154,6 +154,7 @@ public static void setUp() throws Exception {
     public static class CorrectedSearch extends DefaultSearchExtractorTest {
         private static SearchExtractor extractor;
         private static final String QUERY = "duo lipa";
+        private static final String EXPECTED_SUGGESTION = "dua lipa";
 
         @BeforeClass
         public static void setUp() throws Exception {
@@ -169,7 +170,7 @@ public static void setUp() throws Exception {
         @Override public String expectedUrlContains() { return "music.youtube.com/search?q=" + URLEncoder.encode(QUERY); }
         @Override public String expectedOriginalUrlContains() { return "music.youtube.com/search?q=" + URLEncoder.encode(QUERY); }
         @Override public String expectedSearchString() { return QUERY; }
-        @Nullable @Override public String expectedSearchSuggestion() { return null; }
+        @Nullable @Override public String expectedSearchSuggestion() { return EXPECTED_SUGGESTION; }
         @Override public InfoItem.InfoType expectedInfoItemType() { return InfoItem.InfoType.STREAM; }
         @Override public boolean isCorrectedSearch() { return true; }
     }
diff --git a/extractor/src/test/java/org/schabi/newpipe/extractor/services/youtube/search/YoutubeSearchExtractorTest.java b/extractor/src/test/java/org/schabi/newpipe/extractor/services/youtube/search/YoutubeSearchExtractorTest.java
@@ -7,6 +7,7 @@
 import org.schabi.newpipe.extractor.ListExtractor;
 import org.schabi.newpipe.extractor.NewPipe;
 import org.schabi.newpipe.extractor.StreamingService;
+import org.schabi.newpipe.extractor.exceptions.ParsingException;
 import org.schabi.newpipe.extractor.search.SearchExtractor;
 import org.schabi.newpipe.extractor.services.DefaultSearchExtractorTest;
 
@@ -138,6 +139,7 @@ public static void setUp() throws Exception {
     public static class CorrectedSearch extends DefaultSearchExtractorTest {
         private static SearchExtractor extractor;
         private static final String QUERY = "pewdeipie";
+        private static final String EXPECTED_SUGGESTION = "pewdiepie";
 
         @BeforeClass
         public static void setUp() throws Exception {
@@ -153,7 +155,7 @@ public static void setUp() throws Exception {
         @Override public String expectedUrlContains() { return "youtube.com/results?search_query=" + QUERY; }
         @Override public String expectedOriginalUrlContains() { return "youtube.com/results?search_query=" + QUERY; }
         @Override public String expectedSearchString() { return QUERY; }
-        @Nullable @Override public String expectedSearchSuggestion() { return null; }
+        @Nullable @Override public String expectedSearchSuggestion() { return EXPECTED_SUGGESTION; }
         @Override public InfoItem.InfoType expectedInfoItemType() { return InfoItem.InfoType.STREAM; }
         @Override public boolean isCorrectedSearch() { return true; }
     }

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`	`import org.schabi.newpipe.extractor.channel.ChannelInfoItemExtractor;`
`12`	`12`	`import org.schabi.newpipe.extractor.downloader.Downloader;`
`13`	`13`	`import org.schabi.newpipe.extractor.exceptions.ExtractionException;`
	`14`	`+import org.schabi.newpipe.extractor.exceptions.ParsingException;`
`14`	`15`	`import org.schabi.newpipe.extractor.linkhandler.SearchQueryHandler;`
`15`	`16`	`import org.schabi.newpipe.extractor.search.InfoItemsSearchCollector;`
`16`	`17`	`import org.schabi.newpipe.extractor.search.SearchExtractor;`
`@@ -42,9 +43,10 @@ public MediaCCCSearchExtractor(final StreamingService service,`
`42`	`43`	`}`
`43`	`44`	`}`
`44`	`45`
	`46`	`+ @Nonnull`
`45`	`47`	`@Override`
`46`		`- public String getSearchSuggestion() {`
`47`		`- return null;`
	`48`	`+ public String getSearchSuggestion() throws ParsingException {`
	`49`	`+ return "";`
`48`	`50`	`}`
`49`	`51`
`50`	`52`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -33,9 +33,10 @@ public SoundcloudSearchExtractor(StreamingService service, SearchQueryHandler li`
`33`	`33`	`super(service, linkHandler);`
`34`	`34`	`}`
`35`	`35`
	`36`	`+ @Nonnull`
`36`	`37`	`@Override`
`37`	`38`	`public String getSearchSuggestion() {`
`38`		`- return null;`
	`39`	`+ return "";`
`39`	`40`	`}`
`40`	`41`
`41`	`42`	`@Override`