Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

debounced updateWindow #469

Merged
merged 6 commits into from
Oct 19, 2023
Merged

debounced updateWindow #469

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d425bd5
debounced updateWindow
Jaspreet-singh-1032 Oct 12, 2023
5a569c6
use throttle to optimize updateWindow
Jaspreet-singh-1032 Oct 14, 2023
9f4785b
fix lint issue
Jaspreet-singh-1032 Oct 16, 2023
a5e325f
Merge branch 'main' into issue-461-optimize-useKWindowDimensions-perf…
MisRob Oct 17, 2023
17c0e6e
Update changelog
MisRob Oct 17, 2023
cf2909e
Merge branch 'main' into issue-461-optimize-useKWindowDimensions-perf…
MisRob Oct 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions lib/__tests__/useKWindowDimensions.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,22 @@ describe('useKWindowDimensions composable', () => {

it('check if windowWidth and windowHeight properties are initialized on mount', () => {
const wrapper = mount(TestComponent);
expect(wrapper.vm.windowWidth).toEqual(expect.any(Number));
expect(wrapper.vm.windowHeight).toEqual(expect.any(Number));
// Wait for the throttling delay
setTimeout(() => {
expect(wrapper.vm.windowWidth).toEqual(expect.any(Number));
expect(wrapper.vm.windowHeight).toEqual(expect.any(Number));
}, 20);
});

it('check if windowWidth and windowHeight change when window is resized', () => {
const wrapper = mount(TestComponent);
expect(wrapper.vm.windowWidth).not.toEqual(600);
expect(wrapper.vm.windowHeight).not.toEqual(400);
resizeWindow(600, 400);
expect(wrapper.vm.windowWidth).toEqual(600);
expect(wrapper.vm.windowHeight).toEqual(400);
// Wait for the throttling delay
setTimeout(() => {
expect(wrapper.vm.windowWidth).toEqual(600);
expect(wrapper.vm.windowHeight).toEqual(400);
}, 20);
});
});
90 changes: 66 additions & 24 deletions lib/useKResponsiveWindow/__tests__/useKResponsiveWindow.spec.js
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Jaspreet-singh-1032 One of my colleagues noticed an issue with using setTimeout after we merged it, so I opened a follow-up #480. You don't need to work on it, of course! It's rather FYI in case you'd find the note interesting. I didn't realize that either.

Original file line number Diff line number Diff line change
Expand Up @@ -36,73 +36,100 @@ describe('useKResponsiveWindow composable', () => {
resizeWindow(1700);
const wrapper = mount(TestComponent());
await wrapper.vm.$nextTick();
expect(wrapper.vm.windowWidth).toEqual(1700);
expect(wrapper.vm.windowHeight).toEqual(768);
expect(wrapper.vm.windowBreakpoint).toEqual(7);
expect(wrapper.vm.windowIsPortrait).toEqual(false);
expect(wrapper.vm.windowIsLandscape).toEqual(true);
expect(wrapper.vm.windowGutter).toEqual(24);
expect(wrapper.vm.windowIsShort).toEqual(false);
expect(wrapper.vm.windowIsLarge).toEqual(true);
expect(wrapper.vm.windowIsMedium).toEqual(false);
expect(wrapper.vm.windowIsSmall).toEqual(false);
// Wait for the throttling delay
setTimeout(() => {
expect(wrapper.vm.windowWidth).toEqual(1700);
expect(wrapper.vm.windowHeight).toEqual(768);
expect(wrapper.vm.windowBreakpoint).toEqual(7);
expect(wrapper.vm.windowIsPortrait).toEqual(false);
expect(wrapper.vm.windowIsLandscape).toEqual(true);
expect(wrapper.vm.windowGutter).toEqual(24);
expect(wrapper.vm.windowIsShort).toEqual(false);
expect(wrapper.vm.windowIsLarge).toEqual(true);
expect(wrapper.vm.windowIsMedium).toEqual(false);
expect(wrapper.vm.windowIsSmall).toEqual(false);
}, 20);
});

describe('check if windowBreakpoint is set on width change', () => {
it('windowBreakpoint is 0 if width <= 480px', async () => {
resizeWindow(400);
const wrapper = mount(TestComponent());
await wrapper.vm.$nextTick();
expect(wrapper.vm.windowBreakpoint).toEqual(0);
// Wait for the throttling delay
setTimeout(() => {
expect(wrapper.vm.windowBreakpoint).toEqual(0);
}, 20);
});

it('windowBreakpoint is 1 if 480px < width <= 600px', async () => {
resizeWindow(540);
const wrapper = mount(TestComponent());
await wrapper.vm.$nextTick();
expect(wrapper.vm.windowBreakpoint).toEqual(1);
// Wait for the throttling delay
setTimeout(() => {
expect(wrapper.vm.windowBreakpoint).toEqual(1);
}, 20);
});

it('windowBreakpoint is 2 if 600px < width <= 840px', async () => {
resizeWindow(800);
const wrapper = mount(TestComponent());
await wrapper.vm.$nextTick();
expect(wrapper.vm.windowBreakpoint).toEqual(2);
// Wait for the throttling delay
setInterval(() => {
expect(wrapper.vm.windowBreakpoint).toEqual(2);
}, 20);
});

it('windowBreakpoint is 3 if 840px < width <= 944px', async () => {
resizeWindow(944);
const wrapper = mount(TestComponent());
await wrapper.vm.$nextTick();
expect(wrapper.vm.windowBreakpoint).toEqual(3);
// Wait for the throttling delay
setTimeout(() => {
expect(wrapper.vm.windowBreakpoint).toEqual(3);
}, 20);
});

it('windowBreakpoint is 4 if 944px < width <= 1264px', async () => {
resizeWindow(1264);
const wrapper = mount(TestComponent());
await wrapper.vm.$nextTick();
expect(wrapper.vm.windowBreakpoint).toEqual(4);
// Wait for the throttling delay
setTimeout(() => {
expect(wrapper.vm.windowBreakpoint).toEqual(4);
}, 20);
});

it('windowBreakpoint is 5 if 1264px < width <= 1424px', async () => {
resizeWindow(1424);
const wrapper = mount(TestComponent());
await wrapper.vm.$nextTick();
expect(wrapper.vm.windowBreakpoint).toEqual(5);
// Wait for the throttling delay
setTimeout(() => {
expect(wrapper.vm.windowBreakpoint).toEqual(5);
}, 20);
});

it('windowBreakpoint is 6 if 1424px < width <= 1584px', async () => {
resizeWindow(1584);
const wrapper = mount(TestComponent());
await wrapper.vm.$nextTick();
expect(wrapper.vm.windowBreakpoint).toEqual(6);
// Wait for the throttling delay
setTimeout(() => {
expect(wrapper.vm.windowBreakpoint).toEqual(6);
}, 20);
});

it('windowBreakpoint is 7 if width >= 1601px', async () => {
resizeWindow(1800);
const wrapper = mount(TestComponent());
await wrapper.vm.$nextTick();
expect(wrapper.vm.windowBreakpoint).toEqual(7);
// Wait for the throttling delay
setTimeout(() => {
expect(wrapper.vm.windowBreakpoint).toEqual(7);
}, 20);
});
});

Expand All @@ -111,7 +138,10 @@ describe('useKResponsiveWindow composable', () => {
resizeWindow(601);
const wrapper = mount(TestComponent());
await wrapper.vm.$nextTick();
expect(wrapper.vm.windowIsSmall).toEqual(false);
// Wait for the throttling delay
setTimeout(() => {
expect(wrapper.vm.windowIsSmall).toEqual(false);
}, 20);
});

it('windowIsSmall is true if width <= 600px', async () => {
Expand All @@ -134,7 +164,10 @@ describe('useKResponsiveWindow composable', () => {
resizeWindow(700);
const wrapper = mount(TestComponent());
await wrapper.vm.$nextTick();
expect(wrapper.vm.windowIsMedium).toEqual(true);
// Wait for the throttling delay
setTimeout(() => {
expect(wrapper.vm.windowIsMedium).toEqual(true);
}, 20);
});
});

Expand All @@ -150,7 +183,10 @@ describe('useKResponsiveWindow composable', () => {
resizeWindow(841);
const wrapper = mount(TestComponent());
await wrapper.vm.$nextTick();
expect(wrapper.vm.windowIsLarge).toEqual(true);
// Wait for the throttling delay
setTimeout(() => {
expect(wrapper.vm.windowIsLarge).toEqual(true);
}, 20);
});
});

Expand Down Expand Up @@ -193,14 +229,20 @@ describe('useKResponsiveWindow composable', () => {
resizeWindow(500, 500);
const wrapper = mount(TestComponent());
await wrapper.vm.$nextTick();
expect(wrapper.vm.windowBreakpoint).toEqual(1);
expect(wrapper.vm.windowGutter).toEqual(16);
// Wait for the throttling delay
setTimeout(() => {
expect(wrapper.vm.windowBreakpoint).toEqual(1);
expect(wrapper.vm.windowGutter).toEqual(16);
}, 20);
});
it('windowGutter is 24px if windowIsSmall is false(width > 600px)', async () => {
resizeWindow(841);
const wrapper = mount(TestComponent());
await wrapper.vm.$nextTick();
expect(wrapper.vm.windowGutter).toEqual(24);
// Wait for the throttling delay
setTimeout(() => {
expect(wrapper.vm.windowGutter).toEqual(24);
}, 20);
});
});
});
7 changes: 5 additions & 2 deletions lib/useKWindowDimensions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import './composition-api'; //Due to @vue/composition-api shortcomings, add plugin prior to use in kolibri, studio and tests
import { onMounted, onUnmounted, ref } from '@vue/composition-api';
import { throttle } from 'frame-throttle';

/** Global variables */
export const windowWidth = ref(null);
Expand All @@ -16,6 +17,8 @@ const updateWindow = () => {
windowHeight.value = metrics.height;
};

const throttledUpdateWindow = throttle(updateWindow);

/**
* Returns window inner width and height
* @returns {Object} The window's inner width and height
Expand Down Expand Up @@ -73,12 +76,12 @@ function isUseKWindowDimensionsActiveElsewhere() {
export default function useKWindowDimensions() {
onMounted(() => {
usageCount.value++;
addWindowListener(updateWindow);
addWindowListener(throttledUpdateWindow);
});

onUnmounted(() => {
usageCount.value--;
removeWindowListener(updateWindow);
removeWindowListener(throttledUpdateWindow);
});

return {
Expand Down
Loading