activestorage-hotcell-client 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8dd7e3b5529e37a8a93b3dbb7212b1ff8c12de00c5b17cdd6639185e6325c5e8
-  data.tar.gz: 4d53ee17c8de35aa1fd2c6ff81d70af20003fcc65247ef533eb96c370c1d3aff
+  metadata.gz: 4abc5bc93c3eb1b9370c321983b0038e9cba28203e0610b29b0b5d838eece2df
+  data.tar.gz: 2b53ad5e9304c42c0820c879e9beb5faa74db34d050bb49bc02f5a074b80f9ce
 SHA512:
-  metadata.gz: 7f8c5e3d865d5e6f1c25fc08f9f88962d97c5de5fc452ba90762e72b4e7de7772b7f292def58ea3f1d9eb929653974e28c0e6e99b3a420bf83176164110d9a6e
-  data.tar.gz: f7f9b4a83c1f0f2a984adba8d4c1343d5474b86514649a6353a255ba1567c08a0b842ffeaecacefacf2da11a5f1ed24ac2e820088cc2f8ca1ead602b3a3da121
+  metadata.gz: 7f985858d5827fdb6ddcafee076136a6a37a6bcdcb2f07fa5495b3dbe8a9fa2e3b6f29093add11255d4bf94214fda2e025d5caecc9e4fed10c61e123fcecf8cc
+  data.tar.gz: 5884cc6183a3513fab8a27543d24a3546038407e33667c82366e328a5ed84179486076a549281436732c31fecc47baf5abc95f76b4a05d2719ef4168caebb3a7

data/README.md

@@ -1,3 +1,3 @@
 # activestorage-hotcell-client
 
-Part of [HotCell](https://github.com/basecamp/hotcell). See the repository README.
+Part of [Hot Cell](https://github.com/basecamp/hotcell). See the repository README.

data/lib/active_storage/hot_cell/client/analyzers/analyzing.rb

@@ -16,7 +16,7 @@ module ActiveStorage
         # **Which way `metadata` fails is the whole design of the method.** The built-in vips analyzer rescues
         # every Vips::Error and returns an empty hash, which Rails then merges with `analyzed: true` — so an
         # undecodable image is recorded as successfully analyzed, forever, and nothing ever re-enqueues
-        # AnalyzeJob. That is right for a permanent verdict and catastrophic for a transient one.
+        # AnalyzeJob. That is right for a permanent failure and catastrophic for a transient one.
         #
         # So a permanent failure follows the built-in behaviour and lets the blob be marked analyzed, with the
         # reason written to the log so it can be re-decided later against a newer library. A transient failure

data/lib/active_storage/hot_cell/client/analyzers/video.rb

@@ -10,7 +10,7 @@ module ActiveStorage
     module Client
       module Analyzers
         # Rails' VideoAnalyzer shells out to ffprobe inside the application process. Moving ffprobe into a
-        # cell means this has to move with it, or an application that adopts hotcell still analyzes media in
+        # cell means this has to move with it, or an application that adopts Hot Cell still analyzes media in
         # its own process and cannot take ffprobe out of its image — the incomplete move for exactly the
         # media type a cell exists to isolate.
         #

data/lib/active_storage/hot_cell/client/railtie.rb

@@ -9,11 +9,15 @@ module ActiveStorage
       # reads those from config and there is no way for a gem to set them that the engine does not later
       # overwrite. Everything else this gem needs is done here.
       class Railtie < ::Rails::Railtie
-        # to_prepare rather than after_initialize, because it runs again on every code reload and the job
-        # classes do not survive one. See retry_transient_failures!.
-        initializer "active_storage.hot_cell.client.retry_transient_failures" do |app|
-          app.config.to_prepare do
-            ActiveStorage::HotCell::Client.retry_transient_failures!
+        # on_load rather than to_prepare, because to_prepare runs while the application is initializing, and
+        # loading a job there loads Active Job, which Rails' guard_load_hooks reports when eager loading is off.
+        # on_load also runs again each time a job is reloaded, and never for a job the application's Rails
+        # version does not have.
+        initializer "active_storage.hot_cell.client.retry_transient_failures" do
+          ActiveStorage::HotCell::Client::JOBS.each do |name|
+            Rails.autoloaders.main.on_load(name) do |job|
+              ActiveStorage::HotCell::Client.retry_transient_failures! job
+            end
           end
         end
 

data/lib/active_storage/hot_cell/client/transformers/transforming.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "tempfile"
+require "marcel"
 require "active_storage"
 require "active_support/core_ext/class/attribute"
 require "active_support/core_ext/hash/deep_transform_values"
@@ -33,7 +34,7 @@ module ActiveStorage
               output = Tempfile.new([ "hotcell", ".#{format}" ], binmode: true)
 
               begin
-                convert file, output, format: format.to_s, operations: stringified(transformations)
+                convert file, output, format: canonical(format), operations: stringified(transformations)
                 output.tap(&:rewind)
               rescue StandardError
                 output.close!
@@ -41,6 +42,20 @@ module ActiveStorage
               end
             end
 
+            # Rails names a web image's variant format after its upload's extension, so a JPEG uploaded as
+            # `photo.jfif` asks for `jfif`. ImageMagick has no coder for `jfif`, `jif` or `jfi`, and libvips has no
+            # saver for the last two (#84). So a web image's format crosses as its content type's canonical
+            # extension, the one Rails itself names when the upload's extension does not match.
+            def canonical(format)
+              content_type = Marcel::MimeType.for(extension: format.to_s)
+
+              if ActiveStorage.web_image_content_types.include?(content_type)
+                Marcel::Magic.new(content_type).extensions.first
+              else
+                format.to_s
+              end
+            end
+
             # Both handles are reopened by path, narrowly, and that is the protocol rather than fussiness. Rails
             # hands out Tempfiles, which are read-write; an input descriptor must be read-only and an output
             # write-only. An access mode is fixed at open, so a cell handed the wrong one cannot narrow it — it can

data/lib/active_storage/hot_cell/client/version.rb

@@ -3,7 +3,7 @@
 module ActiveStorage
   module HotCell
     module Client
-      VERSION = "1.0.0"
+      VERSION = "1.2.0"
     end
   end
 end

data/lib/active_storage/hot_cell/client.rb

@@ -28,10 +28,11 @@ module ActiveStorage
     module Client
       # These four jobs declare `retry_on ActiveStorage::IntegrityError` and nothing else, and ActiveJob does
       # not retry by default. They should retry the transient class too: `capacity` most obviously, and every
-      # other transient verdict. The policy matches the one they already declare, so a cell failure and an
+      # other transient failure. The policy matches the one they already declare, so a cell failure and an
       # integrity failure back off the same way.
       #
-      # Which of these classes exists depends on the Rails version, so a name that is not loaded is skipped.
+      # Which of these classes exists depends on the Rails version. A name the application does not have is
+      # never loaded, so the retry is never applied to it.
       JOBS = %w[
         ActiveStorage::AnalyzeJob
         ActiveStorage::CreateVariantsJob
@@ -51,22 +52,18 @@ module ActiveStorage
                   Operations::Previewers::Video::Ffmpeg ].freeze
 
       class << self
-        # The railtie calls this from a to_prepare block. Applied once at boot it would not survive a code
+        # The railtie calls this each time one of the JOBS loads. Applied once it would not survive a code
         # reload: a gem engine's app/jobs is in the reloadable autoloader, so these classes are discarded and
         # redefined, and the retry would silently disappear after the first file save in development.
         #
         # Every registered cell contributes its transient class, because the documented multi-cell
         # arrangement routes PreviewVideo to a cell of its own and each cell names its own class. A cell not
-        # yet registered contributes nothing rather than raising: this runs on the boot where the application
-        # has bundled the gem and not yet written the initializer, and that boot has to succeed for the
-        # rollout to take two deploys rather than one.
-        def retry_transient_failures!(jobs: JOBS)
-          transients = CLIENTS.filter_map { |client| client.cell.transient if client.registered? }
-                              .uniq
-          return [] if transients.empty?
-
-          jobs.filter_map(&:safe_constantize)
-              .each { |job| job.retry_on(*transients, **RETRY) }
+        # yet registered contributes nothing rather than raising: this runs in an application that has
+        # bundled the gem and not yet written the initializer, and that boot has to succeed for the rollout
+        # to take two deploys rather than one.
+        def retry_transient_failures!(job)
+          transients = CLIENTS.filter_map { |client| client.cell.transient if client.registered? }.uniq
+          job.retry_on(*transients, **RETRY) if transients.any?
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activestorage-hotcell-client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Mike Dalessio
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: activestorage
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +39,7 @@ dependencies:
         version: 8.2.0.alpha
 description: |
   Drop-in replacements for Active Storage's variant processor, analyzers, and previewers. Configure
-  Rails with these classes and variants, image and media analysis, and previews run in a HotCell
+  Rails with these classes and variants, image and media analysis, and previews run in a Hot Cell
   container instead of in the application process.
 email:
 - mike@37signals.com
@@ -77,8 +77,8 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/basecamp/hotcell
-  source_code_uri: https://github.com/basecamp/hotcell/tree/v1.0.0/activestorage-hotcell-client
-  changelog_uri: https://github.com/basecamp/hotcell/blob/v1.0.0/CHANGELOG.md
+  source_code_uri: https://github.com/basecamp/hotcell/tree/v1.2.0/activestorage-hotcell-client
+  changelog_uri: https://github.com/basecamp/hotcell/blob/v1.2.0/CHANGELOG.md
   documentation_uri: https://basecamp.github.io/hotcell/
   bug_tracker_uri: https://github.com/basecamp/hotcell/issues
   rubygems_mfa_required: 'true'
@@ -98,5 +98,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.6
 specification_version: 4
-summary: Point Active Storage's transformer, analyzer, and previewers at a HotCell.
+summary: Point Active Storage's transformer, analyzer, and previewers at a Hot Cell.
 test_files: []