Add code comments

Author: stevensJourney

packages/common/src/client/sync/stream/AbstractStreamingSyncImplementation.ts

@@ -449,15 +449,16 @@ The next upload iteration will be delayed.`);
         await this.streamingSyncIteration(nestedAbortController.signal, options);
         // Continue immediately, streamingSyncIteration will wait before completing if necessary.
       } catch (ex) {
-        let delay = true;
         /**
          * Either:
          *  - A network request failed with a failed connection or not OKAY response code.
          *  - There was a sync processing error.
-         * This loop will retry.
+         *  - The connection was aborted.
+         * This loop will retry after a delay if the connection was not aborted.
          * The nested abort controller will cleanup any open network requests and streams.
          * The WebRemote should only abort pending fetch requests or close active Readable streams.
          */
+        let delay = true;
         if (ex instanceof AbortOperation) {
           this.logger.warn(ex);
           delay = false;

packages/web/src/worker/sync/SharedSyncImplementation.ts

@@ -145,7 +145,7 @@ export class SharedSyncImplementation
             await this.openInternalDB();
           }
 
-          const sync = await this.generateStreamingImplementation();
+          const sync = this.generateStreamingImplementation();
           const onDispose = sync.registerListener({
             statusChanged: (status) => {
               this.updateAllStatuses(status.toJSON());
@@ -270,6 +270,9 @@ export class SharedSyncImplementation
    * clients.
    */
   async removePort(port: MessagePort) {
+    // Remove the port within a mutex context.
+    // Warns if the port is not found. This should not happen in practice.
+    // We return early if the port is not found.
     const { trackedPort, shouldReconnect } = await this.portMutex.runExclusive(async () => {
       const index = this.ports.findIndex((p) => p.port == port);
       if (index < 0) {

packages/web/tests/utils/MockStreamOpenFactory.ts

@@ -81,6 +81,9 @@ export class MockRemote extends AbstractRemote {
         if (this.errorOnStreamStart) {
           controller.error(new Error('Mock error on stream start'));
         }
+        // The request could be aborted at any time.
+        // This checks if the signal is already aborted and closes the stream if so.
+        // If not, it adds an event listener to close the stream when the signal is aborted.
         if (signal?.aborted) {
           controller.close();
           return;