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.

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

Prevent event listener accumulation #2074

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -304,6 +304,60 @@ describe('CheckSessionService', () => {
}));
});

describe('bindMessageEventToIframe', () => {
it('remove event listener when iframeMessageEventListener already exist', () => {
const serviceAsAny = checkSessionService as any;
const defaultView = serviceAsAny.document.defaultView;
const configuration = { configId: 'configId1' };
const existingListener = serviceAsAny.messageHandler.bind(
this,
configuration
);

serviceAsAny.iframeMessageEventListener = existingListener;

const spyRemoveEventListener = spyOn(defaultView, 'removeEventListener');

serviceAsAny.bindMessageEventToIframe(configuration);

expect(spyRemoveEventListener).toHaveBeenCalledOnceWith(
'message',
existingListener,
false
);
});

it('doesn\'t remove event listener when iframeMessageEventListener not exist', () => {
const serviceAsAny = checkSessionService as any;
const defaultView = serviceAsAny.document.defaultView;

serviceAsAny.iframeMessageEventListener = undefined;

const spyRemoveEventListener = spyOn(defaultView, 'removeEventListener');
const configuration = { configId: 'configId1' };

serviceAsAny.bindMessageEventToIframe(configuration);

expect(spyRemoveEventListener).not.toHaveBeenCalled();
});

it('add event listener', () => {
const serviceAsAny = checkSessionService as any;
const defaultView = serviceAsAny.document.defaultView;

const spyAddEventListener = spyOn(defaultView, 'addEventListener');
const configuration = { configId: 'configId1' };

serviceAsAny.bindMessageEventToIframe(configuration);

expect(spyAddEventListener).toHaveBeenCalledOnceWith(
'message',
jasmine.any(Function),
false
);
});
});

describe('isCheckSessionConfigured', () => {
it('returns true if startCheckSession on config is true', () => {
const config = { configId: 'configId1', startCheckSession: true };
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -283,13 +283,17 @@ export class CheckSessionService implements OnDestroy {
}

private bindMessageEventToIframe(configuration: OpenIdConfiguration): void {
const defaultView = this.document.defaultView;

if (this.iframeMessageEventListener && defaultView) {
defaultView.removeEventListener('message', this.iframeMessageEventListener, false);
}

this.iframeMessageEventListener = this.messageHandler.bind(
this,
configuration
);

const defaultView = this.document.defaultView;

if (defaultView) {
defaultView.addEventListener(
'message',
Expand Down
Loading