feat(ec2): provide link for customer to view system logs (#5633)

## Problem
Limited ability to diagnose problems with EC2 instances provided in the
toolkit.

## Solution
Add a right click option to provide system log of Ec2 instance in
read-only file view.
### Implementation Details
- Log view does NOT live update. This would require refactoring the CWL
significantly. Better to get the feature out and see if this is
something customers want/need.
- To reduce code duplication two new utility components were added
`decodeBase64` in`core/src/shared/utilities/textUtilities.ts` and
`UriSchema` in `core/src/shared/utilities/uriUtils.ts`.
- `decodeBase64` is a helper function to wrap the use of `Buffer.from(X,
"base64").toString()` throughout the toolkit.
- `UriSchema` provides a general framework for translating between an
object and an URI, and vice versa. It allows us to avoid writing the
`isValid` method in all cases. With more work this could likely be more
general, but is only used twice so unclear if it is worth pursuing.
- These changes involved changing some function calls, especially in the
CWL code, but does not impact functionality.
### Pictures 
<img width="1231" alt="image"
src="https://github.com/user-attachments/assets/0991c51e-6e27-4102-a85f-08246a7faab0">
<img width="1508" alt="image"
src="https://github.com/user-attachments/assets/558d831f-7a7c-475b-9400-719ce8fd99d7">


---

<!--- REMINDER: Ensure that your PR meets the guidelines in
CONTRIBUTING.md -->

License: I confirm that my contribution is made under the terms of the
Apache 2.0 license.

---------

Co-authored-by: Justin M. Keyes <[email protected]>

Author: Hweinstock

packages/core/package.nls.json

@@ -129,6 +129,7 @@
     "AWS.command.ec2.stopInstance": "Stop EC2 Instance",
     "AWS.command.ec2.rebootInstance": "Reboot EC2 Instance",
     "AWS.command.ec2.copyInstanceId": "Copy Instance Id",
+    "AWS.command.ec2.viewLogs": "View EC2 Logs",
     "AWS.command.ecr.copyTagUri": "Copy Tag URI",
     "AWS.command.ecr.copyRepositoryUri": "Copy Repository URI",
     "AWS.command.ecr.createRepository": "Create Repository...",

packages/core/src/awsService/cloudWatchLogs/changeLogSearch.ts

@@ -5,7 +5,7 @@
 import { CancellationError } from '../../shared/utilities/timeoutUtils'
 import { telemetry } from '../../shared/telemetry/telemetry'
 import { showInputBox } from '../../shared/ui/inputPrompter'
-import { createURIFromArgs, isLogStreamUri, recordTelemetryFilter } from './cloudWatchLogsUtils'
+import { cwlUriSchema, isLogStreamUri, recordTelemetryFilter } from './cloudWatchLogsUtils'
 import { prepareDocument } from './commands/searchLogGroup'
 import { getActiveDocumentUri } from './document/logDataDocumentProvider'
 import { CloudWatchLogsData, filterLogEventsFromUri, LogDataRegistry } from './registry/logDataRegistry'
@@ -98,7 +98,7 @@ export async function changeLogSearchParams(
             throw new CancellationError('user')
         }
 
-        const newUri = createURIFromArgs(newData.logGroupInfo, newData.parameters)
+        const newUri = cwlUriSchema.form({ logGroupInfo: newData.logGroupInfo, parameters: newData.parameters })
         await prepareDocument(newUri, newData, registry)
     })
 }

packages/core/src/awsService/cloudWatchLogs/cloudWatchLogsUtils.ts

@@ -6,8 +6,9 @@ import { telemetry } from '../../shared/telemetry/telemetry'
 import * as vscode from 'vscode'
 import { CLOUDWATCH_LOGS_SCHEME } from '../../shared/constants'
 import { fromExtensionManifest } from '../../shared/settings'
-import { CloudWatchLogsData, CloudWatchLogsGroupInfo } from './registry/logDataRegistry'
+import { CloudWatchLogsArgs, CloudWatchLogsData, CloudWatchLogsGroupInfo } from './registry/logDataRegistry'
 import { CloudWatchLogsParameters } from './registry/logDataRegistry'
+import { UriSchema } from '../../shared/utilities/uriUtils'
 
 // URIs are the only vehicle for delivering information to a TextDocumentContentProvider.
 // The following functions are used to structure and destructure relevant information to/from a URI.
@@ -32,8 +33,7 @@ export function recordTelemetryFilter(logData: CloudWatchLogsData): void {
 export function uriToKey(uri: vscode.Uri): string {
     if (uri.query) {
         try {
-            const { filterPattern, startTime, endTime, limit, streamNameOptions } =
-                parseCloudWatchLogsUri(uri).parameters
+            const { filterPattern, startTime, endTime, limit, streamNameOptions } = cwlUriSchema.parse(uri).parameters
             const parts = [uri.path, filterPattern, startTime, endTime, limit, streamNameOptions]
             return parts.map((p) => p ?? '').join(':')
         } catch {
@@ -52,18 +52,15 @@ export function uriToKey(uri: vscode.Uri): string {
  * message as the actual log group search. That results in a more fluid UX.
  */
 export function msgKey(logGroupInfo: CloudWatchLogsGroupInfo): string {
-    const uri = createURIFromArgs(logGroupInfo, {})
+    const uri = cwlUriSchema.form({ logGroupInfo: logGroupInfo, parameters: {} })
     return uri.toString()
 }
 
 /**
  * Destructures an awsCloudWatchLogs URI into its component pieces.
  * @param uri URI for a Cloudwatch Logs file
  */
-export function parseCloudWatchLogsUri(uri: vscode.Uri): {
-    logGroupInfo: CloudWatchLogsGroupInfo
-    parameters: CloudWatchLogsParameters
-} {
+function parseCloudWatchLogsUri(uri: vscode.Uri): CloudWatchLogsArgs {
     const parts = uri.path.split(':')
 
     if (uri.scheme !== CLOUDWATCH_LOGS_SCHEME) {
@@ -85,18 +82,8 @@ export function parseCloudWatchLogsUri(uri: vscode.Uri): {
     }
 }
 
-/** True if given URI is a valid Cloud Watch Logs Uri */
-export function isCwlUri(uri: vscode.Uri): boolean {
-    try {
-        parseCloudWatchLogsUri(uri)
-        return true
-    } catch {
-        return false
-    }
-}
-
 export function patternFromCwlUri(uri: vscode.Uri): CloudWatchLogsParameters['filterPattern'] {
-    return parseCloudWatchLogsUri(uri).parameters.filterPattern
+    return cwlUriSchema.parse(uri).parameters.filterPattern
 }
 
 /**
@@ -105,7 +92,7 @@ export function patternFromCwlUri(uri: vscode.Uri): CloudWatchLogsParameters['fi
  * @returns
  */
 export function isLogStreamUri(uri: vscode.Uri): boolean {
-    const logGroupInfo = parseCloudWatchLogsUri(uri).logGroupInfo
+    const logGroupInfo = cwlUriSchema.parse(uri).logGroupInfo
     return logGroupInfo.streamName !== undefined
 }
 
@@ -115,15 +102,13 @@ export function isLogStreamUri(uri: vscode.Uri): boolean {
  * @param streamName Log stream name
  * @param regionName AWS region
  */
-export function createURIFromArgs(
-    logGroupInfo: CloudWatchLogsGroupInfo,
-    parameters: CloudWatchLogsParameters
-): vscode.Uri {
-    let uriStr = `${CLOUDWATCH_LOGS_SCHEME}:${logGroupInfo.regionName}:${logGroupInfo.groupName}`
-    uriStr += logGroupInfo.streamName ? `:${logGroupInfo.streamName}` : ''
+function createURIFromArgs(args: CloudWatchLogsArgs): vscode.Uri {
+    let uriStr = `${CLOUDWATCH_LOGS_SCHEME}:${args.logGroupInfo.regionName}:${args.logGroupInfo.groupName}`
+    uriStr += args.logGroupInfo.streamName ? `:${args.logGroupInfo.streamName}` : ''
 
-    uriStr += `?${encodeURIComponent(JSON.stringify(parameters))}`
+    uriStr += `?${encodeURIComponent(JSON.stringify(args.parameters))}`
     return vscode.Uri.parse(uriStr)
 }
+export const cwlUriSchema = new UriSchema<CloudWatchLogsArgs>(parseCloudWatchLogsUri, createURIFromArgs)
 
 export class CloudWatchLogsSettings extends fromExtensionManifest('aws.cwl', { limit: Number }) {}

packages/core/src/awsService/cloudWatchLogs/commands/copyLogResource.ts

@@ -7,7 +7,7 @@ import * as nls from 'vscode-nls'
 const localize = nls.loadMessageBundle()
 
 import * as vscode from 'vscode'
-import { isLogStreamUri, parseCloudWatchLogsUri } from '../cloudWatchLogsUtils'
+import { cwlUriSchema, isLogStreamUri } from '../cloudWatchLogsUtils'
 import { copyToClipboard } from '../../../shared/utilities/messages'
 
 export async function copyLogResource(uri?: vscode.Uri): Promise<void> {
@@ -20,7 +20,7 @@ export async function copyLogResource(uri?: vscode.Uri): Promise<void> {
                 throw new Error('no active text editor, or undefined URI')
             }
         }
-        const parsedUri = parseCloudWatchLogsUri(uri)
+        const parsedUri = cwlUriSchema.parse(uri)
         const resourceName = isLogStreamUri(uri) ? parsedUri.logGroupInfo.streamName : parsedUri.logGroupInfo.groupName
 
         if (!resourceName) {

packages/core/src/awsService/cloudWatchLogs/commands/saveCurrentLogDataContent.ts

@@ -7,7 +7,7 @@ import * as vscode from 'vscode'
 import * as nls from 'vscode-nls'
 const localize = nls.loadMessageBundle()
 
-import { isLogStreamUri, parseCloudWatchLogsUri } from '../cloudWatchLogsUtils'
+import { cwlUriSchema, isLogStreamUri } from '../cloudWatchLogsUtils'
 import { telemetry, CloudWatchResourceType, Result } from '../../../shared/telemetry/telemetry'
 import fs from '../../../shared/fs/fs'
 
@@ -28,7 +28,7 @@ export async function saveCurrentLogDataContent(): Promise<void> {
         const workspaceDir = vscode.workspace.workspaceFolders
             ? vscode.workspace.workspaceFolders[0].uri
             : vscode.Uri.file(fs.getUserHomeDir())
-        const uriComponents = parseCloudWatchLogsUri(uri)
+        const uriComponents = cwlUriSchema.parse(uri)
         const logGroupInfo = uriComponents.logGroupInfo
 
         const localizedLogFile = localize('AWS.command.saveCurrentLogDataContent.logfile', 'Log File')

packages/core/src/awsService/cloudWatchLogs/commands/searchLogGroup.ts

@@ -16,7 +16,7 @@ import {
 } from '../registry/logDataRegistry'
 import { DataQuickPickItem } from '../../../shared/ui/pickerPrompter'
 import { isValidResponse, isWizardControl, Wizard, WIZARD_RETRY } from '../../../shared/wizards/wizard'
-import { createURIFromArgs, msgKey, parseCloudWatchLogsUri, recordTelemetryFilter } from '../cloudWatchLogsUtils'
+import { cwlUriSchema, msgKey, recordTelemetryFilter } from '../cloudWatchLogsUtils'
 import { DefaultCloudWatchLogsClient } from '../../../shared/clients/cloudWatchLogsClient'
 import { CancellationError } from '../../../shared/utilities/timeoutUtils'
 import { getLogger } from '../../../shared/logger'
@@ -29,6 +29,7 @@ import { createBackButton, createExitButton, createHelpButton } from '../../../s
 import { PromptResult } from '../../../shared/ui/prompter'
 import { ToolkitError } from '../../../shared/errors'
 import { Messages } from '../../../shared/utilities/messages'
+import { showFile } from '../../../shared/utilities/textDocumentUtilities'
 
 const localize = nls.loadMessageBundle()
 
@@ -65,9 +66,7 @@ export async function prepareDocument(uri: vscode.Uri, logData: CloudWatchLogsDa
     try {
         // Gets the data: calls filterLogEventsFromUri().
         await registry.fetchNextLogEvents(uri)
-        const doc = await vscode.workspace.openTextDocument(uri)
-        await vscode.window.showTextDocument(doc, { preview: false })
-        await vscode.languages.setTextDocumentLanguage(doc, 'log')
+        await showFile(uri)
     } catch (err) {
         if (CancellationError.isUserCancelled(err)) {
             throw err
@@ -78,7 +77,7 @@ export async function prepareDocument(uri: vscode.Uri, logData: CloudWatchLogsDa
             localize(
                 'AWS.cwl.searchLogGroup.errorRetrievingLogs',
                 'Failed to get logs for {0}',
-                parseCloudWatchLogsUri(uri).logGroupInfo.groupName
+                cwlUriSchema.parse(uri).logGroupInfo.groupName
             )
         )
     }
@@ -105,7 +104,7 @@ export async function searchLogGroup(
         }
 
         const userResponse = handleWizardResponse(response, registry)
-        const uri = createURIFromArgs(userResponse.logGroupInfo, userResponse.parameters)
+        const uri = cwlUriSchema.form({ logGroupInfo: userResponse.logGroupInfo, parameters: userResponse.parameters })
         await prepareDocument(uri, userResponse, registry)
     })
 }

packages/core/src/awsService/cloudWatchLogs/commands/viewLogStream.ts

@@ -21,11 +21,11 @@ import {
     initLogData as initLogData,
     filterLogEventsFromUri,
 } from '../registry/logDataRegistry'
-import { createURIFromArgs } from '../cloudWatchLogsUtils'
 import { prepareDocument, searchLogGroup } from './searchLogGroup'
 import { telemetry, Result } from '../../../shared/telemetry/telemetry'
 import { CancellationError } from '../../../shared/utilities/timeoutUtils'
 import { formatLocalized } from '../../../shared/utilities/textUtilities'
+import { cwlUriSchema } from '../cloudWatchLogsUtils'
 
 export async function viewLogStream(node: LogGroupNode, registry: LogDataRegistry): Promise<void> {
     await telemetry.cloudwatchlogs_open.run(async (span) => {
@@ -52,7 +52,7 @@ export async function viewLogStream(node: LogGroupNode, registry: LogDataRegistr
             limit: registry.configuration.get('limit', 10000),
         }
 
-        const uri = createURIFromArgs(logGroupInfo, parameters)
+        const uri = cwlUriSchema.form({ logGroupInfo: logGroupInfo, parameters: parameters })
         const logData = initLogData(logGroupInfo, parameters, filterLogEventsFromUri)
         await prepareDocument(uri, logData, registry)
     })

packages/core/src/awsService/cloudWatchLogs/document/logDataDocumentProvider.ts

@@ -5,8 +5,8 @@
 import * as vscode from 'vscode'
 import { CloudWatchLogsGroupInfo, LogDataRegistry, UriString } from '../registry/logDataRegistry'
 import { getLogger } from '../../../shared/logger'
-import { isCwlUri } from '../cloudWatchLogsUtils'
 import { generateTextFromLogEvents, LineToLogStreamMap } from './textContent'
+import { cwlUriSchema } from '../cloudWatchLogsUtils'
 
 export class LogDataDocumentProvider implements vscode.TextDocumentContentProvider {
     /** Resolves the correct {@link LineToLogStreamMap} instance for a given URI */
@@ -26,7 +26,7 @@ export class LogDataDocumentProvider implements vscode.TextDocumentContentProvid
     }
 
     public provideTextDocumentContent(uri: vscode.Uri): string {
-        if (!isCwlUri(uri)) {
+        if (!cwlUriSchema.isValid(uri)) {
             throw new Error(`Uri is not a CWL Uri, so no text can be provided: ${uri.toString()}`)
         }
         const events = this.registry.fetchCachedLogEvents(uri)

packages/core/src/awsService/cloudWatchLogs/document/logStreamsCodeLensProvider.ts

@@ -6,12 +6,7 @@
 import * as vscode from 'vscode'
 import { CLOUDWATCH_LOGS_SCHEME } from '../../../shared/constants'
 import { CloudWatchLogsGroupInfo, LogDataRegistry } from '../registry/logDataRegistry'
-import {
-    CloudWatchLogsSettings,
-    createURIFromArgs,
-    isLogStreamUri,
-    parseCloudWatchLogsUri,
-} from '../cloudWatchLogsUtils'
+import { CloudWatchLogsSettings, cwlUriSchema, isLogStreamUri } from '../cloudWatchLogsUtils'
 import { LogDataDocumentProvider } from './logDataDocumentProvider'
 
 type IdWithLine = { streamId: string; lineNum: number }
@@ -43,7 +38,7 @@ export class LogStreamCodeLensProvider implements vscode.CodeLensProvider {
             return []
         }
 
-        const logGroupInfo = parseCloudWatchLogsUri(uri).logGroupInfo
+        const logGroupInfo = cwlUriSchema.parse(uri).logGroupInfo
 
         if (logGroupInfo.streamName) {
             // This means we have a stream file not a log search.
@@ -64,7 +59,11 @@ export class LogStreamCodeLensProvider implements vscode.CodeLensProvider {
     createLogStreamCodeLens(logGroupInfo: CloudWatchLogsGroupInfo, idWithLine: IdWithLine): vscode.CodeLens {
         const settings = new CloudWatchLogsSettings()
         const limit = settings.get('limit', 1000)
-        const streamUri = createURIFromArgs({ ...logGroupInfo, streamName: idWithLine.streamId }, { limit: limit })
+        const cwlArgs = {
+            logGroupInfo: { ...logGroupInfo, streamName: idWithLine.streamId },
+            parameters: { limit: limit },
+        }
+        const streamUri = cwlUriSchema.form(cwlArgs)
         const cmd: vscode.Command = {
             command: 'aws.loadLogStreamFile',
             arguments: [streamUri, this.registry],

packages/core/src/awsService/cloudWatchLogs/registry/logDataRegistry.ts

@@ -5,7 +5,7 @@
 
 import * as vscode from 'vscode'
 import { CloudWatchLogs } from 'aws-sdk'
-import { CloudWatchLogsSettings, parseCloudWatchLogsUri, uriToKey, msgKey } from '../cloudWatchLogsUtils'
+import { CloudWatchLogsSettings, uriToKey, msgKey, cwlUriSchema } from '../cloudWatchLogsUtils'
 import { DefaultCloudWatchLogsClient } from '../../../shared/clients/cloudWatchLogsClient'
 import { waitTimeout } from '../../../shared/utilities/timeoutUtils'
 import { Messages } from '../../../shared/utilities/messages'
@@ -190,7 +190,7 @@ export class LogDataRegistry {
         if (this.isRegistered(uri)) {
             throw new Error(`Already registered: ${uri.toString()}`)
         }
-        const data = parseCloudWatchLogsUri(uri)
+        const data = cwlUriSchema.parse(uri)
         this.setLogData(uri, initLogData(data.logGroupInfo, data.parameters, retrieveLogsFunction))
     }
 
@@ -281,6 +281,11 @@ export function initLogData(
     }
 }
 
+export type CloudWatchLogsArgs = {
+    logGroupInfo: CloudWatchLogsGroupInfo
+    parameters: CloudWatchLogsParameters
+}
+
 export type CloudWatchLogsGroupInfo = {
     groupName: string
     regionName: string