Soy jbcsrc: Add information about used injected parameters and callees to @TemplateMetadata

This is a prerequisite for adding precompilation support.  The SoySauce object has a method getTransitiveIjParamsForTemplate which is currently implemented via a specific compiler pass.  In order to support this method in a precompilation usecase we will need to store this information somewhere else.  The current plan is to add metadata to each generated template and then lazily calculate this data by crawling through the callgraph.
-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=106638022

Author: lukesandberg

java/src/com/google/template/soy/jbcsrc/TemplateCompiler.java

@@ -28,17 +28,24 @@
 import static com.google.template.soy.jbcsrc.StandardNames.IJ_FIELD;
 import static com.google.template.soy.jbcsrc.StandardNames.PARAMS_FIELD;
 import static com.google.template.soy.jbcsrc.StandardNames.STATE_FIELD;
+import static com.google.template.soy.soytree.SoytreeUtils.getAllNodesOfType;
 
 import com.google.common.collect.ImmutableMap;
 import com.google.template.soy.data.SoyRecord;
 import com.google.template.soy.data.SoyValueProvider;
+import com.google.template.soy.exprtree.VarDefn;
+import com.google.template.soy.exprtree.VarDefn.Kind;
+import com.google.template.soy.exprtree.VarRefNode;
 import com.google.template.soy.jbcsrc.SoyNodeCompiler.CompiledMethodBody;
 import com.google.template.soy.jbcsrc.shared.CompiledTemplate;
 import com.google.template.soy.jbcsrc.shared.TemplateMetadata;
+import com.google.template.soy.soytree.CallBasicNode;
+import com.google.template.soy.soytree.CallDelegateNode;
 import com.google.template.soy.soytree.CallParamContentNode;
 import com.google.template.soy.soytree.CallParamValueNode;
 import com.google.template.soy.soytree.LetContentNode;
 import com.google.template.soy.soytree.LetValueNode;
+import com.google.template.soy.soytree.SoytreeUtils;
 import com.google.template.soy.soytree.TemplateNode;
 import com.google.template.soy.soytree.defn.LocalVar;
 import com.google.template.soy.soytree.defn.TemplateParam;
@@ -49,7 +56,9 @@
 import org.objectweb.asm.Type;
 
 import java.util.ArrayList;
+import java.util.HashSet;
 import java.util.List;
+import java.util.Set;
 
 /**
  * Compiles the top level {@link CompiledTemplate} class for a single template and all related
@@ -154,6 +163,28 @@ private void generateTemplateMetadata() {
         ? ""
         : template.node().getContentKind().name(); 
     annotationWriter.visit("contentKind", kind);
+
+    AnnotationVisitor ijsVisitor = annotationWriter.visitArray("injectedParams");
+    Set<String> uniqueIjs = new HashSet<>();
+    for (VarRefNode var : getAllNodesOfType(template.node(), VarRefNode.class)) {
+      if (var.isInjected() && uniqueIjs.add(var.getName())) {
+        ijsVisitor.visit(null /* ignored for array values */, var.getName());
+      }
+    }
+    ijsVisitor.visitEnd();
+
+    AnnotationVisitor calleesVisitor = annotationWriter.visitArray("callees");
+    for (CallBasicNode call : getAllNodesOfType(template.node(), CallBasicNode.class)) {
+      calleesVisitor.visit(null /* ignored for array values */, call.getCalleeName());
+    }
+    calleesVisitor.visitEnd();
+
+    AnnotationVisitor delCalleesVisitor = annotationWriter.visitArray("delCallees");
+    for (CallDelegateNode call : getAllNodesOfType(template.node(), CallDelegateNode.class)) {
+      delCalleesVisitor.visit(null /* ignored for array values */, call.getDelCalleeName());
+    }
+    delCalleesVisitor.visitEnd();
+
     annotationWriter.visitEnd();
   }
 

java/src/com/google/template/soy/jbcsrc/shared/TemplateMetadata.java

@@ -40,4 +40,19 @@
    * or {@code ""} which means that this isn't a strict template.
    */
   String contentKind();
+
+  /**
+   * Returns the list of injected params, both {@code $ij.foo} variables and {@code @inject} params
+   */ 
+  String[] injectedParams();
+
+  /** 
+   * Returns the fully qualified names of all the basic templates called by this template.
+   */
+  String[] callees();
+
+  /** 
+   * Returns the fully qualified names of all the delegate templates called by this template.
+   */
+  String[] delCallees();
 }

java/tests/com/google/template/soy/jbcsrc/BytecodeCompilerTest.java

@@ -202,6 +202,10 @@ public void testDelCall_delVariant() throws IOException {
         factory.create(TemplateTester.asRecord(ImmutableMap.of("variant", "unknown")), EMPTY_DICT)
             .render(builder, context));
     assertThat(builder.toString()).isEmpty();
+
+    TemplateMetadata templateMetadata = getTemplateMetadata(templates, "ns1.callerTemplate");
+    assertThat(templateMetadata.callees()).isEmpty();
+    assertThat(templateMetadata.delCallees()).asList().containsExactly("ns1.del");
   }
 
   public void testCallBasicNode() throws IOException {
@@ -251,21 +255,30 @@ public void testCallBasicNode() throws IOException {
     params.setField("boo", StringData.forValue("boo"));
     assertThat(render(templates, params, "ns.callerDataAll")).isEqualTo("Foo: foo\nBoo: boo\n");
 
+    assertThat(getTemplateMetadata(templates, "ns.callerDataAll").callees()).asList().containsExactly("ns.callee");
+    
     params = new BasicParamStore(2);
     params.setField("rec", new BasicParamStore(2).setField("foo", StringData.forValue("foo")));
     assertThat(render(templates, params, "ns.callerDataExpr")).isEqualTo("Foo: foo\nBoo: null\n");
     ((ParamStore) params.getField("rec")).setField("boo", StringData.forValue("boo"));
     assertThat(render(templates, params, "ns.callerDataExpr")).isEqualTo("Foo: foo\nBoo: boo\n");
+    assertThat(getTemplateMetadata(templates, "ns.callerDataExpr").callees()).asList().containsExactly("ns.callee");
 
     params = new BasicParamStore(2);
     params.setField("p1", StringData.forValue("foo"));
     assertThat(render(templates, params, "ns.callerParams")).isEqualTo("Foo: foo\nBoo: a1b\n");
+    assertThat(getTemplateMetadata(templates, "ns.callerParams").callees()).asList().containsExactly("ns.callee");
 
     params = new BasicParamStore(2);
     params.setField("p1", StringData.forValue("foo"));
     params.setField("boo", StringData.forValue("boo"));
     assertThat(render(templates, params, "ns.callerParamsAndData"))
         .isEqualTo("Foo: foo\nBoo: boo\n");
+    assertThat(getTemplateMetadata(templates, "ns.callerParamsAndData").callees()).asList().containsExactly("ns.callee");
+  }
+
+  private static TemplateMetadata getTemplateMetadata(CompiledTemplates templates, String name) {
+    return templates.getTemplateFactory(name).getClass().getDeclaringClass().getAnnotation(TemplateMetadata.class);
   }
 
   private String render(CompiledTemplates templates, SoyRecord params, String name)
@@ -655,6 +668,11 @@ public void testParamFields() throws Exception {
     assertEquals(StringData.forValue("foo"), getField("foo", template));
     assertEquals(StringData.forValue("bar"), getField("bar", template));
     assertEquals(StringData.forValue("baz"), getField("baz", template));
+
+    TemplateMetadata templateMetadata = template.getClass().getAnnotation(TemplateMetadata.class);
+    assertThat(templateMetadata.injectedParams()).asList().containsExactly("bar");
+    assertThat(templateMetadata.callees()).isEmpty();
+    assertThat(templateMetadata.delCallees()).isEmpty();
   }
 
   private Object getField(String name, CompiledTemplate template) throws Exception {
@@ -674,7 +692,12 @@ public void testBasicFunctionality() {
         factory.create(EMPTY_DICT, EMPTY_DICT).getClass();
     assertEquals("com.google.template.soy.jbcsrc.gen.ns.foo", templateClass.getName());
     assertEquals("foo", templateClass.getSimpleName());
-    assertEquals("HTML", templateClass.getAnnotation(TemplateMetadata.class).contentKind());
+
+    TemplateMetadata templateMetadata = templateClass.getAnnotation(TemplateMetadata.class);
+    assertEquals("HTML", templateMetadata.contentKind());
+    assertThat(templateMetadata.injectedParams()).isEmpty();
+    assertThat(templateMetadata.callees()).isEmpty();
+    assertThat(templateMetadata.delCallees()).isEmpty();
 
     // ensure that the factory is an inner class of the template.
     assertEquals(templateClass, factory.getClass().getEnclosingClass());