Skip to content

Fix JsoupDocumentReader dropping relative link URLs #6803

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

Open
wantaekchoi wants to merge 1 commit into
base: main
Choose a base branch
from
+42 −1
Open

Fix JsoupDocumentReader dropping relative link URLs #6803

Show file tree
Hide file tree
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
18 changes: 17 additions & 1 deletion ...ocument-reader/src/main/java/org/springframework/ai/reader/jsoup/JsoupDocumentReader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ public JsoupDocumentReader(Resource htmlResource, JsoupDocumentReaderConfig conf
@Override
public List<Document> get() {
try (InputStream inputStream = this.htmlResource.getInputStream()) {
org.jsoup.nodes.Document doc = Jsoup.parse(inputStream, this.config.charset, "");
org.jsoup.nodes.Document doc = Jsoup.parse(inputStream, this.config.charset, resolveBaseUri());

List<Document> documents = new ArrayList<>();

Expand Down Expand Up @@ -108,6 +108,22 @@ else if (this.config.groupByElement) {
}
}

/**
* Returns the base URI used to resolve relative links against, taken from the
* resource itself. Resources that cannot be resolved to a URL, such as a
* {@link org.springframework.core.io.ByteArrayResource}, have no base to resolve
* against and keep an empty one.
*/
private String resolveBaseUri() {
try {
return this.htmlResource.getURL().toString();
}
catch (IOException ignored) {
// A resource without a URL has no base to resolve against.
return "";
}
}

private void addMetadata(org.jsoup.nodes.Document jsoupDoc, Document springDoc) {
Map<String, Object> metadata = new HashMap<>();
metadata.put("title", jsoupDoc.title());
Expand Down
15 changes: 15 additions & 0 deletions ...nt-reader/src/test/java/org/springframework/ai/reader/jsoup/JsoupDocumentReaderTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,21 @@ void testWithLinkUrls() {
assertThat(linkUrls).contains("https://spring.io/");
}

@Test
void testWithRelativeLinkUrls() {
JsoupDocumentReader reader = new JsoupDocumentReader(
new DefaultResourceLoader().getResource("classpath:/test-relative-links.html"),
JsoupDocumentReaderConfig.builder().includeLinkUrls(true).build());
List<Document> documents = reader.get();
assertThat(documents).hasSize(1);
Document document = documents.get(0);

List<String> linkUrls = (List<String>) document.getMetadata().get("linkUrls");
assertThat(linkUrls).contains("https://spring.io/");
assertThat(linkUrls).noneMatch(String::isEmpty);
assertThat(linkUrls).anySatisfy(url -> assertThat(url).endsWith("/guide.html"));
}

@Test
void testWithMetadataTags() {
JsoupDocumentReader reader = new JsoupDocumentReader(
Expand Down
10 changes: 10 additions & 0 deletions document-readers/spring-ai-jsoup-document-reader/src/test/resources/test-relative-links.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html>
<head>
<title>Test Relative Links</title>
</head>
<body>
<a href="guide.html">Relative link</a>
<a href="https://spring.io/">Absolute link</a>
</body>
</html>