__unit-test__ all commented for jsdocs

Author: cfiguer055

SmartClothingApp/.gitignore

@@ -17,3 +17,6 @@ android/
 
 # Temporary files created by Metro to check the health of the file watcher
 .metro-health-check*
+
+# Until format is fixed
+docs/

SmartClothingApp/__test__/__unit-test__/__actions-test__/appActions.unit.test.js

@@ -1,3 +1,27 @@
+/**
+ * Unit tests for app actions in the Smart Clothing App.
+ * 
+ * This test file includes test cases for actions related to app-level state management,
+ * such as managing user metrics modal visibility, updating activity ring data, and
+ * updating heart rate and sleep data date ranges. These tests ensure that each action
+ * is dispatched correctly and that the appropriate payloads are passed to reducers.
+ * 
+ * Mocks:
+ * - Firebase Firestore methods (getDoc, setDoc, etc.)
+ * - AsyncStorage (local storage mock)
+ * - Firebase Authentication methods (updateEmail, updateProfile, etc.)
+ * 
+ * Global mocks and setup are done via jest to simulate database, authentication,
+ * and local storage services.
+ *
+ * Thunks for async actions are tested to verify proper dispatch behavior, with 
+ * mock data and conditions ensuring each action triggers as expected.
+ * 
+ * @file appActions.unit.test.js
+ * 
+ * Credit: Carlos Figueroa (github @cfiguer055)
+ */
+
 import configureMockStore from 'redux-mock-store';
 import thunk from 'redux-thunk';
 import {
@@ -16,11 +40,15 @@ import {
   UPDATE_SLEEP_DATA_DATE_RANGE,
 } from '../../../src/actions/types.js';
 
-console.log(userMetricsDataModalVisible);
 
+
+
+
+// Middleware and store setup
 const middlewares = [thunk];
 const mockStore = configureMockStore(middlewares);
 
+// Mock Firebase dependencies and AsyncStorage
 jest.mock('../../../src/utils/localStorage.js', () => ({
     AsyncStorage: jest.fn(),
   }));
@@ -57,8 +85,36 @@ jest.mock('firebase/auth', () => ({
 
 
 
+/**
+ * Unit tests for app actions in Smart Clothing app.
+ * 
+ * Test suite: User Metrics Actions
+ *
+ * This suite tests all the actions related to user metrics in the app. It verifies that actions
+ * like toggling the metrics modal visibility, updating activity rings, and updating date ranges
+ * for heart rate and sleep data behave as expected.
+ *
+ * This suite of tests validates the Redux actions for the app, including those that:
+ * - Modify the visibility of user metrics modals, update activity rings, and update
+ *   date ranges for heart rate and sleep data.
+ * - It ensures that each action is dispatched correctly, and the reducers will be updated
+ *   as expected.
+ *
+ * Mocks are set up for Firebase Firestore and AsyncStorage to simulate database interactions.
+ *
+ * @test {userMetricsDataModalVisible} Action to update user metrics modal visibility.
+ * @test {updateActivityRingsData} Action to update activity rings data.
+ * @test {updateHeartRateDateRangeData} Action to update heart rate data range.
+ */
 describe('User Metrics Actions', () => {
 
+  /**
+   * Test case: Should create an action to toggle user metrics data modal visibility
+   *
+   * This test validates that the `userMetricsDataModalVisible` action creator produces
+   * the correct action object when passed the visibility state and sign-up screen flag.
+   * @test {userMetricsDataModalVisible}
+   */
   it('should create an action to toggle user metrics data modal visibility', () => {
     const expectedAction = {
       type: USER_METRICS_DATA_MODAL_VISIBLE,
@@ -70,6 +126,13 @@ describe('User Metrics Actions', () => {
     expect(userMetricsDataModalVisible(true, true)).toEqual(expectedAction);
   });
 
+  /**
+   * Test case: Should create an action to update activity ring data for a specific day
+   *
+   * This test ensures that `updateActivityRingsData` generates an action with the correct
+   * payload, including the day of the week and the activity ring data (ring1, ring2, ring3).
+   * @test {updateActivityRingsData}
+   */
   it('should create an action to toggle activity ring data', () => {
     const day = "Monday"
     const ringData = { ring1: '1.0', ring2: '1.0', ring3: '1.0' };
@@ -85,6 +148,13 @@ describe('User Metrics Actions', () => {
     expect(updateActivityRingsData(day, ringData)).toEqual(expectedAction);
   });
 
+  /**
+   * Test case: Should create an action to update heart rate date range
+   *
+   * This test validates that the `updateHeartRateDateRangeData` action creator produces
+   * the correct action object with the start and end dates for the heart rate data.
+   * @test {updateHeartRateDateRangeData}
+   */
   it('should create an action to update heart rate date range', () => {
     const startDate = '2024-01-01';
     const endDate = '2024-01-07';
@@ -95,6 +165,13 @@ describe('User Metrics Actions', () => {
     expect(updateHeartRateDateRangeData(startDate, endDate)).toEqual(expectedAction);
   });
 
+  /**
+   * Test case: Should create an action to update sleep data date range
+   *
+   * This test ensures that `updateSleepDataDateRangeData` correctly dispatches an action
+   * with the provided start and end dates for the sleep data.
+   * @test {updateSleepDataDateRangeData}
+   */
   it('should create an action to update sleep data date range', () => {
     const startDate = '2024-01-01';
     const endDate = '2024-01-07';
@@ -105,6 +182,14 @@ describe('User Metrics Actions', () => {
     expect(updateSleepDataDateRangeData(startDate, endDate)).toEqual(expectedAction);
   });
 
+  /**
+   * Test case: Should dispatch actions to update activity rings data for each day of the week
+   *
+   * This test simulates the `updateActivityRings` thunk, which dispatches activity ring data
+   * for each day of the week. It ensures that all actions are dispatched with the correct
+   * data after the asynchronous operation completes.
+   * @test {updateActivityRings}
+   */
   it('should dispatch actions to update activity rings data', async () => {
     const store = mockStore({});
     const daysOfWeek = [
@@ -124,17 +209,27 @@ describe('User Metrics Actions', () => {
       }
     }));
 
+    // Dispatch the thunk action
     await store.dispatch(updateActivityRings());
     const actions = store.getActions();
 
+    // Verify that each action is dispatched correctly
     expectedActions.forEach((expectedAction, index) => {
       expect(actions[index]).toEqual(expectedAction);
     });
 
+    // Restore Math.random to its original implementation
     Math.random.mockRestore();
-
   }, 10000);
 
+  /**
+   * Test case: Should dispatch actions to update heart rate data date range
+   *
+   * This test validates the `updateHeartRateDateRange` thunk, ensuring that the start and
+   * end dates for the heart rate data are correctly dispatched.
+   * @test {updateHeartRateDateRange}
+   */
+
   it('should dispatch actions to update heart rate data date range', async () => {
     const store = mockStore({});
 
@@ -156,6 +251,13 @@ describe('User Metrics Actions', () => {
 
   }, 10000);
 
+  /**
+   * Test case: Should dispatch actions to update sleep data date range
+   *
+   * This test ensures that `updateSleepDataDateRange` correctly dispatches the action
+   * with the provided start and end dates for the sleep data.
+   * @test {updateSleepDataDateRange}
+   */
   it('should dispatch actions to update sleep data date range', async () => {
     const store = mockStore({});