refactor(functions/v2/imagemagick): migrate from gm to sharp#4289
Closed
angelcaamal wants to merge 2 commits intoGoogleCloudPlatform:mainfrom
Closed
refactor(functions/v2/imagemagick): migrate from gm to sharp#4289angelcaamal wants to merge 2 commits intoGoogleCloudPlatform:mainfrom
angelcaamal wants to merge 2 commits intoGoogleCloudPlatform:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Code Review
This pull request migrates the image processing logic from the gm library to sharp, updating dependencies and test configurations accordingly. The review feedback identifies a potential resource leak where temporary files are not deleted if an error occurs during processing; it is recommended to use a try...finally block to ensure cleanup.
Comment on lines
+78
to
+101
| try { | ||
| await sharp(tempLocalPath).blur(16).toFile(tempLocalBlurredPath); | ||
|
|
||
| console.log(`Blurred image: ${file.name}`); | ||
| } catch (err) { | ||
| console.error('Failed to blur image.', err); | ||
| throw err; | ||
| } | ||
|
|
||
| // Upload result to a different bucket, to avoid re-triggering this function. | ||
| const blurredBucket = storage.bucket(blurredBucketName); | ||
|
|
||
| // Upload the Blurred image back into the bucket. | ||
| const gcsPath = `gs://${blurredBucketName}/${file.name}`; | ||
| try { | ||
| await blurredBucket.upload(tempLocalPath, {destination: file.name}); | ||
| await blurredBucket.upload(tempLocalBlurredPath, {destination: file.name}); | ||
| console.log(`Uploaded blurred image to: ${gcsPath}`); | ||
| } catch (err) { | ||
| throw new Error(`Unable to upload blurred image to ${gcsPath}: ${err}`); | ||
| } | ||
|
|
||
| // Delete the temporary file. | ||
| return fs.unlink(tempLocalPath); | ||
| await fs.unlink(tempLocalPath); | ||
| return await fs.unlink(tempLocalBlurredPath); |
Contributor
There was a problem hiding this comment.
Temporary files created in the /tmp directory should be deleted even if an error occurs during processing. Currently, if sharp or upload fails, the unlink calls are skipped, which can lead to memory exhaustion in the Cloud Function environment. Wrapping the processing logic in a try...finally block ensures cleanup.
try {
try {
await sharp(tempLocalPath).blur(16).toFile(tempLocalBlurredPath);
console.log('Blurred image: ' + file.name);
} catch (err) {
console.error('Failed to blur image.', err);
throw err;
}
// Upload result to a different bucket, to avoid re-triggering this function.
const blurredBucket = storage.bucket(blurredBucketName);
// Upload the Blurred image back into the bucket.
const gcsPath = 'gs://' + blurredBucketName + '/' + file.name;
try {
await blurredBucket.upload(tempLocalBlurredPath, {destination: file.name});
console.log('Uploaded blurred image to: ' + gcsPath);
} catch (err) {
throw new Error('Unable to upload blurred image to ' + gcsPath + ': ' + err);
}
} finally {
// Delete the temporary files.
await Promise.allSettled([
fs.unlink(tempLocalPath),
fs.unlink(tempLocalBlurredPath),
]);
}
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Fixes Internal: b/503435756
Note: Before submitting a pull request, please open an issue for discussion if you are not associated with Google.
Checklist
npm test(see Testing)npm run lint(see Style)GoogleCloudPlatform/nodejs-docs-samples. Not a fork.