Fix code highlighting and optimize category select
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.
This commit is contained in:
undergroundwires
@@ -1,7 +1,10 @@
|
||||
import { SelectedScript } from '@/application/Context/State/Selection/SelectedScript';
|
||||
import { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
|
||||
import { RecommendationLevel } from '@/domain/RecommendationLevel';
|
||||
import { CategoryCollectionStateStub } from '@tests/unit/shared/Stubs/CategoryCollectionStateStub';
|
||||
import { ScriptSelectionStub } from '@tests/unit/shared/Stubs/ScriptSelectionStub';
|
||||
import { ScriptStub } from '@tests/unit/shared/Stubs/ScriptStub';
|
||||
import { SelectedScriptStub } from '@tests/unit/shared/Stubs/SelectedScriptStub';
|
||||
import { UserSelectionStub } from '@tests/unit/shared/Stubs/UserSelectionStub';
|
||||
|
||||
export class SelectionStateTestScenario {
|
||||
public readonly all: readonly SelectedScript[];
|
||||
@@ -28,13 +31,21 @@ export class SelectionStateTestScenario {
|
||||
this.all = [...this.allStandard, ...this.allStrict, ...this.allUnrecommended];
|
||||
}
|
||||
|
||||
public generateState(selectedScripts: readonly SelectedScript[]) {
|
||||
public generateState(selectedScripts: readonly SelectedScript[] = []) {
|
||||
const allScripts = this.all.map((s) => s.script);
|
||||
return new CategoryCollectionStateStub(allScripts)
|
||||
const scriptSelection = new ScriptSelectionStub()
|
||||
.withSelectedScripts(selectedScripts);
|
||||
const categoryCollectionState = new CategoryCollectionStateStub(allScripts)
|
||||
.withSelection(new UserSelectionStub().withScripts(scriptSelection));
|
||||
return {
|
||||
scriptsStub: scriptSelection,
|
||||
stateStub: categoryCollectionState,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
function createSelectedScripts(level?: RecommendationLevel, ...ids: string[]) {
|
||||
return ids.map((id) => new SelectedScript(new ScriptStub(id).withLevel(level), false));
|
||||
function createSelectedScripts(level?: RecommendationLevel, ...ids: string[]): SelectedScript[] {
|
||||
return ids.map((id) => new SelectedScriptStub(
|
||||
new ScriptStub(id).withLevel(level),
|
||||
).withRevert(false));
|
||||
}
|
||||
|
||||
@@ -3,10 +3,14 @@ import {
|
||||
SelectionCheckContext, SelectionMutationContext, SelectionType,
|
||||
getCurrentSelectionType, setCurrentSelectionType,
|
||||
} from '@/presentation/components/Scripts/Menu/Selector/SelectionTypeHandler';
|
||||
import { scrambledEqual } from '@/application/Common/Array';
|
||||
import { RecommendationLevel } from '@/domain/RecommendationLevel';
|
||||
import { ICategoryCollectionState } from '@/application/Context/State/ICategoryCollectionState';
|
||||
import { EnumRangeTestRunner } from '@tests/unit/application/Common/EnumRangeTestRunner';
|
||||
import { ScriptSelection } from '@/application/Context/State/Selection/Script/ScriptSelection';
|
||||
import { MethodCall } from '@tests/unit/shared/Stubs/StubWithObservableMethodCalls';
|
||||
import { expectExists } from '@tests/shared/Assertions/ExpectExists';
|
||||
import { scrambledEqual } from '@/application/Common/Array';
|
||||
import { IScript } from '@/domain/IScript';
|
||||
import { SelectionStateTestScenario } from './SelectionStateTestScenario';
|
||||
|
||||
describe('SelectionTypeHandler', () => {
|
||||
@@ -14,11 +18,11 @@ describe('SelectionTypeHandler', () => {
|
||||
describe('throws with invalid type', () => {
|
||||
// arrange
|
||||
const scenario = new SelectionStateTestScenario();
|
||||
const state = scenario.generateState([]);
|
||||
const { stateStub } = scenario.generateState([]);
|
||||
// act
|
||||
const act = (type: SelectionType) => setCurrentSelectionType(
|
||||
type,
|
||||
createMutationContext(state),
|
||||
createMutationContext(stateStub),
|
||||
);
|
||||
// assert
|
||||
new EnumRangeTestRunner(act)
|
||||
@@ -28,44 +32,64 @@ describe('SelectionTypeHandler', () => {
|
||||
describe('select types as expected', () => {
|
||||
// arrange
|
||||
const scenario = new SelectionStateTestScenario();
|
||||
const initialScriptsCases = [{
|
||||
name: 'when nothing is selected',
|
||||
initialScripts: [],
|
||||
}, {
|
||||
name: 'when some scripts are selected',
|
||||
initialScripts: [...scenario.allStandard, ...scenario.someStrict],
|
||||
}, {
|
||||
name: 'when all scripts are selected',
|
||||
initialScripts: scenario.all,
|
||||
}];
|
||||
for (const initialScriptsCase of initialScriptsCases) {
|
||||
describe(initialScriptsCase.name, () => {
|
||||
const state = scenario.generateState(initialScriptsCase.initialScripts);
|
||||
const typeExpectations = [{
|
||||
input: SelectionType.None,
|
||||
output: [],
|
||||
}, {
|
||||
input: SelectionType.Standard,
|
||||
output: scenario.allStandard,
|
||||
}, {
|
||||
input: SelectionType.Strict,
|
||||
output: [...scenario.allStandard, ...scenario.allStrict],
|
||||
}, {
|
||||
input: SelectionType.All,
|
||||
output: scenario.all,
|
||||
}];
|
||||
for (const expectation of typeExpectations) {
|
||||
// act
|
||||
it(`${SelectionType[expectation.input]} returns as expected`, () => {
|
||||
setCurrentSelectionType(expectation.input, createMutationContext(state));
|
||||
// assert
|
||||
const actual = state.selection.selectedScripts;
|
||||
const expected = expectation.output;
|
||||
expect(scrambledEqual(actual, expected));
|
||||
});
|
||||
const testScenarios: ReadonlyArray<{
|
||||
readonly givenType: SelectionType;
|
||||
readonly expectedCall: MethodCall<ScriptSelection>;
|
||||
}> = [
|
||||
{
|
||||
givenType: SelectionType.None,
|
||||
expectedCall: {
|
||||
methodName: 'deselectAll',
|
||||
args: [],
|
||||
},
|
||||
},
|
||||
{
|
||||
givenType: SelectionType.Standard,
|
||||
expectedCall: {
|
||||
methodName: 'selectOnly',
|
||||
args: [
|
||||
scenario.allStandard.map((s) => s.script),
|
||||
],
|
||||
},
|
||||
},
|
||||
{
|
||||
givenType: SelectionType.Strict,
|
||||
expectedCall: {
|
||||
methodName: 'selectOnly',
|
||||
args: [[
|
||||
...scenario.allStandard.map((s) => s.script),
|
||||
...scenario.allStrict.map((s) => s.script),
|
||||
]],
|
||||
},
|
||||
},
|
||||
{
|
||||
givenType: SelectionType.All,
|
||||
expectedCall: {
|
||||
methodName: 'selectAll',
|
||||
args: [],
|
||||
},
|
||||
},
|
||||
];
|
||||
testScenarios.forEach(({
|
||||
givenType, expectedCall,
|
||||
}) => {
|
||||
it(`${SelectionType[givenType]} modifies as expected`, () => {
|
||||
const { stateStub, scriptsStub } = scenario.generateState();
|
||||
// act
|
||||
setCurrentSelectionType(givenType, createMutationContext(stateStub));
|
||||
// assert
|
||||
const call = scriptsStub.callHistory.find(
|
||||
(c) => c.methodName === expectedCall.methodName,
|
||||
);
|
||||
expectExists(call);
|
||||
if (expectedCall.args.length > 0) { /** {@link ScriptSelection.selectOnly}. */
|
||||
expect(scrambledEqual(
|
||||
call.args[0] as IScript[],
|
||||
expectedCall.args[0] as IScript[],
|
||||
)).to.equal(true);
|
||||
}
|
||||
});
|
||||
}
|
||||
});
|
||||
});
|
||||
});
|
||||
describe('getCurrentSelectionType', () => {
|
||||
@@ -106,9 +130,9 @@ describe('SelectionTypeHandler', () => {
|
||||
}];
|
||||
for (const testCase of testCases) {
|
||||
it(testCase.name, () => {
|
||||
const state = scenario.generateState(testCase.selection);
|
||||
const { stateStub } = scenario.generateState(testCase.selection);
|
||||
// act
|
||||
const actual = getCurrentSelectionType(createCheckContext(state));
|
||||
const actual = getCurrentSelectionType(createCheckContext(stateStub));
|
||||
// assert
|
||||
expect(actual).to.deep.equal(
|
||||
testCase.expected,
|
||||
@@ -130,14 +154,14 @@ describe('SelectionTypeHandler', () => {
|
||||
|
||||
function createMutationContext(state: ICategoryCollectionState): SelectionMutationContext {
|
||||
return {
|
||||
selection: state.selection,
|
||||
selection: state.selection.scripts,
|
||||
collection: state.collection,
|
||||
};
|
||||
}
|
||||
|
||||
function createCheckContext(state: ICategoryCollectionState): SelectionCheckContext {
|
||||
return {
|
||||
selection: state.selection,
|
||||
selection: state.selection.scripts,
|
||||
collection: state.collection,
|
||||
};
|
||||
}
|
||||
|
||||
@@ -1,106 +1,101 @@
|
||||
import { describe, it, expect } from 'vitest';
|
||||
import { CategoryReverter } from '@/presentation/components/Scripts/View/Tree/NodeContent/Reverter/CategoryReverter';
|
||||
import { SelectedScript } from '@/application/Context/State/Selection/SelectedScript';
|
||||
import { UserSelection } from '@/application/Context/State/Selection/UserSelection';
|
||||
import { CategoryStub } from '@tests/unit/shared/Stubs/CategoryStub';
|
||||
import { CategoryCollectionStub } from '@tests/unit/shared/Stubs/CategoryCollectionStub';
|
||||
import { ScriptStub } from '@tests/unit/shared/Stubs/ScriptStub';
|
||||
import { getCategoryNodeId } from '@/presentation/components/Scripts/View/Tree/TreeViewAdapter/CategoryNodeMetadataConverter';
|
||||
import { UserSelectionStub } from '@tests/unit/shared/Stubs/UserSelectionStub';
|
||||
import { SelectedScriptStub } from '@tests/unit/shared/Stubs/SelectedScriptStub';
|
||||
import { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
|
||||
import { CategorySelectionStub } from '@tests/unit/shared/Stubs/CategorySelectionStub';
|
||||
|
||||
describe('CategoryReverter', () => {
|
||||
describe('getState', () => {
|
||||
// arrange
|
||||
const scripts = [
|
||||
new ScriptStub('revertable').withRevertCode('REM revert me'),
|
||||
new ScriptStub('revertable2').withRevertCode('REM revert me 2'),
|
||||
new ScriptStub('reversible').withRevertCode('REM revert me'),
|
||||
new ScriptStub('reversible2').withRevertCode('REM revert me 2'),
|
||||
];
|
||||
const category = new CategoryStub(1).withScripts(...scripts);
|
||||
const nodeId = getCategoryNodeId(category);
|
||||
const collection = new CategoryCollectionStub().withAction(category);
|
||||
const sut = new CategoryReverter(nodeId, collection);
|
||||
const testCases = [
|
||||
const testScenarios: ReadonlyArray<{
|
||||
readonly description: string;
|
||||
readonly selectedScripts: readonly SelectedScript[];
|
||||
readonly expectedState: boolean;
|
||||
}> = [
|
||||
{
|
||||
name: 'false when subscripts are not reverted',
|
||||
state: scripts.map((script) => new SelectedScript(script, false)),
|
||||
expected: false,
|
||||
description: 'returns `false` for non-reverted subscripts',
|
||||
selectedScripts: scripts.map(
|
||||
(script) => new SelectedScriptStub(script).withRevert(false),
|
||||
),
|
||||
expectedState: false,
|
||||
},
|
||||
{
|
||||
name: 'false when some subscripts are reverted',
|
||||
state: [new SelectedScript(scripts[0], false), new SelectedScript(scripts[0], true)],
|
||||
expected: false,
|
||||
description: 'returns `false` when only some subscripts are reverted',
|
||||
selectedScripts: [
|
||||
new SelectedScriptStub(scripts[0]).withRevert(false),
|
||||
new SelectedScriptStub(scripts[0]).withRevert(true),
|
||||
],
|
||||
expectedState: false,
|
||||
},
|
||||
{
|
||||
name: 'false when subscripts are not reverted',
|
||||
state: scripts.map((script) => new SelectedScript(script, true)),
|
||||
expected: true,
|
||||
description: 'returns `true` when all subscripts are reverted',
|
||||
selectedScripts: scripts.map(
|
||||
(script) => new SelectedScriptStub(script).withRevert(true),
|
||||
),
|
||||
expectedState: true,
|
||||
},
|
||||
];
|
||||
for (const testCase of testCases) {
|
||||
it(testCase.name, () => {
|
||||
testScenarios.forEach((
|
||||
{ description, selectedScripts, expectedState },
|
||||
) => {
|
||||
it(description, () => {
|
||||
// act
|
||||
const actual = sut.getState(testCase.state);
|
||||
const actual = sut.getState(selectedScripts);
|
||||
// assert
|
||||
expect(actual).to.equal(testCase.expected);
|
||||
expect(actual).to.equal(expectedState);
|
||||
});
|
||||
}
|
||||
});
|
||||
});
|
||||
describe('selectWithRevertState', () => {
|
||||
// arrange
|
||||
const scripts = [
|
||||
new ScriptStub('revertable').withRevertCode('REM revert me'),
|
||||
new ScriptStub('revertable2').withRevertCode('REM revert me 2'),
|
||||
const allScripts = [
|
||||
new ScriptStub('reversible').withRevertCode('REM revert me'),
|
||||
new ScriptStub('reversible2').withRevertCode('REM revert me 2'),
|
||||
];
|
||||
const category = new CategoryStub(1).withScripts(...scripts);
|
||||
const category = new CategoryStub(1).withScripts(...allScripts);
|
||||
const collection = new CategoryCollectionStub().withAction(category);
|
||||
/* eslint-disable object-property-newline */
|
||||
const testCases = [
|
||||
const testScenarios: ReadonlyArray<{
|
||||
readonly description: string;
|
||||
readonly expectedRevert: boolean;
|
||||
}> = [
|
||||
{
|
||||
name: 'selects with revert state when not selected',
|
||||
selection: [],
|
||||
revert: true, expectRevert: true,
|
||||
description: 'selects with revert',
|
||||
expectedRevert: true,
|
||||
},
|
||||
{
|
||||
name: 'selects with non-revert state when not selected',
|
||||
selection: [],
|
||||
revert: false, expectRevert: false,
|
||||
},
|
||||
{
|
||||
name: 'switches when already selected with revert state',
|
||||
selection: scripts.map((script) => new SelectedScript(script, true)),
|
||||
revert: false, expectRevert: false,
|
||||
},
|
||||
{
|
||||
name: 'switches when already selected with not revert state',
|
||||
selection: scripts.map((script) => new SelectedScript(script, false)),
|
||||
revert: true, expectRevert: true,
|
||||
},
|
||||
{
|
||||
name: 'keeps revert state when already selected with revert state',
|
||||
selection: scripts.map((script) => new SelectedScript(script, true)),
|
||||
revert: true, expectRevert: true,
|
||||
},
|
||||
{
|
||||
name: 'keeps revert state deselected when already selected wtih non revert state',
|
||||
selection: scripts.map((script) => new SelectedScript(script, false)),
|
||||
revert: false, expectRevert: false,
|
||||
description: 'selects without revert',
|
||||
expectedRevert: false,
|
||||
},
|
||||
];
|
||||
/* eslint-enable object-property-newline */
|
||||
const nodeId = getCategoryNodeId(category);
|
||||
for (const testCase of testCases) {
|
||||
it(testCase.name, () => {
|
||||
const selection = new UserSelection(collection, testCase.selection);
|
||||
testScenarios.forEach((
|
||||
{ description, expectedRevert },
|
||||
) => {
|
||||
it(description, () => {
|
||||
const categorySelection = new CategorySelectionStub();
|
||||
const sut = new CategoryReverter(nodeId, collection);
|
||||
const revertState = expectedRevert;
|
||||
// act
|
||||
sut.selectWithRevertState(testCase.revert, selection);
|
||||
sut.selectWithRevertState(
|
||||
revertState,
|
||||
new UserSelectionStub().withCategories(categorySelection),
|
||||
);
|
||||
// assert
|
||||
expect(sut.getState(selection.selectedScripts)).to.equal(testCase.expectRevert);
|
||||
expect(selection.selectedScripts).has.lengthOf(2);
|
||||
expect(selection.selectedScripts[0].id).equal(scripts[0].id);
|
||||
expect(selection.selectedScripts[1].id).equal(scripts[1].id);
|
||||
expect(selection.selectedScripts[0].revert).equal(testCase.expectRevert);
|
||||
expect(selection.selectedScripts[1].revert).equal(testCase.expectRevert);
|
||||
expect(categorySelection.isCategorySelected(category.id, expectedRevert)).to.equal(true);
|
||||
});
|
||||
}
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1,90 +1,118 @@
|
||||
import { describe, it, expect } from 'vitest';
|
||||
import { ScriptReverter } from '@/presentation/components/Scripts/View/Tree/NodeContent/Reverter/ScriptReverter';
|
||||
import { UserSelection } from '@/application/Context/State/Selection/UserSelection';
|
||||
import { SelectedScript } from '@/application/Context/State/Selection/SelectedScript';
|
||||
import { CategoryCollectionStub } from '@tests/unit/shared/Stubs/CategoryCollectionStub';
|
||||
import { CategoryStub } from '@tests/unit/shared/Stubs/CategoryStub';
|
||||
import { ScriptStub } from '@tests/unit/shared/Stubs/ScriptStub';
|
||||
import { SelectedScriptStub } from '@tests/unit/shared/Stubs/SelectedScriptStub';
|
||||
import { getScriptNodeId } from '@/presentation/components/Scripts/View/Tree/TreeViewAdapter/CategoryNodeMetadataConverter';
|
||||
import { UserSelectionStub } from '@tests/unit/shared/Stubs/UserSelectionStub';
|
||||
import { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
|
||||
import { ScriptSelectionStub } from '@tests/unit/shared/Stubs/ScriptSelectionStub';
|
||||
|
||||
describe('ScriptReverter', () => {
|
||||
describe('getState', () => {
|
||||
it('false when script is not selected', () => {
|
||||
// arrange
|
||||
const script = new ScriptStub('id');
|
||||
const nodeId = getScriptNodeId(script);
|
||||
const sut = new ScriptReverter(nodeId);
|
||||
// act
|
||||
const actual = sut.getState([]);
|
||||
// assert
|
||||
expect(actual).to.equal(false);
|
||||
});
|
||||
it('false when script is selected but not reverted', () => {
|
||||
// arrange
|
||||
const scripts = [new SelectedScriptStub('id'), new SelectedScriptStub('dummy')];
|
||||
const nodeId = getScriptNodeId(scripts[0].script);
|
||||
const sut = new ScriptReverter(nodeId);
|
||||
// act
|
||||
const actual = sut.getState(scripts);
|
||||
// assert
|
||||
expect(actual).to.equal(false);
|
||||
});
|
||||
it('true when script is selected and reverted', () => {
|
||||
// arrange
|
||||
const scripts = [new SelectedScriptStub('id', true), new SelectedScriptStub('dummy')];
|
||||
const nodeId = getScriptNodeId(scripts[0].script);
|
||||
const sut = new ScriptReverter(nodeId);
|
||||
// act
|
||||
const actual = sut.getState(scripts);
|
||||
// assert
|
||||
expect(actual).to.equal(true);
|
||||
// arrange
|
||||
const script = new ScriptStub('id');
|
||||
const nodeId = getScriptNodeId(script);
|
||||
const testScenarios: ReadonlyArray<{
|
||||
readonly description: string;
|
||||
readonly selectedScripts: readonly SelectedScript[];
|
||||
readonly expectedState: boolean;
|
||||
}> = [
|
||||
{
|
||||
description: 'returns `false` when script is not selected',
|
||||
selectedScripts: [],
|
||||
expectedState: false,
|
||||
},
|
||||
{
|
||||
description: 'returns `false` when script is selected but not reverted',
|
||||
selectedScripts: [
|
||||
new SelectedScriptStub(script).withRevert(false),
|
||||
new SelectedScriptStub(new ScriptStub('dummy')),
|
||||
],
|
||||
expectedState: false,
|
||||
},
|
||||
{
|
||||
description: 'returns `true` when script is selected and reverted',
|
||||
selectedScripts: [
|
||||
new SelectedScriptStub(script).withRevert(true),
|
||||
new SelectedScriptStub(new ScriptStub('dummy')),
|
||||
],
|
||||
expectedState: true,
|
||||
},
|
||||
];
|
||||
testScenarios.forEach((
|
||||
{ description, selectedScripts, expectedState },
|
||||
) => {
|
||||
it(description, () => {
|
||||
const sut = new ScriptReverter(nodeId);
|
||||
// act
|
||||
const actual = sut.getState(selectedScripts);
|
||||
// assert
|
||||
expect(actual).to.equal(expectedState);
|
||||
});
|
||||
});
|
||||
});
|
||||
describe('selectWithRevertState', () => {
|
||||
// arrange
|
||||
const script = new ScriptStub('id');
|
||||
const collection = new CategoryCollectionStub()
|
||||
.withAction(new CategoryStub(5).withScript(script));
|
||||
/* eslint-disable object-property-newline */
|
||||
const testCases = [
|
||||
const testScenarios: ReadonlyArray<{
|
||||
readonly description: string;
|
||||
readonly selection: readonly SelectedScript[];
|
||||
readonly expectedRevert: boolean;
|
||||
}> = [
|
||||
{
|
||||
name: 'selects with revert state when not selected',
|
||||
selection: [], revert: true, expectRevert: true,
|
||||
description: 'selects as reverted when initially unselected',
|
||||
selection: [],
|
||||
expectedRevert: true,
|
||||
},
|
||||
{
|
||||
name: 'selects with non-revert state when not selected',
|
||||
selection: [], revert: false, expectRevert: false,
|
||||
description: 'selects as non-reverted when initially unselected',
|
||||
selection: [],
|
||||
expectedRevert: false,
|
||||
},
|
||||
{
|
||||
name: 'switches when already selected with revert state',
|
||||
selection: [new SelectedScript(script, true)], revert: false, expectRevert: false,
|
||||
description: 'toggles to non-reverted for previously reverted scripts',
|
||||
selection: [
|
||||
new SelectedScriptStub(script).withRevert(true),
|
||||
],
|
||||
expectedRevert: false,
|
||||
},
|
||||
{
|
||||
name: 'switches when already selected with not revert state',
|
||||
selection: [new SelectedScript(script, false)], revert: true, expectRevert: true,
|
||||
description: 'toggles to reverted for previously non-reverted scripts',
|
||||
selection: [
|
||||
new SelectedScriptStub(script).withRevert(false),
|
||||
],
|
||||
expectedRevert: true,
|
||||
},
|
||||
{
|
||||
name: 'keeps revert state when already selected with revert state',
|
||||
selection: [new SelectedScript(script, true)], revert: true, expectRevert: true,
|
||||
description: 'maintains reverted state for already reverted scripts',
|
||||
selection: [
|
||||
new SelectedScriptStub(script).withRevert(true),
|
||||
],
|
||||
expectedRevert: true,
|
||||
},
|
||||
{
|
||||
name: 'keeps revert state deselected when already selected with non revert state',
|
||||
selection: [new SelectedScript(script, false)], revert: false, expectRevert: false,
|
||||
description: 'maintains non-reverted state for already non-reverted scripts',
|
||||
selection: [
|
||||
new SelectedScriptStub(script).withRevert(false),
|
||||
],
|
||||
expectedRevert: false,
|
||||
},
|
||||
];
|
||||
/* eslint-enable object-property-newline */
|
||||
const nodeId = getScriptNodeId(script);
|
||||
for (const testCase of testCases) {
|
||||
it(testCase.name, () => {
|
||||
const selection = new UserSelection(collection, testCase.selection);
|
||||
testScenarios.forEach((
|
||||
{ description, selection, expectedRevert },
|
||||
) => {
|
||||
it(description, () => {
|
||||
const scriptSelection = new ScriptSelectionStub()
|
||||
.withSelectedScripts(selection);
|
||||
const userSelection = new UserSelectionStub().withScripts(scriptSelection);
|
||||
const sut = new ScriptReverter(nodeId);
|
||||
const revertState = expectedRevert;
|
||||
// act
|
||||
sut.selectWithRevertState(testCase.revert, selection);
|
||||
sut.selectWithRevertState(revertState, userSelection);
|
||||
// assert
|
||||
expect(selection.isSelected(script.id)).to.equal(true);
|
||||
expect(selection.selectedScripts[0].revert).equal(testCase.expectRevert);
|
||||
expect(scriptSelection.isScriptSelected(script.id, expectedRevert)).to.equal(true);
|
||||
});
|
||||
}
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
@@ -7,6 +7,7 @@ import { TreeNodeCheckState } from '@/presentation/components/Scripts/View/Tree/
|
||||
import { UserSelectionStub } from '@tests/unit/shared/Stubs/UserSelectionStub';
|
||||
import { TreeNodeStateChangedEmittedEventStub } from '@tests/unit/shared/Stubs/TreeNodeStateChangedEmittedEventStub';
|
||||
import { UseUserSelectionStateStub } from '@tests/unit/shared/Stubs/UseUserSelectionStateStub';
|
||||
import { ScriptSelectionStub } from '@tests/unit/shared/Stubs/ScriptSelectionStub';
|
||||
|
||||
describe('useCollectionSelectionStateUpdater', () => {
|
||||
describe('updateNodeSelection', () => {
|
||||
@@ -56,9 +57,12 @@ describe('useCollectionSelectionStateUpdater', () => {
|
||||
it('adds to selection if not already selected', () => {
|
||||
// arrange
|
||||
const { returnObject, useSelectionStateStub } = runHook();
|
||||
const selectionStub = new UserSelectionStub([]);
|
||||
selectionStub.isSelected = () => false;
|
||||
useSelectionStateStub.withUserSelection(selectionStub);
|
||||
const isScriptInitiallySelected = false;
|
||||
const scriptSelectionStub = new ScriptSelectionStub()
|
||||
.withIsSelectedResult(isScriptInitiallySelected);
|
||||
useSelectionStateStub.withUserSelection(
|
||||
new UserSelectionStub().withScripts(scriptSelectionStub),
|
||||
);
|
||||
const node = createTreeNodeStub({
|
||||
isBranch: false,
|
||||
currentState: TreeNodeCheckState.Checked,
|
||||
@@ -73,14 +77,17 @@ describe('useCollectionSelectionStateUpdater', () => {
|
||||
returnObject.updateNodeSelection(mockEvent);
|
||||
// assert
|
||||
expect(useSelectionStateStub.isSelectionModified()).to.equal(true);
|
||||
expect(selectionStub.isScriptAdded(node.id)).to.equal(true);
|
||||
expect(scriptSelectionStub.isScriptSelected(node.id, false)).to.equal(true);
|
||||
});
|
||||
it('does nothing if already selected', () => {
|
||||
// arrange
|
||||
const { returnObject, useSelectionStateStub } = runHook();
|
||||
const selectionStub = new UserSelectionStub([]);
|
||||
selectionStub.isSelected = () => true;
|
||||
useSelectionStateStub.withUserSelection(selectionStub);
|
||||
const isScriptInitiallySelected = true;
|
||||
const scriptSelectionStub = new ScriptSelectionStub()
|
||||
.withIsSelectedResult(isScriptInitiallySelected);
|
||||
useSelectionStateStub.withUserSelection(
|
||||
new UserSelectionStub().withScripts(scriptSelectionStub),
|
||||
);
|
||||
const mockEvent = new TreeNodeStateChangedEmittedEventStub()
|
||||
.withNode(
|
||||
createTreeNodeStub({
|
||||
@@ -102,9 +109,12 @@ describe('useCollectionSelectionStateUpdater', () => {
|
||||
it('removes from selection if already selected', () => {
|
||||
// arrange
|
||||
const { returnObject, useSelectionStateStub } = runHook();
|
||||
const selectionStub = new UserSelectionStub([]);
|
||||
selectionStub.isSelected = () => true;
|
||||
useSelectionStateStub.withUserSelection(selectionStub);
|
||||
const isScriptInitiallySelected = true;
|
||||
const scriptSelectionStub = new ScriptSelectionStub()
|
||||
.withIsSelectedResult(isScriptInitiallySelected);
|
||||
useSelectionStateStub.withUserSelection(
|
||||
new UserSelectionStub().withScripts(scriptSelectionStub),
|
||||
);
|
||||
const node = createTreeNodeStub({
|
||||
isBranch: false,
|
||||
currentState: TreeNodeCheckState.Unchecked,
|
||||
@@ -119,14 +129,17 @@ describe('useCollectionSelectionStateUpdater', () => {
|
||||
returnObject.updateNodeSelection(mockEvent);
|
||||
// assert
|
||||
expect(useSelectionStateStub.isSelectionModified()).to.equal(true);
|
||||
expect(selectionStub.isScriptRemoved(node.id)).to.equal(true);
|
||||
expect(scriptSelectionStub.isScriptDeselected(node.id)).to.equal(true);
|
||||
});
|
||||
it('does nothing if not already selected', () => {
|
||||
// arrange
|
||||
const { returnObject, useSelectionStateStub } = runHook();
|
||||
const selectionStub = new UserSelectionStub([]);
|
||||
selectionStub.isSelected = () => false;
|
||||
useSelectionStateStub.withUserSelection(selectionStub);
|
||||
const isScriptInitiallySelected = false;
|
||||
const scriptSelectionStub = new ScriptSelectionStub()
|
||||
.withIsSelectedResult(isScriptInitiallySelected);
|
||||
useSelectionStateStub.withUserSelection(
|
||||
new UserSelectionStub().withScripts(scriptSelectionStub),
|
||||
);
|
||||
const mockEvent = new TreeNodeStateChangedEmittedEventStub()
|
||||
.withNode(
|
||||
createTreeNodeStub({
|
||||
|
||||
@@ -4,6 +4,7 @@ import { SelectedScriptStub } from '@tests/unit/shared/Stubs/SelectedScriptStub'
|
||||
import { getScriptNodeId } from '@/presentation/components/Scripts/View/Tree/TreeViewAdapter/CategoryNodeMetadataConverter';
|
||||
import { IScript } from '@/domain/IScript';
|
||||
import { UseUserSelectionStateStub } from '@tests/unit/shared/Stubs/UseUserSelectionStateStub';
|
||||
import { ScriptStub } from '@tests/unit/shared/Stubs/ScriptStub';
|
||||
|
||||
describe('useSelectedScriptNodeIds', () => {
|
||||
it('returns an empty array when no scripts are selected', () => {
|
||||
@@ -19,8 +20,8 @@ describe('useSelectedScriptNodeIds', () => {
|
||||
it('immediately', () => {
|
||||
// arrange
|
||||
const selectedScripts = [
|
||||
new SelectedScriptStub('id-1'),
|
||||
new SelectedScriptStub('id-2'),
|
||||
new SelectedScriptStub(new ScriptStub('id-1')),
|
||||
new SelectedScriptStub(new ScriptStub('id-2')),
|
||||
];
|
||||
const parsedNodeIds = new Map<IScript, string>([
|
||||
[selectedScripts[0].script, 'expected-id-1'],
|
||||
@@ -43,8 +44,8 @@ describe('useSelectedScriptNodeIds', () => {
|
||||
// arrange
|
||||
const initialScripts = [];
|
||||
const changedScripts = [
|
||||
new SelectedScriptStub('id-1'),
|
||||
new SelectedScriptStub('id-2'),
|
||||
new SelectedScriptStub(new ScriptStub('id-1')),
|
||||
new SelectedScriptStub(new ScriptStub('id-2')),
|
||||
];
|
||||
const parsedNodeIds = new Map<IScript, string>([
|
||||
[changedScripts[0].script, 'expected-id-1'],
|
||||
|
||||
@@ -1,19 +1,20 @@
|
||||
import { describe, it, expect } from 'vitest';
|
||||
import { nextTick, watch } from 'vue';
|
||||
import { SelectionModifier, useUserSelectionState } from '@/presentation/components/Shared/Hooks/UseUserSelectionState';
|
||||
import { UserSelection } from '@/application/Context/State/Selection/UserSelection';
|
||||
import { UseCollectionStateStub } from '@tests/unit/shared/Stubs/UseCollectionStateStub';
|
||||
import { UseAutoUnsubscribedEventsStub } from '@tests/unit/shared/Stubs/UseAutoUnsubscribedEventsStub';
|
||||
import { UserSelectionStub } from '@tests/unit/shared/Stubs/UserSelectionStub';
|
||||
import { ScriptStub } from '@tests/unit/shared/Stubs/ScriptStub';
|
||||
import { CategoryCollectionStateStub } from '@tests/unit/shared/Stubs/CategoryCollectionStateStub';
|
||||
import { IUserSelection } from '@/application/Context/State/Selection/IUserSelection';
|
||||
import { SelectedScriptStub } from '@tests/unit/shared/Stubs/SelectedScriptStub';
|
||||
import { ScriptSelectionStub } from '@tests/unit/shared/Stubs/ScriptSelectionStub';
|
||||
|
||||
describe('useUserSelectionState', () => {
|
||||
describe('currentSelection', () => {
|
||||
it('initializes with correct selection', () => {
|
||||
// arrange
|
||||
const expectedSelection = new UserSelectionStub([new ScriptStub('initialSelectedScript')]);
|
||||
const expectedSelection = new UserSelectionStub();
|
||||
const collectionStateStub = new UseCollectionStateStub()
|
||||
.withState(new CategoryCollectionStateStub().withSelection(expectedSelection));
|
||||
// act
|
||||
@@ -27,8 +28,8 @@ describe('useUserSelectionState', () => {
|
||||
describe('once collection state is changed', () => {
|
||||
it('updated', () => {
|
||||
// arrange
|
||||
const initialSelection = new UserSelectionStub([new ScriptStub('initialSelectedScript')]);
|
||||
const changedSelection = new UserSelectionStub([new ScriptStub('changedSelectedScript')]);
|
||||
const initialSelection = new UserSelectionStub();
|
||||
const changedSelection = new UserSelectionStub();
|
||||
const collectionStateStub = new UseCollectionStateStub()
|
||||
.withState(new CategoryCollectionStateStub().withSelection(initialSelection));
|
||||
const { returnObject } = runHook({
|
||||
@@ -45,8 +46,9 @@ describe('useUserSelectionState', () => {
|
||||
});
|
||||
it('not updated when old state changes', async () => {
|
||||
// arrange
|
||||
const oldSelectionState = new UserSelectionStub([new ScriptStub('inOldState')]);
|
||||
const newSelectionState = new UserSelectionStub([new ScriptStub('inNewState')]);
|
||||
const oldScriptSelection = new ScriptSelectionStub();
|
||||
const oldSelectionState = new UserSelectionStub().withScripts(oldScriptSelection);
|
||||
const newSelectionState = new UserSelectionStub();
|
||||
const collectionStateStub = new UseCollectionStateStub()
|
||||
.withState(new CategoryCollectionStateStub().withSelection(oldSelectionState));
|
||||
const { returnObject } = runHook({
|
||||
@@ -61,7 +63,9 @@ describe('useUserSelectionState', () => {
|
||||
totalUpdates++;
|
||||
});
|
||||
// act
|
||||
oldSelectionState.triggerSelectionChangedEvent([new SelectedScriptStub('newInOldState')]);
|
||||
oldScriptSelection.triggerSelectionChangedEvent([
|
||||
new SelectedScriptStub(new ScriptStub('newInOldState')),
|
||||
]);
|
||||
await nextTick();
|
||||
// assert
|
||||
expect(totalUpdates).to.equal(0);
|
||||
@@ -69,8 +73,8 @@ describe('useUserSelectionState', () => {
|
||||
describe('triggers change', () => {
|
||||
it('with new selection reference', async () => {
|
||||
// arrange
|
||||
const oldSelection = new UserSelectionStub([]);
|
||||
const newSelection = new UserSelectionStub([]);
|
||||
const oldSelection = new UserSelectionStub();
|
||||
const newSelection = new UserSelectionStub();
|
||||
const initialCollectionState = new CategoryCollectionStateStub()
|
||||
.withSelection(oldSelection);
|
||||
const changedCollectionState = new CategoryCollectionStateStub()
|
||||
@@ -93,7 +97,7 @@ describe('useUserSelectionState', () => {
|
||||
});
|
||||
it('with the same selection reference', async () => {
|
||||
// arrange
|
||||
const userSelection = new UserSelectionStub([new ScriptStub('sameScriptInSameReference')]);
|
||||
const userSelection = new UserSelectionStub();
|
||||
const initialCollectionState = new CategoryCollectionStateStub()
|
||||
.withSelection(userSelection);
|
||||
const changedCollectionState = new CategoryCollectionStateStub()
|
||||
@@ -119,26 +123,38 @@ describe('useUserSelectionState', () => {
|
||||
describe('once selection state is changed', () => {
|
||||
it('updated with same collection state', async () => {
|
||||
// arrange
|
||||
const initialScripts = [new ScriptStub('initialSelectedScript')];
|
||||
const changedScripts = [new SelectedScriptStub('changedSelectedScript')];
|
||||
const selectionState = new UserSelectionStub(initialScripts);
|
||||
const collectionState = new CategoryCollectionStateStub().withSelection(selectionState);
|
||||
const initialScripts = [
|
||||
new SelectedScriptStub(new ScriptStub('initialSelectedScript')),
|
||||
];
|
||||
const changedScripts = [
|
||||
new SelectedScriptStub(new ScriptStub('changedSelectedScript')),
|
||||
];
|
||||
const scriptSelectionStub = new ScriptSelectionStub()
|
||||
.withSelectedScripts(initialScripts);
|
||||
const expectedSelectionState = new UserSelectionStub().withScripts(scriptSelectionStub);
|
||||
const collectionState = new CategoryCollectionStateStub()
|
||||
.withSelection(expectedSelectionState);
|
||||
const collectionStateStub = new UseCollectionStateStub().withState(collectionState);
|
||||
const { returnObject } = runHook({
|
||||
useCollectionState: collectionStateStub,
|
||||
});
|
||||
// act
|
||||
selectionState.triggerSelectionChangedEvent(changedScripts);
|
||||
scriptSelectionStub.triggerSelectionChangedEvent(changedScripts);
|
||||
await nextTick();
|
||||
// assert
|
||||
const actualSelection = returnObject.currentSelection.value;
|
||||
expect(actualSelection).to.equal(selectionState);
|
||||
expect(actualSelection).to.equal(expectedSelectionState);
|
||||
});
|
||||
it('updated once collection state is changed', async () => {
|
||||
// arrange
|
||||
const changedScripts = [new SelectedScriptStub('changedSelectedScript')];
|
||||
const newSelectionState = new UserSelectionStub([new ScriptStub('initialSelectedScriptInNewCollection')]);
|
||||
const initialCollectionState = new CategoryCollectionStateStub().withSelectedScripts([new SelectedScriptStub('initialSelectedScriptInInitialCollection')]);
|
||||
const changedScripts = [
|
||||
new SelectedScriptStub(new ScriptStub('changedSelectedScript')),
|
||||
];
|
||||
const scriptSelectionStub = new ScriptSelectionStub();
|
||||
const newSelectionState = new UserSelectionStub().withScripts(scriptSelectionStub);
|
||||
const initialCollectionState = new CategoryCollectionStateStub().withSelectedScripts([
|
||||
new SelectedScriptStub(new ScriptStub('initialSelectedScriptInInitialCollection')),
|
||||
]);
|
||||
const collectionStateStub = new UseCollectionStateStub().withState(initialCollectionState);
|
||||
const { returnObject } = runHook({ useCollectionState: collectionStateStub });
|
||||
// act
|
||||
@@ -146,7 +162,7 @@ describe('useUserSelectionState', () => {
|
||||
newState: new CategoryCollectionStateStub().withSelection(newSelectionState),
|
||||
immediateOnly: false,
|
||||
});
|
||||
newSelectionState.triggerSelectionChangedEvent(changedScripts);
|
||||
scriptSelectionStub.triggerSelectionChangedEvent(changedScripts);
|
||||
// assert
|
||||
const actualSelection = returnObject.currentSelection.value;
|
||||
expect(actualSelection).to.equal(newSelectionState);
|
||||
@@ -156,17 +172,19 @@ describe('useUserSelectionState', () => {
|
||||
// arrange
|
||||
const oldSelectedScriptsArrayReference = [];
|
||||
const newSelectedScriptsArrayReference = [];
|
||||
const userSelection = new UserSelectionStub(oldSelectedScriptsArrayReference)
|
||||
const scriptSelectionStub = new ScriptSelectionStub()
|
||||
.withSelectedScripts(oldSelectedScriptsArrayReference);
|
||||
const collectionStateStub = new UseCollectionStateStub()
|
||||
.withState(new CategoryCollectionStateStub().withSelection(userSelection));
|
||||
.withState(new CategoryCollectionStateStub().withSelection(
|
||||
new UserSelectionStub().withScripts(scriptSelectionStub),
|
||||
));
|
||||
const { returnObject } = runHook({ useCollectionState: collectionStateStub });
|
||||
let isChangeTriggered = false;
|
||||
watch(returnObject.currentSelection, () => {
|
||||
isChangeTriggered = true;
|
||||
});
|
||||
// act
|
||||
userSelection.triggerSelectionChangedEvent(newSelectedScriptsArrayReference);
|
||||
scriptSelectionStub.triggerSelectionChangedEvent(newSelectedScriptsArrayReference);
|
||||
await nextTick();
|
||||
// assert
|
||||
expect(isChangeTriggered).to.equal(true);
|
||||
@@ -174,17 +192,19 @@ describe('useUserSelectionState', () => {
|
||||
it('with same selected scripts array reference', async () => {
|
||||
// arrange
|
||||
const sharedSelectedScriptsReference = [];
|
||||
const userSelection = new UserSelectionStub([])
|
||||
const scriptSelectionStub = new ScriptSelectionStub()
|
||||
.withSelectedScripts(sharedSelectedScriptsReference);
|
||||
const collectionStateStub = new UseCollectionStateStub()
|
||||
.withState(new CategoryCollectionStateStub().withSelection(userSelection));
|
||||
.withState(new CategoryCollectionStateStub().withSelection(
|
||||
new UserSelectionStub().withScripts(scriptSelectionStub),
|
||||
));
|
||||
const { returnObject } = runHook({ useCollectionState: collectionStateStub });
|
||||
let isChangeTriggered = false;
|
||||
watch(returnObject.currentSelection, () => {
|
||||
isChangeTriggered = true;
|
||||
});
|
||||
// act
|
||||
userSelection.triggerSelectionChangedEvent(sharedSelectedScriptsReference);
|
||||
scriptSelectionStub.triggerSelectionChangedEvent(sharedSelectedScriptsReference);
|
||||
await nextTick();
|
||||
// assert
|
||||
expect(isChangeTriggered).to.equal(true);
|
||||
@@ -197,7 +217,7 @@ describe('useUserSelectionState', () => {
|
||||
// arrange
|
||||
const { returnObject, collectionStateStub } = runHook();
|
||||
const expectedSelection = collectionStateStub.state.selection;
|
||||
let mutatedSelection: IUserSelection | undefined;
|
||||
let mutatedSelection: UserSelection | undefined;
|
||||
const mutator: SelectionModifier = (selection) => {
|
||||
mutatedSelection = selection;
|
||||
};
|
||||
@@ -210,10 +230,10 @@ describe('useUserSelectionState', () => {
|
||||
it('new state is modified once collection state is changed', async () => {
|
||||
// arrange
|
||||
const { returnObject, collectionStateStub } = runHook();
|
||||
const expectedSelection = new UserSelectionStub([]);
|
||||
const expectedSelection = new UserSelectionStub();
|
||||
const newCollectionState = new CategoryCollectionStateStub()
|
||||
.withSelection(expectedSelection);
|
||||
let mutatedSelection: IUserSelection | undefined;
|
||||
let mutatedSelection: UserSelection | undefined;
|
||||
const mutator: SelectionModifier = (selection) => {
|
||||
mutatedSelection = selection;
|
||||
};
|
||||
@@ -231,12 +251,12 @@ describe('useUserSelectionState', () => {
|
||||
it('old state is not modified once collection state is changed', async () => {
|
||||
// arrange
|
||||
const oldState = new CategoryCollectionStateStub().withSelectedScripts([
|
||||
new SelectedScriptStub('scriptFromOldState'),
|
||||
new SelectedScriptStub(new ScriptStub('scriptFromOldState')),
|
||||
]);
|
||||
const collectionStateStub = new UseCollectionStateStub()
|
||||
.withState(oldState);
|
||||
const { returnObject } = runHook({ useCollectionState: collectionStateStub });
|
||||
const expectedSelection = new UserSelectionStub([]);
|
||||
const expectedSelection = new UserSelectionStub();
|
||||
const newCollectionState = new CategoryCollectionStateStub()
|
||||
.withSelection(expectedSelection);
|
||||
let totalMutations = 0;
|
||||
|
||||
@@ -1,148 +0,0 @@
|
||||
import { describe, it, expect } from 'vitest';
|
||||
import { throttle, ITimer, Timeout } from '@/presentation/components/Shared/Throttle';
|
||||
import { EventSource } from '@/infrastructure/Events/EventSource';
|
||||
import { IEventSubscription } from '@/infrastructure/Events/IEventSource';
|
||||
import { createMockTimeout } from '@tests/unit/shared/Stubs/TimeoutStub';
|
||||
|
||||
describe('throttle', () => {
|
||||
describe('validates parameters', () => {
|
||||
describe('throws if waitInMs is invalid', () => {
|
||||
// arrange
|
||||
const testCases = [
|
||||
{
|
||||
name: 'given zero',
|
||||
value: 0,
|
||||
expectedError: 'missing delay',
|
||||
},
|
||||
{
|
||||
name: 'given negative',
|
||||
value: -2,
|
||||
expectedError: 'negative delay',
|
||||
},
|
||||
];
|
||||
const noopCallback = () => { /* do nothing */ };
|
||||
for (const testCase of testCases) {
|
||||
it(`"${testCase.name}" throws "${testCase.expectedError}"`, () => {
|
||||
// act
|
||||
const waitInMs = testCase.value;
|
||||
const act = () => throttle(noopCallback, waitInMs);
|
||||
// assert
|
||||
expect(act).to.throw(testCase.expectedError);
|
||||
});
|
||||
}
|
||||
});
|
||||
});
|
||||
it('should call the callback immediately', () => {
|
||||
// arrange
|
||||
const timer = new TimerMock();
|
||||
let totalRuns = 0;
|
||||
const callback = () => totalRuns++;
|
||||
const throttleFunc = throttle(callback, 500, timer);
|
||||
// act
|
||||
throttleFunc();
|
||||
// assert
|
||||
expect(totalRuns).to.equal(1);
|
||||
});
|
||||
it('should call the callback again after the timeout', () => {
|
||||
// arrange
|
||||
const timer = new TimerMock();
|
||||
let totalRuns = 0;
|
||||
const callback = () => totalRuns++;
|
||||
const waitInMs = 500;
|
||||
const throttleFunc = throttle(callback, waitInMs, timer);
|
||||
// act
|
||||
throttleFunc();
|
||||
totalRuns--; // So we don't count the initial run
|
||||
throttleFunc();
|
||||
timer.tickNext(waitInMs);
|
||||
// assert
|
||||
expect(totalRuns).to.equal(1);
|
||||
});
|
||||
it('should call the callback at most once at given time', () => {
|
||||
// arrange
|
||||
const timer = new TimerMock();
|
||||
let totalRuns = 0;
|
||||
const callback = () => totalRuns++;
|
||||
const waitInMs = 500;
|
||||
const totalCalls = 10;
|
||||
const throttleFunc = throttle(callback, waitInMs, timer);
|
||||
// act
|
||||
for (let currentCall = 0; currentCall < totalCalls; currentCall++) {
|
||||
const currentTime = (waitInMs / totalCalls) * currentCall;
|
||||
timer.setCurrentTime(currentTime);
|
||||
throttleFunc();
|
||||
}
|
||||
// assert
|
||||
expect(totalRuns).to.equal(2); // one initial and one at the end
|
||||
});
|
||||
it('should call the callback as long as delay is waited', () => {
|
||||
// arrange
|
||||
const timer = new TimerMock();
|
||||
let totalRuns = 0;
|
||||
const callback = () => totalRuns++;
|
||||
const waitInMs = 500;
|
||||
const expectedTotalRuns = 10;
|
||||
const throttleFunc = throttle(callback, waitInMs, timer);
|
||||
// act
|
||||
for (let i = 0; i < expectedTotalRuns; i++) {
|
||||
throttleFunc();
|
||||
timer.tickNext(waitInMs);
|
||||
}
|
||||
// assert
|
||||
expect(totalRuns).to.equal(expectedTotalRuns);
|
||||
});
|
||||
it('should call arguments as expected', () => {
|
||||
// arrange
|
||||
const timer = new TimerMock();
|
||||
const expected = [1, 2, 3];
|
||||
const actual = new Array<number>();
|
||||
const callback = (arg: number) => { actual.push(arg); };
|
||||
const waitInMs = 500;
|
||||
const throttleFunc = throttle(callback, waitInMs, timer);
|
||||
// act
|
||||
for (const arg of expected) {
|
||||
throttleFunc(arg);
|
||||
timer.tickNext(waitInMs);
|
||||
}
|
||||
// assert
|
||||
expect(expected).to.deep.equal(actual);
|
||||
});
|
||||
});
|
||||
|
||||
class TimerMock implements ITimer {
|
||||
private timeChanged = new EventSource<number>();
|
||||
|
||||
private subscriptions = new Array<IEventSubscription>();
|
||||
|
||||
private currentTime = 0;
|
||||
|
||||
public setTimeout(callback: () => void, ms: number): Timeout {
|
||||
const runTime = this.currentTime + ms;
|
||||
const subscription = this.timeChanged.on((time) => {
|
||||
if (time >= runTime) {
|
||||
callback();
|
||||
subscription.unsubscribe();
|
||||
}
|
||||
});
|
||||
this.subscriptions.push(subscription);
|
||||
const id = this.subscriptions.length - 1;
|
||||
return createMockTimeout(id);
|
||||
}
|
||||
|
||||
public clearTimeout(timeoutId: Timeout): void {
|
||||
this.subscriptions[+timeoutId].unsubscribe();
|
||||
}
|
||||
|
||||
public dateNow(): number {
|
||||
return this.currentTime;
|
||||
}
|
||||
|
||||
public tickNext(ms: number): void {
|
||||
this.setCurrentTime(this.currentTime + ms);
|
||||
}
|
||||
|
||||
public setCurrentTime(ms: number): void {
|
||||
this.currentTime = ms;
|
||||
this.timeChanged.notify(this.currentTime);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user