feat: handle LS folderConfigs [IDE-502]

package.json

@@ -217,6 +217,11 @@
             "default": [],
             "description": "Folders to trust for Snyk scans."
           },
+          "snyk.folderConfigs": {
+            "type": "array",
+            "default": [],
+            "description": "Folder configuration for Snyk scans."
+          },
           "snyk.features.preview": {
             "type": "object",
             "default": {},

src/snyk/common/configuration/configuration.ts

@@ -25,6 +25,7 @@
   YES_CRASH_REPORT_SETTING,
   YES_WELCOME_NOTIFICATION_SETTING,
   DELTA_FINDINGS,
+  FOLDER_CONFIGS,
 } from '../constants/settings';
 import SecretStorageAdapter from '../vscode/secretStorage';
 import { IVSCodeWorkspace } from '../vscode/workspace';
@@ -36,6 +37,13 @@
   iacEnabled: boolean | undefined;
 };
 
+
+export type FolderConfig = {
+  folderPath: string;
+  baseBranch: string;
+  localBranches: string[] | undefined;
+};
+
 export interface IssueViewOptions {
   ignoredIssues: boolean;
   openIssues: boolean;
@@ -122,6 +130,10 @@
   setEndpoint(endpoint: string): Promise<void>;
 
   getDeltaFindingsEnabled(): boolean;
+
+  getFolderConfigs(): FolderConfig[];
+
+  setFolderConfigs(folderConfig: FolderConfig[]): Promise<void>;
 }
 
 export class Configuration implements IConfiguration {
@@ -463,6 +475,12 @@
     );
   }
 
+  getFolderConfigs(): FolderConfig[] {
+    return (
+      this.workspace.getConfiguration<FolderConfig[]>(CONFIGURATION_IDENTIFIER, this.getConfigName(FOLDER_CONFIGS)) || []
+    );
+  }
+
   get scanningMode(): string | undefined {
     return this.workspace.getConfiguration<string>(CONFIGURATION_IDENTIFIER, this.getConfigName(SCANNING_MODE));
   }
@@ -476,5 +494,14 @@
     );
   }
 
+  async setFolderConfigs(folderConfigs: FolderConfig[]): Promise<void> {
+    await this.workspace.updateConfiguration(
+      CONFIGURATION_IDENTIFIER,
+      this.getConfigName(FOLDER_CONFIGS),
+      folderConfigs,
+      true,
+    );
+  }
+
   private getConfigName = (setting: string) => setting.replace(`${CONFIGURATION_IDENTIFIER}.`, '');
 }

src/snyk/common/configuration/folderConfig.ts

@@ -0,0 +1,40 @@
+import { FolderConfig, IConfiguration } from './configuration';
+
+export interface IFolderConfigs {
+  getFolderConfigs(config: IConfiguration): ReadonlyArray<FolderConfig>;
+
+  resetFolderConfigsCache(): void;
+}
+
+export class FolderConfigs implements IFolderConfigs {
+  private folderConfigsCache?: ReadonlyArray<FolderConfig>;
+
+  getFolderConfigs(config: IConfiguration): ReadonlyArray<FolderConfig> {
+    if (this.folderConfigsCache !== undefined) {
+      return this.folderConfigsCache;
+    }
+
+    const folderConfigs = config.getFolderConfigs();
+
+    this.folderConfigsCache = folderConfigs;
+
+    return folderConfigs;
+  }
+
+  setFolderConfig(_config: IConfiguration, _folderPath: string, _baseBranch: string) {
+    // Get all folders and update one you need and use setFolderConfig.
+    // if (this.folderConfigsCache !== undefined) {
+    //   return this.folderConfigsCache;
+    // }
+
+    // const folderConfigs = config.getFolderConfigs();
+
+    // this.folderConfigsCache = folderConfigs;
+
+    // return folderConfigs;
+  }
+
+  resetFolderConfigsCache() {
+    this.folderConfigsCache = undefined;
+  }
+}

src/snyk/common/constants/languageServer.ts

@@ -12,3 +12,4 @@ export const SNYK_HAS_AUTHENTICATED = '$/snyk.hasAuthenticated';
 export const SNYK_CLI_PATH = '$/snyk.isAvailableCli';
 export const SNYK_ADD_TRUSTED_FOLDERS = '$/snyk.addTrustedFolders';
 export const SNYK_SCAN = '$/snyk.scan';
+export const SNYK_FOLDERCONFIG = '$/snyk.folderConfigs';

src/snyk/common/constants/settings.ts

@@ -24,6 +24,7 @@ export const ADVANCED_CUSTOM_LS_PATH = `${CONFIGURATION_IDENTIFIER}.advanced.lan
 export const ISSUE_VIEW_OPTIONS_SETTING = `${CONFIGURATION_IDENTIFIER}.issueViewOptions`;
 export const SEVERITY_FILTER_SETTING = `${CONFIGURATION_IDENTIFIER}.severity`;
 export const TRUSTED_FOLDERS = `${CONFIGURATION_IDENTIFIER}.trustedFolders`;
+export const FOLDER_CONFIGS = `${CONFIGURATION_IDENTIFIER}.folderConfigs`;
 export const SCANNING_MODE = `${CONFIGURATION_IDENTIFIER}.scanningMode`;
 
 export const DELTA_FINDINGS = `${FEATURES_PREVIEW_SETTING}.deltaFindings`;

src/snyk/common/languageServer/languageServer.ts

@@ -1,10 +1,11 @@
 import _ from 'lodash';
 import { firstValueFrom, ReplaySubject, Subject } from 'rxjs';
 import { IAuthenticationService } from '../../base/services/authenticationService';
-import { IConfiguration } from '../configuration/configuration';
+import { FolderConfig, IConfiguration } from '../configuration/configuration';
 import {
   SNYK_ADD_TRUSTED_FOLDERS,
   SNYK_CLI_PATH,
+  SNYK_FOLDERCONFIG,
   SNYK_HAS_AUTHENTICATED,
   SNYK_LANGUAGE_SERVER_NAME,
   SNYK_SCAN,
@@ -118,7 +119,7 @@ export class LanguageServer implements ILanguageServer {
     };
 
     // Create the language client and start the client.
-    this.client = this.languageClientAdapter.create('Snyk LS', SNYK_LANGUAGE_SERVER_NAME, serverOptions, clientOptions);
+    this.client = this.languageClientAdapter.create('SnykLS', SNYK_LANGUAGE_SERVER_NAME, serverOptions, clientOptions);
 
     try {
       // Start the client. This will also launch the server
@@ -138,6 +139,12 @@ export class LanguageServer implements ILanguageServer {
       });
     });
 
+    client.onNotification(SNYK_FOLDERCONFIG, ({ folderConfigs }: { folderConfigs: FolderConfig[] }) => {
+      this.configuration.setFolderConfigs(folderConfigs).catch((error: Error) => {
+        ErrorHandler.handle(error, this.logger, error.message);
+      });
+    });
+
     client.onNotification(SNYK_CLI_PATH, ({ cliPath }: { cliPath: string }) => {
       if (!cliPath) {
         ErrorHandler.handle(

src/snyk/common/languageServer/settings.ts

@@ -1,6 +1,6 @@
 import _ from 'lodash';
 import { CLI_INTEGRATION_NAME } from '../../cli/contants/integration';
-import { Configuration, IConfiguration, SeverityFilter } from '../configuration/configuration';
+import { Configuration, FolderConfig, IConfiguration, SeverityFilter } from '../configuration/configuration';
 import { User } from '../user';
 import { PROTOCOL_VERSION } from '../constants/languageServer';
 
@@ -41,6 +41,7 @@
   deviceId?: string;
   requiredProtocolVersion?: string;
   enableDeltaFindings?: string;
+  folderConfigs: FolderConfig[];
 };
 
 export class LanguageServerSettings {
@@ -80,6 +81,7 @@
       integrationVersion: await Configuration.getVersion(),
       deviceId: user.anonymousId,
       requiredProtocolVersion: `${PROTOCOL_VERSION}`,
+      folderConfigs: configuration.getFolderConfigs()
     };
   }
 }

src/test/unit/common/languageServer/languageServer.test.ts

@@ -223,6 +223,7 @@
         insecure: 'true',
         requiredProtocolVersion: '12',
         scanningMode: 'auto',
+        folderConfigs: []
       };
 
       deepStrictEqual(await languageServer.getInitializationOptions(), expectedInitializationOptions);