chore: hide oss quickfixes behind a preview flag (#504)

* chore: hide oss quickfixes behind a preview flag * fix: add missing prop in tests * fix: add getPreviewFeatures mock for settings test * refactor: move getpreview call to configuration --------- Co-authored-by: Abdelrahman Shawki Hassan <shawki.hassan@snyk.io>
snyk · Jul 26, 2024 · f6a758e · f6a758e
1 parent 468444e
commit f6a758e
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 8 deletions.
diff --git a/src/snyk/common/configuration/configuration.ts b/src/snyk/common/configuration/configuration.ts
@@ -62,6 +62,7 @@ export interface SeverityFilter {
 
 export type PreviewFeatures = {
  advisor: boolean | undefined;
+ ossQuickfixes: boolean | undefined;
 };
 
 export interface IConfiguration {
@@ -132,6 +133,8 @@ export interface IConfiguration {
 
  getDeltaFindingsEnabled(): boolean;
 
+ getOssQuickFixCodeActionsEnabled(): boolean;
+
  getFolderConfigs(): FolderConfig[];
 
  setFolderConfigs(folderConfig: FolderConfig[]): Promise<void>;
@@ -147,6 +150,10 @@ export class Configuration implements IConfiguration {
 
  constructor(private processEnv: NodeJS.ProcessEnv = process.env, private workspace: IVSCodeWorkspace) {}
 
+ getOssQuickFixCodeActionsEnabled(): boolean {
+ return this.getPreviewFeatures().ossQuickfixes ?? false;
+ }
+
  getInsecure(): boolean {
  const strictSSL = this.workspace.getConfiguration<boolean>('http', 'proxyStrictSSL') ?? true;
  return !strictSSL;
@@ -449,6 +456,7 @@ export class Configuration implements IConfiguration {
  getPreviewFeatures(): PreviewFeatures {
  const defaultSetting: PreviewFeatures = {
  advisor: false,
+ ossQuickfixes: false,
  };
 
  const userSetting =

diff --git a/src/snyk/common/languageServer/settings.ts b/src/snyk/common/languageServer/settings.ts
@@ -43,6 +43,7 @@ export type ServerSettings = {
  requiredProtocolVersion?: string;
  enableDeltaFindings?: string;
  folderConfigs: FolderConfig[];
+ enableSnykOSSQuickFixCodeActions: string;
 };
 
 export class LanguageServerSettings {
@@ -84,6 +85,7 @@ export class LanguageServerSettings {
  deviceId: user.anonymousId,
  requiredProtocolVersion: `${PROTOCOL_VERSION}`,
  folderConfigs: configuration.getFolderConfigs(),
+ enableSnykOSSQuickFixCodeActions: `${configuration.getOssQuickFixCodeActionsEnabled()}`,
  };
  }
 }
diff --git a/src/test/unit/common/configuration.test.ts b/src/test/unit/common/configuration.test.ts
@@ -94,12 +94,14 @@ suite('Configuration', () => {
 
  deepStrictEqual(configuration.getPreviewFeatures(), {
  advisor: false,
+ ossQuickfixes: false,
  } as PreviewFeatures);
  });
 
  test('Preview features: some features enabled', () => {
  const previewFeatures = {
  advisor: false,
+ ossQuickfixes: false,
  } as PreviewFeatures;
  const workspace = stubWorkspaceConfiguration(FEATURES_PREVIEW_SETTING, previewFeatures);
 

diff --git a/src/test/unit/common/languageServer/languageServer.test.ts b/src/test/unit/common/languageServer/languageServer.test.ts
@@ -61,14 +61,18 @@ suite('Language Server', () => {
  isAutomaticDependencyManagementEnabled() {
  return true;
  },
+ getOssQuickFixCodeActionsEnabled() {
+ return false;
+ },
+ getFeaturesConfiguration() {
+ return defaultFeaturesConfigurationStub;
+ },
  getPreviewFeatures() {
  return {
  advisor: false,
+ ossQuickfixes: false,
  };
  },
- getFeaturesConfiguration() {
- return defaultFeaturesConfigurationStub;
- },
  severityFilter: {
  critical: true,
  high: true,
@@ -231,6 +235,7 @@ suite('Language Server', () => {
  scanningMode: 'auto',
  folderConfigs: [],
  authenticationMethod: 'oauth',
+ enableSnykOSSQuickFixCodeActions: 'false',
  };
 
  deepStrictEqual(await languageServer.getInitializationOptions(), expectedInitializationOptions);

diff --git a/src/test/unit/common/languageServer/middleware.test.ts b/src/test/unit/common/languageServer/middleware.test.ts
@@ -37,10 +37,11 @@ suite('Language Server: Middleware', () => {
  getDeltaFindingsEnabled(): boolean {
  return false;
  },
- getPreviewFeatures: () => {
- return {
- advisor: false,
- };
+ getPreviewFeatures() {
+ return { advisor: false, ossQuickfixes: false };
+ },
+ getOssQuickFixCodeActionsEnabled(): boolean {
+ return false;
  },
  getFeaturesConfiguration() {
  return defaultFeaturesConfigurationStub;

diff --git a/src/test/unit/common/languageServer/settings.test.ts b/src/test/unit/common/languageServer/settings.test.ts
@@ -1,5 +1,5 @@
 import assert from 'assert';
-import { FolderConfig, IConfiguration } from '../../../../snyk/common/configuration/configuration';
+import { FolderConfig, IConfiguration, PreviewFeatures } from '../../../../snyk/common/configuration/configuration';
 import { LanguageServerSettings } from '../../../../snyk/common/languageServer/settings';
 import { User } from '../../../../snyk/common/user';
 
@@ -23,6 +23,12 @@ suite('LanguageServerSettings', () => {
  getFolderConfigs(): FolderConfig[] {
  return [];
  },
+ getPreviewFeatures(): PreviewFeatures {
+ return { advisor: false, ossQuickfixes: false };
+ },
+ getOssQuickFixCodeActionsEnabled(): boolean {
+ return false;
+ },
  getAuthenticationMethod(): string {
  return 'oauth';
  },