This commit introduces a batched debounce mechanism for managing user
selection state changes. It effectively reduces unnecessary processing
during rapid script checking, preventing multiple triggers for code
compilation and UI rendering.
Key improvements include:
- Enhanced performance, especially noticeable when selecting large
categories. This update resolves minor UI freezes experienced when
selecting categories with numerous scripts.
- Correction of a bug where the code area only highlighted the last
selected script when multiple scripts were chosen.
Other changes include:
- Timing functions:
- Create a `Timing` folder for `throttle` and the new
`batchedDebounce` functions.
- Move these functions to the application layer from the presentation
layer, reflecting their application-wide use.
- Refactor existing code for improved clarity, naming consistency, and
adherence to new naming conventions.
- Add missing unit tests.
- `UserSelection`:
- State modifications in `UserSelection` now utilize a singular object
inspired by the CQRS pattern, enabling batch updates and flexible
change configurations, thereby simplifying change management.
- Remove the `I` prefix from related interfaces to align with new coding
standards.
- Refactor related code for better testability in isolation with
dependency injection.
- Repository:
- Move repository abstractions to the application layer.
- Improve repository abstraction to combine `ReadonlyRepository` and
`MutableRepository` interfaces.
- E2E testing:
- Introduce E2E tests to validate the correct batch selection
behavior.
- Add a specialized data attribute in `TheCodeArea.vue` for improved
testability.
- Reorganize shared Cypress functions for a more idiomatic Cypress
approach.
- Improve test documentation with related information.
- `SelectedScript`:
- Create an abstraction for simplified testability.
- Introduce `SelectedScriptStub` in tests as a substitute for the
actual object.
53 lines
1.8 KiB
TypeScript
53 lines
1.8 KiB
TypeScript
import { shallowRef } from 'vue';
|
|
import type { SelectionModifier, useUserSelectionState } from '@/presentation/components/Shared/Hooks/UseUserSelectionState';
|
|
import { UserSelection } from '@/application/Context/State/Selection/UserSelection';
|
|
import { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
|
|
import { StubWithObservableMethodCalls } from './StubWithObservableMethodCalls';
|
|
import { UserSelectionStub } from './UserSelectionStub';
|
|
import { ScriptSelectionStub } from './ScriptSelectionStub';
|
|
|
|
export class UseUserSelectionStateStub
|
|
extends StubWithObservableMethodCalls<ReturnType<typeof useUserSelectionState>> {
|
|
private readonly currentSelection = shallowRef<UserSelection>(
|
|
new UserSelectionStub(),
|
|
);
|
|
|
|
private modifyCurrentSelection(mutator: SelectionModifier) {
|
|
mutator(this.currentSelection.value);
|
|
this.registerMethodCall({
|
|
methodName: 'modifyCurrentSelection',
|
|
args: [mutator],
|
|
});
|
|
}
|
|
|
|
public withUserSelection(userSelection: UserSelection): this {
|
|
this.currentSelection.value = userSelection;
|
|
return this;
|
|
}
|
|
|
|
public withSelectedScripts(selectedScripts: readonly SelectedScript[]): this {
|
|
return this.withUserSelection(
|
|
new UserSelectionStub()
|
|
.withScripts(
|
|
new ScriptSelectionStub().withSelectedScripts(selectedScripts),
|
|
),
|
|
);
|
|
}
|
|
|
|
public get selection(): UserSelection {
|
|
return this.currentSelection.value;
|
|
}
|
|
|
|
public isSelectionModified(): boolean {
|
|
const modifyCall = this.callHistory.find((call) => call.methodName === 'modifyCurrentSelection');
|
|
return modifyCall !== undefined;
|
|
}
|
|
|
|
public get(): ReturnType<typeof useUserSelectionState> {
|
|
return {
|
|
currentSelection: this.currentSelection,
|
|
modifyCurrentSelection: this.modifyCurrentSelection.bind(this),
|
|
};
|
|
}
|
|
}
|