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...
28 # Deliberately *NOT* using is_exception - if someone left a misbehaving
29 # antipattern value in $@, it's not our business to whine about it
30 if( defined $@ and length $@ ) {
32 $guard->{existing_exception_ref} = (length ref $@) ? $@ : \$@
38 weaken( $guard->{dbh} = $storage->_dbh );
40 bless $guard, ref $class || $class;
48 $self->{storage}->throw_exception("Refusing to execute multiple commits on scope guard $self")
49 if $self->{inactivated};
51 # FIXME - this assumption may be premature: a commit may fail and a rollback
52 # *still* be necessary. Currently I am not aware of such scenarious, but I
53 # also know the deferred constraint handling is *severely* undertested.
54 # Making the change of "fire txn and never come back to this" in order to
55 # address RT#107159, but this *MUST* be reevaluated later.
56 $self->{inactivated} = 1;
57 $self->{storage}->txn_commit;
61 return if &detected_reinvoked_destructor;
65 return if $self->{inactivated};
67 # if our dbh is not ours anymore, the $dbh weakref will go undef
68 $self->{storage}->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
69 return unless $self->{dbh};
71 my $exception = $@ if (
75 ! defined $self->{existing_exception_ref}
77 refaddr( (length ref $@) ? $@ : \$@ ) != refaddr($self->{existing_exception_ref})
84 carp 'A DBIx::Class::Storage::TxnScopeGuard went out of scope without explicit commit or error. Rolling back.'
85 unless defined $exception;
87 my $rollback_exception;
88 # do minimal connectivity check due to weird shit like
89 # https://rt.cpan.org/Public/Bug/Display.html?id=62370
90 try { $self->{storage}->_seems_connected && $self->{storage}->txn_rollback }
91 catch { $rollback_exception = shift };
93 if ( $rollback_exception and (
94 ! defined blessed $rollback_exception
96 ! $rollback_exception->isa('DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION')
98 # append our text - THIS IS A TEMPORARY FIXUP!
99 # a real stackable exception object is in the works
100 if (ref $exception eq 'DBIx::Class::Exception') {
101 $exception->{msg} = "Transaction aborted: $exception->{msg} "
102 ."Rollback failed: ${rollback_exception}";
105 $exception = "Transaction aborted: ${exception} "
106 ."Rollback failed: ${rollback_exception}";
110 "********************* ROLLBACK FAILED!!! ********************",
111 "\nA rollback operation failed after the guard went out of scope.",
112 'This is potentially a disastrous situation, check your data for',
113 "consistency: $rollback_exception"
128 DBIx::Class::Storage::TxnScopeGuard - Scope-based transaction handling
133 my ($self, $schema) = @_;
135 my $guard = $schema->txn_scope_guard;
137 # Multiple database operations here
144 An object that behaves much like L<Scope::Guard>, but hardcoded to do the
145 right thing with transactions in DBIx::Class.
151 Creating an instance of this class will start a new transaction (by
152 implicitly calling L<DBIx::Class::Storage/txn_begin>. Expects a
153 L<DBIx::Class::Storage> object as its only argument.
157 Commit the transaction, and stop guarding the scope. If this method is not
158 called and this object goes out of scope (e.g. an exception is thrown) then
159 the transaction is rolled back, via L<DBIx::Class::Storage/txn_rollback>
165 L<DBIx::Class::Schema/txn_scope_guard>.
167 L<Scope::Guard> by chocolateboy (inspiration for this module)
169 =head1 FURTHER QUESTIONS?
171 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
173 =head1 COPYRIGHT AND LICENSE
175 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
176 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
177 redistribute it and/or modify it under the same terms as the
178 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.