chore: Store user preferences in a config-map (#1260)

Use config-map to store and restore user preferences. This gives an ability not to use che-server API for storing preferences.

extensions/eclipse-che-theia-user-preferences/package.json

@@ -20,7 +20,9 @@
     "@theia/workspace": "next",
     "nsfw": "^2.1.2",
     "@theia/preferences": "next",
-    "@eclipse-che/theia-plugin-ext": "^0.0.1"
+    "@eclipse-che/theia-plugin-ext": "^0.0.1",
+    "@kubernetes/client-node": "^0.12.1",
+    "@eclipse-che/theia-remote-impl-che-server": "0.0.1"
   },
   "devDependencies": {
     "rimraf": "latest",

extensions/eclipse-che-theia-user-preferences/src/node/che-theia-preferences-synchronizer.ts

@@ -8,24 +8,36 @@
  * SPDX-License-Identifier: EPL-2.0
  ***********************************************************************/
 
+import * as k8s from '@kubernetes/client-node';
 import * as nsfw from 'nsfw';
 
+import { CheK8SService, WorkspaceService } from '@eclipse-che/theia-remote-api/lib/common';
 import { Emitter, Event } from '@theia/core';
 import { Preferences, UserService } from '@eclipse-che/theia-remote-api/lib/common/user-service';
 import { dirname, resolve } from 'path';
 import { ensureDir, readFile, writeFile } from 'fs-extra';
 import { inject, injectable } from 'inversify';
 
+import { CheK8SServiceImpl } from '@eclipse-che/theia-remote-impl-che-server/lib/node/che-server-k8s-service-impl';
 import { homedir } from 'os';
+import { readFileSync } from 'fs';
 
 export const THEIA_PREFERENCES_KEY = 'theia-user-preferences';
+export const WORKSPACE_PREFERENCES_CONFIGMAP_NAME = 'workspace-preferences-configmap';
 export const THEIA_USER_PREFERENCES_PATH = resolve(homedir(), '.theia', 'settings.json');
+const INFRASTRUCTURE_NAMESPACE = 'infrastructureNamespace';
 
 @injectable()
 export class CheTheiaUserPreferencesSynchronizer {
   @inject(UserService)
   protected userService: UserService;
 
+  @inject(CheK8SService)
+  private readonly cheK8SService: CheK8SServiceImpl;
+
+  @inject(WorkspaceService)
+  private readonly workspaceService: WorkspaceService;
+
   protected settingsJsonWatcher: nsfw.NSFW | undefined;
 
   protected readonly onUserPreferencesModifyEmitter = new Emitter<object>();
@@ -39,11 +51,30 @@ export class CheTheiaUserPreferencesSynchronizer {
    * Provides stored Theia user preferences into workspace.
    */
   public async readTheiaUserPreferencesFromCheSettings(): Promise<void> {
-    const chePreferences = await this.userService.getUserPreferences(THEIA_PREFERENCES_KEY);
-    const theiaPreferences = chePreferences[THEIA_PREFERENCES_KEY] ? chePreferences[THEIA_PREFERENCES_KEY] : '{}';
-    const theiaPreferencesBeautified = JSON.stringify(JSON.parse(theiaPreferences), undefined, 3);
     await ensureDir(dirname(THEIA_USER_PREFERENCES_PATH));
-    await writeFile(THEIA_USER_PREFERENCES_PATH, theiaPreferencesBeautified, 'utf8');
+    let content = '';
+    try {
+      const request = await this.cheK8SService
+        .makeApiClient(k8s.CoreV1Api)
+        .readNamespacedConfigMap(WORKSPACE_PREFERENCES_CONFIGMAP_NAME, await this.getWorkspaceNamespace());
+      if (request.body && request.body.data && request.body.data[THEIA_PREFERENCES_KEY]) {
+        content = JSON.stringify(JSON.parse(request.body.data[THEIA_PREFERENCES_KEY]), undefined, 3);
+      }
+    } catch (e) {
+      console.error('Failed to retrieve preferences storage.', e);
+    }
+    await writeFile(THEIA_USER_PREFERENCES_PATH, content, 'utf8');
+  }
+
+  private async getWorkspaceNamespace(): Promise<string> {
+    // devworkspace use-case
+    const workspaceNamespace = process.env.DEVWORKSPACE_NAMESPACE;
+    if (workspaceNamespace) {
+      return Promise.resolve(workspaceNamespace);
+    }
+    // grab current workspace
+    const workspace = await this.workspaceService.currentWorkspace();
+    return workspace.attributes?.[INFRASTRUCTURE_NAMESPACE] || workspace.namespace || '';
   }
 
   public async getPreferences(): Promise<object> {
@@ -64,10 +95,27 @@ export class CheTheiaUserPreferencesSynchronizer {
       return;
     }
 
-    this.settingsJsonWatcher = await nsfw(THEIA_USER_PREFERENCES_PATH, (events: nsfw.FileChangeEvent[]) => {
+    this.settingsJsonWatcher = await nsfw(THEIA_USER_PREFERENCES_PATH, async (events: nsfw.FileChangeEvent[]) => {
       for (const event of events) {
         if (event.action === nsfw.actions.MODIFIED) {
-          this.updateTheiaUserPreferencesInCheSettings();
+          const client = this.cheK8SService.makeApiClient(k8s.CoreV1Api);
+          client.defaultHeaders = {
+            Accept: 'application/json',
+            'Content-Type': k8s.PatchUtils.PATCH_FORMAT_STRATEGIC_MERGE_PATCH,
+          };
+          const preferences = readFileSync(THEIA_USER_PREFERENCES_PATH).toString();
+          const theiaPreferencesBeautified = JSON.stringify(JSON.parse(preferences), undefined, 3);
+          try {
+            await client.patchNamespacedConfigMap(
+              WORKSPACE_PREFERENCES_CONFIGMAP_NAME,
+              await this.getWorkspaceNamespace(),
+              {
+                data: { [THEIA_PREFERENCES_KEY]: theiaPreferencesBeautified },
+              }
+            );
+          } catch (e) {
+            console.error('Failed to update preferences storage.', e);
+          }
           return;
         }
       }