Refactor logs

This commit is contained in:
problematicconsumer
2023-11-28 18:24:31 +03:30
parent bb745c2ec1
commit 9c165e178b
25 changed files with 272 additions and 163 deletions

View File

@@ -12,6 +12,7 @@ import 'package:hiddify/data/repository/app_repository_impl.dart';
import 'package:hiddify/domain/environment.dart';
import 'package:hiddify/features/common/window/window_controller.dart';
import 'package:hiddify/features/geo_asset/data/geo_asset_data_providers.dart';
import 'package:hiddify/features/log/data/log_data_providers.dart';
import 'package:hiddify/features/profile/data/profile_data_providers.dart';
import 'package:hiddify/features/profile/notifier/active_profile_notifier.dart';
import 'package:hiddify/features/system_tray/system_tray_controller.dart';
@@ -88,6 +89,7 @@ Future<void> _lazyBootstrap(
final filesEditor = container.read(filesEditorServiceProvider);
await filesEditor.init();
await container.read(logRepositoryProvider.future);
await container.read(geoAssetRepositoryProvider.future);
await container.read(profileRepositoryProvider.future);
@@ -145,7 +147,7 @@ void initLoggers(
final logToFile = debug || (!Platform.isAndroid && !Platform.isIOS);
if (logToFile) {
_loggers.addPrinter(
FileLogPrinter(read(filesEditorServiceProvider).appLogsFile.path),
FileLogPrinter(read(logPathResolverProvider).appFile().path),
);
}
Loggy.initLoggy(

View File

@@ -53,7 +53,7 @@ int getCurrentIndex(BuildContext context) {
final String location = GoRouterState.of(context).uri.path;
if (location == const HomeRoute().location) return 0;
if (location.startsWith(const ProxiesRoute().location)) return 1;
if (location.startsWith(const LogsRoute().location)) return 2;
if (location.startsWith(const LogsOverviewRoute().location)) return 2;
if (location.startsWith(const SettingsRoute().location)) return 3;
if (location.startsWith(const AboutRoute().location)) return 4;
return 0;
@@ -66,7 +66,7 @@ void switchTab(int index, BuildContext context) {
case 1:
const ProxiesRoute().go(context);
case 2:
const LogsRoute().go(context);
const LogsOverviewRoute().go(context);
case 3:
const SettingsRoute().go(context);
case 4:

View File

@@ -6,7 +6,7 @@ import 'package:hiddify/features/common/adaptive_root_scaffold.dart';
import 'package:hiddify/features/geo_asset/overview/geo_assets_overview_page.dart';
import 'package:hiddify/features/home/view/view.dart';
import 'package:hiddify/features/intro/intro_page.dart';
import 'package:hiddify/features/logs/view/logs_page.dart';
import 'package:hiddify/features/log/overview/logs_overview_page.dart';
import 'package:hiddify/features/profile/add/add_profile_modal.dart';
import 'package:hiddify/features/profile/details/profile_details_page.dart';
import 'package:hiddify/features/profile/overview/profiles_overview_page.dart';
@@ -44,9 +44,9 @@ GlobalKey<NavigatorState>? _dynamicRootKey =
path: "profiles/:id",
name: ProfileDetailsRoute.name,
),
TypedGoRoute<LogsRoute>(
TypedGoRoute<LogsOverviewRoute>(
path: "logs",
name: LogsRoute.name,
name: LogsOverviewRoute.name,
),
TypedGoRoute<SettingsRoute>(
path: "settings",
@@ -116,9 +116,9 @@ class MobileWrapperRoute extends ShellRouteData {
path: "/proxies",
name: ProxiesRoute.name,
),
TypedGoRoute<LogsRoute>(
TypedGoRoute<LogsOverviewRoute>(
path: "/logs",
name: LogsRoute.name,
name: LogsOverviewRoute.name,
),
TypedGoRoute<SettingsRoute>(
path: "/settings",
@@ -260,8 +260,8 @@ class ProfileDetailsRoute extends GoRouteData {
}
}
class LogsRoute extends GoRouteData {
const LogsRoute();
class LogsOverviewRoute extends GoRouteData {
const LogsOverviewRoute();
static const name = "Logs";
static final GlobalKey<NavigatorState>? $parentNavigatorKey = _dynamicRootKey;
@@ -272,10 +272,10 @@ class LogsRoute extends GoRouteData {
return const MaterialPage(
fullscreenDialog: true,
name: name,
child: LogsPage(),
child: LogsOverviewPage(),
);
}
return const NoTransitionPage(name: name, child: LogsPage());
return const NoTransitionPage(name: name, child: LogsOverviewPage());
}
}

View File

@@ -3,6 +3,7 @@ import 'package:flutter/foundation.dart';
import 'package:hiddify/core/prefs/prefs.dart';
import 'package:hiddify/data/data_providers.dart';
import 'package:hiddify/domain/singbox/singbox.dart';
import 'package:hiddify/features/log/model/log_level.dart';
import 'package:hiddify/utils/pref_notifier.dart';
import 'package:riverpod_annotation/riverpod_annotation.dart';

View File

@@ -240,24 +240,6 @@ class CoreFacadeImpl with ExceptionHandler, InfraLogger implements CoreFacade {
);
}
@override
Stream<Either<CoreServiceFailure, List<String>>> watchLogs() {
return singbox.watchLogs(filesEditor.coreLogsFile.path).handleExceptions(
(error, stackTrace) {
loggy.warning("error watching logs", error, stackTrace);
return CoreServiceFailure.unexpected(error, stackTrace);
},
);
}
@override
TaskEither<CoreServiceFailure, Unit> clearLogs() {
return exceptionHandler(
() => singbox.clearLogs().mapLeft(CoreServiceFailure.other).run(),
CoreServiceFailure.unexpected,
);
}
@override
Stream<ConnectionStatus> watchConnectionStatus() =>
singbox.watchConnectionStatus();

View File

@@ -1,62 +0,0 @@
import 'package:dartx/dartx.dart';
import 'package:flutter/material.dart';
import 'package:freezed_annotation/freezed_annotation.dart';
import 'package:tint/tint.dart';
part 'box_log.freezed.dart';
enum LogLevel {
trace,
debug,
info,
warn,
error,
fatal,
panic;
static List<LogLevel> get choices => values.takeFirst(4);
Color? get color => switch (this) {
trace => Colors.lightBlueAccent,
debug => Colors.grey,
info => Colors.lightGreen,
warn => Colors.orange,
error => Colors.redAccent,
fatal => Colors.red,
panic => Colors.red,
};
}
@freezed
class BoxLog with _$BoxLog {
const factory BoxLog({
LogLevel? level,
DateTime? time,
required String message,
}) = _BoxLog;
factory BoxLog.parse(String log) {
log = log.strip();
DateTime? time;
if (log.length > 25) {
time = DateTime.tryParse(log.substring(6, 25));
}
if (time != null) {
log = log.substring(26);
}
final level = LogLevel.values.firstOrNullWhere(
(e) {
if (log.startsWith(e.name.toUpperCase())) {
log = log.removePrefix(e.name.toUpperCase());
return true;
}
return false;
},
);
return BoxLog(
level: level,
time: time,
message: log.trim(),
);
}
}

View File

@@ -2,8 +2,8 @@ import 'dart:convert';
import 'package:freezed_annotation/freezed_annotation.dart';
import 'package:hiddify/core/prefs/prefs.dart';
import 'package:hiddify/domain/singbox/box_log.dart';
import 'package:hiddify/domain/singbox/rules.dart';
import 'package:hiddify/features/log/model/log_level.dart';
part 'config_options.freezed.dart';
part 'config_options.g.dart';

View File

@@ -1,4 +1,3 @@
export 'box_log.dart';
export 'config_options.dart';
export 'core_status.dart';
export 'outbounds.dart';

View File

@@ -46,8 +46,4 @@ abstract interface class SingboxFacade {
Stream<ConnectionStatus> watchConnectionStatus();
Stream<Either<CoreServiceFailure, CoreStatus>> watchCoreStatus();
Stream<Either<CoreServiceFailure, List<String>>> watchLogs();
TaskEither<CoreServiceFailure, Unit> clearLogs();
}

View File

@@ -0,0 +1,23 @@
import 'package:hiddify/features/log/data/log_path_resolver.dart';
import 'package:hiddify/features/log/data/log_repository.dart';
import 'package:hiddify/services/service_providers.dart';
import 'package:riverpod_annotation/riverpod_annotation.dart';
part 'log_data_providers.g.dart';
@Riverpod(keepAlive: true)
Future<LogRepository> logRepository(LogRepositoryRef ref) async {
final repo = LogRepositoryImpl(
singbox: ref.watch(singboxServiceProvider),
logPathResolver: ref.watch(logPathResolverProvider),
);
await repo.init().getOrElse((l) => throw l).run();
return repo;
}
@Riverpod(keepAlive: true)
LogPathResolver logPathResolver(LogPathResolverRef ref) {
return LogPathResolver(
ref.watch(filesEditorServiceProvider).dirs.workingDir,
);
}

View File

@@ -0,0 +1,33 @@
// ignore_for_file: parameter_assignments
import 'package:dartx/dartx.dart';
import 'package:hiddify/features/log/model/log_entity.dart';
import 'package:hiddify/features/log/model/log_level.dart';
import 'package:tint/tint.dart';
abstract class LogParser {
static LogEntity parseSingbox(String log) {
log = log.strip();
DateTime? time;
if (log.length > 25) {
time = DateTime.tryParse(log.substring(6, 25));
}
if (time != null) {
log = log.substring(26);
}
final level = LogLevel.values.firstOrNullWhere(
(e) {
if (log.startsWith(e.name.toUpperCase())) {
log = log.removePrefix(e.name.toUpperCase());
return true;
}
return false;
},
);
return LogEntity(
level: level,
time: time,
message: log.trim(),
);
}
}

View File

@@ -0,0 +1,19 @@
import 'dart:io';
import 'package:path/path.dart' as p;
class LogPathResolver {
const LogPathResolver(this._workingDir);
final Directory _workingDir;
Directory get directory => _workingDir;
File coreFile() {
return File(p.join(directory.path, "box.log"));
}
File appFile() {
return File(p.join(directory.path, "app.log"));
}
}

View File

@@ -0,0 +1,70 @@
import 'package:fpdart/fpdart.dart';
import 'package:hiddify/data/repository/exception_handlers.dart';
import 'package:hiddify/features/log/data/log_parser.dart';
import 'package:hiddify/features/log/data/log_path_resolver.dart';
import 'package:hiddify/features/log/model/log_entity.dart';
import 'package:hiddify/features/log/model/log_failure.dart';
import 'package:hiddify/services/singbox/singbox_service.dart';
import 'package:hiddify/utils/custom_loggers.dart';
abstract interface class LogRepository {
TaskEither<LogFailure, Unit> init();
Stream<Either<LogFailure, List<LogEntity>>> watchLogs();
TaskEither<LogFailure, Unit> clearLogs();
}
class LogRepositoryImpl
with ExceptionHandler, InfraLogger
implements LogRepository {
LogRepositoryImpl({
required this.singbox,
required this.logPathResolver,
});
final SingboxService singbox;
final LogPathResolver logPathResolver;
@override
TaskEither<LogFailure, Unit> init() {
return exceptionHandler(
() async {
if (!await logPathResolver.directory.exists()) {
await logPathResolver.directory.create(recursive: true);
}
if (await logPathResolver.coreFile().exists()) {
await logPathResolver.coreFile().writeAsString("");
} else {
await logPathResolver.coreFile().create(recursive: true);
}
if (await logPathResolver.appFile().exists()) {
await logPathResolver.appFile().writeAsString("");
} else {
await logPathResolver.appFile().create(recursive: true);
}
return right(unit);
},
LogUnexpectedFailure.new,
);
}
@override
Stream<Either<LogFailure, List<LogEntity>>> watchLogs() {
return singbox
.watchLogs(logPathResolver.coreFile().path)
.map((event) => event.map(LogParser.parseSingbox).toList())
.handleExceptions(
(error, stackTrace) {
loggy.warning("error watching logs", error, stackTrace);
return LogFailure.unexpected(error, stackTrace);
},
);
}
@override
TaskEither<LogFailure, Unit> clearLogs() {
return exceptionHandler(
() => singbox.clearLogs().mapLeft(LogFailure.unexpected).run(),
LogFailure.unexpected,
);
}
}

View File

@@ -0,0 +1,13 @@
import 'package:freezed_annotation/freezed_annotation.dart';
import 'package:hiddify/features/log/model/log_level.dart';
part 'log_entity.freezed.dart';
@freezed
class LogEntity with _$LogEntity {
const factory LogEntity({
LogLevel? level,
DateTime? time,
required String message,
}) = _LogEntity;
}

View File

@@ -0,0 +1,25 @@
import 'package:freezed_annotation/freezed_annotation.dart';
import 'package:hiddify/core/prefs/locale_prefs.dart';
import 'package:hiddify/domain/failures.dart';
part 'log_failure.freezed.dart';
@freezed
sealed class LogFailure with _$LogFailure, Failure {
const LogFailure._();
const factory LogFailure.unexpected([
Object? error,
StackTrace? stackTrace,
]) = LogUnexpectedFailure;
@override
({String type, String? message}) present(TranslationsEn t) {
return switch (this) {
LogUnexpectedFailure() => (
type: "unexpected",
message: null,
),
};
}
}

View File

@@ -0,0 +1,25 @@
import 'package:dartx/dartx.dart';
import 'package:flutter/material.dart';
enum LogLevel {
trace,
debug,
info,
warn,
error,
fatal,
panic;
/// [LogLevel] selectable by user as preference
static List<LogLevel> get choices => values.takeFirst(4);
Color? get color => switch (this) {
trace => Colors.lightBlueAccent,
debug => Colors.grey,
info => Colors.lightGreen,
warn => Colors.orange,
error => Colors.redAccent,
fatal => Colors.red,
panic => Colors.red,
};
}

View File

@@ -1,21 +1,22 @@
import 'dart:async';
import 'package:hiddify/data/data_providers.dart';
import 'package:hiddify/domain/singbox/singbox.dart';
import 'package:hiddify/features/logs/notifier/logs_state.dart';
import 'package:hiddify/features/log/data/log_data_providers.dart';
import 'package:hiddify/features/log/model/log_entity.dart';
import 'package:hiddify/features/log/model/log_level.dart';
import 'package:hiddify/features/log/overview/logs_overview_state.dart';
import 'package:hiddify/utils/riverpod_utils.dart';
import 'package:hiddify/utils/utils.dart';
import 'package:riverpod_annotation/riverpod_annotation.dart';
import 'package:rxdart/rxdart.dart';
part 'logs_notifier.g.dart';
part 'logs_overview_notifier.g.dart';
@riverpod
class LogsNotifier extends _$LogsNotifier with AppLogger {
class LogsOverviewNotifier extends _$LogsOverviewNotifier with AppLogger {
@override
LogsState build() {
LogsOverviewState build() {
ref.disposeDelay(const Duration(seconds: 20));
state = const LogsState();
state = const LogsOverviewState();
ref.onDispose(
() {
loggy.debug("disposing");
@@ -41,7 +42,7 @@ class LogsNotifier extends _$LogsNotifier with AppLogger {
);
_addListeners();
return const LogsState();
return const LogsOverviewState();
}
StreamSubscription? _listener;
@@ -50,7 +51,8 @@ class LogsNotifier extends _$LogsNotifier with AppLogger {
loggy.debug("adding listeners");
await _listener?.cancel();
_listener = ref
.read(coreFacadeProvider)
.read(logRepositoryProvider)
.requireValue
.watchLogs()
.throttle(
(_) => Stream.value(_listener?.isPaused ?? false),
@@ -78,15 +80,14 @@ class LogsNotifier extends _$LogsNotifier with AppLogger {
).listen((event) {});
}
Iterable<String> _logs = [];
Iterable<LogEntity> _logs = [];
final _debouncer = CallbackDebouncer(const Duration(milliseconds: 200));
LogLevel? _levelFilter;
String _filter = "";
Future<List<BoxLog>> _computeLogs() async {
final logs = _logs.map(BoxLog.parse);
if (_levelFilter == null && _filter.isEmpty) return logs.toList();
return logs.where((e) {
Future<List<LogEntity>> _computeLogs() async {
if (_levelFilter == null && _filter.isEmpty) return _logs.toList();
return _logs.where((e) {
return (_filter.isEmpty || e.message.contains(_filter)) &&
(_levelFilter == null ||
e.level == null ||
@@ -108,7 +109,7 @@ class LogsNotifier extends _$LogsNotifier with AppLogger {
Future<void> clear() async {
loggy.debug("clearing");
await ref.read(coreFacadeProvider).clearLogs().match(
await ref.read(logRepositoryProvider).requireValue.clearLogs().match(
(l) {
loggy.warning("error clearing logs", l);
},

View File

@@ -5,25 +5,25 @@ import 'package:gap/gap.dart';
import 'package:hiddify/core/core_providers.dart';
import 'package:hiddify/core/prefs/prefs.dart';
import 'package:hiddify/domain/failures.dart';
import 'package:hiddify/domain/singbox/singbox.dart';
import 'package:hiddify/features/common/nested_app_bar.dart';
import 'package:hiddify/features/logs/notifier/notifier.dart';
import 'package:hiddify/services/service_providers.dart';
import 'package:hiddify/features/log/data/log_data_providers.dart';
import 'package:hiddify/features/log/model/log_level.dart';
import 'package:hiddify/features/log/overview/logs_overview_notifier.dart';
import 'package:hiddify/utils/utils.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:sliver_tools/sliver_tools.dart';
class LogsPage extends HookConsumerWidget with PresLogger {
const LogsPage({super.key});
class LogsOverviewPage extends HookConsumerWidget with PresLogger {
const LogsOverviewPage({super.key});
@override
Widget build(BuildContext context, WidgetRef ref) {
final t = ref.watch(translationsProvider);
final state = ref.watch(logsNotifierProvider);
final notifier = ref.watch(logsNotifierProvider.notifier);
final state = ref.watch(logsOverviewNotifierProvider);
final notifier = ref.watch(logsOverviewNotifierProvider.notifier);
final debug = ref.watch(debugModeNotifierProvider);
final filesEditor = ref.watch(filesEditorServiceProvider);
final pathResolver = ref.watch(logPathResolverProvider);
final filterController = useTextEditingController(text: state.filter);
@@ -33,8 +33,8 @@ class LogsPage extends HookConsumerWidget with PresLogger {
child: Text(t.logs.shareCoreLogs),
onTap: () async {
await UriUtils.tryShareOrLaunchFile(
Uri.parse(filesEditor.coreLogsFile.path),
fileOrDir: filesEditor.logsDir.uri,
Uri.parse(pathResolver.coreFile().path),
fileOrDir: pathResolver.directory.uri,
);
},
),
@@ -42,8 +42,8 @@ class LogsPage extends HookConsumerWidget with PresLogger {
child: Text(t.logs.shareAppLogs),
onTap: () async {
await UriUtils.tryShareOrLaunchFile(
Uri.parse(filesEditor.appLogsFile.path),
fileOrDir: filesEditor.logsDir.uri,
Uri.parse(pathResolver.appFile().path),
fileOrDir: pathResolver.directory.uri,
);
},
),

View File

@@ -0,0 +1,18 @@
import 'package:freezed_annotation/freezed_annotation.dart';
import 'package:hiddify/features/log/model/log_entity.dart';
import 'package:hiddify/features/log/model/log_level.dart';
import 'package:riverpod_annotation/riverpod_annotation.dart';
part 'logs_overview_state.freezed.dart';
@freezed
class LogsOverviewState with _$LogsOverviewState {
const LogsOverviewState._();
const factory LogsOverviewState({
@Default(AsyncLoading()) AsyncValue<List<LogEntity>> logs,
@Default(false) bool paused,
@Default("") String filter,
LogLevel? levelFilter,
}) = _LogsOverviewState;
}

View File

@@ -1,17 +0,0 @@
import 'package:freezed_annotation/freezed_annotation.dart';
import 'package:hiddify/domain/singbox/singbox.dart';
import 'package:riverpod_annotation/riverpod_annotation.dart';
part 'logs_state.freezed.dart';
@freezed
class LogsState with _$LogsState {
const LogsState._();
const factory LogsState({
@Default(AsyncLoading()) AsyncValue<List<BoxLog>> logs,
@Default(false) bool paused,
@Default("") String filter,
LogLevel? levelFilter,
}) = _LogsState;
}

View File

@@ -1,2 +0,0 @@
export 'logs_notifier.dart';
export 'logs_state.dart';

View File

@@ -1 +0,0 @@
export 'logs_page.dart';

View File

@@ -4,6 +4,7 @@ import 'package:gap/gap.dart';
import 'package:hiddify/core/core_providers.dart';
import 'package:hiddify/data/repository/config_options_store.dart';
import 'package:hiddify/domain/singbox/singbox.dart';
import 'package:hiddify/features/log/model/log_level.dart';
import 'package:hiddify/features/settings/widgets/widgets.dart';
import 'package:hiddify/utils/utils.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';

View File

@@ -41,7 +41,7 @@ class SystemTrayController extends _$SystemTrayController
final destinations = <(String label, String location)>[
(t.home.pageTitle, const HomeRoute().location),
(t.proxies.pageTitle, const ProxiesRoute().location),
(t.logs.pageTitle, const LogsRoute().location),
(t.logs.pageTitle, const LogsOverviewRoute().location),
(t.settings.pageTitle, const SettingsRoute().location),
(t.about.pageTitle, const AboutRoute().location),
];

View File

@@ -2,7 +2,6 @@ import 'dart:io';
import 'package:hiddify/services/platform_services.dart';
import 'package:hiddify/utils/utils.dart';
import 'package:path/path.dart' as p;
import 'package:path_provider/path_provider.dart';
typedef Directories = ({
@@ -19,10 +18,6 @@ class FilesEditorService with InfraLogger {
late final Directories dirs;
Directory get workingDir => dirs.workingDir;
Directory get logsDir => dirs.workingDir;
File get appLogsFile => File(p.join(logsDir.path, "app.log"));
File get coreLogsFile => File(p.join(logsDir.path, "box.log"));
Future<void> init() async {
dirs = await platformServices.getPaths().getOrElse(
@@ -40,18 +35,6 @@ class FilesEditorService with InfraLogger {
if (!await dirs.workingDir.exists()) {
await dirs.workingDir.create(recursive: true);
}
if (await appLogsFile.exists()) {
await appLogsFile.writeAsString("");
} else {
await appLogsFile.create(recursive: true);
}
if (await coreLogsFile.exists()) {
await coreLogsFile.writeAsString("");
} else {
await coreLogsFile.create(recursive: true);
}
}
static Future<Directory> getDatabaseDirectory() async {