Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Load MiniMagick before use #12754

Merged
merged 1 commit into from
Aug 9, 2024
Merged

Load MiniMagick before use #12754

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions app/models/enterprise.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# frozen_string_literal: false

require "mini_magick"

class Enterprise < ApplicationRecord
SELLS = %w(unspecified none own any).freeze
ENTERPRISE_SEARCH_RADIUS = 100
Expand Down
2 changes: 2 additions & 0 deletions app/models/spree/image.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# frozen_string_literal: true

require "mini_magick"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The alternative is to rescue StandardError which may be more robust and agnostic of what kind of problem is arising when processing an image.

Usually it's good practice to rescue specific errors. But if an unknown error breaks the shop page instead of not displaying an image then that's a bad consequence in production as well.

I want to merge this pull request today to include it in the release. But let's discuss other options, @openfoodfoundation/developers.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that using specific errors for rescuing should be the practice, however, I think it should be the case where we want to handle different errors differently.

If we need to handle each error similarly, then the StandardError rescue seems better with some logging or non-code-breaking alerts. In this case, we are rescuing from 3 different errors I guess, but each is handled in a same way. We could shorten this by just rescuing StandardError. In image processing, many cases may break the code and we may again face a similar issue in the future. That may have been handled by the MiniMagick::Error rescue. But yes, like you said StandardError may be more agnostic to handling these image processing cases.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree it's worth breaking our rule of "always rescue specific errors" for this case. We are still notifying to Bugsnag so it won't be hiding any new types of errors.

Do we need to differentiate between known errors (ActiveStorage::Error, MiniMagick::Error, ActionView::Template::Error) and new error types?
I think not. Whatever the error type, if it happens infrequently we can probably ignore it. If it is impacting on users and they report it, we can investigate. Or if we see a huge spike in bugsnag, we can investigate it.

So I'm happy to switch to just StandardError. But I would suggest we use at least one of these known error types in the spec (if not already).


module Spree
class Image < Asset
has_one_attached :attachment, service: image_service do |attachment|
Expand Down
Loading