Updates to logging for artifact uploads (#949)

* More details logs during artifact upload

* extra logging

* Updates to artifact logging + clarifications around upload size

* Fix linting errors

* Update packages/artifact/src/internal/artifact-client.ts

Co-authored-by: campersau <[email protected]>

Co-authored-by: campersau <[email protected]>

packages/artifact/src/internal/upload-http-client.ts

@@ -235,19 +235,28 @@ export class UploadHttpClient {
     // for creating a new GZip file, an in-memory buffer is used for compression
     // with named pipes the file size is reported as zero in that case don't read the file in memory
     if (!isFIFO && totalFileSize < 65536) {
+      core.debug(
+        `${parameters.file} is less than 64k in size. Creating a gzip file in-memory to potentially reduce the upload size`
+      )
       const buffer = await createGZipFileInBuffer(parameters.file)
 
-      //An open stream is needed in the event of a failure and we need to retry. If a NodeJS.ReadableStream is directly passed in,
+      // An open stream is needed in the event of a failure and we need to retry. If a NodeJS.ReadableStream is directly passed in,
       // it will not properly get reset to the start of the stream if a chunk upload needs to be retried
       let openUploadStream: () => NodeJS.ReadableStream
 
       if (totalFileSize < buffer.byteLength) {
         // compression did not help with reducing the size, use a readable stream from the original file for upload
+        core.debug(
+          `The gzip file created for ${parameters.file} did not help with reducing the size of the file. The original file will be uploaded as-is`
+        )
         openUploadStream = () => fs.createReadStream(parameters.file)
         isGzip = false
         uploadFileSize = totalFileSize
       } else {
         // create a readable stream using a PassThrough stream that is both readable and writable
+        core.debug(
+          `A gzip file created for ${parameters.file} helped with reducing the size of the original file. The file will be uploaded using gzip.`
+        )
         openUploadStream = () => {
           const passThrough = new stream.PassThrough()
           passThrough.end(buffer)
@@ -283,6 +292,9 @@ export class UploadHttpClient {
       // the file that is being uploaded is greater than 64k in size, a temporary file gets created on disk using the
       // npm tmp-promise package and this file gets used to create a GZipped file
       const tempFile = await tmp.file()
+      core.debug(
+        `${parameters.file} is greater than 64k in size. Creating a gzip file on-disk ${tempFile.path} to potentially reduce the upload size`
+      )
 
       // create a GZip file of the original file being uploaded, the original file should not be modified in any way
       uploadFileSize = await createGZipFileOnDisk(
@@ -295,9 +307,16 @@ export class UploadHttpClient {
       // compression did not help with size reduction, use the original file for upload and delete the temp GZip file
       // for named pipes totalFileSize is zero, this assumes compression did help
       if (!isFIFO && totalFileSize < uploadFileSize) {
+        core.debug(
+          `The gzip file created for ${parameters.file} did not help with reducing the size of the file. The original file will be uploaded as-is`
+        )
         uploadFileSize = totalFileSize
         uploadFilePath = parameters.file
         isGzip = false
+      } else {
+        core.debug(
+          `The gzip file created for ${parameters.file} is smaller than the original file. The file will be uploaded using gzip.`
+        )
       }
 
       let abortFileUpload = false
@@ -355,6 +374,7 @@ export class UploadHttpClient {
 
       // Delete the temporary file that was created as part of the upload. If the temp file does not get manually deleted by
       // calling cleanup, it gets removed when the node process exits. For more info see: https://www.npmjs.com/package/tmp-promise#about
+      core.debug(`deleting temporary gzip file ${tempFile.path}`)
       await tempFile.cleanup()
 
       return {