Skip to content

feat(devtools): add filter and sort for data table #421

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
yang-lile wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(devtools): add filter and sort for data table #421

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
245 changes: 223 additions & 22 deletions tool/get_it_devtools_extension/lib/main.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ import 'dart:async';
import 'package:devtools_app_shared/ui.dart';
import 'package:devtools_extensions/devtools_extensions.dart';
import 'package:flutter/material.dart';
import 'package:get_it_devtools_extension/src/widgets/filter_dialog.dart';
import 'package:get_it_devtools_extension/src/widgets/sort_dialog.dart';
import 'package:vm_service/vm_service.dart';

import 'src/model.dart';
Expand Down Expand Up @@ -31,13 +33,80 @@ class _GetItDevToolsScreenState extends State<GetItDevToolsScreen> {
List<RegistrationInfo> _registrations = [];
bool _isLoading = true;
String? _error;
final TextEditingController _searchController = TextEditingController();
String _searchQuery = '';

// Sorting
SortField _sortField = SortField.defaultOrder;
SortDirection _sortDirection = SortDirection.asc;

// Filters
final Set<String> _selectedRegistrationTypes = {};
final Set<String> _selectedScopes = {};
bool? _filterAsync;
bool? _filterReady;
bool? _filterCreated;

@override
void initState() {
super.initState();
_init();
}

@override
void dispose() {
_searchController.dispose();
super.dispose();
}

List<RegistrationInfo> get _filteredRegistrations {
final filtered = [
if (_searchQuery.isNotEmpty) _matchesSearch,
if (_selectedScopes.isNotEmpty) _matchesScope,
if (_selectedRegistrationTypes.isNotEmpty) _matchesRegistrationType,
if (_filterAsync != null) _matchesAsync,
if (_filterReady != null) _matchesReady,
if (_filterCreated != null) _matchesCreated,
].fold<Iterable<RegistrationInfo>>(_registrations, (data, predicate) => data.where(predicate)).toList();

// For defaultOrder, descending means reversing the list
if (_sortField == SortField.defaultOrder) {
return _sortDirection == SortDirection.desc ? filtered.reversed.toList() : filtered;
}

return filtered..sort(_compareBySortField);
}

bool _matchesSearch(RegistrationInfo item) {
final query = _searchQuery.toLowerCase();
return item.type.toLowerCase().contains(query) ||
(item.instanceName?.toLowerCase().contains(query) ?? false) ||
(item.instanceDetails?.toLowerCase().contains(query) ?? false);
}

bool _matchesScope(RegistrationInfo item) => _selectedScopes.contains(item.scopeName);

bool _matchesRegistrationType(RegistrationInfo item) => _selectedRegistrationTypes.contains(item.registrationType);

bool _matchesAsync(RegistrationInfo item) => item.isAsync == _filterAsync;

bool _matchesReady(RegistrationInfo item) => item.isReady == _filterReady;

bool _matchesCreated(RegistrationInfo item) => item.isCreated == _filterCreated;

int _compareBySortField(RegistrationInfo a, RegistrationInfo b) {
if (_sortField == SortField.defaultOrder) return 0;

final comparison = switch (_sortField) {
SortField.type => a.type.compareTo(b.type),
SortField.instanceName => (a.instanceName ?? '').compareTo(b.instanceName ?? ''),
SortField.instanceDetails => (a.instanceDetails ?? '').compareTo(b.instanceDetails ?? ''),
SortField.defaultOrder => 0,
};

return _sortDirection == SortDirection.asc ? comparison : -comparison;
}

Future<void> _init() async {
try {
await _fetchRegistrations();
Expand All @@ -58,13 +127,9 @@ class _GetItDevToolsScreenState extends State<GetItDevToolsScreen> {

Future<void> _fetchRegistrations() async {
try {
final response = await serviceManager.callServiceExtensionOnMainIsolate(
'ext.get_it.getRegistrations',
);
final response = await serviceManager.callServiceExtensionOnMainIsolate('ext.get_it.getRegistrations');
final List<dynamic> data = response.json?['registrations'] ?? [];
final registrations = data
.map((e) => RegistrationInfo.fromJson(e as Map<String, dynamic>))
.toList();
final registrations = data.map((e) => RegistrationInfo.fromJson(e as Map<String, dynamic>)).toList();

setState(() {
_registrations = registrations;
Expand All @@ -74,8 +139,7 @@ class _GetItDevToolsScreenState extends State<GetItDevToolsScreen> {
// If the extension is not registered yet (app starting up), we might get an error.
// We can retry or just show empty state.
setState(() {
_error =
'Could not fetch registrations. Make sure debugEventsEnabled is true in GetIt.';
_error = 'Could not fetch registrations. Make sure debugEventsEnabled is true in GetIt.';
_isLoading = false;
});
}
Expand All @@ -94,10 +158,7 @@ class _GetItDevToolsScreenState extends State<GetItDevToolsScreen> {
children: [
Text('Error: $_error'),
const SizedBox(height: 16),
ElevatedButton(
onPressed: _fetchRegistrations,
child: const Text('Retry'),
),
ElevatedButton(onPressed: _fetchRegistrations, child: const Text('Retry')),
],
),
);
Expand All @@ -108,19 +169,57 @@ class _GetItDevToolsScreenState extends State<GetItDevToolsScreen> {
AreaPaneHeader(
title: const Text('GetIt Registrations'),
actions: [
IconButton(
icon: const Icon(Icons.refresh),
tooltip: 'Refresh',
onPressed: _fetchRegistrations,
),
IconButton(icon: const Icon(Icons.filter_list), tooltip: 'Filter', onPressed: _handleFilterPressed),
IconButton(icon: const Icon(Icons.sort), tooltip: 'Sort', onPressed: _handleSortPressed),
IconButton(icon: const Icon(Icons.refresh), tooltip: 'Refresh', onPressed: _fetchRegistrations),
],
),
Padding(
padding: const EdgeInsets.symmetric(horizontal: 16, vertical: 8),
child: TextField(
controller: _searchController,
decoration: InputDecoration(
hintText: 'Search registrations...',
prefixIcon: const Icon(Icons.search),
suffixIcon: _searchQuery.isNotEmpty == true
? IconButton(
icon: const Icon(Icons.clear),
onPressed: () {
_searchController.clear();
setState(() {
_searchQuery = '';
});
},
)
: null,
border: const OutlineInputBorder(),
),
onChanged: (value) {
setState(() {
_searchQuery = value;
});
},
),
),
// Show active filter chips
if (_selectedRegistrationTypes.isNotEmpty ||
_selectedScopes.isNotEmpty ||
_filterAsync != null ||
_filterReady != null ||
_filterCreated != null)
_buildFilterChips(),
Expanded(child: _buildTable()),
],
);
}

Widget _buildTable() {
final filtered = _filteredRegistrations;

if (filtered.isEmpty && _searchQuery.isNotEmpty) {
return const Center(child: Text('No results found'));
}

return SingleChildScrollView(
scrollDirection: Axis.vertical,
child: SingleChildScrollView(
Expand All @@ -136,7 +235,7 @@ class _GetItDevToolsScreenState extends State<GetItDevToolsScreen> {
DataColumn(label: Text('Created')),
DataColumn(label: Text('Instance Details')),
],
rows: _registrations.map((item) {
rows: filtered.map((item) {
return DataRow(
cells: [
DataCell(Text(item.type)),
Expand All @@ -150,10 +249,7 @@ class _GetItDevToolsScreenState extends State<GetItDevToolsScreen> {
item.instanceDetails != null
? Tooltip(
message: item.instanceDetails!,
child: Text(
_truncateText(item.instanceDetails!, 50),
overflow: TextOverflow.ellipsis,
),
child: Text(_truncateText(item.instanceDetails!, 50), overflow: TextOverflow.ellipsis),
)
: const Text(''),
),
Expand All @@ -171,4 +267,109 @@ class _GetItDevToolsScreenState extends State<GetItDevToolsScreen> {
}
return '${text.substring(0, maxLength)}...';
}

Padding _buildFilterChips() {
return Padding(
padding: const EdgeInsets.symmetric(horizontal: 16),
child: Wrap(
spacing: 8,
runSpacing: 8,
children: [
..._selectedScopes.map(
(scope) => Chip(
label: Text('Scope: $scope'),
onDeleted: () {
setState(() {
_selectedScopes.remove(scope);
});
},
),
),
..._selectedRegistrationTypes.map(
(type) => Chip(
label: Text('Mode: $type'),
onDeleted: () {
setState(() {
_selectedRegistrationTypes.remove(type);
});
},
),
),
if (_filterAsync != null)
Chip(
label: Text('Async: ${_filterAsync! ? 'Yes' : 'No'}'),
onDeleted: () {
setState(() {
_filterAsync = null;
});
},
),
if (_filterReady != null)
Chip(
label: Text('Ready: ${_filterReady! ? 'Yes' : 'No'}'),
onDeleted: () {
setState(() {
_filterReady = null;
});
},
),
if (_filterCreated != null)
Chip(
label: Text('Created: ${_filterCreated! ? 'Yes' : 'No'}'),
onDeleted: () {
setState(() {
_filterCreated = null;
});
},
),
],
),
);
}

Future<void> _handleFilterPressed() async {
final allRegistrationTypes = _registrations.map((r) => r.registrationType).toSet().toList()..sort();
final allScopes = _registrations.map((r) => r.scopeName).toSet().toList()..sort();

final initialState = FilterState(
selectedScopes: _selectedScopes,
selectedRegistrationTypes: _selectedRegistrationTypes,
filterAsync: _filterAsync,
filterReady: _filterReady,
filterCreated: _filterCreated,
);
final result = await showDialog<FilterState>(
context: context,
builder: (context) =>
FilterDialog(registrationTypes: allRegistrationTypes, scopes: allScopes, initialState: initialState),
);

if (result != null) {
setState(() {
_selectedScopes
..clear()
..addAll(result.selectedScopes);
_selectedRegistrationTypes
..clear()
..addAll(result.selectedRegistrationTypes);
_filterAsync = result.filterAsync;
_filterReady = result.filterReady;
_filterCreated = result.filterCreated;
});
}
}

Future<void> _handleSortPressed() async {
final initialState = SortState(field: _sortField, direction: _sortDirection);
final result = await showDialog<SortState>(
context: context,
builder: (context) => SortDialog(initialState: initialState),
);
if (result != null) {
setState(() {
_sortField = result.field;
_sortDirection = result.direction;
});
}
}
}
Loading