Skip to content

Clarify Diff Snapshots Freed column is per class #8837 #10002

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

Open
AzazelSensei wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Clarify Diff Snapshots Freed column is per class #8837 #10002

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions packages/devtools_app/lib/src/screens/memory/panes/diff/widgets/classes_table_diff.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,7 @@ class _SizeColumn extends ColumnData<DiffClassData> {
_SizeColumn(this.dataPart, this.sizeType)
: super(
columnTitle(dataPart),
titleTooltip: columnTooltip(dataPart),
fixedWidthPx: 80.0,
alignment: ColumnAlignment.right,
);
Expand All @@ -183,6 +184,24 @@ class _SizeColumn extends ColumnData<DiffClassData> {
}
}

static String columnTooltip(_DataPart dataPart) {
switch (dataPart) {
case _DataPart.created:
return 'Size of this class allocated between the two snapshots.\n'
'This is the value for this row, not a cumulative total.';
case _DataPart.deleted:
return 'Size of this class released between the two snapshots.\n'
'This is the value for this row, not a cumulative total.';
case _DataPart.delta:
return 'Net size change of this class between the two snapshots '
'(allocated minus freed).\n'
'This is the value for this row, not a cumulative total.';
case _DataPart.persisted:
return 'Size of this class present in both snapshots.\n'
'This is the value for this row, not a cumulative total.';
}
}
Comment on lines +187 to +203

@gemini-code-assist gemini-code-assist Bot Sep 3, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

[CONCERN] The string literal '\nThis is the value for this row, not a cumulative total.' is repeated four times within the columnTooltip method. To adhere to the DRY principle and the repository style guide, this repeated sub-expression should be extracted into a local constant.

  static String columnTooltip(_DataPart dataPart) {
    const rowValueNote = '\\nThis is the value for this row, not a cumulative total.';
    switch (dataPart) {
      case _DataPart.created:
        return 'Size of this class allocated between the two snapshots.$rowValueNote';
      case _DataPart.deleted:
        return 'Size of this class released between the two snapshots.$rowValueNote';
      case _DataPart.delta:
        return 'Net size change of this class between the two snapshots '
            '(allocated minus freed).$rowValueNote';
      case _DataPart.persisted:
        return 'Size of this class present in both snapshots.$rowValueNote';
    }
  }
References
  1. Extract repeated sub-expressions or string literals within the same method into local variables or constants to adhere to the DRY principle. (link)


@override
int getValue(DiffClassData data) {
switch (sizeType) {
Expand Down
3 changes: 3 additions & 0 deletions packages/devtools_app/release_notes/NEXT_RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ TODO: Remove this section if there are not any updates.
## Memory updates

* Added the ability to pin classes to the top of the Profile Memory table. [#8898](https://github.com/flutter/devtools/issues/8898)
* Clarified that Diff Snapshots size columns (Allocated, Freed, Delta, Persisted)
show memory for that class row, not a running total of the table.
[#8837](https://github.com/flutter/devtools/issues/8837)

## Debugger updates

Expand Down