fix(bazel): ng_module should not emit shim files under bazel and Ivy (#…

…33765) Under bazel and Ivy we don't need the shim files to be emmited by default. We still need to the shims for blaze however because google3 code imports them. This improves build latency by 1-2 seconds per ng_module target. PR Close #33765
angular · Nov 12, 2019 · e24ed8d0e2221f0d681f5623e2fee61e5b9c7630 · e24ed8d
1 parent 229bfd5
commit e24ed8d0e2221f0d681f5623e2fee61e5b9c7630
diff --git a/integration/bazel/src/BUILD.bazel b/integration/bazel/src/BUILD.bazel
@@ -13,6 +13,7 @@ exports_files(["tsconfig.json"])
 ng_module(
     name = "src",
     srcs = glob(["*.ts"]),
+    generate_ve_shims = True,
     deps = [
         "//src/hello-world",
         "@npm//@angular/common",

diff --git a/integration/bazel/src/hello-world/BUILD.bazel b/integration/bazel/src/hello-world/BUILD.bazel
@@ -17,6 +17,7 @@ ng_module(
         exclude = ["*.spec.ts"],
     ),
     assets = [":hello-world-styles"],
+    generate_ve_shims = True,
     deps = [
         "@npm//@angular/core",
         "@npm//@types",

diff --git a/modules/benchmarks/src/class_bindings/BUILD.bazel b/modules/benchmarks/src/class_bindings/BUILD.bazel
@@ -10,6 +10,7 @@ ng_module(
         ["**/*.ts"],
         exclude = ["**/*.spec.ts"],
     ),
+    generate_ve_shims = True,
     deps = [
         "//packages:types",
         "//packages/common",

diff --git a/modules/benchmarks/src/expanding_rows/BUILD.bazel b/modules/benchmarks/src/expanding_rows/BUILD.bazel
@@ -10,6 +10,7 @@ ng_module(
         ["**/*.ts"],
         exclude = ["**/*.spec.ts"],
     ),
+    generate_ve_shims = True,
     deps = [
         "//packages:types",
         "//packages/common",

diff --git a/modules/benchmarks/src/largeform/ng2/BUILD.bazel b/modules/benchmarks/src/largeform/ng2/BUILD.bazel
@@ -9,6 +9,7 @@ package(default_visibility = ["//modules/benchmarks:__subpackages__"])
 ng_module(
     name = "ng2",
     srcs = glob(["*.ts"]),
+    generate_ve_shims = True,
     # FIXME-IVY(FW-998): ExpressionTranslatorVisitor#visitWriteKeyExpr is not implemented.
     tags = ["fixme-ivy-aot"],
     tsconfig = "//modules/benchmarks:tsconfig-build.json",

diff --git a/modules/benchmarks/src/largetable/ng2/BUILD.bazel b/modules/benchmarks/src/largetable/ng2/BUILD.bazel
@@ -10,6 +10,7 @@ package(default_visibility = ["//modules/benchmarks:__subpackages__"])
 ng_module(
     name = "ng2",
     srcs = glob(["*.ts"]),
+    generate_ve_shims = True,
     tsconfig = "//modules/benchmarks:tsconfig-build.json",
     # TODO: FW-1004 Type checking is currently not complete.
     type_check = False,

diff --git a/modules/benchmarks/src/largetable/ng2_switch/BUILD.bazel b/modules/benchmarks/src/largetable/ng2_switch/BUILD.bazel
@@ -7,6 +7,7 @@ package(default_visibility = ["//modules/benchmarks:__subpackages__"])
 ng_module(
     name = "ng2_switch",
     srcs = glob(["*.ts"]),
+    generate_ve_shims = True,
     tsconfig = "//modules/benchmarks:tsconfig-build.json",
     # TODO: FW-1004 Type checking is currently not complete.
     type_check = False,

diff --git a/modules/benchmarks/src/tree/ng2/BUILD.bazel b/modules/benchmarks/src/tree/ng2/BUILD.bazel
@@ -10,6 +10,7 @@ package(default_visibility = ["//modules/benchmarks:__subpackages__"])
 ng_module(
     name = "ng2",
     srcs = glob(["*.ts"]),
+    generate_ve_shims = True,
     tsconfig = "//modules/benchmarks:tsconfig-build.json",
     # TODO: FW-1004 Type checking is currently not complete.
     type_check = False,

diff --git a/modules/benchmarks/src/tree/ng2_switch/BUILD.bazel b/modules/benchmarks/src/tree/ng2_switch/BUILD.bazel
@@ -7,6 +7,7 @@ package(default_visibility = ["//modules/benchmarks:__subpackages__"])
 ng_module(
     name = "ng2_switch",
     srcs = glob(["*.ts"]),
+    generate_ve_shims = True,
     tsconfig = "//modules/benchmarks:tsconfig-build.json",
     # TODO: FW-1004 Type checking is currently not complete.
     type_check = False,

diff --git a/modules/benchmarks/src/views/BUILD.bazel b/modules/benchmarks/src/views/BUILD.bazel
@@ -9,6 +9,7 @@ ng_module(
         ["**/*.ts"],
         exclude = ["**/*.spec.ts"],
     ),
+    generate_ve_shims = True,
     deps = [
         "//packages:types",
         "//packages/common",

diff --git a/packages/bazel/src/builders/files/src/BUILD.bazel.template b/packages/bazel/src/builders/files/src/BUILD.bazel.template
@@ -38,6 +38,7 @@ ng_module(
       "**/*.css",
       "**/*.html",
     ]) + ([":styles"] if len(glob(["**/*.scss"])) else []),
+    generate_ve_shims = True,
     deps = [
         "@npm//@angular/core",
         "@npm//@angular/platform-browser",

diff --git a/packages/bazel/src/ng_module.bzl b/packages/bazel/src/ng_module.bzl
@@ -208,11 +208,14 @@ def _expected_outs(ctx):
         if short_path.endswith(".ts") and not short_path.endswith(".d.ts"):
             basename = short_path[len(package_prefix):-len(".ts")]
             if (len(factory_basename_set.to_list()) == 0 or basename in factory_basename_set.to_list()):
-                devmode_js = [
-                    ".ngfactory.js",
-                    ".ngsummary.js",
-                    ".js",
-                ]
+                if _generate_ve_shims(ctx):
+                    devmode_js = [
+                        ".ngfactory.js",
+                        ".ngsummary.js",
+                        ".js",
+                    ]
+                else:
+                    devmode_js = [".js"]
 
                 # Only ngc produces .json files, they're not needed in Ivy.
                 if is_legacy_ngc:
@@ -293,7 +296,18 @@ def _expected_outs(ctx):
         i18n_messages = i18n_messages_files,
     )
 
+# Determines if we need to generate View Engine shims (.ngfactory and .ngsummary files)
+def _generate_ve_shims(ctx):
+    # we are checking the workspace name here, because otherwise this would be a breaking change
+    # (the shims used to be on by default)
+    # we can remove this check once angular/components and angular/angular-cli repos no longer depend
+    # on the presence of shims, or if they explicitly opt-in to their generation via ng_modules' generate_ve_shims attr
+    return _is_bazel() and _is_view_engine_enabled(ctx) or (
+        getattr(ctx.attr, "generate_ve_shims", False) == True or ctx.workspace_name != "angular"
+    )
+
 def _ngc_tsconfig(ctx, files, srcs, **kwargs):
+    generate_ve_shims = _generate_ve_shims(ctx)
     outs = _expected_outs(ctx)
     is_legacy_ngc = _is_view_engine_enabled(ctx)
     if "devmode_manifest" in kwargs:
@@ -305,8 +319,8 @@ def _ngc_tsconfig(ctx, files, srcs, **kwargs):
         "enableResourceInlining": ctx.attr.inline_resources,
         "generateCodeForLibraries": False,
         "allowEmptyCodegenFiles": True,
-        "generateNgFactoryShims": True,
-        "generateNgSummaryShims": True,
+        "generateNgFactoryShims": True if generate_ve_shims else False,
+        "generateNgSummaryShims": True if generate_ve_shims else False,
         # Summaries are only enabled if Angular outputs are to be produced.
         "enableSummariesForJit": is_legacy_ngc,
         "enableIvy": _is_ivy_enabled(ctx),
@@ -771,6 +785,8 @@ NG_MODULE_RULE_ATTRS = dict(dict(COMMON_ATTRIBUTES, **NG_MODULE_ATTRIBUTES), **{
         executable = True,
         cfg = "host",
     ),
+    # Should the rule generate ngfactory and ngsummary shim files?
+    "generate_ve_shims": attr.bool(default = False),
 })
 
 ng_module = rule(

diff --git a/packages/compiler-cli/integrationtest/bazel/injectable_def/app/BUILD.bazel b/packages/compiler-cli/integrationtest/bazel/injectable_def/app/BUILD.bazel
@@ -10,6 +10,7 @@ ng_module(
             "src/**/*.ts",
         ],
     ),
+    generate_ve_shims = True,
     module_name = "app_built",
     deps = [
         "//packages/compiler-cli/integrationtest/bazel/injectable_def/lib2",

diff --git a/packages/examples/common/BUILD.bazel b/packages/examples/common/BUILD.bazel
@@ -9,6 +9,7 @@ ng_module(
         ["**/*.ts"],
         exclude = ["**/*_spec.ts"],
     ),
+    generate_ve_shims = True,
     # TODO: FW-1004 Type checking is currently not complete.
     type_check = False,
     deps = [

diff --git a/packages/examples/core/BUILD.bazel b/packages/examples/core/BUILD.bazel
@@ -12,6 +12,7 @@ ng_module(
             "**/*_howto.ts",
         ],
     ),
+    generate_ve_shims = True,
     # TODO: FW-1004 Type checking is currently not complete.
     type_check = False,
     deps = [

diff --git a/packages/examples/forms/BUILD.bazel b/packages/examples/forms/BUILD.bazel
@@ -9,6 +9,7 @@ ng_module(
         ["**/*.ts"],
         exclude = ["**/*_spec.ts"],
     ),
+    generate_ve_shims = True,
     # TODO: FW-1004 Type checking is currently not complete.
     type_check = False,
     deps = [

diff --git a/packages/examples/router/activated-route/BUILD.bazel b/packages/examples/router/activated-route/BUILD.bazel
@@ -8,6 +8,7 @@ ng_module(
     srcs = glob(
         ["**/*.ts"],
     ),
+    generate_ve_shims = True,
     # TODO: FW-1004 Type checking is currently not complete.
     type_check = False,
     deps = [

diff --git a/packages/examples/service-worker/push/BUILD.bazel b/packages/examples/service-worker/push/BUILD.bazel
@@ -9,6 +9,7 @@ ng_module(
         ["**/*.ts"],
         exclude = ["**/*_spec.ts"],
     ),
+    generate_ve_shims = True,
     # TODO: FW-1004 Type checking is currently not complete.
     type_check = False,
     deps = [

diff --git a/packages/examples/service-worker/registration-options/BUILD.bazel b/packages/examples/service-worker/registration-options/BUILD.bazel
@@ -9,6 +9,7 @@ ng_module(
         ["**/*.ts"],
         exclude = ["**/*_spec.ts"],
     ),
+    generate_ve_shims = True,
     # TODO: FW-1004 Type checking is currently not complete.
     type_check = False,
     deps = [

diff --git a/packages/examples/upgrade/upgrade_example.bzl b/packages/examples/upgrade/upgrade_example.bzl
@@ -12,6 +12,7 @@ def create_upgrade_example_targets(name, srcs, e2e_srcs, entry_module, assets =
     ng_module(
         name = "%s_sources" % name,
         srcs = srcs,
+        generate_ve_shims = True,
         # TODO: FW-1004 Type checking is currently not complete.
         type_check = False,
         deps = [

diff --git a/packages/router/test/aot_ngsummary_test/BUILD.bazel b/packages/router/test/aot_ngsummary_test/BUILD.bazel
@@ -4,6 +4,7 @@ ng_module(
     name = "aot_routing_module",
     testonly = True,
     srcs = ["aot_router_module.ts"],
+    generate_ve_shims = True,
     deps = [
         "//packages/core",
         "//packages/router",