PivotGrid: T1317109 — fix memory leak after PivotGridDataSource is reassigned #32332
+49
−13
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This reverts commit 8c3e610.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a memory leak issue (T1317109) that occurs when PivotGridDataSource is reassigned. The fix ensures that internal DataSource instances within store objects are properly disposed when the PivotGridDataSource itself is disposed.
Changes:
- Added
dispose()methods to LocalStore, RemoteStore, and XmlaStore classes - Modified PivotGridDataSource.dispose() to call the store's dispose method
- Added tests to verify that LocalStore and RemoteStore dispose their internal DataSource instances
- Improved code formatting with consistent indentation in data_source.ts
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| packages/devextreme/testing/tests/DevExpress.ui.widgets.pivotGrid/dataSource_bundled.tests.js | Added two tests to verify that PivotGridDataSource.dispose() properly disposes the internal DataSource in both LocalStore and RemoteStore |
| packages/devextreme/js/__internal/grids/pivot_grid/xmla_store/m_xmla_store.ts | Added empty dispose() method to XmlaStore for interface consistency (XmlaStore doesn't maintain internal DataSource) |
| packages/devextreme/js/__internal/grids/pivot_grid/remote_store/m_remote_store.ts | Added dispose() method that disposes the internal _dataSource using optional chaining for null safety |
| packages/devextreme/js/__internal/grids/pivot_grid/local_store/m_local_store.ts | Added dispose() method that disposes the internal _dataSource using optional chaining for null safety; also removed unnecessary eslint-disable comment |
| packages/devextreme/js/__internal/grids/pivot_grid/data_source/m_data_source.ts | Updated dispose() to call store's dispose method; improved code formatting with consistent indentation |
Comment on lines
+6920
to
+6941
| QUnit.test('PivotGridDataSource dispose disposes LocalStore', function(assert) { | ||
| const dataSource = new PivotGridDataSource({ | ||
| store: window.orders | ||
| }); | ||
| const store = dataSource.store(); | ||
|
|
||
| dataSource.dispose(); | ||
|
|
||
| assert.ok(store._dataSource._disposed, 'LocalStore internal DataSource is disposed'); | ||
| }); | ||
|
|
||
| QUnit.test('PivotGridDataSource dispose disposes RemoteStore', function(assert) { | ||
| const dataSource = new PivotGridDataSource({ | ||
| remoteOperations: true, | ||
| store: window.orders | ||
| }); | ||
| const store = dataSource.store(); | ||
|
|
||
| dataSource.dispose(); | ||
|
|
||
| assert.ok(store._dataSource._disposed, 'RemoteStore internal DataSource is disposed'); | ||
| }); |
There was a problem hiding this comment.
The tests for LocalStore and RemoteStore disposal both access the internal _dataSource property to verify disposal. However, there's no corresponding test for XmlaStore disposal, even though an empty dispose() method was added to it. Consider adding a test for XmlaStore to maintain consistent test coverage across all store types, or add a comment explaining why XmlaStore doesn't need disposal testing (because it doesn't maintain an internal DataSource).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.