Add groups to clarify output and measure the time each group takes

Author: eregon

common.js

@@ -1,5 +1,20 @@
 const os = require('os')
 const fs = require('fs')
+const core = require('@actions/core')
+const { performance } = require('perf_hooks')
+
+export async function measure(name, block) {
+  return await core.group(name, async () => {
+    const start = performance.now()
+    try {
+      return await block()
+    } finally {
+      const end = performance.now()
+      const duration = (end - start) / 1000.0
+      console.log(`Took ${duration.toFixed(2).padStart(6)} seconds`)
+    }
+  })
+}
 
 export function getVirtualEnvironmentName() {
   const platform = os.platform()

dist/index.js

@@ -26,7 +26,8 @@ export async function run() {
 
     setupPath(ruby, newPathEntries)
 
-    await installBundler(platform, rubyPrefix, engine, version)
+    await common.measure('Installing Bundler', async () =>
+      installBundler(platform, rubyPrefix, engine, version))
 
     core.setOutput('ruby-prefix', rubyPrefix)
   } catch (error) {
@@ -101,12 +102,14 @@ function setupPath(ruby, newPathEntries) {
   let cleanPath = originalPath.filter(entry => !/\bruby\b/i.test(entry))
 
   if (cleanPath.length !== originalPath.length) {
+    core.startGroup('Cleaning PATH')
     console.log('Entries removed from PATH to avoid conflicts with Ruby:')
     for (const entry of originalPath) {
       if (!cleanPath.includes(entry)) {
         console.log(`  ${entry}`)
       }
     }
+    core.endGroup()
   }
 
   core.exportVariable('PATH', [...newPathEntries, ...cleanPath].join(path.delimiter))

index.js

@@ -3,6 +3,7 @@ const path = require('path')
 const exec = require('@actions/exec')
 const io = require('@actions/io')
 const tc = require('@actions/tool-cache')
+const common = require('./common')
 const rubyBuilderVersions = require('./ruby-builder-versions')
 
 const builderReleaseTag = 'enable-shared'
@@ -27,12 +28,15 @@ async function downloadAndExtract(platform, ruby) {
   const rubiesDir = path.join(os.homedir(), '.rubies')
   await io.mkdirP(rubiesDir)
 
-  const url = await getDownloadURL(platform, ruby)
-  console.log(url)
+  const downloadPath = await common.measure('Downloading Ruby', async () => {
+    const url = getDownloadURL(platform, ruby)
+    console.log(url)
+    return await tc.downloadTool(url)
+  })
 
-  const downloadPath = await tc.downloadTool(url)
   const tar = platform.startsWith('windows') ? 'C:\\Windows\\system32\\tar.exe' : 'tar'
-  await exec.exec(tar, [ '-xz', '-C', rubiesDir, '-f',  downloadPath ])
+  await common.measure('Extracting Ruby', async () =>
+    exec.exec(tar, [ '-xz', '-C', rubiesDir, '-f',  downloadPath ]))
 
   return path.join(rubiesDir, ruby)
 }

ruby-builder.js

@@ -7,6 +7,7 @@ const cp = require('child_process')
 const core = require('@actions/core')
 const exec = require('@actions/exec')
 const tc = require('@actions/tool-cache')
+const common = require('./common')
 const rubyInstallerVersions = require('./windows-versions').versions
 
 // Extract to SSD, see https://github.com/ruby/setup-ruby/pull/14
@@ -35,15 +36,19 @@ export function getAvailableVersions(platform, engine) {
 export async function install(platform, ruby) {
   const version = ruby.split('-', 2)[1]
   const url = rubyInstallerVersions[version]
-  console.log(url)
 
   if (!url.endsWith('.7z')) {
-    throw new Error('URL should end in .7z')
+    throw new Error(`URL should end in .7z: ${url}`)
   }
   const base = url.slice(url.lastIndexOf('/') + 1, url.length - '.7z'.length)
 
-  const downloadPath = await tc.downloadTool(url)
-  await exec.exec('7z', ['x', downloadPath, `-xr!${base}\\share\\doc`, `-o${drive}:\\`], { silent: true })
+  const downloadPath = await common.measure('Downloading Ruby', async () => {
+    console.log(url)
+    return await tc.downloadTool(url)
+  })
+
+  await common.measure('Extracting Ruby', async () =>
+    exec.exec('7z', ['x', downloadPath, `-xr!${base}\\share\\doc`, `-o${drive}:\\`], { silent: true }))
   const rubyPrefix = `${drive}:\\${base}`
 
   let toolchainPaths = (version === 'mswin') ?
@@ -62,15 +67,17 @@ async function symLinkToEmbeddedMSYS2() {
   }
   const latestVersion = toolCacheVersions.slice(-1)[0]
   const hostedRuby = tc.find('Ruby', latestVersion)
-  await exec.exec(`cmd /c mklink /D ${msys2} ${hostedRuby}\\msys64`)
+  await common.measure('Linking MSYS2', async () =>
+    exec.exec(`cmd /c mklink /D ${msys2} ${hostedRuby}\\msys64`))
 }
 
 async function setupMingw(version) {
   core.exportVariable('MAKE', 'make.exe')
 
   if (version.startsWith('2.2') || version.startsWith('2.3')) {
     core.exportVariable('SSL_CERT_FILE', certFile)
-    await installMSYS(version)
+    await common.measure('Installing MSYS1', async () =>
+      installMSYS(version))
 
     return msysPathEntries
   } else {
@@ -117,7 +124,10 @@ async function setupMSWin() {
     await symLinkToEmbeddedMSYS2()
   }
 
-  return [...addVCVARSEnv(), ...msys2PathEntries]
+  const VCPathEntries = await common.measure('Setting up MSVC environment', async () =>
+    addVCVARSEnv())
+
+  return [...VCPathEntries, ...msys2PathEntries]
 }
 
 /* Sets MSVC environment for use in Actions