Updates dockerfile

node_modules/yaml-language-server/lib/esm/languageserver/handlers/settingsHandlers.js

@@ -0,0 +1,299 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Red Hat, Inc. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+import { configure as configureHttpRequests, xhr } from 'request-light';
+import { DidChangeConfigurationNotification, DocumentFormattingRequest } from 'vscode-languageserver';
+import { convertErrorToTelemetryMsg } from '../../languageservice/utils/objects';
+import { isRelativePath, relativeToAbsolutePath } from '../../languageservice/utils/paths';
+import { checkSchemaURI, JSON_SCHEMASTORE_URL, KUBERNETES_SCHEMA_URL } from '../../languageservice/utils/schemaUrls';
+import { SchemaPriority } from '../../languageservice/yamlLanguageService';
+import { SchemaSelectionRequests } from '../../requestTypes';
+export class SettingsHandler {
+    constructor(connection, languageService, yamlSettings, validationHandler, telemetry) {
+        this.connection = connection;
+        this.languageService = languageService;
+        this.yamlSettings = yamlSettings;
+        this.validationHandler = validationHandler;
+        this.telemetry = telemetry;
+    }
+    async registerHandlers() {
+        if (this.yamlSettings.hasConfigurationCapability && this.yamlSettings.clientDynamicRegisterSupport) {
+            try {
+                // Register for all configuration changes.
+                await this.connection.client.register(DidChangeConfigurationNotification.type);
+            }
+            catch (err) {
+                this.telemetry.sendError('yaml.settings.error', { error: convertErrorToTelemetryMsg(err) });
+            }
+        }
+        this.connection.onDidChangeConfiguration(() => this.pullConfiguration());
+    }
+    /**
+     *  The server pull the 'yaml', 'http.proxy', 'http.proxyStrictSSL', '[yaml]' settings sections
+     */
+    async pullConfiguration() {
+        const config = await this.connection.workspace.getConfiguration([
+            { section: 'yaml' },
+            { section: 'http' },
+            { section: '[yaml]' },
+            { section: 'editor' },
+            { section: 'files' },
+        ]);
+        const settings = {
+            yaml: config[0],
+            http: {
+                proxy: config[1]?.proxy ?? '',
+                proxyStrictSSL: config[1]?.proxyStrictSSL ?? false,
+            },
+            yamlEditor: config[2],
+            vscodeEditor: config[3],
+            files: config[4],
+        };
+        await this.setConfiguration(settings);
+    }
+    async setConfiguration(settings) {
+        configureHttpRequests(settings.http && settings.http.proxy, settings.http && settings.http.proxyStrictSSL);
+        this.yamlSettings.specificValidatorPaths = [];
+        if (settings.yaml) {
+            if (Object.prototype.hasOwnProperty.call(settings.yaml, 'schemas')) {
+                this.yamlSettings.yamlConfigurationSettings = settings.yaml.schemas;
+            }
+            if (Object.prototype.hasOwnProperty.call(settings.yaml, 'validate')) {
+                this.yamlSettings.yamlShouldValidate = settings.yaml.validate;
+            }
+            if (Object.prototype.hasOwnProperty.call(settings.yaml, 'hover')) {
+                this.yamlSettings.yamlShouldHover = settings.yaml.hover;
+            }
+            if (Object.prototype.hasOwnProperty.call(settings.yaml, 'completion')) {
+                this.yamlSettings.yamlShouldCompletion = settings.yaml.completion;
+            }
+            this.yamlSettings.customTags = settings.yaml.customTags ? settings.yaml.customTags : [];
+            this.yamlSettings.maxItemsComputed = Math.trunc(Math.max(0, Number(settings.yaml.maxItemsComputed))) || 5000;
+            if (settings.yaml.schemaStore) {
+                this.yamlSettings.schemaStoreEnabled = settings.yaml.schemaStore.enable;
+                if (settings.yaml.schemaStore.url?.length !== 0) {
+                    this.yamlSettings.schemaStoreUrl = settings.yaml.schemaStore.url;
+                }
+            }
+            if (settings.files?.associations) {
+                for (const [ext, languageId] of Object.entries(settings.files.associations)) {
+                    if (languageId === 'yaml') {
+                        this.yamlSettings.fileExtensions.push(ext);
+                    }
+                }
+            }
+            this.yamlSettings.yamlVersion = settings.yaml.yamlVersion ?? '1.2';
+            if (settings.yaml.format) {
+                this.yamlSettings.yamlFormatterSettings = {
+                    proseWrap: settings.yaml.format.proseWrap || 'preserve',
+                    printWidth: settings.yaml.format.printWidth || 80,
+                };
+                if (settings.yaml.format.singleQuote !== undefined) {
+                    this.yamlSettings.yamlFormatterSettings.singleQuote = settings.yaml.format.singleQuote;
+                }
+                if (settings.yaml.format.bracketSpacing !== undefined) {
+                    this.yamlSettings.yamlFormatterSettings.bracketSpacing = settings.yaml.format.bracketSpacing;
+                }
+                if (settings.yaml.format.enable !== undefined) {
+                    this.yamlSettings.yamlFormatterSettings.enable = settings.yaml.format.enable;
+                }
+            }
+            this.yamlSettings.disableAdditionalProperties = settings.yaml.disableAdditionalProperties;
+            this.yamlSettings.disableDefaultProperties = settings.yaml.disableDefaultProperties;
+            if (settings.yaml.suggest) {
+                this.yamlSettings.suggest.parentSkeletonSelectedFirst = settings.yaml.suggest.parentSkeletonSelectedFirst;
+            }
+            this.yamlSettings.style = {
+                flowMapping: settings.yaml.style?.flowMapping ?? 'allow',
+                flowSequence: settings.yaml.style?.flowSequence ?? 'allow',
+            };
+            this.yamlSettings.keyOrdering = settings.yaml.keyOrdering ?? false;
+        }
+        this.yamlSettings.schemaConfigurationSettings = [];
+        let tabSize = 2;
+        if (settings.vscodeEditor) {
+            tabSize =
+                !settings.vscodeEditor['detectIndentation'] && settings.yamlEditor ? settings.yamlEditor['editor.tabSize'] : tabSize;
+        }
+        if (settings.yamlEditor && settings.yamlEditor['editor.tabSize']) {
+            this.yamlSettings.indentation = ' '.repeat(tabSize);
+        }
+        for (const uri in this.yamlSettings.yamlConfigurationSettings) {
+            const globPattern = this.yamlSettings.yamlConfigurationSettings[uri];
+            const schemaObj = {
+                fileMatch: Array.isArray(globPattern) ? globPattern : [globPattern],
+                uri: checkSchemaURI(this.yamlSettings.workspaceFolders, this.yamlSettings.workspaceRoot, uri, this.telemetry),
+            };
+            this.yamlSettings.schemaConfigurationSettings.push(schemaObj);
+        }
+        await this.setSchemaStoreSettingsIfNotSet();
+        this.updateConfiguration();
+        if (this.yamlSettings.useSchemaSelectionRequests) {
+            this.connection.sendNotification(SchemaSelectionRequests.schemaStoreInitialized, {});
+        }
+        // dynamically enable & disable the formatter
+        if (this.yamlSettings.clientDynamicRegisterSupport) {
+            const enableFormatter = settings && settings.yaml && settings.yaml.format && settings.yaml.format.enable;
+            if (enableFormatter) {
+                if (!this.yamlSettings.formatterRegistration) {
+                    this.yamlSettings.formatterRegistration = this.connection.client.register(DocumentFormattingRequest.type, {
+                        documentSelector: [{ language: 'yaml' }],
+                    });
+                }
+            }
+            else if (this.yamlSettings.formatterRegistration) {
+                this.yamlSettings.formatterRegistration.then((r) => {
+                    return r.dispose();
+                });
+                this.yamlSettings.formatterRegistration = null;
+            }
+        }
+    }
+    /**
+     * This function helps set the schema store if it hasn't already been set
+     * AND the schema store setting is enabled. If the schema store setting
+     * is not enabled we need to clear the schemas.
+     */
+    async setSchemaStoreSettingsIfNotSet() {
+        const schemaStoreIsSet = this.yamlSettings.schemaStoreSettings.length !== 0;
+        let schemaStoreUrl = '';
+        if (this.yamlSettings.schemaStoreUrl?.length !== 0) {
+            schemaStoreUrl = this.yamlSettings.schemaStoreUrl;
+        }
+        else {
+            schemaStoreUrl = JSON_SCHEMASTORE_URL;
+        }
+        if (this.yamlSettings.schemaStoreEnabled && !schemaStoreIsSet) {
+            try {
+                const schemaStore = await this.getSchemaStoreMatchingSchemas(schemaStoreUrl);
+                this.yamlSettings.schemaStoreSettings = schemaStore.schemas;
+            }
+            catch (err) {
+                // ignore
+            }
+        }
+        else if (!this.yamlSettings.schemaStoreEnabled) {
+            this.yamlSettings.schemaStoreSettings = [];
+        }
+    }
+    /**
+     * When the schema store is enabled, download and store YAML schema associations
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    async getSchemaStoreMatchingSchemas(schemaStoreUrl) {
+        const response = await xhr({ url: schemaStoreUrl });
+        const languageSettings = {
+            schemas: [],
+        };
+        // Parse the schema store catalog as JSON
+        const schemas = JSON.parse(response.responseText);
+        for (const schemaIndex in schemas.schemas) {
+            const schema = schemas.schemas[schemaIndex];
+            if (schema && schema.fileMatch) {
+                for (const fileMatch in schema.fileMatch) {
+                    const currFileMatch = schema.fileMatch[fileMatch];
+                    // If the schema is for files with a YAML extension, save the schema association
+                    if (this.yamlSettings.fileExtensions.findIndex((value) => {
+                        return currFileMatch.indexOf(value) > -1;
+                    }) > -1) {
+                        languageSettings.schemas.push({
+                            uri: schema.url,
+                            fileMatch: [currFileMatch],
+                            priority: SchemaPriority.SchemaStore,
+                            name: schema.name,
+                            description: schema.description,
+                            versions: schema.versions,
+                        });
+                    }
+                }
+            }
+        }
+        return languageSettings;
+    }
+    /**
+     * Called when server settings or schema associations are changed
+     * Re-creates schema associations and re-validates any open YAML files
+     */
+    updateConfiguration() {
+        let languageSettings = {
+            validate: this.yamlSettings.yamlShouldValidate,
+            hover: this.yamlSettings.yamlShouldHover,
+            completion: this.yamlSettings.yamlShouldCompletion,
+            schemas: [],
+            customTags: this.yamlSettings.customTags,
+            format: this.yamlSettings.yamlFormatterSettings.enable,
+            indentation: this.yamlSettings.indentation,
+            disableAdditionalProperties: this.yamlSettings.disableAdditionalProperties,
+            disableDefaultProperties: this.yamlSettings.disableDefaultProperties,
+            parentSkeletonSelectedFirst: this.yamlSettings.suggest.parentSkeletonSelectedFirst,
+            flowMapping: this.yamlSettings.style?.flowMapping,
+            flowSequence: this.yamlSettings.style?.flowSequence,
+            yamlVersion: this.yamlSettings.yamlVersion,
+            keyOrdering: this.yamlSettings.keyOrdering,
+        };
+        if (this.yamlSettings.schemaAssociations) {
+            if (Array.isArray(this.yamlSettings.schemaAssociations)) {
+                this.yamlSettings.schemaAssociations.forEach((association) => {
+                    languageSettings = this.configureSchemas(association.uri, association.fileMatch, association.schema, languageSettings, SchemaPriority.SchemaAssociation);
+                });
+            }
+            else {
+                for (const uri in this.yamlSettings.schemaAssociations) {
+                    const fileMatch = this.yamlSettings.schemaAssociations[uri];
+                    languageSettings = this.configureSchemas(uri, fileMatch, null, languageSettings, SchemaPriority.SchemaAssociation);
+                }
+            }
+        }
+        if (this.yamlSettings.schemaConfigurationSettings) {
+            this.yamlSettings.schemaConfigurationSettings.forEach((schema) => {
+                let uri = schema.uri;
+                if (!uri && schema.schema) {
+                    uri = schema.schema.id;
+                }
+                if (!uri && schema.fileMatch) {
+                    uri = 'vscode://schemas/custom/' + encodeURIComponent(schema.fileMatch.join('&'));
+                }
+                if (uri) {
+                    if (isRelativePath(uri)) {
+                        uri = relativeToAbsolutePath(this.yamlSettings.workspaceFolders, this.yamlSettings.workspaceRoot, uri);
+                    }
+                    languageSettings = this.configureSchemas(uri, schema.fileMatch, schema.schema, languageSettings, SchemaPriority.Settings);
+                }
+            });
+        }
+        if (this.yamlSettings.schemaStoreSettings) {
+            languageSettings.schemas = languageSettings.schemas.concat(this.yamlSettings.schemaStoreSettings);
+        }
+        this.languageService.configure(languageSettings);
+        // Revalidate any open text documents
+        this.yamlSettings.documents.all().forEach((document) => this.validationHandler.validate(document));
+    }
+    /**
+     * Stores schema associations in server settings, handling kubernetes
+     * @param uri string path to schema (whether local or online)
+     * @param fileMatch file pattern to apply the schema to
+     * @param schema schema id
+     * @param languageSettings current server settings
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    configureSchemas(uri, fileMatch, schema, languageSettings, priorityLevel) {
+        uri = checkSchemaURI(this.yamlSettings.workspaceFolders, this.yamlSettings.workspaceRoot, uri, this.telemetry);
+        if (schema === null) {
+            languageSettings.schemas.push({ uri, fileMatch: fileMatch, priority: priorityLevel });
+        }
+        else {
+            languageSettings.schemas.push({ uri, fileMatch: fileMatch, schema: schema, priority: priorityLevel });
+        }
+        if (fileMatch.constructor === Array && uri === KUBERNETES_SCHEMA_URL) {
+            fileMatch.forEach((url) => {
+                this.yamlSettings.specificValidatorPaths.push(url);
+            });
+        }
+        else if (uri === KUBERNETES_SCHEMA_URL) {
+            this.yamlSettings.specificValidatorPaths.push(fileMatch);
+        }
+        return languageSettings;
+    }
+}
+//# sourceMappingURL=settingsHandlers.js.map