refactor(core): Return NOT_FOUND for retrieve instead of null (angular#60358)

This fits within the spec of the retrieve.

PR Close angular#60358

Author: iteriani

packages/core/primitives/di/src/not_found.ts

@@ -27,7 +27,7 @@ export class NotFoundError extends Error {
  * Type guard for checking if an unknown value is a NotFound.
  */
 export function isNotFound(e: unknown): e is NotFound {
-  return e === NOT_FOUND || (e as NotFoundError).name === 'ɵNotFound';
+  return e === NOT_FOUND || (e as NotFoundError)?.name === 'ɵNotFound';
 }
 
 /**

packages/core/src/di/injector_compatibility.ts

@@ -21,6 +21,7 @@ import {ProviderToken} from './provider_token';
 import type {HostAttributeToken} from './host_attribute_token';
 import {
   Injector as PrimitivesInjector,
+  isNotFound,
   NotFound,
   InjectionToken as PrimitivesInjectionToken,
   getCurrentInjector,
@@ -50,12 +51,19 @@ export class RetrievingInjector implements PrimitivesInjector {
   retrieve<T>(token: PrimitivesInjectionToken<T>, options: unknown): T | NotFound {
     const flags: InternalInjectFlags =
       convertToBitFlags(options as InjectOptions | undefined) || InternalInjectFlags.Default;
-    return (this.injector as BackwardsCompatibleInjector).get(
-      token as unknown as InjectionToken<T>,
-      // When a dependency is requested with an optional flag, DI returns null as the default value.
-      flags & InternalInjectFlags.Optional ? null : undefined,
-      flags,
-    ) as T;
+    try {
+      return (this.injector as BackwardsCompatibleInjector).get(
+        token as unknown as InjectionToken<T>,
+        // When a dependency is requested with an optional flag, DI returns null as the default value.
+        (flags & InternalInjectFlags.Optional ? null : THROW_IF_NOT_FOUND) as T,
+        flags,
+      ) as T;
+    } catch (e: any) {
+      if (isNotFound(e)) {
+        return e;
+      }
+      throw e;
+    }
   }
 }
 
@@ -96,11 +104,15 @@ export function injectInjectorOnly<T>(
   } else if (currentInjector === null) {
     return injectRootLimpMode(token, undefined, flags);
   } else {
-    const value = currentInjector.retrieve(
-      token as PrimitivesInjectionToken<T>,
-      convertToInjectOptions(flags),
-    ) as T;
+    const options = convertToInjectOptions(flags);
+    const value = currentInjector.retrieve(token as PrimitivesInjectionToken<T>, options) as T;
     ngDevMode && emitInjectEvent(token as Type<unknown>, value, flags);
+    if (isNotFound(value)) {
+      if (options.optional) {
+        return null;
+      }
+      throw value;
+    }
     return value;
   }
 }

packages/core/src/di/null_injector.ts

@@ -6,15 +6,15 @@
  * found in the LICENSE file at https://angular.dev/license
  */
 
+import {NotFoundError} from '@angular/core/primitives/di';
 import {stringify} from '../util/stringify';
 import type {Injector} from './injector';
 import {THROW_IF_NOT_FOUND} from './injector_compatibility';
 
 export class NullInjector implements Injector {
   get(token: any, notFoundValue: any = THROW_IF_NOT_FOUND): any {
     if (notFoundValue === THROW_IF_NOT_FOUND) {
-      const error = new Error(`NullInjectorError: No provider for ${stringify(token)}!`);
-      error.name = 'NullInjectorError';
+      const error = new NotFoundError(`NullInjectorError: No provider for ${stringify(token)}!`);
       throw error;
     }
     return notFoundValue;

packages/core/src/di/r3_injector.ts

@@ -80,6 +80,7 @@ import {
   InjectionToken as PrimitivesInjectionToken,
   NOT_FOUND,
   NotFound,
+  isNotFound,
 } from '@angular/core/primitives/di';
 
 /**
@@ -238,12 +239,19 @@ export class R3Injector extends EnvironmentInjector implements PrimitivesInjecto
   retrieve<T>(token: PrimitivesInjectionToken<T>, options?: unknown): T | NotFound {
     const flags: InternalInjectFlags =
       convertToBitFlags(options as InjectOptions | undefined) || InternalInjectFlags.Default;
-    return (this as BackwardsCompatibleInjector).get(
-      token as unknown as InjectionToken<T>,
-      // When a dependency is requested with an optional flag, DI returns null as the default value.
-      flags & InternalInjectFlags.Optional ? null : undefined,
-      flags,
-    )!;
+    try {
+      return (this as BackwardsCompatibleInjector).get(
+        token as unknown as InjectionToken<T>,
+        // When a dependency is requested with an optional flag, DI returns null as the default value.
+        THROW_IF_NOT_FOUND as T,
+        flags,
+      );
+    } catch (e: any) {
+      if (isNotFound(e)) {
+        return e;
+      }
+      throw e;
+    }
   }
 
   /**
@@ -367,7 +375,8 @@ export class R3Injector extends EnvironmentInjector implements PrimitivesInjecto
           : notFoundValue;
       return nextInjector.get(token, notFoundValue);
     } catch (e: any) {
-      if (e.name === 'NullInjectorError') {
+      if (isNotFound(e)) {
+        // @ts-ignore
         const path: any[] = (e[NG_TEMP_TOKEN_PATH] = e[NG_TEMP_TOKEN_PATH] || []);
         path.unshift(stringify(token));
         if (previousInjector) {

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

@@ -106,6 +106,7 @@
   "NG_INJ_DEF",
   "NG_PIPE_DEF",
   "NG_PROV_DEF",
+  "NOT_FOUND",
   "NOT_FOUND2",
   "NOT_FOUND_CHECK_ONLY_ELEMENT_INJECTOR",
   "NOT_YET",
@@ -123,6 +124,7 @@
   "NoopAnimationDriver",
   "NoopAnimationPlayer",
   "NoopNgZone",
+  "NotFoundError",
   "NullInjector",
   "ObjectUnsubscribedError",
   "Observable",
@@ -376,6 +378,7 @@
   "isLView",
   "isNodeMatchingSelector",
   "isNodeMatchingSelectorList",
+  "isNotFound",
   "isPlatformServer",
   "isPositive",
   "isPromise",

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

@@ -113,6 +113,7 @@
   "NG_MOD_DEF",
   "NG_PIPE_DEF",
   "NG_PROV_DEF",
+  "NOT_FOUND",
   "NOT_FOUND2",
   "NOT_FOUND_CHECK_ONLY_ELEMENT_INJECTOR",
   "NOT_YET",
@@ -133,6 +134,7 @@
   "NoopAnimationDriver",
   "NoopAnimationPlayer",
   "NoopNgZone",
+  "NotFoundError",
   "NullInjector",
   "ObjectUnsubscribedError",
   "Observable",
@@ -399,6 +401,7 @@
   "isLView",
   "isNodeMatchingSelector",
   "isNodeMatchingSelectorList",
+  "isNotFound",
   "isPlatformServer",
   "isPositive",
   "isPromise",

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

@@ -82,6 +82,7 @@
   "NG_MOD_DEF",
   "NG_PIPE_DEF",
   "NG_PROV_DEF",
+  "NOT_FOUND",
   "NOT_FOUND2",
   "NOT_FOUND_CHECK_ONLY_ELEMENT_INJECTOR",
   "NOT_YET",
@@ -98,6 +99,7 @@
   "NodeInjectorFactory",
   "NoneEncapsulationDomRenderer",
   "NoopNgZone",
+  "NotFoundError",
   "NullInjector",
   "ObjectUnsubscribedError",
   "Observable",
@@ -321,6 +323,7 @@
   "isLView",
   "isNodeMatchingSelector",
   "isNodeMatchingSelectorList",
+  "isNotFound",
   "isPlatformServer",
   "isPositive",
   "isPromise",

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

@@ -111,6 +111,7 @@
   "NG_TEMPLATE_SELECTOR",
   "NG_TEMP_TOKEN_PATH",
   "NG_TOKEN_PATH",
+  "NOT_FOUND",
   "NOT_FOUND2",
   "NOT_FOUND_CHECK_ONLY_ELEMENT_INJECTOR",
   "NOT_YET",
@@ -126,6 +127,7 @@
   "NodeInjectorFactory",
   "NoneEncapsulationDomRenderer",
   "NoopNgZone",
+  "NotFoundError",
   "NullInjector",
   "ON_COMPLETE_FNS",
   "ObjectUnsubscribedError",
@@ -385,6 +387,7 @@
   "isLView",
   "isNodeMatchingSelector",
   "isNodeMatchingSelectorList",
+  "isNotFound",
   "isPlatformServer",
   "isPositive",
   "isPromise",

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

@@ -118,6 +118,7 @@
   "NG_PROV_DEF",
   "NG_VALIDATORS",
   "NG_VALUE_ACCESSOR",
+  "NOT_FOUND",
   "NOT_FOUND2",
   "NOT_FOUND_CHECK_ONLY_ELEMENT_INJECTOR",
   "NOT_YET",
@@ -140,6 +141,7 @@
   "NodeInjectorFactory",
   "NoneEncapsulationDomRenderer",
   "NoopNgZone",
+  "NotFoundError",
   "NullInjector",
   "ObjectUnsubscribedError",
   "Observable",
@@ -470,6 +472,7 @@
   "isListLikeIterable",
   "isNodeMatchingSelector",
   "isNodeMatchingSelectorList",
+  "isNotFound",
   "isOptionsObj",
   "isPlatformServer",
   "isPositive",

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

@@ -110,6 +110,7 @@
   "NG_PROV_DEF",
   "NG_VALIDATORS",
   "NG_VALUE_ACCESSOR",
+  "NOT_FOUND",
   "NOT_FOUND2",
   "NOT_FOUND_CHECK_ONLY_ELEMENT_INJECTOR",
   "NOT_YET",
@@ -135,6 +136,7 @@
   "NodeInjectorFactory",
   "NoneEncapsulationDomRenderer",
   "NoopNgZone",
+  "NotFoundError",
   "NullInjector",
   "ObjectUnsubscribedError",
   "Observable",
@@ -456,6 +458,7 @@
   "isListLikeIterable",
   "isNodeMatchingSelector",
   "isNodeMatchingSelectorList",
+  "isNotFound",
   "isOptionsObj",
   "isPlatformServer",
   "isPositive",