feat: add multiple schema deletions (#397)

* feat: add multiple schema deletions

* fix: typing MODIFICATION_ACTIONS.deleteAll

Co-authored-by: Petr Spacek <p-spacek@email.cz>

src/languageserver/handlers/requestHandlers.ts

@@ -3,7 +3,12 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 import { Connection } from 'vscode-languageserver';
-import { MODIFICATION_ACTIONS, SchemaAdditions, SchemaDeletions } from '../../languageservice/services/yamlSchemaService';
+import {
+  MODIFICATION_ACTIONS,
+  SchemaAdditions,
+  SchemaDeletions,
+  SchemaDeletionsAll,
+} from '../../languageservice/services/yamlSchemaService';
 import { LanguageService } from '../../languageservice/yamlLanguageService';
 import { SchemaModificationNotification } from '../../requestTypes';
 
@@ -19,11 +24,15 @@ export class RequestHandlers {
     );
   }
 
-  private registerSchemaModificationNotificationHandler(modifications: SchemaAdditions | SchemaDeletions): void {
+  private registerSchemaModificationNotificationHandler(
+    modifications: SchemaAdditions | SchemaDeletions | SchemaDeletionsAll
+  ): void {
     if (modifications.action === MODIFICATION_ACTIONS.add) {
       this.languageService.modifySchemaContent(modifications);
     } else if (modifications.action === MODIFICATION_ACTIONS.delete) {
       this.languageService.deleteSchemaContent(modifications);
+    } else if (modifications.action === MODIFICATION_ACTIONS.deleteAll) {
+      this.languageService.deleteSchemasWhole(modifications);
     }
   }
 }

src/languageservice/services/yamlSchemaService.ts

@@ -31,6 +31,7 @@ export declare type CustomSchemaProvider = (uri: string) => Promise<string | str
 export enum MODIFICATION_ACTIONS {
   'delete',
   'add',
+  'deleteAll',
 }
 
 export interface SchemaAdditions {
@@ -49,6 +50,11 @@ export interface SchemaDeletions {
   key: string;
 }
 
+export interface SchemaDeletionsAll {
+  schemas: string[];
+  action: MODIFICATION_ACTIONS.deleteAll;
+}
+
 export class FilePatternAssociation {
   private schemas: string[];
   private patternRegExp: RegExp;
@@ -455,6 +461,15 @@ export class YAMLSchemaService extends JSONSchemaService {
     return Promise.resolve(undefined);
   }
 
+  /**
+   * Delete schemas on specific path
+   */
+  public async deleteSchemas(deletions: SchemaDeletionsAll): Promise<void> {
+    deletions.schemas.forEach((s) => {
+      this.deleteSchema(s);
+    });
+    return Promise.resolve(undefined);
+  }
   /**
    * Delete a schema with schema ID.
    */

src/languageservice/yamlLanguageService.ts

@@ -4,7 +4,13 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { YAMLSchemaService, CustomSchemaProvider, SchemaAdditions, SchemaDeletions } from './services/yamlSchemaService';
+import {
+  YAMLSchemaService,
+  CustomSchemaProvider,
+  SchemaAdditions,
+  SchemaDeletions,
+  SchemaDeletionsAll,
+} from './services/yamlSchemaService';
 import {
   Position,
   CompletionList,
@@ -118,6 +124,7 @@ export interface LanguageService {
   deleteSchema(schemaID: string): void;
   modifySchemaContent(schemaAdditions: SchemaAdditions): void;
   deleteSchemaContent(schemaDeletions: SchemaDeletions): void;
+  deleteSchemasWhole(schemaDeletions: SchemaDeletionsAll): void;
   getFoldingRanges(document: TextDocument, context: FoldingRangesContext): FoldingRange[] | null;
   getCodeAction(document: TextDocument, params: CodeActionParams): CodeAction[] | undefined;
 }
@@ -180,6 +187,9 @@ export function getLanguageService(
     deleteSchemaContent: (schemaDeletions: SchemaDeletions) => {
       return schemaService.deleteContent(schemaDeletions);
     },
+    deleteSchemasWhole: (schemaDeletions: SchemaDeletionsAll) => {
+      return schemaService.deleteSchemas(schemaDeletions);
+    },
     getFoldingRanges,
     getCodeAction: (document, params) => {
       return yamlCodeActions.getCodeAction(document, params);

test/schema.test.ts

@@ -505,6 +505,23 @@ describe('JSON Schema', () => {
     });
   });
 
+  it('Deleting schemas', async () => {
+    const service = new SchemaService.YAMLSchemaService(requestServiceMock, workspaceContext);
+    service.setSchemaContributions({
+      schemas: {
+        'https://myschemastore/main/schema1.json': {
+          type: 'object',
+        },
+      },
+    });
+    await service.deleteSchemas({
+      action: MODIFICATION_ACTIONS.deleteAll,
+      schemas: ['https://myschemastore/main/schema1.json'],
+    } as SchemaService.SchemaDeletionsAll);
+    const fs = await service.getResolvedSchema('https://myschemastore/main/schema1.json');
+    assert.equal(fs, undefined);
+  });
+
   it('Modifying schema works with kubernetes resolution', async () => {
     const service = new SchemaService.YAMLSchemaService(schemaRequestServiceForURL, workspaceContext);
     service.registerExternalSchema(KUBERNETES_SCHEMA_URL);