statelydb 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8481aaa31dca18c89b20c17cea4e413165e0aa6677c5ba3eb522780f9f327559
-  data.tar.gz: cdbfd5503bc8d8882a47b3b9fbc59c591477957572d66539c8841c55d8ad2ec4
+  metadata.gz: 8b27d32c4da703530db30a90682ed114e0c6d51d5c3dc6a686a7ab2bf766998c
+  data.tar.gz: f5166027a052648eba7dbda0c57b3f6a43803bfda0ab7231228439d11a30cd4c
 SHA512:
-  metadata.gz: 1484b054ae70123705dcb70911019173d766e16dc7c748e00ac7409b26617d87e3131d11ca3d0a65b91081f7371a787818993e81ebc6af232c9dc1f685ac951a
-  data.tar.gz: 85acbaf93fadc0c5928f47ef41d534ff93ea1b2ecdd08021fb78df456bc5451a8a14e889b8de539df72f32c81f05c1d5431762cd69309a408a80bc5e3e6b4342
+  metadata.gz: 68066039cfd9d52a577e2a1be1b66be66468fb40e12bb98e8a4ef4b02e4b97136c20824efa4a1bbd6cf3a099146a43aa8e44114ac5e1eb2cb5402d583773faf4
+  data.tar.gz: a1ee650259c49d439f32a72d7ab2161a560c0d0e27eb8c87c7a3b03c255ab369d5bd0ceedf25901234b0a93eaee996221002f1782a4e7ed923a249ba93c0f72b

data/README.md

@@ -47,5 +47,5 @@ def put_my_item
 
 ---
 
-[Getting Started Guide]: https://preview-docs.stately.cloud/guides/getting-started/
-[Defining Schema]: https://preview-docs.stately.cloud/guides/defining-schema/
+[Getting Started Guide]: https://docs.stately.cloud/guides/getting-started/
+[Defining Schema]: https://docs.stately.cloud/guides/schema/

data/lib/api/db/service_services_pb.rb

@@ -40,12 +40,12 @@ module Stately
         # always applied atomically; all will fail or all will succeed.
         rpc :Delete, ::Stately::Db::DeleteRequest, ::Stately::Db::DeleteResponse
         # BeginList retrieves Items that start with a specified key path prefix. The
-        # key path prefix must minimally contain a Group Key (an item type and an
-        # item ID). BeginList will return an empty result set if there are no items
-        # matching that key prefix. This API returns a token that you can pass to
-        # ContinueList to expand the result set, or to SyncList to get updates within
-        # the result set. This can fail if the caller does not have permission to
-        # read Items.
+        # key path prefix must minimally contain a Group Key (a single key segment
+        # with a namespace and an ID). BeginList will return an empty result set if
+        # there are no items matching that key prefix. This API returns a token that
+        # you can pass to ContinueList to expand the result set, or to SyncList to
+        # get updates within the result set. This can fail if the caller does not
+        # have permission to read Items.
         # buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
         rpc :BeginList, ::Stately::Db::BeginListRequest, stream(::Stately::Db::ListResponse)
         # ContinueList takes the token from a BeginList call and returns more results

data/lib/api/errors/error_details_pb.rb

@@ -5,7 +5,7 @@
 require 'google/protobuf'
 
 
-descriptor_data = "\n\x1a\x65rrors/error_details.proto\x12\x0estately.errors\"y\n\x13StatelyErrorDetails\x12!\n\x0cstately_code\x18\x01 \x01(\tR\x0bstatelyCode\x12\x18\n\x07message\x18\x02 \x01(\tR\x07message\x12%\n\x0eupstream_cause\x18\x03 \x01(\tR\rupstreamCauseB\x80\x01\n\x12\x63om.stately.errorsB\x11\x45rrorDetailsProtoP\x01\xa2\x02\x03SEX\xaa\x02\x0eStately.Errors\xca\x02\x0eStately\\Errors\xe2\x02\x1aStately\\Errors\\GPBMetadata\xea\x02\x0fStately::Errorsb\x06proto3"
+descriptor_data = "\n\x1a\x65rrors/error_details.proto\x12\x0estately.errors\"\x8d\x01\n\x13StatelyErrorDetails\x12!\n\x0cstately_code\x18\x01 \x01(\tR\x0bstatelyCode\x12\x18\n\x07message\x18\x02 \x01(\tR\x07message\x12%\n\x0eupstream_cause\x18\x03 \x01(\tR\rupstreamCause\x12\x12\n\x04\x63ode\x18\x04 \x01(\rR\x04\x63odeB\x80\x01\n\x12\x63om.stately.errorsB\x11\x45rrorDetailsProtoP\x01\xa2\x02\x03SEX\xaa\x02\x0eStately.Errors\xca\x02\x0eStately\\Errors\xe2\x02\x1aStately\\Errors\\GPBMetadata\xea\x02\x0fStately::Errorsb\x06proto3"
 
 pool = Google::Protobuf::DescriptorPool.generated_pool
 pool.add_serialized_file(descriptor_data)

data/lib/statelydb.rb

@@ -92,6 +92,7 @@ module StatelyDB
       key_paths = Array(key_paths).flatten
       req = Stately::Db::GetRequest.new(
         store_id: @store_id,
+        schema_version_id: @schema::SCHEMA_VERSION_ID,
         gets:
           key_paths.map { |key_path| Stately::Db::GetItem.new(key_path: String(key_path)) },
         allow_stale: @allow_stale
@@ -125,7 +126,8 @@ module StatelyDB
         limit:,
         sort_property:,
         sort_direction:,
-        allow_stale: @allow_stale
+        allow_stale: @allow_stale,
+        schema_version_id: @schema::SCHEMA_VERSION_ID
       )
       resp = @stub.begin_list(req)
       process_list_response(resp)
@@ -188,6 +190,7 @@ module StatelyDB
       items = Array(items).flatten
       req = Stately::Db::PutRequest.new(
         store_id: @store_id,
+        schema_version_id: @schema::SCHEMA_VERSION_ID,
         puts: items.map do |item|
           Stately::Db::PutItem.new(
             item: item.send("marshal_stately")
@@ -214,6 +217,7 @@ module StatelyDB
       key_paths = Array(key_paths).flatten
       req = Stately::Db::DeleteRequest.new(
         store_id: @store_id,
+        schema_version_id: @schema::SCHEMA_VERSION_ID,
         deletes: key_paths.map { |key_path| Stately::Db::DeleteItem.new(key_path: String(key_path)) }
       )
       @stub.delete(req)
@@ -308,6 +312,7 @@ module StatelyDB
     def process_sync_response(resp)
       changed_items = []
       deleted_item_paths = []
+      updated_outside_list_window_paths = []
       token = nil
       is_reset = false
       resp.each do |r|
@@ -319,6 +324,9 @@ module StatelyDB
           r.result.deleted_items.each do |item|
             deleted_item_paths << item.key_path
           end
+          r.result.updated_item_keys_outside_list_window.each do |item|
+            updated_outside_list_window_paths << item.key_path
+          end
         when :reset
           is_reset = true
         when :finished
@@ -328,7 +336,7 @@ module StatelyDB
                                        can_sync: raw_token.can_sync)
         end
       end
-      SyncResult.new(changed_items:, deleted_item_paths:, is_reset:, token:)
+      SyncResult.new(changed_items:, deleted_item_paths:, updated_outside_list_window_paths:, is_reset:, token:)
     end
   end
 
@@ -336,18 +344,24 @@ module StatelyDB
   #
   # @attr_reader changed_items [Array<StatelyDB::Item>] the items that were changed
   # @attr_reader deleted_item_paths [Array<String>] the key paths that were deleted
+  # @attr_reader updated_outside_list_window_paths [Array<String>] the key paths of
+  #   items that were updated but Stately cannot tell if they were in the sync window.
+  #   Treat these as deleted in most cases.
   # @attr_reader is_reset [Boolean] whether the sync operation reset the token
   # @attr_reader token [StatelyDB::Token] the token to continue from
   class SyncResult
-    attr_reader :changed_items, :deleted_item_paths, :is_reset, :token
+    attr_reader :changed_items, :deleted_item_paths, :updated_outside_list_window_paths, :is_reset, :token
 
     # @param changed_items [Array<StatelyDB::Item>] the items that were changed
     # @param deleted_item_paths [Array<String>] the key paths that were deleted
+    # @param updated_outside_list_window_paths [Array<String>] key paths for items that were updated
+    #   but do not currently use the sort property that the list window is based on
     # @param is_reset [Boolean] whether the sync operation reset the token
     # @param token [StatelyDB::Token] the token to continue from
-    def initialize(changed_items:, deleted_item_paths:, is_reset:, token:)
+    def initialize(changed_items:, deleted_item_paths:, updated_outside_list_window_paths:, is_reset:, token:)
       @changed_items = changed_items
       @deleted_item_paths = deleted_item_paths
+      @updated_outside_list_window_paths = updated_outside_list_window_paths
       @is_reset = is_reset
       @token = token
     end

data/lib/transaction/transaction.rb

@@ -124,7 +124,10 @@ module StatelyDB
       # @!visibility private
       def begin
         @is_transaction_open = true
-        req = Stately::Db::TransactionRequest.new(begin: Stately::Db::TransactionBegin.new(store_id: @store_id.to_i))
+        req = Stately::Db::TransactionRequest.new(
+          begin: Stately::Db::TransactionBegin.new(store_id: @store_id.to_i,
+                                                   schema_version_id: @schema::SCHEMA_VERSION_ID)
+        )
         request_only(req)
         @incoming_responses = @stub.transaction(@outgoing_requests)
         nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statelydb
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Stately Cloud, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-15 00:00:00.000000000 Z
+date: 2024-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async