Pass LoggableElementMetadata from VE to Logger's enter function in the Server Side Logger

PiperOrigin-RevId: 749102931

Author: Soy Authors

java/src/com/google/template/soy/data/BUILD.bazel

@@ -113,6 +113,7 @@ java_library(
         "//java/src/com/google/template/soy/internal/proto",
         "//java/src/com/google/template/soy/jbcsrc/api:helpers",
         "//java/src/com/google/template/soy/jbcsrc/shared:names",
+        "//src/main/protobuf:ve_metadata_java_proto",
         "@com_google_auto_value_auto_value",
         "@com_google_protobuf//:protobuf_java",
         "@maven//:com_google_code_findbugs_jsr305",

java/src/com/google/template/soy/data/LogStatement.java

@@ -20,13 +20,22 @@
 import com.google.common.base.MoreObjects;
 import com.google.protobuf.Message;
 import com.google.protobuf.TextFormat;
+import com.google.template.soy.logging.LoggableElementMetadata;
 import javax.annotation.Nullable;
 
 /** The value of a {@code velog} statement. */
 @AutoValue
 public abstract class LogStatement {
   public static LogStatement create(long id, @Nullable Message data, boolean logOnly) {
-    return new AutoValue_LogStatement(id, data, logOnly);
+    return new AutoValue_LogStatement(id, data, logOnly, null);
+  }
+
+  public static LogStatement create(
+      long id,
+      @Nullable Message data,
+      boolean logOnly,
+      @Nullable LoggableElementMetadata loggableElementMetadata) {
+    return new AutoValue_LogStatement(id, data, logOnly, loggableElementMetadata);
   }
 
   LogStatement() {} // prevent subclasses outside the package
@@ -46,6 +55,9 @@ public static LogStatement create(long id, @Nullable Message data, boolean logOn
    */
   public abstract boolean logOnly();
 
+  @Nullable
+  public abstract LoggableElementMetadata loggableElementMetadata();
+
   @Override
   public String toString() {
     return MoreObjects.toStringHelper("velog")
@@ -60,6 +72,7 @@ public String toString() {
                     + TextFormat.shortDebugString(data())
                     + "}")
         .addValue(logOnly() ? "logonly" : null)
+        .add("loggableElementMetadata", loggableElementMetadata())
         .toString();
   }
 }

java/src/com/google/template/soy/jbcsrc/runtime/JbcSrcRuntime.java

@@ -132,7 +132,6 @@ public static boolean stringEqualsAsNumber(String expr, double number) {
     }
   }
 
-
   @Keep
   @Nonnull
   public static SoyValue getField(SoyValue record, RecordProperty field) {
@@ -752,16 +751,15 @@ public StackFrame render(
   @Keep
   public static LogStatement createLogStatement(boolean logOnly, SoyValue value) {
     SoyVisualElementData veData = (SoyVisualElementData) value;
-    return LogStatement.create(veData.ve().id(), veData.data(), logOnly);
+    return LogStatement.create(veData.ve().id(), veData.data(), logOnly, veData.ve().metadata());
   }
 
   @Keep
   public static LogStatement createLogStatement(SoyValue value) {
     SoyVisualElementData veData = (SoyVisualElementData) value;
-    return LogStatement.create(veData.ve().id(), veData.data(), false);
+    return LogStatement.create(veData.ve().id(), veData.data(), false, veData.ve().metadata());
   }
 
-
   /** Asserts that all members of the list are resolved. */
   @Keep
   @Nonnull

java/tests/com/google/template/soy/jbcsrc/BUILD.bazel

@@ -91,6 +91,7 @@ java_library(
         "//java/tests/com/google/template/soy/data:soy_value_converter_utility",
         "//java/tests/com/google/template/soy/jbcsrc/restricted/testing",
         "//src/main/protobuf:logging_config_java_proto",
+        "//src/main/protobuf:ve_metadata_java_proto",
         "//src/test/protobuf:test_protos_java_proto",
         "@com_google_protobuf//:protobuf_java",
         "@maven//:com_google_code_findbugs_jsr305",

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

@@ -17,6 +17,7 @@
 package com.google.template.soy.jbcsrc;
 
 import static com.google.common.truth.Truth.assertThat;
+import static com.google.template.soy.testing.VeMetadataExample.veMetadataExampleExtension;
 import static org.junit.Assert.assertThrows;
 import static org.junit.Assert.fail;
 
@@ -33,6 +34,7 @@
 import com.google.template.soy.jbcsrc.shared.CompiledTemplates;
 import com.google.template.soy.jbcsrc.shared.RenderContext;
 import com.google.template.soy.jbcsrc.shared.StackFrame;
+import com.google.template.soy.logging.LoggableElementMetadata;
 import com.google.template.soy.logging.LoggingFunction;
 import com.google.template.soy.logging.SoyLogger;
 import com.google.template.soy.logging.SoyLogger.LoggingAttrs;
@@ -107,7 +109,10 @@ public void testBasicLogging_treeStructure() throws Exception {
     assertThat(sb.toString())
         .isEqualTo("<div data-id=1><div data-id=2></div><div data-id=3></div></div>");
     assertThat(testLogger.builder.toString())
-        .isEqualTo("velog{id=1}\n" + "  velog{id=2}\n" + "  velog{id=3}");
+        .isEqualTo(
+            "velog{id=1, loggableElementMetadata=}\n"
+                + "  velog{id=2, loggableElementMetadata=}\n"
+                + "  velog{id=3, loggableElementMetadata=}");
   }
 
   @Test
@@ -119,7 +124,7 @@ public void testBasicLogging_withData() throws Exception {
         "{velog ve_data(FooVe, Foo(intField: 123))}<div data-id=1></div>{/velog}");
     assertThat(sb.toString()).isEqualTo("<div data-id=1></div>");
     assertThat(testLogger.builder.toString())
-        .isEqualTo("velog{id=1, data=soy.test.Foo{int_field: 123}}");
+        .isEqualTo("velog{id=1, data=soy.test.Foo{int_field: 123}, loggableElementMetadata=}");
   }
 
   @Test
@@ -131,7 +136,8 @@ public void testBasicLogging_logonly() throws Exception {
         "{velog FooVe logonly=\"true\"}<div data-id=1></div>{/velog}");
     // logonly ve's disable content generation
     assertThat(sb.toString()).isEmpty();
-    assertThat(testLogger.builder.toString()).isEqualTo("velog{id=1, logonly}");
+    assertThat(testLogger.builder.toString())
+        .isEqualTo("velog{id=1, logonly, loggableElementMetadata=}");
   }
 
   @Test
@@ -152,7 +158,10 @@ public void testBasicLogging_logonly_dynamic() throws Exception {
         "{velog Bar logonly=\"$f\"}<div data-id=2></div>{/velog}");
     // logonly ve's disable content generation
     assertThat(sb.toString()).isEqualTo("<div data-id=2></div>");
-    assertThat(testLogger.builder.toString()).isEqualTo("velog{id=1, logonly}\nvelog{id=2}");
+    assertThat(testLogger.builder.toString())
+        .isEqualTo(
+            "velog{id=1, logonly, loggableElementMetadata=}\n"
+                + "velog{id=2, loggableElementMetadata=}");
   }
 
   @Test
@@ -183,14 +192,30 @@ public void testBasicLogging_logonly_true_noLogger() throws Exception {
     }
   }
 
+  @Test
+  public void testBasicLogging_loggableElementMetadata() throws Exception {
+    StringBuilder sb = new StringBuilder();
+    TestLogger testLogger = new TestLogger();
+    renderTemplate(
+        OutputAppendable.create(sb, testLogger),
+        "{velog ve_data(VeWithLoggableElementMetadata)}<div data-id=1></div>{/velog}");
+    assertThat(sb.toString()).isEqualTo("<div data-id=1></div>");
+    assertThat(testLogger.builder.toString())
+        .isEqualTo(
+            "velog{id=5, loggableElementMetadata=[soy.test.ve_metadata_example_extension]:"
+                + " \"foo\"\n"
+                + "}");
+  }
+
   @Test
   public void testLogging_letVariables() throws Exception {
     StringBuilder sb = new StringBuilder();
     TestLogger testLogger = new TestLogger();
     renderTemplate(
         OutputAppendable.create(sb, testLogger),
         "{let $foo kind=\"html\"}{velog FooVe}<div data-id=1></div>{/velog}{/let}{$foo}{$foo}");
-    assertThat(testLogger.builder.toString()).isEqualTo("velog{id=1}\nvelog{id=1}");
+    assertThat(testLogger.builder.toString())
+        .isEqualTo("velog{id=1, loggableElementMetadata=}\nvelog{id=1, loggableElementMetadata=}");
     assertThat(sb.toString()).isEqualTo("<div data-id=1></div><div data-id=1></div>");
   }
 
@@ -205,7 +230,7 @@ public void testLogging_msg() throws Exception {
             + "  Greetings, {velog FooVe}<a href='./wiki?human'>Human</a>{/velog}\n"
             + "{/msg}");
     assertThat(sb.toString()).isEqualTo("Greetings, <a href='./wiki?human'>Human</a>");
-    assertThat(testLogger.builder.toString()).isEqualTo("velog{id=1}");
+    assertThat(testLogger.builder.toString()).isEqualTo("velog{id=1, loggableElementMetadata=}");
   }
 
   // Regression test for a bug where logging would get dropped if there was a velog, in a msg around
@@ -221,7 +246,7 @@ public void testLogging_msg_void_element() throws Exception {
             + "  Greetings, {velog FooVe}<input type=text>{/velog}\n"
             + "{/msg}");
     assertThat(sb.toString()).isEqualTo("Greetings, <input type=text>");
-    assertThat(testLogger.builder.toString()).isEqualTo("velog{id=1}");
+    assertThat(testLogger.builder.toString()).isEqualTo("velog{id=1, loggableElementMetadata=}");
   }
 
   @Test
@@ -237,10 +262,10 @@ public void testLogging_nestedLogOnly() throws IOException {
     assertThat(sb.toString()).isEmpty();
     assertThat(testLogger.builder.toString())
         .isEqualTo(
-            "velog{id=1, logonly}\n"
-                + "  velog{id=1}\n"
-                + "    velog{id=1, logonly}\n"
-                + "      velog{id=1, logonly}");
+            "velog{id=1, logonly, loggableElementMetadata=}\n"
+                + "  velog{id=1, loggableElementMetadata=}\n"
+                + "    velog{id=1, logonly, loggableElementMetadata=}\n"
+                + "      velog{id=1, logonly, loggableElementMetadata=}");
   }
 
   @Test
@@ -252,7 +277,7 @@ public void testLogging_loggingFunction_basic() throws Exception {
         "<div data-depth={depth()}></div>"
             + "{velog FooVe}<div data-depth={depth()}></div>{/velog}"
             + "<div data-depth={depth()}></div>");
-    assertThat(testLogger.builder.toString()).isEqualTo("velog{id=1}");
+    assertThat(testLogger.builder.toString()).isEqualTo("velog{id=1, loggableElementMetadata=}");
     assertThat(sb.toString())
         .isEqualTo("<div data-depth=0></div><div data-depth=1></div><div data-depth=0></div>");
   }
@@ -283,7 +308,7 @@ public void testLogging_elvis() throws Exception {
         "  {/velog}",
         "{/let}",
         "{$log ?? ''}");
-    assertThat(testLogger.builder.toString()).isEqualTo("velog{id=1}");
+    assertThat(testLogger.builder.toString()).isEqualTo("velog{id=1, loggableElementMetadata=}");
     assertThat(sb.toString()).isEqualTo("<div>hello</div>");
   }
 
@@ -294,7 +319,7 @@ public void testLoggingAttributes_basic() throws Exception {
     testLogger.attrsMap.put(1L, LoggingAttrs.builder().addDataAttribute("data-foo", "bar").build());
     renderTemplate(
         OutputAppendable.create(sb, testLogger), "{velog FooVe}<div>hello</div>{/velog}");
-    assertThat(testLogger.builder.toString()).isEqualTo("velog{id=1}");
+    assertThat(testLogger.builder.toString()).isEqualTo("velog{id=1, loggableElementMetadata=}");
     assertThat(sb.toString()).isEqualTo("<div data-foo=\"bar\">hello</div>");
   }
 
@@ -305,7 +330,7 @@ public void testLoggingAttributes_withCall() throws Exception {
     testLogger.attrsMap.put(1L, LoggingAttrs.builder().addDataAttribute("data-foo", "bar").build());
     renderTemplate(
         OutputAppendable.create(sb, testLogger), "{velog FooVe}{call another /}{/velog}");
-    assertThat(testLogger.builder.toString()).isEqualTo("velog{id=1}");
+    assertThat(testLogger.builder.toString()).isEqualTo("velog{id=1, loggableElementMetadata=}");
     assertThat(sb.toString()).isEqualTo("<div data-foo=\"bar\">called</div>");
   }
 
@@ -318,7 +343,7 @@ public void testLoggingAttributes_withLet() throws Exception {
         OutputAppendable.create(sb, testLogger),
         "{let $div kind='html'}<div>hello</div>{/let}",
         "{velog FooVe}{$div}{/velog}");
-    assertThat(testLogger.builder.toString()).isEqualTo("velog{id=1}");
+    assertThat(testLogger.builder.toString()).isEqualTo("velog{id=1, loggableElementMetadata=}");
     assertThat(sb.toString()).isEqualTo("<div data-foo=\"bar\">hello</div>");
   }
 
@@ -329,7 +354,7 @@ public void testLoggingAttributes_anchor() throws Exception {
     testLogger.attrsMap.put(
         1L, LoggingAttrs.builder().addAnchorHref(SafeUrls.fromConstant("./go")).build());
     renderTemplate(OutputAppendable.create(sb, testLogger), "{velog FooVe}<a>hello</a>{/velog}");
-    assertThat(testLogger.builder.toString()).isEqualTo("velog{id=1}");
+    assertThat(testLogger.builder.toString()).isEqualTo("velog{id=1, loggableElementMetadata=}");
     assertThat(sb.toString()).isEqualTo("<a href=\"./go\">hello</a>");
   }
 
@@ -361,15 +386,24 @@ private void renderTemplate(
       throws IOException {
     SoyFileSetParserBuilder builder =
         SoyFileSetParserBuilder.forTemplateAndImports(
-                "{const FooVe = ve_def('FooVe', 1, Foo) /}"
-                    + "{const Bar = ve_def('Bar', 2, Foo) /}"
-                    + "{const Baz = ve_def('Baz', 3, Foo) /}"
-                    + "{const Quux = ve_def('Quux', 4, Foo) /}"
+                // End of the line comments are to force the formatter to keep each line on its own
+                // line.
+                "{const FooVe = ve_def('FooVe', 1, Foo) /}" //
+                    + "{const Bar = ve_def('Bar', 2, Foo) /}" //
+                    + "{const Baz = ve_def('Baz', 3, Foo) /}" //
+                    + "{const Quux = ve_def('Quux', 4, Foo) /}" //
+                    + "{const VeWithLoggableElementMetadata = ve_def(" //
+                    + " 'VeWithLoggableElementMetadata'," //
+                    + " 5," //
+                    + " Foo," //
+                    + " LoggableElementMetadata(veMetadataExampleExtension: 'foo')) /}" //
                     + "{template foo}\n"
                     + Joiner.on("\n").join(templateBodyLines)
-                    + "\n{/template}"
-                    + "{template another}<div>called</div>{/template}\n",
-                Foo.getDescriptor())
+                    + "\n{/template}" //
+                    + "{template another}<div>called</div>{/template}\n", //
+                Foo.getDescriptor(),
+                LoggableElementMetadata.getDescriptor(),
+                veMetadataExampleExtension.getDescriptor())
             .addSoySourceFunction(new DepthFunction())
             .addHtmlAttributesForLogging(true)
             .runAutoescaper(true);

src/test/protobuf/BUILD.bazel

@@ -14,8 +14,8 @@
 # limitations under the License.
 ##
 
-load("@rules_proto//proto:defs.bzl", "proto_library")
 load("@rules_java//java:defs.bzl", "java_proto_library")
+load("@rules_proto//proto:defs.bzl", "proto_library")
 
 package(
     default_testonly = 1,
@@ -38,6 +38,7 @@ proto_library(
         ["*.proto"],
         exclude = ["collision.proto"],
     ),
+    deps = ["//src/main/protobuf:ve_metadata_java_proto"],
 )
 
 proto_library(

src/test/protobuf/ve_metadata_example.proto

@@ -0,0 +1,11 @@
+syntax = "proto2";
+
+package soy.test;
+
+import "src/main/protobuf/ve_metadata.proto";
+
+option java_package = "com.google.template.soy.testing";
+
+extend LoggableElementMetadata {
+  optional string ve_metadata_example_extension = 1010;
+}