feat(core): Allow passing application providers in bootstrapModule options (#64354)

atscott · AndrewKushnir · commit 2a7a5de53fd6 · 2025-10-13T15:10:10.000-07:00
This commit adds `applicationProviders` to the `bootstrapModule` options object. This allows specifying additional providers at the location of bootstrap, which makes default providers much easier to accomplish. Using this, we can refine the approach taken for downgrade_module to use this more direct API rather than the additional provider variable dance. PR Close #64354
diff --git a/goldens/public-api/core/index.api.md b/goldens/public-api/core/index.api.md
@@ -1421,9 +1421,15 @@ export const platformCore: (extraProviders?: StaticProvider[] | undefined) => Pl
 
 // @public
 export class PlatformRef {
-    bootstrapModule<M>(moduleType: Type<M>, compilerOptions?: (CompilerOptions & BootstrapOptions) | Array<CompilerOptions & BootstrapOptions>): Promise<NgModuleRef<M>>;
+    bootstrapModule<M>(moduleType: Type<M>, compilerOptions?: (CompilerOptions & BootstrapOptions & {
+        applicationProviders?: Array<Provider | EnvironmentProviders>;
+    }) | Array<CompilerOptions & BootstrapOptions & {
+        applicationProviders?: Array<Provider | EnvironmentProviders>;
+    }>): Promise<NgModuleRef<M>>;
     // @deprecated
-    bootstrapModuleFactory<M>(moduleFactory: NgModuleFactory<M>, options?: BootstrapOptions): Promise<NgModuleRef<M>>;
+    bootstrapModuleFactory<M>(moduleFactory: NgModuleFactory<M>, options?: BootstrapOptions & {
+        applicationProviders?: Array<Provider | EnvironmentProviders>;
+    }): Promise<NgModuleRef<M>>;
     destroy(): void;
     get destroyed(): boolean;
     get injector(): Injector;
diff --git a/packages/core/src/core_private_export.ts b/packages/core/src/core_private_export.ts
@@ -175,4 +175,3 @@ export {TimerScheduler as ɵTimerScheduler} from './defer/timer_scheduler';
 export {ɵassertType} from './type_checking';
 export {ANIMATIONS_DISABLED as ɵANIMATIONS_DISABLED} from './animation/interfaces';
 export {allLeavingAnimations as ɵallLeavingAnimations} from './animation/longest_animation';
-export {setZoneProvidersForNextBootstrap as ɵsetZoneProvidersForNextBootstrap} from './platform/platform_ref';
diff --git a/packages/core/src/di/create_injector.ts b/packages/core/src/di/create_injector.ts
@@ -10,7 +10,7 @@ import {EMPTY_ARRAY} from '../util/empty';
 import {stringify} from '../util/stringify';
 
 import type {Injector} from './injector';
-import type {Provider, StaticProvider} from './interface/provider';
+import type {EnvironmentProviders, Provider, StaticProvider} from './interface/provider';
 import {importProvidersFrom} from './provider_collection';
 import {getNullInjector, R3Injector} from './r3_injector';
 import {InjectorScope} from './scope';
@@ -42,7 +42,7 @@ export function createInjector(
 export function createInjectorWithoutInjectorInstances(
   defType: /* InjectorType<any> */ any,
   parent: Injector | null = null,
-  additionalProviders: Array<Provider | StaticProvider> | null = null,
+  additionalProviders: Array<Provider | EnvironmentProviders> | null = null,
   name?: string,
   scopes = new Set<InjectorScope>(),
 ): R3Injector {
diff --git a/packages/core/src/platform/platform_ref.ts b/packages/core/src/platform/platform_ref.ts
@@ -10,7 +10,7 @@ import {compileNgModuleFactory} from '../application/application_ngmodule_factor
 import {BootstrapOptions, optionsReducer} from '../application/application_ref';
 import {validAppIdInitializer} from '../application/application_tokens';
 import {provideZonelessChangeDetectionInternal} from '../change_detection/scheduling/zoneless_scheduling_impl';
-import {Injectable, Injector, StaticProvider} from '../di';
+import {EnvironmentProviders, Injectable, Injector, Provider, StaticProvider} from '../di';
 import {errorHandlerEnvironmentInitializer} from '../error_handler';
 import {RuntimeError, RuntimeErrorCode} from '../errors';
 import {Type} from '../interface/type';
@@ -27,18 +27,6 @@ import {getNgZone} from '../zone/ng_zone';
 
 const ZONELESS_BY_DEFAULT = true;
 
-// Holds the set of providers to be used for the *next* application to be bootstrapped.
-// Used only for providing the zone related providers by default with `downgradeModule`.
-let _additionalApplicationProviders: StaticProvider[] | undefined = undefined;
-export function setZoneProvidersForNextBootstrap(): void {
-  _additionalApplicationProviders = internalProvideZoneChangeDetection({});
-}
-function getAndClearAdditionalProviders(): StaticProvider[] | undefined {
-  const providers = _additionalApplicationProviders;
-  _additionalApplicationProviders = undefined;
-  return providers;
-}
-
 /**
  * The Angular platform is the entry point for Angular on a web page.
  * Each page has exactly one platform. Services (such as reflection) which are common
@@ -65,19 +53,7 @@ export class PlatformRef {
    */
   bootstrapModuleFactory<M>(
     moduleFactory: NgModuleFactory<M>,
-    options?: BootstrapOptions,
-  ): Promise<NgModuleRef<M>> {
-    return this.bootstrapModuleFactoryWithApplicationProviders(
-      moduleFactory,
-      options,
-      getAndClearAdditionalProviders(),
-    );
-  }
-
-  private bootstrapModuleFactoryWithApplicationProviders<M>(
-    moduleFactory: NgModuleFactory<M>,
-    options?: BootstrapOptions,
-    applicationProviders?: StaticProvider[],
+    options?: BootstrapOptions & {applicationProviders?: Array<Provider | EnvironmentProviders>},
   ): Promise<NgModuleRef<M>> {
     const defaultZoneCdProviders = [];
     if (!ZONELESS_BY_DEFAULT) {
@@ -93,7 +69,7 @@ export class PlatformRef {
     const allAppProviders = [
       provideZonelessChangeDetectionInternal(),
       ...defaultZoneCdProviders,
-      ...(applicationProviders ?? []),
+      ...(options?.applicationProviders ?? []),
       errorHandlerEnvironmentInitializer,
       ...(ngDevMode ? [validAppIdInitializer] : []),
     ];
@@ -130,18 +106,17 @@ export class PlatformRef {
   bootstrapModule<M>(
     moduleType: Type<M>,
     compilerOptions:
-      | (CompilerOptions & BootstrapOptions)
-      | Array<CompilerOptions & BootstrapOptions> = [],
+      | (CompilerOptions &
+          BootstrapOptions & {applicationProviders?: Array<Provider | EnvironmentProviders>})
+      | Array<
+          CompilerOptions &
+            BootstrapOptions & {applicationProviders?: Array<Provider | EnvironmentProviders>}
+        > = [],
   ): Promise<NgModuleRef<M>> {
-    const additionalApplicationProviders = getAndClearAdditionalProviders();
     const options = optionsReducer({}, compilerOptions);
     setModuleBootstrapImpl();
     return compileNgModuleFactory(this.injector, options, moduleType).then((moduleFactory) =>
-      this.bootstrapModuleFactoryWithApplicationProviders(
-        moduleFactory,
-        options,
-        additionalApplicationProviders,
-      ),
+      this.bootstrapModuleFactory(moduleFactory, options),
     );
   }
 
diff --git a/packages/core/src/render3/ng_module_ref.ts b/packages/core/src/render3/ng_module_ref.ts
@@ -67,7 +67,7 @@ export class NgModuleRef<T> extends viewEngine_NgModuleRef<T> implements Interna
   constructor(
     private readonly ngModuleType: Type<T>,
     public _parent: Injector | null,
-    additionalProviders: StaticProvider[],
+    additionalProviders: Array<Provider | EnvironmentProviders>,
     runInjectorInitializers = true,
   ) {
     super();
@@ -137,7 +137,7 @@ export class NgModuleFactory<T> extends viewEngine_NgModuleFactory<T> {
 export function createNgModuleRefWithProviders<T>(
   moduleType: Type<T>,
   parentInjector: Injector | null,
-  additionalProviders: StaticProvider[],
+  additionalProviders: Array<Provider | EnvironmentProviders>,
 ): InternalNgModuleRef<T> {
   return new NgModuleRef(moduleType, parentInjector, additionalProviders, false);
 }
diff --git a/packages/core/test/bundling/forms_reactive/bundle.golden_symbols.json b/packages/core/test/bundling/forms_reactive/bundle.golden_symbols.json
@@ -315,7 +315,6 @@
       "__spreadProps",
       "__spreadValues",
       "__values",
-      "_additionalApplicationProviders",
       "_applyRootElementTransformImpl",
       "_arrayIndexOfSorted",
       "_bind",
@@ -542,7 +541,6 @@
       "fromPromise",
       "fromReadableStreamLike",
       "getActiveConsumer",
-      "getAndClearAdditionalProviders",
       "getBaseElementHref",
       "getBeforeNodeForView",
       "getBindingsEnabled",
diff --git a/packages/core/test/bundling/forms_template_driven/bundle.golden_symbols.json b/packages/core/test/bundling/forms_template_driven/bundle.golden_symbols.json
@@ -319,7 +319,6 @@
       "__spreadProps",
       "__spreadValues",
       "__values",
-      "_additionalApplicationProviders",
       "_applyRootElementTransformImpl",
       "_arrayIndexOfSorted",
       "_bind",
@@ -543,7 +542,6 @@
       "fromPromise",
       "fromReadableStreamLike",
       "getActiveConsumer",
-      "getAndClearAdditionalProviders",
       "getBaseElementHref",
       "getBeforeNodeForView",
       "getBindingsEnabled",
diff --git a/packages/upgrade/static/src/downgrade_module.ts b/packages/upgrade/static/src/downgrade_module.ts
@@ -13,7 +13,7 @@ import {
   PlatformRef,
   StaticProvider,
   Type,
-  ɵsetZoneProvidersForNextBootstrap,
+  ɵinternalProvideZoneChangeDetection as internalProvideZoneChangeDetection,
 } from '@angular/core';
 import {platformBrowser} from '@angular/platform-browser';
 
@@ -384,21 +384,20 @@ export function downgradeModule<T>(
   if (ɵutil.isNgModuleType(moduleOrBootstrapFn)) {
     // NgModule class
     bootstrapFn = (extraProviders: StaticProvider[]) =>
-      platformBrowser(extraProviders).bootstrapModule(moduleOrBootstrapFn);
+      platformBrowser(extraProviders).bootstrapModule(moduleOrBootstrapFn, {
+        applicationProviders: [internalProvideZoneChangeDetection({})],
+      });
   } else if (!ɵutil.isFunction(moduleOrBootstrapFn)) {
     // NgModule factory
     bootstrapFn = (extraProviders: StaticProvider[]) =>
-      platformBrowser(extraProviders).bootstrapModuleFactory(moduleOrBootstrapFn);
+      platformBrowser(extraProviders).bootstrapModuleFactory(moduleOrBootstrapFn, {
+        applicationProviders: [internalProvideZoneChangeDetection({})],
+      });
   } else {
     // bootstrap function
     bootstrapFn = moduleOrBootstrapFn;
   }
 
-  const wrappedBootstrapFn = (extraProviders: StaticProvider[]) => {
-    ɵsetZoneProvidersForNextBootstrap();
-    return bootstrapFn(extraProviders);
-  };
-
   let injector: Injector;
 
   // Create an ng1 module to bootstrap.
@@ -421,7 +420,7 @@ export function downgradeModule<T>(
       ($injector: ɵangular1.IInjectorService) => {
         setTempInjectorRef($injector);
         const result: ɵutil.LazyModuleRef = {
-          promise: wrappedBootstrapFn(angular1Providers).then((ref) => {
+          promise: bootstrapFn(angular1Providers).then((ref) => {
             injector = result.injector = new NgAdapterInjector(ref.injector);
             injector.get(ɵconstants.$INJECTOR);
 
diff --git a/packages/upgrade/static/test/integration/downgrade_module_spec.ts b/packages/upgrade/static/test/integration/downgrade_module_spec.ts
