Skip to content
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

Jump to bottom

feat(v2): enable feeds by default in blog plugin #3842

Merged
merged 7 commits into from
Dec 10, 2020
Merged

feat(v2): enable feeds by default in blog plugin #3842

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
38af5f4
feat: enables feeds by default in blog
cindygu4 Nov 29, 2020
4f3199a
feat(v2): enable feeds by default
cindygu4 Nov 30, 2020
7f18351
feat(v2): enable feeds in blog plugin
cindygu4 Dec 4, 2020
9d2fe88
feat(v2): enable feeds by default in blog plugin
cindygu4 Dec 4, 2020
612687f
feat(v2): enable feeds by default in blog plugin
cindygu4 Dec 4, 2020
7ce4fec
feat(v2): enable feeds by default
cindygu4 Dec 7, 2020
0e25e50
feat(v2): enable feeds by default in blog plugin
cindygu4 Dec 7, 2020
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
25 changes: 24 additions & 1 deletion packages/docusaurus-plugin-content-blog/src/__tests__/pluginOptionSchema.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,10 @@ test('should accept valid user options', async () => {
],
};
const {value, error} = await PluginOptionSchema.validate(userOptions);
expect(value).toEqual(userOptions);
expect(value).toEqual({
...userOptions,
feedOptions: {type: ['rss', 'atom']},
});
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be added to DEFAULT_OPTIONS or userOptions?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe I tried what you suggested when trying to resolve the issue with this unit test. However, it won't pass the test unless we add feedOptions: {type: ['rss', 'atom']} here

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why exactly this test does not pass?

I can't tell you if I can't see the code, but what I'm sure of is that we 100% want to put default options in the DEFAULT_OPTIONS constant

Copy link
Contributor Author

@cindygu4 cindygu4 Nov 30, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've now added type: 'all' into DEFAULT_OPTIONS.feedOptions and this test passes. I think it would still make sense to have this line of code here since it would convert type: 'all' into the array (['rss', 'atom']) right?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cindygu4 I'd rather have type: ['rss', 'atom'] and allow the validation to work with arrays syntax, so that the default options are not "transformed"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the suggestion @slorber! @vikhramt007 and I have implemented the feature using the type: ['rss', 'atom'] as the default and allowed the validation to work with arrays. It now passes all of the unit tests :)

expect(error).toBe(undefined);
});

Expand Down Expand Up @@ -82,6 +85,26 @@ test('should convert all feed type to array with other feed type', () => {
});
});

test('should contain array with rss + atom for missing feed type', () => {
const {value} = PluginOptionSchema.validate({
feedOptions: {},
});
expect(value).toEqual({
...DEFAULT_OPTIONS,
feedOptions: {type: ['rss', 'atom']},
});
});

test('should have array with rss + atom, title for missing feed type', () => {
const {value} = PluginOptionSchema.validate({
feedOptions: {title: 'title'},
});
expect(value).toEqual({
...DEFAULT_OPTIONS,
feedOptions: {type: ['rss', 'atom'], title: 'title'},
});
});

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That looks good

Can you please add a test to ensure that type: null leads to type: null after validation? To ensure it's not using default values as a fallback?

describe('blog sidebar', () => {
test('should accept 0 sidebar count', () => {
const userOptions = {blogSidebarCount: 0};
Expand Down
11 changes: 6 additions & 5 deletions packages/docusaurus-plugin-content-blog/src/pluginOptionSchema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,13 @@ export const PluginOptionSchema = Joi.object({
DEFAULT_OPTIONS.beforeDefaultRehypePlugins,
),
feedOptions: Joi.object({
type: Joi.alternatives().conditional(
Joi.string().equal('all', 'rss', 'atom'),
{
type: Joi.alternatives()
.conditional(Joi.string().equal('all', 'rss', 'atom'), {
then: Joi.custom((val) => (val === 'all' ? ['rss', 'atom'] : [val])),
},
),
})
.empty(undefined)
.empty(null)
.default(['rss', 'atom']),
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should use DEFAULT_OPTIONS.feedOptions.type, similarly to how we handle default options in other places

Copy link
Contributor Author

@cindygu4 cindygu4 Nov 30, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi,

I've tried setting DEFAULT_OPTIONS.feedOptions.type to 'all' as well as ['rss', 'atom'] and both give me these errors
Screen Shot 2020-11-30 at 9 19 12 AM
Screen Shot 2020-11-30 at 9 23 20 AM

Also, setting DEFAULT_OPTIONS.feedOptions.type to ['rss', 'atom'] also gives me an additional error [ValidationError: "feedOptions.type" does not match any of the allowed types].

Do you have any suggestions as to how to resolve these? The only way I've found to make it work is by adding the empty() and default() methods within the Joi object.

Thanks!

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't debug remotely code that I can't fully see, You'd rather commit your failed attempt and ask a new review.

Also, setting DEFAULT_OPTIONS.feedOptions.type to ['rss', 'atom'] also gives me an additional error [ValidationError: "feedOptions.type" does not match any of the allowed types].

You should make the validator accept an array for this to work, currently it only accept strings

Copy link
Contributor Author

@cindygu4 cindygu4 Nov 30, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok yeah, I'll make another commit with the failed attempt.

title: Joi.string().allow(''),
description: Joi.string().allow(''),
copyright: Joi.string(),
Expand Down