feat: display artifact upload durations in the console

.circleci/cache-version.txt

@@ -1,3 +1,3 @@
 # Bump this version to force CI to re-create the cache from scratch.
 
-10-25-23.1
+11-2-23

cli/CHANGELOG.md

@@ -1,4 +1,12 @@
 <!-- See the ../guides/writing-the-cypress-changelog.md for details on writing the changelog. -->
+## 13.6.0
+
+_Released 11/21/2023 (PENDING)_
+
+**Features:**
+
+- When artifacts are uploaded to the Cypress Cloud, the duration of each upload will be displayed in the console. Addresses [#28237](https://github.com/cypress-io/cypress/issues/28237).
+
 ## 13.5.1
 
 _Released 11/14/2023_

packages/server/lib/modes/record.js

@@ -25,6 +25,7 @@ const { printPendingArtifactUpload, printCompletedArtifactUpload } = require('..
 const testsUtils = require('../util/tests_utils')
 const specWriter = require('../util/spec_writer')
 const { fs } = require('../util/fs')
+const { performance } = require('perf_hooks')
 
 // dont yell about any errors either
 const runningInternalTests = () => {
@@ -252,6 +253,8 @@ const uploadArtifactBatch = async (artifacts, protocolManager, quiet) => {
         }
       }
 
+      const startTime = performance.now()
+
       debug('uploading artifact %O', {
         ...artifact,
         payload: typeof artifact.payload,
@@ -267,6 +270,7 @@ const uploadArtifactBatch = async (artifacts, protocolManager, quiet) => {
             url: artifact.uploadUrl,
             fileSize: artifact.fileSize,
             key: artifact.reportKey,
+            duration: performance.now() - startTime,
           }
         }
 
@@ -279,6 +283,7 @@ const uploadArtifactBatch = async (artifacts, protocolManager, quiet) => {
           pathToFile: artifact.filePath,
           fileSize: artifact.fileSize,
           key: artifact.reportKey,
+          duration: performance.now() - startTime,
         }
       } catch (err) {
         debug('failed to upload artifact %o', {
@@ -297,6 +302,7 @@ const uploadArtifactBatch = async (artifacts, protocolManager, quiet) => {
             allErrors: err.errors,
             url: artifact.uploadUrl,
             pathToFile: artifact.filePath,
+            duration: performance.now() - startTime,
           }
         }
 
@@ -306,6 +312,7 @@ const uploadArtifactBatch = async (artifacts, protocolManager, quiet) => {
           error: err.message,
           url: artifact.uploadUrl,
           pathToFile: artifact.filePath,
+          duration: performance.now() - startTime,
         }
       }
     }),
@@ -338,7 +345,8 @@ const uploadArtifactBatch = async (artifacts, protocolManager, quiet) => {
       return skipped && !report.error ? acc : {
         ...acc,
         [key]: {
-          ...report,
+          // TODO: once cloud supports reporting duration, no longer omit this
+          ..._.omit(report, 'duration'),
           error,
         },
       }

packages/server/lib/util/human_time.js

@@ -37,7 +37,7 @@ const long = (ms, alwaysIncludeSeconds = true) => {
   return msg.join(', ')
 }
 
-const short = (ms) => {
+const short = (ms, fixed = undefined) => {
   let { mins, duration } = parse(ms)
   const msg = []
 
@@ -53,7 +53,7 @@ const short = (ms) => {
     msg.push(`${secs}s`)
   } else {
     if (!mins) {
-      const millis = duration.milliseconds()
+      const millis = fixed ? duration.milliseconds().toFixed(fixed) : duration.milliseconds()
 
       if (millis) {
         msg.push(`${millis}ms`)

packages/server/lib/util/print-run.ts

@@ -614,21 +614,30 @@ type ArtifactUploadResultLike = {
   success: boolean
   error?: string
   skipped?: boolean
+  duration?: number
 }
 
 export const printCompletedArtifactUpload = <T extends ArtifactUploadResultLike> (artifactUploadResult: T, labels: Record<'protocol' | 'screenshots' | 'video', string>, num: string): void => {
-  const { pathToFile, key, fileSize, success, error, skipped } = artifactUploadResult
+  const { pathToFile, key, fileSize, success, error, skipped, duration } = artifactUploadResult
 
   process.stdout.write(`  - ${labels[key]} `)
 
   if (success) {
-    process.stdout.write(`- Done Uploading ${formatFileSize(Number(fileSize))} ${num}`)
+    process.stdout.write(`- Done Uploading ${formatFileSize(Number(fileSize))}`)
   } else if (skipped) {
-    process.stdout.write(`- Nothing to Upload ${num}`)
+    process.stdout.write(`- Nothing to Upload`)
   } else {
-    process.stdout.write(`- Failed Uploading ${num}`)
+    process.stdout.write(`- Failed Uploading`)
   }
 
+  if (duration) {
+    const durationOut = humanTime.short(duration, 2)
+
+    process.stdout.write(` ${success ? 'in' : 'after'} ${durationOut}`)
+  }
+
+  process.stdout.write(` ${num}`)
+
   if (pathToFile && key !== 'protocol') {
     process.stdout.write(` ${formatPath(pathToFile, undefined, 'cyan')}`)
   }