refactor(core): add ENABLE_ROOT_COMPONENT_BOOTSTRAP token (angular#59133)

Introduced the `ENABLE_ROOT_COMPONENT_BOOTSTRAP` token to control the bootstrapping of components during application initialization. This token is utilized by the Angular CLI in the `@angular/ssr` package, particularly during server-side rendering (SSR) when extracting routes.

When set to `false`, this token prevents the root component from being bootstrapped during SSR's route extraction phase, which is crucial for efficiently extracting routes without triggering component initialization. This mechanism separates the concerns of route extraction and component bootstrapping during SSR rendering, optimizing performance.

If not provided or set to `true`, the default behavior of bootstrapping the root component(s) during initialization is maintained.

Context: angular/angular-cli#29085

PR Close angular#59133

Author: alan-agius4

packages/core/src/core_private_export.ts

@@ -105,6 +105,7 @@ export {
 } from './metadata/resource_loading';
 export {PendingTasksInternal as ɵPendingTasksInternal} from './pending_tasks';
 export {ALLOW_MULTIPLE_PLATFORMS as ɵALLOW_MULTIPLE_PLATFORMS} from './platform/platform';
+export {ENABLE_ROOT_COMPONENT_BOOTSTRAP as ɵENABLE_ROOT_COMPONENT_BOOTSTRAP} from './platform/bootstrap';
 export {ReflectionCapabilities as ɵReflectionCapabilities} from './reflection/reflection_capabilities';
 export {AnimationRendererType as ɵAnimationRendererType} from './render/api';
 export {

packages/core/src/platform/bootstrap.ts

@@ -8,7 +8,7 @@
 import {Subscription} from 'rxjs';
 
 import {PROVIDED_NG_ZONE} from '../change_detection/scheduling/ng_zone_scheduling';
-import {EnvironmentInjector, R3Injector} from '../di/r3_injector';
+import {R3Injector} from '../di/r3_injector';
 import {ErrorHandler} from '../error_handler';
 import {RuntimeError, RuntimeErrorCode} from '../errors';
 import {DEFAULT_LOCALE_ID} from '../i18n/localization';
@@ -22,10 +22,34 @@ import {NgZone} from '../zone/ng_zone';
 import {ApplicationInitStatus} from '../application/application_init';
 import {_callAndReportToErrorHandler, ApplicationRef, remove} from '../application/application_ref';
 import {PROVIDED_ZONELESS} from '../change_detection/scheduling/zoneless_scheduling';
-import {Injector} from '../di';
+import {InjectionToken, Injector} from '../di';
 import {InternalNgModuleRef, NgModuleRef} from '../linker/ng_module_factory';
 import {stringify} from '../util/stringify';
 
+/**
+ * InjectionToken to control root component bootstrap behavior.
+ *
+ * This token is primarily used in Angular's server-side rendering (SSR) scenarios,
+ * particularly by the `@angular/ssr` package, to manage whether the root component
+ * should be bootstrapped during the application initialization process.
+ *
+ * ## Purpose:
+ * During SSR route extraction, setting this token to `false` prevents Angular from
+ * bootstrapping the root component. This avoids unnecessary component rendering,
+ * enabling route extraction without requiring additional APIs or triggering
+ * component logic.
+ *
+ * ## Behavior:
+ * - **`false`**: Prevents the root component from being bootstrapped.
+ * - **`true`** (default): Proceeds with the normal root component bootstrap process.
+ *
+ * This mechanism ensures SSR can efficiently separate route extraction logic
+ * from component rendering.
+ */
+export const ENABLE_ROOT_COMPONENT_BOOTSTRAP = new InjectionToken<boolean>(
+  ngDevMode ? 'ENABLE_ROOT_COMPONENT_BOOTSTRAP' : '',
+);
+
 export interface BootstrapConfig {
   platformInjector: Injector;
 }
@@ -125,6 +149,17 @@ export function bootstrap<M>(
         // If the `LOCALE_ID` provider is defined at bootstrap then we set the value for ivy
         const localeId = envInjector.get(LOCALE_ID, DEFAULT_LOCALE_ID);
         setLocaleId(localeId || DEFAULT_LOCALE_ID);
+
+        const enableRootComponentBoostrap = envInjector.get(ENABLE_ROOT_COMPONENT_BOOTSTRAP, true);
+        if (!enableRootComponentBoostrap) {
+          if (isApplicationBootstrapConfig(config)) {
+            return envInjector.get(ApplicationRef);
+          }
+
+          config.allPlatformModules.push(config.moduleRef);
+          return config.moduleRef;
+        }
+
         if (typeof ngDevMode === 'undefined' || ngDevMode) {
           const imagePerformanceService = envInjector.get(ImagePerformanceWarning);
           imagePerformanceService.start();

packages/core/test/bundling/animations-standalone/bundle.golden_symbols.json

@@ -64,6 +64,7 @@
   "EMPTY_PAYLOAD",
   "EMPTY_PLAYER_ARRAY",
   "EMPTY_SUBSCRIPTION",
+  "ENABLE_ROOT_COMPONENT_BOOTSTRAP",
   "ENTER_TOKEN_REGEX",
   "ENVIRONMENT_INITIALIZER",
   "EVENT_MANAGER_PLUGINS",

packages/core/test/bundling/animations/bundle.golden_symbols.json

@@ -72,6 +72,7 @@
   "EMPTY_PAYLOAD",
   "EMPTY_PLAYER_ARRAY",
   "EMPTY_SUBSCRIPTION",
+  "ENABLE_ROOT_COMPONENT_BOOTSTRAP",
   "ENTER_TOKEN_REGEX",
   "ENVIRONMENT_INITIALIZER",
   "EVENT_MANAGER_PLUGINS",

packages/core/test/bundling/cyclic_import/bundle.golden_symbols.json

@@ -44,6 +44,7 @@
   "EMPTY_OBSERVER",
   "EMPTY_PAYLOAD",
   "EMPTY_SUBSCRIPTION",
+  "ENABLE_ROOT_COMPONENT_BOOTSTRAP",
   "ENVIRONMENT_INITIALIZER",
   "EVENT_MANAGER_PLUGINS",
   "EffectScheduler",

packages/core/test/bundling/defer/bundle.golden_symbols.json

@@ -60,6 +60,7 @@
   "EMPTY_OBSERVER",
   "EMPTY_PAYLOAD",
   "EMPTY_SUBSCRIPTION",
+  "ENABLE_ROOT_COMPONENT_BOOTSTRAP",
   "ENVIRONMENT_INITIALIZER",
   "EVENT_MANAGER_PLUGINS",
   "EffectScheduler",

packages/core/test/bundling/forms_reactive/bundle.golden_symbols.json

@@ -62,6 +62,7 @@
   "EMPTY_OBSERVER",
   "EMPTY_PAYLOAD",
   "EMPTY_SUBSCRIPTION",
+  "ENABLE_ROOT_COMPONENT_BOOTSTRAP",
   "ENVIRONMENT_INITIALIZER",
   "ERRORED",
   "EVENT_MANAGER_PLUGINS",

packages/core/test/bundling/forms_template_driven/bundle.golden_symbols.json

@@ -63,6 +63,7 @@
   "EMPTY_OBSERVER",
   "EMPTY_PAYLOAD",
   "EMPTY_SUBSCRIPTION",
+  "ENABLE_ROOT_COMPONENT_BOOTSTRAP",
   "ENVIRONMENT_INITIALIZER",
   "ERRORED",
   "EVENT_MANAGER_PLUGINS",

packages/core/test/bundling/hello_world/bundle.golden_symbols.json

@@ -28,6 +28,7 @@
   "EMPTY_OBSERVER",
   "EMPTY_PAYLOAD",
   "EMPTY_SUBSCRIPTION",
+  "ENABLE_ROOT_COMPONENT_BOOTSTRAP",
   "ENVIRONMENT_INITIALIZER",
   "EffectScheduler",
   "ElementRef",

packages/core/test/bundling/hydration/bundle.golden_symbols.json

@@ -41,6 +41,7 @@
   "EMPTY_OBSERVER",
   "EMPTY_PAYLOAD",
   "EMPTY_SUBSCRIPTION",
+  "ENABLE_ROOT_COMPONENT_BOOTSTRAP",
   "ENVIRONMENT_INITIALIZER",
   "EVENT_MANAGER_PLUGINS",
   "EffectScheduler",