No public description

PiperOrigin-RevId: 568880032

Author: Closure Team

src/com/google/javascript/jscomp/GatherModuleMetadata.java

@@ -75,6 +75,11 @@ public final class GatherModuleMetadata implements CompilerPass {
       DiagnosticType.error(
           "JSC_INVALID_REQUIRE_DYNAMIC", "Argument to goog.requireDynamic must be a string.");
 
+  static final DiagnosticType INVALID_MAYBE_REQUIRE =
+      DiagnosticType.error(
+          "JSC_INVALID_MAYBE_REQUIRE",
+          "Argument to goog.maybeRequireFrameworkInternalOnlyDoNotCallOrElse must be a string.");
+
   static final DiagnosticType INVALID_SET_TEST_ONLY =
       DiagnosticType.error(
           "JSC_INVALID_SET_TEST_ONLY",
@@ -90,6 +95,8 @@ public final class GatherModuleMetadata implements CompilerPass {
   private static final Node GOOG_MODULE = IR.getprop(IR.name("goog"), "module");
   private static final Node GOOG_REQUIRE = IR.getprop(IR.name("goog"), "require");
   private static final Node GOOG_REQUIRE_TYPE = IR.getprop(IR.name("goog"), "requireType");
+  private static final Node GOOG_MAYBE_REQUIRE =
+      IR.getprop(IR.name("goog"), "maybeRequireFrameworkInternalOnlyDoNotCallOrElse");
   private static final Node GOOG_REQUIRE_DYNAMIC = IR.getprop(IR.name("goog"), "requireDynamic");
   private static final Node GOOG_SET_TEST_ONLY = IR.getprop(IR.name("goog"), "setTestOnly");
   private static final Node GOOG_MODULE_DECLARELEGACYNAMESPACE =
@@ -481,6 +488,15 @@ private void visitGoogCall(NodeTraversal t, Node n) {
         } else {
           t.report(n, INVALID_REQUIRE_TYPE);
         }
+      } else if (getprop.matchesQualifiedName(GOOG_MAYBE_REQUIRE)) {
+        if (n.hasTwoChildren() && n.getLastChild().isStringLit()) {
+          currentModule
+              .metadataBuilder
+              .maybeRequiredGoogNamespacesBuilder()
+              .add(n.getLastChild().getString());
+        } else {
+          t.report(n, INVALID_MAYBE_REQUIRE);
+        }
       } else if (getprop.matchesQualifiedName(GOOG_SET_TEST_ONLY)) {
         if (n.hasOneChild() || (n.hasTwoChildren() && n.getLastChild().isStringLit())) {
           currentModule.metadataBuilder.isTestOnly(true);

src/com/google/javascript/jscomp/deps/JsFileFullParser.java

@@ -87,6 +87,7 @@ public enum ModuleType {
     public final Multiset<String> provides = TreeMultiset.create();
     public final Multiset<String> requires = TreeMultiset.create();
     public final Multiset<String> typeRequires = TreeMultiset.create();
+    public final Multiset<String> maybeRequires = TreeMultiset.create();
     public final Multiset<String> requiresCss = TreeMultiset.create();
     public final Multiset<String> visibility = TreeMultiset.create();
 
@@ -251,6 +252,7 @@ private static void recordModuleMetadata(FileInfo info, ModuleMetadata module) {
     if (module.usesClosure()) {
       info.provides.addAll(module.googNamespaces());
       info.requires.addAll(module.stronglyRequiredGoogNamespaces());
+      info.maybeRequires.addAll(module.maybeRequiredGoogNamespaces());
       info.dynamicRequires.addAll(module.dynamicallyRequiredGoogNamespaces().elementSet());
       info.readToggles.addAll(module.readToggles().elementSet());
       info.typeRequires.addAll(module.weaklyRequiredGoogNamespaces());

src/com/google/javascript/jscomp/modules/ModuleMetadataMap.java

@@ -184,6 +184,15 @@ public boolean isModule() {
      */
     public abstract ImmutableMultiset<String> dynamicallyRequiredGoogNamespaces();
 
+    /**
+     * Closure namespaces this file "maybe" require, i.e., arguments to
+     * goog.maybeRequireFrameworkInternalOnlyDoNotCallOrElse() calls.
+     *
+     * <p>This is a multiset as it does not warn on duplicate namespaces, but will still encapsulate
+     * that information with this multiset.
+     */
+    public abstract ImmutableMultiset<String> maybeRequiredGoogNamespaces();
+
     /**
      * Closure namespaces this file weakly requires, i.e., arguments to goog.requireType calls.
      *
@@ -241,6 +250,8 @@ public Builder addGoogNamespace(String namespace) {
 
       public abstract ImmutableMultiset.Builder<String> dynamicallyRequiredGoogNamespacesBuilder();
 
+      public abstract ImmutableMultiset.Builder<String> maybeRequiredGoogNamespacesBuilder();
+
       public abstract ImmutableMultiset.Builder<String> weaklyRequiredGoogNamespacesBuilder();
 
       public abstract ImmutableMultiset.Builder<String> es6ImportSpecifiersBuilder();

test/com/google/javascript/jscomp/GatherModuleMetadataTest.java

@@ -591,6 +591,23 @@ public void testRequireDynamicWithIllegalArg() {
         GatherModuleMetadata.INVALID_REQUIRE_DYNAMIC);
   }
 
+  @Test
+  public void testMaybeRequire() {
+    testSame("goog.maybeRequireFrameworkInternalOnlyDoNotCallOrElse('my.Type')");
+    ModuleMetadata m = metadataMap().getModulesByPath().get("testcode");
+    assertThat(m.maybeRequiredGoogNamespaces()).containsExactly("my.Type");
+  }
+
+  @Test
+  public void testMaybeRequireWithIllegalArg() {
+    testError(
+        "goog.maybeRequireFrameworkInternalOnlyDoNotCallOrElse('my.Type','extra.Type');",
+        GatherModuleMetadata.INVALID_MAYBE_REQUIRE);
+    testError(
+        "goog.maybeRequireFrameworkInternalOnlyDoNotCallOrElse(42);",
+        GatherModuleMetadata.INVALID_MAYBE_REQUIRE);
+  }
+
   @Test
   public void testRequiredClosureNamespaces() {
     testSame("goog.require('my.Type');");