fix: Add validation for profile (#651)

Author: CsCherrYY

src/formatter-settings/index.ts

@@ -49,7 +49,9 @@ export class JavaFormatterSettingsEditorProvider implements vscode.CustomTextEdi
             if (!this.settingsUrl || e.document.uri.toString() !== vscode.Uri.file(this.profilePath).toString()) {
                 return;
             }
-            await this.parseProfileAndUpdate(e.document);
+            if (!await this.parseProfileAndUpdate(e.document)) {
+                this.webviewPanel?.dispose();
+            }
         });
     }
 
@@ -168,23 +170,27 @@ export class JavaFormatterSettingsEditorProvider implements vscode.CustomTextEdi
     }
 
     private async initialize(document: vscode.TextDocument): Promise<boolean> {
-        if (!await this.checkRequirement()) {
-            return false;
-        }
-        if (!await this.checkProfileSettings()) {
+        if (!await this.checkRequirement() || !await this.checkProfileSettings() || !await this.parseProfileAndUpdate(document)) {
             return false;
         }
         this.exampleKind = ExampleKind.INDENTATION_EXAMPLE;
-        await this.parseProfileAndUpdate(document);
         this.webviewPanel?.webview.postMessage({
             command: "changeReadOnlyState",
             value: this.readOnly,
         });
         return true;
     }
 
-    private async parseProfileAndUpdate(document: vscode.TextDocument): Promise<void> {
+    private async parseProfileAndUpdate(document: vscode.TextDocument): Promise<boolean> {
         const content: ProfileContent = parseProfile(document);
+        if (!content.isValid) {
+            vscode.window.showErrorMessage("The current profile is invalid, please check it in the Settings and try again.", "Open Settings").then((anwser) => {
+                if (anwser === "Open Settings") {
+                    openFormatterSettings();
+                }
+            })
+            return false;
+        }
         this.diagnosticCollection.set(document.uri, content.diagnostics);
         if (this.webviewPanel) {
             this.profileElements = content.profileElements || this.profileElements;
@@ -200,6 +206,7 @@ export class JavaFormatterSettingsEditorProvider implements vscode.CustomTextEdi
             await this.updateVSCodeSettings();
             this.format();
         }
+        return true;
     }
 
     private onChangeProfileSettings(): void {

src/formatter-settings/types.ts

@@ -56,6 +56,7 @@ export interface DOMAttr extends Attr {
 }
 
 export interface ProfileContent {
+    isValid: boolean,
     settingsVersion: string,
     diagnostics: vscode.Diagnostic[],
     profileElements?: Map<string, DOMElement>,

src/formatter-settings/utils.ts

@@ -72,6 +72,7 @@ export function parseProfile(document: vscode.TextDocument): ProfileContent {
     const profileSettings = new Map<string, string>();
     let lastElement = undefined;
     const diagnostics: vscode.Diagnostic[] = [];
+    let settingsVersion = JavaConstants.CURRENT_FORMATTER_SETTINGS_VERSION;
     const documentDOM = new DOMParser({
         locator: {}, errorHandler: (_level, msg) => {
             const bracketExp: RegExp = new RegExp("\\[line:(\\d*),col:(\\d*)\\]", "g");
@@ -81,11 +82,13 @@ export function parseProfile(document: vscode.TextDocument): ProfileContent {
             }
         }
     }).parseFromString(document.getText());
-    let settingsVersion = documentDOM.documentElement.getAttribute("version") || JavaConstants.CURRENT_FORMATTER_SETTINGS_VERSION;
+    if (!documentDOM) {
+        return { isValid: false, settingsVersion, diagnostics };
+    }
+    settingsVersion = documentDOM.documentElement.getAttribute("version") || settingsVersion;
     const profiles = documentDOM.documentElement.getElementsByTagName("profile");
     if (!profiles || profiles.length === 0) {
-        diagnostics.push(new vscode.Diagnostic(new vscode.Range(new vscode.Position(0, 0), new vscode.Position(0, 0)), "No valid profiles found."));
-        return { settingsVersion, diagnostics };
+       return { isValid: false, settingsVersion, diagnostics };
     }
     const settingsProfileName: string | undefined = vscode.workspace.getConfiguration("java").get<string>(JavaConstants.SETTINGS_PROFILE_KEY);
     for (let i = 0; i < profiles.length; i++) {
@@ -119,8 +122,7 @@ export function parseProfile(document: vscode.TextDocument): ProfileContent {
         }
     }
     if (!profileElements.size) {
-        diagnostics.push(new vscode.Diagnostic(new vscode.Range(new vscode.Position(0, 0), new vscode.Position(0, 0)), "No valid settings found in the profile."));
-        return { settingsVersion, diagnostics };
+        return { isValid: false, settingsVersion, diagnostics };
     }
     const supportedProfileSettings = getSupportedProfileSettings(Number(settingsVersion));
     for (const setting of supportedProfileSettings.values()) {
@@ -146,6 +148,7 @@ export function parseProfile(document: vscode.TextDocument): ProfileContent {
         setting.value = webViewValue;
     }
     return {
+        isValid: true,
         settingsVersion,
         diagnostics,
         profileElements,