Merge pull request #2010 from umbraco/14/bugfix/calculate-user-start-nodes

iOvergaard · web-flow · commit 985975fc74a0 · 2024-06-26T10:40:40.000+02:00
Bugfix: Render calculated user start nodes in User Workspace
diff --git a/src/external/backend-api/src/models.ts b/src/external/backend-api/src/models.ts
diff --git a/src/external/backend-api/src/services.ts b/src/external/backend-api/src/services.ts
@@ -8566,6 +8566,29 @@ providerName
 		});
 	}
 
+	/**
+	 * @returns unknown OK
+	 * @throws ApiError
+	 */
+	public static getUserByIdCalculateStartNodes(data: UserData['payloads']['GetUserByIdCalculateStartNodes']): CancelablePromise<UserData['responses']['GetUserByIdCalculateStartNodes']> {
+		const {
+                    
+                    id
+                } = data;
+		return __request(OpenAPI, {
+			method: 'GET',
+			url: '/umbraco/management/api/v1/user/{id}/calculate-start-nodes',
+			path: {
+				id
+			},
+			errors: {
+				401: `The resource is protected and requires an authentication token`,
+				403: `The authenticated user do not have access to this resource`,
+				404: `Not Found`,
+			},
+		});
+	}
+
 	/**
 	 * @returns string OK
 	 * @throws ApiError
diff --git a/src/mocks/data/user/user.db.ts b/src/mocks/data/user/user.db.ts
@@ -76,7 +76,7 @@ class UmbUserMockDB extends UmbEntityMockDbBase<UmbMockUserModel> {
 			hasAccessToSensitiveData: true,
 			avatarUrls: [],
 			hasAccessToAllLanguages: true,
-			languageIsoCode: firstUser.languageIsoCode,
+			languageIsoCode: firstUser.languageIsoCode || null,
 			languages: [],
 			documentStartNodeIds: firstUser.documentStartNodeIds,
 			mediaStartNodeIds: firstUser.mediaStartNodeIds,
diff --git a/src/packages/core/repository/detail/detail-data-source.interface.ts b/src/packages/core/repository/detail/detail-data-source.interface.ts
@@ -2,8 +2,11 @@ import type { UmbDataSourceResponse } from '../data-source-response.interface.js
 import type { UmbReadDetailDataSource } from './read/index.js';
 import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
 
-export interface UmbDetailDataSourceConstructor<DetailType = any> {
-	new (host: UmbControllerHost): UmbDetailDataSource<DetailType>;
+export interface UmbDetailDataSourceConstructor<
+	DetailType = any,
+	UmbDetailDataSourceType extends UmbDetailDataSource<DetailType> = UmbDetailDataSource<DetailType>,
+> {
+	new (host: UmbControllerHost): UmbDetailDataSourceType;
 }
 
 export interface UmbDetailDataSource<DetailType> extends UmbReadDetailDataSource<DetailType> {
diff --git a/src/packages/core/repository/detail/detail-repository-base.ts b/src/packages/core/repository/detail/detail-repository-base.ts
@@ -8,14 +8,17 @@ import type { UmbContextToken } from '@umbraco-cms/backoffice/context-api';
 import type { UmbDetailStore } from '@umbraco-cms/backoffice/store';
 import type { UmbApi } from '@umbraco-cms/backoffice/extension-api';
 
-export abstract class UmbDetailRepositoryBase<DetailModelType extends { unique: string; entityType: string }>
+export abstract class UmbDetailRepositoryBase<
+		DetailModelType extends { unique: string; entityType: string },
+		UmbDetailDataSourceType extends UmbDetailDataSource<DetailModelType> = UmbDetailDataSource<DetailModelType>,
+	>
 	extends UmbRepositoryBase
 	implements UmbDetailRepository<DetailModelType>, UmbApi
 {
 	#init: Promise<unknown>;
 
 	#detailStore?: UmbDetailStore<DetailModelType>;
-	#detailSource: UmbDetailDataSource<DetailModelType>;
+	protected detailDataSource: UmbDetailDataSourceType;
 	#notificationContext?: UmbNotificationContext;
 
 	constructor(
@@ -25,7 +28,7 @@ export abstract class UmbDetailRepositoryBase<DetailModelType extends { unique:
 	) {
 		super(host);
 
-		this.#detailSource = new detailSource(host);
+		this.detailDataSource = new detailSource(host) as UmbDetailDataSourceType;
 
 		this.#init = Promise.all([
 			this.consumeContext(detailStoreContextAlias, (instance) => {
@@ -45,7 +48,7 @@ export abstract class UmbDetailRepositoryBase<DetailModelType extends { unique:
 	 * @memberof UmbDetailRepositoryBase
 	 */
 	async createScaffold(preset?: Partial<DetailModelType>) {
-		return this.#detailSource.createScaffold(preset);
+		return this.detailDataSource.createScaffold(preset);
 	}
 
 	/**
@@ -58,7 +61,7 @@ export abstract class UmbDetailRepositoryBase<DetailModelType extends { unique:
 		if (!unique) throw new Error('Unique is missing');
 		await this.#init;
 
-		const { data, error } = await this.#detailSource.read(unique);
+		const { data, error } = await this.detailDataSource.read(unique);
 
 		if (data) {
 			this.#detailStore!.append(data);
@@ -78,7 +81,7 @@ export abstract class UmbDetailRepositoryBase<DetailModelType extends { unique:
 		if (!model) throw new Error('Data is missing');
 		await this.#init;
 
-		const { data: createdData, error } = await this.#detailSource.create(model, parentUnique);
+		const { data: createdData, error } = await this.detailDataSource.create(model, parentUnique);
 
 		if (createdData) {
 			this.#detailStore?.append(createdData);
@@ -102,7 +105,7 @@ export abstract class UmbDetailRepositoryBase<DetailModelType extends { unique:
 		if (!model.unique) throw new Error('Unique is missing');
 		await this.#init;
 
-		const { data: updatedData, error } = await this.#detailSource.update(model);
+		const { data: updatedData, error } = await this.detailDataSource.update(model);
 
 		if (updatedData) {
 			this.#detailStore!.updateItem(model.unique, updatedData);
@@ -125,7 +128,7 @@ export abstract class UmbDetailRepositoryBase<DetailModelType extends { unique:
 		if (!unique) throw new Error('Unique is missing');
 		await this.#init;
 
-		const { error } = await this.#detailSource.delete(unique);
+		const { error } = await this.detailDataSource.delete(unique);
 
 		if (!error) {
 			this.#detailStore!.removeItem(unique);
@@ -152,7 +155,7 @@ export abstract class UmbDetailRepositoryBase<DetailModelType extends { unique:
 
 	override destroy(): void {
 		this.#detailStore = undefined;
-		(this.#detailSource as any) = undefined;
+		(this.detailDataSource as any) = undefined;
 		super.destroy();
 	}
 }
diff --git a/src/packages/user/user/components/user-document-start-node/user-document-start-node.element.ts b/src/packages/user/user/components/user-document-start-node/user-document-start-node.element.ts
@@ -5,8 +5,18 @@ import { UmbDocumentItemRepository } from '@umbraco-cms/backoffice/document';
 
 @customElement('umb-user-document-start-node')
 export class UmbUserDocumentStartNodeElement extends UmbLitElement {
+	#uniques: Array<string> = [];
 	@property({ type: Array, attribute: false })
-	uniques: Array<string> = [];
+	public get uniques(): Array<string> {
+		return this.#uniques;
+	}
+	public set uniques(value: Array<string>) {
+		this.#uniques = value;
+
+		if (this.#uniques.length > 0) {
+			this.#observeItems();
+		}
+	}
 
 	@property({ type: Boolean })
 	readonly = false;
@@ -16,10 +26,12 @@ export class UmbUserDocumentStartNodeElement extends UmbLitElement {
 
 	#itemRepository = new UmbDocumentItemRepository(this);
 
-	protected override async firstUpdated(): Promise<void> {
-		if (this.uniques.length === 0) return;
-		const { data } = await this.#itemRepository.requestItems(this.uniques);
-		this._displayValue = data || [];
+	async #observeItems() {
+		const { asObservable } = await this.#itemRepository.requestItems(this.#uniques);
+
+		this.observe(asObservable(), (data) => {
+			this._displayValue = data || [];
+		});
 	}
 
 	override render() {
diff --git a/src/packages/user/user/components/user-media-start-node/user-media-start-node.element.ts b/src/packages/user/user/components/user-media-start-node/user-media-start-node.element.ts
@@ -5,8 +5,18 @@ import { UmbMediaItemRepository } from '@umbraco-cms/backoffice/media';
 
 @customElement('umb-user-media-start-node')
 export class UmbUserMediaStartNodeElement extends UmbLitElement {
+	#uniques: Array<string> = [];
 	@property({ type: Array, attribute: false })
-	uniques: Array<string> = [];
+	public get uniques(): Array<string> {
+		return this.#uniques;
+	}
+	public set uniques(value: Array<string>) {
+		this.#uniques = value;
+
+		if (this.#uniques.length > 0) {
+			this.#observeItems();
+		}
+	}
 
 	@property({ type: Boolean })
 	readonly = false;
@@ -16,10 +26,12 @@ export class UmbUserMediaStartNodeElement extends UmbLitElement {
 
 	#itemRepository = new UmbMediaItemRepository(this);
 
-	protected override async firstUpdated(): Promise<void> {
-		if (this.uniques.length === 0) return;
-		const { data } = await this.#itemRepository.requestItems(this.uniques);
-		this._displayValue = data || [];
+	async #observeItems() {
+		const { asObservable } = await this.#itemRepository.requestItems(this.#uniques);
+
+		this.observe(asObservable(), (data) => {
+			this._displayValue = data || [];
+		});
 	}
 
 	override render() {
diff --git a/src/packages/user/user/repository/detail/types.ts b/src/packages/user/user/repository/detail/types.ts
@@ -0,0 +1,6 @@
+import type { UmbUserDetailModel, UmbUserStartNodesModel } from '../../types.js';
+import type { UmbDataSourceResponse, UmbDetailDataSource } from '@umbraco-cms/backoffice/repository';
+
+export interface UmbUserDetailDataSource extends UmbDetailDataSource<UmbUserDetailModel> {
+	calculateStartNodes(unique: string): Promise<UmbDataSourceResponse<UmbUserStartNodesModel>>;
+}
diff --git a/src/packages/user/user/repository/detail/user-detail.repository.ts b/src/packages/user/user/repository/detail/user-detail.repository.ts
@@ -1,17 +1,33 @@
 import type { UmbUserDetailModel } from '../../types.js';
+import type { UmbUserDetailDataSource } from './types.js';
 import { UmbUserServerDataSource } from './user-detail.server.data-source.js';
 import { UMB_USER_DETAIL_STORE_CONTEXT } from './user-detail.store.js';
 import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
 import { UmbDetailRepositoryBase } from '@umbraco-cms/backoffice/repository';
 
-export class UmbUserDetailRepository extends UmbDetailRepositoryBase<UmbUserDetailModel> {
+export class UmbUserDetailRepository extends UmbDetailRepositoryBase<UmbUserDetailModel, UmbUserDetailDataSource> {
 	constructor(host: UmbControllerHost) {
 		super(host, UmbUserServerDataSource, UMB_USER_DETAIL_STORE_CONTEXT);
 	}
 
+	/**
+	 * Creates a new User detail
+	 * @param {UmbUserDetailModel} model
+	 * @return {*}
+	 * @memberof UmbUserDetailRepository
+	 */
 	override async create(model: UmbUserDetailModel) {
 		return super.create(model, null);
 	}
+
+	/**
+	 * Requests the detail for the given unique
+	 * @return {*}
+	 * @memberof UmbUserDetailRepository
+	 */
+	requestCalculateStartNodes(unique: string) {
+		return this.detailDataSource.calculateStartNodes(unique);
+	}
 }
 
 export default UmbUserDetailRepository;
diff --git a/src/packages/user/user/repository/detail/user-detail.server.data-source.ts b/src/packages/user/user/repository/detail/user-detail.server.data-source.ts
@@ -1,4 +1,4 @@
-import type { UmbUserDetailModel } from '../../types.js';
+import type { UmbUserDetailModel, UmbUserStartNodesModel } from '../../types.js';
 import { UMB_USER_ENTITY_TYPE } from '../../entity.js';
 import { UmbId } from '@umbraco-cms/backoffice/id';
 import type { UmbDetailDataSource } from '@umbraco-cms/backoffice/repository';
@@ -212,4 +212,42 @@ export class UmbUserServerDataSource implements UmbDetailDataSource<UmbUserDetai
 			}),
 		);
 	}
+
+	/**
+	 * Calculates the start nodes for the User
+	 * @param {string} unique
+	 * @return {*}
+	 * @memberof UmbUserServerDataSource
+	 */
+	async calculateStartNodes(unique: string) {
+		if (!unique) throw new Error('Unique is missing');
+
+		const { data, error } = await tryExecuteAndNotify(
+			this.#host,
+			UserService.getUserByIdCalculateStartNodes({
+				id: unique,
+			}),
+		);
+
+		if (data) {
+			const calculatedStartNodes: UmbUserStartNodesModel = {
+				hasDocumentRootAccess: data.hasDocumentRootAccess,
+				documentStartNodeUniques: data.documentStartNodeIds.map((node) => {
+					return {
+						unique: node.id,
+					};
+				}),
+				hasMediaRootAccess: data.hasMediaRootAccess,
+				mediaStartNodeUniques: data.mediaStartNodeIds.map((node) => {
+					return {
+						unique: node.id,
+					};
+				}),
+			};
+
+			return { data: calculatedStartNodes };
+		}
+
+		return { error };
+	}
 }
diff --git a/src/packages/user/user/types.ts b/src/packages/user/user/types.ts
@@ -5,21 +5,17 @@ import { UserStateModel, type UserTwoFactorProviderModel } from '@umbraco-cms/ba
 export type UmbUserStateEnum = UserStateModel;
 export const UmbUserStateEnum = UserStateModel;
 
-export interface UmbUserDetailModel {
+export interface UmbUserDetailModel extends UmbUserStartNodesModel {
 	avatarUrls: Array<string>;
 	createDate: string | null;
-	documentStartNodeUniques: Array<UmbReferenceByUnique>;
 	email: string;
 	entityType: UmbUserEntityType;
 	failedLoginAttempts: number;
-	hasDocumentRootAccess: boolean;
-	hasMediaRootAccess: boolean;
 	isAdmin: boolean;
 	languageIsoCode: string | null;
 	lastLockoutDate: string | null;
 	lastLoginDate: string | null;
 	lastPasswordChangeDate: string | null;
-	mediaStartNodeUniques: Array<UmbReferenceByUnique>;
 	name: string;
 	state: UmbUserStateEnum | null;
 	unique: string;
@@ -28,4 +24,11 @@ export interface UmbUserDetailModel {
 	userName: string;
 }
 
+export interface UmbUserStartNodesModel {
+	documentStartNodeUniques: Array<UmbReferenceByUnique>;
+	hasDocumentRootAccess: boolean;
+	hasMediaRootAccess: boolean;
+	mediaStartNodeUniques: Array<UmbReferenceByUnique>;
+}
+
 export type UmbUserMfaProviderModel = UserTwoFactorProviderModel;
diff --git a/src/packages/user/user/workspace/components/user-workspace-access/user-workspace-access.element.ts b/src/packages/user/user/workspace/components/user-workspace-access/user-workspace-access.element.ts
@@ -1,5 +1,5 @@
 import { UMB_USER_WORKSPACE_CONTEXT } from '../../user-workspace.context-token.js';
-import type { UmbUserDetailModel } from '../../../types.js';
+import type { UmbUserStartNodesModel } from '../../../types.js';
 import { html, customElement, state, css } from '@umbraco-cms/backoffice/external/lit';
 import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
 import { UmbTextStyles } from '@umbraco-cms/backoffice/style';
@@ -10,7 +10,7 @@ const elementName = 'umb-user-workspace-access';
 @customElement(elementName)
 export class UmbUserWorkspaceAccessElement extends UmbLitElement {
 	@state()
-	private _user?: UmbUserDetailModel;
+	private _calculatedStartNodes?: UmbUserStartNodesModel;
 
 	#userWorkspaceContext?: typeof UMB_USER_WORKSPACE_CONTEXT.TYPE;
 
@@ -19,7 +19,11 @@ export class UmbUserWorkspaceAccessElement extends UmbLitElement {
 
 		this.consumeContext(UMB_USER_WORKSPACE_CONTEXT, (instance) => {
 			this.#userWorkspaceContext = instance;
-			this.observe(this.#userWorkspaceContext.data, (user) => (this._user = user), 'umbUserObserver');
+			this.observe(
+				this.#userWorkspaceContext.calculatedStartNodes,
+				(calculatedStartNodes) => (this._calculatedStartNodes = calculatedStartNodes),
+				'umbUserObserver',
+			);
 		});
 	}
 
@@ -41,15 +45,15 @@ export class UmbUserWorkspaceAccessElement extends UmbLitElement {
 		return html` <b><umb-localize key="sections_content">Content</umb-localize></b>
 			<umb-user-document-start-node
 				readonly
-				.uniques=${this._user?.documentStartNodeUniques.map((reference) => reference.unique) ||
+				.uniques=${this._calculatedStartNodes?.documentStartNodeUniques.map((reference) => reference.unique) ||
 				[]}></umb-user-document-start-node>`;
 	}
 
 	#renderMediaStartNodes() {
 		return html` <b><umb-localize key="sections_media">Media</umb-localize></b>
 			<umb-user-media-start-node
 				readonly
-				.uniques=${this._user?.mediaStartNodeUniques.map((reference) => reference.unique) ||
+				.uniques=${this._calculatedStartNodes?.mediaStartNodeUniques.map((reference) => reference.unique) ||
 				[]}></umb-user-media-start-node>`;
 	}
 
diff --git a/src/packages/user/user/workspace/user-workspace.context.ts b/src/packages/user/user/workspace/user-workspace.context.ts
