chore: synchronize workspaces

storage/transactional.go

@@ -5,15 +5,34 @@ package storage
 
 import "context"
 
-// A storage provider that has support for transactions should implement this
-// interface to ensure atomicity for certain flows that require transactional
-// semantics. When atomicity is required, Fosite will group calls to the storage
-// provider in a function and passes that to Transaction.  Implementations are
+// Transactional should be implemented by storage providers that support
+// transactions to ensure atomicity for certain flows that require transactional
+// semantics. When atomicity is required, Ory Fosite will group calls to the storage
+// provider in a function and passes that to Transaction. Implementations are
 // expected to execute these calls in a transactional manner. Typically, a
 // handle to the transaction will be stored in the context.
 //
 // Implementations should rollback (or retry) the transaction if the callback
 // returns an error.
+//
+//	function Transcation(ctx context.Context, f func(context.Context) error) error {
+//	  tx, err := storage.BeginTx(ctx)
+//	  if err != nil {
+//	    return err
+//	  }
+//
+//	  defer function() {
+//	  	if err != nil {
+//	  		tx.Rollback()
+//	  	}
+//	  }()
+//
+//	  if err := f(tx); err != nil {
+//	    return err
+//	  }
+//
+//	  return tx.Commit()
+//	}
 type Transactional interface {
 	Transaction(context.Context, func(context.Context) error) error
 }