-
Notifications
You must be signed in to change notification settings - Fork 45
fix: add file-context to generator parse errors #688
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
Closed
Closed
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| import assert from 'node:assert/strict'; | ||
| import { describe, it, mock } from 'node:test'; | ||
|
|
||
| // Mock dependencies | ||
| const mockReadFile = mock.fn(); | ||
| mock.module('node:fs/promises', { | ||
| namedExports: { readFile: mockReadFile }, | ||
| }); | ||
|
|
||
| // Mock other internal modules as needed | ||
| // From src/generators/ast/__tests__/ to src/utils/configuration/index.mjs is ../../../utils/configuration/index.mjs | ||
| mock.module('../../../utils/configuration/index.mjs', { | ||
| defaultExport: () => ({ ast: { input: 'docs/*.md' } }), | ||
| }); | ||
|
|
||
| const { processChunk } = await import('../generate.mjs'); | ||
|
|
||
| describe('ast/generate.mjs error handling', () => { | ||
| it('should wrap readFile errors with filename, original message, and cause', async () => { | ||
| const error = new Error('FS_ERROR'); | ||
| mockReadFile.mock.mockImplementation(async () => { | ||
| throw error; | ||
| }); | ||
|
|
||
| const inputSlice = ['test.md']; | ||
| const itemIndices = [0]; | ||
|
|
||
| await assert.rejects( | ||
| async () => await processChunk(inputSlice, itemIndices), | ||
| { | ||
| name: 'Error', | ||
| message: 'Failed to process test.md: FS_ERROR', | ||
| cause: error, | ||
| } | ||
| ); | ||
| }); | ||
| }); |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| import assert from 'node:assert/strict'; | ||
| import { describe, it, mock } from 'node:test'; | ||
|
|
||
| // Mock dependencies | ||
| const mockParseApiDoc = mock.fn(); | ||
| mock.module('../utils/parse.mjs', { | ||
| namedExports: { parseApiDoc: mockParseApiDoc }, | ||
| }); | ||
|
|
||
| // Mock configuration and URL utils | ||
| // From src/generators/metadata/__tests__/ to src/utils/ is ../../../utils/ | ||
| mock.module('../../../utils/configuration/index.mjs', { | ||
| defaultExport: () => ({ metadata: { typeMap: 'typeMap.json' } }), | ||
| }); | ||
| mock.module('../../../utils/url.mjs', { | ||
| namedExports: { importFromURL: async () => ({}) }, | ||
| }); | ||
|
|
||
| const { processChunk } = await import('../generate.mjs'); | ||
|
|
||
| describe('metadata/generate.mjs error handling', () => { | ||
| it('should wrap parsing errors with filename, original message, and cause', async () => { | ||
| const error = new Error('PARSE_ERROR'); | ||
| mockParseApiDoc.mock.mockImplementation(() => { | ||
| throw error; | ||
| }); | ||
|
|
||
| const fullInput = [{ file: { path: 'docs/api/fs.md', basename: 'fs.md' } }]; | ||
| const itemIndices = [0]; | ||
|
|
||
| await assert.rejects( | ||
| async () => await processChunk(fullInput, itemIndices, {}), | ||
| { | ||
| name: 'Error', | ||
| message: 'Failed to parse metadata for docs/api/fs.md: PARSE_ERROR', | ||
| cause: error, | ||
| } | ||
| ); | ||
| }); | ||
|
|
||
| it('should fallback to basename or unknown if path is missing', async () => { | ||
| const error = new Error('PARSE_ERROR'); | ||
| mockParseApiDoc.mock.mockImplementation(() => { | ||
| throw error; | ||
| }); | ||
|
|
||
| const fullInput = [{ file: { basename: 'fs.md' } }]; | ||
|
|
||
| await assert.rejects(async () => await processChunk(fullInput, [0], {}), { | ||
| name: 'Error', | ||
| message: 'Failed to parse metadata for fs.md: PARSE_ERROR', | ||
| cause: error, | ||
| }); | ||
| }); | ||
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fixed in bbc3ecf. |
||
| }); | ||
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 |
|---|---|---|
|
|
@@ -14,7 +14,15 @@ export async function processChunk(fullInput, itemIndices, typeMap) { | |
| const results = []; | ||
|
|
||
| for (const idx of itemIndices) { | ||
| results.push(...parseApiDoc(fullInput[idx], typeMap)); | ||
| const input = fullInput[idx]; | ||
| try { | ||
| results.push(...parseApiDoc(input, typeMap)); | ||
| } catch (err) { | ||
| const path = | ||
| input?.file?.path ?? input?.file?.basename ?? '<unknown file>'; | ||
| const message = `Failed to parse metadata for ${path}: ${err.message ?? err}`; | ||
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fixed in bbc3ecf. |
||
| throw new Error(message, { cause: err }); | ||
| } | ||
| } | ||
|
|
||
| return results; | ||
|
|
||
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.
Fixed in bbc3ecf.