Skip to content

Use include_metadata configuration in Consensus Commit #152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 2, 2025
Merged

Use include_metadata configuration in Consensus Commit #152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion scalardb/src/scalardb/db/cluster.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,10 @@
"scalar.db.storage=jdbc"
"scalar.db.contact_points=jdbc:postgresql://postgresql-scalardb-cluster.default.svc.cluster.local:5432/postgres"
"scalar.db.username=postgres"
"scalar.db.password=postgres"])
"scalar.db.password=postgres"
""
;; Set to true to include transaction metadata in the records
"scalar.db.consensus_commit.include_metadata.enabled=true"])
Comment on lines +44 to +45
Copy link
Contributor Author

@brfrn169 brfrn169 Jun 27, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this change also affects the cluster test, so I added the configuration here as well.

Note that I didn't add support for the read-committed isolation level and the one-phase commit optimization in the cluster test.


:imagePullSecrets [{:name "scalardb-ghcr-secret"}]}})

Expand Down
3 changes: 2 additions & 1 deletion scalardb/src/scalardb/db_extend.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@
(.setProperty "scalar.db.consensus_commit.coordinator.group_commit.slot_capacity" "4")
(.setProperty "scalar.db.consensus_commit.coordinator.group_commit.old_group_abort_timeout_millis" "15000")
(.setProperty "scalar.db.consensus_commit.coordinator.group_commit.delayed_slot_move_timeout_millis" "400")
(.setProperty "scalar.db.consensus_commit.coordinator.group_commit.metrics_monitor_log_enabled" "true")))
(.setProperty "scalar.db.consensus_commit.coordinator.group_commit.metrics_monitor_log_enabled" "true")
(.setProperty "scalar.db.consensus_commit.include_metadata.enabled" "true")))
Copy link
Contributor Author

@brfrn169 brfrn169 Jun 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Set the scalar.db.consensus_commit.include_metadata.enabled property to true to include transaction metadata in the records.


(defprotocol DbExtension
(get-db-type [this])
Expand Down
10 changes: 3 additions & 7 deletions scalardb/src/scalardb/transfer.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,13 +132,11 @@
[test n]
(try
(let [tx (scalar/start-transaction test)
tx-results (map #(.get tx (prepare-get %)) (range n))
;; Need Storage API to read the transaction metadata
results (mapv #(.get @(:storage test) (prepare-get %)) (range n))]
Comment on lines -136 to -137
Copy link
Contributor Author

@brfrn169 brfrn169 Jun 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed the use of the Storage API.

results (map #(.get tx (prepare-get %)) (range n))]
;; Put the same balance to check conflicts with in-flight transactions
(mapv #(->> (calc-new-balance %2 0) (prepare-put %1) (.put tx))
(range n)
tx-results)
results)
(.commit tx)
results)
(catch Exception e
Expand All @@ -148,11 +146,9 @@
(defn read-all-with-retry
[test n]
(scalar/check-transaction-connection! test)
(scalar/check-storage-connection! test)
(scalar/with-retry
(fn [test]
(scalar/prepare-transaction-service! test)
(scalar/prepare-storage-service! test))
(scalar/prepare-transaction-service! test))
test
(read-all test n)))

Expand Down
19 changes: 2 additions & 17 deletions scalardb/test/scalardb/transfer_2pc_test.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
[scalardb.transfer-2pc :as transfer-2pc]
[spy.core :as spy])
(:import (com.scalar.db.api DistributedTransaction
DistributedStorage
TwoPhaseCommitTransaction
Get
Put
Expand Down Expand Up @@ -63,12 +62,6 @@
(^void put [_ ^Put p] (mock-put p))
(^void commit [_] (swap! commit-count inc))))

(def mock-storage
(reify
DistributedStorage
(^Optional get [_ ^Get g] (mock-get g))
(^void put [_ ^Put p] (mock-put p))))

(def mock-transaction-throws-exception
(reify
DistributedTransaction
Expand Down Expand Up @@ -206,38 +199,30 @@
(deftest transfer-client-get-all-test
(binding [test-records (atom {0 1000 1 100 2 10 3 1 4 0})]
(with-redefs [scalar/check-transaction-connection! (spy/spy)
scalar/check-storage-connection! (spy/spy)
scalar/start-transaction (spy/stub mock-transaction)]
(let [client (client/open! (transfer-2pc/->TransferClient (atom false) 5 100 1)
nil nil)
result (client/invoke! client {:db mock-db
:storage (ref mock-storage)}
result (client/invoke! client {:db mock-db}
(#'transfer/get-all {:client client}
nil))]
(is (spy/called-once? scalar/check-transaction-connection!))
(is (spy/called-once? scalar/check-storage-connection!))
(is (= :ok (:type result)))
(is (= [1000 100 10 1 0] (get-in result [:value :balance])))
(is (= [1000 100 10 1 0] (get-in result [:value :version])))))))

(deftest transfer-client-get-all-fail-test
(with-redefs [scalar/exponential-backoff (spy/spy)
scalar/check-transaction-connection! (spy/spy)
scalar/check-storage-connection! (spy/spy)
scalar/prepare-transaction-service! (spy/spy)
scalar/prepare-storage-service! (spy/spy)
scalar/start-transaction (spy/stub mock-transaction-throws-exception)]
(let [client (client/open! (transfer-2pc/->TransferClient (atom false) 5 100 1)
nil nil)]
(is (thrown? clojure.lang.ExceptionInfo
(client/invoke! client {:db mock-db
:storage (ref mock-storage)}
(client/invoke! client {:db mock-db}
(#'transfer/get-all {:client client}
nil))))
(is (spy/called-n-times? scalar/exponential-backoff scalar/RETRIES))
(is (spy/called-n-times? scalar/prepare-transaction-service!
(+ (quot scalar/RETRIES scalar/RETRIES_FOR_RECONNECTION) 1)))
(is (spy/called-n-times? scalar/prepare-storage-service!
(+ (quot scalar/RETRIES scalar/RETRIES_FOR_RECONNECTION) 1))))))

(deftest transfer-client-check-tx-test
Expand Down
19 changes: 2 additions & 17 deletions scalardb/test/scalardb/transfer_test.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
[scalardb.transfer :as transfer]
[spy.core :as spy])
(:import (com.scalar.db.api DistributedTransaction
DistributedStorage
Get
Put
Result)
Expand Down Expand Up @@ -57,12 +56,6 @@
(^void put [_ ^Put p] (mock-put p))
(^void commit [_] (swap! commit-count inc))))

(def mock-storage
(reify
DistributedStorage
(^Optional get [_ ^Get g] (mock-get g))
(^void put [_ ^Put p] (mock-put p))))

(def mock-transaction-throws-exception
(reify
DistributedTransaction
Expand Down Expand Up @@ -178,38 +171,30 @@
(deftest transfer-client-get-all-test
(binding [test-records (atom {0 1000 1 100 2 10 3 1 4 0})]
(with-redefs [scalar/check-transaction-connection! (spy/spy)
scalar/check-storage-connection! (spy/spy)
scalar/start-transaction (spy/stub mock-transaction)]
(let [client (client/open! (transfer/->TransferClient (atom false) 5 100 1)
nil nil)
result (client/invoke! client {:db mock-db
:storage (ref mock-storage)}
result (client/invoke! client {:db mock-db}
(#'transfer/get-all {:client client}
nil))]
(is (spy/called-once? scalar/check-transaction-connection!))
(is (spy/called-once? scalar/check-storage-connection!))
(is (= :ok (:type result)))
(is (= [1000 100 10 1 0] (get-in result [:value :balance])))
(is (= [1000 100 10 1 0] (get-in result [:value :version])))))))

(deftest transfer-client-get-all-fail-test
(with-redefs [scalar/exponential-backoff (spy/spy)
scalar/check-transaction-connection! (spy/spy)
scalar/check-storage-connection! (spy/spy)
scalar/prepare-transaction-service! (spy/spy)
scalar/prepare-storage-service! (spy/spy)
scalar/start-transaction (spy/stub mock-transaction-throws-exception)]
(let [client (client/open! (transfer/->TransferClient (atom false) 5 100 1)
nil nil)]
(is (thrown? clojure.lang.ExceptionInfo
(client/invoke! client {:db mock-db
:storage (ref mock-storage)}
(client/invoke! client {:db mock-db}
(#'transfer/get-all {:client client}
nil))))
(is (spy/called-n-times? scalar/exponential-backoff scalar/RETRIES))
(is (spy/called-n-times? scalar/prepare-transaction-service!
(+ (quot scalar/RETRIES scalar/RETRIES_FOR_RECONNECTION) 1)))
(is (spy/called-n-times? scalar/prepare-storage-service!
(+ (quot scalar/RETRIES scalar/RETRIES_FOR_RECONNECTION) 1))))))

(deftest transfer-client-check-tx-test
Expand Down
Loading