fix: improve type safety and modernize image optimization code #243
Conversation
WalkthroughThe pull request introduces refinements to the TypeScript configuration and image optimization module in the Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🔭 Outside diff range comments (1)
_api/src/optimizeImages.ts (1)
Line range hint
61-76: Add cleanup for temporary files in error cases.The temporary file might not be cleaned up if an error occurs during optimization.
async function optimizePng(filePath: string): Promise<void> { const tempFilePath = `${filePath}.${uuidv4()}.tmp` + try { const image = sharp(filePath) const metadata = await image.metadata() if (metadata.height && metadata.height > PNG_MAX_HEIGHT) { await image.resize({ height: PNG_MAX_HEIGHT }).toFile(tempFilePath) } else { const data = await image.toBuffer() await sharp(data).toFile(tempFilePath) } renameSync(tempFilePath, filePath) + } catch (error) { + try { + unlinkSync(tempFilePath) + } catch {} // Ignore cleanup errors + throw error + } }
🧹 Nitpick comments (1)
_api/src/optimizeImages.ts (1)
Line range hint
18-27: Consider filtering files earlier for performance.While the type annotation is good, we could optimize the directory traversal by filtering non-image files earlier.
export async function optimizeImages(dir: string): Promise<void> { - const files = getFilePathsInDirectory(dir) + const files = getFilePathsInDirectory(dir).filter(file => + !isDirectory(file) && imageExtensions.includes(extname(file).toLowerCase()) + ) for (const file of files) { if (isDirectory(file)) { await optimizeImages(file) continue } - const ext = extname(file).toLowerCase() - if (!imageExtensions.includes(ext)) { - continue - } + const ext = extname(file).toLowerCase()
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
_api/src/optimizeImages.ts(5 hunks)_api/tsconfig.json(1 hunks)
🔇 Additional comments (3)
_api/src/optimizeImages.ts (2)
1-2: LGTM! Modern Node.js imports.The use of the
node:prefix and destructured imports from core modules improves clarity and bundle optimization.
15-15: LGTM! Improved type safety with readonly.The
readonlytype annotation prevents accidental modifications to the array._api/tsconfig.json (1)
3-9: LGTM! Modern TypeScript configuration.The configuration is well-aligned with modern TypeScript practices:
- ES2020 target is appropriate for Node.js
- Bundler moduleResolution is future-proof
- Explicit Node.js types improve type checking
| const relativePath = relative(dir, file) | ||
| console.log(`Optimized ${relativePath}: ${originalSize} bytes -> ${newSize} bytes`) | ||
|
|
||
| if (ext === ".svg" && newSize > SVG_SIZE_LIMIT) { | ||
| console.warn(chalk.yellow(`Deleting oversized SVG: ${relativePath}`)) | ||
| fs.unlinkSync(file) | ||
| unlinkSync(file) | ||
| } | ||
|
|
||
| if (ext === ".png" && newSize > PNG_SIZE_LIMIT) { | ||
| console.warn(chalk.yellow(`Deleting oversized PNG: ${relativePath}`)) | ||
| fs.unlinkSync(file) | ||
| unlinkSync(file) |
There was a problem hiding this comment.
Add error handling for file operations.
The synchronous file operations (unlinkSync) could throw errors if the file is locked or permissions are insufficient.
- unlinkSync(file)
+ try {
+ unlinkSync(file)
+ } catch (error) {
+ console.error(chalk.red(`Failed to delete ${relativePath}: ${error.message}`))
+ }📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| const relativePath = relative(dir, file) | |
| console.log(`Optimized ${relativePath}: ${originalSize} bytes -> ${newSize} bytes`) | |
| if (ext === ".svg" && newSize > SVG_SIZE_LIMIT) { | |
| console.warn(chalk.yellow(`Deleting oversized SVG: ${relativePath}`)) | |
| fs.unlinkSync(file) | |
| unlinkSync(file) | |
| } | |
| if (ext === ".png" && newSize > PNG_SIZE_LIMIT) { | |
| console.warn(chalk.yellow(`Deleting oversized PNG: ${relativePath}`)) | |
| fs.unlinkSync(file) | |
| unlinkSync(file) | |
| const relativePath = relative(dir, file) | |
| console.log(`Optimized ${relativePath}: ${originalSize} bytes -> ${newSize} bytes`) | |
| if (ext === ".svg" && newSize > SVG_SIZE_LIMIT) { | |
| console.warn(chalk.yellow(`Deleting oversized SVG: ${relativePath}`)) | |
| try { | |
| unlinkSync(file) | |
| } catch (error) { | |
| console.error(chalk.red(`Failed to delete ${relativePath}: ${error.message}`)) | |
| } | |
| } | |
| if (ext === ".png" && newSize > PNG_SIZE_LIMIT) { | |
| console.warn(chalk.yellow(`Deleting oversized PNG: ${relativePath}`)) | |
| try { | |
| unlinkSync(file) | |
| } catch (error) { | |
| console.error(chalk.red(`Failed to delete ${relativePath}: ${error.message}`)) | |
| } |
| function optimizeSvg(filePath: string): void { | ||
| const data = readFileSync(filePath, "utf8") | ||
| const result = optimize(data, { path: filePath }) | ||
| fs.writeFileSync(filePath, result.data) | ||
| writeFileSync(filePath, result.data) |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider using async operations and add error handling.
The synchronous file operations could block the event loop. Consider using async alternatives and add error handling.
-function optimizeSvg(filePath: string): void {
- const data = readFileSync(filePath, "utf8")
- const result = optimize(data, { path: filePath })
- writeFileSync(filePath, result.data)
+async function optimizeSvg(filePath: string): Promise<void> {
+ try {
+ const data = await promises.readFile(filePath, "utf8")
+ const result = optimize(data, { path: filePath })
+ await promises.writeFile(filePath, result.data)
+ } catch (error) {
+ console.error(chalk.red(`Failed to optimize SVG ${filePath}: ${error.message}`))
+ throw error
+ }
}Don't forget to add the import:
-import { readFileSync, writeFileSync, unlinkSync, renameSync } from 'node:fs'
+import { readFileSync, writeFileSync, unlinkSync, renameSync, promises } from 'node:fs'Committable suggestion skipped: line range outside the PR's diff.
Summary by CodeRabbit
Refactor
Chores