Velocity
  1. Velocity
  2. VELOCITY-615

Inconsistent macro bahaviour in cached and non-cached modes

    Details

    • Type: Bug Bug
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 1.5
    • Fix Version/s: 1.6.1, 1.7
    • Component/s: Engine
    • Labels:
      None
    • Environment:
      Windows XP, Tomcat 6.x, JVM 1.6

      Description

      Here's the scenario; we have a framework that allows us to reload the Velocity runtime so that we can tinker with caching etc at runtime. We normally run development with template caching turned off and deliver to the client with caching turned on.

      There is a problem with inline macros (probably macro libraries too, not sure) whereby they will behave differently once they are compiled and cached then when they are interpreted at runtime. It is all to do with the re-assignment of parameter variables within the macro.

      Here is a very simple example;

      #macro(tmpMacro $FieldNames)
      #set($FieldNames="ingredient." + $FieldNames.replaceAll(",",",ingredient."))
      .....
      #end

      #tmpMacro("one,two,three")

      This works fine when the template is not cached - as soon as you turn on caching, the macro becomes unreliable.
      My original prognosis was that we were upsetting the variable types by converting strings into lists but as you can see, that isn't the case in this example. The problem is solved by changing the assignment to;

      #set($Names="ingredient." + $FieldNames.replaceAll(",",",ingredient."))

      I can appreciate that maybe this type of "re-assignment" of parameters might be an issue, but the real problem is the inconsistency between the cached and non-cached behaviours.

        Issue Links

          Activity

          Hide
          Will Glass-Husain added a comment -

          Have you tried this with the upcoming v 1.6 (download from subversion)? There's been a lot of work to shore up the macro infrastructure.

          WILL

          Show
          Will Glass-Husain added a comment - Have you tried this with the upcoming v 1.6 (download from subversion)? There's been a lot of work to shore up the macro infrastructure. WILL
          Hide
          Nathan Bubna added a comment -

          You can also get a candidate for 1.6-beta1 at:

          http://people.apache.org/~nbubna/velocity/engine/1.6-beta1/

          The way macros are handled under the covers has changed dramatically. Please try out 1.6.

          Show
          Nathan Bubna added a comment - You can also get a candidate for 1.6-beta1 at: http://people.apache.org/~nbubna/velocity/engine/1.6-beta1/ The way macros are handled under the covers has changed dramatically. Please try out 1.6.
          Hide
          Nathan Bubna added a comment -

          I'm not seeing this with 1.6, though admittedly, i'm not sure i fully understand what needs to happen to replicate it. Steve, if this is still a problem for you in 1.6, please re-open this, so we can investigate further.

          Show
          Nathan Bubna added a comment - I'm not seeing this with 1.6, though admittedly, i'm not sure i fully understand what needs to happen to replicate it. Steve, if this is still a problem for you in 1.6, please re-open this, so we can investigate further.
          Hide
          Steve O'Hara added a comment - - edited

          We have upgraded to 1.6 but still have this issue.
          I've condensed it down to the following;

          #set($steve="old value")
          #macro(tmpMacro $steve)
          #set($steve="new value $steve")
          $steve
          #end
          #tmpMacro("dave")

          As you can see, there is some messing with the scope going on here but this is in essence what is occurring in our application on a much larger scale.
          I would expect the result to be "new value dave" but it's not, bizarrely it's "dave"

          This worked as expected in 1.5 and produced "new value dave"

          Thes are my velocity settings;

          objProps.setProperty("resource.loader", "Scaffold");
          objProps.setProperty("Scaffold.resource.loader.class", "com.pivotal.scaffold.ScaffoldResourceLoader");
          objProps.setProperty("Scaffold.resource.loader.templatepath", sPath + "/WEB-INF/templates");
          objProps.setProperty("Scaffold.resource.loader.reportpath", sPath + "/WEB-INF/report");
          objProps.setProperty("Scaffold.resource.loader.macrospath", sPath + "/WEB-INF/macros");
          objProps.setProperty("Scaffold.resource.loader.modificationCheckInterval", "10");
          objProps.setProperty("runtime.log.logsystem.class", "org.apache.velocity.runtime.log.Log4JLogChute");
          objProps.setProperty("runtime.log.logsystem.log4j.category", "org.apache.velocity");
          objProps.setProperty("velocimacro.permissions.allow.inline", "true");
          objProps.setProperty("velocimacro.permissions.allow.inline.to.replace.global", "false");
          objProps.setProperty("velocimacro.permissions.allow.inline.local.scope", "true");
          objProps.setProperty("velocimacro.context.localscope", "false");
          objProps.setProperty("velocimacro.arguments.strict", "true");
          objProps.setProperty("input.encoding", ScaffoldApplication.DEFAULT_ENCODING);
          objProps.setProperty("output.encoding", ScaffoldApplication.DEFAULT_ENCODING);
          objProps.setProperty("directive.parse.max.depth", "1000");

          Show
          Steve O'Hara added a comment - - edited We have upgraded to 1.6 but still have this issue. I've condensed it down to the following; #set($steve="old value") #macro(tmpMacro $steve) #set($steve="new value $steve") $steve #end #tmpMacro("dave") As you can see, there is some messing with the scope going on here but this is in essence what is occurring in our application on a much larger scale. I would expect the result to be "new value dave" but it's not, bizarrely it's "dave" This worked as expected in 1.5 and produced "new value dave" Thes are my velocity settings; objProps.setProperty("resource.loader", "Scaffold"); objProps.setProperty("Scaffold.resource.loader.class", "com.pivotal.scaffold.ScaffoldResourceLoader"); objProps.setProperty("Scaffold.resource.loader.templatepath", sPath + "/WEB-INF/templates"); objProps.setProperty("Scaffold.resource.loader.reportpath", sPath + "/WEB-INF/report"); objProps.setProperty("Scaffold.resource.loader.macrospath", sPath + "/WEB-INF/macros"); objProps.setProperty("Scaffold.resource.loader.modificationCheckInterval", "10"); objProps.setProperty("runtime.log.logsystem.class", "org.apache.velocity.runtime.log.Log4JLogChute"); objProps.setProperty("runtime.log.logsystem.log4j.category", "org.apache.velocity"); objProps.setProperty("velocimacro.permissions.allow.inline", "true"); objProps.setProperty("velocimacro.permissions.allow.inline.to.replace.global", "false"); objProps.setProperty("velocimacro.permissions.allow.inline.local.scope", "true"); objProps.setProperty("velocimacro.context.localscope", "false"); objProps.setProperty("velocimacro.arguments.strict", "true"); objProps.setProperty("input.encoding", ScaffoldApplication.DEFAULT_ENCODING); objProps.setProperty("output.encoding", ScaffoldApplication.DEFAULT_ENCODING); objProps.setProperty("directive.parse.max.depth", "1000");
          Hide
          Nathan Bubna added a comment -

          So, i can understand why you would expect this to work, but it sure ain't pretty to have everything named $foo. You have a global $foo, then 'dave' proxied as a $foo macro argument and then changing the value of $foo. It appears that this is confusing ProxyVMContext. I think you'll notice some errors in your logs letting you know this isn't working for it. So, at least there's a warning about this.

          You'll find that changing it to:

          #set($steve="old value")
          #macro(tmpMacro $bob)
          #set($steve="new value $bob")
          $steve
          #end
          #tmpMacro("dave")

          Should fix your problem.

          In the meantime, i'll see if i can impart some greater wisdom to ProxyVMContext regarding the tangled web you've woven. I can't see any good reason this should be disallowed, tangled though it is.

          i also don't see how this latest example has anything to do with cached vs non-cached modes. I can replicate it just fine in non-cached mode. this is clearly different than the original bug you experienced in 1.5.

          Show
          Nathan Bubna added a comment - So, i can understand why you would expect this to work, but it sure ain't pretty to have everything named $foo. You have a global $foo, then 'dave' proxied as a $foo macro argument and then changing the value of $foo. It appears that this is confusing ProxyVMContext. I think you'll notice some errors in your logs letting you know this isn't working for it. So, at least there's a warning about this. You'll find that changing it to: #set($steve="old value") #macro(tmpMacro $bob) #set($steve="new value $bob") $steve #end #tmpMacro("dave") Should fix your problem. In the meantime, i'll see if i can impart some greater wisdom to ProxyVMContext regarding the tangled web you've woven. I can't see any good reason this should be disallowed, tangled though it is. i also don't see how this latest example has anything to do with cached vs non-cached modes. I can replicate it just fine in non-cached mode. this is clearly different than the original bug you experienced in 1.5.

            People

            • Assignee:
              Unassigned
              Reporter:
              Steve O'Hara
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development