Changeset 13773

Timestamp:

01/21/12 01:49:56 (4 months ago)

Author:

GeorgeClark

Message:

Item9563: Refresh prefs cache b4 call afterSave

Prefs are cached, so any attempt to read changed topic preferences in
the afterSaveHandler fails because the cached values from before the
save are returned.

The simple fix appears to be to delete the preferences cache for the
object before dispatching the afterSaveHandler.

Updated unit tests to verify the issue.

There is stil some issue remaining - Foswiki::Func returns null
parameters when called in the afterSaveHandler.

Location:

branches/Release01x01

Files:

• UnitTestContrib/test/unit/PluginHandlerTests.pm (modified) (6 diffs)
• core/lib/Foswiki/Meta.pm (modified) (1 diff)

branches/Release01x01/UnitTestContrib/test/unit/PluginHandlerTests.pm

@@ -152 +152 @@
     $Foswiki::cfg{Plugins}{ $this->{plugin_name} }{Module} =
       "Foswiki::Plugins::$this->{plugin_name}";
-    $this->{session}->finish();
-    $this->{session} = new Foswiki();    # default user
+    $this->createNewFoswikiSession();
     eval "\$Foswiki::Plugins::$this->{plugin_name}::tester = \$this;";
     $this->checkCalls( 1, 'initPlugin' );
@@ -190 +189 @@
 
     my $q = Foswiki::Func::getRequestObject();
-    $this->{session}->finish();
-    $this->{session} = new Foswiki( $Foswiki::cfg{GuestUserLogin}, $q );
+    $this->createNewFoswikiSession( $Foswiki::cfg{GuestUserLogin}, $q );
 
     $this->makePlugin( 'saveHandlers', <<'HERE');
@@ -216 +214 @@
     $tester->assert_str_equals('Wibble', $_[4]->get('WIBBLE')->{wibble});
     $tester->assert_matches( qr/B4SAVE/, $_[0]);
-    Foswiki::Func::pushTopicContext( $this->{test_web}, 'Tropic' );
-
-    #SMELL:  This fails due to cached preferences
-    #$tester->assert_str_equals( "AFTER",
-    #        $_[4]->getPreference("BLAH"));
+
+    $tester->assert_str_equals( "AFTER",
+            $_[4]->getPreference("BLAH"));
 
     #SMELL:  And for some reason this returns null instead of either BEFORE or AFTER
-            #Foswiki::Func::getPreferencesValue("BLAH") );
+    # Foswiki::Func::pushTopicContext( $this->{test_web}, 'Tropic' );
+    # $tester->assert_str_equals( "AFTER",
+    #  Foswiki::Func::getPreferencesValue("BLAH") );
+
     $called->{afterSaveHandler}++;
 }
@@ -237 +236 @@
     $this->checkCalls( 1, 'afterSaveHandler' );
 
+    $this->createNewFoswikiSession(); # undef, $topicquery );
+    Foswiki::Func::pushTopicContext( $this->{test_web}, 'Tropic' );
+
     my $newMeta =
       Foswiki::Meta->load( $this->{session}, $this->{test_web}, "Tropic" );
@@ -243 +245 @@
     $this->assert_str_equals( "AFTER",  $newMeta->getPreference("BLAH") );
 
-    #SMELL: Without this call, getPreferences returns BEFORE
-    Foswiki::Func::pushTopicContext( $this->{test_web}, 'Tropic' );
     $this->assert_str_equals( "AFTER",
         Foswiki::Func::getPreferencesValue("BLAH") );
@@ -687 +687 @@
 HERE
 
-    $this->{session}->finish();
+    $this->createNewFoswikiSession();
     $this->checkCalls( 1, 'finishPlugin' );
-    $this->{session} = new Foswiki();
 }
 

branches/Release01x01/core/lib/Foswiki/Meta.pm

@@ -1939 +1939 @@
     if ( $plugins->haveHandlerFor('afterSaveHandler') ) {
         my $text = $this->getEmbeddedStoreForm();
+        delete $this->{_preferences};  # Make sure handler has changed prefs
         my $error = $signal ? $signal->{-text} : undef;
         $plugins->dispatch( 'afterSaveHandler', $text, $this->{_topic},