fix: Get options from matadata (#173)

CsCherrYY · web-flow · commit 7d8cf2e892cb · 2021-03-10T13:12:49.000+08:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -166,7 +166,7 @@
     "mocha": "^7.1.1",
     "ts-loader": "^4.4.2",
     "tslint": "^5.18.0",
-    "typescript": "^3.5.3",
+    "typescript": "^4.2.3",
     "vscode-test": "^1.2.0",
     "webpack": "^4.42.0",
     "webpack-cli": "^3.3.12"
diff --git a/src/handler/HandlerInterfaces.ts b/src/handler/HandlerInterfaces.ts
@@ -3,6 +3,7 @@
 
 import { QuickPickItem } from "vscode";
 import { IDependenciesItem } from "../DependencyManager";
+import { Identifiable } from "../model/Metadata";
 
 export interface IStep {
     getNextStep(): IStep | undefined;
@@ -32,12 +33,17 @@ export interface IDefaultProjectData {
     targetFolder?: string;
 }
 
-export interface IPickMetadata {
+export interface IHandlerItem<T extends Identifiable> extends QuickPickItem {
+    label: string;
+    value?: T;
+}
+
+export interface IPickMetadata<T extends Identifiable> {
     metadata: IProjectMetadata;
     title: string;
     pickStep: IStep;
     placeholder: string;
-    items: QuickPickItem[];
+    items: Array<IHandlerItem<T>>;
 }
 
 export interface IInputMetaData {
diff --git a/src/handler/SpecifyBootVersionStep.ts b/src/handler/SpecifyBootVersionStep.ts
@@ -1,12 +1,12 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 
-import { Disposable, QuickInputButtons, QuickPick, window } from "vscode";
 import { instrumentOperationStep, sendInfo } from "vscode-extension-telemetry-wrapper";
-import { OperationCanceledError } from "../Errors";
-import { IValue, serviceManager } from "../model";
-import { IProjectMetadata, IStep } from "./HandlerInterfaces";
+import { serviceManager } from "../model";
+import { BootVersion, MatadataType } from "../model/Metadata";
+import { IPickMetadata, IProjectMetadata, IStep } from "./HandlerInterfaces";
 import { SpecifyLanguageStep } from "./SpecifyLanguageStep";
+import { createPickBox } from "./utils";
 
 export class SpecifyBootVersionStep implements IStep {
 
@@ -29,46 +29,13 @@ export class SpecifyBootVersionStep implements IStep {
     }
 
     private async specifyBootVersion(projectMetadata: IProjectMetadata): Promise<boolean> {
-        const disposables: Disposable[] = [];
-        const result: boolean = await new Promise<boolean>(async (resolve, reject) => {
-            const pickBox: QuickPick<{ value: IValue, label: string }> = window.createQuickPick<{ value: IValue, label: string }>();
-            pickBox.title = "Spring Initializr: Specify Spring Boot version",
-            pickBox.placeholder = "Specify Spring Boot version.";
-            try {
-                pickBox.items = await serviceManager.getBootVersions(projectMetadata.serviceUrl).then(versions => versions.map(v => ({ value: v, label: v.name })));
-            } catch (error) {
-                return reject(error);
-            }
-            pickBox.ignoreFocusOut = true;
-            if (projectMetadata.pickSteps.length > 0) {
-                pickBox.buttons = [(QuickInputButtons.Back)];
-                disposables.push(
-                    pickBox.onDidTriggerButton((item) => {
-                        if (item === QuickInputButtons.Back) {
-                            return resolve(false);
-                        }
-                    })
-                );
-            }
-            disposables.push(
-                pickBox.onDidAccept(() => {
-                    if (!pickBox.selectedItems[0]) {
-                        return;
-                    }
-                    projectMetadata.bootVersion = pickBox.selectedItems[0] && pickBox.selectedItems[0].value && pickBox.selectedItems[0].value.id;
-                    projectMetadata.pickSteps.push(SpecifyBootVersionStep.getInstance());
-                    return resolve(true);
-                }),
-                pickBox.onDidHide(() => {
-                    return reject(new OperationCanceledError("BootVersion not specified."));
-                })
-            );
-            disposables.push(pickBox);
-            pickBox.show();
-        });
-        for (const d of disposables) {
-            d.dispose();
-        }
-        return result;
+        const pickMetaData: IPickMetadata<BootVersion> = {
+            metadata: projectMetadata,
+            title: "Spring Initializr: Specify Spring Boot version",
+            pickStep: SpecifyBootVersionStep.getInstance(),
+            placeholder: "Specify Spring Boot version.",
+            items: await serviceManager.getItems(projectMetadata.serviceUrl, MatadataType.BOOTVERSION),
+        };
+        return await createPickBox(pickMetaData);
     }
 }
diff --git a/src/handler/SpecifyJavaVersionStep.ts b/src/handler/SpecifyJavaVersionStep.ts
@@ -3,6 +3,8 @@
 
 import { workspace } from "vscode";
 import { instrumentOperationStep } from "vscode-extension-telemetry-wrapper";
+import { serviceManager } from "../model";
+import { JavaVersion, MatadataType } from "../model/Metadata";
 import { IPickMetadata, IProjectMetadata, IStep } from "./HandlerInterfaces";
 import { SpecifyDependenciesStep } from "./SpecifyDependenciesStep";
 import { createPickBox } from "./utils";
@@ -32,12 +34,12 @@ export class SpecifyJavaVersionStep implements IStep {
             projectMetadata.javaVersion = javaVersion;
             return true;
         }
-        const pickMetaData: IPickMetadata = {
+        const pickMetaData: IPickMetadata<JavaVersion> = {
             metadata: projectMetadata,
             title: "Spring Initializr: Specify Java version",
             pickStep: SpecifyJavaVersionStep.getInstance(),
             placeholder: "Specify Java version.",
-            items: [{ label: "11" }, { label: "1.8" }, { label: "14" }]
+            items: await serviceManager.getItems(projectMetadata.serviceUrl, MatadataType.JAVAVERSION),
         };
         return await createPickBox(pickMetaData);
     }
diff --git a/src/handler/SpecifyLanguageStep.ts b/src/handler/SpecifyLanguageStep.ts
@@ -3,6 +3,8 @@
 
 import { workspace } from "vscode";
 import { instrumentOperationStep } from "vscode-extension-telemetry-wrapper";
+import { serviceManager } from "../model";
+import { Language, MatadataType } from "../model/Metadata";
 import { IPickMetadata, IProjectMetadata, IStep } from "./HandlerInterfaces";
 import { SpecifyGroupIdStep } from "./SpecifyGroupIdStep";
 import { createPickBox } from "./utils";
@@ -32,12 +34,12 @@ export class SpecifyLanguageStep implements IStep {
             projectMetadata.language = language && language.toLowerCase();
             return true;
         }
-        const pickMetaData: IPickMetadata = {
+        const pickMetaData: IPickMetadata<Language> = {
             metadata: projectMetadata,
             title: "Spring Initializr: Specify project language",
             pickStep: SpecifyLanguageStep.getInstance(),
             placeholder: "Specify project language.",
-            items: [{ label: "Java" }, { label: "Kotlin" }, { label: "Groovy" }]
+            items: await serviceManager.getItems(projectMetadata.serviceUrl, MatadataType.LANGUAGE),
         };
         return await createPickBox(pickMetaData);
     }
diff --git a/src/handler/SpecifyPackagingStep.ts b/src/handler/SpecifyPackagingStep.ts
@@ -3,6 +3,8 @@
 
 import { workspace } from "vscode";
 import { instrumentOperationStep } from "vscode-extension-telemetry-wrapper";
+import { serviceManager } from "../model";
+import { MatadataType, Packaging } from "../model/Metadata";
 import { IPickMetadata, IProjectMetadata, IStep } from "./HandlerInterfaces";
 import { SpecifyJavaVersionStep } from "./SpecifyJavaVersionStep";
 import { createPickBox } from "./utils";
@@ -32,12 +34,12 @@ export class SpecifyPackagingStep implements IStep {
             projectMetadata.packaging = packaging && packaging.toLowerCase();
             return true;
         }
-        const pickMetaData: IPickMetadata = {
+        const pickMetaData: IPickMetadata<Packaging> = {
             metadata: projectMetadata,
             title: "Spring Initializr: Specify packaging type",
             pickStep: SpecifyPackagingStep.getInstance(),
             placeholder: "Specify packaging type.",
-            items: [{ label: "JAR" }, { label: "WAR" }]
+            items: await serviceManager.getItems(projectMetadata.serviceUrl, MatadataType.PACKAGING),
         };
         return await createPickBox(pickMetaData);
     }
diff --git a/src/handler/utils.ts b/src/handler/utils.ts
@@ -2,11 +2,13 @@
 // Licensed under the MIT license.
 
 import * as vscode from "vscode";
-import { Disposable, InputBox, QuickInputButtons, QuickPick, QuickPickItem, window } from "vscode";
+import { Disposable, InputBox, QuickInputButtons, QuickPick, window } from "vscode";
 import { OperationCanceledError } from "../Errors";
+import { Identifiable } from "../model/Metadata";
 import { artifactIdValidation, groupIdValidation } from "../Utils";
-import { IInputMetaData, IPickMetadata, IProjectMetadata } from "./HandlerInterfaces";
+import { IHandlerItem, IInputMetaData, IPickMetadata, IProjectMetadata } from "./HandlerInterfaces";
 import { SpecifyArtifactIdStep } from "./SpecifyArtifactIdStep";
+import { SpecifyBootVersionStep } from "./SpecifyBootVersionStep";
 import { SpecifyGroupIdStep } from "./SpecifyGroupIdStep";
 import { SpecifyJavaVersionStep } from "./SpecifyJavaVersionStep";
 import { SpecifyLanguageStep } from "./SpecifyLanguageStep";
@@ -32,10 +34,10 @@ export async function specifyServiceUrl(projectMetadata?: IProjectMetadata): Pro
     }
 }
 
-export async function createPickBox(pickMetadata: IPickMetadata): Promise<boolean> {
+export async function createPickBox<T extends Identifiable>(pickMetadata: IPickMetadata<T>): Promise<boolean> {
     const disposables: Disposable[] = [];
     const result: boolean = await new Promise<boolean>((resolve, reject) => {
-        const pickBox: QuickPick<QuickPickItem> = window.createQuickPick<QuickPickItem>();
+        const pickBox: QuickPick<IHandlerItem<T>> = window.createQuickPick<IHandlerItem<T>>();
         pickBox.title = pickMetadata.title;
         pickBox.placeholder = pickMetadata.placeholder;
         pickBox.items = pickMetadata.items;
@@ -52,15 +54,17 @@ export async function createPickBox(pickMetadata: IPickMetadata): Promise<boolea
         }
         disposables.push(
             pickBox.onDidAccept(() => {
-                if (!pickBox.selectedItems[0]) {
+                if (!pickBox.selectedItems?.[0]) {
                     return;
                 }
                 if (pickMetadata.pickStep instanceof SpecifyLanguageStep) {
-                    pickMetadata.metadata.language = pickBox.selectedItems[0].label && pickBox.selectedItems[0].label.toLowerCase();
+                    pickMetadata.metadata.language = pickBox.selectedItems[0].label?.toLowerCase();
                 } else if (pickMetadata.pickStep instanceof SpecifyJavaVersionStep) {
                     pickMetadata.metadata.javaVersion = pickBox.selectedItems[0].label;
                 } else if (pickMetadata.pickStep instanceof SpecifyPackagingStep) {
-                    pickMetadata.metadata.packaging = pickBox.selectedItems[0].label && pickBox.selectedItems[0].label.toLowerCase();
+                    pickMetadata.metadata.packaging = pickBox.selectedItems[0].label?.toLowerCase();
+                } else if (pickMetadata.pickStep instanceof SpecifyBootVersionStep) {
+                    pickMetadata.metadata.bootVersion = pickBox.selectedItems[0].value?.id;
                 }
                 pickMetadata.metadata.pickSteps.push(pickMetadata.pickStep);
                 return resolve(true);
@@ -72,6 +76,8 @@ export async function createPickBox(pickMetadata: IPickMetadata): Promise<boolea
                     return reject(new OperationCanceledError("Java version not specified."));
                 } else if (pickMetadata.pickStep instanceof SpecifyPackagingStep) {
                     return reject(new OperationCanceledError("Packaging not specified."));
+                } else if (pickMetadata.pickStep instanceof SpecifyBootVersionStep) {
+                    return reject(new OperationCanceledError("BootVersion not specified."));
                 }
                 return reject(new Error("Unknown picking step"));
             })
diff --git a/src/model/Metadata.ts b/src/model/Metadata.ts
@@ -13,11 +13,18 @@ export interface Metadata {
     type: Category<ProjectType>;
 }
 
+export enum MatadataType {
+    BOOTVERSION,
+    JAVAVERSION,
+    LANGUAGE,
+    PACKAGING,
+}
+
 interface Nameable {
     name: string;
 }
 
-interface Identifiable extends Nameable {
+export interface Identifiable extends Nameable {
     id: string;
 }
 
@@ -30,10 +37,10 @@ interface ProjectType extends Identifiable {
     action: string;
 }
 
-type BootVersion = Identifiable;
-type Packaging = Identifiable;
-type JavaVersion = Identifiable;
-type Language = Identifiable;
+export type BootVersion = Identifiable;
+export type Packaging = Identifiable;
+export type JavaVersion = Identifiable;
+export type Language = Identifiable;
 
 export interface DependencyGroup extends Category<Dependency>, Nameable {
 }
diff --git a/src/model/ServiceManager.ts b/src/model/ServiceManager.ts
@@ -2,9 +2,10 @@
 // Licensed under the MIT license.
 
 import { IDependency, IStarters } from ".";
+import { IHandlerItem } from "../handler/HandlerInterfaces";
 import { downloadFile } from "../Utils";
 import { matchRange } from "../Utils/VersionHelper";
-import { DependencyGroup, Metadata } from "./Metadata";
+import { DependencyGroup, Identifiable, MatadataType, Metadata } from "./Metadata";
 
 /**
  * Prefer v2.2 and fallback to v2.1
@@ -15,15 +16,36 @@ const METADATA_HEADERS = { Accept: "application/vnd.initializr.v2.2+json,applica
 class ServiceManager {
     private metadataMap: Map<string, Metadata> = new Map();
 
-    public async getBootVersions(serviceUrl: string): Promise<any[]> {
+    public async getItems<T extends Identifiable>(serviceUrl: string, type: MatadataType): Promise<Array<IHandlerItem<T>>> {
         const metadata = await this.ensureMetadata(serviceUrl);
         if (!metadata) {
             throw new Error("Failed to fetch metadata.");
         }
+        let defaultLabel: string;
+        let values: any[];
+        switch (type) {
+            case MatadataType.BOOTVERSION:
+                defaultLabel = metadata.bootVersion.default;
+                values = metadata.bootVersion.values;
+                break;
+            case MatadataType.JAVAVERSION:
+                defaultLabel = metadata.javaVersion.default;
+                values = metadata.javaVersion.values;
+                break;
+            case MatadataType.LANGUAGE:
+                defaultLabel = metadata.language.default;
+                values = metadata.language.values;
+                break;
+            case MatadataType.PACKAGING:
+                defaultLabel = metadata.packaging.default;
+                values = metadata.packaging.values;
+                break;
+            default:
+                throw new Error("Invalid metadata type.");
+        }
 
-        const defaultVersion: string = metadata.bootVersion.default;
-        const versions = metadata.bootVersion.values;
-        return versions.filter(x => x.id === defaultVersion).concat(versions.filter(x => x.id !== defaultVersion));
+        const sortedValues = values.filter(x => x.id === defaultLabel).concat(values.filter(x => x.id !== defaultLabel));
+        return (type === MatadataType.BOOTVERSION) ? sortedValues.map(v => ({ value: v, label: v.name })) : sortedValues.map(v => ({ label: v.name }));
     }
 
     public async getAvailableDependencies(serviceUrl: string, bootVersion: string): Promise<IDependency[]> {

Original file line number	Diff line number	Diff line change
`@@ -13,11 +13,18 @@ export interface Metadata {`
`13`	`13`	`type: Category<ProjectType>;`
`14`	`14`	`}`
`15`	`15`
	`16`	`+export enum MatadataType {`
	`17`	`+ BOOTVERSION,`
	`18`	`+ JAVAVERSION,`
	`19`	`+ LANGUAGE,`
	`20`	`+ PACKAGING,`
	`21`	`+}`
	`22`	`+`
`16`	`23`	`interface Nameable {`
`17`	`24`	`name: string;`
`18`	`25`	`}`
`19`	`26`
`20`		`-interface Identifiable extends Nameable {`
	`27`	`+export interface Identifiable extends Nameable {`
`21`	`28`	`id: string;`
`22`	`29`	`}`
`23`	`30`
`@@ -30,10 +37,10 @@ interface ProjectType extends Identifiable {`
`30`	`37`	`action: string;`
`31`	`38`	`}`
`32`	`39`
`33`		`-type BootVersion = Identifiable;`
`34`		`-type Packaging = Identifiable;`
`35`		`-type JavaVersion = Identifiable;`
`36`		`-type Language = Identifiable;`
	`40`	`+export type BootVersion = Identifiable;`
	`41`	`+export type Packaging = Identifiable;`
	`42`	`+export type JavaVersion = Identifiable;`
	`43`	`+export type Language = Identifiable;`
`37`	`44`
`38`	`45`	`export interface DependencyGroup extends Category<Dependency>, Nameable {`
`39`	`46`	`}`