-
Notifications
You must be signed in to change notification settings - Fork 0
Refactor duplicated error handling and validation utilities #126
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
Open
Copilot
wants to merge
4
commits into
develop
Choose a base branch
from
copilot/refactor-duplicate-code
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
100d3bc
docs: Add code duplication analysis
Copilot d29a9a2
refactor: Extract duplicated error handling and validation utilities
Copilot a76ff45
fix: Add proper type checking for NodeJS error code property
Copilot 9f5d63c
fix: Make validation error formatting parameter explicit for consistency
Copilot 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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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,108 @@ | ||
| /** | ||
| * Tests for loader utilities | ||
| */ | ||
|
|
||
| import { describe, it, expect } from 'vitest'; | ||
| import { filePathToUrl, formatValidationErrors } from './loader-utils.js'; | ||
| import type { ValidationResult } from 'ums-lib'; | ||
|
|
||
| describe('loader-utils', () => { | ||
| describe('filePathToUrl', () => { | ||
| it('should convert file path to file URL', () => { | ||
| const filePath = '/path/to/module.ts'; | ||
| const url = filePathToUrl(filePath); | ||
|
|
||
| expect(url).toContain('file://'); | ||
| expect(url).toContain('module.ts'); | ||
| }); | ||
|
|
||
| it('should handle paths with special characters', () => { | ||
| const filePath = '/path/to/my module.ts'; | ||
| const url = filePathToUrl(filePath); | ||
|
|
||
| expect(url).toContain('file://'); | ||
| expect(url).toContain('my%20module.ts'); | ||
| }); | ||
| }); | ||
|
|
||
| describe('formatValidationErrors', () => { | ||
| it('should format validation errors with paths', () => { | ||
| const validation: ValidationResult = { | ||
| valid: false, | ||
| errors: [ | ||
| { path: 'metadata.name', message: 'Name is required' }, | ||
| { path: 'components[0]', message: 'Invalid component' } | ||
| ], | ||
| warnings: [] | ||
| }; | ||
|
|
||
| const result = formatValidationErrors(validation); | ||
| expect(result).toBe('metadata.name: Name is required; components[0]: Invalid component'); | ||
| }); | ||
|
|
||
| it('should use default path for errors without path', () => { | ||
| const validation: ValidationResult = { | ||
| valid: false, | ||
| errors: [ | ||
| { message: 'Invalid structure' } | ||
| ], | ||
| warnings: [] | ||
| }; | ||
|
|
||
| const result = formatValidationErrors(validation); | ||
| expect(result).toBe('module: Invalid structure'); | ||
| }); | ||
|
|
||
| it('should use custom default path', () => { | ||
| const validation: ValidationResult = { | ||
| valid: false, | ||
| errors: [ | ||
| { message: 'Invalid structure' } | ||
| ], | ||
| warnings: [] | ||
| }; | ||
|
|
||
| const result = formatValidationErrors(validation, 'persona'); | ||
| expect(result).toBe('persona: Invalid structure'); | ||
| }); | ||
|
|
||
| it('should handle mixed errors with and without paths', () => { | ||
| const validation: ValidationResult = { | ||
| valid: false, | ||
| errors: [ | ||
| { path: 'id', message: 'ID is required' }, | ||
| { message: 'Missing schema version' }, | ||
| { path: 'version', message: 'Invalid version format' } | ||
| ], | ||
| warnings: [] | ||
| }; | ||
|
|
||
| const result = formatValidationErrors(validation); | ||
| expect(result).toBe('id: ID is required; module: Missing schema version; version: Invalid version format'); | ||
| }); | ||
|
|
||
| it('should handle single error', () => { | ||
| const validation: ValidationResult = { | ||
| valid: false, | ||
| errors: [ | ||
| { path: 'id', message: 'ID is required' } | ||
| ], | ||
| warnings: [] | ||
| }; | ||
|
|
||
| const result = formatValidationErrors(validation); | ||
| expect(result).toBe('id: ID is required'); | ||
| }); | ||
|
|
||
| it('should handle empty errors array', () => { | ||
| const validation: ValidationResult = { | ||
| valid: true, | ||
| errors: [], | ||
| warnings: [] | ||
| }; | ||
|
|
||
| const result = formatValidationErrors(validation); | ||
| expect(result).toBe(''); | ||
| }); | ||
| }); | ||
| }); |
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,30 @@ | ||
| /** | ||
| * Shared utilities for module and persona loaders | ||
| */ | ||
|
|
||
| import { pathToFileURL } from 'node:url'; | ||
| import type { ValidationResult } from 'ums-lib'; | ||
|
|
||
| /** | ||
| * Convert file path to file URL for dynamic import | ||
| * @param filePath - Absolute path to file | ||
| * @returns File URL string suitable for dynamic import | ||
| */ | ||
| export function filePathToUrl(filePath: string): string { | ||
| return pathToFileURL(filePath).href; | ||
| } | ||
|
|
||
| /** | ||
| * Format validation errors into a single error message | ||
| * @param validation - Validation result from ums-lib | ||
| * @param defaultPath - Default path to use if error has no path (e.g., 'module', 'persona') | ||
| * @returns Formatted error message string | ||
| */ | ||
| export function formatValidationErrors( | ||
| validation: ValidationResult, | ||
| defaultPath = 'module' | ||
| ): string { | ||
| return validation.errors | ||
| .map(e => `${e.path ?? defaultPath}: ${e.message}`) | ||
| .join('; '); | ||
| } |
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 error message construction still uses the inline pattern that was supposed to be refactored. Consider extracting this to a helper function like
getErrorMessage()in the CLI package to maintain consistency with the stated goal of eliminating duplicated error handling patterns. The same pattern exists in several other SDK files (high-level-api.ts lines 142 and 196, module-discovery.ts line 91, standard-library.ts line 60, build-orchestrator.ts line 163).