Issue - 275 (Meaningful Documentation)

lib/controllers/auth_state_controller.dart

@@ -32,9 +32,15 @@ class AuthStateController extends GetxController {
   late bool? isEmailVerified;
   late User appwriteUser;
 
+  // initializes FlutterLocalNotifications Plugin provides cross-platform to display local notifications.
   FlutterLocalNotificationsPlugin flutterLocalNotificationsPlugin =
       FlutterLocalNotificationsPlugin();
 
+  /*
+  - Sets up Android notification settings.
+  - Registers callback to handle Notification taps(onDidRecieveNotificationResponse)
+  - Enables overall notification capability.
+  */
   Future<void> initializeLocalNotifications() async {
     const AndroidInitializationSettings initializationSettingsAndroid =
         AndroidInitializationSettings('ic_launcher');
@@ -47,11 +53,24 @@ class AuthStateController extends GetxController {
         onDidReceiveNotificationResponse: onDidReceiveNotificationResponse);
   }
 
+  /*Code Explaination of onDidReceiveNotificationResponse.
+    The below method handles the logic of tapping on a notification
+    1.Extract the discussion name from the notification payload.
+    2.Fetch the index of the discussion that is obtained after tapping on notification.
+    3.Lookup the matching discussion in the controller's list.
+    4.Make the ScrollController to get initialized to that offset.
+    5.Update tab Controller to switch to discussions tab.
+    6.Navigate user to the tabs screen.
+   */
+
   void onDidReceiveNotificationResponse(
       NotificationResponse notificationResponse) async {
-    String name = notificationResponse.payload!;
+    String name = notificationResponse
+        .payload!; //fetching the payload(custom key value pairs).
+
     DiscussionsController discussionsController =
         Get.find<DiscussionsController>();
+
     int index = discussionsController.discussions
         .indexWhere((discussion) => discussion.data["name"] == name);
 
@@ -119,6 +138,11 @@ class AuthStateController extends GetxController {
     }
   }
 
+  /*
+  In the below method,
+    it Fetches and sets the user Profile info from Appwrite ,
+    and later updates the widgets. 
+   */
   Future<void> setUserProfileData() async {
     isInitializing.value = true;
     try {
@@ -146,12 +170,27 @@ class AuthStateController extends GetxController {
     }
   }
 
+  /*
+    In this below method (getAppwriteToken)
+    1.Call createJWT() on the account object
+    2.This returns a JWT class containing the signed token.
+    3.We return just the raw JWT string portion.
+   */
   Future<String> getAppwriteToken() async {
     Jwt authToken = await account.createJWT();
     log(authToken.toString());
     return authToken.jwt;
   }
 
+  /*
+    In the below method(isUserLoggedIn)
+    - all we are trying to know is whether the userProfile is successfully setup or not.
+    - If yes then route the ui to tabView.
+    - If no then route the ui to onBoarding.
+    - If error, check if its a first launch
+    - On first launch, show landing page.
+    - Otherwise redirect to login screen.
+   */
   Future<void> isUserLoggedIn() async {
     try {
       await setUserProfileData();
@@ -195,6 +234,16 @@ class AuthStateController extends GetxController {
     });
   }
 
+/*
+  1. Get the current FCM token for the user's device.
+  2. Fetch the list of subscribed Discussion from appwrite collection.
+  3. Loop through subscribed discussion.
+  4. Get the list of tokens and remove current user's token.
+  5. Update the discusion.
+
+  Result: This keeps each discussion's tokens list uptodate as user 
+  subscribe/unsubscribe over time.
+ */
   Future<void> removeRegistrationTokenfromSubscribedDiscussions() async {
     final fcmToken = await messaging.getToken();
     List<Document> subscribedDiscussions = await databases.listDocuments(
@@ -232,6 +281,8 @@ class AuthStateController extends GetxController {
     await isUserLoggedIn();
   }
 
+  //Displays dialog box for confirming the logout decision of user.
+  //Then it performs the corresponding task.
   Future<void> logout() async {
     Get.defaultDialog(
       title: "Are you sure?",

lib/controllers/authentication_controller.dart

@@ -10,6 +10,7 @@ import 'package:resonate/views/widgets/snackbar.dart';
 class AuthenticationController extends GetxController {
   var isPasswordFieldVisible = false.obs;
   var isLoading = false.obs;
+
   TextEditingController emailController = TextEditingController(text: "");
   TextEditingController passwordController = TextEditingController(text: "");
   TextEditingController confirmPasswordController =
@@ -19,6 +20,7 @@ class AuthenticationController extends GetxController {
   var loginFormKey;
   var registrationFormKey;
 
+//Login the user using email and password.
   Future<void> login() async {
     if (!loginFormKey.currentState!.validate()) {
       return;
@@ -30,7 +32,8 @@ class AuthenticationController extends GetxController {
     } on AppwriteException catch (e) {
       log(e.toString());
       if (e.type == 'user_invalid_credentials') {
-        customSnackbar('Try Again!', "Incorrect Email Or Password", MessageType.error);
+        customSnackbar(
+            'Try Again!', "Incorrect Email Or Password", MessageType.error);
       }
     } catch (e) {
       log(e.toString());
@@ -39,6 +42,10 @@ class AuthenticationController extends GetxController {
     }
   }
 
+  /*
+    This method(signup) helps  to sign the user through
+    email,password
+   */
   Future<bool> signup() async {
     try {
       isLoading.value = true;
@@ -57,6 +64,7 @@ class AuthenticationController extends GetxController {
     }
   }
 
+  //Sign in with Google .
   Future<void> loginWithGoogle() async {
     try {
       await authStateController.loginWithGoogle();
@@ -65,6 +73,7 @@ class AuthenticationController extends GetxController {
     }
   }
 
+//Sign in with Github.
   Future<void> loginWithGithub() async {
     try {
       await authStateController.loginWithGithub();

lib/controllers/discussions_controller.dart

@@ -16,21 +16,28 @@ class DiscussionsController extends GetxController {
   final Databases databases = AppwriteService.getDatabases();
   TextEditingController dateTimeController = TextEditingController(text: "");
   AuthStateController authStateController = Get.find<AuthStateController>();
+
   final CreateRoomController createRoomController =
       Get.find<CreateRoomController>();
+
   Rx<ScrollController> discussionScrollController = ScrollController().obs;
   final TabViewController controller = Get.find<TabViewController>();
+
   final ThemeController themeController = Get.find<ThemeController>();
   final RoomsController roomsController = Get.find<RoomsController>();
+
   FirebaseMessaging messaging = FirebaseMessaging.instance;
+
   late List<Document> discussions;
   late String scheduledDateTime;
   late Document currentUserDoc;
   late Duration localTimeZoneOffset;
   late String localTimeZoneName;
   late bool isOffsetNegetive;
+
   Rx<bool> isLoading = false.obs;
   late DateTime currentTimeInstance;
+
   final Map<String, String> monthMap = {
     "1": "Jan",
     "2": "Feb",
@@ -45,6 +52,7 @@ class DiscussionsController extends GetxController {
     "11": "Nov",
     "12": "Dec",
   };
+
   @override
   void onInit() async {
     super.onInit();

lib/controllers/email_verify_controller.dart

@@ -26,7 +26,8 @@ class EmailVerifyController extends GetxController {
   var isVerifying = false.obs;
   var isUpdateAllowed = true.obs;
   var signupisallowed = true.obs;
-  var clearTextField=false.obs;
+  var clearTextField = false.obs;
+
   AuthStateController authStateController = Get.find<AuthStateController>();
   AuthenticationController authController =
       Get.find<AuthenticationController>();
@@ -39,20 +40,31 @@ class EmailVerifyController extends GetxController {
     databases = Databases(authStateController.client);
   }
 
+  //This method provides the service of sending OTP to user
+  //by leveraging the AppWrite functions.
   Future<bool> sendOTP() async {
+    //sets the loading state to indicate ongoing process.
     authController.isLoading.value = true;
+
+    //Generates OTP by appending randomNumber with email.
     var otpID = randomNumeric(10).toString() + authStateController.email!;
+
     // Appwrite does not accept @ in document ID's
     otpID = otpID.split("@")[0];
+
     var sendOtpData = {
       "email": authStateController.email,
       "otpID": otpID.toString()
     };
 
+    //updates the user's document in Appwrite.
     await authStateController.account
         .updatePrefs(prefs: {"otp_ID": otpID, "isUserProfileComplete": true});
+
+    //Encodes the data to be sent to the function into a json string.
     var data = json.encode(sendOtpData);
 
+    //Triggers the Appwrite Function responsible for sending OTP emails.
     var res = await functions.createExecution(
         functionId: sendOtpFunctionID, data: data.toString());
 
@@ -75,6 +87,15 @@ class EmailVerifyController extends GetxController {
     return true;
   }
 
+  /*
+    This below method helps to verify the user entered otp
+
+    Purpose of imp variables used in below code:
+    - otpId =>Retrieves the otp from user's document, representing the actual OTP.
+    - userOTP => The user entered OTP.
+    - verificationID => Based on the comparison , the function will determine whether user
+    entered the correct OTP.
+   */
   Future<void> verifyOTP(String userOTP) async {
     verificationID = randomNumeric(10).toString() + authStateController.email!;
     verificationID = verificationID.split("@")[0];
@@ -90,6 +111,7 @@ class EmailVerifyController extends GetxController {
         functionId: verifyOtpFunctionID, data: data.toString());
   }
 
+//Provides the verficiation Status of OTP entered by user.
   Future<String> checkVerificationStatus() async {
     final document = await databases.getDocument(
       databaseId: emailVerificationDatabaseID,
@@ -100,6 +122,7 @@ class EmailVerifyController extends GetxController {
     return isVerified;
   }
 
+  //This function makes the user Profile set Verified.
   Future<void> setVerified() async {
     var verifyUserData = {
       "userID": authStateController.uid,
@@ -109,6 +132,7 @@ class EmailVerifyController extends GetxController {
         functionId: verifyUserFunctionID, data: verifyData.toString());
   }
 
+  //Helps to update Email a creates a cloud function for it.
   Future<void> updateEmail() async {
     var updateEmailData = json.encode({
       "User_ID": authStateController.uid,

lib/controllers/livekit_controller.dart

@@ -5,22 +5,30 @@ import 'package:livekit_client/livekit_client.dart';
 import 'package:resonate/controllers/pair_chat_controller.dart';
 import 'package:resonate/controllers/single_room_controller.dart';
 
-class LiveKitController extends GetxController{
+class LiveKitController extends GetxController {
   late final Room liveKitRoom;
   late final EventsListener<RoomEvent> listener;
   final String liveKitUri;
   final String roomToken;
 
   LiveKitController({required this.liveKitUri, required this.roomToken});
 
+  /*
+    - In onInit() method, we try to create a new room and join it ,through roomtoken & liveKitURI.
+    - Setting up necessary listeners .
+   */
   @override
-  void onInit() async{
+  void onInit() async {
     await joinLiveKitRoom(liveKitUri: liveKitUri, roomToken: roomToken);
     liveKitRoom.addListener(onRoomDidUpdate);
     setUpListeners();
     super.onInit();
   }
 
+  /*
+    In the onClose method ,all the resources that were allocated before are released
+    to prevent resource exploitation and avoid memory leaks.
+   */
   @override
   void onClose() async {
     (() async {
@@ -31,10 +39,10 @@ class LiveKitController extends GetxController{
     super.onClose();
   }
 
-  Future<void> joinLiveKitRoom({required String liveKitUri, required String roomToken}) async {
+  Future<void> joinLiveKitRoom(
+      {required String liveKitUri, required String roomToken}) async {
     //
     try {
-
       //create new room
       liveKitRoom = Room();
 
@@ -53,7 +61,6 @@ class LiveKitController extends GetxController{
           ),
         ),
       );
-
     } catch (error) {
       log('Could not connect $error');
     }
@@ -63,23 +70,32 @@ class LiveKitController extends GetxController{
     //Callback which will be called on room update
   }
 
+  /*
+  - This below method's purpose is to set up event listeners to handle specific
+    events related to rooms, disconnections and recording status changes.
+   */
   void setUpListeners() => listener
     ..on<RoomDisconnectedEvent>((event) async {
       if (event.reason != null) {
         log('Room disconnected: reason => ${event.reason}');
       }
-      WidgetsBindingCompatible.instance
-          ?.addPostFrameCallback((timeStamp) {
-            if (Get.isRegistered<SingleRoomController>()){
-              Get.find<SingleRoomController>().leaveRoom();
-            }
-            else if (Get.isRegistered<PairChatController>()){
-              Get.find<PairChatController>().endChat();
-            }
+
+      /*
+      Schedules a callback to run after the current frame completes.
+      - Checks if Registered Controllers are :
+        1.If SingleRoomController  is registered , calls [leaveRoom()] to initate proper
+          room clean up.
+        2.If PairChatController is registered, calls [endChat()] to handle chat termination.
+       */
+      WidgetsBindingCompatible.instance?.addPostFrameCallback((timeStamp) {
+        if (Get.isRegistered<SingleRoomController>()) {
+          Get.find<SingleRoomController>().leaveRoom();
+        } else if (Get.isRegistered<PairChatController>()) {
+          Get.find<PairChatController>().endChat();
+        }
       });
     })
     ..on<RoomRecordingStatusChanged>((event) {
       //context.showRecordingStatusChangedDialog(event.activeRecording);
     });
-
-}
+}