eb096d07e2
This commit simplifies event handling, providing a unified and robust
way to handle event lifecycling. This way, it fixes events not being
unsubscribed when state is changed.
Introduce a new function in `EventSubscriptionCollection` to remove
existing events and adding new events. This provides an easier to use
API, which leads to code that's easier to understand. It also prevents
potential bugs that may occur due to forgetting to call both functions.
It fixes `TheScriptsMenu` not unregistering events on state change.
Other improvements include:
- Include a getter to get total amount of registered subcriptions.
This helps in unit testing.
- Have nullish checks to prevent potential errors further down the
execution.
- Use array instead of rest parameters to increase readability and
simplify tests.
Ensure `SliderHandler` stops resizes on unmount, unsubscribing from all
events and resetting state to default.
Update `injectionKeys` to do imports as types to avoid circular
dependencies. Simplify importing `injectionKeys` to enable and strict
typings for iterating injection keys.
Add tests covering new behavior.
100 lines
3.3 KiB
TypeScript
100 lines
3.3 KiB
TypeScript
import { describe } from 'vitest';
|
|
import { VueDependencyInjectionApiStub } from '@tests/unit/shared/Stubs/VueDependencyInjectionApiStub';
|
|
import { InjectionKeys } from '@/presentation/injectionSymbols';
|
|
import { provideDependencies, VueDependencyInjectionApi } from '@/presentation/bootstrapping/DependencyProvider';
|
|
import { ApplicationContextStub } from '@tests/unit/shared/Stubs/ApplicationContextStub';
|
|
import { itIsSingleton } from '@tests/unit/shared/TestCases/SingletonTests';
|
|
|
|
describe('DependencyProvider', () => {
|
|
describe('provideDependencies', () => {
|
|
const testCases: {
|
|
readonly [K in keyof typeof InjectionKeys]: (injectionKey: symbol) => void;
|
|
} = {
|
|
useCollectionState: createTransientTests(),
|
|
useApplication: createSingletonTests(),
|
|
useRuntimeEnvironment: createSingletonTests(),
|
|
useAutoUnsubscribedEvents: createTransientTests(),
|
|
};
|
|
Object.entries(testCases).forEach(([key, runTests]) => {
|
|
describe(`Key: "${key}"`, () => {
|
|
runTests(InjectionKeys[key]);
|
|
});
|
|
});
|
|
});
|
|
});
|
|
|
|
function createTransientTests() {
|
|
return (injectionKey: symbol) => {
|
|
it('should register a function when transient dependency is resolved', () => {
|
|
// arrange
|
|
const api = new VueDependencyInjectionApiStub();
|
|
// act
|
|
new ProvideDependenciesBuilder()
|
|
.withApi(api)
|
|
.provideDependencies();
|
|
// expect
|
|
const registeredObject = api.inject(injectionKey);
|
|
expect(registeredObject).to.be.instanceOf(Function);
|
|
});
|
|
it('should return different instances for transient dependency', () => {
|
|
// arrange
|
|
const api = new VueDependencyInjectionApiStub();
|
|
// act
|
|
new ProvideDependenciesBuilder()
|
|
.withApi(api)
|
|
.provideDependencies();
|
|
// expect
|
|
const registeredObject = api.inject(injectionKey);
|
|
const factory = registeredObject as () => unknown;
|
|
const firstResult = factory();
|
|
const secondResult = factory();
|
|
expect(firstResult).to.not.equal(secondResult);
|
|
});
|
|
};
|
|
}
|
|
|
|
function createSingletonTests() {
|
|
return (injectionKey: symbol) => {
|
|
it('should register an object when singleton dependency is resolved', () => {
|
|
// arrange
|
|
const api = new VueDependencyInjectionApiStub();
|
|
// act
|
|
new ProvideDependenciesBuilder()
|
|
.withApi(api)
|
|
.provideDependencies();
|
|
// expect
|
|
const registeredObject = api.inject(injectionKey);
|
|
expect(registeredObject).to.be.instanceOf(Object);
|
|
});
|
|
it('should return the same instance for singleton dependency', () => {
|
|
itIsSingleton({
|
|
getter: () => {
|
|
// arrange
|
|
const api = new VueDependencyInjectionApiStub();
|
|
// act
|
|
new ProvideDependenciesBuilder()
|
|
.withApi(api)
|
|
.provideDependencies();
|
|
// expect
|
|
const registeredObject = api.inject(injectionKey);
|
|
return registeredObject;
|
|
},
|
|
});
|
|
});
|
|
};
|
|
}
|
|
class ProvideDependenciesBuilder {
|
|
private context = new ApplicationContextStub();
|
|
|
|
private api: VueDependencyInjectionApi = new VueDependencyInjectionApiStub();
|
|
|
|
public withApi(api: VueDependencyInjectionApi): this {
|
|
this.api = api;
|
|
return this;
|
|
}
|
|
|
|
public provideDependencies() {
|
|
return provideDependencies(this.context, this.api);
|
|
}
|
|
}
|