GitHub Pipeline

.github/workflows/main.yml

@@ -0,0 +1,87 @@
+name: Flutter Workflow
+
+on:
+  push:
+    branches-ignore:
+      - main
+jobs:
+  # Check app for format and lint exceptions (fail fast)
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Install Flutter
+        uses: subosito/flutter-action@v2
+        with:
+          flutter-version: '3.3.0'
+          channel: 'stable'
+      - run: flutter --version
+      - run: make format
+      - run: make clean
+      - run: make lint
+  # Check code quality
+  code_quality:
+    needs: check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Install Flutter
+        uses: subosito/flutter-action@v2
+        with:
+          flutter-version: '3.3.0'
+          channel: 'stable'
+      - run: export PATH="$PATH":"$HOME/.pub-cache/bin"
+      - run: flutter pub global activate dart_code_metrics
+      - run: metrics lib -r codeclimate  > gh-code-quality-report.json
+      - name: Upload Code Quality Report
+        uses: actions/upload-artifact@v3
+        with:
+          name: gh-code-quality-report
+          path: gh-code-quality-report.json
+  # Run tests and report quality
+  test:
+    needs: check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Install Flutter
+        uses: subosito/flutter-action@v2
+        with:
+          flutter-version: '3.3.0'
+          channel: 'stable'
+      - run: export PATH="$PATH":"$HOME/.pub-cache/bin"
+      - run: flutter pub global activate junitreport
+      - run: flutter test --machine --coverage | tojunit -o report.xml
+      - name: Upload Report
+        uses: actions/upload-artifact@v3
+        with:
+          name: report
+          path: report.xml
+  # Build the app to check if release builds still work
+  apk:
+    needs: [check, test, code_quality]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Setup Java  
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'zulu'
+          java-version: '11'
+      - name: Install Flutter
+        uses: subosito/flutter-action@v2
+        with:
+          flutter-version: '3.3.0'
+          channel: 'stable'
+      - run: make build-android-apk
+      - name: 'Upload APK'
+        uses: actions/upload-artifact@v3
+        with:
+          name: apk
+          path: build-output/app.apk
+          retention-days: 2
+

.gitignore

@@ -42,3 +42,6 @@ app.*.map.json
 /android/app/debug
 /android/app/profile
 /android/app/release
+
+
+.build-output

lib/main.dart

@@ -1,13 +1,17 @@
 import 'package:counter_workshop/src/app.dart';
+import 'package:counter_workshop/src/core/logger/app_logger.dart';
 import 'package:counter_workshop/src/features/counter/data/datasources/remote/src/mock/counter_fake.api.dart';
 import 'package:counter_workshop/src/features/counter/data/repositories/counter.repository.dart';
 import 'package:flutter/material.dart';
 import 'package:intl/intl.dart';
 import 'package:intl/intl_standalone.dart' if (dart.library.html) 'package:intl/intl_browser.dart';
+import 'package:logging/logging.dart';
 
 Future<void> main() async {
   Intl.systemLocale = await findSystemLocale();
+  AppLogger(level: Level.WARNING);
   final CounterRepository counterRepository = CounterRepository(counterApi: CounterFakeApi());
+
   runApp(
     App(
       counterRepository: counterRepository,

lib/src/core/logger/app_logger.dart

@@ -0,0 +1,26 @@
+import 'package:counter_workshop/src/core/logger/appenders.dart';
+import 'package:counter_workshop/src/core/logger/log_formatters.dart';
+import 'package:flutter/foundation.dart';
+import 'package:logging/logging.dart';
+
+final appLogger = Logger('CounterWorkshop');
+
+class AppLogger {
+  // ignore: unused_field
+  static late AppLogger _singleton;
+
+  factory AppLogger({Level level = Level.ALL}) => _singleton = AppLogger._initLogger(level);
+
+  AppLogger._initLogger(Level level) {
+    recordStackTraceAtLevel = level;
+    appLogger.info('App Started');
+    if (kDebugMode) {
+      ConsoleLogAppender(formatter: const ConsoleLogFormatter()).attachToLogger(Logger.root);
+      FileLogAppender(formatter: const FileLogFormatter()).attachToLogger(Logger.root);
+    }
+
+    if (kReleaseMode) {
+      FileLogAppender(formatter: const FileLogFormatter()).attachToLogger(Logger.root);
+    }
+  }
+}

lib/src/core/logger/appenders.dart

@@ -0,0 +1,50 @@
+import 'dart:developer';
+
+import 'package:counter_workshop/src/core/logger/log_formatters.dart';
+import 'package:logging/logging.dart';
+import 'package:logging_appenders/logging_appenders.dart';
+
+class ConsoleLogAppender extends BaseLogAppender {
+  void Function(Object line)? printer;
+
+  ConsoleLogAppender({LogRecordFormatter? formatter}) : super(formatter ?? defaultDebugConsoleLogFormatter());
+
+  ConsoleLogAppender setupLogging({Level level = Level.ALL, Level stderrLevel = Level.OFF}) {
+    Logger.root.clearListeners();
+    Logger.root.level = level;
+
+    return defaultLogAppender(stderrLevel: stderrLevel)..attachToLogger(Logger.root);
+  }
+
+  @override
+  void handle(LogRecord record) {
+    log(formatter.format(record));
+  }
+}
+
+ConsoleLogAppender defaultLogAppender({LogRecordFormatter? formatter, Level? stderrLevel}) {
+  return ConsoleLogAppender(formatter: formatter);
+}
+
+class FileLogAppender extends RotatingFileAppender {
+  void Function(Object line)? printer;
+
+  FileLogAppender({LogRecordFormatter? formatter})
+      : super(baseFilePath: '/counter_workshop_logs', formatter: formatter);
+
+  FileLogAppender setupLogging({Level level = Level.ALL, Level stderrLevel = Level.OFF}) {
+    Logger.root.clearListeners();
+    Logger.root.level = level;
+
+    return fileLogAppender(stderrLevel: stderrLevel)..attachToLogger(Logger.root);
+  }
+
+  @override
+  void handle(LogRecord record) {
+    //log(formatter.format(record));
+  }
+}
+
+FileLogAppender fileLogAppender({LogRecordFormatter? formatter, Level? stderrLevel}) {
+  return FileLogAppender(formatter: formatter);
+}

lib/src/core/logger/log_formatters.dart

@@ -0,0 +1,84 @@
+import 'package:logging/logging.dart';
+import 'package:logging_appenders/logging_appenders.dart';
+
+LogRecordFormatter defaultDebugConsoleLogFormatter() => const DefaultLogRecordFormatter();
+
+LogRecordFormatter defaultFileLogFormatter() => const DefaultLogRecordFormatter();
+
+class ConsoleLogFormatter extends LogRecordFormatter {
+  const ConsoleLogFormatter();
+
+  @override
+  StringBuffer formatToStringBuffer(LogRecord rec, StringBuffer sb) {
+    String outputColor = FormatterHelper.defineOutputColor(rec.level);
+    sb.write(
+      '$outputColor [${rec.time}] [${rec.level.name}] [${rec.zone}] '
+      '[${rec.loggerName}] - \x1B[34m${rec.message}',
+    );
+
+    if (rec.error != null) {
+      sb.writeln();
+      sb.write('### ${rec.error?.runtimeType}: ');
+      sb.write(rec.error);
+    }
+    final stackTrace = rec.stackTrace ?? (rec.error is Error ? (rec.error as Error).stackTrace : null);
+    if (stackTrace != null) {
+      sb.writeln();
+      sb.write(stackTrace);
+    }
+    sb.write('\x1B[0m');
+    return sb;
+  }
+}
+
+class FileLogFormatter extends LogRecordFormatter {
+  const FileLogFormatter();
+
+  @override
+  StringBuffer formatToStringBuffer(LogRecord rec, StringBuffer sb) {
+    sb.write(
+      '[${rec.time}] [${rec.level.name}] [${rec.zone}] '
+      '[${rec.loggerName}] - ${rec.message}',
+    );
+
+    if (rec.error != null) {
+      sb.writeln();
+      sb.write('### ${rec.error?.runtimeType}: ');
+      sb.write(rec.error);
+    }
+    final stackTrace = rec.stackTrace ?? (rec.error is Error ? (rec.error as Error).stackTrace : null);
+    if (stackTrace != null) {
+      sb.writeln();
+      sb.write(stackTrace);
+    }
+    return sb;
+  }
+}
+
+class FormatterHelper {
+  FormatterHelper._();
+
+  static String defineOutputColor(Level level) {
+    String outputColor = '';
+    switch (level.name) {
+      case 'ALL':
+      case 'FINEST':
+      case 'FINER':
+      case 'FINE':
+      case 'CONFIG':
+        outputColor = '\x1B[37m';
+        break;
+      case 'INFO':
+      case 'WARNING':
+        outputColor = '\x1B[33m';
+        break;
+      case 'SEVERE':
+      case 'SHOUT':
+        outputColor = '\x1B[31m';
+        break;
+      default:
+        outputColor = '\x1B[37m';
+    }
+    return outputColor;
+  }
+}

lib/src/core/routing/router.dart

@@ -6,7 +6,7 @@ import 'package:go_router/go_router.dart';
 
 final router = GoRouter(
   urlPathStrategy: UrlPathStrategy.path,
-  debugLogDiagnostics: true,
+  debugLogDiagnostics: false, // Logs werden durch den Logger übernommen
   initialLocation: '/counters',
   routes: [
     GoRoute(

lib/src/features/counter/data/repositories/counter.repository.dart

@@ -1,11 +1,11 @@
 import 'dart:async';
 
+import 'package:counter_workshop/src/core/logger/app_logger.dart';
 import 'package:counter_workshop/src/features/counter/data/datasources/remote/converters/counter_request.converter.dart';
 import 'package:counter_workshop/src/features/counter/data/datasources/remote/counter.api.dart';
 import 'package:counter_workshop/src/features/counter/data/datasources/remote/converters/counter_response.converter.dart';
 import 'package:counter_workshop/src/features/counter/data/datasources/remote/dtos/counter_response.dto.dart';
 import 'package:counter_workshop/src/features/counter/domain/model/counter.model.dart';
-import 'dart:developer';
 
 import 'package:counter_workshop/src/features/counter/domain/repository/counter.repository_interface.dart';
 
@@ -16,7 +16,7 @@ class CounterRepository implements CounterRepositoryInterface {
 
   @override
   Future<List<CounterModel>> getCounterList() async {
-    log('retriving counter list');
+    appLogger.info('retriving counter list');
     final List<CounterResponseDto> response = await counterApi.fetchAll();
 
     // map result to model
@@ -33,7 +33,7 @@ class CounterRepository implements CounterRepositoryInterface {
 
   @override
   Future<CounterModel> createCounter({required CounterModel counterModel}) async {
-    log('creating new counter with name ${counterModel.name}');
+    appLogger.info('creating new counter with name ${counterModel.name}');
 
     // map model to dto
     final dto = CounterRequestConverter().toDto(counterModel);
@@ -47,7 +47,7 @@ class CounterRepository implements CounterRepositoryInterface {
 
   @override
   Future<void> updateCounter({required String id, required CounterModel counterModel}) async {
-    log('updating counter: $id with value: $counterModel');
+    appLogger.info('updating counter: $id with value: $counterModel');
 
     // map model to dto
     final dto = CounterResponseConverter().toDto(counterModel);
@@ -58,7 +58,7 @@ class CounterRepository implements CounterRepositoryInterface {
 
   @override
   Future<void> deleteCounter({required String id}) async {
-    log('deleting counter: $id');
+    appLogger.info('deleting counter: $id');
     await counterApi.deleteCounter(id);
   }
 }

lib/src/features/counter/presentation/edit/bloc/edit_counter.bloc.dart

@@ -1,9 +1,8 @@
 import 'dart:async';
-
+import 'package:counter_workshop/src/core/logger/app_logger.dart';
 import 'package:counter_workshop/src/features/counter/data/repositories/counter.repository.dart';
 import 'package:counter_workshop/src/features/counter/presentation/edit/bloc/edit_counter.event.dart';
 import 'package:counter_workshop/src/features/counter/presentation/edit/bloc/edit_counter.state.dart';
-import 'package:flutter/foundation.dart';
 import 'package:flutter_bloc/flutter_bloc.dart';
 
 class EditCounterBloc extends Bloc<EditCounterEvent, EditCounterState> {
@@ -26,14 +25,14 @@ class EditCounterBloc extends Bloc<EditCounterEvent, EditCounterState> {
   }
 
   Future<void> _onIncrement(CounterIncrementPressed event, Emitter<EditCounterState> emit) async {
-    debugPrint('INCREMENT: ${event.counterModel.toString()}');
+    appLogger.info('INCREMENT: ${event.counterModel.toString()}');
     final newCounterModel = event.counterModel.copyWith(value: event.counterModel.value + 1);
     emit(EditCounterData(newCounterModel));
     await counterRepository.updateCounter(id: event.counterModel.id, counterModel: newCounterModel);
   }
 
   Future<void> _onDecrement(CounterDecrementPressed event, Emitter<EditCounterState> emit) async {
-    debugPrint('DECREMENT: ${event.counterModel.toString()}');
+    appLogger.info('DECREMENT: ${event.counterModel.toString()}');
 
     if (event.counterModel.value == 0) {
       return;

lib/src/features/counter/presentation/edit/view/edit_counter.page.dart

@@ -1,5 +1,4 @@
-import 'dart:developer';
-
+import 'package:counter_workshop/src/core/logger/app_logger.dart';
 import 'package:counter_workshop/src/core/widgets/custom_loading_indicator.widget.dart';
 import 'package:counter_workshop/src/core/widgets/error_message.widget.dart';
 import 'package:counter_workshop/src/features/counter/data/repositories/counter.repository.dart';
@@ -65,7 +64,7 @@ class CounterView extends StatelessWidget {
         listener: (context, state) {
           if (state is EditCounterData) {
             // Calling DashboardBloc (MasterPage) from EditCounterBloc (DetailPage)
-            log('EditBlocListener: ${state.counterModel.value}');
+            appLogger.info('EditBlocListener: ${state.counterModel.value}');
             final dashboardBloc = context.read<DashboardBloc>();
             dashboardBloc.add(FetchCounterList());
           }