Merge flash in session and finalize before sending response patches

diff --git a/.shipit b/.shipit
new file mode 100644 (file)
index 0000000..9970de4
--- /dev/null
+++ b/.shipit
@@ -0,0 +1,5 @@
+# auto-generated shipit config file.
+steps = FindVersion, ChangeVersion, CheckChangeLog, DistTest, Commit, Tag, MakeDist, UploadCPAN
+
+svn.tagpattern = http://dev.catalyst.perl.org/repos/Catalyst/tags/Catalyst-Plugin-Session/%v
+CheckChangeLog.files = Changes

diff --git a/Changes b/Changes
index 8f2f749..d23ead0 100644 (file)
--- a/Changes
+++ b/Changes
@@ -1,10 +1,14 @@
 Revision history for Perl extension Catalyst::Plugin::Session
 
-0.20    XXX
+0.19_01 2009-01-09
+        - Use shipit to package the dist
         - Switch to Module::install
         - Flash data is now stored inside the session (key "__flash") to avoid
           duplicate entry errors caused by simultaneous select/insert/delete of
-          flash rows when using DBI as a Store.
+          flash rows when using DBI as a Store. (Sergio Salvi)
+        - Fix session finalization order that caused HTTP responses to be sent
+          before the session is actually finalized and stored in its Store.
+          (Sergio Salvi)
 
 0.19    2007-10-08
 

diff --git a/Makefile.PL b/Makefile.PL
index a8dfe6f..073ce16 100644 (file)
--- a/Makefile.PL
+++ b/Makefile.PL
@@ -16,6 +16,7 @@ requires 'Digest';
 requires 'File::Spec';
 requires 'File::Temp';
 requires 'Object::Signature';
+requires 'MRO::Compat';
 
 # an indirect dep. needs a certain version.
 requires 'Tie::RefHash' => '1.34';

diff --git a/lib/Catalyst/Plugin/Session.pm b/lib/Catalyst/Plugin/Session.pm
index 8b66e78..e9c2a13 100644 (file)
--- a/lib/Catalyst/Plugin/Session.pm
+++ b/lib/Catalyst/Plugin/Session.pm
@@ -13,7 +13,7 @@ use overload            ();
 use Object::Signature   ();
 use Carp;
 
-our $VERSION = '0.20';
+our $VERSION = '0.19_01';
 
 my @session_data_accessors; # used in delete_session
 BEGIN {
@@ -98,13 +98,15 @@ sub finalize_headers {
     return $c->NEXT::finalize_headers(@_);
 }
 
-sub finalize {
+sub finalize_body {
     my $c = shift;
-    my $ret = $c->NEXT::finalize(@_);
 
-    # then finish the rest
+    # We have to finalize our session *before* $c->engine->finalize_xxx is called,
+    # because we do not want to send the HTTP response before the session is stored/committed to
+    # the session database (or whatever Session::Store you use).
     $c->finalize_session;
-    return $ret;
+
+    return $c->NEXT::finalize_body(@_);
 }
 
 sub finalize_session {
@@ -764,10 +766,10 @@ prepare time.
 This method is extended and will extend the expiry time before sending
 the response.
 
-=item finalize
+=item finalize_body
 
-This method is extended and will call finalize_session after the other
-finalizes run.  Here we persist the session data if a session exists.
+This method is extended and will call finalize_session before the other
+finalize_body methods run.  Here we persist the session data if a session exists.
 
 =item initialize_session_data
 
@@ -1010,10 +1012,14 @@ Andy Grundman
 
 Christian Hansen
 
-Yuval Kogman, C<nothingmuch@woobling.org> (current maintainer)
+Yuval Kogman, C<nothingmuch@woobling.org>
 
 Sebastian Riedel
 
+Tomas Doran (t0m) C<bobtfish@bobtfish.net> (current maintainer)
+
+Sergio Salvi
+
 And countless other contributers from #catalyst. Thanks guys!
 
 =head1 COPYRIGHT & LICENSE

diff --git a/t/03_flash.t b/t/03_flash.t
index 4000422..f58222c 100644 (file)
--- a/t/03_flash.t
+++ b/t/03_flash.t
@@ -33,7 +33,7 @@ is_deeply( $c->flash, {}, "nothing in flash" );
 
 $c->flash->{foo} = "moose";
 
-$c->finalize;
+$c->finalize_body;
 
 is_deeply( $c->flash, { foo => "moose" }, "one key in flash" );
 
@@ -45,21 +45,21 @@ is_deeply( $c->flash, { foo => "moose", bar => "gorch" }, "two keys in flash" );
 
 cmp_deeply( $c->session, { __updated => re('^\d+$'), __flash => $c->flash }, "session still has __flash with flash data" );
 
-$c->finalize;
+$c->finalize_body;
 
 is_deeply( $c->flash, { bar => "gorch" }, "one key in flash" );
 
-$c->finalize;
+$c->finalize_body;
 
 $c->flash->{test} = 'clear_flash';
 
-$c->finalize;
+$c->finalize_body;
 
 $c->clear_flash();
 
 is_deeply( $c->flash, {}, "nothing in flash after clear_flash" );
 
-$c->finalize;
+$c->finalize_body;
 
 is_deeply( $c->flash, {}, "nothing in flash after finalize after clear_flash" );
 
@@ -69,7 +69,7 @@ $c->flash->{bar} = "gorch";
 
 $c->config->{session}{flash_to_stash} = 1;
 
-$c->finalize;
+$c->finalize_body;
 $c->prepare_action;
 
 is_deeply( $c->stash, { bar => "gorch" }, "flash copied to stash" );

diff --git a/t/06_finalize.t b/t/06_finalize.t
deleted file mode 100644 (file)
index b1aac67..0000000
--- a/t/06_finalize.t
+++ /dev/null
@@ -1,41 +0,0 @@
-#!/usr/bin/perl
-
-use strict;
-use warnings;
-
-use Test::More;
-
-BEGIN {
-    if ( eval { require Catalyst::Plugin::Session::State::Cookie } ) {
-        plan tests => 3;
-    } else {
-        plan skip_all => "Catalyst::Plugin::Session::State::Cookie required";
-    }
-}
-
-my $finalized = 0;
-
-{
-  package TestPlugin;
-  BEGIN { $INC{"TestPlugin.pm"} = 1 } # nasty hack for 5.8.6
-
-  sub finalize_session { $finalized = 1 }
-
-  sub finalize { die "already finalized_session()" if $finalized }
-
-  # Structure inheritance so TestPlugin->finalize() is called *after* 
-  # Catalyst::Plugin::Session->finalize()
-  package TestApp;
-
-  use Catalyst qw/
-    Session Session::Store::Dummy Session::State::Cookie +TestPlugin 
-  /;
-  __PACKAGE__->setup;
-}
-
-BEGIN { use_ok('Catalyst::Plugin::Session') }
-
-my $c = TestApp->new;
-eval { $c->finalize };
-ok(!$@, "finalize_session() called after all other finalize() methods");
-ok($finalized, "finalize_session() called");