44r0n7/privacy.sexy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix memory leaks via auto-unsubscribing and DI

Browse Source 
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.
This commit is contained in:
undergroundwires
2023-09-01 18:14:25 +02:00
parent 19e42c9c52
commit eb096d07e2
37 changed files with 856 additions and 243 deletions
Download Patch File Download Diff File Expand all files Collapse all files

197
tests/unit/presentation/components/Shared/Hooks/UseCollectionState.spec.ts
View File

@@ -6,30 +6,89 @@ import { IReadOnlyCategoryCollectionState } from '@/application/Context/State/IC
import { ApplicationContextChangedEventStub } from '@tests/unit/shared/Stubs/ApplicationContextChangedEventStub';
import { OperatingSystem } from '@/domain/OperatingSystem';
import { itEachAbsentObjectValue } from '@tests/unit/shared/TestCases/AbsentTests';
import { IApplicationContext } from '@/application/Context/IApplicationContext';
import { IEventSubscriptionCollection } from '@/infrastructure/Events/IEventSubscriptionCollection';
import { EventSubscriptionCollectionStub } from '@tests/unit/shared/Stubs/EventSubscriptionCollectionStub';
describe('UseCollectionState', () => {
describe('context is absent', () => {
itEachAbsentObjectValue((absentValue) => {
describe('parameter validation', () => {
describe('absent context', () => {
itEachAbsentObjectValue((absentValue) => {
// arrange
const expectedError = 'missing context';
const contextValue = absentValue;
// act
const act = () => new UseCollectionStateBuilder()
.withContext(contextValue)
.build();
// assert
expect(act).to.throw(expectedError);
});
});
describe('absent events', () => {
itEachAbsentObjectValue((absentValue) => {
// arrange
const expectedError = 'missing events';
const eventsValue = absentValue;
// act
const act = () => new UseCollectionStateBuilder()
.withEvents(eventsValue)
.build();
// assert
expect(act).to.throw(expectedError);
});
});
});
describe('listens to contextChanged event', () => {
it('registers new event listener', () => {
// arrange
const expectedError = 'missing context';
const contextValue = absentValue;
const events = new EventSubscriptionCollectionStub();
const expectedSubscriptionsCount = 1;
// act
const act = () => useCollectionState(contextValue);
new UseCollectionStateBuilder()
.withEvents(events)
.build();
// assert
expect(act).to.throw(expectedError);
const actualSubscriptionsCount = events.subscriptionCount;
expect(actualSubscriptionsCount).to.equal(expectedSubscriptionsCount);
});
it('does not modify the state after event listener is unsubscribed', () => {
// arrange
const events = new EventSubscriptionCollectionStub();
const oldState = new CategoryCollectionStateStub();
const newState = new CategoryCollectionStateStub();
const context = new ApplicationContextStub()
.withState(oldState);
// act
const { currentState } = new UseCollectionStateBuilder()
.withContext(context)
.withEvents(events)
.build();
const stateModifierEvent = events.mostRecentSubscription;
stateModifierEvent.unsubscribe();
context.dispatchContextChange(
new ApplicationContextChangedEventStub().withNewState(newState),
);
// assert
expect(currentState.value).to.equal(oldState);
});
});
describe('currentContext', () => {
it('returns current context', () => {
// arrange
const expected = new ApplicationContextStub();
const expectedContext = new ApplicationContextStub();
// act
const { currentContext } = useCollectionState(expected);
const { currentContext } = new UseCollectionStateBuilder()
.withContext(expectedContext)
.build();
// assert
expect(currentContext).to.equal(expected);
expect(currentContext).to.equal(expectedContext);
});
});
@@ -41,24 +100,28 @@ describe('UseCollectionState', () => {
.withState(expected);
// act
const { currentState } = useCollectionState(context);
const { currentState } = new UseCollectionStateBuilder()
.withContext(context)
.build();
// assert
expect(currentState.value).to.equal(expected);
});
it('returns changed collection state', () => {
// arrange
const newState = new CategoryCollectionStateStub();
const expectedNewState = new CategoryCollectionStateStub();
const context = new ApplicationContextStub();
const { currentState } = useCollectionState(context);
const { currentState } = new UseCollectionStateBuilder()
.withContext(context)
.build();
// act
context.dispatchContextChange(
new ApplicationContextChangedEventStub().withNewState(newState),
new ApplicationContextChangedEventStub().withNewState(expectedNewState),
);
// assert
expect(currentState.value).to.equal(newState);
expect(currentState.value).to.equal(expectedNewState);
});
});
@@ -67,8 +130,7 @@ describe('UseCollectionState', () => {
itEachAbsentObjectValue((absentValue) => {
// arrange
const expectedError = 'missing state handler';
const context = new ApplicationContextStub();
const { onStateChange } = useCollectionState(context);
const { onStateChange } = new UseCollectionStateBuilder().build();
// act
const act = () => onStateChange(absentValue);
// assert
@@ -79,7 +141,9 @@ describe('UseCollectionState', () => {
// arrange
const expected = true;
const context = new ApplicationContextStub();
const { onStateChange } = useCollectionState(context);
const { onStateChange } = new UseCollectionStateBuilder()
.withContext(context)
.build();
let wasCalled = false;
// act
@@ -94,8 +158,7 @@ describe('UseCollectionState', () => {
it('call handler immediately when immediate is true', () => {
// arrange
const expected = true;
const context = new ApplicationContextStub();
const { onStateChange } = useCollectionState(context);
const { onStateChange } = new UseCollectionStateBuilder().build();
let wasCalled = false;
// act
@@ -109,8 +172,7 @@ describe('UseCollectionState', () => {
it('does not call handler immediately when immediate is false', () => {
// arrange
const expected = false;
const context = new ApplicationContextStub();
const { onStateChange } = useCollectionState(context);
const { onStateChange } = new UseCollectionStateBuilder().build();
let wasCalled = false;
// act
@@ -125,7 +187,9 @@ describe('UseCollectionState', () => {
// arrange
const expected = 5;
const context = new ApplicationContextStub();
const { onStateChange } = useCollectionState(context);
const { onStateChange } = new UseCollectionStateBuilder()
.withContext(context)
.build();
let totalCalled = 0;
// act
@@ -144,7 +208,9 @@ describe('UseCollectionState', () => {
const expected = new CategoryCollectionStateStub();
let actual: IReadOnlyCategoryCollectionState;
const context = new ApplicationContextStub();
const { onStateChange } = useCollectionState(context);
const { onStateChange } = new UseCollectionStateBuilder()
.withContext(context)
.build();
// act
onStateChange((newState) => {
@@ -159,21 +225,57 @@ describe('UseCollectionState', () => {
});
it('call handler with old state after state changes', () => {
// arrange
const expected = new CategoryCollectionStateStub();
let actual: IReadOnlyCategoryCollectionState;
const expectedState = new CategoryCollectionStateStub();
let actualState: IReadOnlyCategoryCollectionState;
const context = new ApplicationContextStub();
const { onStateChange } = useCollectionState(context);
const { onStateChange } = new UseCollectionStateBuilder()
.withContext(context)
.build();
// act
onStateChange((_, oldState) => {
actual = oldState;
actualState = oldState;
});
context.dispatchContextChange(
new ApplicationContextChangedEventStub().withOldState(expected),
new ApplicationContextChangedEventStub().withOldState(expectedState),
);
// assert
expect(actual).to.equal(expected);
expect(actualState).to.equal(expectedState);
});
describe('listens to contextChanged event', () => {
it('registers new event listener', () => {
// arrange
const events = new EventSubscriptionCollectionStub();
const { onStateChange } = new UseCollectionStateBuilder()
.withEvents(events)
.build();
const expectedSubscriptionsCount = 1;
// act
events.unsubscribeAll(); // clean count for event subscriptions before
onStateChange(() => { /* NO OP */ });
// assert
const actualSubscriptionsCount = events.subscriptionCount;
expect(actualSubscriptionsCount).to.equal(expectedSubscriptionsCount);
});
it('onStateChange is not called once event is unsubscribed', () => {
// arrange
let isCallbackCalled = false;
const callback = () => { isCallbackCalled = true; };
const context = new ApplicationContextStub();
const events = new EventSubscriptionCollectionStub();
const { onStateChange } = new UseCollectionStateBuilder()
.withEvents(events)
.withContext(context)
.build();
// act
onStateChange(callback);
const stateChangeEvent = events.mostRecentSubscription;
stateChangeEvent.unsubscribe();
context.dispatchContextChange();
// assert
expect(isCallbackCalled).to.equal(false);
});
});
});
@@ -183,9 +285,13 @@ describe('UseCollectionState', () => {
// arrange
const expectedError = 'missing state mutator';
const context = new ApplicationContextStub();
const { modifyCurrentState } = useCollectionState(context);
const { modifyCurrentState } = new UseCollectionStateBuilder()
.withContext(context)
.build();
// act
const act = () => modifyCurrentState(absentValue);
// assert
expect(act).to.throw(expectedError);
});
@@ -198,7 +304,9 @@ describe('UseCollectionState', () => {
.withOs(oldOs);
const context = new ApplicationContextStub()
.withState(state);
const { modifyCurrentState } = useCollectionState(context);
const { modifyCurrentState } = new UseCollectionStateBuilder()
.withContext(context)
.build();
// act
modifyCurrentState((mutableState) => {
@@ -217,8 +325,7 @@ describe('UseCollectionState', () => {
itEachAbsentObjectValue((absentValue) => {
// arrange
const expectedError = 'missing context mutator';
const context = new ApplicationContextStub();
const { modifyCurrentContext } = useCollectionState(context);
const { modifyCurrentContext } = new UseCollectionStateBuilder().build();
// act
const act = () => modifyCurrentContext(absentValue);
// assert
@@ -233,7 +340,9 @@ describe('UseCollectionState', () => {
.withOs(OperatingSystem.macOS);
const context = new ApplicationContextStub()
.withState(oldState);
const { modifyCurrentContext } = useCollectionState(context);
const { modifyCurrentContext } = new UseCollectionStateBuilder()
.withContext(context)
.build();
// act
modifyCurrentContext((mutableContext) => {
@@ -247,3 +356,23 @@ describe('UseCollectionState', () => {
});
});
});
class UseCollectionStateBuilder {
private context: IApplicationContext = new ApplicationContextStub();
private events: IEventSubscriptionCollection = new EventSubscriptionCollectionStub();
public withContext(context: IApplicationContext): this {
this.context = context;
return this;
}
public withEvents(events: IEventSubscriptionCollection): this {
this.events = events;
return this;
}
public build(): ReturnType<typeof useCollectionState> {
return useCollectionState(this.context, this.events);
}
}