Support toggling awt development in help center (#886)

Signed-off-by: sheche <[email protected]>

Author: jdneo

src/commands/handler.ts

@@ -7,6 +7,7 @@ import { validateAndRecommendExtension } from "../recommendation";
 import { sendInfo } from "vscode-extension-telemetry-wrapper";
 import { getReleaseNotesEntries, findLatestReleaseNotes } from "../utils";
 import { gt, eq } from "semver";
+import { fetchInitProps } from "../welcome/index";
 
 export async function createMavenProjectCmdHandler(_context: vscode.ExtensionContext) {
   if (!await validateAndRecommendExtension("vscjava.vscode-maven", "Maven extension is recommended to help create Java projects and work with custom goals.", true)) {
@@ -104,3 +105,25 @@ export async function showReleaseNotesHandler(context: vscode.ExtensionContext,
 
   return await showReleaseNotes(context, operationId, version);
 }
+
+export async function toggleAwtDevelopmentHandler(context: vscode.ExtensionContext, _operationId: string, enable: boolean) {
+  const workspaceConfig: vscode.WorkspaceConfiguration = vscode.workspace.getConfiguration("java.completion");
+  const disabledList: string[] = workspaceConfig.get<string[]>("filteredTypes") || [];
+  const filteredTypes: string[] = disabledList.filter((type) => {
+    return !type.startsWith("java.awt.");
+  });
+
+  if (!enable) {
+    filteredTypes.push("java.awt.*");
+  }
+
+  try {
+    await workspaceConfig.update("filteredTypes", filteredTypes, vscode.ConfigurationTarget.Workspace);
+  } catch (e) {
+    vscode.window.showErrorMessage((e as Error).message);
+    return;
+  }
+
+  fetchInitProps(context);
+  vscode.window.showInformationMessage(`Java AWT development is ${enable ? "enabled" : "disabled"}.`);
+}

src/commands/index.ts

@@ -12,7 +12,7 @@ import { javaRuntimeCmdHandler } from "../java-runtime";
 import { overviewCmdHandler } from "../overview";
 import { webviewCmdLinkHandler } from "../utils";
 import { showWelcomeWebview, showWelcomeWebviewBeside } from "../welcome";
-import { createMavenProjectCmdHandler, createMicroProfileStarterProjectCmdHandler, createQuarkusProjectCmdHandler, createSpringBootProjectCmdHandler, installExtensionCmdHandler, openUrlCmdHandler, showExtensionCmdHandler, showReleaseNotesHandler } from "./handler";
+import { createMavenProjectCmdHandler, createMicroProfileStarterProjectCmdHandler, createQuarkusProjectCmdHandler, createSpringBootProjectCmdHandler, installExtensionCmdHandler, openUrlCmdHandler, showExtensionCmdHandler, showReleaseNotesHandler, toggleAwtDevelopmentHandler } from "./handler";
 
 export function initialize(context: vscode.ExtensionContext) {
   registerCommandHandler(context, "java.overview", overviewCmdHandler);
@@ -35,6 +35,7 @@ export function initialize(context: vscode.ExtensionContext) {
   registerCommandHandler(context, "java.classpathConfiguration", showClasspathConfigurationPage);
   registerCommandHandler(context, "java.installJdk", showInstallJdkWebviewBeside);
   registerCommandHandler(context, "java.installJdk.fromWalkthrough", showInstallJdkWebview);
+  registerCommandHandler(context, "java.toggleAwtDevelopment", toggleAwtDevelopmentHandler);
 }
 
 type CommandHandler = (context: vscode.ExtensionContext, operationId: string, ...args: any[]) => any;

src/welcome/assets/components/GetStartedPage.tsx

@@ -13,6 +13,7 @@ import TourPage from "./TourPage";
 export class GetStartedPage extends React.Component<{
     showWhenUsingJava: boolean,
     firstTimeRun: boolean,
+    isAwtDisabled: boolean,
 }> {
 
     render() {
@@ -25,7 +26,7 @@ export class GetStartedPage extends React.Component<{
     }
 
     renderWelcomePage() {
-        const {showWhenUsingJava} = this.props;
+        const {showWhenUsingJava, isAwtDisabled} = this.props;
         return (
             <Container fluid className="root">
                 <Row className="mb-4">
@@ -40,7 +41,7 @@ export class GetStartedPage extends React.Component<{
                 </Row>
                 <Row className="mb-4">
                     <Col>
-                        <NavigationPanel />
+                        <NavigationPanel isAwtDisabled={isAwtDisabled}/>
                     </Col>
                 </Row>
                 <Row className="mb-4 footer">

src/welcome/assets/components/NavigationPanel.tsx

@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 
+import * as _ from "lodash";
 import Tabs from "react-bootstrap/Tabs";
 import Tab from "react-bootstrap/Tab";
 import React from "react";
@@ -13,7 +14,9 @@ import { ListGroup } from "react-bootstrap";
 import { reportTabSwitch, WEBVIEW_ID } from "../utils";
 import { encodeCommandUriWithTelemetry } from "../../../utils/webview";
 
-export default class NavigationPanel extends React.Component {
+export default class NavigationPanel extends React.Component<{
+  isAwtDisabled: boolean;
+}> {
   private groups = [
     {
       name: "General",
@@ -42,14 +45,26 @@ export default class NavigationPanel extends React.Component {
         { name: "Tutorial: Running and Debugging", command: "java.helper.openUrl", args: ["https://code.visualstudio.com/docs/java/java-debugging"] },
         { name: "Tutorial: Testing", command: "java.helper.openUrl", args: ["https://code.visualstudio.com/docs/java/java-testing"] },
         { name: "Configure Sources, Dependencies, Output Folder...", command: "java.classpathConfiguration" },
-        { name: "Quick Start: Jupyter Notebook for Java", command: "java.helper.openUrl", args: ["https://github.com/microsoft/vscode-java-pack/wiki/Quick-Start:-Jupyter-Notebook-for-Java"] }
+        { name: "Quick Start: Jupyter Notebook for Java", command: "java.helper.openUrl", args: ["https://github.com/microsoft/vscode-java-pack/wiki/Quick-Start:-Jupyter-Notebook-for-Java"] },
+        { name: "Enable AWT Development", command: "java.toggleAwtDevelopment", args: [true] },
       ]
     },
   ];
 
   private currentTab: string = this.groups[0].name;
 
   render() {
+    const {isAwtDisabled} = this.props;
+    const studentSection = _.find(this.groups, {name: "Student"});
+    if (studentSection) {
+      for (const action of studentSection.actions) {
+        if (action.command === "java.toggleAwtDevelopment") {
+          action.name = `${isAwtDisabled ? "Enable" : "Disable"} AWT Development`;
+          action.args = [isAwtDisabled];
+        }
+      }
+    }
+
     const itemIcon = <Icon className="codicon" icon={rocketIcon} />;
     const tabItems = this.groups.map(group => {
       const actionItems = group.actions.map(action => (

src/welcome/index.ts

@@ -124,12 +124,13 @@ const setFirstTimeRun = (context: vscode.ExtensionContext, firstTimeRun: boolean
     context.globalState.update(KEY_IS_WELCOME_PAGE_VIEWED, !firstTimeRun);
 };
 
-const fetchInitProps = async (context: vscode.ExtensionContext) => {
+export const fetchInitProps = async (context: vscode.ExtensionContext) => {
     welcomeView?.webview.postMessage({
         command: "onDidFetchInitProps",
         props: {
             showWhenUsingJava: context.globalState.get(KEY_SHOW_WHEN_USING_JAVA),
             firstTimeRun: context.globalState.get(KEY_IS_WELCOME_PAGE_VIEWED) !== true,
+            isAwtDisabled: isAwtDisabled(),
         }
     });
     setFirstTimeRun(context, false);
@@ -141,7 +142,15 @@ const showTourPage = async (context: vscode.ExtensionContext) => {
         props: {
             showWhenUsingJava: context.globalState.get(KEY_SHOW_WHEN_USING_JAVA),
             firstTimeRun: true,
+            isAwtDisabled: isAwtDisabled(),
         }
     });
     setFirstTimeRun(context, false);
 };
+
+function isAwtDisabled(): boolean {
+    const filteredTypes: string[] = vscode.workspace.getConfiguration("java.completion").get<string[]>("filteredTypes") || [];
+    return filteredTypes.some((type: string) => {
+        return type.startsWith("java.awt.");
+    });
+}