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: Throw exception on version mismatch #9380

Closed
wants to merge 2 commits into from
Closed

feat: Throw exception on version mismatch #9380

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2abc3b
feat: Throw exception on version mismatch
shubhankar-mern Oct 7, 2023
3ff4662
eaft added the test cases for version mismatch
shubhankar-mern Oct 7, 2023
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
2 changes: 1 addition & 1 deletion packages/docusaurus/src/server/__tests__/siteMetadata.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ describe('loadSiteMetadata', () => {
] as LoadedPlugin[],
siteDir: path.join(__dirname, '__fixtures__/siteMetadata'),
}),
).resolves.toMatchSnapshot();
).rejects.toThrow('Docusaurus plugin versions mismatch detected.');
expect(consoleMock.mock.calls[0]![0]).toMatchInlineSnapshot(`
"[ERROR] Invalid docusaurus-plugin-content-docs version 1.0.0.
All official @docusaurus/* packages should have the exact same version as @docusaurus/core (<CURRENT_VERSION>).
Expand Down
9 changes: 9 additions & 0 deletions packages/docusaurus/src/server/siteMetadata.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ export async function getPluginVersion(
*/
function checkDocusaurusPackagesVersion(siteMetadata: SiteMetadata) {
const {docusaurusVersion} = siteMetadata;
let mismatchDetected: boolean = false;
Object.entries(siteMetadata.pluginVersions).forEach(
([plugin, versionInfo]) => {
if (
Expand All @@ -82,13 +83,21 @@ function checkDocusaurusPackagesVersion(siteMetadata: SiteMetadata) {
versionInfo.version &&
versionInfo.version !== docusaurusVersion
) {
// change mismatched to true
mismatchDetected = true;
// Should we throw instead? It still could work with different versions
logger.error`Invalid name=${plugin} version number=${versionInfo.version}.
All official @docusaurus/* packages should have the exact same version as @docusaurus/core (number=${docusaurusVersion}).
Maybe you want to check, or regenerate your yarn.lock or package-lock.json file?`;
}
},
);
if (mismatchDetected) {
// Throw an exception or exit with a non-zero exit code.
throw new Error('Docusaurus plugin versions mismatch detected.');
// We can exit the process with a non-zero code:
// process.exit(1);
}
}

export async function loadSiteMetadata({
Expand Down