Merge the relationship resolution rework
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Storage / TxnScopeGuard.pm
index 5b72f68..f961c4e 100644 (file)
@@ -2,153 +2,112 @@ package DBIx::Class::Storage::TxnScopeGuard;
 
 use strict;
 use warnings;
-use Try::Tiny;
-use Scalar::Util qw/weaken blessed/;
-use DBIx::Class::Exception;
+use Scalar::Util qw(weaken blessed refaddr);
+use DBIx::Class;
+use DBIx::Class::_Util qw(is_exception detected_reinvoked_destructor);
 use DBIx::Class::Carp;
-
-# temporary until we fix the $@ issue in core
-# we also need a real appendable, stackable exception object
-# (coming soon)
-BEGIN {
-  if ($] >= 5.013001 and $] <= 5.013007) {
-    *IS_BROKEN_PERL = sub () { 1 };
-  }
-  else {
-    *IS_BROKEN_PERL = sub () { 0 };
-  }
-}
-
 use namespace::clean;
 
-my ($guards_count, $compat_handler, $foreign_handler);
-
 sub new {
   my ($class, $storage) = @_;
 
+  my $guard = {
+    inactivated => 0,
+    storage => $storage,
+  };
+
+  # we are starting with an already set $@ - in order for things to work we need to
+  # be able to recognize it upon destruction - store its weakref
+  # recording it before doing the txn_begin stuff
+  #
+  # FIXME FRAGILE - any eval that fails but *does not* rethrow between here
+  # and the unwind will trample over $@ and invalidate the entire mechanism
+  # There got to be a saner way of doing this...
+  #
+  # Deliberately *NOT* using is_exception - if someone left a misbehaving
+  # antipattern value in $@, it's not our business to whine about it
+  weaken(
+    $guard->{existing_exception_ref} = (length ref $@) ? $@ : \$@
+  ) if( defined $@ and length $@ );
+
   $storage->txn_begin;
-  my $guard = bless [ 0, $storage, $storage->_dbh ], ref $class || $class;
-
-
-  # install a callback carefully
-  if (IS_BROKEN_PERL and !$guards_count) {
-
-    # if the thrown exception is a plain string, wrap it in our
-    # own exception class
-    # this is actually a pretty cool idea, may very well keep it
-    # after perl is fixed
-    $compat_handler ||= bless(
-      sub {
-        $@ = (blessed($_[0]) or ref($_[0]))
-          ? $_[0]
-          : bless ( { msg => $_[0] }, 'DBIx::Class::Exception')
-        ;
-        die;
-      },
-      '__TxnScopeGuard__FIXUP__',
-    );
 
-    if ($foreign_handler = $SIG{__DIE__}) {
-      $SIG{__DIE__} = bless (
-        sub {
-          # we trust the foreign handler to do whatever it wants, all we do is set $@
-          eval { $compat_handler->(@_) };
-          $foreign_handler->(@_);
-        },
-        '__TxnScopeGuard__FIXUP__',
-      );
-    }
-    else {
-      $SIG{__DIE__} = $compat_handler;
-    }
-  }
+  weaken( $guard->{dbh} = $storage->_dbh );
 
-  $guards_count++;
+  bless $guard, ref $class || $class;
 
-  weaken ($guard->[2]);
   $guard;
 }
 
 sub commit {
   my $self = shift;
 
-  $self->[1]->txn_commit;
-  $self->[0] = 1;
+  $self->{storage}->throw_exception("Refusing to execute multiple commits on scope guard $self")
+    if $self->{inactivated};
+
+  # FIXME - this assumption may be premature: a commit may fail and a rollback
+  # *still* be necessary. Currently I am not aware of such scenarious, but I
+  # also know the deferred constraint handling is *severely* undertested.
+  # Making the change of "fire txn and never come back to this" in order to
+  # address RT#107159, but this *MUST* be reevaluated later.
+  $self->{inactivated} = 1;
+  $self->{storage}->txn_commit;
 }
 
 sub DESTROY {
-  my ($dismiss, $storage) = @{$_[0]};
+  return if &detected_reinvoked_destructor;
+
+  return if $_[0]->{inactivated};
+
+
+  # grab it before we've done volatile stuff below
+  my $current_exception = (
+    is_exception $@
+      and
+    (
+      ! defined $_[0]->{existing_exception_ref}
+        or
+      refaddr( (length ref $@) ? $@ : \$@ ) != refaddr($_[0]->{existing_exception_ref})
+    )
+  )
+    ? $@
+    : undef
+  ;
+
+
+  # if our dbh is not ours anymore, the $dbh weakref will go undef
+  $_[0]->{storage}->_verify_pid unless DBIx::Class::_ENV_::BROKEN_FORK;
+  return unless defined $_[0]->{dbh};
+
+
+  carp 'A DBIx::Class::Storage::TxnScopeGuard went out of scope without explicit commit or error. Rolling back'
+    unless defined $current_exception;
 
-  $guards_count--;
 
-  # don't touch unless it's ours, and there are no more of us left
   if (
-    IS_BROKEN_PERL
+    my $rollback_exception = $_[0]->{storage}->__delicate_rollback(
+      defined $current_exception
+        ? \$current_exception
+        : ()
+    )
       and
-    !$guards_count
+    ! defined $current_exception
   ) {
-
-    if (ref $SIG{__DIE__} eq '__TxnScopeGuard__FIXUP__') {
-      # restore what we saved
-      if ($foreign_handler) {
-        $SIG{__DIE__} = $foreign_handler;
-      }
-      else {
-        delete $SIG{__DIE__};
-      }
-    }
-
-    # make sure we do not leak the foreign one in case it exists
-    undef $foreign_handler;
+    carp (join ' ',
+      "********************* ROLLBACK FAILED!!! ********************",
+      "\nA rollback operation failed after the guard went out of scope.",
+      'This is potentially a disastrous situation, check your data for',
+      "consistency: $rollback_exception"
+    );
   }
 
-  return if $dismiss;
-
-  # if our dbh is not ours anymore, the weakref will go undef
-  $storage->_verify_pid;
-  return unless $_[0]->[2];
-
-  my $exception = $@;
-
-  {
-    local $@;
-
-    carp 'A DBIx::Class::Storage::TxnScopeGuard went out of scope without explicit commit or error. Rolling back.'
-      unless $exception;
-
-    my $rollback_exception;
-    # do minimal connectivity check due to weird shit like
-    # https://rt.cpan.org/Public/Bug/Display.html?id=62370
-    try { $storage->_seems_connected && $storage->txn_rollback }
-    catch { $rollback_exception = shift };
-
-    if ( $rollback_exception and (
-      ! defined blessed $rollback_exception
-          or
-      ! $rollback_exception->isa('DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION')
-    ) ) {
-      # append our text - THIS IS A TEMPORARY FIXUP!
-      # a real stackable exception object is in the works
-      if (ref $exception eq 'DBIx::Class::Exception') {
-        $exception->{msg} = "Transaction aborted: $exception->{msg} "
-          ."Rollback failed: ${rollback_exception}";
-      }
-      elsif ($exception) {
-        $exception = "Transaction aborted: ${exception} "
-          ."Rollback failed: ${rollback_exception}";
-      }
-      else {
-        carp (join ' ',
-          "********************* ROLLBACK FAILED!!! ********************",
-          "\nA rollback operation failed after the guard went out of scope.",
-          'This is potentially a disastrous situation, check your data for',
-          "consistency: $rollback_exception"
-        );
-      }
-    }
-  }
+  $@ = $current_exception
+    if DBIx::Class::_ENV_::UNSTABLE_DOLLARAT;
 
-  $@ = $exception unless IS_BROKEN_PERL;
+  # Dummy NEXTSTATE ensuring the all temporaries on the stack are garbage
+  # collected before leaving this scope. Depending on the code above, this
+  # may very well be just a preventive measure guarding future modifications
+  undef;
 }
 
 1;
@@ -196,13 +155,15 @@ the transaction is rolled back, via L<DBIx::Class::Storage/txn_rollback>
 
 L<DBIx::Class::Schema/txn_scope_guard>.
 
-=head1 AUTHOR
+L<Scope::Guard> by chocolateboy (inspiration for this module)
 
-Ash Berlin, 2008.
+=head1 FURTHER QUESTIONS?
 
-Inspired by L<Scope::Guard> by chocolateboy.
+Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
 
-This module is free software. It may be used, redistributed and/or modified
-under the same terms as Perl itself.
+=head1 COPYRIGHT AND LICENSE
 
-=cut
+This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
+by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
+redistribute it and/or modify it under the same terms as the
+L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.