1 package DBIx::Class::Storage::TxnScopeGuard;
6 use Scalar::Util qw(weaken blessed refaddr);
8 use DBIx::Class::_Util qw(is_exception detected_reinvoked_destructor);
13 my ($class, $storage) = @_;
20 # we are starting with an already set $@ - in order for things to work we need to
21 # be able to recognize it upon destruction - store its weakref
22 # recording it before doing the txn_begin stuff
24 # FIXME FRAGILE - any eval that fails but *does not* rethrow between here
25 # and the unwind will trample over $@ and invalidate the entire mechanism
26 # There got to be a saner way of doing this...
27 if (is_exception $@) {
29 $guard->{existing_exception_ref} = (length ref $@) ? $@ : \$@
35 weaken( $guard->{dbh} = $storage->_dbh );
37 bless $guard, ref $class || $class;
45 $self->{storage}->throw_exception("Refusing to execute multiple commits on scope guard $self")
46 if $self->{inactivated};
48 # FIXME - this assumption may be premature: a commit may fail and a rollback
49 # *still* be necessary. Currently I am not aware of such scenarious, but I
50 # also know the deferred constraint handling is *severely* undertested.
51 # Making the change of "fire txn and never come back to this" in order to
52 # address RT#107159, but this *MUST* be reevaluated later.
53 $self->{inactivated} = 1;
54 $self->{storage}->txn_commit;
58 return if &detected_reinvoked_destructor;
62 return if $self->{inactivated};
64 # if our dbh is not ours anymore, the $dbh weakref will go undef
65 $self->{storage}->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
66 return unless $self->{dbh};
68 my $exception = $@ if (
72 ! defined $self->{existing_exception_ref}
74 refaddr( (length ref $@) ? $@ : \$@ ) != refaddr($self->{existing_exception_ref})
81 carp 'A DBIx::Class::Storage::TxnScopeGuard went out of scope without explicit commit or error. Rolling back.'
82 unless defined $exception;
84 my $rollback_exception;
85 # do minimal connectivity check due to weird shit like
86 # https://rt.cpan.org/Public/Bug/Display.html?id=62370
87 try { $self->{storage}->_seems_connected && $self->{storage}->txn_rollback }
88 catch { $rollback_exception = shift };
90 if ( $rollback_exception and (
91 ! defined blessed $rollback_exception
93 ! $rollback_exception->isa('DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION')
95 # append our text - THIS IS A TEMPORARY FIXUP!
96 # a real stackable exception object is in the works
97 if (ref $exception eq 'DBIx::Class::Exception') {
98 $exception->{msg} = "Transaction aborted: $exception->{msg} "
99 ."Rollback failed: ${rollback_exception}";
102 $exception = "Transaction aborted: ${exception} "
103 ."Rollback failed: ${rollback_exception}";
107 "********************* ROLLBACK FAILED!!! ********************",
108 "\nA rollback operation failed after the guard went out of scope.",
109 'This is potentially a disastrous situation, check your data for',
110 "consistency: $rollback_exception"
125 DBIx::Class::Storage::TxnScopeGuard - Scope-based transaction handling
130 my ($self, $schema) = @_;
132 my $guard = $schema->txn_scope_guard;
134 # Multiple database operations here
141 An object that behaves much like L<Scope::Guard>, but hardcoded to do the
142 right thing with transactions in DBIx::Class.
148 Creating an instance of this class will start a new transaction (by
149 implicitly calling L<DBIx::Class::Storage/txn_begin>. Expects a
150 L<DBIx::Class::Storage> object as its only argument.
154 Commit the transaction, and stop guarding the scope. If this method is not
155 called and this object goes out of scope (e.g. an exception is thrown) then
156 the transaction is rolled back, via L<DBIx::Class::Storage/txn_rollback>
162 L<DBIx::Class::Schema/txn_scope_guard>.
164 L<Scope::Guard> by chocolateboy (inspiration for this module)
166 =head1 FURTHER QUESTIONS?
168 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
170 =head1 COPYRIGHT AND LICENSE
172 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
173 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
174 redistribute it and/or modify it under the same terms as the
175 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.