chore: comments

Author: durran

src/cmap/commands.ts

@@ -433,7 +433,7 @@ export class DocumentSequence {
   documents: Document[];
   serializedDocumentsLength: number;
   private chunks: Uint8Array[];
-  private header?: Buffer;
+  private header: Buffer;
 
   /**
    * Create a new document sequence for the provided field.
@@ -444,33 +444,27 @@ export class DocumentSequence {
     this.documents = [];
     this.chunks = [];
     this.serializedDocumentsLength = 0;
-    this.init();
-    if (documents) {
-      for (const doc of documents) {
-        this.push(doc, BSON.serialize(doc));
-      }
-    }
-  }
-
-  /**
-   * Initialize the buffer chunks.
-   */
-  private init() {
     // Document sequences starts with type 1 at the first byte.
+    // Field strings must always be UTF-8.
     const buffer = Buffer.allocUnsafe(1 + 4 + this.field.length + 1);
     buffer[0] = 1;
     // Third part is the field name at offset 5 with trailing null byte.
     encodeUTF8Into(buffer, `${this.field}\0`, 5);
     this.chunks.push(buffer);
     this.header = buffer;
+    if (documents) {
+      for (const doc of documents) {
+        this.push(doc, BSON.serialize(doc));
+      }
+    }
   }
 
   /**
    * Push a document to the document sequence. Will serialize the document
    * as well and return the current serialized length of all documents.
    * @param document - The document to add.
    * @param buffer - The serialized document in raw BSON.
-   * @returns The new totoal document sequence length.
+   * @returns The new total document sequence length.
    */
   push(document: Document, buffer: Uint8Array): number {
     this.serializedDocumentsLength += buffer.length;

src/operations/client_bulk_write/command_builder.ts

@@ -105,7 +105,7 @@ export class ClientBulkWriteCommandBuilder {
           currentCommandLength + operationBuffer.length < maxMessageSizeBytes &&
           currentCommand.ops.documents.length < maxWriteBatchSize
         ) {
-          // Pushing to the ops document sequence returns the bytes length added.
+          // Pushing to the ops document sequence returns the total byte length of the document sequence.
           currentCommandLength =
             MESSAGE_OVERHEAD_BYTES + this.addOperation(currentCommand, operation, operationBuffer);
         } else {
@@ -185,7 +185,7 @@ export class ClientBulkWriteCommandBuilder {
     operation: Document,
     operationBuffer: Uint8Array
   ): number {
-    // Pushing to the ops document sequence returns the bytes length added.
+    // Pushing to the ops document sequence returns the total byte length of the document sequence.
     return command.ops.push(operation, operationBuffer);
   }
 
@@ -196,7 +196,7 @@ export class ClientBulkWriteCommandBuilder {
     nsInfo: Document,
     nsInfoBuffer: Uint8Array
   ): number {
-    // Pushing to the nsInfo document sequence returns the bytes length added.
+    // Pushing to the nsInfo document sequence returns the total byte length of the document sequence.
     const nsInfoLength = command.nsInfo.push(nsInfo, nsInfoBuffer);
     const opsLength = this.addOperation(command, operation, operationBuffer);
     return nsInfoLength + opsLength;