Changeset 13836

Timestamp:

01/27/12 05:14:49 (4 weeks ago)

Author:

PaulHarvey

Message:

Item11431: add ASSERTs for SINGLE_SINGLETONS

Conflicts:

lib/Foswiki.pm

Location:

branches/Release01x01/core/lib

Files:

• Foswiki.pm (modified) (6 diffs)
• Foswiki/Func.pm (modified) (4 diffs)
• Foswiki/Plugin.pm (modified) (1 diff)
• Foswiki/Plugins.pm (modified) (3 diffs)

branches/Release01x01/core/lib/Foswiki.pm

@@ -80 +80 @@
 our $OC      = "<!--\0";
 our $CC      = "\0-->";
+
+# This variable is set if Foswiki is running in unit test mode.
+# It is provided so that modules can detect unit test mode to avoid
+# corrupting data spaces.
+our $inUnitTestMode = 0;
+
+sub SINGLE_SINGLETONS       { 0 }
+sub SINGLE_SINGLETONS_TRACE { 0 }
 
 # Returns the full path of the directory containing Foswiki.pm
@@ -1673 +1681 @@
         CGI::charset( $Foswiki::cfg{Site}{CharSet} );
     }
+    if (SINGLE_SINGLETONS_TRACE) {
+        require Data::Dumper;
+        print STDERR "new $this: "
+          . Data::Dumper->Dump( [ [caller], [ caller(1) ] ] );
+    }
 
     $this->{request}  = $query;
@@ -1681 +1694 @@
     # This is required in case we get an exception during
     # initialisation, so that we have a session to handle it with.
+    ASSERT( !$Foswiki::Plugins::SESSION ) if SINGLE_SINGLETONS;
     $Foswiki::Plugins::SESSION = $this;
+    ASSERT( $Foswiki::Plugins::SESSION->isa('Foswiki') ) if DEBUG;
 
     # Tell Foswiki::Response which charset we are using if not default
@@ -2131 +2146 @@
 
     undef $this->{DebugVerificationCode};    # from Foswiki::UI::Register
+    if (SINGLE_SINGLETONS_TRACE) {
+        require Data::Dumper;
+        print STDERR "finish $this: "
+          . Data::Dumper->Dump( [ [caller], [ caller(1) ] ] );
+    }
+    if (SINGLE_SINGLETONS) {
+        ASSERT( defined $Foswiki::Plugins::SESSION );
+        ASSERT( $Foswiki::Plugins::SESSION == $this );
+        ASSERT( $Foswiki::Plugins::SESSION->isa('Foswiki') );
+    }
+    undef $Foswiki::Plugins::SESSION;
 
     if (DEBUG) {
@@ -2396 +2422 @@
 
     # Make sure func works, for registered tag handlers
+    if (SINGLE_SINGLETONS) {
+        ASSERT( defined $Foswiki::Plugins::SESSION );
+        ASSERT( $Foswiki::Plugins::SESSION == $this );
+    }
     local $Foswiki::Plugins::SESSION = $this;
+    ASSERT( $Foswiki::Plugins::SESSION->isa('Foswiki') ) if DEBUG;
 
     my $text = $topicObject->text();
@@ -2733 +2764 @@
 
     # Make sure func works, for registered tag handlers
-    $Foswiki::Plugins::SESSION = $this;
+    if (SINGLE_SINGLETONS) {
+        ASSERT( defined $Foswiki::Plugins::SESSION );
+        ASSERT( $Foswiki::Plugins::SESSION == $this );
+    }
+    local $Foswiki::Plugins::SESSION = $this;
+    ASSERT( $Foswiki::Plugins::SESSION->isa('Foswiki') ) if DEBUG;
 
     # NOTE TO DEBUGGERS

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

@@ -576 +576 @@
     my ( $tag, $function, $syntax ) = @_;
     ASSERT($Foswiki::Plugins::SESSION) if DEBUG;
+    ASSERT( $Foswiki::Plugins::SESSION->isa('Foswiki') ) if DEBUG;
 
     # $pluginContext is undefined if a contrib registers a tag handler.
@@ -589 +590 @@
         sub {
             my ( $session, $params, $topicObject ) = @_;
-            my $record = $Foswiki::Plugins::SESSION;
-            $Foswiki::Plugins::SESSION = $_[0];
+            local $Foswiki::Plugins::SESSION = $session;
 
             # $pluginContext is defined for all plugins
@@ -607 +607 @@
 
             # Compatibility; expand $topicObject to the topic and web
-            my $result =
-              &$function( $session, $params, $topicObject->topic,
+            return &$function( $session, $params, $topicObject->topic,
                 $topicObject->web, $topicObject );
-            $Foswiki::Plugins::SESSION = $record;
-            return $result;
         },
         $syntax
@@ -704 +701 @@
             my $record = $Foswiki::Plugins::SESSION;
             $Foswiki::Plugins::SESSION = $_[0];
+            ASSERT( $Foswiki::Plugins::SESSION->isa('Foswiki') ) if DEBUG;
             my $result = &$function(@_);
             $Foswiki::Plugins::SESSION = $record;

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

@@ -164 +164 @@
     # Set the session for this call stack
     local $Foswiki::Plugins::SESSION = $this->{session};
+    ASSERT( $Foswiki::Plugins::SESSION->isa('Foswiki') ) if DEBUG;
 
     my $sub = $p . "::initPlugin";

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

@@ -225 +225 @@
     # Set the session for this call stack
     local $Foswiki::Plugins::SESSION = $this->{session};
+    ASSERT( $Foswiki::Plugins::SESSION->isa('Foswiki') ) if DEBUG;
 
     foreach my $plugin ( @{ $this->{plugins} } ) {
@@ -247 +248 @@
     # Set the session for this call stack
     local $Foswiki::Plugins::SESSION = $this->{session};
+    ASSERT( $Foswiki::Plugins::SESSION->isa('Foswiki') ) if DEBUG;
 
     foreach my $plugin ( @{ $this->{plugins} } ) {
@@ -326 +328 @@
         # Set the value of $SESSION for this call stack
         local $SESSION = $this->{session};
+        ASSERT( $Foswiki::Plugins::SESSION->isa('Foswiki') ) if DEBUG;
 
         # apply handler on the remaining list of args