V16/feature: get context resolves in undefined if not found

src/Umbraco.Web.UI.Client/examples/workspace-context-counter/incrementor-workspace-action.ts

@@ -1,11 +1,14 @@
+import { EXAMPLE_COUNTER_CONTEXT } from './counter-workspace-context.js';
 import { UmbWorkspaceActionBase, type UmbWorkspaceAction } from '@umbraco-cms/backoffice/workspace';
-import { EXAMPLE_COUNTER_CONTEXT } from './counter-workspace-context';
 
 // The Example Incrementor Workspace Action Controller:
 export class ExampleIncrementorWorkspaceAction extends UmbWorkspaceActionBase implements UmbWorkspaceAction {
 	// This method is executed
 	override async execute() {
 		const context = await this.getContext(EXAMPLE_COUNTER_CONTEXT);
+		if (!context) {
+			throw new Error('Could not get the counter context');
+		}
 		context.increment();
 	}
 }

src/Umbraco.Web.UI.Client/src/apps/app/api-interceptor.controller.ts

@@ -29,6 +29,9 @@ export class UmbApiInterceptorController extends UmbControllerBase {
 			if (!isUmbNotifications(notifications)) return response;
 
 			this.getContext(UMB_NOTIFICATION_CONTEXT).then((notificationContext) => {
+				if (notificationContext === undefined) {
+					throw new Error('Notification context is not available');
+				}
 				for (const notification of notifications) {
 					notificationContext.peek(extractUmbNotificationColor(notification.type), {
 						data: { headline: notification.category, message: notification.message },

src/Umbraco.Web.UI.Client/src/apps/app/app-auth.controller.ts

@@ -7,13 +7,14 @@
 import { setStoredPath } from '@umbraco-cms/backoffice/utils';
 
 export class UmbAppAuthController extends UmbControllerBase {
+	#retrievedModal: Promise<unknown>;
 	#authContext?: typeof UMB_AUTH_CONTEXT.TYPE;
 	#isFirstCheck = true;
 
 	constructor(host: UmbControllerHost) {
 		super(host);
 
-		this.consumeContext(UMB_AUTH_CONTEXT, (context) => {
+		this.#retrievedModal = this.consumeContext(UMB_AUTH_CONTEXT, (context) => {
 			this.#authContext = context;
 
 			// Observe the user's authorization state and start the authorization flow if the user is not authorized
@@ -24,14 +25,15 @@
 				},
 				'_authState',
 			);
-		});
+		}).asPromise({ preventTimeout: true });
 	}
 
 	/**
 	 * Checks if the user is authorized.
 	 * If not, the authorization flow is started.
 	 */
 	async isAuthorized(): Promise<boolean> {
+		await this.#retrievedModal.catch(() => undefined);
 		if (!this.#authContext) {
 			throw new Error('[Fatal] Auth context is not available');
 		}
@@ -63,6 +65,7 @@
 	 * @param userLoginState
 	 */
 	async makeAuthorizationRequest(userLoginState: UmbUserLoginState = 'loggingIn'): Promise<boolean> {
+		await this.#retrievedModal.catch(() => undefined);
 		if (!this.#authContext) {
 			throw new Error('[Fatal] Auth context is not available');
 		}
@@ -111,13 +114,17 @@
 	}
 
 	async #showLoginModal(userLoginState: UmbUserLoginState): Promise<boolean> {
+		await this.#retrievedModal.catch(() => undefined);
 		if (!this.#authContext) {
 			throw new Error('[Fatal] Auth context is not available');
 		}
 
 		// Show the provider selection screen
 		const authModalKey = 'umbAuthModal';
 		const modalManager = await this.getContext(UMB_MODAL_MANAGER_CONTEXT);
+		if (!modalManager) {
+			throw new Error('[Fatal] Modal manager is not available');
+		}
 
 		const selected = await modalManager
 			.open(this._host, UMB_MODAL_APP_AUTH, {

src/Umbraco.Web.UI.Client/src/apps/backoffice/backoffice.context.ts

@@ -34,29 +34,26 @@ export class UmbBackofficeContext extends UmbContextBase<UmbBackofficeContext> {
 			});
 		});
 
-		this.#init();
-	}
-
-	async #init() {
-		const userContext = await this.getContext(UMB_CURRENT_USER_CONTEXT);
-		this.observe(
-			userContext.allowedSections,
-			(allowedSections) => {
-				if (!allowedSections) return;
-				// TODO: Please be aware that we re-initialize this initializer based on user permissions. I suggest we should solve this specific case should be improved by the ability to change the filter [NL]
-				new UmbExtensionsManifestInitializer(
-					this,
-					umbExtensionsRegistry,
-					'section',
-					(manifest) => allowedSections.includes(manifest.alias),
-					async (sections) => {
-						this.#allowedSections.setValue([...sections]);
-					},
-					'umbAllowedSectionsManifestInitializer',
-				);
-			},
-			'umbAllowedSectionsObserver',
-		);
+		this.consumeContext(UMB_CURRENT_USER_CONTEXT, (userContext) => {
+			this.observe(
+				userContext.allowedSections,
+				(allowedSections) => {
+					if (!allowedSections) return;
+					// TODO: Please be aware that we re-initialize this initializer based on user permissions. I suggest we should solve this specific case should be improved by the ability to change the filter [NL]
+					new UmbExtensionsManifestInitializer(
+						this,
+						umbExtensionsRegistry,
+						'section',
+						(manifest) => allowedSections.includes(manifest.alias),
+						async (sections) => {
+							this.#allowedSections.setValue([...sections]);
+						},
+						'umbAllowedSectionsManifestInitializer',
+					);
+				},
+				'umbAllowedSectionsObserver',
+			);
+		});
 	}
 
 	async #getVersion() {

src/Umbraco.Web.UI.Client/src/apps/backoffice/components/backoffice-header-logo.element.ts

@@ -47,7 +47,7 @@ export class UmbBackofficeHeaderLogoElement extends UmbLitElement {
 		});
 	}
 
-	protected override async firstUpdated() {
+	protected override firstUpdated() {
 		this.#isAdmin();
 	}
 
@@ -88,6 +88,10 @@ export class UmbBackofficeHeaderLogoElement extends UmbLitElement {
 
 	async #openSystemInformation() {
 		const modalManager = await this.getContext(UMB_MODAL_MANAGER_CONTEXT);
+		if (!modalManager) {
+			throw new Error('Modal manager not found');
+		}
+
 		modalManager
 			.open(this, UMB_SYSINFO_MODAL)
 			.onSubmit()
@@ -97,6 +101,7 @@ export class UmbBackofficeHeaderLogoElement extends UmbLitElement {
 	async #openNewVersion() {
 		if (!this._serverUpgradeCheck) return;
 		const modalManager = await this.getContext(UMB_MODAL_MANAGER_CONTEXT);
+		if (!modalManager) return;
 		modalManager
 			.open(this, UMB_NEWVERSION_MODAL, {
 				data: {

src/Umbraco.Web.UI.Client/src/apps/preview/apps/preview-culture.element.ts

@@ -36,7 +36,7 @@ export class UmbPreviewCultureElement extends UmbLitElement {
 		this._culture = culture;
 
 		const previewContext = await this.getContext(UMB_PREVIEW_CONTEXT);
-		previewContext.updateIFrame({ culture: culture.unique });
+		previewContext?.updateIFrame({ culture: culture.unique });
 	}
 
 	override render() {

src/Umbraco.Web.UI.Client/src/apps/preview/apps/preview-exit.element.ts

@@ -6,7 +6,7 @@ import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
 export class UmbPreviewExitElement extends UmbLitElement {
 	async #onClick() {
 		const previewContext = await this.getContext(UMB_PREVIEW_CONTEXT);
-		previewContext.exitPreview(0);
+		previewContext?.exitPreview(0);
 	}
 
 	override render() {

src/Umbraco.Web.UI.Client/src/apps/preview/apps/preview-open-website.element.ts

@@ -6,7 +6,7 @@ import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
 export class UmbPreviewOpenWebsiteElement extends UmbLitElement {
 	async #onClick() {
 		const previewContext = await this.getContext(UMB_PREVIEW_CONTEXT);
-		previewContext.openWebsite();
+		previewContext?.openWebsite();
 	}
 
 	override render() {

src/Umbraco.Web.UI.Client/src/apps/preview/preview.context.ts

@@ -24,24 +24,22 @@ export class UmbPreviewContext extends UmbContextBase<UmbPreviewContext> {
 
 	constructor(host: UmbControllerHost) {
 		super(host, UMB_PREVIEW_CONTEXT);
-		this.#init();
-	}
 
-	async #init() {
-		const appContext = await this.getContext(UMB_APP_CONTEXT);
-		this.#serverUrl = appContext.getServerUrl();
+		this.consumeContext(UMB_APP_CONTEXT, (appContext) => {
+			this.#serverUrl = appContext.getServerUrl();
 
-		const params = new URLSearchParams(window.location.search);
+			const params = new URLSearchParams(window.location.search);
 
-		this.#culture = params.get('culture');
-		this.#unique = params.get('id');
+			this.#culture = params.get('culture');
+			this.#unique = params.get('id');
 
-		if (!this.#unique) {
-			console.error('No unique ID found in query string.');
-			return;
-		}
+			if (!this.#unique) {
+				console.error('No unique ID found in query string.');
+				return;
+			}
 
-		this.#setPreviewUrl();
+			this.#setPreviewUrl();
+		});
 	}
 
 	#configureWebSocket() {

src/Umbraco.Web.UI.Client/src/libs/class-api/class.interface.ts

@@ -1,5 +1,6 @@
 import type {
 	UmbContextCallback,
+	UmbContextConsumerAsPromiseOptionsType,
 	UmbContextConsumerController,
 	UmbContextProviderController,
 	UmbContextToken,
@@ -64,5 +65,6 @@ export interface UmbClassInterface extends UmbControllerHost {
 	 */
 	getContext<BaseType = unknown, ResultType extends BaseType = BaseType>(
 		alias: string | UmbContextToken<BaseType, ResultType>,
-	): Promise<ResultType>;
+		options?: UmbContextConsumerAsPromiseOptionsType,
+	): Promise<ResultType | undefined>;
 }

src/Umbraco.Web.UI.Client/src/libs/class-api/class.mixin.ts

@@ -11,6 +11,7 @@
 	type UmbContextCallback,
 	UmbContextConsumerController,
 	UmbContextProviderController,
+	type UmbContextConsumerAsPromiseOptionsType,
 } from '@umbraco-cms/backoffice/context-api';
 import { type ObserverCallback, UmbObserverController, simpleHashCode } from '@umbraco-cms/backoffice/observable-api';
 
@@ -98,12 +99,19 @@
 
 		async getContext<BaseType = unknown, ResultType extends BaseType = BaseType>(
 			contextAlias: string | UmbContextToken<BaseType, ResultType>,
-		): Promise<ResultType> {
+			options?: UmbContextConsumerAsPromiseOptionsType,
+		): Promise<ResultType | undefined> {
 			const controller = new UmbContextConsumerController(this, contextAlias);
-			const promise = controller.asPromise().then((result) => {
-				controller.destroy();
-				return result;
-			});
+			const promise = controller
+				.asPromise(options)
+				.then((result) => {
+					controller.destroy();
+					return result;
+				})
+				.catch(() => {
+					controller.destroy();
+					return undefined;
+				});
 			return promise;
 		}