fix results url construction

* Introduce platform utilities into @actions/core

* Add tests for the platform helper

* Update README.md

* Update README.md with more details

package-lock.json

@@ -3262,9 +3262,9 @@
       }
     },
     "node_modules/axios": {
-      "version": "1.4.0",
-      "resolved": "https://registry.npmjs.org/axios/-/axios-1.4.0.tgz",
-      "integrity": "sha512-S4XCWMEmzvo64T9GfvQDOXgYRDJ/wsSZc7Jvdgx5u1sd0JwsuPLqb3SYmusag+edF6ziyMensPVqLTSc1PiSEA==",
+      "version": "1.6.2",
+      "resolved": "https://registry.npmjs.org/axios/-/axios-1.6.2.tgz",
+      "integrity": "sha512-7i24Ri4pmDRfJTR7LDBhsOTtcm+9kjX5WiY1X3wIisx6G9So3pfMkEiU7emUBe46oceVImccTEM3k6C5dbVW8A==",
       "dev": true,
       "dependencies": {
         "follow-redirects": "^1.15.0",

packages/artifact/src/internal/shared/artifact-twirp-client.ts

@@ -52,8 +52,8 @@ class ArtifactHttpClient implements Rpc {
     contentType: 'application/json' | 'application/protobuf',
     data: object | Uint8Array
   ): Promise<object | Uint8Array> {
-    const url = `${this.baseUrl}/twirp/${service}/${method}`
-    debug(`Requesting ${url}`)
+    const url = new URL(`/twirp/${service}/${method}`, this.baseUrl).href
+    debug(`Requesting: ${url}`)
     const headers = {
       'Content-Type': contentType
     }

packages/artifact/src/internal/shared/config.ts

@@ -1,3 +1,5 @@
+import os from 'os'
+
 // Used for controlling the highWaterMark value of the zip that is being streamed
 // The same value is used as the chunk size that is use during upload to blob storage
 export function getUploadChunkSize(): number {
@@ -17,7 +19,8 @@ export function getResultsServiceUrl(): string {
   if (!resultsUrl) {
     throw new Error('Unable to get the ACTIONS_RESULTS_URL env variable')
   }
-  return resultsUrl
+
+  return new URL(resultsUrl).origin
 }
 
 export function isGhes(): boolean {
@@ -34,3 +37,17 @@ export function getGitHubWorkspaceDir(): string {
   }
   return ghWorkspaceDir
 }
+
+// Mimics behavior of azcopy: https://learn.microsoft.com/en-us/azure/storage/common/storage-use-azcopy-optimize
+// If your machine has fewer than 5 CPUs, then the value of this variable is set to 32.
+// Otherwise, the default value is equal to 16 multiplied by the number of CPUs. The maximum value of this variable is 300.
+export function getConcurrency(): number {
+  const numCPUs = os.cpus().length
+
+  if (numCPUs <= 4) {
+    return 32
+  }
+
+  const concurrency = 16 * numCPUs
+  return concurrency > 300 ? 300 : concurrency
+}

packages/artifact/src/internal/shared/interfaces.ts

@@ -38,6 +38,17 @@ export interface UploadOptions {
    * input of 0 assumes default retention setting.
    */
   retentionDays?: number
+  /**
+   * The level of compression for Zlib to be applied to the artifact archive.
+   * The value can range from 0 to 9:
+   * - 0: No compression
+   * - 1: Best speed
+   * - 6: Default compression (same as GNU Gzip)
+   * - 9: Best compression
+   * Higher levels will result in better compression, but will take longer to complete.
+   * For large files that are not easily compressed, a value of 0 is recommended for significantly faster uploads.
+   */
+  compressionLevel?: number
 }
 
 /*****************************************************************************

packages/artifact/src/internal/upload/blob-upload.ts

@@ -1,7 +1,7 @@
 import {BlobClient, BlockBlobUploadStreamOptions} from '@azure/storage-blob'
 import {TransferProgressEvent} from '@azure/core-http'
 import {ZipUploadStream} from './zip'
-import {getUploadChunkSize} from '../shared/config'
+import {getUploadChunkSize, getConcurrency} from '../shared/config'
 import * as core from '@actions/core'
 import * as crypto from 'crypto'
 import * as stream from 'stream'
@@ -29,13 +29,13 @@ export async function uploadZipToBlobStorage(
 ): Promise<BlobUploadResponse> {
   let uploadByteCount = 0
 
-  const maxBuffers = 5
+  const maxConcurrency = getConcurrency()
   const bufferSize = getUploadChunkSize()
   const blobClient = new BlobClient(authenticatedUploadURL)
   const blockBlobClient = blobClient.getBlockBlobClient()
 
   core.debug(
-    `Uploading artifact zip to blob storage with maxBuffers: ${maxBuffers}, bufferSize: ${bufferSize}`
+    `Uploading artifact zip to blob storage with maxConcurrency: ${maxConcurrency}, bufferSize: ${bufferSize}`
   )
 
   const uploadCallback = (progress: TransferProgressEvent): void => {
@@ -61,7 +61,7 @@ export async function uploadZipToBlobStorage(
     await blockBlobClient.uploadStream(
       uploadStream,
       bufferSize,
-      maxBuffers,
+      maxConcurrency,
       options
     )
 

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

@@ -37,7 +37,10 @@ export async function uploadArtifact(
     }
   }
 
-  const zipUploadStream = await createZipUploadStream(zipSpecification)
+  const zipUploadStream = await createZipUploadStream(
+    zipSpecification,
+    options?.compressionLevel
+  )
 
   // get the IDs needed for the artifact creation
   const backendIds = getBackendIdsFromToken()

packages/artifact/src/internal/upload/zip.ts

@@ -5,6 +5,8 @@ import {createReadStream} from 'fs'
 import {UploadZipSpecification} from './upload-zip-specification'
 import {getUploadChunkSize} from '../shared/config'
 
+export const DEFAULT_COMPRESSION_LEVEL = 6
+
 // Custom stream transformer so we can set the highWaterMark property
 // See https://github.com/nodejs/node/issues/8855
 export class ZipUploadStream extends stream.Transform {
@@ -21,14 +23,16 @@ export class ZipUploadStream extends stream.Transform {
 }
 
 export async function createZipUploadStream(
-  uploadSpecification: UploadZipSpecification[]
+  uploadSpecification: UploadZipSpecification[],
+  compressionLevel: number = DEFAULT_COMPRESSION_LEVEL
 ): Promise<ZipUploadStream> {
+  core.debug(
+    `Creating Artifact archive with compressionLevel: ${compressionLevel}`
+  )
+
   const zip = archiver.create('zip', {
-    zlib: {level: 9} // Sets the compression level.
-    // Available options are 0-9
-    // 0 => no compression
-    // 1 => fastest with low compression
-    // 9 => highest compression ratio but the slowest
+    highWaterMark: getUploadChunkSize(),
+    zlib: {level: compressionLevel}
   })
 
   // register callbacks for various events during the zip lifecycle

packages/core/README.md

@@ -333,3 +333,28 @@ toPlatformPath('/foo/bar') // => \foo\bar
 // On a Linux runner.
 toPlatformPath('\\foo\\bar') // => /foo/bar
 ```
+
+#### Platform helper
+
+Provides shorthands for getting information about platform action is running on.
+
+```js
+import { platform } from '@actions/core'
+
+/* equals to a call of os.platform() */
+platform.platform // 'win32' | 'darwin' | 'linux' | 'freebsd' | 'openbsd' | 'android' | 'cygwin' | 'sunos'
+
+/* equals to a call of os.arch() */
+platform.arch // 'x64' | 'arm' | 'arm64' | 'ia32' | 'mips' | 'mipsel' | 'ppc' | 'ppc64' | 'riscv64' | 's390' | 's390x'
+
+/* common shorthands for platform-specific logic */
+platform.isWindows // true
+platform.isMacOS // false
+platform.isLinux // false
+
+/* run platform-specific script to get more details about the exact platform, works on Windows, MacOS and Linux */
+const {
+  name, // Microsoft Windows 11 Enterprise
+  version, // 10.0.22621
+} = await platform.getDetails()
+```

packages/core/__tests__/platform.test.ts

@@ -0,0 +1,29 @@
+import os from 'os'
+import {platform} from '../src/core'
+
+describe('getInfo', () => {
+  it('returns the platform info', async () => {
+    const info = await platform.getDetails()
+    expect(info).toEqual({
+      name: expect.any(String),
+      platform: expect.any(String),
+      arch: expect.any(String),
+      version: expect.any(String),
+      isWindows: expect.any(Boolean),
+      isMacOS: expect.any(Boolean),
+      isLinux: expect.any(Boolean)
+    })
+  })
+
+  it('returns the platform info with the correct name', async () => {
+    const isWindows = os.platform() === 'win32'
+    const isMacOS = os.platform() === 'darwin'
+    const isLinux = os.platform() === 'linux'
+
+    const info = await platform.getDetails()
+    expect(info.platform).toEqual(os.platform())
+    expect(info.isWindows).toEqual(isWindows)
+    expect(info.isMacOS).toEqual(isMacOS)
+    expect(info.isLinux).toEqual(isLinux)
+  })
+})

packages/core/package-lock.json

@@ -9,6 +9,7 @@
       "version": "1.10.1",
       "license": "MIT",
       "dependencies": {
+        "@actions/exec": "^1.1.1",
         "@actions/http-client": "^2.0.1",
         "uuid": "^8.3.2"
       },
@@ -17,6 +18,14 @@
         "@types/uuid": "^8.3.4"
       }
     },
+    "node_modules/@actions/exec": {
+      "version": "1.1.1",
+      "resolved": "https://registry.npmjs.org/@actions/exec/-/exec-1.1.1.tgz",
+      "integrity": "sha512-+sCcHHbVdk93a0XT19ECtO/gIXoxvdsgQLzb2fE2/5sIZmWQuluYyjPQtrtTHdU1YzTZ7bAPN4sITq2xi1679w==",
+      "dependencies": {
+        "@actions/io": "^1.0.1"
+      }
+    },
     "node_modules/@actions/http-client": {
       "version": "2.1.0",
       "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-2.1.0.tgz",
@@ -25,6 +34,11 @@
         "tunnel": "^0.0.6"
       }
     },
+    "node_modules/@actions/io": {
+      "version": "1.1.3",
+      "resolved": "https://registry.npmjs.org/@actions/io/-/io-1.1.3.tgz",
+      "integrity": "sha512-wi9JjgKLYS7U/z8PPbco+PvTb/nRWjeoFlJ1Qer83k/3C5PHQi28hiVdeE2kHXmIL99mQFawx8qt/JPjZilJ8Q=="
+    },
     "node_modules/@types/node": {
       "version": "12.0.2",
       "resolved": "https://registry.npmjs.org/@types/node/-/node-12.0.2.tgz",
@@ -55,6 +69,14 @@
     }
   },
   "dependencies": {
+    "@actions/exec": {
+      "version": "1.1.1",
+      "resolved": "https://registry.npmjs.org/@actions/exec/-/exec-1.1.1.tgz",
+      "integrity": "sha512-+sCcHHbVdk93a0XT19ECtO/gIXoxvdsgQLzb2fE2/5sIZmWQuluYyjPQtrtTHdU1YzTZ7bAPN4sITq2xi1679w==",
+      "requires": {
+        "@actions/io": "^1.0.1"
+      }
+    },
     "@actions/http-client": {
       "version": "2.1.0",
       "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-2.1.0.tgz",
@@ -63,6 +85,11 @@
         "tunnel": "^0.0.6"
       }
     },
+    "@actions/io": {
+      "version": "1.1.3",
+      "resolved": "https://registry.npmjs.org/@actions/io/-/io-1.1.3.tgz",
+      "integrity": "sha512-wi9JjgKLYS7U/z8PPbco+PvTb/nRWjeoFlJ1Qer83k/3C5PHQi28hiVdeE2kHXmIL99mQFawx8qt/JPjZilJ8Q=="
+    },
     "@types/node": {
       "version": "12.0.2",
       "resolved": "https://registry.npmjs.org/@types/node/-/node-12.0.2.tgz",

packages/core/package.json

@@ -36,6 +36,7 @@
     "url": "https://github.com/actions/toolkit/issues"
   },
   "dependencies": {
+    "@actions/exec": "^1.1.1",
     "@actions/http-client": "^2.0.1",
     "uuid": "^8.3.2"
   },

packages/core/src/core.ts

@@ -386,3 +386,8 @@ export {markdownSummary} from './summary'
  * Path exports
  */
 export {toPosixPath, toWin32Path, toPlatformPath} from './path-utils'
+
+/**
+ * Platform utilities exports
+ */
+export * as platform from './platform'

packages/core/src/platform.ts

@@ -0,0 +1,87 @@
+import os from 'os'
+import * as exec from '@actions/exec'
+
+const getWindowsInfo = async (): Promise<{name: string; version: string}> => {
+  const {stdout: version} = await exec.getExecOutput(
+    'powershell -command "(Get-CimInstance -ClassName Win32_OperatingSystem).Version"',
+    undefined,
+    {
+      silent: true
+    }
+  )
+
+  const {stdout: name} = await exec.getExecOutput(
+    'powershell -command "(Get-CimInstance -ClassName Win32_OperatingSystem).Caption"',
+    undefined,
+    {
+      silent: true
+    }
+  )
+
+  return {
+    name: name.trim(),
+    version: version.trim()
+  }
+}
+
+const getMacOsInfo = async (): Promise<{
+  name: string
+  version: string
+}> => {
+  const {stdout} = await exec.getExecOutput('sw_vers', undefined, {
+    silent: true
+  })
+
+  const version = stdout.match(/ProductVersion:\s*(.+)/)?.[1] ?? ''
+  const name = stdout.match(/ProductName:\s*(.+)/)?.[1] ?? ''
+
+  return {
+    name,
+    version
+  }
+}
+
+const getLinuxInfo = async (): Promise<{
+  name: string
+  version: string
+}> => {
+  const {stdout} = await exec.getExecOutput('lsb_release', ['-i', '-r', '-s'], {
+    silent: true
+  })
+
+  const [name, version] = stdout.trim().split('\n')
+
+  return {
+    name,
+    version
+  }
+}
+
+export const platform = os.platform()
+export const arch = os.arch()
+export const isWindows = platform === 'win32'
+export const isMacOS = platform === 'darwin'
+export const isLinux = platform === 'linux'
+
+export async function getDetails(): Promise<{
+  name: string
+  platform: string
+  arch: string
+  version: string
+  isWindows: boolean
+  isMacOS: boolean
+  isLinux: boolean
+}> {
+  return {
+    ...(await (isWindows
+      ? getWindowsInfo()
+      : isMacOS
+      ? getMacOsInfo()
+      : getLinuxInfo())),
+    platform,
+    arch,
+    isWindows,
+    isMacOS,
+    isLinux
+  }
+}