-
Notifications
You must be signed in to change notification settings - Fork 104
fix(shared): resolve docusaurus/mermaid/elk dependency and add test #2324
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.
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
34 changes: 34 additions & 0 deletions
34
shared/src/docify/template-bundles/docusaurus/package.spec.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| import { describe, it, expect, afterAll } from 'vitest'; | ||
| import { copyFileSync, mkdtempSync, rmSync } from 'fs'; | ||
| import { join } from 'path'; | ||
| import { tmpdir } from 'os'; | ||
| import { spawn } from 'child_process'; | ||
|
|
||
| const TEMPLATE_PACKAGE_JSON = join(__dirname, 'package.json'); | ||
|
|
||
| // The purpose of this test is to ensure that the docusaurus template bundle's dependencies can be | ||
| // resolved. This is a long-running test because it involves "npm install", which can take some time. | ||
| // | ||
| // Without this test, we might not discover peer dependency conflicts until after a release is produced | ||
| // and a user tries to use the template bundle. | ||
| describe('docusaurus template bundle dependencies', () => { | ||
| const tmpDir = mkdtempSync(join(tmpdir(), 'calm-docusaurus-')); | ||
|
|
||
| afterAll(() => { | ||
| rmSync(tmpDir, { recursive: true, force: true }); | ||
| }); | ||
|
|
||
| it('should resolve without peer dependency conflicts (long running test)', async () => { | ||
| copyFileSync(TEMPLATE_PACKAGE_JSON, join(tmpDir, 'package.json')); | ||
|
|
||
| const exitCode = await new Promise<number>((resolve, reject) => { | ||
| const stderr: string[] = []; | ||
| const proc = spawn('npm', ['install', '--package-lock-only', '--prefix', tmpDir]); | ||
| proc.stderr?.on('data', (chunk: Buffer) => stderr.push(chunk.toString())); | ||
| proc.on('close', (code) => resolve(code ?? 1)); | ||
| proc.on('error', reject); | ||
| }); | ||
|
|
||
| expect(exitCode).toBe(0); | ||
| }, 120_000); | ||
| }); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This test shells out to
npm install, which by default may run audit/fund requests and (depending on npm behavior) lifecycle scripts, making the test slower/flakier and potentially executing third‑party scripts during CI. Consider adding--no-audit,--no-fund, and--ignore-scripts, and run the command withcwdset totmpDir(instead of relying on--prefix) so it’s fully isolated; also consider usingnpm.cmdon Windows to keep the test runnable for contributors.