Merge pull request #1 from mgoldenberg/expose-version-change-transaction

Provide access to active transaction in callback provided to `OpenDbRequestBuilder::with_on_upgrade_needed{_fut}`

Author: Hywan

.github/workflows/test.yml

@@ -1,6 +1,6 @@
 name: Test
 on:
-  workflow_call: { }
+  workflow_call: {}
   push:
     branches:
       - master
@@ -41,7 +41,7 @@ jobs:
         uses: alorel-actions/cargo/init@v2
         id: toolchain
         with:
-          toolchain: nightly-2024-10-18
+          toolchain: nightly-2025-05-05
           cache-prefix: doc
           local: true
 
@@ -104,7 +104,7 @@ jobs:
         include:
           - toolchain: nightly-2025-05-05
             os: ubuntu-latest
-          - toolchain: 1.75.0
+          - toolchain: 1.85.0
             os: ubuntu-latest
           - toolchain: stable
             os: ubuntu-latest
@@ -120,7 +120,7 @@ jobs:
       fail-fast: false
       matrix:
         flags:
-          - ''
+          - ""
           - --features cursors
           - --features dates
           - --features indices

Cargo.toml

@@ -10,7 +10,7 @@ name = "indexed_db_futures"
 version = "0.6.4"
 authors = ["Arturas Molcanovas <amolc@pm.me>"]
 edition = "2021"
-rust-version = "1.75.0"
+rust-version = "1.85.0"
 license = "MIT"
 description = "Future bindings for IndexedDB via web_sys"
 repository = "https://github.com/Alorel/rust-indexed-db"

internal_macros/src/generic_bounds.rs

@@ -1,7 +1,5 @@
 use crate::commons::FnTarget;
 use crate::TokenStream1;
-use macroific::prelude::*;
-use proc_macro2::Ident;
 use quote::ToTokens;
 use syn::{parse_quote, Error, WherePredicate};
 
@@ -22,7 +20,7 @@ macro_rules! make_opts {
         ///
         /// | Option | Type |
         /// |--------|-----------|
-        $($(#[doc = concat!(" | `", stringify!($extra_opt), "` | `", stringify!($extra_ty), "` |")])+)+
+        $($(#[doc = concat!(" | `", stringify!($extra_opt), "` | `", stringify!($extra_ty), "` |")])+)*
         #[derive(::macroific::attr_parse::AttributeOptions)]
         pub(super) struct $struct_name {
             $($($opt: ::syn::punctuated::Punctuated<proc_macro2::Ident, ::syn::Token![,]>,)+)+
@@ -53,10 +51,8 @@ make_opts!(Opts => {
     db_name|index_name|store_name|key_path => ::core::convert::AsRef<str>,
     db_version => crate::factory::DBVersion,
     blocked_cb => ::core::ops::FnOnce(crate::database::VersionChangeEvent) -> crate::Result<()> + 'static,
-    upgrade_cb => ::core::ops::FnOnce(crate::database::VersionChangeEvent, crate::database::Database) -> crate::Result<()> + 'static,
-    [custom] => {
-        upgrade_async_cb => UpgradeAsyncCb,
-    },
+    upgrade_cb => ::core::ops::FnOnce(crate::database::VersionChangeEvent, &crate::transaction::Transaction<'_>) -> crate::Result<()> + 'static,
+    upgrade_async_cb => ::core::ops::AsyncFnOnce(crate::database::VersionChangeEvent, &crate::transaction::Transaction<'_>) -> crate::Result<()> + 'static,
 });
 
 #[inline]
@@ -73,31 +69,6 @@ pub(super) fn exec(spec: TokenStream1, target: TokenStream1) -> TokenStream1 {
     }
 }
 
-#[derive(ParseOption)]
-struct UpgradeAsyncCb {
-    #[attr_opts(default = false)]
-    fun: Ident,
-
-    #[attr_opts(default = false)]
-    fut: Ident,
-}
-
-impl UpgradeAsyncCb {
-    fn extend_target(self, target: &mut FnTarget) {
-        let Self { fun, fut } = self;
-        let wheres = [
-            parse_quote!(#fun: ::core::ops::FnOnce(crate::database::VersionChangeEvent, crate::database::Database) -> #fut + 'static),
-            parse_quote!(#fut: ::core::future::Future<Output = crate::Result<()>> + 'static),
-        ];
-
-        target
-            .generics_mut()
-            .make_where_clause()
-            .predicates
-            .extend::<[WherePredicate; 2]>(wheres);
-    }
-}
-
 fn on_err(mut target: TokenStream1, e: Error) -> TokenStream1 {
     let e: TokenStream1 = e.into_compile_error().into();
     target.extend(e);

src/cursor.rs

@@ -64,7 +64,7 @@ impl<'a, Qs> Cursor<'a, Qs> {
     /// followed by [`value`](https://developer.mozilla.org/en-US/docs/Web/API/IDBCursorWithValue/value) in JS.
     #[errdoc(Cursor(TransactionInactiveError, InvalidStateError))]
     #[inline]
-    pub fn next_record<T>(&mut self) -> CursorNextRequest<T>
+    pub fn next_record<T>(&mut self) -> CursorNextRequest<'_, T>
     where
         T: TryFromJs,
     {
@@ -73,7 +73,7 @@ impl<'a, Qs> Cursor<'a, Qs> {
 
     /// Mirror of [`Self::next_record`] for `serde`-deserialisable values.
     #[cfg(feature = "serde")]
-    pub fn next_record_ser<T>(&mut self) -> CursorNextRequest<T>
+    pub fn next_record_ser<T>(&mut self) -> CursorNextRequest<'_, T>
     where
         T: crate::serde::DeserialiseFromJs,
     {
@@ -106,7 +106,7 @@ impl<'a, Qs> Cursor<'a, Qs> {
         DataCloneError,
     ))]
     #[inline]
-    pub fn update<V>(&self, value: V) -> Update<V> {
+    pub fn update<V>(&self, value: V) -> Update<'_, V> {
         Update::new(self, value)
     }
 

src/cursor/key_cursor.rs

@@ -34,7 +34,7 @@ impl<'a, Qs> KeyCursor<'a, Qs> {
     /// followed by [`key`](https://developer.mozilla.org/en-US/docs/Web/API/IDBCursor/key) in JS.
     #[inline]
     #[errdoc(Cursor(TransactionInactiveError, InvalidStateError))]
-    pub fn next_key<T>(&mut self) -> CursorNextRequest<T>
+    pub fn next_key<T>(&mut self) -> CursorNextRequest<'_, T>
     where
         T: TryFromJs,
     {
@@ -44,7 +44,7 @@ impl<'a, Qs> KeyCursor<'a, Qs> {
     /// Mirror of [`Self::next_key`] for `serde`-deserialisable keys.
     #[inline]
     #[cfg(feature = "serde")]
-    pub fn next_key_ser<T>(&mut self) -> CursorNextRequest<T>
+    pub fn next_key_ser<T>(&mut self) -> CursorNextRequest<'_, T>
     where
         T: crate::serde::DeserialiseFromJs,
     {

src/cursor/stream.rs

@@ -90,7 +90,7 @@ impl<'a, Qs, T> Stream<Cursor<'a, Qs>, T> {
         DataErrorUpdate,
         DataCloneError
     ))]
-    pub fn update<V>(&self, value: V) -> super::Update<V> {
+    pub fn update<V>(&self, value: V) -> super::Update<'_, V> {
         self.cursor.update(value)
     }
 

src/database.rs

@@ -52,7 +52,7 @@ impl Database {
     /// Create an object store with the given name.
     #[generic_bounds(store_name(N))]
     #[inline]
-    pub fn create_object_store<N>(&self, name: N) -> StoreBuilder<N> {
+    pub fn create_object_store<N>(&self, name: N) -> StoreBuilder<'_, N> {
         StoreBuilder::new(self, name)
     }
 
@@ -99,15 +99,15 @@ impl Database {
 
     /// List the names of the object stores within this database.
     #[inline]
-    pub fn object_store_names(&self) -> DomStringIter {
+    pub fn object_store_names(&self) -> DomStringIter<'_> {
         DomStringIter::new(self.as_sys().object_store_names())
     }
 
     /// Start a transaction on the given store name(s). Finish the builder with a call to
     /// [`Build::build`](crate::Build::build).
     #[errdoc(Database(NotFoundErrorTx, InvalidAccessErrorTx))]
     #[inline]
-    pub fn transaction<S: ObjectStoreName>(&self, store_names: S) -> TransactionBuilder<S> {
+    pub fn transaction<S: ObjectStoreName>(&self, store_names: S) -> TransactionBuilder<'_, S> {
         TransactionBuilder::new(self, store_names)
     }
 

src/error/unexpected_data.rs

@@ -22,6 +22,10 @@ pub enum UnexpectedDataError {
     #[error("`Future` polled unexpectedly.")]
     PollState,
 
+    /// Expected a Transaction to exist, but it was not found.
+    #[error("Expected the Transaction to exist, but it was not found.")]
+    TransactionNotFound,
+
     /// Expected a Transaction to be aborted, but it was committed.
     #[error("Expected the Transaction to be aborted, but it was committed.")]
     TransactionCommitted,

src/factory/req_builder.rs

@@ -102,9 +102,9 @@ impl<N, V, B, U, Fa> OpenDbRequestBuilder<N, V, B, U, Fa> {
 
     /// Set the [upgradeneeded](https://developer.mozilla.org/en-US/docs/Web/API/IDBOpenDBRequest/upgradeneeded_event)
     /// event handler that returns a `Future`.
-    #[generic_bounds(upgrade_async_cb(fun(U2), fut(U2Fut)))]
+    #[generic_bounds(upgrade_async_cb(U2))]
     #[cfg(feature = "async-upgrade")]
-    pub fn with_on_upgrade_needed_fut<U2, U2Fut>(
+    pub fn with_on_upgrade_needed_fut<U2>(
         self,
         on_upgrade_needed: U2,
     ) -> OpenDbRequestBuilder<N, V, B, OpenDbListener, Fa> {

src/future/open_db/listener.rs

@@ -1,5 +1,6 @@
 use crate::database::{Database, VersionChangeEvent};
 use crate::error::{Error, UnexpectedDataError};
+use crate::transaction::{OnTransactionDrop, Transaction};
 use internal_macros::generic_bounds;
 use std::fmt::{Debug, Display, Formatter};
 use std::mem;
@@ -56,9 +57,16 @@ impl OpenDbListener {
             #[cfg(feature = "async-upgrade")]
             async_notify: Self::fake_rx(),
             listener: Closure::once(move |evt: web_sys::IdbVersionChangeEvent| {
-                let res = Database::from_event(&evt)
-                    .and_then(move |db| callback(VersionChangeEvent::new(evt), db));
-
+                let res = Database::from_event(&evt).and_then(|db| {
+                    Transaction::from_raw_version_change_event(&db, &evt).and_then(|mut tx| {
+                        callback(VersionChangeEvent::new(evt), &tx).inspect(|()| {
+                            // If the callback succeeded, we want to ensure that
+                            // the transaction is committed when dropped and not
+                            // aborted.
+                            tx.on_drop(OnTransactionDrop::Commit);
+                        })
+                    })
+                });
                 Self::handle_result(LBL_UPGRADE, &status, res)
             }),
         }
@@ -154,8 +162,8 @@ const _: () = {
             tokio::sync::mpsc::unbounded_channel().1
         }
 
-        #[generic_bounds(upgrade_async_cb(fun(Fn), fut(Fut)))]
-        pub(crate) fn new_upgrade_fut<Fn, Fut>(callback: Fn) -> Self {
+        #[generic_bounds(upgrade_async_cb(Fn))]
+        pub(crate) fn new_upgrade_fut<Fn>(callback: Fn) -> Self {
             let status = Status::new();
             let (tx, rx) = tokio::sync::mpsc::unbounded_channel();
             Self {
@@ -168,11 +176,21 @@ const _: () = {
                     };
 
                     Self::set_status(&status, Status::Pending, LBL_UPGRADE)?;
-                    let fut = callback(VersionChangeEvent::new(evt), db);
-
                     wasm_bindgen_futures::spawn_local(async move {
-                        let result = match fut.await {
-                            Ok(()) => Status::Ok,
+                        let db = db;
+                        let result = match Transaction::from_raw_version_change_event(&db, &evt) {
+                            Ok(mut transaction) => {
+                                match callback(VersionChangeEvent::new(evt), &transaction).await {
+                                    Ok(()) => {
+                                        // If the callback succeeded, we want to ensure that
+                                        // the transaction is committed when dropped and not
+                                        // aborted.
+                                        transaction.on_drop(OnTransactionDrop::Commit);
+                                        Status::Ok
+                                    }
+                                    Err(e) => Status::Err(e),
+                                }
+                            }
                             Err(e) => Status::Err(e),
                         };
                         let _ = Self::set_status(&status, result, LBL_UPGRADE);