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

fix(select): fix memory leak in IgxSelectionAPIService #13926

Merged
merged 7 commits into from
Feb 21, 2024
Merged

fix(select): fix memory leak in IgxSelectionAPIService #13926

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
80fbb7c
fix(select): fix memory leak in IgxSelectionAPIService
teodosiah Feb 19, 2024
6410197
fix(select): remove unnecessary ngOnDestroy in the select component
teodosiah Feb 19, 2024
033320b
Update drop-down.component.spec.ts
teodosiah Feb 19, 2024
f181e1d
Merge branch 'master' into thristodorova/fix-13923-master
teodosiah Feb 19, 2024
33a3dfb
Merge branch 'master' into thristodorova/fix-13923-master
ChronosSF Feb 20, 2024
3bfa486
Merge branch 'master' into thristodorova/fix-13923-master
kdinev Feb 20, 2024
0e8d8dc
Merge branch 'master' into thristodorova/fix-13923-master
Lipata Feb 21, 2024
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
2 changes: 1 addition & 1 deletion projects/igniteui-angular/src/lib/combo/combo.common.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1009,7 +1009,7 @@ export abstract class IgxComboBaseDirective extends DisplayDensityBase implement
this.destroy$.next();
this.destroy$.complete();
this.comboAPI.clear();
this.selectionService.clear(this.id);
this.selectionService.delete(this.id);
}

/**
Expand Down
18 changes: 13 additions & 5 deletions projects/igniteui-angular/src/lib/combo/combo.component.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ describe('igxCombo', () => {
const elementRef = { nativeElement: null };
const mockSelection: {
[key: string]: jasmine.Spy;
} = jasmine.createSpyObj('IgxSelectionAPIService', ['get', 'set', 'add_items', 'select_items']);
} = jasmine.createSpyObj('IgxSelectionAPIService', ['get', 'set', 'add_items', 'select_items', 'delete']);
const mockCdr = jasmine.createSpyObj('ChangeDetectorRef', ['markForCheck', 'detectChanges']);
const mockComboService = jasmine.createSpyObj('IgxComboAPIService', ['register']);
const mockComboService = jasmine.createSpyObj('IgxComboAPIService', ['register', 'clear']);
const mockNgControl = jasmine.createSpyObj('NgControl', ['registerOnChangeCb', 'registerOnTouchedCb']);
const mockInjector = jasmine.createSpyObj('Injector', {
get: mockNgControl
Expand Down Expand Up @@ -835,6 +835,14 @@ describe('igxCombo', () => {
expect([...selectionService.get(combo.id)][1]).toBe(subParams.newValue);
sub.unsubscribe();
}));

it('should delete the selection on destroy', () => {
combo = new IgxComboComponent(elementRef, mockCdr, mockSelection as any, mockComboService,
mockIconService, null, null, mockInjector);
combo.ngOnDestroy();
expect(mockComboService.clear).toHaveBeenCalled();
expect(mockSelection.delete).toHaveBeenCalled();
});
});

describe('Combo feature tests: ', () => {
Expand Down Expand Up @@ -1413,11 +1421,11 @@ describe('igxCombo', () => {
await wait();
fixture.detectChanges();
combo.select([combo.data[0][valueKey], combo.data[1][valueKey]]);
Object.assign(expectedResults, {
Object.assign(expectedResults, {
newValue: [0, 1, 31, 32],
oldValue: [0, 1],
newSelection: [{[valueKey]: 0}, {[valueKey]: 1}, combo.data[0], combo.data[1]],
oldSelection: [{[valueKey]: 0}, {[valueKey]: 1}],
newSelection: [{ [valueKey]: 0 }, { [valueKey]: 1 }, combo.data[0], combo.data[1]],
oldSelection: [{ [valueKey]: 0 }, { [valueKey]: 1 }],
added: [combo.data[0], combo.data[1]],
removed: [],
event: undefined,
Expand Down
8 changes: 8 additions & 0 deletions projects/igniteui-angular/src/lib/core/selection.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,14 @@ export class IgxSelectionAPIService {
this.selection.set(componentID, this.get_empty());
}

/**
* Removes selection for a component.
* @param componentID
*/
public delete(componentID: string) {
Copy link
Member

@Lipata Lipata Feb 20, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Once the selection service is provided on a component level instead of on the root this will not be necessary.

this.selection.delete(componentID);
}

/**
* Get current component selection length.
*
Expand Down
9 changes: 8 additions & 1 deletion projects/igniteui-angular/src/lib/drop-down/drop-down.component.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ describe('IgxDropDown ', () => {
{ value: 'Item5', index: 5 } as IgxDropDownItemComponent];
const mockSelection: {
[key: string]: jasmine.Spy;
} = jasmine.createSpyObj('IgxSelectionAPIService', ['get', 'set', 'add_items', 'select_items']);
} = jasmine.createSpyObj('IgxSelectionAPIService', ['get', 'set', 'add_items', 'select_items', 'delete']);
const mockCdr = jasmine.createSpyObj('ChangeDetectorRef', ['markForCheck', 'detectChanges']);
mockSelection.get.and.returnValue(new Set([]));
const mockForOf = jasmine.createSpyObj('IgxForOfDirective', ['totalItemCount']);
Expand Down Expand Up @@ -179,6 +179,13 @@ describe('IgxDropDown ', () => {
dropdown.toggle();
expect(dropdown.close).toHaveBeenCalledTimes(1);
});
it('should remove selection on destroy', () => {
const selectionService = new IgxSelectionAPIService();
const selectionDeleteSpy = spyOn(selectionService, 'delete');
dropdown = new IgxDropDownComponent({ nativeElement: null }, mockCdr, selectionService, null);
dropdown.ngOnDestroy();
expect(selectionDeleteSpy).toHaveBeenCalled();
});
});
describe('User interaction tests', () => {
describe('Selection & key navigation', () => {
Expand Down
4 changes: 2 additions & 2 deletions projects/igniteui-angular/src/lib/drop-down/drop-down.component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,8 +411,8 @@ export class IgxDropDownComponent extends IgxDropDownBaseDirective implements ID
public ngOnDestroy() {
this.destroy$.next(true);
this.destroy$.complete();
this.selection.clear(this.id);
this.selection.clear(`${this.id}-active`);
this.selection.delete(this.id);
this.selection.delete(`${this.id}-active`);
}

/** @hidden @internal */
Expand Down
6 changes: 5 additions & 1 deletion projects/igniteui-angular/src/lib/select/select.component.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2666,7 +2666,7 @@ describe('igxSelect', () => {
describe('igxSelect ControlValueAccessor Unit', () => {
let select: IgxSelectComponent;
it('Should correctly implement interface methods', () => {
const mockSelection = jasmine.createSpyObj('IgxSelectionAPIService', ['get', 'set', 'clear', 'first_item']);
const mockSelection = jasmine.createSpyObj('IgxSelectionAPIService', ['get', 'set', 'clear', 'delete', 'first_item']);
const mockCdr = jasmine.createSpyObj('ChangeDetectorRef', ['detectChanges']);
const mockNgControl = jasmine.createSpyObj('NgControl', ['registerOnChangeCb', 'registerOnTouchedCb']);
const mockInjector = jasmine.createSpyObj('Injector', {
Expand Down Expand Up @@ -2707,6 +2707,10 @@ describe('igxSelect ControlValueAccessor Unit', () => {
spyOnProperty(select, 'collapsed').and.returnValue(true);
select.onBlur();
expect(mockNgControl.registerOnTouchedCb).toHaveBeenCalledTimes(2);

// destroy
select.ngOnDestroy();
expect(mockSelection.delete).toHaveBeenCalled();
});

it('Should correctly handle ngControl validity', () => {
Expand Down
9 changes: 0 additions & 9 deletions projects/igniteui-angular/src/lib/select/select.component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -551,15 +551,6 @@ export class IgxSelectComponent extends IgxDropDownComponent implements IgxSelec
}
}

/**
* @hidden @internal
*/
public override ngOnDestroy() {
this.destroy$.next(true);
this.destroy$.complete();
this.selection.clear(this.id);
}

/**
* @hidden @internal
* Prevent input blur - closing the items container on Header/Footer Template click.
Expand Down
15 changes: 13 additions & 2 deletions projects/igniteui-angular/src/lib/simple-combo/simple-combo.component.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,9 @@ describe('IgxSimpleCombo', () => {
const elementRef = { nativeElement: null };
const mockSelection: {
[key: string]: jasmine.Spy;
} = jasmine.createSpyObj('IgxSelectionAPIService', ['get', 'set', 'add_items', 'select_items']);
} = jasmine.createSpyObj('IgxSelectionAPIService', ['get', 'set', 'add_items', 'select_items', 'delete']);
const mockCdr = jasmine.createSpyObj('ChangeDetectorRef', ['markForCheck', 'detectChanges']);
const mockComboService = jasmine.createSpyObj('IgxComboAPIService', ['register']);
const mockComboService = jasmine.createSpyObj('IgxComboAPIService', ['register', 'clear']);
const mockNgControl = jasmine.createSpyObj('NgControl', ['registerOnChangeCb', 'registerOnTouchedCb']);
const mockInjector = jasmine.createSpyObj('Injector', {
get: mockNgControl
Expand Down Expand Up @@ -435,6 +435,17 @@ describe('IgxSimpleCombo', () => {
combo.handleClear(spyObj);
expect(combo.displayValue).toEqual(item[0]);
});

it('should delete the selection on destroy', () => {
const selectionService = new IgxSelectionAPIService();
const comboClearSpy = spyOn(mockComboService, 'clear');
const selectionDeleteSpy = spyOn(selectionService, 'delete');
combo = new IgxSimpleComboComponent(elementRef, mockCdr, selectionService, mockComboService,
mockIconService, platformUtil, null, null, mockInjector);
combo.ngOnDestroy();
expect(comboClearSpy).toHaveBeenCalled();
expect(selectionDeleteSpy).toHaveBeenCalled();
});
});

describe('Initialization and rendering tests: ', () => {
Expand Down
Loading