Explicitly import crypto (#1842)

joshmgross · web-flow · commit d14afd7973c0 · 2024-10-04T17:23:42.000-04:00
* Explicitly import `crypto`

* Add release notes for 1.11.1

* Fix crypto mock in test

* Fix `crypto` mock

* Lint
diff --git a/packages/cache/src/internal/cacheUtils.ts b/packages/cache/src/internal/cacheUtils.ts
@@ -2,6 +2,7 @@ import * as core from '@actions/core'
 import * as exec from '@actions/exec'
 import * as glob from '@actions/glob'
 import * as io from '@actions/io'
+import * as crypto from 'crypto'
 import * as fs from 'fs'
 import * as path from 'path'
 import * as semver from 'semver'
diff --git a/packages/core/RELEASES.md b/packages/core/RELEASES.md
@@ -1,5 +1,8 @@
 # @actions/core Releases
 
+### 1.11.1
+- Fix uses of `crypto.randomUUID` on Node 18 and earlier [#1842](https://github.com/actions/toolkit/pull/1842)
+
 ### 1.11.0
 - Add platform info utilities [#1551](https://github.com/actions/toolkit/pull/1551)
 - Remove dependency on `uuid` package [#1824](https://github.com/actions/toolkit/pull/1824)
diff --git a/packages/core/__tests__/core.test.ts b/packages/core/__tests__/core.test.ts
@@ -46,6 +46,11 @@ const testEnvVars = {
 const UUID = '9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d'
 const DELIMITER = `ghadelimiter_${UUID}`
 
+jest.mock('crypto', () => ({
+  ...jest.requireActual('crypto'),
+  randomUUID: jest.fn(() => UUID)
+}))
+
 const TEMP_DIR = path.join(__dirname, '_temp')
 
 describe('@actions/core', () => {
@@ -66,10 +71,6 @@ describe('@actions/core', () => {
       process.env[key] = testEnvVars[key as keyof typeof testEnvVars]
     }
     process.stdout.write = jest.fn()
-
-    jest.spyOn(crypto, 'randomUUID').mockImplementation(() => {
-      return UUID
-    })
   })
 
   afterEach(() => {
diff --git a/packages/core/package-lock.json b/packages/core/package-lock.json
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@actions/core",
-  "version": "1.11.0",
+  "version": "1.11.1",
   "description": "Actions core lib",
   "keywords": [
     "github",
@@ -40,6 +40,6 @@
     "@actions/http-client": "^2.0.1"
   },
   "devDependencies": {
-    "@types/node": "^12.0.2"
+    "@types/node": "^16.18.112"
   }
 }
diff --git a/packages/core/src/file-command.ts b/packages/core/src/file-command.ts
@@ -3,6 +3,7 @@
 // We use any as a valid input type
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
+import * as crypto from 'crypto'
 import * as fs from 'fs'
 import * as os from 'os'
 import {toCommandValue} from './utils'
diff --git a/packages/tool-cache/src/tool-cache.ts b/packages/tool-cache/src/tool-cache.ts
@@ -1,5 +1,6 @@
 import * as core from '@actions/core'
 import * as io from '@actions/io'
+import * as crypto from 'crypto'
 import * as fs from 'fs'
 import * as mm from './manifest'
 import * as os from 'os'

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@actions/core",`
`3`		`- "version": "1.11.0",`
	`3`	`+ "version": "1.11.1",`
`4`	`4`	`"description": "Actions core lib",`
`5`	`5`	`"keywords": [`
`6`	`6`	`"github",`
`@@ -40,6 +40,6 @@`
`40`	`40`	`"@actions/http-client": "^2.0.1"`
`41`	`41`	`},`
`42`	`42`	`"devDependencies": {`
`43`		`- "@types/node": "^12.0.2"`
	`43`	`+ "@types/node": "^16.18.112"`
`44`	`44`	`}`
`45`	`45`	`}`