Feature: add client runtime cache for all item endpoints (#19960)

* extend controller base

* extend controller base

* add package for management api

* add signalr as external package

* connect to server event hub

* do no act on undefined

* add event subject

* correct alias

* export token

* add helper methods

* cache server responses

* fix import

* use helpers

* add detail request manager

* implement for document type

* implement for data type

* add method for update

* add support for create method

* align code

* Update detail-request.manager.ts

* move explicit naming

* move into folder

* collect server code in folder

* add implementation for data type request manager

* implement for document type

* only cache when we have connection to the server events

* update

* fix imports

* introduce item cache

* call trough get items controller

* remove log

* add unit tests for item cache

* Create cache.test.ts

* use sync method to lookup data type item

* use correct alias

* remove unused code

* data type item cache

* add client document type item cache

* add client cache for dictionary items

* add media item client cache

* add client cache for media type item

* add client cache for member and member type items

* add member group item cache

* split detail cache invalidation from request manager

* introduce item cache invalidation manager

* remove arg

* add data type item cache manager

* add memeber group item cache invalidation manager

* remove unused

* invalidate documents when document types changes

* align naming

* add method to get unique

* add dictionary item cache manager

* use server model instead of mapping

* call method

* update args

* update document type item cache invalidation

* add cache invalidation for member items

* update

* update

* update

* add item caching for languages

* add template item cache

* cache stylesheet items

* add caching for script items

* cache partial view items

* cache user items

* cache user group items

* add document blueprint item cache

* Removed readonly Signs property to re-align client models.

* Regenerate client types.

* Applied changes from code review.

* cache static file items

* add webhook item cache

* update mocks with signs data

* update mocks

* fix lint error

* fix eslint errors

---------

Co-authored-by: Jacob Overgaard <[email protected]>
Co-authored-by: Andy Butland <[email protected]>

Author: 3 people

src/Umbraco.Web.UI.Client/src/packages/data-type/entry-point.ts

@@ -1,12 +1,16 @@
 import { UmbManagementApiDataTypeDetailDataCacheInvalidationManager } from './repository/detail/server-data-source/data-type-detail.server.cache-invalidation.manager.js';
+import { UmbManagementApiDataTypeItemDataCacheInvalidationManager } from './repository/item/data-type-item.server.cache-invalidation.manager.js';
 import type { UmbEntryPointOnInit, UmbEntryPointOnUnload } from '@umbraco-cms/backoffice/extension-api';
 
 let detailDataCacheInvalidationManager: UmbManagementApiDataTypeDetailDataCacheInvalidationManager | undefined;
+let itemDataCacheInvalidationManager: UmbManagementApiDataTypeItemDataCacheInvalidationManager | undefined;
 
 export const onInit: UmbEntryPointOnInit = (host) => {
 	detailDataCacheInvalidationManager = new UmbManagementApiDataTypeDetailDataCacheInvalidationManager(host);
+	itemDataCacheInvalidationManager = new UmbManagementApiDataTypeItemDataCacheInvalidationManager(host);
 };
 
 export const onUnload: UmbEntryPointOnUnload = () => {
 	detailDataCacheInvalidationManager?.destroy();
+	itemDataCacheInvalidationManager?.destroy();
 };

src/Umbraco.Web.UI.Client/src/packages/data-type/repository/item/data-type-item.server.cache-invalidation.manager.ts

@@ -0,0 +1,13 @@
+import { dataTypeItemCache } from './data-type-item.server.cache.js';
+import { UmbManagementApiItemDataCacheInvalidationManager } from '@umbraco-cms/backoffice/management-api';
+import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
+import type { DataTypeItemResponseModel } from '@umbraco-cms/backoffice/external/backend-api';
+
+export class UmbManagementApiDataTypeItemDataCacheInvalidationManager extends UmbManagementApiItemDataCacheInvalidationManager<DataTypeItemResponseModel> {
+	constructor(host: UmbControllerHost) {
+		super(host, {
+			dataCache: dataTypeItemCache,
+			eventSources: ['Umbraco:CMS:DataType'],
+		});
+	}
+}

src/Umbraco.Web.UI.Client/src/packages/data-type/repository/item/data-type-item.server.cache.ts

@@ -0,0 +1,6 @@
+import type { DataTypeItemResponseModel } from '@umbraco-cms/backoffice/external/backend-api';
+import { UmbManagementApiItemDataCache } from '@umbraco-cms/backoffice/management-api';
+
+const dataTypeItemCache = new UmbManagementApiItemDataCache<DataTypeItemResponseModel>();
+
+export { dataTypeItemCache };

src/Umbraco.Web.UI.Client/src/packages/data-type/repository/item/data-type-item.server.data-source.ts

@@ -1,12 +1,11 @@
 import { UMB_DATA_TYPE_ENTITY_TYPE } from '../../entity.js';
 import type { UmbDataTypeItemModel } from './types.js';
+import { UmbManagementApiDataTypeItemDataRequestManager } from './data-type-item.server.request-manager.js';
 import { UmbItemServerDataSourceBase } from '@umbraco-cms/backoffice/repository';
 import type { DataTypeItemResponseModel } from '@umbraco-cms/backoffice/external/backend-api';
-import { DataTypeService } from '@umbraco-cms/backoffice/external/backend-api';
 import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
 import { umbExtensionsRegistry } from '@umbraco-cms/backoffice/extension-registry';
 import type { ManifestPropertyEditorUi } from '@umbraco-cms/backoffice/property-editor';
-import { UmbItemDataApiGetRequestController } from '@umbraco-cms/backoffice/entity-item';
 
 let manifestPropertyEditorUis: Array<ManifestPropertyEditorUi> = [];
 
@@ -19,12 +18,13 @@ export class UmbDataTypeItemServerDataSource extends UmbItemServerDataSourceBase
 	DataTypeItemResponseModel,
 	UmbDataTypeItemModel
 > {
+	#itemRequestManager = new UmbManagementApiDataTypeItemDataRequestManager(this);
+
 	/**
 	 * Creates an instance of UmbDataTypeItemServerDataSource.
 	 * @param {UmbControllerHost} host - The controller host for this controller to be appended to
 	 * @memberof UmbDataTypeItemServerDataSource
 	 */
-
 	constructor(host: UmbControllerHost) {
 		super(host, {
 			mapper,
@@ -41,13 +41,7 @@ export class UmbDataTypeItemServerDataSource extends UmbItemServerDataSourceBase
 	override async getItems(uniques: Array<string>) {
 		if (!uniques) throw new Error('Uniques are missing');
 
-		const itemRequestManager = new UmbItemDataApiGetRequestController(this, {
-			// eslint-disable-next-line local-rules/no-direct-api-import
-			api: (args) => DataTypeService.getItemDataType({ query: { id: args.uniques } }),
-			uniques,
-		});
-
-		const { data, error } = await itemRequestManager.request();
+		const { data, error } = await this.#itemRequestManager.getItems(uniques);
 
 		return { data: this._getMappedItems(data), error };
 	}

src/Umbraco.Web.UI.Client/src/packages/data-type/repository/item/data-type-item.server.request-manager.ts

@@ -0,0 +1,15 @@
+/* eslint-disable local-rules/no-direct-api-import */
+import { dataTypeItemCache } from './data-type-item.server.cache.js';
+import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
+import { DataTypeService, type DataTypeItemResponseModel } from '@umbraco-cms/backoffice/external/backend-api';
+import { UmbManagementApiItemDataRequestManager } from '@umbraco-cms/backoffice/management-api';
+
+export class UmbManagementApiDataTypeItemDataRequestManager extends UmbManagementApiItemDataRequestManager<DataTypeItemResponseModel> {
+	constructor(host: UmbControllerHost) {
+		super(host, {
+			getItems: (ids: Array<string>) => DataTypeService.getItemDataType({ query: { id: ids } }),
+			dataCache: dataTypeItemCache,
+			getUniqueMethod: (item) => item.id,
+		});
+	}
+}

src/Umbraco.Web.UI.Client/src/packages/dictionary/entry-point.ts

@@ -0,0 +1,12 @@
+import { UmbManagementApiDictionaryItemDataCacheInvalidationManager } from './repository/item/dictionary-item.server.cache-invalidation.manager.js';
+import type { UmbEntryPointOnInit, UmbEntryPointOnUnload } from '@umbraco-cms/backoffice/extension-api';
+
+let itemDataCacheInvalidationManager: UmbManagementApiDictionaryItemDataCacheInvalidationManager | undefined;
+
+export const onInit: UmbEntryPointOnInit = (host) => {
+	itemDataCacheInvalidationManager = new UmbManagementApiDictionaryItemDataCacheInvalidationManager(host);
+};
+
+export const onUnload: UmbEntryPointOnUnload = () => {
+	itemDataCacheInvalidationManager?.destroy();
+};

src/Umbraco.Web.UI.Client/src/packages/dictionary/manifests.ts

@@ -16,4 +16,10 @@ export const manifests: Array<UmbExtensionManifest> = [
 	...searchManifests,
 	...treeManifests,
 	...workspaceManifests,
+	{
+		name: 'Dictionary Backoffice Entry Point',
+		alias: 'Umb.EntryPoint.Dictionary',
+		type: 'backofficeEntryPoint',
+		js: () => import('./entry-point.js'),
+	},
 ];

src/Umbraco.Web.UI.Client/src/packages/dictionary/repository/item/dictionary-item.server.cache-invalidation.manager.ts

@@ -0,0 +1,13 @@
+import { dictionaryItemCache } from './dictionary-item.server.cache.js';
+import { UmbManagementApiItemDataCacheInvalidationManager } from '@umbraco-cms/backoffice/management-api';
+import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
+import type { DictionaryItemItemResponseModel } from '@umbraco-cms/backoffice/external/backend-api';
+
+export class UmbManagementApiDictionaryItemDataCacheInvalidationManager extends UmbManagementApiItemDataCacheInvalidationManager<DictionaryItemItemResponseModel> {
+	constructor(host: UmbControllerHost) {
+		super(host, {
+			dataCache: dictionaryItemCache,
+			eventSources: ['Umbraco:CMS:DictionaryItem'],
+		});
+	}
+}

src/Umbraco.Web.UI.Client/src/packages/dictionary/repository/item/dictionary-item.server.cache.ts

@@ -0,0 +1,6 @@
+import type { DictionaryItemItemResponseModel } from '@umbraco-cms/backoffice/external/backend-api';
+import { UmbManagementApiItemDataCache } from '@umbraco-cms/backoffice/management-api';
+
+const dictionaryItemCache = new UmbManagementApiItemDataCache<DictionaryItemItemResponseModel>();
+
+export { dictionaryItemCache };

src/Umbraco.Web.UI.Client/src/packages/dictionary/repository/item/dictionary-item.server.data-source.ts

@@ -1,10 +1,9 @@
 import { UMB_DICTIONARY_ENTITY_TYPE } from '../../entity.js';
 import type { UmbDictionaryItemModel } from './types.js';
+import { UmbManagementApiDictionaryItemDataRequestManager } from './dictionary-item.server.request-manager.js';
 import { UmbItemServerDataSourceBase } from '@umbraco-cms/backoffice/repository';
 import type { DictionaryItemItemResponseModel } from '@umbraco-cms/backoffice/external/backend-api';
-import { DictionaryService } from '@umbraco-cms/backoffice/external/backend-api';
 import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
-import { UmbItemDataApiGetRequestController } from '@umbraco-cms/backoffice/entity-item';
 
 /**
  * A server data source for Dictionary items
@@ -15,6 +14,8 @@ export class UmbDictionaryItemServerDataSource extends UmbItemServerDataSourceBa
 	DictionaryItemItemResponseModel,
 	UmbDictionaryItemModel
 > {
+	#itemRequestManager = new UmbManagementApiDictionaryItemDataRequestManager(this);
+
 	/**
 	 * Creates an instance of UmbDictionaryItemServerDataSource.
 	 * @param {UmbControllerHost} host - The controller host for this controller to be appended to
@@ -29,13 +30,7 @@ export class UmbDictionaryItemServerDataSource extends UmbItemServerDataSourceBa
 	override async getItems(uniques: Array<string>) {
 		if (!uniques) throw new Error('Uniques are missing');
 
-		const itemRequestManager = new UmbItemDataApiGetRequestController(this, {
-			// eslint-disable-next-line local-rules/no-direct-api-import
-			api: (args) => DictionaryService.getItemDictionary({ query: { id: args.uniques } }),
-			uniques,
-		});
-
-		const { data, error } = await itemRequestManager.request();
+		const { data, error } = await this.#itemRequestManager.getItems(uniques);
 
 		return { data: this._getMappedItems(data), error };
 	}