Files
privacy.sexy/tests/unit/presentation/components/Shared/Resize/UseResizeObserver.spec.ts
undergroundwires ae0165f1fe Ensure tests do not log warning or errors
This commit increases strictnes of tests by failing on tests (even
though they pass) if `console.warn` or `console.error` is used. This is
used to fix warning outputs from Vue, cleaning up test output and
preventing potential issues with tests.

This commit fixes all of the failing tests, including refactoring in
code to make them more testable through injecting Vue lifecycle
hook function stubs. This removes `shallowMount`ing done on places,
improving the speed of executing unit tests. It also reduces complexity
and increases maintainability by removing `@vue/test-utils` dependency
for these tests.

Changes:

- Register global hook for all tests to fail if console.error or
  console.warn is being used.
- Fix all issues with failing tests.
- Create test helper function for running code in a wrapper component to
  run code in reliable/unified way to surpress Vue warnings about code
  not running inside `setup`.
2024-07-23 16:08:04 +02:00

120 lines
3.7 KiB
TypeScript

import { shallowRef } from 'vue';
import { useResizeObserver, type ObservedElementReference } from '@/presentation/components/Shared/Hooks/Resize/UseResizeObserver';
import { flushPromiseResolutionQueue } from '@tests/unit/shared/PromiseInspection';
import type { AnimationFrameLimiter } from '@/presentation/components/Shared/Hooks/Resize/UseAnimationFrameLimiter';
import { ThrottleStub } from '@tests/unit/shared/Stubs/ThrottleStub';
import type { LifecycleHook } from '@/presentation/components/Shared/Hooks/Common/LifecycleHook';
import { LifecycleHookStub } from '@tests/unit/shared/Stubs/LifecycleHookStub';
describe('UseResizeObserver', () => {
it('registers observer once mounted', async () => {
// arrange
let registeredElement: Element | null = null;
const expectedElement = document.createElement('div');
const resizeObserverStub = createResizeObserverStub();
resizeObserverStub.observe = (element) => {
registeredElement = element;
};
// act
new TestContext()
.withObservedElementRef(shallowRef(expectedElement))
.withResizeObserver(resizeObserverStub)
.useResizeObserver();
await flushPromiseResolutionQueue();
// assert
expect(registeredElement).to.equal(expectedElement);
});
it('disposes observer once unmounted', async () => {
// arrange
let isObserverDisconnected = false;
const resizeObserverStub = createResizeObserverStub();
resizeObserverStub.disconnect = () => {
isObserverDisconnected = true;
};
const teardownHook = new LifecycleHookStub();
// act
new TestContext()
.withResizeObserver(resizeObserverStub)
.withOnTeardown(teardownHook.getHook())
.useResizeObserver();
await flushPromiseResolutionQueue();
teardownHook.executeAllCallbacks();
// assert
expect(teardownHook.totalRegisteredCallbacks).to.be.greaterThan(0);
expect(isObserverDisconnected).to.equal(true);
});
});
function createResizeObserverStub(): ResizeObserver {
return {
disconnect: () => {},
observe: () => {},
unobserve: () => {},
};
}
function createFrameLimiterStub(): AnimationFrameLimiter {
return {
cancelNextFrame: () => {},
resetNextFrame: (callback) => { callback(); },
};
}
class TestContext {
private resizeObserver: ResizeObserver = createResizeObserverStub();
private observedElementRef: ObservedElementReference = shallowRef(document.createElement('div'));
private onSetup: LifecycleHook = new LifecycleHookStub()
.withInvokeCallbackImmediately(true)
.getHook();
private onTeardown: LifecycleHook = new LifecycleHookStub()
.getHook();
public withResizeObserver(resizeObserver: ResizeObserver): this {
this.resizeObserver = resizeObserver;
return this;
}
public withObservedElementRef(observedElementRef: ObservedElementReference): this {
this.observedElementRef = observedElementRef;
return this;
}
public withOnSetup(onSetup: LifecycleHook): this {
this.onSetup = onSetup;
return this;
}
public withOnTeardown(onTeardown: LifecycleHook): this {
this.onTeardown = onTeardown;
return this;
}
public useResizeObserver() {
return useResizeObserver(
...this.buildParameters(),
);
}
private buildParameters(): Parameters<typeof useResizeObserver> {
return [
{
observedElementRef: this.observedElementRef,
throttleInMs: 50,
observeCallback: () => {},
},
() => ({
resizeObserverReady: Promise.resolve(() => this.resizeObserver),
}),
() => createFrameLimiterStub(),
new ThrottleStub()
.withImmediateExecution(true)
.func,
this.onSetup,
this.onTeardown,
];
}
}