francelu commented 1 week ago

Integrate Timer Feature

Description

This PR introduces a new timer feature to the project, which includes the implementation of the timer model, data transfer objects, repository, view model, and associated tests. It integrates the logic for managing timers, including starting, stopping, and resetting timers, as well as synchronizing data with the Supabase backend.

It closes issue #217.

Note

This PR will not handle the delete functions on Timer VM since it's not useful for now. I'm creating a task in for later, when we will need it on the deletion of a user.

I know I should have made a separate PR for the M from the VM. However, as I was implementing the VM, I had to change multiple times the M. That would have lead to a PR from M, and a PR for VM which would have overwritten the PR for M.

This PR has as new lines a lot of documentation , and mainly tests code. Hence, the thousand lines. I'm sorryyy...

Changes

Added Timer data class with methods for serialization and state management.
Introduced TimerDto data transfer object to facilitate conversion between the Timer model and API data (for Supabase).
Defined TimerRepository interface and implemented TimerRepositorySupabase for API interactions.
Added TimerViewModel for handling timer-related operations and UI state.
Implemented TimerManager to manage timer actions (start, stop, reset) and have a persistent timer (running after app closed).

Note

The table in Supabase has been settled, with its policies. It only contains the list of last timers' elapsed times.
I tried to fix the security hotspot raised by sonarcloud, no clue still...

Files

Added

app/src/main/java/com/android/periodpals/model/timer/Timer.kt
app/src/main/java/com/android/periodpals/model/timer/TimerDto.kt
app/src/main/java/com/android/periodpals/model/timer/TimerManager.kt
app/src/main/java/com/android/periodpals/model/timer/TimerModel.kt
app/src/main/java/com/android/periodpals/model/timer/TimerModelSupabase.kt
app/src/main/java/com/android/periodpals/model/timer/TimerViewModel.kt
app/src/test/java/com/android/periodpals/model/timer/TimerDtoTest.kt
app/src/test/java/com/android/periodpals/model/timer/TimerManagerTest.kt
app/src/test/java/com/android/periodpals/model/timer/TimerModelSupabaseTest.kt

Modified

app/src/main/java/com/android/periodpals/model/user/UserDto.kt: I saw the documentation wasn't up-to-date when trying to understand who VM worked with Supabase.
app/build.gradle.kts: add viewBinding in buildFeatures.

Removed

None

Dependencies Added

None

Testing

Unit tests have been added for TimerDto, TimerManager, and TimerRepositorySupabase to ensure correct functionality.
Tests verify serialization/deserialisation, timer actions, and API interactions with Supabase.

francelu commented 1 day ago

Changes Implemented from PR Review of @coaguila

Timer data class and TimerDto:
- They do not include the required changes since Supabase handles the uid (with RLS) and id itself.
- They only contain a property time which is the elapsed time of that timer.
- I didn't keep track of when they were created. We could implement that later if we want an average over the last five timers.
- TimerDtoTest.kt was updated as necessary.
Removed commented code from TimerViewModel.kt.
Didn't add the requested Robolectric since these aren't UI test, refer to PR #208.
Added verify() statements as requested in the TimerViewModelTest.kt.
deleteTimer() implemented as Supabase recommends with a filter. (Actually two functions, one by timerIdthe other by userId.)