Merge pull request che-incubator#555 from RomanNikitenko/fix-merging-extensions

fix: Fix merging ConfigMap and workspace file extensions

Author: RomanNikitenko

launcher/src/editor-configurations.ts

@@ -1,5 +1,5 @@
 /**********************************************************************
- * Copyright (c) 2024 Red Hat, Inc.
+ * Copyright (c) 2024-2025 Red Hat, Inc.
  *
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -91,16 +91,29 @@ export class EditorConfigurations {
   private async configureExtensions(configmap: k8s.V1ConfigMap): Promise<void> {
     const configmapContent = configmap.data![EditorConfigs.Extensions];
     if (!configmapContent) {
+      console.log(`    > Configmap does not contain ${EditorConfigs.Extensions}. Skip this step.`);
       return;
     }
 
     console.log('  > Configure workspace extensions...');
 
     try {
-      const extensionsFromConfigmap = parseJSON(configmapContent, {
+      const parsedConfigmapContent = parseJSON(configmapContent, {
         errorMessage: 'Configmap content is not valid.',
       });
 
+      const configMapExtensions = parsedConfigmapContent?.recommendations;
+      if (!Array.isArray(configMapExtensions) || configMapExtensions.length < 1) {
+        console.log(
+          `    > ${EditorConfigs.Extensions} section of Configmap does not contain recomendations. Skip this step.`
+        );
+        return;
+      } else {
+        console.log(
+          `    > ${EditorConfigs.Extensions} section of Configmap contains ${configMapExtensions.length} extensions.`
+        );
+      }
+
       if (!this.workspaceFilePath) {
         console.log('    > Missing workspace file. Skip this step.');
         return;
@@ -118,10 +131,12 @@ export class EditorConfigurations {
         errorMessage: 'Workspace file is not valid.',
       });
 
-      workspaceConfigData['extensions'] = {
-        ...(workspaceConfigData['extensions'] || {}),
-        ...extensionsFromConfigmap,
-      };
+      const workspaceFileExtensions = workspaceConfigData?.extensions?.recommendations || [];
+      console.log(`    > Workspace file contains ${workspaceFileExtensions.length} extensions.`);
+
+      const combinedExtensions = Array.from(new Set([...configMapExtensions, ...workspaceFileExtensions]));
+      workspaceConfigData.extensions = workspaceConfigData.extensions ?? {};
+      workspaceConfigData.extensions.recommendations = combinedExtensions;
 
       const json = JSON.stringify(workspaceConfigData, null, '\t');
       await fs.writeFile(this.workspaceFilePath, json);

launcher/tests/editor-configurations.spec.ts

@@ -1,5 +1,5 @@
 /**********************************************************************
- * Copyright (c) 2024 Red Hat, Inc.
+ * Copyright (c) 2024-2025 Red Hat, Inc.
  *
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -42,26 +42,50 @@ const CONFIGMAP_SETTINGS_DATA = {
   'settings.json': SETTINGS_CONTENT,
 };
 
-const EXTENSIONS_CONTENT =
+const WORKSPACE_FILE_EXTENSIONS_CONTENT =
   '{\n' +
   '  "recommendations": [\n' +
   '      "dbaeumer.vscode-eslint",\n' +
   '      "github.vscode-pull-request-github"\n' +
   '  ]\n' +
   '}\n';
-const EXTENSIONS_JSON = JSON.parse(EXTENSIONS_CONTENT);
-const WORKSPACE_CONFIG_JSON = JSON.parse(WORKSPACE_FILE_CONTENT);
-WORKSPACE_CONFIG_JSON['extensions'] = EXTENSIONS_JSON;
-const WORKSPACE_CONFIG_WITH_EXTENSIONS_TO_FILE = JSON.stringify(WORKSPACE_CONFIG_JSON, null, '\t');
+
+// prettier-ignore
+const CONFIGMAP_EXTENSIONS_CONTENT =
+  '{\n' +
+  '  "recommendations": [\n' +
+  '      "redhat.vscode-yaml",\n' +
+  '      "redhat.java"\n' +
+  '  ]\n' +
+  '}\n';
+
+const MERGED_EXTENSIONS_CONTENT =
+  '{\n' +
+  '  "recommendations": [\n' +
+  '      "redhat.vscode-yaml",\n' +
+  '      "redhat.java",\n' +
+  '      "dbaeumer.vscode-eslint",\n' +
+  '      "github.vscode-pull-request-github"\n' +
+  '  ]\n' +
+  '}\n';
+const WORKSPACE_EXTENSIONS_JSON = JSON.parse(WORKSPACE_FILE_EXTENSIONS_CONTENT);
+const WORKSPACE_CONFIG_WITHOUT_EXTENSIONS_JSON = JSON.parse(WORKSPACE_FILE_CONTENT);
+const CONFIGMAP_EXTENSIONS_JSON = JSON.parse(CONFIGMAP_EXTENSIONS_CONTENT);
+const MERGED_EXTENSIONS_JSON = JSON.parse(MERGED_EXTENSIONS_CONTENT);
 const CONFIGMAP_EXTENSIOSN_DATA = {
-  'extensions.json': EXTENSIONS_CONTENT,
+  'extensions.json': CONFIGMAP_EXTENSIONS_CONTENT,
 };
 
 const CONFIGMAP_INCORRECT_DATA = {
   'extensions.json': '//some incorrect data',
   'settings.json': '//some incorrect data',
 };
 
+const EMPTY_RECOMMENDATIONS_CONTENT = '{\n' + '  "recommendations": []\n' + '}\n';
+const EMPTY_RECOMMENDATIONS_DATA = {
+  'extensions.json': EMPTY_RECOMMENDATIONS_CONTENT,
+};
+
 jest.mock('@kubernetes/client-node', () => {
   const actual = jest.requireActual('@kubernetes/client-node');
   return {
@@ -106,7 +130,7 @@ describe('Test applying editor configurations:', () => {
     }));
   });
 
-  it('should skip applying editor congis if there is no DEVWORKSPACE_NAMESPACE', async () => {
+  it('should skip applying editor configs if there is no DEVWORKSPACE_NAMESPACE', async () => {
     await new EditorConfigurations().configure();
 
     expect(mockMakeApiClient).not.toHaveBeenCalled();
@@ -214,6 +238,27 @@ describe('Test applying editor configurations:', () => {
     expect(writeFileMock).not.toHaveBeenCalled();
   });
 
+  it('should skip applying extensions when empty list of extensions in a configmap', async () => {
+    env.DEVWORKSPACE_NAMESPACE = DEVWORKSPACE_NAMESPACE;
+    const mockResponse = {
+      response: {} as IncomingMessage,
+      body: { data: EMPTY_RECOMMENDATIONS_DATA } as V1ConfigMap,
+    };
+    mockCoreV1Api.readNamespacedConfigMap.mockResolvedValue(mockResponse);
+    fileExistsMock.mockResolvedValue(false);
+
+    await new EditorConfigurations(WORKSPACE_FILE_PATH).configure();
+
+    expect(mockMakeApiClient).toHaveBeenCalledWith(CoreV1Api);
+    expect(mockCoreV1Api.readNamespacedConfigMap).toHaveBeenCalledWith(
+      'vscode-editor-configurations',
+      DEVWORKSPACE_NAMESPACE
+    );
+    expect(fileExistsMock).not.toHaveBeenCalled();
+    expect(readFileMock).not.toHaveBeenCalled();
+    expect(writeFileMock).not.toHaveBeenCalled();
+  });
+
   it('should skip applying extensions when the workspace file is not found', async () => {
     env.DEVWORKSPACE_NAMESPACE = DEVWORKSPACE_NAMESPACE;
     const mockResponse = {
@@ -233,8 +278,13 @@ describe('Test applying editor configurations:', () => {
     expect(writeFileMock).not.toHaveBeenCalled();
   });
 
-  it('should apply extensions from a configmap', async () => {
+  it('should apply extensions from a configmap when workspace file does not contain extensions', async () => {
     env.DEVWORKSPACE_NAMESPACE = DEVWORKSPACE_NAMESPACE;
+    const workspaceConfigWithConfigMapExtensionsJson = {
+      ...WORKSPACE_CONFIG_WITHOUT_EXTENSIONS_JSON,
+      extensions: CONFIGMAP_EXTENSIONS_JSON,
+    };
+    const workspaceConfigWithExtensionsToFile = JSON.stringify(workspaceConfigWithConfigMapExtensionsJson, null, '\t');
     const mockResponse = {
       response: {} as IncomingMessage,
       body: { data: CONFIGMAP_EXTENSIOSN_DATA } as V1ConfigMap,
@@ -251,7 +301,42 @@ describe('Test applying editor configurations:', () => {
       DEVWORKSPACE_NAMESPACE
     );
     expect(writeFileMock).toBeCalledTimes(1); // only extensions were applied
-    expect(writeFileMock).toBeCalledWith(WORKSPACE_FILE_PATH, WORKSPACE_CONFIG_WITH_EXTENSIONS_TO_FILE);
+    expect(writeFileMock).toBeCalledWith(WORKSPACE_FILE_PATH, workspaceConfigWithExtensionsToFile);
+  });
+
+  it('should merge extensions from the configmap and workspace file extensions', async () => {
+    env.DEVWORKSPACE_NAMESPACE = DEVWORKSPACE_NAMESPACE;
+    const workspaceConfigWithExtensionsJson = {
+      ...WORKSPACE_CONFIG_WITHOUT_EXTENSIONS_JSON,
+      extensions: WORKSPACE_EXTENSIONS_JSON,
+    };
+    const workspaceConfigWithMergedExtensionsJson = {
+      ...WORKSPACE_CONFIG_WITHOUT_EXTENSIONS_JSON,
+      extensions: MERGED_EXTENSIONS_JSON,
+    };
+    const workspaceConfigWithExtensionsToFile = JSON.stringify(workspaceConfigWithExtensionsJson, null, '\t');
+    const workspaceConfigWithMergedExtensionsToFile = JSON.stringify(
+      workspaceConfigWithMergedExtensionsJson,
+      null,
+      '\t'
+    );
+    const mockResponse = {
+      response: {} as IncomingMessage,
+      body: { data: CONFIGMAP_EXTENSIOSN_DATA } as V1ConfigMap,
+    };
+    mockCoreV1Api.readNamespacedConfigMap.mockResolvedValue(mockResponse);
+    fileExistsMock.mockResolvedValue(true);
+    readFileMock.mockResolvedValue(workspaceConfigWithExtensionsToFile);
+
+    await new EditorConfigurations(WORKSPACE_FILE_PATH).configure();
+
+    expect(mockMakeApiClient).toHaveBeenCalledWith(CoreV1Api);
+    expect(mockCoreV1Api.readNamespacedConfigMap).toHaveBeenCalledWith(
+      'vscode-editor-configurations',
+      DEVWORKSPACE_NAMESPACE
+    );
+    expect(writeFileMock).toBeCalledTimes(1); // only extensions were applied
+    expect(writeFileMock).toBeCalledWith(WORKSPACE_FILE_PATH, workspaceConfigWithMergedExtensionsToFile);
   });
 
   it('should merge product.json with a provided config map', async () => {