yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Item Repository: Sort statuses by order of unique (#20603)

Browse Source 
* utility

* ability to replace

* deprecate removeStatus

* no need to call this any longer

* Sort statuses and ensure not appending statuses, only updating them
This commit is contained in:
Niels Lyngsø
2025-10-22 11:42:13 +02:00
committed by GitHub
parent 63ae29a1aa
commit f6df0c1828
6 changed files with 120 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
src/Umbraco.Web.UI.Client/src/libs/observable-api/states/array-state.test.ts
View File

@@ -5,7 +5,7 @@ describe('ArrayState', () => {
type ObjectType = { key: string; another: string };
type ArrayType = ObjectType[];
let subject: UmbArrayState<ObjectType>;
let state: UmbArrayState<ObjectType>;
let initialData: ArrayType;
beforeEach(() => {
@@ -14,12 +14,12 @@ describe('ArrayState', () => {
{ key: '2', another: 'myValue2' },
{ key: '3', another: 'myValue3' },
];
subject = new UmbArrayState(initialData, (x) => x.key);
state = new UmbArrayState(initialData, (x) => x.key);
});
it('replays latests, no matter the amount of subscriptions.', (done) => {
let amountOfCallbacks = 0;
const observer = subject.asObservable();
const observer = state.asObservable();
observer.subscribe((value) => {
amountOfCallbacks++;
expect(value).to.be.equal(initialData);
@@ -36,8 +36,8 @@ describe('ArrayState', () => {
it('remove method, removes the one with the key', (done) => {
const expectedData = [initialData[0], initialData[2]];
subject.remove(['2']);
const observer = subject.asObservable();
state.remove(['2']);
const observer = state.asObservable();
observer.subscribe((value) => {
expect(JSON.stringify(value)).to.be.equal(JSON.stringify(expectedData));
done();
@@ -45,17 +45,17 @@ describe('ArrayState', () => {
});
it('getHasOne method, return true when key exists', () => {
expect(subject.getHasOne('2')).to.be.true;
expect(state.getHasOne('2')).to.be.true;
});
it('getHasOne method, return false when key does not exists', () => {
expect(subject.getHasOne('1337')).to.be.false;
expect(state.getHasOne('1337')).to.be.false;
});
it('filter method, removes anything that is not true of the given predicate method', (done) => {
const expectedData = [initialData[0], initialData[2]];
subject.filter((x) => x.key !== '2');
const observer = subject.asObservable();
state.filter((x) => x.key !== '2');
const observer = state.asObservable();
observer.subscribe((value) => {
expect(JSON.stringify(value)).to.be.equal(JSON.stringify(expectedData));
done();
@@ -64,11 +64,11 @@ describe('ArrayState', () => {
it('add new item via appendOne method.', (done) => {
const newItem = { key: '4', another: 'myValue4' };
subject.appendOne(newItem);
state.appendOne(newItem);
const expectedData = [...initialData, newItem];
const observer = subject.asObservable();
const observer = state.asObservable();
observer.subscribe((value) => {
expect(value.length).to.be.equal(expectedData.length);
expect(value[3].another).to.be.equal(expectedData[3].another);
@@ -78,9 +78,25 @@ describe('ArrayState', () => {
it('partially update an existing item via updateOne method.', (done) => {
const newItem = { another: 'myValue2.2' };
subject.updateOne('2', newItem);
state.updateOne('2', newItem);
const observer = subject.asObservable();
const observer = state.asObservable();
observer.subscribe((value) => {
expect(value.length).to.be.equal(initialData.length);
expect(value[0].another).to.be.equal('myValue1');
expect(value[1].another).to.be.equal('myValue2.2');
done();
});
});
it('replaces only existing items via replace method.', (done) => {
const newItems = [
{ key: '2', another: 'myValue2.2' },
{ key: '4', another: 'myValue4.4' },
];
state.replace(newItems);
const observer = state.asObservable();
observer.subscribe((value) => {
expect(value.length).to.be.equal(initialData.length);
expect(value[0].another).to.be.equal('myValue1');
@@ -90,7 +106,7 @@ describe('ArrayState', () => {
});
it('getObservablePart for a specific entry of array', (done) => {
const subObserver = subject.asObservablePart((data) => data.find((x) => x.key === '2'));
const subObserver = state.asObservablePart((data) => data.find((x) => x.key === '2'));
subObserver.subscribe((entry) => {
if (entry) {
expect(entry.another).to.be.equal(initialData[1].another);
@@ -103,7 +119,7 @@ describe('ArrayState', () => {
let amountOfCallbacks = 0;
const newItem = { key: '4', another: 'myValue4' };
const subObserver = subject.asObservablePart((data) => data.find((x) => x.key === newItem.key));
const subObserver = state.asObservablePart((data) => data.find((x) => x.key === newItem.key));
subObserver.subscribe((entry) => {
amountOfCallbacks++;
if (amountOfCallbacks === 1) {
@@ -118,16 +134,16 @@ describe('ArrayState', () => {
}
});
subject.appendOne(newItem);
state.appendOne(newItem);
});
it('asObservable returns the replaced item', (done) => {
const newItem = { key: '2', another: 'myValue4' };
subject.appendOne(newItem);
state.appendOne(newItem);
const expectedData = [initialData[0], newItem, initialData[2]];
const observer = subject.asObservable();
const observer = state.asObservable();
observer.subscribe((value) => {
expect(value.length).to.be.equal(expectedData.length);
expect(value[1].another).to.be.equal(newItem.another);
@@ -137,9 +153,9 @@ describe('ArrayState', () => {
it('getObservablePart returns the replaced item', (done) => {
const newItem = { key: '2', another: 'myValue4' };
subject.appendOne(newItem);
state.appendOne(newItem);
const subObserver = subject.asObservablePart((data) => data.find((x) => x.key === newItem.key));
const subObserver = state.asObservablePart((data) => data.find((x) => x.key === newItem.key));
subObserver.subscribe((entry) => {
expect(entry).to.be.equal(newItem); // Second callback should give us the right data:
if (entry) {
@@ -152,7 +168,7 @@ describe('ArrayState', () => {
it('getObservablePart replays existing data to any amount of subscribers.', (done) => {
let amountOfCallbacks = 0;
const subObserver = subject.asObservablePart((data) => data.find((x) => x.key === '2'));
const subObserver = state.asObservablePart((data) => data.find((x) => x.key === '2'));
subObserver.subscribe((entry) => {
if (entry) {
amountOfCallbacks++;
@@ -173,7 +189,7 @@ describe('ArrayState', () => {
it('getObservablePart replays existing data to any amount of subscribers.', (done) => {
let amountOfCallbacks = 0;
const subObserver = subject.asObservablePart((data) => data.find((x) => x.key === '2'));
const subObserver = state.asObservablePart((data) => data.find((x) => x.key === '2'));
subObserver.subscribe((entry) => {
if (entry) {
amountOfCallbacks++;
@@ -194,7 +210,7 @@ describe('ArrayState', () => {
it('append only updates observable if changes item', (done) => {
let count = 0;
const observer = subject.asObservable();
const observer = state.asObservable();
observer.subscribe((value) => {
count++;
if (count === 1) {
@@ -212,12 +228,12 @@ describe('ArrayState', () => {
Promise.resolve().then(() => {
// Despite how many times this happens it should not trigger any change.
subject.append(initialData);
subject.append(initialData);
subject.append(initialData);
state.append(initialData);
state.append(initialData);
state.append(initialData);
Promise.resolve().then(() => {
subject.appendOne({ key: '4', another: 'myValue4' });
state.appendOne({ key: '4', another: 'myValue4' });
});
});
});

33
src/Umbraco.Web.UI.Client/src/libs/observable-api/states/array-state.ts
View File

@@ -2,6 +2,7 @@ import { partialUpdateFrozenArray } from '../utils/partial-update-frozen-array.f
import { prependToUniqueArray } from '../utils/prepend-to-unique-array.function.js';
import { pushAtToUniqueArray } from '../utils/push-at-to-unique-array.function.js';
import { pushToUniqueArray } from '../utils/push-to-unique-array.function.js';
import { replaceInUniqueArray } from '../utils/replace-in-unique-array.function.js';
import { UmbDeepState } from './deep-state.js';
/**
@@ -263,6 +264,38 @@ export class UmbArrayState<T, U = unknown> extends UmbDeepState<T[]> {
return this;
}
/**
* @function replace
* @param {Partial<T>} entires - data of entries to be replaced.
* @returns {UmbArrayState<T>} Reference to it self.
* @description - Replaces one or more entries, requires the ArrayState to be constructed with a getUnique method.
* @example <caption>Example append some data.</caption>
* const data = [
* { key: 1, value: 'foo'},
* { key: 2, value: 'bar'}
* ];
* const myState = new UmbArrayState(data, (x) => x.key);
* const updates = [
* { key: 1, value: 'foo2'},
* { key: 3, value: 'bar2'}
* ];
* myState.replace(updates);
* // Only the existing item gets replaced:
* myState.getValue(); // -> [{ key: 1, value: 'foo2'}, { key: 2, value: 'bar'}]
*/
replace(entries: Array<T>): UmbArrayState<T> {
if (this.getUniqueMethod) {
const next = [...this.getValue()];
entries.forEach((entry) => {
replaceInUniqueArray(next, entry as T, this.getUniqueMethod!);
});
this.setValue(next);
} else {
throw new Error("Can't replace entries of an ArrayState without a getUnique method provided when constructed.");
}
return this;
}
/**
* @function updateOne
* @param {U} unique - Unique value to find entry to update.

1
src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/index.ts
View File

@@ -12,5 +12,6 @@ export * from './observe-multiple.function.js';
export * from './partial-update-frozen-array.function.js';
export * from './push-at-to-unique-array.function.js';
export * from './push-to-unique-array.function.js';
export * from './replace-in-unique-array.function.js';
export * from './simple-hash-code.function.js';
export * from './strict-equality-memoization.function.js';

19
src/Umbraco.Web.UI.Client/src/libs/observable-api/utils/replace-in-unique-array.function.ts Normal file
View File

@@ -0,0 +1,19 @@
/**
* @function replaceInUniqueArray
* @param {T[]} data - An array of objects.
* @param {T} entry - The object to replace with.
* @param {getUniqueMethod: (entry: T) => unknown} [getUniqueMethod] - Method to get the unique value of an entry.
* @description - Replaces an item of an Array.
* @example <caption>Example replace an entry of an Array. Where the key is unique and the item will only be replaced if matched with existing.</caption>
* const data = [{key: 'myKey', value:'initialValue'}];
* const entry = {key: 'myKey', value: 'replacedValue'};
* const newDataSet = replaceInUniqueArray(data, entry, x => x.key === key);
*/
export function replaceInUniqueArray<T>(data: T[], entry: T, getUniqueMethod: (entry: T) => unknown): T[] {
const unique = getUniqueMethod(entry);
const indexToReplace = data.findIndex((x) => getUniqueMethod(x) === unique);
if (indexToReplace !== -1) {
data[indexToReplace] = entry;
}
return data;
}

1
src/Umbraco.Web.UI.Client/src/packages/core/picker-input/picker-input.context.ts
View File

@@ -128,7 +128,6 @@ export class UmbPickerInputContext<
#removeItem(unique: string) {
const newSelection = this.getSelection().filter((value) => value !== unique);
this.setSelection(newSelection);
this.#itemManager.removeStatus(unique);
this.getHostElement().dispatchEvent(new UmbChangeEvent());
}
}

35
src/Umbraco.Web.UI.Client/src/packages/core/repository/repository-items.manager.ts
View File

@@ -7,6 +7,7 @@ import { UmbExtensionApiInitializer } from '@umbraco-cms/backoffice/extension-ap
import { UmbControllerBase } from '@umbraco-cms/backoffice/class-api';
import { UMB_ACTION_EVENT_CONTEXT } from '@umbraco-cms/backoffice/action';
import { UmbEntityUpdatedEvent } from '@umbraco-cms/backoffice/entity-action';
import { UmbDeprecation } from '../utils/deprecation/deprecation.js';
const ObserveRepositoryAlias = Symbol();
@@ -57,17 +58,20 @@ export class UmbRepositoryItemsManager<ItemType extends { unique: string }> exte
(uniques) => {
if (uniques.length === 0) {
this.#items.setValue([]);
this.#statuses.setValue([]);
return;
}
// TODO: This could be optimized so we only load the appended items, but this requires that the response checks that an item is still present in uniques. [NL]
// Check if we already have the items, and then just sort them:
const items = this.#items.getValue();
// Check if we already have the statuses, and then just sort them:
const statuses = this.#statuses.getValue();
if (
uniques.length === items.length &&
uniques.every((unique) => items.find((item) => item.unique === unique))
uniques.length === statuses.length &&
uniques.every((unique) => statuses.find((status) => status.unique === unique))
) {
const items = this.#items.getValue();
this.#items.setValue(this.#sortByUniques(items));
this.#statuses.setValue(this.#sortByUniques(statuses));
} else {
// We need to load new items, so ...
this.#requestItems();
@@ -125,9 +129,17 @@ export class UmbRepositoryItemsManager<ItemType extends { unique: string }> exte
return this.#items.asObservablePart((items) => items.find((item) => item.unique === unique));
}
/**
* @deprecated - This is resolved by setUniques, no need to update statuses.
* @param unique {string} - The unique identifier of the item to remove the status of.
*/
removeStatus(unique: string) {
const newStatuses = this.#statuses.getValue().filter((status) => status.unique !== unique);
this.#statuses.setValue(newStatuses);
new UmbDeprecation({
removeInVersion: '18.0.0',
deprecated: 'removeStatus',
solution: 'Statuses are removed automatically when setting uniques',
}).warn();
this.#statuses.filter((status) => status.unique !== unique);
}
async getItemByUnique(unique: string) {
@@ -145,6 +157,7 @@ export class UmbRepositoryItemsManager<ItemType extends { unique: string }> exte
const requestedUniques = this.getUniques();
this.#statuses.setValue(
// No need to do sorting here as we just got the unique in the right order above.
requestedUniques.map((unique) => ({
state: {
type: 'loading',
@@ -165,7 +178,7 @@ export class UmbRepositoryItemsManager<ItemType extends { unique: string }> exte
}
if (error) {
this.#statuses.append(
this.#statuses.replace(
requestedUniques.map((unique) => ({
state: {
type: 'error',
@@ -184,7 +197,7 @@ export class UmbRepositoryItemsManager<ItemType extends { unique: string }> exte
const resolvedUniques = requestedUniques.filter((unique) => !rejectedUniques.includes(unique));
this.#items.remove(rejectedUniques);
this.#statuses.append([
this.#statuses.replace([
...rejectedUniques.map(
(unique) =>
({
@@ -227,12 +240,11 @@ export class UmbRepositoryItemsManager<ItemType extends { unique: string }> exte
const { data, error } = await this.repository.requestItems([unique]);
if (error) {
this.#statuses.appendOne({
this.#statuses.updateOne(unique, {
state: {
type: 'error',
error: '#general_notFound',
},
unique,
} as UmbRepositoryItemsStatus);
}
@@ -245,11 +257,12 @@ export class UmbRepositoryItemsManager<ItemType extends { unique: string }> exte
const newItems = [...items];
newItems[index] = data[0];
this.#items.setValue(this.#sortByUniques(newItems));
// No need to update statuses here, as the item is the same, just updated.
}
}
}
#sortByUniques(data?: Array<ItemType>): Array<ItemType> {
#sortByUniques<T extends Pick<ItemType, 'unique'>>(data?: Array<T>): Array<T> {
if (!data) return [];
const uniques = this.getUniques();
return [...data].sort((a, b) => {