activerecord-turbopuffer-adapter 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc9b47b80bd694b53052b54ca2647989e6bfd911c1a0f2e59056d61cfccf075e
-  data.tar.gz: a306ba71a2c62db295b438c6583f61a765d425a8f2888c328b831df31bf9840b
+  metadata.gz: 69922615a71c6eefbe25e734208f52099110685db3ad28073dd79e284ec3381b
+  data.tar.gz: 47e713a1a9336e51dcb6e446e23d3364f2bcf8f23ff944a0b52e2a7d4e49acbf
 SHA512:
-  metadata.gz: f73376471edf444dfc0f2c5dd702d2727a280c307f440da3a367d7d594074a9654e8b20fa58c19c2c6e57a4ab393dbacf17bb8044be82867e9fe7528d5b78874
-  data.tar.gz: 8988590d661ac5c872df12f3e467f939bdb71f291d9485eab31227d3ea3afa3773f8ad8d885f2a91e3b8d3856e92835fc1a2381ceee79978185206b6f52e5479
+  metadata.gz: 7b366354338fd3d15e689340dbddf279ebf4b4d3823412ae1ef95d21eca48d1a06b492738b1aa21c9abb87e77906e2d3f07b67e71f80b61241e1f3143126946d
+  data.tar.gz: fe83fd43d546c5e07e19fcc38a14760b2810955f5e3398ce4b4895c19280fa3c77dc88874a6bb771ff5572fd90a6a9ebd13bb0563c2a69fa40de5375b6fa34fa

data/README.md

@@ -120,6 +120,24 @@ Document
 
 > Eventual reads are cheaper but may not include writes from the last few seconds. Set a default with `turbopuffer_consistency "eventual"` in a model or `consistency: eventual` in `database.yml`. Strong is the default.
 
+### Errors
+
+Turbopuffer errors are raised as the ActiveRecord exceptions a Rails app already handles.
+
+```ruby
+begin
+  Document.where(published: true).to_a
+rescue ActiveRecord::ConnectionFailed
+  # turbopuffer is unreachable
+rescue ActiveRecord::StatementTimeout
+  # the request timed out
+rescue ActiveRecord::DatabaseConnectionError
+  # the API key is invalid
+rescue ActiveRecord::StatementInvalid => e
+  e.cause # => the underlying Turbopuffer::Errors::APIError, e.g. a bad request or rate limit
+end
+```
+
 ### Using alongside Postgres
 
 While something of a lark, aspirationally the idea of this gem is to make turbopuffer conveniently usable as the primary db in a Rails app. In practice, however, using turbopuffer alongside a traditional primary db (such as postgres) is a supported, potentially more practical solution.

data/lib/active_record/connection_adapters/turbopuffer_adapter.rb

@@ -363,6 +363,19 @@ module ActiveRecord
       def reconnect
         connect
       end
+
+      def translate_exception(exception, message:, sql:, binds:)
+        case exception
+        when Turbopuffer::Errors::APITimeoutError
+          ActiveRecord::StatementTimeout.new(message, sql: sql, binds: binds, connection_pool: @pool)
+        when Turbopuffer::Errors::APIConnectionError
+          ActiveRecord::ConnectionFailed.new(message, sql: sql, binds: binds, connection_pool: @pool)
+        when Turbopuffer::Errors::AuthenticationError, Turbopuffer::Errors::PermissionDeniedError
+          ActiveRecord::DatabaseConnectionError.new(message)
+        else
+          super
+        end
+      end
     end
   end
 end

data/lib/turbopuffer/active_record/version.rb

@@ -1,5 +1,5 @@
 module Turbopuffer
   module ActiveRecord
-    VERSION = "0.1.3"
+    VERSION = "0.1.4"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-turbopuffer-adapter
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Richard Monette