Commit | Line | Data |
6936e902 |
1 | package DBIx::Class::Storage::TxnScopeGuard; |
1bc193ac |
2 | |
3 | use strict; |
4 | use warnings; |
3d56e026 |
5 | use Scalar::Util qw(weaken blessed refaddr); |
b4ad8a74 |
6 | use DBIx::Class; |
e1d9e578 |
7 | use DBIx::Class::_Util qw(is_exception detected_reinvoked_destructor); |
70c28808 |
8 | use DBIx::Class::Carp; |
9c1700e3 |
9 | use namespace::clean; |
10 | |
1bc193ac |
11 | sub new { |
12 | my ($class, $storage) = @_; |
13 | |
f62c5724 |
14 | my $guard = { |
15 | inactivated => 0, |
16 | storage => $storage, |
17 | }; |
18 | |
19 | # we are starting with an already set $@ - in order for things to work we need to |
20 | # be able to recognize it upon destruction - store its weakref |
21 | # recording it before doing the txn_begin stuff |
6e102c8f |
22 | # |
23 | # FIXME FRAGILE - any eval that fails but *does not* rethrow between here |
24 | # and the unwind will trample over $@ and invalidate the entire mechanism |
25 | # There got to be a saner way of doing this... |
35cf7d1a |
26 | # |
27 | # Deliberately *NOT* using is_exception - if someone left a misbehaving |
28 | # antipattern value in $@, it's not our business to whine about it |
29 | if( defined $@ and length $@ ) { |
6e102c8f |
30 | weaken( |
d52c4a75 |
31 | $guard->{existing_exception_ref} = (length ref $@) ? $@ : \$@ |
6e102c8f |
32 | ); |
f62c5724 |
33 | } |
34 | |
1bc193ac |
35 | $storage->txn_begin; |
1f870d5a |
36 | |
6e102c8f |
37 | weaken( $guard->{dbh} = $storage->_dbh ); |
f62c5724 |
38 | |
39 | bless $guard, ref $class || $class; |
1f870d5a |
40 | |
7d216b10 |
41 | $guard; |
1bc193ac |
42 | } |
43 | |
44 | sub commit { |
45 | my $self = shift; |
46 | |
f62c5724 |
47 | $self->{storage}->throw_exception("Refusing to execute multiple commits on scope guard $self") |
48 | if $self->{inactivated}; |
49 | |
0bec44d5 |
50 | # FIXME - this assumption may be premature: a commit may fail and a rollback |
51 | # *still* be necessary. Currently I am not aware of such scenarious, but I |
52 | # also know the deferred constraint handling is *severely* undertested. |
53 | # Making the change of "fire txn and never come back to this" in order to |
54 | # address RT#107159, but this *MUST* be reevaluated later. |
f62c5724 |
55 | $self->{inactivated} = 1; |
0bec44d5 |
56 | $self->{storage}->txn_commit; |
1bc193ac |
57 | } |
58 | |
59 | sub DESTROY { |
e1d9e578 |
60 | return if &detected_reinvoked_destructor; |
3d56e026 |
61 | |
85944825 |
62 | return if $_[0]->{inactivated}; |
3b7f3eac |
63 | |
7d216b10 |
64 | |
84efb6d7 |
65 | # grab it before we've done volatile stuff below |
85944825 |
66 | my $current_exception = ( |
841efcb3 |
67 | is_exception $@ |
f62c5724 |
68 | and |
69 | ( |
85944825 |
70 | ! defined $_[0]->{existing_exception_ref} |
f62c5724 |
71 | or |
85944825 |
72 | refaddr( (length ref $@) ? $@ : \$@ ) != refaddr($_[0]->{existing_exception_ref}) |
f62c5724 |
73 | ) |
85944825 |
74 | ) |
75 | ? $@ |
76 | : undef |
77 | ; |
c6e27318 |
78 | |
84efb6d7 |
79 | |
80 | # if our dbh is not ours anymore, the $dbh weakref will go undef |
81 | $_[0]->{storage}->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK; |
82 | return unless defined $_[0]->{dbh}; |
83 | |
84 | |
85 | carp 'A DBIx::Class::Storage::TxnScopeGuard went out of scope without explicit commit or error. Rolling back.' |
86 | unless defined $current_exception; |
87 | |
88 | |
89 | if ( |
90 | my $rollback_exception = $_[0]->{storage}->__delicate_rollback( |
91 | defined $current_exception |
92 | ? \$current_exception |
93 | : () |
94 | ) |
95 | and |
96 | ! defined $current_exception |
97 | ) { |
98 | carp (join ' ', |
99 | "********************* ROLLBACK FAILED!!! ********************", |
100 | "\nA rollback operation failed after the guard went out of scope.", |
101 | 'This is potentially a disastrous situation, check your data for', |
102 | "consistency: $rollback_exception" |
103 | ); |
3b7f3eac |
104 | } |
36099e8c |
105 | |
84efb6d7 |
106 | $@ = $current_exception |
107 | if DBIx::Class::_ENV_::UNSTABLE_DOLLARAT; |
1bc193ac |
108 | } |
109 | |
110 | 1; |
111 | |
112 | __END__ |
113 | |
114 | =head1 NAME |
115 | |
6936e902 |
116 | DBIx::Class::Storage::TxnScopeGuard - Scope-based transaction handling |
1bc193ac |
117 | |
118 | =head1 SYNOPSIS |
119 | |
120 | sub foo { |
121 | my ($self, $schema) = @_; |
122 | |
123 | my $guard = $schema->txn_scope_guard; |
124 | |
125 | # Multiple database operations here |
126 | |
127 | $guard->commit; |
128 | } |
129 | |
130 | =head1 DESCRIPTION |
131 | |
132 | An object that behaves much like L<Scope::Guard>, but hardcoded to do the |
fd323bf1 |
133 | right thing with transactions in DBIx::Class. |
1bc193ac |
134 | |
135 | =head1 METHODS |
136 | |
137 | =head2 new |
138 | |
6936e902 |
139 | Creating an instance of this class will start a new transaction (by |
140 | implicitly calling L<DBIx::Class::Storage/txn_begin>. Expects a |
1bc193ac |
141 | L<DBIx::Class::Storage> object as its only argument. |
142 | |
143 | =head2 commit |
144 | |
145 | Commit the transaction, and stop guarding the scope. If this method is not |
48580715 |
146 | called and this object goes out of scope (e.g. an exception is thrown) then |
6936e902 |
147 | the transaction is rolled back, via L<DBIx::Class::Storage/txn_rollback> |
1bc193ac |
148 | |
149 | =cut |
150 | |
151 | =head1 SEE ALSO |
152 | |
153 | L<DBIx::Class::Schema/txn_scope_guard>. |
154 | |
a2bd3796 |
155 | L<Scope::Guard> by chocolateboy (inspiration for this module) |
1bc193ac |
156 | |
a2bd3796 |
157 | =head1 FURTHER QUESTIONS? |
1bc193ac |
158 | |
a2bd3796 |
159 | Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>. |
1bc193ac |
160 | |
a2bd3796 |
161 | =head1 COPYRIGHT AND LICENSE |
1bc193ac |
162 | |
a2bd3796 |
163 | This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE> |
164 | by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can |
165 | redistribute it and/or modify it under the same terms as the |
166 | L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>. |