Increasing likelihood of users encountering codelenses (#1115)

This change is twofold:

* We now activate the toolkit on a user opening a JS, C#, Python, or YAML file
* If the user doesn't have the RedHat YAML Language Support extension installed, we prompt them to install it. This is required for codelenses in YAML files.

Author: bryceitoc9

package.json

@@ -55,7 +55,11 @@
         "onView:aws.cdk.explorer",
         "onCommand:aws.refreshCdkExplorer",
         "onCommand:aws.aboutToolkit",
-        "onLanguage:asl"
+        "onLanguage:asl",
+        "onLanguage:javascript",
+        "onLanguage:python",
+        "onLanguage:csharp",
+        "onLanguage:yaml"
     ],
     "main": "./extensionMain",
     "contributes": {

package.nls.json

@@ -193,6 +193,9 @@
     "AWS.message.info.stepFunctions.publishStateMachine.creating": "Creating state machine '{0}' in {1}...",
     "AWS.message.info.stepFunctions.publishStateMachine.updateSuccess": "Successfully updated state machine '{0}'",
     "AWS.message.info.stepFunctions.publishStateMachine.updating": "Updating state machine '{0}' in {1}...",
+    "AWS.message.info.yaml.prompt": "Install YAML extension for additional AWS features.",
+    "AWS.message.info.yaml.goToMarketplace": "Open Marketplace Page",
+    "AWS.message.info.yaml.suppressPrompt": "Dismiss, and don't show again",
     "AWS.schemas.downloadCodeBindings.initWizard.language.prompt": "Select a code binding language",
     "AWS.schemas.downloadCodeBindings.initWizard.version.prompt": "Select a version for schema {0} :",
     "AWS.schemas.downloadCodeBindings.initWizard.location.prompt": "Select a workspace folder to download code binding",
@@ -352,6 +355,7 @@
     "AWS.stepfunctions.visualisation.errors.rename": "State machine visualization closed due to file renaming or closure.",
     "AWS.submitFeedback.title": "Submit Quick Feedback",
     "AWS.wizard.selectedPreviously": "Selected Previously",
+    "AWS.generic.response.dismiss": "Dismiss",
     "AWS.generic.response.no": "No",
     "AWS.generic.response.yes": "Yes",
     "AWS.generic.notImplemented": "Not implemented",

src/shared/extensionUtilities.ts

@@ -16,6 +16,23 @@ import { getLogger } from './logger'
 
 const localize = nls.loadMessageBundle()
 
+const VSCODE_APPNAME = 'Visual Studio Code'
+
+export enum IDE {
+    vscode,
+    unknown,
+}
+
+export function getIdeType(): IDE {
+    // Theia doesn't necessarily have all env propertie
+    // so we should be defensive and assume appName is nullable.
+    if (vscode.env.appName?.startsWith(VSCODE_APPNAME)) {
+        return IDE.vscode
+    }
+
+    return IDE.unknown
+}
+
 export class ExtensionUtilities {
     public static getLibrariesForHtml(names: string[]): ScriptResource[] {
         const basePath = path.join(ext.context.extensionPath, 'media', 'libs')

src/shared/extensions.ts

@@ -13,6 +13,7 @@ import { ChannelLogger } from './utilities/vsCodeUtils'
 export const VSCODE_EXTENSION_ID = {
     awstoolkit: 'amazonwebservices.aws-toolkit-vscode',
     python: 'ms-python.python',
+    yaml: 'redhat.vscode-yaml',
 }
 
 /**

src/shared/sam/activation.ts

@@ -3,6 +3,9 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import * as nls from 'vscode-nls'
+const localize = nls.loadMessageBundle()
+
 import * as vscode from 'vscode'
 import { createNewSamApplication, resumeCreateNewSamApp } from '../../lambda/commands/createNewSamApp'
 import { deploySamApplication, SamDeployWizardResponseProvider } from '../../lambda/commands/deploySamApplication'
@@ -17,7 +20,10 @@ import * as codelensUtils from '../codelens/codeLensUtils'
 import * as csLensProvider from '../codelens/csharpCodeLensProvider'
 import * as pyLensProvider from '../codelens/pythonCodeLensProvider'
 import { SamTemplateCodeLensProvider } from '../codelens/samTemplateCodeLensProvider'
-import { ExtContext } from '../extensions'
+import { ext } from '../extensionGlobals'
+import { ExtContext, VSCODE_EXTENSION_ID } from '../extensions'
+import { getIdeType, IDE } from '../extensionUtilities'
+import { getLogger } from '../logger/logger'
 import { SettingsConfiguration } from '../settingsConfiguration'
 import { TelemetryService } from '../telemetry/telemetryService'
 import { PromiseSharer } from '../utilities/promiseUtilities'
@@ -28,12 +34,16 @@ import { addSamDebugConfiguration } from './debugger/commands/addSamDebugConfigu
 import { SamDebugSession } from './debugger/samDebugSession'
 import { AWS_SAM_DEBUG_TYPE } from './debugger/awsSamDebugConfiguration'
 
+const STATE_NAME_SUPPRESS_YAML_PROMPT = 'aws.sam.suppressYamlPrompt'
+
 /**
  * Activate SAM-related functionality.
  */
 export async function activate(ctx: ExtContext): Promise<void> {
     initializeSamCliContext({ settingsConfiguration: ctx.settings })
 
+    createYamlExtensionPrompt()
+
     ctx.extensionContext.subscriptions.push(
         ...(await activateCodeLensProviders(ctx, ctx.settings, ctx.outputChannel, ctx.telemetryService))
     )
@@ -182,3 +192,102 @@ class InlineDebugAdapterFactory implements vscode.DebugAdapterDescriptorFactory
         return new vscode.DebugAdapterInlineImplementation(new SamDebugSession(this.ctx))
     }
 }
+
+/**
+ * Creates a prompt (via toast) to guide users to installing the Red Hat YAML extension.
+ * This is necessary for displaying codelenses on templaye YAML files.
+ * Will show once per extension activation at most (all prompting triggers are disposed of on first trigger)
+ * Will not show if the YAML extension is installed or if a user has permanently dismissed the message.
+ */
+function createYamlExtensionPrompt(): void {
+    const neverPromptAgain = ext.context.globalState.get<boolean>(STATE_NAME_SUPPRESS_YAML_PROMPT)
+
+    // only pop this up in VS Code and Insiders since other VS Code-like IDEs (e.g. Theia) may not have a marketplace or contain the YAML plugin
+    if (!neverPromptAgain && getIdeType() === IDE.vscode && !vscode.extensions.getExtension(VSCODE_EXTENSION_ID.yaml)) {
+        // these will all be disposed immediately after showing one so the user isn't prompted more than once per session
+        const yamlPromptDisposables: vscode.Disposable[] = []
+
+        // user opens a template file
+        vscode.workspace.onDidOpenTextDocument(
+            async (doc: vscode.TextDocument) => {
+                promptInstallYamlPlugin(doc.fileName, yamlPromptDisposables)
+            },
+            undefined,
+            yamlPromptDisposables
+        )
+
+        // user swaps to an already-open template file that didn't have focus
+        vscode.window.onDidChangeActiveTextEditor(
+            async (editor: vscode.TextEditor | undefined) => {
+                await promptInstallYamlPluginFromEditor(editor, yamlPromptDisposables)
+            },
+            undefined,
+            yamlPromptDisposables
+        )
+
+        // user already has an open template with focus
+        // prescreen if a template.yaml is current open so we only call once
+        const openTemplateYamls = vscode.window.visibleTextEditors.filter(editor => {
+            const fileName = editor.document.fileName
+            return fileName.endsWith('template.yaml') || fileName.endsWith('template.yml')
+        })
+
+        if (openTemplateYamls.length > 0) {
+            promptInstallYamlPluginFromEditor(openTemplateYamls[0], yamlPromptDisposables)
+        }
+    }
+}
+
+async function promptInstallYamlPluginFromEditor(
+    editor: vscode.TextEditor | undefined,
+    disposables: vscode.Disposable[]
+): Promise<void> {
+    if (editor) {
+        promptInstallYamlPlugin(editor.document.fileName, disposables)
+    }
+}
+
+/**
+ * Looks for template.yaml and template.yml files and disp[oses prompts
+ * @param fileName File name to check against
+ * @param disposables List of disposables to dispose of when the filename is a template YAML file
+ */
+async function promptInstallYamlPlugin(fileName: string, disposables: vscode.Disposable[]): Promise<void> {
+    if (fileName.endsWith('template.yaml') || fileName.endsWith('template.yml')) {
+        // immediately dispose other triggers so it doesn't flash again
+        for (const prompt of disposables) {
+            prompt.dispose()
+        }
+
+        const goToMarketplace = localize('AWS.message.info.yaml.goToMarketplace', 'Open Marketplace Page')
+        const dismiss = localize('AWS.generic.response.dismiss', 'Dismiss')
+        const permanentlySuppress = localize('AWS.message.info.yaml.suppressPrompt', "Dismiss, and don't show again")
+
+        const response = await vscode.window.showInformationMessage(
+            localize('AWS.message.info.yaml.prompt', 'Install YAML extension for additional AWS features.'),
+            goToMarketplace,
+            dismiss,
+            permanentlySuppress
+        )
+
+        switch (response) {
+            case goToMarketplace:
+                // Available options are:
+                // extension.open: opens extension page in VS Code extension marketplace view
+                // workspace.extension.installPlugin: autoinstalls plugin with no additional feedback
+                // workspace.extension.search: preloads and executes a search in the extension sidebar with the given term
+
+                // not sure if these are 100% stable.
+                // Opting for `extension.open` as this gives the user a good path forward to install while not doing anything potentially unexpected.
+                try {
+                    await vscode.commands.executeCommand('extension.open', VSCODE_EXTENSION_ID.yaml)
+                } catch (e) {
+                    const err = e as Error
+                    getLogger().error(`Extension ${VSCODE_EXTENSION_ID.yaml} could not be opened: `, err.message)
+                }
+                break
+            case permanentlySuppress:
+                ext.context.globalState.update(STATE_NAME_SUPPRESS_YAML_PROMPT, true)
+        }
+    }
+}