web: make shared crypto.randomUUID() function (#4693)

* refactor: globalThis.crypto.randomUUID()

Before, `crypto.randomUUID()` broke web mode since it is
not available in the polyfill `crypto-browserify`.

Solution:

Use `globalThis.crypto.randomUUID()` as it works in both node + browser
since each environment provides an implementation at runtime.

In the long term we will want a better solution, but this commit
quickly gets web mode working.

Signed-off-by: Nikolas Komonen <[email protected]>

* use randomUUID in existing places

Signed-off-by: Nikolas Komonen <[email protected]>

* add tests

Signed-off-by: Nikolas Komonen <[email protected]>

* add documentation

Signed-off-by: Nikolas Komonen <[email protected]>

---------

Signed-off-by: Nikolas Komonen <[email protected]>

Author: nkomonen-amazon

packages/core/src/amazonqFeatureDev/session/sessionState.ts

@@ -4,7 +4,6 @@
  */
 
 import { MynahIcons } from '@aws/mynah-ui'
-import { randomUUID } from 'crypto'
 import * as path from 'path'
 import * as vscode from 'vscode'
 import { ToolkitError } from '../../shared/errors'
@@ -34,6 +33,7 @@ import { CodeReference } from '../../amazonq/webview/ui/connector'
 import { isPresent } from '../../shared/utilities/collectionUtils'
 import { encodeHTML } from '../../shared/utilities/textUtilities'
 import { AuthUtil } from '../../codewhisperer/util/authUtil'
+import { randomUUID } from '../../common/crypto'
 
 export class ConversationNotStartedState implements Omit<SessionState, 'uploadId'> {
     public tokenSource: vscode.CancellationTokenSource

packages/core/src/amazonqGumby/telemetry/codeTransformTelemetryState.ts

@@ -2,7 +2,8 @@
  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0
  */
-import { randomUUID } from 'crypto'
+
+import { randomUUID } from '../../common/crypto'
 
 interface ICodeTransformerTelemetryState {
     sessionId: string

packages/core/src/auth/auth.ts

@@ -10,7 +10,6 @@ const localize = nls.loadMessageBundle()
 
 import * as vscode from 'vscode'
 import * as localizedText from '../shared/localizedText'
-import { randomUUID } from 'crypto'
 import { Credentials } from '@aws-sdk/types'
 import { SsoAccessTokenProvider } from './sso/ssoAccessTokenProvider'
 import { Timeout } from '../shared/utilities/timeoutUtils'
@@ -61,6 +60,7 @@ import {
 } from './connection'
 import { isSageMaker, isCloud9 } from '../shared/extensionUtilities'
 import { telemetry } from '../shared/telemetry/telemetry'
+import { randomUUID } from '../common/crypto'
 
 interface AuthService {
     /**

packages/core/src/codewhispererChat/controllers/chat/controller.ts

@@ -33,7 +33,6 @@ import { EditorContentController } from '../../../amazonq/commons/controllers/co
 import { EditorContextCommand } from '../../commands/registerCommands'
 import { PromptsGenerator } from './prompts/promptsGenerator'
 import { TriggerEventsStorage } from '../../storages/triggerEvents'
-import { randomUUID } from 'crypto'
 import {
     CodeWhispererStreamingServiceException,
     GenerateAssistantResponseCommandOutput,
@@ -46,6 +45,7 @@ import { triggerPayloadToChatRequest } from './chatRequest/converter'
 import { OnboardingPageInteraction } from '../../../amazonq/onboardingPage/model'
 import { getChatAuthState } from '../../../codewhisperer/util/authUtil'
 import { openUrl } from '../../../shared/utilities/vsCodeUtils'
+import { randomUUID } from '../../../common/crypto'
 
 export interface ChatControllerMessagePublishers {
     readonly processPromptChatMessage: MessagePublisher<PromptMessage>

packages/core/src/common/crypto.ts

@@ -0,0 +1,33 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * Why do we need this?
+ *
+ * Depending on environment (node vs web), `crypto` is different.
+ * Node requires `crypto` to be imported, while in web it is available globally
+ * through just calling `crypto` or `globalThis.crypto`.
+ *
+ * The crypto signatures and functions are not 1:1 between the environments.
+ * So this module provides environment agnostic functions for `crypto`.
+ *
+ * ---
+ *
+ * Node `crypto` has `crypto.webcrypto` except the interface is more cumbersome to use
+ * compared to node `crypto`. So we will want to eventually exclusively use functions
+ * in this class instead of the `crypto` functions.
+ *
+ * Once we do not need `crypto` anymore, we can get rid of the polyfill.
+ */
+
+import { isWeb } from './webUtils'
+
+export function randomUUID(): `${string}-${string}-${string}-${string}-${string}` {
+    if (isWeb()) {
+        return globalThis.crypto.randomUUID()
+    }
+
+    return require('crypto').randomUUID()
+}

packages/core/src/shared/telemetry/util.ts

@@ -7,7 +7,6 @@ import { env, Memento, version } from 'vscode'
 import { getLogger } from '../logger'
 import { fromExtensionManifest } from '../settings'
 import { shared } from '../utilities/functionUtils'
-import { randomUUID } from 'crypto'
 import { isInDevEnv, extensionVersion, isAutomation } from '../vscode/env'
 import { addTypeName } from '../utilities/typeConstructors'
 import globals from '../extensionGlobals'
@@ -16,6 +15,7 @@ import { Result } from './telemetry.gen'
 import { MetricDatum } from './clienttelemetry'
 import { isValidationExemptMetric } from './exemptMetrics'
 import { isCloud9, isSageMaker } from '../../shared/extensionUtilities'
+import { randomUUID } from '../../common/crypto'
 
 const legacySettingsTelemetryValueDisable = 'Disable'
 const legacySettingsTelemetryValueEnable = 'Enable'

packages/core/src/test/amazonqFeatureDev/session/sessionState.test.ts

@@ -21,7 +21,7 @@ import { MessagePublisher } from '../../../amazonq/messages/messagePublisher'
 import { FeatureDevClient } from '../../../amazonqFeatureDev/client/featureDev'
 import { ToolkitError } from '../../../shared/errors'
 import { PrepareRepoFailedError } from '../../../amazonqFeatureDev/errors'
-import crypto from 'crypto'
+import * as crypto from '../../../common/crypto'
 import { TelemetryHelper } from '../../../amazonqFeatureDev/util/telemetryHelper'
 import { assertTelemetry, createTestWorkspaceFolder } from '../../testUtil'
 import { getFetchStubWithResponse } from '../../common/request.test'

packages/core/src/test/common/crypto.test.ts

@@ -0,0 +1,28 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import assert from 'assert'
+import { randomUUID } from '../../common/crypto'
+
+describe('crypto', function () {
+    describe('randomUUID()', function () {
+        const uuidPattern = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i
+
+        it('functions as normal', async function () {
+            const result1 = randomUUID()
+            const result2 = randomUUID()
+            const result3 = randomUUID()
+            assert(uuidPattern.test(result1))
+            assert(uuidPattern.test(result2))
+            assert(uuidPattern.test(result3))
+            assert(result1 !== result2)
+            assert(result2 !== result3)
+        })
+
+        it('test pattern fails on non-uuid', function () {
+            assert(uuidPattern.test('not-a-uuid') === false)
+        })
+    })
+})

packages/core/src/testWeb/common/crypto.test.ts

@@ -0,0 +1,28 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import assert from 'assert'
+import { randomUUID } from '../../common/crypto'
+
+describe('crypto', function () {
+    describe('randomUUID()', function () {
+        const uuidPattern = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i
+
+        it('functions as normal', async function () {
+            const result1 = randomUUID()
+            const result2 = randomUUID()
+            const result3 = randomUUID()
+            assert(uuidPattern.test(result1))
+            assert(uuidPattern.test(result2))
+            assert(uuidPattern.test(result3))
+            assert(result1 !== result2)
+            assert(result2 !== result3)
+        })
+
+        it('test pattern fails on non-uuid', function () {
+            assert(uuidPattern.test('not-a-uuid') === false)
+        })
+    })
+})