paquito 0.11.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ede4c0254b56d0c34d1d664903ffcd51db1ce717723a82858973c76d41231bb
-  data.tar.gz: 97d7ac64e05043df851dd6ef49cec163991c91afc6b25e98e1b4649a5a808eb8
+  metadata.gz: 6b6c5c9838f1a54d3ffce2095ac8b46b423b54eaea4704ace9e7a33ad011316d
+  data.tar.gz: e3b26fc6ecdc8ad279b2f9157089536d69e942fe011458b521da0daf2b8e423d
 SHA512:
-  metadata.gz: 650bc85b15bbf5c2516941222d3de02e6c7b622a0998e9ccd2db2adf439964d5edc877227b750fad06903c0d00f58a61004e3e6271b37bf6d67f8a1aeb45dcfc
-  data.tar.gz: b2b03a2c958c622e68b8f1cf3745d89b4cefc9ac4070875d85174ed3c5943c27a31df049f44b677d9fd6c33e958c8ddc9b834f4d8870ed8a547fe7b30b1df8ba
+  metadata.gz: 513b52e62ba30a9f3f94f63b19b467f9c9dbed9ec3a65d41dd9efe8a50a97bbf580c8c3c29a6dd15a2f4ace5e4f692728377757983d6500ef3b531db83c955e8
+  data.tar.gz: 90b2dffe3fe1569ee79927e7aecead29731665908b03772c300e95bab2e62844fc2a247b4b54da5ab1999c0608fa8bb7606990b1d18777779bf651ada1fd14eb

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+# 1.0.0
+
+Both changes in this release require applications to be fully updated to the latest patch version of the gem before
+bumping to this version.
+
+* Store md5 digest of columns + sql types along with records (#51)
+  *IMPORTANT*: if you are storing Active Record objects in the cache, ensure you have updated and deployed 0.11.3 before
+  upgrading, and ensure you are handling either all `ActiveRecordCoder::Error` errors, or that you explicitly add
+  `ActiveRecordCoder::ColumnsDigestMismatch` to your error handling.
+* Bump `Paquito.format_version` to `1` by default.
+  *IMPORTANT*: if you are upgrading from a previous version, you MUST first fully deploy the gem up to at least version 0.10.0
+  and release before enabling it. If you don't, you may notice some `UnpackError` during the code rollout, which may be fine
+  if you only use Paquito for ephemeral cache data. See release notes for v0.10.0.
+
 # 0.11.3
 
 * Deserialize records with extra unused array elements in payload (#52)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    paquito (0.11.3)
+    paquito (1.0.0)
       msgpack (>= 1.5.2)
 
 GEM

data/lib/paquito/active_record_coder.rb

@@ -88,9 +88,12 @@ module Paquito
       end
 
       def serialize_record(record)
-        arguments = [record.class.name, attributes_for_database(record)]
-        arguments << true if record.new_record?
-        arguments
+        [
+          record.class.name,
+          attributes_for_database(record),
+          record.new_record?,
+          columns_digest(record.class),
+        ]
       end
 
       def attributes_for_database(record)
@@ -99,18 +102,28 @@ module Paquito
         attributes
       end
 
-      def deserialize_record(class_name, attributes_from_database, new_record = false, *)
+      def deserialize_record(class_name, attributes_from_database, new_record = false, hash = nil, *)
         begin
           klass = Object.const_get(class_name)
         rescue NameError
           raise ClassMissingError, "undefined class: #{class_name}"
         end
 
+        if hash && (hash != (expected_digest = columns_digest(klass)))
+          raise ColumnsDigestMismatch,
+            "\"#{hash}\" does not match the expected digest of \"#{expected_digest}\""
+        end
+
         # Ideally we'd like to call `klass.instantiate`, however it doesn't allow to pass
         # wether the record was persisted or not.
         attributes = klass.attributes_builder.build_from_database(attributes_from_database, EMPTY_HASH)
         klass.allocate.init_with_attributes(attributes, new_record)
       end
+
+      def columns_digest(klass)
+        str = klass.columns_hash.map { |name, column| [name, column.sql_type].join(":") }.join(",")
+        ::Digest::MD5.digest(str).unpack1("s")
+      end
     end
 
     class Error < ::Paquito::Error
@@ -122,6 +135,9 @@ module Paquito
     class AssociationMissingError < Error
     end
 
+    class ColumnsDigestMismatch < Error
+    end
+
     class InstanceTracker
       def initialize
         @instances = []

data/lib/paquito/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Paquito
-  VERSION = "0.11.3"
+  VERSION = "1.0.0"
 end

data/lib/paquito.rb

@@ -29,7 +29,7 @@ module Paquito
   autoload :FlatCacheEntryCoder, "paquito/flat_cache_entry_coder"
   autoload :ActiveRecordCoder, "paquito/active_record_coder"
 
-  DEFAULT_FORMAT_VERSION = 0
+  DEFAULT_FORMAT_VERSION = 1
   @format_version = DEFAULT_FORMAT_VERSION
 
   class << self

data/paquito.gemspec

@@ -19,6 +19,14 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/Shopify/paquito"
 
+  spec.post_install_message = <<~POST_INSTALL_MSG
+    Warning: Paquito 1.0 includes potentially breaking changes to ActiveRecordCoder.
+    Before upgrading to 1.0 from an earlier version, ensure you have first upgraded
+    to 0.11.3 and deployed your application before upgrading to 1.0. Also ensure you
+    rescue either all `ActiveRecordCoder::Error` errors, or that you explicitly
+    rescue the new `ActiveRecord::ColumnsDigestError`.
+  POST_INSTALL_MSG
+
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: paquito
 version: !ruby/object:Gem::Version
-  version: 0.11.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Jean Boussier
 bindir: exe
 cert_chain: []
-date: 2025-02-06 00:00:00.000000000 Z
+date: 2025-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -82,6 +82,12 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/Shopify/paquito
   source_code_uri: https://github.com/Shopify/paquito
+post_install_message: |
+  Warning: Paquito 1.0 includes potentially breaking changes to ActiveRecordCoder.
+  Before upgrading to 1.0 from an earlier version, ensure you have first upgraded
+  to 0.11.3 and deployed your application before upgrading to 1.0. Also ensure you
+  rescue either all `ActiveRecordCoder::Error` errors, or that you explicitly
+  rescue the new `ActiveRecord::ColumnsDigestError`.
 rdoc_options: []
 require_paths:
 - lib