Skip to content

fix(tab-bar): prevent keyboard controller memory leak on rapid mount/unmount #30906

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

Merged
ShaneK merged 4 commits into from
Jan 14, 2026
+46 −2
Merged

fix(tab-bar): prevent keyboard controller memory leak on rapid mount/unmount #30906

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
13b441d
fix(tab-bar): prevent keyboard controller memory leak on rapid mount/…
ShaneK Jan 5, 2026
6ea7cef
fix(tab-bar): prevent keyboard controller memory leak on rapid mount/…
ShaneK Jan 8, 2026
9c10dbe
Merge branch 'main' of github.com:ionic-team/ionic-framework into ION…
ShaneK Jan 13, 2026
4d19d31
fix(footer): fixing memory leak from rapid keyboard mount/unmount
ShaneK Jan 13, 2026
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
24 changes: 23 additions & 1 deletion core/src/components/footer/footer.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ export class Footer implements ComponentInterface {
private scrollEl?: HTMLElement;
private contentScrollCallback?: () => void;
private keyboardCtrl: KeyboardController | null = null;
private keyboardCtrlPromise: Promise<KeyboardController> | null = null;

@State() private keyboardVisible = false;

Expand Down Expand Up @@ -52,7 +53,7 @@ export class Footer implements ComponentInterface {
}

async connectedCallback() {
this.keyboardCtrl = await createKeyboardController(async (keyboardOpen, waitForResize) => {
const promise = createKeyboardController(async (keyboardOpen, waitForResize) => {
/**
* If the keyboard is hiding, then we need to wait
* for the webview to resize. Otherwise, the footer
Expand All @@ -64,11 +65,32 @@ export class Footer implements ComponentInterface {

this.keyboardVisible = keyboardOpen; // trigger re-render by updating state
});
this.keyboardCtrlPromise = promise;

const keyboardCtrl = await promise;

/**
* Only assign if this is still the current promise.
* Otherwise, a new connectedCallback has started or
* disconnectedCallback was called, so destroy this instance.
*/
if (this.keyboardCtrlPromise === promise) {
this.keyboardCtrl = keyboardCtrl;
this.keyboardCtrlPromise = null;
} else {
keyboardCtrl.destroy();
}
}

disconnectedCallback() {
if (this.keyboardCtrlPromise) {
this.keyboardCtrlPromise.then((ctrl) => ctrl.destroy());
this.keyboardCtrlPromise = null;
}

if (this.keyboardCtrl) {
this.keyboardCtrl.destroy();
this.keyboardCtrl = null;
}
}

Expand Down
24 changes: 23 additions & 1 deletion core/src/components/tab-bar/tab-bar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import type { TabBarChangedEventDetail } from './tab-bar-interface';
})
export class TabBar implements ComponentInterface {
private keyboardCtrl: KeyboardController | null = null;
private keyboardCtrlPromise: Promise<KeyboardController> | null = null;
private didLoad = false;

@Element() el!: HTMLElement;
Expand Down Expand Up @@ -88,7 +89,7 @@ export class TabBar implements ComponentInterface {
}

async connectedCallback() {
this.keyboardCtrl = await createKeyboardController(async (keyboardOpen, waitForResize) => {
const promise = createKeyboardController(async (keyboardOpen, waitForResize) => {
/**
* If the keyboard is hiding, then we need to wait
* for the webview to resize. Otherwise, the tab bar
Expand All @@ -100,11 +101,32 @@ export class TabBar implements ComponentInterface {

this.keyboardVisible = keyboardOpen; // trigger re-render by updating state
});
this.keyboardCtrlPromise = promise;

const keyboardCtrl = await promise;

/**
* Only assign if this is still the current promise.
* Otherwise, a new connectedCallback has started or
* disconnectedCallback was called, so destroy this instance.
*/
if (this.keyboardCtrlPromise === promise) {
this.keyboardCtrl = keyboardCtrl;
this.keyboardCtrlPromise = null;
} else {
keyboardCtrl.destroy();
}
}

disconnectedCallback() {
if (this.keyboardCtrlPromise) {
Copy link
Member

@brandyscarney brandyscarney Jan 13, 2026

Choose a reason for hiding this comment

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

Maybe this doesn't need to be done on this PR, but I feel like we do this same code in so many places that we should consider making it a utility.

Copy link
Member Author

@ShaneK ShaneK Jan 13, 2026

Choose a reason for hiding this comment

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

It looks like this particular pattern is only specifically done in tab bar and footer (unless I'm missing something?), so I'm not sure if that's worth extracting right now

Copy link
Member

@brandyscarney brandyscarney Jan 14, 2026

Choose a reason for hiding this comment

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

I mostly meant the code that is destroying like this:

ionic-framework/core/src/components/select/select.tsx

Lines 376 to 379 in 1c89cf0

if (this.notchController) {
this.notchController.destroy();
this.notchController = undefined;
}

We also disconnect in a lot of places:

ionic-framework/core/src/components/select/select.tsx

Lines 382 to 385 in 1c89cf0

if (this.validationObserver) {
this.validationObserver.disconnect();
this.validationObserver = undefined;
}

It seems like we could make this into a utility or something, but that's not an issue for your PR.

Copy link
Contributor

@thetaPC thetaPC Jan 14, 2026

Choose a reason for hiding this comment

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

Let's make a ticket to circle back on adding the utility.

Copy link
Member Author

@ShaneK ShaneK Jan 14, 2026

Choose a reason for hiding this comment

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

@thetaPC Done! This will be FW-7030

this.keyboardCtrlPromise.then((ctrl) => ctrl.destroy());
this.keyboardCtrlPromise = null;
}

if (this.keyboardCtrl) {
this.keyboardCtrl.destroy();
this.keyboardCtrl = null;
}
}

Expand Down
Loading