Attend to review comments

Author: brizental

glean/src/core/upload/uploader.ts

@@ -43,7 +43,9 @@ export interface Uploader {
    * Makes a POST request to a given url, with the given headers and body.
    *
    * @param url The URL to make the POST request
-   * @param body The stringified body of this post request
+   * @param body The body of this post request. The body may be a stringified JSON or, most likely,
+   *        a Uint8Array containing the gzipped version of said stringified JSON. We need to accept
+   *        both in case the compression fails.
    * @param headers Optional header to include in the request
    * @returns The status code of the response.
    */

glean/src/platform/qt/fflate.stub.js

@@ -10,5 +10,8 @@
 
 // eslint-disable-next-line jsdoc/require-jsdoc
 export function gzipSync() {
+  // We throw here because when the gzipping action throws the ping upload manager will
+  // catch and send the uncompressed ping, which is what we want on QML for the time being.
+  // We are trying to figure out how to actually add the gzipping step to QML on Bug 1716322.
   throw new Error("Attempted to use `gzipSync` from QML, but that is not supported.");
 }