From b9dedef29263b5b1de3cac307aa36897e2f5329b Mon Sep 17 00:00:00 2001 From: Dennis Guse Date: Thu, 29 Dec 2022 01:05:58 +0100 Subject: [PATCH] Refactor: introduced SensorManager. --- .../io/file/importer/ExportImportTest.java | 8 +- .../TrackRecordingServiceTestRecording.java | 37 ++++---- .../TrackRecordingServiceTestUtils.java | 14 --- .../sensors/BluetoothRemoteSensorManager.java | 8 +- .../opentracks/sensors/SensorManager.java | 85 +++++++++++++++++++ .../services/TrackRecordingService.java | 3 +- .../services/handlers/TrackPointCreator.java | 71 +++------------- 7 files changed, 123 insertions(+), 103 deletions(-) create mode 100644 src/main/java/de/dennisguse/opentracks/sensors/SensorManager.java diff --git a/src/androidTest/java/de/dennisguse/opentracks/io/file/importer/ExportImportTest.java b/src/androidTest/java/de/dennisguse/opentracks/io/file/importer/ExportImportTest.java index df0810d0d..81a865605 100644 --- a/src/androidTest/java/de/dennisguse/opentracks/io/file/importer/ExportImportTest.java +++ b/src/androidTest/java/de/dennisguse/opentracks/io/file/importer/ExportImportTest.java @@ -166,7 +166,7 @@ public class ExportImportTest { trackPointCreator.setClock("2020-02-02T02:02:18Z"); BluetoothRemoteSensorManager mockRemoteSensorManager = Mockito.mock(BluetoothRemoteSensorManager.class); - trackPointCreator.setRemoteSensorManager(mockRemoteSensorManager); + trackPointCreator.getSensorManager().setBluetoothSensorManager(mockRemoteSensorManager); service.endCurrentTrack(); trackPointCreator.setClock("2020-02-02T02:03:20Z"); @@ -179,7 +179,7 @@ public class ExportImportTest { sendLocation(trackPointCreator, "2020-02-02T02:03:23Z", 3, 16.001, 10, 27, 15, 10, 0); trackPointCreator.setClock("2020-02-02T02:03:24Z"); - trackPointCreator.setRemoteSensorManager(mockRemoteSensorManager); + trackPointCreator.getSensorManager().setBluetoothSensorManager(mockRemoteSensorManager); service.endCurrentTrack(); Track track = contentProviderUtils.getTrack(trackId); @@ -521,12 +521,12 @@ public class ExportImportTest { sensorDataSet.fillTrackPoint(trackPoint); return sensorDataSet; }); - trackPointCreator.setRemoteSensorManager(remoteSensorManager); + trackPointCreator.getSensorManager().setBluetoothSensorManager(remoteSensorManager); trackPointCreator.onChange(new SensorDataSet()); } private void mockAltitudeChange(TrackPointCreator trackPointCreator, float altitudeGain) { - AltitudeSumManager altitudeSumManager = trackPointCreator.getAltitudeSumManager(); + AltitudeSumManager altitudeSumManager = trackPointCreator.getSensorManager().getAltitudeSumManager(); altitudeSumManager.setAltitudeGain_m(altitudeGain); altitudeSumManager.setAltitudeLoss_m(altitudeGain); } diff --git a/src/androidTest/java/de/dennisguse/opentracks/services/TrackRecordingServiceTestRecording.java b/src/androidTest/java/de/dennisguse/opentracks/services/TrackRecordingServiceTestRecording.java index 3901a9342..4bd0c580d 100644 --- a/src/androidTest/java/de/dennisguse/opentracks/services/TrackRecordingServiceTestRecording.java +++ b/src/androidTest/java/de/dennisguse/opentracks/services/TrackRecordingServiceTestRecording.java @@ -45,6 +45,8 @@ import de.dennisguse.opentracks.stats.TrackStatistics; /** * Tests insert location. + * Note: on API23, the TrackRecordingService may not be stopped properly before the next test. + * So, if something fails, subsequent tests may be affected. */ @RunWith(AndroidJUnit4.class) public class TrackRecordingServiceTestRecording { @@ -112,7 +114,7 @@ public class TrackRecordingServiceTestRecording { String startTime = "2020-02-02T02:02:02Z"; trackPointCreator.setClock(startTime); Track.Id trackId = service.startNewTrack(); - trackPointCreator.setAltitudeSumManager(altitudeSumManager); + trackPointCreator.getSensorManager().setAltitudeSumManager(altitudeSumManager); // then assertEquals(new TrackStatistics(startTime, startTime, 0, 0, 0, 0, null, null) @@ -149,7 +151,7 @@ public class TrackRecordingServiceTestRecording { trackPointCreator.setClock(startTime); Track.Id trackId = service.startNewTrack(); - trackPointCreator.setAltitudeSumManager(altitudeSumManager); + trackPointCreator.getSensorManager().setAltitudeSumManager(altitudeSumManager); // when String pauseTime = "2020-02-02T02:02:03Z"; @@ -195,7 +197,7 @@ public class TrackRecordingServiceTestRecording { String starTime = "2020-02-02T02:02:02Z"; trackPointCreator.setClock(starTime); Track.Id trackId = service.startNewTrack(); - trackPointCreator.setAltitudeSumManager(altitudeSumManager); + trackPointCreator.getSensorManager().setAltitudeSumManager(altitudeSumManager); String pauseTime = "2020-02-02T02:02:03Z"; trackPointCreator.setClock(pauseTime); @@ -227,7 +229,7 @@ public class TrackRecordingServiceTestRecording { trackPointCreator.setClock(startTime); Track.Id trackId = service.startNewTrack(); - trackPointCreator.setAltitudeSumManager(altitudeSumManager); + trackPointCreator.getSensorManager().setAltitudeSumManager(altitudeSumManager); String stopTime = "2020-02-02T02:02:03Z"; trackPointCreator.setClock(stopTime); @@ -237,7 +239,7 @@ public class TrackRecordingServiceTestRecording { String resumeTime = "2020-02-02T02:02:04Z"; trackPointCreator.setClock(resumeTime); service.resumeTrack(trackId); - trackPointCreator.setAltitudeSumManager(altitudeSumManager); + trackPointCreator.getSensorManager().setAltitudeSumManager(altitudeSumManager); // then new TrackPointAssert().assertEquals(List.of( @@ -258,12 +260,13 @@ public class TrackRecordingServiceTestRecording { trackPointCreator.setClock(startTime); Track.Id trackId = service.startNewTrack(); - trackPointCreator.setAltitudeSumManager(altitudeSumManager); - BluetoothRemoteSensorManager remoteSensorManager = trackPointCreator.getRemoteSensorManager(); + trackPointCreator.getSensorManager().setAltitudeSumManager(altitudeSumManager); + BluetoothRemoteSensorManager remoteSensorManager = trackPointCreator.getSensorManager().getBluetoothSensorManager(); // when String sensor1 = "2020-02-02T02:02:03Z"; trackPointCreator.setClock(sensor1); + remoteSensorManager.onChanged(new SensorDataHeartRate("", "", HeartRate.of(5))); //Should be ignored String sensor3 = "2020-02-02T02:02:13Z"; @@ -297,7 +300,7 @@ public class TrackRecordingServiceTestRecording { TrackPointCreator trackPointCreator = service.getTrackPointCreator(); trackPointCreator.setClock(startTime); Track.Id trackId = service.startNewTrack(); - trackPointCreator.setAltitudeSumManager(altitudeSumManager); + trackPointCreator.getSensorManager().setAltitudeSumManager(altitudeSumManager); // when @@ -371,7 +374,7 @@ public class TrackRecordingServiceTestRecording { TrackPointCreator trackPointCreator = service.getTrackPointCreator(); trackPointCreator.setClock(startTime); Track.Id trackId = service.startNewTrack(); - trackPointCreator.setAltitudeSumManager(altitudeSumManager); + trackPointCreator.getSensorManager().setAltitudeSumManager(altitudeSumManager); // when String gps1 = "2020-02-02T02:02:03Z"; @@ -436,7 +439,7 @@ public class TrackRecordingServiceTestRecording { TrackPointCreator trackPointCreator = service.getTrackPointCreator(); trackPointCreator.setClock(startTime); Track.Id trackId = service.startNewTrack(); - trackPointCreator.setAltitudeSumManager(altitudeSumManager); + trackPointCreator.getSensorManager().setAltitudeSumManager(altitudeSumManager); // when String gps1 = "2020-02-02T02:02:03Z"; @@ -500,7 +503,7 @@ public class TrackRecordingServiceTestRecording { TrackPointCreator trackPointCreator = service.getTrackPointCreator(); trackPointCreator.setClock(startTime); Track.Id trackId = service.startNewTrack(); - trackPointCreator.setAltitudeSumManager(altitudeSumManager); + trackPointCreator.getSensorManager().setAltitudeSumManager(altitudeSumManager); // when String gps1 = "2020-02-02T02:02:03Z"; @@ -564,7 +567,7 @@ public class TrackRecordingServiceTestRecording { TrackPointCreator trackPointCreator = service.getTrackPointCreator(); trackPointCreator.setClock(startTime); Track.Id trackId = service.startNewTrack(); - trackPointCreator.setAltitudeSumManager(altitudeSumManager); + trackPointCreator.getSensorManager().setAltitudeSumManager(altitudeSumManager); // when String gps1 = "2020-02-02T02:02:03Z"; @@ -652,7 +655,7 @@ public class TrackRecordingServiceTestRecording { TrackPointCreator trackPointCreator = service.getTrackPointCreator(); trackPointCreator.setClock(startTime); Track.Id trackId = service.startNewTrack(); - trackPointCreator.setAltitudeSumManager(altitudeSumManager); + trackPointCreator.getSensorManager().setAltitudeSumManager(altitudeSumManager); // when String gps1 = "2020-02-02T02:02:03Z"; @@ -702,7 +705,7 @@ public class TrackRecordingServiceTestRecording { TrackPointCreator trackPointCreator = service.getTrackPointCreator(); trackPointCreator.setClock(startTime); Track.Id trackId = service.startNewTrack(); - trackPointCreator.setAltitudeSumManager(altitudeSumManager); + trackPointCreator.getSensorManager().setAltitudeSumManager(altitudeSumManager); // when String gps1 = "2020-02-02T02:02:03Z"; @@ -748,7 +751,7 @@ public class TrackRecordingServiceTestRecording { TrackPointCreator trackPointCreator = service.getTrackPointCreator(); trackPointCreator.setClock(startTime); Track.Id trackId = service.startNewTrack(); - trackPointCreator.setAltitudeSumManager(altitudeSumManager); + trackPointCreator.getSensorManager().setAltitudeSumManager(altitudeSumManager); // when String gps1 = "2020-02-02T02:02:03Z"; @@ -812,8 +815,8 @@ public class TrackRecordingServiceTestRecording { TrackPointCreator trackPointCreator = service.getTrackPointCreator(); trackPointCreator.setClock(startTime); Track.Id trackId = service.startNewTrack(); - trackPointCreator.setAltitudeSumManager(altitudeSumManager); - BluetoothRemoteSensorManager remoteSensorManager = trackPointCreator.getRemoteSensorManager(); + trackPointCreator.getSensorManager().setAltitudeSumManager(altitudeSumManager); + BluetoothRemoteSensorManager remoteSensorManager = trackPointCreator.getSensorManager().getBluetoothSensorManager(); // when String sensor1 = "2020-02-02T02:02:03Z"; diff --git a/src/androidTest/java/de/dennisguse/opentracks/services/TrackRecordingServiceTestUtils.java b/src/androidTest/java/de/dennisguse/opentracks/services/TrackRecordingServiceTestUtils.java index e03053f37..214f152db 100644 --- a/src/androidTest/java/de/dennisguse/opentracks/services/TrackRecordingServiceTestUtils.java +++ b/src/androidTest/java/de/dennisguse/opentracks/services/TrackRecordingServiceTestUtils.java @@ -1,17 +1,12 @@ package de.dennisguse.opentracks.services; import android.content.Context; -import android.content.Intent; import android.location.Location; import androidx.test.rule.ServiceTestRule; -import org.mockito.Mockito; - -import java.time.Clock; import java.util.concurrent.TimeoutException; -import de.dennisguse.opentracks.sensors.BluetoothRemoteSensorManager; import de.dennisguse.opentracks.services.handlers.TrackPointCreator; import de.dennisguse.opentracks.settings.PreferencesUtils; @@ -24,15 +19,6 @@ public class TrackRecordingServiceTestUtils { public static void resetService(ServiceTestRule mServiceRule, Context context) throws TimeoutException { // Let's use default values. PreferencesUtils.clear(); - - // Reset service (if some previous test failed) - TrackRecordingService service = ((TrackRecordingService.Binder) mServiceRule.bindService(new Intent(context, TrackRecordingService.class))) - .getService(); - - BluetoothRemoteSensorManager remoteSensorManager = Mockito.mock(BluetoothRemoteSensorManager.class); - service.getTrackPointCreator().setRemoteSensorManager(remoteSensorManager); - service.getTrackPointCreator().setClock(Clock.systemUTC()); - service.endCurrentTrack(); } static void sendGPSLocation(TrackPointCreator trackPointCreator, String time, double latitude, double longitude, float accuracy, long speed) { diff --git a/src/main/java/de/dennisguse/opentracks/sensors/BluetoothRemoteSensorManager.java b/src/main/java/de/dennisguse/opentracks/sensors/BluetoothRemoteSensorManager.java index 95b5b1b17..2711aa1bf 100644 --- a/src/main/java/de/dennisguse/opentracks/sensors/BluetoothRemoteSensorManager.java +++ b/src/main/java/de/dennisguse/opentracks/sensors/BluetoothRemoteSensorManager.java @@ -73,7 +73,7 @@ public class BluetoothRemoteSensorManager implements SensorConnector, AbstractBl private final SensorDataSet sensorDataSet = new SensorDataSet(); - private final SensorDataSetChangeObserver observer; + private final SensorManager.SensorDataSetChangeObserver observer; private final SharedPreferences.OnSharedPreferenceChangeListener sharedPreferenceChangeListener = new SharedPreferences.OnSharedPreferenceChangeListener() { @Override @@ -114,7 +114,7 @@ public class BluetoothRemoteSensorManager implements SensorConnector, AbstractBl } }; - public BluetoothRemoteSensorManager(@NonNull Context context, @NonNull Handler handler, @NonNull SensorDataSetChangeObserver observer) { + public BluetoothRemoteSensorManager(@NonNull Context context, @NonNull Handler handler, @NonNull SensorManager.SensorDataSetChangeObserver observer) { this.context = context; this.handler = handler; this.observer = observer; @@ -232,8 +232,4 @@ public class BluetoothRemoteSensorManager implements SensorConnector, AbstractBl public Handler getHandler() { return handler; } - - public interface SensorDataSetChangeObserver { - void onChange(SensorDataSet sensorDataSet); - } } diff --git a/src/main/java/de/dennisguse/opentracks/sensors/SensorManager.java b/src/main/java/de/dennisguse/opentracks/sensors/SensorManager.java new file mode 100644 index 000000000..bf8e82d08 --- /dev/null +++ b/src/main/java/de/dennisguse/opentracks/sensors/SensorManager.java @@ -0,0 +1,85 @@ +package de.dennisguse.opentracks.sensors; + +import android.content.Context; +import android.os.Handler; +import android.util.Log; + +import androidx.annotation.VisibleForTesting; + +import de.dennisguse.opentracks.data.models.TrackPoint; +import de.dennisguse.opentracks.sensors.sensorData.SensorData; +import de.dennisguse.opentracks.sensors.sensorData.SensorDataSet; + +public class SensorManager { + + private static final String TAG = SensorManager.class.getSimpleName(); + + private BluetoothRemoteSensorManager bluetoothSensorManager; + + private AltitudeSumManager altitudeSumManager; + + public SensorManager(Context context, Handler handler, SensorDataSetChangeObserver observer) { + bluetoothSensorManager = new BluetoothRemoteSensorManager(context, handler, observer); + altitudeSumManager = new AltitudeSumManager(); + } + + public void start(Context context, Handler handler) { + bluetoothSensorManager.start(context, handler); + altitudeSumManager.start(context, handler); + } + + public void stop(Context context) { + if (bluetoothSensorManager != null) { + bluetoothSensorManager.stop(context); + bluetoothSensorManager = null; + } + + if (altitudeSumManager != null) { + altitudeSumManager.stop(context); + altitudeSumManager = null; + } + } + + public SensorDataSet fill(TrackPoint trackPoint) { + altitudeSumManager.fill(trackPoint); + return bluetoothSensorManager.fill(trackPoint); + } + + public void reset() { + if (bluetoothSensorManager == null || altitudeSumManager == null) { + Log.d(TAG, "No recording running and no reset necessary."); + return; + } + bluetoothSensorManager.reset(); + altitudeSumManager.reset(); + } + + @Deprecated + @VisibleForTesting + public BluetoothRemoteSensorManager getBluetoothSensorManager() { + return bluetoothSensorManager; + } + + @Deprecated + @VisibleForTesting + public void setBluetoothSensorManager(BluetoothRemoteSensorManager remoteSensorManager) { + this.bluetoothSensorManager = remoteSensorManager; + } + + @Deprecated + @VisibleForTesting + public AltitudeSumManager getAltitudeSumManager() { + return altitudeSumManager; + } + + @Deprecated + @VisibleForTesting + public void setAltitudeSumManager(AltitudeSumManager altitudeSumManager) { + this.altitudeSumManager = altitudeSumManager; + } + + @Deprecated + public interface SensorDataSetChangeObserver { + void onChange(SensorDataSet sensorDataSet); + } +} diff --git a/src/main/java/de/dennisguse/opentracks/services/TrackRecordingService.java b/src/main/java/de/dennisguse/opentracks/services/TrackRecordingService.java index f0ee43184..1cef8f6ab 100644 --- a/src/main/java/de/dennisguse/opentracks/services/TrackRecordingService.java +++ b/src/main/java/de/dennisguse/opentracks/services/TrackRecordingService.java @@ -111,7 +111,7 @@ public class TrackRecordingService extends Service implements TrackPointCreator. egm2008CorrectionManager = new EGM2008CorrectionManager(); trackRecordingManager = new TrackRecordingManager(this); trackRecordingManager.start(); - trackPointCreator = new TrackPointCreator(this); + trackPointCreator = new TrackPointCreator(this, this, handler); voiceAnnouncementManager = new VoiceAnnouncementManager(this); notificationManager = new TrackRecordingServiceNotificationManager(this); @@ -177,7 +177,6 @@ public class TrackRecordingService extends Service implements TrackPointCreator. } public void resumeTrack(Track.Id trackId) { - trackPointCreator.reset(); if (!trackRecordingManager.resumeExistingTrack(trackId, trackPointCreator)) { Log.w(TAG, "Cannot resume a non-existing track."); return; diff --git a/src/main/java/de/dennisguse/opentracks/services/handlers/TrackPointCreator.java b/src/main/java/de/dennisguse/opentracks/services/handlers/TrackPointCreator.java index 89d99a7ba..598468d34 100644 --- a/src/main/java/de/dennisguse/opentracks/services/handlers/TrackPointCreator.java +++ b/src/main/java/de/dennisguse/opentracks/services/handlers/TrackPointCreator.java @@ -16,14 +16,13 @@ import java.time.ZoneId; import de.dennisguse.opentracks.data.models.Distance; import de.dennisguse.opentracks.data.models.TrackPoint; -import de.dennisguse.opentracks.sensors.AltitudeSumManager; -import de.dennisguse.opentracks.sensors.BluetoothRemoteSensorManager; +import de.dennisguse.opentracks.sensors.SensorManager; import de.dennisguse.opentracks.sensors.sensorData.SensorDataSet; /** * Creates TrackPoints while recording by fusing data from different sensors (e.g., GNSS, barometer, BLE sensors). */ -public class TrackPointCreator implements BluetoothRemoteSensorManager.SensorDataSetChangeObserver { +public class TrackPointCreator implements SensorManager.SensorDataSetChangeObserver { private static final String TAG = TrackPointCreator.class.getSimpleName(); @@ -35,12 +34,12 @@ public class TrackPointCreator implements BluetoothRemoteSensorManager.SensorDat private Clock clock = new MonotonicClock(); private final GPSHandler gpsHandler; - private BluetoothRemoteSensorManager remoteSensorManager; - private AltitudeSumManager altitudeSumManager; + private SensorManager sensorManager; - public TrackPointCreator(Callback service) { + public TrackPointCreator(Callback service, Context context, Handler handler) { this.service = service; this.gpsHandler = new GPSHandler(this); + this.sensorManager = new SensorManager(context, handler, this); } @VisibleForTesting @@ -53,26 +52,15 @@ public class TrackPointCreator implements BluetoothRemoteSensorManager.SensorDat this.context = context; gpsHandler.start(context, handler); - - remoteSensorManager = new BluetoothRemoteSensorManager(context, handler, this); - altitudeSumManager = new AltitudeSumManager(); - - remoteSensorManager.start(context, handler); - altitudeSumManager.start(context, handler); - + sensorManager.start(context, handler); } private boolean isStarted() { return context != null; } - public synchronized void reset() { - if (remoteSensorManager == null || altitudeSumManager == null) { - Log.d(TAG, "No recording running and no reset necessary."); - return; - } - remoteSensorManager.reset(); - altitudeSumManager.reset(); + private synchronized void reset() { + sensorManager.reset(); } private SensorDataSet addSensorData(TrackPoint trackPoint) { @@ -80,32 +68,13 @@ public class TrackPointCreator implements BluetoothRemoteSensorManager.SensorDat Log.w(TAG, "Not started, should not be called."); return null; } - SensorDataSet sensorDataSet = null; - BluetoothRemoteSensorManager localRemoteSensorManager = remoteSensorManager; - if (localRemoteSensorManager != null) { - sensorDataSet = localRemoteSensorManager.fill(trackPoint); - } - AltitudeSumManager localAltitudeSumManager = altitudeSumManager; - if (localAltitudeSumManager != null) { - localAltitudeSumManager.fill(trackPoint); - } - return sensorDataSet; + return sensorManager.fill(trackPoint); } public synchronized void stop() { gpsHandler.stop(context); - if (remoteSensorManager != null) { - remoteSensorManager.stop(context); - remoteSensorManager = null; - } - - if (altitudeSumManager != null) { - altitudeSumManager.stop(context); - altitudeSumManager = null; - } - this.context = null; } @@ -169,26 +138,8 @@ public class TrackPointCreator implements BluetoothRemoteSensorManager.SensorDat } @VisibleForTesting - public AltitudeSumManager getAltitudeSumManager() { - return altitudeSumManager; - } - - @Deprecated - @VisibleForTesting - public void setAltitudeSumManager(AltitudeSumManager altitudeSumManager) { - this.altitudeSumManager = altitudeSumManager; - } - - @Deprecated - @VisibleForTesting - public BluetoothRemoteSensorManager getRemoteSensorManager() { - return remoteSensorManager; - } - - @Deprecated - @VisibleForTesting - public void setRemoteSensorManager(BluetoothRemoteSensorManager remoteSensorManager) { - this.remoteSensorManager = remoteSensorManager; + public SensorManager getSensorManager() { + return sensorManager; } @VisibleForTesting