hotcell-core 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cee7ec2d2cf66191fe36c65ee799ebead567515b4d8815fd194ee2f4e21b2e68
-  data.tar.gz: efbf59f1ee0b4579d8e7d98a65200eed5bc6b5546782a403216784fb5f8075cd
+  metadata.gz: 18422ba38ab889459be6c0b8527f42de192c5a6454dee63a23ac3298cc1610ec
+  data.tar.gz: 68cbf455e50633d16d0f620ce95af4c7315e42106a654440fddfb1136291255f
 SHA512:
-  metadata.gz: 4ab338d0b9c68b834e1e70021013bb8a7f1f3335c1c7a49a5e5e59ce44d0009cd5ddc72be724439c29902e940c6924ba58c45b24770d920656e9ec8e232c6b5e
-  data.tar.gz: 283063e9416cbdb6ea1dd9ba103adc727ce3a478fe9f5f03918e9bbc62537d8f2f63167dbefa3a4999cfa0841d9ad4ed5e6f279700b0a6179947f6239ec5b2a6
+  metadata.gz: fe2050dbea7ceb1a89393498fefe0f14f50510d8623decfc2b73221afc9c6b519f4aea95927433f2ba44262b72d19df043c071fd61dc94aafb25fd6dda53a454
+  data.tar.gz: d3e737603771d2d89cc5f94f01ffb73145533319817fecced75fe642e4a8dcc3011239374cfee1b15049ed02374e66057266079a4f674799a6be9f91f4834661

data/README.md

@@ -1,3 +1,3 @@
 # hotcell-core
 
-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/hot_cell/codes.rb

@@ -82,10 +82,10 @@ module HotCell
     #
     # So the supervisor never infers either of them from a signal. They are decided in the worker, which is
     # the process that holds the request: `memory` when it catches NoMemoryError itself, and `fsize` when a
-    # write of its own returns EFBIG. See Worker#disarm_file_size_signal for why the file-size verdict has
+    # write of its own returns EFBIG. See Worker#disarm_file_size_signal for why the `fsize` failure has
     # to be earned that way rather than read off a wait status.
     #
-    # That is a narrower guarantee than "a permanent verdict cannot be forged", and the difference matters.
+    # That is a narrower guarantee than "a permanent failure cannot be forged", and the difference matters.
     # It removes the supervisor as an instrument: a sibling's signal no longer travels through a wait status
     # into someone else's blob. It does nothing about a cell that has been compromised outright and answers
     # a connection itself — `from_wire` believes a `permanent` boolean off the wire, and a worker that stole

data/lib/hot_cell/core/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HotCell
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/hot_cell/descriptors.rb

@@ -117,7 +117,7 @@ module HotCell
     # Copies the bytes onto the worker's own scratch on the first call and returns the filename. This is the
     # fallback, for an operation that genuinely needs a real file. Prefer `fd_path`, which reads the
     # descriptor in place: staging is a write, so RLIMIT_FSIZE bounds it, and an input larger than the
-    # operation's file_size dies here as a permanent `fsize` verdict — a ceiling Rails does not have. The
+    # operation's file_size dies here as a permanent `fsize` failure — a ceiling Rails does not have. The
     # Active Storage operations all read `fd_path` for exactly that reason; nothing should reach for `path`
     # without a specific need for a distinct on-disk copy.
     #

data/lib/hot_cell/errors.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 module HotCell
-  # What this gem raises when a call is wrong, as distinct from a cell's verdict on a conversion.
+  # What this gem raises when a call is wrong, as distinct from a cell's failure.
   #
   # These must be raised outside the client's transport rescue. An application injects its own
-  # exception classes for a cell's verdicts, and if one of those descends from IOError then a bad call
+  # exception classes for a cell's failures, and if one of those descends from IOError then a bad call
   # swallowed by the transport rescue comes back as a socket failure and gets retried forever.
   class Error < StandardError; end
 
@@ -24,7 +24,7 @@ module HotCell
   # cannot hold its limits and a client that cannot classify a failure are both worse discovered in traffic.
   class ConfigurationError < Error; end
 
-  # A peer that stopped mid-message. Distinct from a cell answering `timeout`, which is a verdict: this is
+  # A peer that stopped mid-message. Distinct from a cell answering `timeout`, which is a failure: this is
   # the caller's own deadline passing with the response incomplete.
   class ReadTimeout < Error; end
 

data/lib/hot_cell/failure.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module HotCell
-  # A cell's verdict on a request that did not succeed.
+  # A cell's answer to a request that did not succeed.
   #
   # The message is untrusted and it outlives the request. It comes out of a worker that has just parsed
   # a hostile file, and Vips::Error#message routinely contains the input filename. Applications store
@@ -59,9 +59,10 @@ module HotCell
     class << self
       # Builds from either a message String or an Exception. An Exception has to become two wire fields, and
       # that rule was written out at three call sites across two gems — the worker, the supervisor's control
-      # answer, and the client's transport.
+      # answer, and the client's transport. `::Exception` because hotcell-client defines Failure::Exception,
+      # which a bare `Exception` here would name.
       def for(code, detail, cause: nil)
-        if detail.is_a?(Exception)
+        if detail.is_a?(::Exception)
           new code: code, cause: cause, error_class: detail.class.name, message: detail.message
         else
           new code: code, cause: cause, message: detail
@@ -70,7 +71,7 @@ module HotCell
 
       # A code this client has never heard of is not permanent. An old client will meet a code added
       # later, and the harm of the two mistakes is not symmetrical: retrying something permanent costs
-      # some work, while writing down a verdict that was temporary is irreversible.
+      # some work, while writing down a failure that was temporary is irreversible.
       # A `permanent` that is present but not a boolean is derived rather than believed. Truthiness would make
       # any non-nil value permanent, and permanent is the answer that cannot be taken back — so a garbled
       # field must not be able to say it.

data/lib/hot_cell/payload.rb

@@ -33,7 +33,7 @@ module HotCell
       # cell.
       #
       # The body is one JSON.parse call, so the rescue cannot hide a bug of our own. NoMemoryError is not
-      # a StandardError and stays uncaught: a document that large is the worker's memory verdict, not a
+      # a StandardError and stays uncaught: a document that large is the worker's `memory` failure, not a
       # bad line.
       def parse(json)
         JSON.parse json, symbolize_names: true, max_nesting: MAX_NESTING, allow_nan: false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hotcell-core
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Mike Dalessio
@@ -10,7 +10,7 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: |
-  The wire protocol between an application and a HotCell container: the request and response format,
+  The wire protocol between an application and a Hot Cell container: the request and response format,
   file descriptor passing over SCM_RIGHTS, payload validation, and the error taxonomy. Both
   hotcell-client and hotcell-server depend on it. Install one of those rather than this.
 email:
@@ -43,8 +43,8 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/basecamp/hotcell
-  source_code_uri: https://github.com/basecamp/hotcell/tree/v1.1.0/hotcell-core
-  changelog_uri: https://github.com/basecamp/hotcell/blob/v1.1.0/CHANGELOG.md
+  source_code_uri: https://github.com/basecamp/hotcell/tree/v1.2.0/hotcell-core
+  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'
@@ -62,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.6
 specification_version: 4
-summary: The wire protocol shared by both sides of a HotCell.
+summary: The wire protocol shared by both sides of a Hot Cell.
 test_files: []