Linter (#52)

* Add base Flutter dependencies

* Bump minimal android sdk version

* Increment and decrement with counter cubit & create main/app/locator structure

* create and implement domain layer

* Connection bluetooth avec le ganglion

* Create Flutter code structure example based on this [arch](https://github.com/PolyCortex/polydodo/wiki/Mobile-Architecture)

* Remove widget test specific to counter app

* Create an empty test for pipeline to perform build

* Create an empty test in order for build pipeline to pass

* fix mistake: move test/ under mobile/

* Requete de donnees et enregistrement sur csv

* Changement du format du fichier output pour openBCI

* Fixed some duplicates

* Finished updating bluetooth files. Missing csv feature

* Added recording feature

* Removed main2 temporary file

* Removed unecessary prints

* Extracted variable and renamed for clarity

* Removed unecessary imports and exposed methods in bluetooth interface

* Removed unecessary bluetooth from domain

* Created eeg data repository

* Changed string id to UniqueID, fixed state inconsistency

* Fixed typo, removed unecessary delay

* format

* Fixed typo

* Removed general export files in favor of individual import

* Added missing files for last commit

* Extracted openbci header and only adding it at export time

* Added error handling for failed connections

* Handling already connected error and cleaned slightly findCharacteristics

* Switched to generic acquisiton device in application layer

* Reverted merge with master

* Added handling for packet id 0 and fixed data values

* Returning Container in view instead of new ListView

* Remove default formatter for workspace because it prevents dartfmt to perform formating on dart files.

* Reset esbenp.prettier-vscode as default formatter, but specified dartfmt as dart formatter

* Changes based on last pull request comments (injecting flutter blue into repository, and small formatting changes)

* Changed Acquisition initialization method to more generic name instead of bluetooth

* Initial connection with usb serial achieved, missing data formatting

* Renamed serial port

* Moved back flutter instance into repository initialization and created
generic entity extending equatable with unique id

* Switched to AcquisitionDevice interface usage

* Seperated data formatting into stream transformer

* Implemented Cyton transformer

* Small convention changes and changed BaseTransformer to an abstract class

* Made async function into future

* Removed transformer interface

* Dynamically changing repositories and transformers

* Added missing file

* Fixed negative handling in cyton transformer and cleaned up a bit

* Added unit testing

* Awaiting stream in serial

* Added status check for Cyton

* Made exception parameter optional

* Using implicit variable type instead of string

* Added overrides for interface implemented methods

* Linter changes using pedantic

* Fixed error from list on data save

* Trying minimum iOS 11.0

* Added analysis option file for linter

* Fixed more linting issues, ignoring protos, added analyze to mobile workflow, added lint error to test workflow

* Fixed linting issue

Co-authored-by: Anes Belfodil <ans.belfodil@gmail.com>
Co-authored-by: William Harvey <william.harvey@polymtl.ca>

Author: 3 people

.github/workflows/mobile.yml

@@ -24,6 +24,8 @@ jobs:
 
       - run: flutter pub get
 
+      - run: flutter analyze
+
       - run: flutter test
 
       - run: flutter build apk

mobile/analysis_options.yaml

@@ -0,0 +1,9 @@
+include: package:pedantic/analysis_options.yaml
+
+analyzer:
+  exclude:
+    - lib/protos
+
+linter:
+  rules:
+    avoid_shadowing_type_parameters: false

mobile/ios/Flutter/AppFrameworkInfo.plist

@@ -21,6 +21,6 @@
   <key>CFBundleVersion</key>
   <string>1.0</string>
   <key>MinimumOSVersion</key>
-  <string>10.0</string>
+  <string>11.0</string>
 </dict>
 </plist>

mobile/ios/Runner.xcodeproj/project.pbxproj

@@ -272,7 +272,7 @@
 				GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
-				IPHONEOS_DEPLOYMENT_TARGET = 10.0;
+				IPHONEOS_DEPLOYMENT_TARGET = 11.0;
 				MTL_ENABLE_DEBUG_INFO = NO;
 				SDKROOT = iphoneos;
 				SUPPORTED_PLATFORMS = iphoneos;
@@ -354,7 +354,7 @@
 				GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
-				IPHONEOS_DEPLOYMENT_TARGET = 10.0;
+				IPHONEOS_DEPLOYMENT_TARGET = 11.0;
 				MTL_ENABLE_DEBUG_INFO = YES;
 				ONLY_ACTIVE_ARCH = YES;
 				SDKROOT = iphoneos;
@@ -403,7 +403,7 @@
 				GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
-				IPHONEOS_DEPLOYMENT_TARGET = 10.0;
+				IPHONEOS_DEPLOYMENT_TARGET = 11.0;
 				MTL_ENABLE_DEBUG_INFO = NO;
 				SDKROOT = iphoneos;
 				SUPPORTED_PLATFORMS = iphoneos;

mobile/lib/src/application/device/device_selector_cubit.dart

@@ -5,6 +5,7 @@ import 'package:flutter_bloc/flutter_bloc.dart';
 import 'package:polydodo/src/domain/acquisition_device/acquisition_device.dart';
 import 'package:polydodo/src/domain/acquisition_device/i_acquisition_device_repository.dart';
 import 'package:streaming_shared_preferences/streaming_shared_preferences.dart';
+import 'package:pedantic/pedantic.dart';
 import 'device_selector_state.dart';
 
 class DeviceSelectorCubit extends Cubit<DeviceState> {
@@ -21,13 +22,11 @@ class DeviceSelectorCubit extends Cubit<DeviceState> {
   void startSearching() {
     _deviceRepository.initializeRepository();
 
-    if (_acquisitionDeviceStream == null) {
-      _acquisitionDeviceStream = _deviceRepository
-          .watch()
-          .asBroadcastStream()
-          .listen((devices) => emit(DeviceSearchInProgress(devices)),
-              onError: (e) => emit(DeviceSearchFailure(e)));
-    }
+    _acquisitionDeviceStream ??= _deviceRepository
+        .watch()
+        .asBroadcastStream()
+        .listen((devices) => emit(DeviceSearchInProgress(devices)),
+            onError: (e) => emit(DeviceSearchFailure(e)));
   }
 
   Future<void> connect(AcquisitionDevice device) async {
@@ -53,11 +52,9 @@ class DeviceSelectorCubit extends Cubit<DeviceState> {
 
   // todo: change bluetooth preferences in the preference section of the app
   void swapBluetooth() async {
-    print("swap");
     usingBluetooth = !usingBluetooth;
-    StreamingSharedPreferences _prefs =
-        await StreamingSharedPreferences.instance;
+    var _prefs = await StreamingSharedPreferences.instance;
 
-    _prefs.setBool('using_bluetooth', usingBluetooth);
+    unawaited(_prefs.setBool('using_bluetooth', usingBluetooth));
   }
 }

mobile/lib/src/domain/unique_id.dart

@@ -16,5 +16,5 @@ class UniqueId extends Equatable {
   List<Object> get props => [_id];
 
   @override
-  toString() => _id;
+  String toString() => _id;
 }

mobile/lib/src/infrastructure/connection_repositories/acquisition_device_repository.dart

@@ -7,8 +7,8 @@ import 'package:polydodo/src/infrastructure/connection_repositories/serial_repos
 import 'package:streaming_shared_preferences/streaming_shared_preferences.dart';
 
 class AcquisitionDeviceRepository implements IAcquisitionDeviceRepository {
-  final BluetoothRepository _bluetoothRepository = new BluetoothRepository();
-  final SerialRepository _serialRepository = new SerialRepository();
+  final BluetoothRepository _bluetoothRepository = BluetoothRepository();
+  final SerialRepository _serialRepository = SerialRepository();
   IAcquisitionDeviceRepository _currentRepository;
 
   StreamSubscription _bluetoothStream;
@@ -20,9 +20,10 @@ class AcquisitionDeviceRepository implements IAcquisitionDeviceRepository {
 
   AcquisitionDeviceRepository() {
     _currentRepository = _serialRepository;
-    _acquisitionDeviceController = new StreamController();
+    _acquisitionDeviceController = StreamController();
   }
 
+  @override
   Future<void> initializeRepository() async {
     if (_preferences == null) {
       _preferences = await StreamingSharedPreferences.instance;
@@ -50,22 +51,27 @@ class AcquisitionDeviceRepository implements IAcquisitionDeviceRepository {
     }
   }
 
+  @override
   void connect(AcquisitionDevice device, Function(bool, Exception) callback) {
     _currentRepository.connect(device, callback);
   }
 
+  @override
   void disconnect() {
     _currentRepository.disconnect();
   }
 
+  @override
   Future<Stream<List<int>>> startDataStream() {
     return _currentRepository.startDataStream();
   }
 
+  @override
   void stopDataStream() {
     _currentRepository.stopDataStream();
   }
 
+  @override
   Stream<List<AcquisitionDevice>> watch() {
     return _acquisitionDeviceController.stream;
   }

mobile/lib/src/infrastructure/connection_repositories/bluetooth_repository.dart

@@ -5,11 +5,12 @@ import 'package:polydodo/src/domain/acquisition_device/acquisition_device.dart';
 import 'package:polydodo/src/domain/acquisition_device/i_acquisition_device_repository.dart';
 import 'package:polydodo/src/infrastructure/constants.dart';
 import 'package:polydodo/src/domain/unique_id.dart';
+import 'package:pedantic/pedantic.dart';
 
 class BluetoothRepository implements IAcquisitionDeviceRepository {
-  static const String BLE_SERVICE = "0000fe84-0000-1000-8000-00805f9b34fb";
-  static const String BLE_RECEIVE = "2d30c082-f39f-4ce6-923f-3484ea480596";
-  static const String BLE_SEND = "2d30c083-f39f-4ce6-923f-3484ea480596";
+  static const String BLE_SERVICE = '0000fe84-0000-1000-8000-00805f9b34fb';
+  static const String BLE_RECEIVE = '2d30c082-f39f-4ce6-923f-3484ea480596';
+  static const String BLE_SEND = '2d30c083-f39f-4ce6-923f-3484ea480596';
 
   AcquisitionDevice _selectedDevice;
   QualifiedCharacteristic _sendCharacteristic;
@@ -18,7 +19,7 @@ class BluetoothRepository implements IAcquisitionDeviceRepository {
   FlutterReactiveBle flutterReactiveBle;
   StreamSubscription<ConnectionStateUpdate> _connectedDeviceStream;
   StreamSubscription<DiscoveredDevice> _bluetoothScanSubscription;
-  List<AcquisitionDevice> _acquisitionDevicePersistency = [];
+  final List<AcquisitionDevice> _acquisitionDevicePersistency = [];
   final streamController = StreamController<List<AcquisitionDevice>>();
 
   @override
@@ -35,7 +36,7 @@ class BluetoothRepository implements IAcquisitionDeviceRepository {
   }
 
   void addDevice(DiscoveredDevice bluetoothDevice) {
-    AcquisitionDevice device = AcquisitionDevice(
+    var device = AcquisitionDevice(
         UniqueId.from(bluetoothDevice.id.toString()), bluetoothDevice.name);
 
     final idx = _acquisitionDevicePersistency.indexOf(device);
@@ -66,15 +67,15 @@ class BluetoothRepository implements IAcquisitionDeviceRepository {
         callback(true);
       } else if (event.connectionState == DeviceConnectionState.disconnected) {
         disconnect();
-        callback(false, Exception("Failed to connect to device"));
+        callback(false, Exception('Failed to connect to device'));
       }
     });
   }
 
   @override
-  void disconnect() async {
+  Future<void> disconnect() async {
     _selectedDevice = null;
-    _connectedDeviceStream?.cancel();
+    await _connectedDeviceStream?.cancel();
   }
 
   void setupCharacteristics() async {
@@ -95,8 +96,9 @@ class BluetoothRepository implements IAcquisitionDeviceRepository {
         deviceId: _selectedDevice.id.toString(),
         priority: ConnectionPriority.highPerformance);
 
-    flutterReactiveBle.writeCharacteristicWithoutResponse(_sendCharacteristic,
-        value: START_STREAM_CHAR.codeUnits);
+    unawaited(flutterReactiveBle.writeCharacteristicWithoutResponse(
+        _sendCharacteristic,
+        value: START_STREAM_CHAR.codeUnits));
 
     return flutterReactiveBle.subscribeToCharacteristic(_receiveCharacteristic);
   }
@@ -106,8 +108,9 @@ class BluetoothRepository implements IAcquisitionDeviceRepository {
     await flutterReactiveBle.requestConnectionPriority(
         deviceId: _selectedDevice.id.toString(),
         priority: ConnectionPriority.balanced);
-    flutterReactiveBle.writeCharacteristicWithoutResponse(_sendCharacteristic,
-        value: STOP_STREAM_CHAR.codeUnits);
+    unawaited(flutterReactiveBle.writeCharacteristicWithoutResponse(
+        _sendCharacteristic,
+        value: STOP_STREAM_CHAR.codeUnits));
   }
 
   @override

mobile/lib/src/infrastructure/connection_repositories/eeg_data_repository.dart

@@ -12,36 +12,36 @@ import 'package:polydodo/src/infrastructure/eeg_data_transformers/cytonTransform
 import 'package:polydodo/src/infrastructure/constants.dart';
 import 'package:polydodo/src/infrastructure/eeg_data_transformers/ganglionTransformer.dart';
 import 'package:streaming_shared_preferences/streaming_shared_preferences.dart';
+import 'package:pedantic/pedantic.dart';
 
 class EEGDataRepository implements IEEGDataRepository {
   EEGData _recordingData;
   BaseOpenBCITransformer<List<int>, List<dynamic>> currentStreamTransformer;
 
   final GanglionTransformer<List<int>, List> _ganglionTransformer =
-      new GanglionTransformer<List<int>, List>.broadcast();
+      GanglionTransformer<List<int>, List>.broadcast();
 
   final CytonTransformer<List<int>, List<dynamic>> _cytonTransformer =
-      new CytonTransformer<Uint8List, List>.broadcast();
+      CytonTransformer<Uint8List, List>.broadcast();
 
   BaseOpenBCITransformer<List<int>, List<dynamic>> _currentTransformer;
   StreamSubscription _currentTransformerStream;
 
   StreamingSharedPreferences _preferences;
 
+  @override
   void initialize() async {
-    if (_preferences == null) {
-      _preferences = await StreamingSharedPreferences.instance;
-    }
+    _preferences ??= await StreamingSharedPreferences.instance;
 
     _currentTransformer =
         _preferences.getBool('using_bluetooth', defaultValue: false).getValue()
             ? _ganglionTransformer
             : _cytonTransformer;
   }
 
+  @override
   void createRecordingFromStream(Stream<List<int>> stream) {
-    _recordingData =
-        EEGData(UniqueId.from(DateTime.now().toString()), List<List>());
+    _recordingData = EEGData(UniqueId.from(DateTime.now().toString()), [[]]);
 
     _currentTransformer.reset();
     _currentTransformerStream = stream
@@ -50,23 +50,27 @@ class EEGDataRepository implements IEEGDataRepository {
         .listen((data) => _recordingData.values.add(data));
   }
 
+  @override
   Future<void> stopRecordingFromStream() async {
     // todo: move save future to another file
-    _currentTransformerStream.cancel();
+    unawaited(_currentTransformerStream.cancel());
 
     final directory = await getExternalStorageDirectory();
     final pathOfTheFileToWrite =
-        directory.path + '/' + _recordingData.fileName + ".txt";
-    File file = File(pathOfTheFileToWrite);
-    List<List> fileContent = [];
+        directory.path + '/' + _recordingData.fileName + '.txt';
+    var file = File(pathOfTheFileToWrite);
+    var fileContent = [[]];
     //todo: dynamically change header when we change transformer
     fileContent.addAll(OPEN_BCI_CYTON_HEADER);
     fileContent.addAll(_recordingData.values);
-    String csv = const ListToCsvConverter().convert(fileContent);
+    var csv = const ListToCsvConverter().convert(fileContent);
     await file.writeAsString(csv);
   }
 
   // todo: implement export and import
+  @override
   void importData() {}
+
+  @override
   void exportData() {}
 }

mobile/lib/src/infrastructure/connection_repositories/serial_repository.dart

@@ -6,13 +6,14 @@ import 'package:polydodo/src/domain/acquisition_device/acquisition_device.dart';
 import 'package:polydodo/src/domain/acquisition_device/i_acquisition_device_repository.dart';
 import 'package:polydodo/src/infrastructure/constants.dart';
 import 'package:usb_serial/usb_serial.dart';
+import 'package:pedantic/pedantic.dart';
 
 class SerialRepository implements IAcquisitionDeviceRepository {
   UsbDevice _selectedDevice;
   UsbPort _serialPort;
-  List<AcquisitionDevice> _acquisitionDevicePersistency = [];
-  List<UsbDevice> _serialDevices = [];
   StreamSubscription _inputStreamSubscription;
+  final List<AcquisitionDevice> _acquisitionDevicePersistency = [];
+  final List<UsbDevice> _serialDevices = [];
   final streamController = StreamController<List<AcquisitionDevice>>();
 
   @override
@@ -23,8 +24,8 @@ class SerialRepository implements IAcquisitionDeviceRepository {
   }
 
   void addDevices(List<UsbDevice> serialDevices) {
-    for (UsbDevice serialDevice in serialDevices) {
-      AcquisitionDevice device = AcquisitionDevice(
+    for (var serialDevice in serialDevices) {
+      var device = AcquisitionDevice(
           UniqueId.from(serialDevice.deviceId.toString()),
           serialDevice.productName);
 
@@ -40,31 +41,31 @@ class SerialRepository implements IAcquisitionDeviceRepository {
     _selectedDevice =
         _serialDevices[_acquisitionDevicePersistency.indexOf(device)];
     _serialPort = await _selectedDevice.create();
-    bool openSuccessful = await _serialPort.open();
+    var openSuccessful = await _serialPort.open();
 
     if (!openSuccessful) {
-      callback(false, Exception("Could not open port"));
+      callback(false, Exception('Could not open port'));
     }
 
-    _serialPort.setPortParameters(
+    await _serialPort.setPortParameters(
         115200, UsbPort.DATABITS_8, UsbPort.STOPBITS_1, UsbPort.PARITY_NONE);
 
-    _checkCytonConnection(callback);
+    unawaited(_checkCytonConnection(callback));
   }
 
   Future<void> _checkCytonConnection(
       Function(bool, [Exception]) callback) async {
-    var status = "";
+    var status = '';
 
     _inputStreamSubscription = _serialPort.inputStream.listen((event) {
       status += String.fromCharCodes(event);
 
       if (isFullMessage(status)) {
         _inputStreamSubscription.cancel();
 
-        if (status == CYTON_SYSTEM_UP)
+        if (status == CYTON_SYSTEM_UP) {
           callback(true);
-        else {
+        } else {
           disconnect();
           callback(false, Exception(status));
         }
@@ -83,7 +84,7 @@ class SerialRepository implements IAcquisitionDeviceRepository {
   @override
   Future<void> disconnect() async {
     await _serialPort?.close();
-    _inputStreamSubscription?.cancel();
+    await _inputStreamSubscription?.cancel();
     _selectedDevice = null;
     _serialPort = null;
   }