chore(rpc): rewrite comments for clarity

Author: hazzuk

src/components/structures/UserRPC.tsx

@@ -11,8 +11,9 @@ import { logger } from "matrix-js-sdk/src/logger";
 
 import { BridgeRPC, Activity } from '../../elecord/rpc/BridgeRPC';
 
-// elecord rpc user component - gets and displays user activity
-// this component starts the full rpc lifecycle
+// elecord rpc: user component - display local user rpc activity
+
+// (starts rpc activity sender lifecycle)
 
 const UserRPC: React.FC = () => {
     const [activity, setActivity] = useState<Activity | null | undefined>(null);
@@ -51,4 +52,3 @@ const UserRPC: React.FC = () => {
 };
 
 export default UserRPC;
-

src/components/views/rooms/RoomTileRPC.tsx

@@ -13,20 +13,22 @@ import { MatrixClientPeg } from "../../../MatrixClientPeg";
 import { ParseRoomRPC } from "../../../elecord/rpc/ParseRoomRPC";
 import { Activity } from '../../../elecord/rpc/BridgeRPC';
 
-// elecord rpc room tile component - displays user activity on dm rooms
+// elecord rpc: room tile component - display external user rpc activity on dm rooms
+
+// (starts external user rpc activity lifecycle)
 
 interface Props {
     roomId: string;
     dmUserID: string;
 }
 
 const RoomTileRPC: FC<Props> = ({ roomId, dmUserID }) => {
-    // State to store the activity.
+    // state to store activity
     const [activity, setActivity] = useState<Activity | null | undefined>(null);
-    // State to trigger re-renders to update the time-ago text.
+    // state to trigger re-renders to update time-ago text
     const [now, setNow] = useState(Date.now());
 
-    // Fetch and subscribe to activity updates.
+    // fetch and subscribe to activity updates
     useEffect(() => {
         (async () => {
             const client = MatrixClientPeg.safeGet();
@@ -41,7 +43,8 @@ const RoomTileRPC: FC<Props> = ({ roomId, dmUserID }) => {
                 parseRoomRPC.cleanup();
             }
 
-            // monitor for new state events and clean up the listener when the component unmounts
+            // monitor for new state events,
+            // clean up listener when component unmounts
             parseRoomRPC.onActivity(newActivity => {
                 logger.debug("RoomRPC: 🔦 Room state changed:", dmUserID);
                 setActivity(newActivity);
@@ -61,26 +64,27 @@ const RoomTileRPC: FC<Props> = ({ roomId, dmUserID }) => {
         })();
     }, [roomId, dmUserID]);
 
-    // Self-adjusting timeout: update more frequently when activity is new,
-    // and switch to updating every hour once it's older than an hour.
+    // self-adjusting timeout: update more frequently when activity is new,
+    // switch to updating every hour once it's older than an hour
     useEffect(() => {
         let timer: ReturnType<typeof setTimeout>;
 
         const tick = async () => {
             setNow(Date.now());
 
-            // Default update frequency is 1 minute.
+            // default update frequency: 1m 
             let nextDelay = 60000;
             if (activity?.timestamps?.start && !activity.status) {
                 const elapsed = Date.now() - activity.timestamps.start;
-                // Switch to updating every hour if activity is older than one hour.
+                // check activity older than 1h
                 if (elapsed >= 3600000) {
+                    // update frequency: 1h
                     nextDelay = 3600000;
                 }
             }
             timer = setTimeout(tick, nextDelay);
         };
-        // Start the cycle.
+        // start cycle
         timer = setTimeout(tick, 60000);
 
         return () => clearTimeout(timer);
@@ -136,4 +140,3 @@ const RoomTileRPC: FC<Props> = ({ roomId, dmUserID }) => {
 };
 
 export default RoomTileRPC;
-

src/elecord/rpc/BridgeRPC.ts

@@ -9,7 +9,7 @@ import { logger } from "matrix-js-sdk/src/logger";
 
 import { sendActivity } from "./SendRPC";
 
-// elecord rpc bridge - communicates with the local game presence websocket server
+// elecord rpc: bridge - communicate with local erpc websocket server
 
 export type Activity = {
     application_id: string;
@@ -164,4 +164,3 @@ export class BridgeRPC {
         return this.activity;
     }
 }
-

src/elecord/rpc/ParseRoomRPC.ts

@@ -20,6 +20,8 @@ import {
 import { Activity } from './BridgeRPC';
 import DOMPurify from "dompurify";
 
+// elecord rpc: parser - fetch and format rpc activity state events
+
 const EVENT_TYPE: any = "app.elecord.rpc.activity";
 
 export class ParseRoomRPC {
@@ -35,9 +37,7 @@ export class ParseRoomRPC {
         this.dmUserID = dmUserID;
     }
 
-    /**
-     * Fetch the current state event for the given user and room.
-     */
+    // fetch current state event for given user, and room
     public async getActivity() {
         logger.debug("ViewRPC: getActivity() called:", this.dmUserID);
 
@@ -54,13 +54,11 @@ export class ParseRoomRPC {
         // an empty (content: {}) activity means rpc is disabled
         // if not, then we will return null
 
-        // provide activity
+        // return rpc activity
         return this.processEvent(event);
     }
 
-    /**
-     * Callback when a new state event is received.
-     */
+    // callback when new state event received
     public onActivity(callback: (activity: Activity) => void): void {
         logger.debug("ViewRPC: 🏳️ onActivity() started:", this.dmUserID);
 
@@ -73,7 +71,7 @@ export class ParseRoomRPC {
             const event = state.getStateEvents(EVENT_TYPE, this.dmUserID);
             const activity = this.processEvent(event);
 
-            // provide activity
+            // return rpc activity
             if (activity) {
                 callback({ ...activity });
             }
@@ -88,10 +86,7 @@ export class ParseRoomRPC {
         };
     }
 
-    /**
-     * Get the room by roomId.
-     * @returns The Room object or undefined if the room is not found.
-     */
+    // get room by roomId
     private getRoom(): Room | undefined {
         const room: Room | null = this.client.getRoom(this.roomId);
         if (!room) {
@@ -101,11 +96,7 @@ export class ParseRoomRPC {
         return room;
     }
 
-    /**
-     * Process the event and extract the activity.
-     * @param event The MatrixEvent to process.
-     * @returns The extracted Activity or null if the event is invalid.
-     */
+    // process state event, and extract activity
     private processEvent(event: MatrixEvent | null | undefined): Activity | null {
         if (
             event &&
@@ -124,18 +115,17 @@ export class ParseRoomRPC {
             // check activity status is valid
             if (this.activity.status === true) {
                 logger.debug("ViewRPC: Activity status:", this.activity.status, this.dmUserID);
-
-                // check the event was sent within the last 10.5 minutes
-                // if not, set status to false (as it's too old to be valid)
+                // check event sent within last 10.5 minutes
                 const now = new Date().getTime();
                 const sent = event.getTs();
                 const diff = now - sent;
                 if (diff > 630000) {
                     logger.warn("ViewRPC: ⌛ Activity status too old:", Math.round(diff/60000) + "m", this.dmUserID);
-                    // correct the invalid status
+                    // correct invalid status (too old to be valid)
                     this.activity.status = false;
                     this.activity.timestamps.start = sent;
                 }
+
             } else if (this.activity.status === false) {
                 logger.debug("ViewRPC: Activity status:", this.activity.status, this.dmUserID);
                 this.activity.timestamps.start = event.getTs();
@@ -150,4 +140,3 @@ export class ParseRoomRPC {
         }
     }
 }
-

src/elecord/rpc/RouteRPC.ts

@@ -9,7 +9,7 @@ import { logger } from "matrix-js-sdk/src/logger";
 
 import DMRoomMap from "../../utils/DMRoomMap";
 
-// elecord rpc route - returns routes to dm rooms for activity updates
+// elecord rpc: router - return routes to dm rooms
 
 export async function routeActivity() {
 
@@ -25,4 +25,3 @@ export async function routeActivity() {
         return dmRooms;
     }
 }
-

src/elecord/rpc/SendRPC.ts

@@ -11,7 +11,7 @@ import { Activity } from "./BridgeRPC";
 import { routeActivity } from "./RouteRPC";
 import { MatrixClientPeg } from "../../MatrixClientPeg";
 
-// elecord rpc sender - sends activity updates as room state events
+// elecord rpc: sender - send rpc activity state events
 
 export async function sendActivity(this: any, activity: Activity, previousID: string) {
 
@@ -54,4 +54,3 @@ export async function sendActivity(this: any, activity: Activity, previousID: st
         logger.info("SendRPC: 🚀 Sent activity updates");
     }
 }
-