<![CDATA[Complex Slug]]>
@@ -124,6 +406,15 @@ exports[`json filters to the first two entries 1`] = `
"home_page_url": "https://docusaurus.io/myBaseUrl/blog",
"description": "Hello Blog",
"items": [
+ {
+ "id": "https://docusaurus.io/myBaseUrl/blog/blog-with-links",
+ "content_html": "absolute full url
/nabsolute url with implicit domain name
/nrelative url
/nanchor
",
+ "url": "https://docusaurus.io/myBaseUrl/blog/blog-with-links",
+ "title": "Test if href in feed resolved correctly",
+ "summary": "absolute full url",
+ "date_modified": "2023-07-19T08:15:33.000Z",
+ "tags": []
+ },
{
"id": "https://docusaurus.io/myBaseUrl/blog/mdx-require-blog-post",
"content_html": "Test MDX with require calls
HTML Heading 1 HTML Heading 2 HTML Paragraph
Import DOM
Heading 1 Heading 2 Heading 3 Heading 4 Heading 5 Normal Text Italics Text Bold Text
link
",
- "url": "https://docusaurus.io/myBaseUrl/blog/mdx-blog-post",
- "title": "Full Blog Sample",
- "summary": "HTML Heading 1",
- "date_modified": "2021-03-05T00:00:00.000Z",
- "tags": []
}
]
}",
@@ -155,6 +437,15 @@ exports[`json has feed item for each post 1`] = `
"home_page_url": "https://docusaurus.io/myBaseUrl/blog",
"description": "Hello Blog",
"items": [
+ {
+ "id": "https://docusaurus.io/myBaseUrl/blog/blog-with-links",
+ "content_html": "absolute full url
/nabsolute url with implicit domain name
/nrelative url
/nanchor
",
+ "url": "https://docusaurus.io/myBaseUrl/blog/blog-with-links",
+ "title": "Test if href in feed resolved correctly",
+ "summary": "absolute full url",
+ "date_modified": "2023-07-19T08:15:33.000Z",
+ "tags": []
+ },
{
"id": "https://docusaurus.io/myBaseUrl/blog/mdx-require-blog-post",
"content_html": "Test MDX with require calls
HTML Heading 1 HTML Heading 2 HTML Paragraph
Import DOM
Heading 1 Heading 2 Heading 3 Heading 4 Heading 5 Normal Text Italics Text Bold Text
link
",
+ "content_html": "HTML Heading 1 HTML Heading 2 HTML Paragraph
Import DOM
Heading 1 Heading 2 Heading 3 Heading 4 Heading 5 Normal Text Italics Text Bold Text
link
",
"url": "https://docusaurus.io/myBaseUrl/blog/mdx-blog-post",
"title": "Full Blog Sample",
"summary": "HTML Heading 1",
@@ -242,11 +533,22 @@ exports[`rss filters to the first two entries 1`] = `
Hello Blog
Hello Blog
- Sat, 06 Mar 2021 00:00:00 GMT
+ Wed, 19 Jul 2023 08:15:33 GMT
https://validator.w3.org/feed/docs/rss2.html
https://github.com/jpmonette/feed
en
Copyright
+ -
+
<![CDATA[Test if href in feed resolved correctly]]>
+ https://docusaurus.io/myBaseUrl/blog/blog-with-links
+ Wed, 19 Jul 2023 08:15:33 GMT
+ absolute full url
+absolute url with implicit domain name
+relative url
+anchor
]]>
-
<![CDATA[MDX Blog Sample with require calls]]>
Test MDX with require calls
- -
-
<![CDATA[Full Blog Sample]]>
- https://docusaurus.io/myBaseUrl/blog/mdx-blog-post
- Fri, 05 Mar 2021 00:00:00 GMT
- HTML Heading 1HTML Heading 2 HTML Paragraph
Import DOM
Heading 1 Heading 2 Heading 3 Heading 4 Heading 5 Normal Text Italics Text Bold Text
link
]]>
-
",
]
@@ -276,11 +570,22 @@ exports[`rss has feed item for each post 1`] = `
Hello Blog
Hello Blog
- Sat, 06 Mar 2021 00:00:00 GMT
+ Wed, 19 Jul 2023 08:15:33 GMT
https://validator.w3.org/feed/docs/rss2.html
https://github.com/jpmonette/feed
en
Copyright
+ -
+
<![CDATA[Test if href in feed resolved correctly]]>
+ https://docusaurus.io/myBaseUrl/blog/blog-with-links
+ Wed, 19 Jul 2023 08:15:33 GMT
+ absolute full url
+absolute url with implicit domain name
+relative url
+anchor
]]>
-
<![CDATA[MDX Blog Sample with require calls]]>
https://docusaurus.io/myBaseUrl/blog/mdx-blog-post
Fri, 05 Mar 2021 00:00:00 GMT
HTML Heading 1HTML Heading 2 HTML Paragraph
Import DOM
Heading 1 Heading 2 Heading 3 Heading 4 Heading 5 Normal Text Italics Text Bold Text
link
]]>
+ HTML Heading 1HTML Heading 2 HTML Paragraph
Import DOM
Heading 1 Heading 2 Heading 3 Heading 4 Heading 5 Normal Text Italics Text Bold Text
link
]]>
-
<![CDATA[Complex Slug]]>
diff --git a/packages/docusaurus-plugin-content-blog/src/__tests__/feed.test.ts b/packages/docusaurus-plugin-content-blog/src/__tests__/feed.test.ts
index 6592c09d7aa5..d98961e3868e 100644
--- a/packages/docusaurus-plugin-content-blog/src/__tests__/feed.test.ts
+++ b/packages/docusaurus-plugin-content-blog/src/__tests__/feed.test.ts
@@ -8,12 +8,18 @@
import {jest} from '@jest/globals';
import path from 'path';
import fs from 'fs-extra';
+import {load as cheerioLoad} from 'cheerio';
+import {readOutputHTMLFile} from '@docusaurus/utils';
+import {blogPostContainerID} from '@docusaurus/utils-common';
import {DEFAULT_OPTIONS} from '../options';
import {generateBlogPosts} from '../blogUtils';
-import {createBlogFeedFiles} from '../feed';
-import type {LoadContext, I18n} from '@docusaurus/types';
+import {
+ createBlogFeedFiles,
+ defaultCreateFeedItems as feedDefaultCreateFeedItems,
+} from '../feed';
+import type {LoadContext, I18n, DocusaurusConfig} from '@docusaurus/types';
import type {BlogContentPaths} from '../types';
-import type {PluginOptions} from '@docusaurus/plugin-content-blog';
+import type {BlogPost, PluginOptions} from '@docusaurus/plugin-content-blog';
const DefaultI18N: I18n = {
currentLocale: 'en',
@@ -62,6 +68,32 @@ async function testGenerateFeeds(
});
}
+function isFullAbsolutePath(str: string) {
+ const domain = 'https://domain.com';
+ const {origin} = new URL(str, domain);
+ return origin !== domain;
+}
+
+async function generateLinksOfBlogPosts(outDir: string, blogPosts: BlogPost[]) {
+ const linksOfBlogPosts: {[postId: string]: string[]} = {};
+ const pathOfFile = path.join(outDir, 'blog');
+ const promises = blogPosts.map(async (post) => {
+ try {
+ const content = await readOutputHTMLFile(post.id, pathOfFile, true);
+ const $ = cheerioLoad(content);
+ const anchorElements = $(`div#${blogPostContainerID} a`);
+ if (anchorElements.length > 0) {
+ const href = anchorElements.map((_, elm) => elm.attribs.href).toArray();
+ linksOfBlogPosts[post.id] = href;
+ }
+ } catch {
+ // post is a draft
+ }
+ });
+ await Promise.all(promises);
+ return linksOfBlogPosts;
+}
+
describe.each(['atom', 'rss', 'json'])('%s', (feedType) => {
const fsMock = jest.spyOn(fs, 'outputFile').mockImplementation(() => {});
@@ -196,3 +228,95 @@ describe.each(['atom', 'rss', 'json'])('%s', (feedType) => {
fsMock.mockClear();
});
});
+
+describe('Test defaultCreateFeedItems', () => {
+ const fsMock = jest.spyOn(fs, 'outputFile').mockImplementation(() => {});
+ it('links in feeds are resolved correctly', async () => {
+ const siteDir = path.join(__dirname, '__fixtures__', 'website');
+ const outDir = path.join(siteDir, 'build-snap');
+ const siteConfig = {
+ title: 'Hello',
+ baseUrl: '/myBaseUrl/',
+ url: 'https://docusaurus.io',
+ favicon: 'image/favicon.ico',
+ } as DocusaurusConfig;
+
+ const context = {
+ siteDir,
+ siteConfig,
+ i18n: DefaultI18N,
+ outDir,
+ } as LoadContext;
+
+ const options = {
+ path: 'blog',
+ routeBasePath: 'blog',
+ tagsBasePath: 'tags',
+ authorsMapPath: 'authors.yml',
+ include: DEFAULT_OPTIONS.include,
+ exclude: DEFAULT_OPTIONS.exclude,
+ feedOptions: {
+ type: ['atom', 'rss', 'json'],
+ copyright: 'Copyright',
+ },
+ readingTime: ({content, defaultReadingTime}) =>
+ defaultReadingTime({content}),
+ truncateMarker: //,
+ } as PluginOptions;
+
+ const blogPosts = await generateBlogPosts(
+ getBlogContentPaths(siteDir),
+ context,
+ options,
+ );
+
+ await createBlogFeedFiles({
+ blogPosts,
+ options,
+ siteConfig: context.siteConfig,
+ outDir: context.outDir,
+ locale: 'en',
+ });
+
+ const originalLinksInBlogs: {[id: string]: Array} =
+ await generateLinksOfBlogPosts(outDir, blogPosts);
+
+ const blogPostsWithLinks = blogPosts.filter(
+ (post) => originalLinksInBlogs[post.id],
+ );
+
+ const feedsWithLinks = await feedDefaultCreateFeedItems({
+ blogPosts: blogPostsWithLinks,
+ siteConfig,
+ outDir,
+ });
+
+ feedsWithLinks.forEach((feed) => {
+ const $ = cheerioLoad(feed.content ?? '');
+ const linksInFeed = $('a')
+ .map((_, elm) => elm.attribs.href)
+ .toArray();
+ const idOfBlogPost = feed.id!.replace(
+ new URL(`${siteConfig.baseUrl}blog`, siteConfig.url).href,
+ '',
+ );
+ const originalLinksInBlog = originalLinksInBlogs[idOfBlogPost];
+ const {permalink = ''} =
+ blogPostsWithLinks.find((post) => post.id === idOfBlogPost)?.metadata ||
+ {};
+
+ originalLinksInBlog!.forEach((originalLinkInBlog, idx) => {
+ const linkToTest = isFullAbsolutePath(originalLinkInBlog)
+ ? originalLinkInBlog
+ : new URL(originalLinkInBlog, new URL(permalink, siteConfig.url))
+ .href;
+
+ expect(linkToTest).toEqual(linksInFeed[idx]);
+ });
+ });
+ expect(
+ fsMock.mock.calls.map((call) => call[1] as string),
+ ).toMatchSnapshot();
+ fsMock.mockClear();
+ });
+});
diff --git a/packages/docusaurus-plugin-content-blog/src/feed.ts b/packages/docusaurus-plugin-content-blog/src/feed.ts
index 9efc84e16ccf..df0da93f5ce5 100644
--- a/packages/docusaurus-plugin-content-blog/src/feed.ts
+++ b/packages/docusaurus-plugin-content-blog/src/feed.ts
@@ -70,7 +70,7 @@ async function generateBlogFeed({
return feed;
}
-async function defaultCreateFeedItems({
+export async function defaultCreateFeedItems({
blogPosts,
siteConfig,
outDir,
diff --git a/website/_dogfooding/_blog tests/2023-07-19-a.mdx b/website/_dogfooding/_blog tests/2023-07-19-a.mdx
new file mode 100644
index 000000000000..16cdfd88d675
--- /dev/null
+++ b/website/_dogfooding/_blog tests/2023-07-19-a.mdx
@@ -0,0 +1,9 @@
+---
+title: 'Test if href in feed resolved correctly'
+---
+
+[absolute full url](https://github.com/facebook/docusaurus)
+
+[absolute url with implicit domain name](/tests/blog/2023/07/19/b)
+
+[relative url](2023-07-19-b.mdx)
diff --git a/website/_dogfooding/_blog tests/2023-07-19-b.mdx b/website/_dogfooding/_blog tests/2023-07-19-b.mdx
new file mode 100644
index 000000000000..d6a54897045a
--- /dev/null
+++ b/website/_dogfooding/_blog tests/2023-07-19-b.mdx
@@ -0,0 +1 @@
+# Test Relative Path
![](\\"/foo/img/docusaurus.png\\")