feat: allow custom base url configuration for dev work [ROAD-209]

src/snyk/base/modules/baseSnykModule.ts

@@ -1,5 +1,4 @@
 import * as vscode from 'vscode';
-import { configuration } from '../../common/configuration';
 import { ContextService, IContextService } from '../../common/services/contextService';
 import { IOpenerService, OpenerService } from '../../common/services/openerService';
 import { IViewManagerService, ViewManagerService } from '../../common/services/viewManagerService';
@@ -9,6 +8,7 @@ import SnykStatusBarItem, { IStatusBarItem } from '../statusBarItem/statusBarIte
 import SettingsWatcher from '../../common/watchers/settingsWatcher';
 import { IWatcher } from '../../common/watchers/interfaces';
 import { IBaseSnykModule, errorType } from './interfaces';
+import { configuration } from '../../common/configuration/instance';
 
 export default abstract class BaseSnykModule implements IBaseSnykModule {
   statusBarItem: IStatusBarItem;

src/snyk/base/modules/loginModule.ts

@@ -1,6 +1,6 @@
 import { checkSession, startSession } from '@snyk/code-client';
 import { getIpFamily, IpFamily } from '@snyk/code-client/dist/http';
-import { configuration } from '../../common/configuration';
+import { configuration } from '../../common/configuration/instance';
 import { SNYK_CONTEXT } from '../../common/constants/views';
 import { Logger } from '../../common/logger/logger';
 import { errorsLogs } from '../../common/messages/errorsServerLogMessages';

src/snyk/base/modules/reportModule.ts

@@ -1,6 +1,6 @@
 import { constants, reportError } from '@snyk/code-client';
 import * as _ from 'lodash';
-import { configuration } from '../../common/configuration';
+import { configuration } from '../../common/configuration/instance';
 import {
   COMMAND_DEBOUNCE_INTERVAL,
   CONNECTION_ERROR_RETRY_INTERVAL,

src/snyk/base/modules/snykLib.ts

@@ -1,5 +1,4 @@
 import * as _ from 'lodash';
-import { configuration } from '../../common/configuration';
 import {
   EXECUTION_DEBOUNCE_INTERVAL,
   EXECUTION_PAUSE_INTERVAL,
@@ -13,6 +12,7 @@ import * as vscode from 'vscode';
 import LoginModule from './loginModule';
 import { analytics } from '../../common/analytics/analytics';
 import { ISnykLib } from './interfaces';
+import { configuration } from '../../common/configuration/instance';
 
 export default class SnykLib extends LoginModule implements ISnykLib {
   private _mode = SNYK_MODE_CODES.AUTO;

src/snyk/base/views/welcome/welcomeViewProvider.ts

@@ -1,6 +1,7 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 import * as vscode from 'vscode';
-import { configuration, FeaturesConfiguration } from '../../../common/configuration';
+import { FeaturesConfiguration } from '../../../common/configuration/configuration';
+import { configuration } from '../../../common/configuration/instance';
 import { SNYK_CONTEXT } from '../../../common/constants/views';
 import { IContextService } from '../../../common/services/contextService';
 

src/snyk/common/analytics/analytics.ts

@@ -1,4 +1,4 @@
-import { configuration } from '../configuration';
+import { configuration } from '../configuration/instance';
 import { Logger } from '../logger/logger';
 import { IAnalytics, Iteratively } from './itly';
 

src/snyk/common/api/apiСlient.ts

@@ -1,5 +1,5 @@
 import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
-import { configuration } from '../configuration';
+import { configuration } from '../configuration/instance';
 
 const defaultHeaders: Readonly<Record<string, string | boolean>> = {
   Accept: 'application/json',

src/snyk/common/configuration/configuration.ts

@@ -0,0 +1,163 @@
+import { URL } from 'url';
+import { IDE_NAME } from '../constants/general';
+import {
+  ADVANCED_ADVANCED_MODE_SETTING,
+  CODE_QUALITY_ENABLED_SETTING,
+  CODE_SECURITY_ENABLED_SETTING,
+  CONFIGURATION_IDENTIFIER,
+  TOKEN_SETTING,
+  YES_CRASH_REPORT_SETTING,
+  YES_TELEMETRY_SETTING,
+  YES_WELCOME_NOTIFICATION_SETTING,
+} from '../constants/settings';
+import { IVSCodeWorkspace } from '../vscode/workspace';
+
+export type FeaturesConfiguration = {
+  codeSecurityEnabled: boolean | undefined;
+  codeQualityEnabled: boolean | undefined;
+};
+
+export interface IConfiguration {
+  isDevelopment: boolean;
+  source: string;
+  baseURL: string;
+  authHost: string;
+  snykCodeUrl: string;
+  token: string | undefined;
+  snykCodeToken: string | undefined;
+  setToken(token: string): Promise<void>;
+  shouldReportErrors: boolean;
+  shouldReportEvents: boolean;
+  getFeaturesConfiguration(): FeaturesConfiguration | undefined;
+  setFeaturesConfiguration(config: FeaturesConfiguration | undefined): Promise<void>;
+}
+
+export class Configuration implements IConfiguration {
+  // These attributes are used in tests
+  private defaultBaseURL = 'https://deeproxy.snyk.io';
+  private defaultAuthHost = 'https://snyk.io';
+
+  constructor(private processEnv: NodeJS.ProcessEnv = process.env, private workspace: IVSCodeWorkspace) {}
+
+  get isDevelopment(): boolean {
+    return !!this.processEnv.SNYK_VSCE_DEVELOPMENT;
+  }
+
+  get baseURL(): string {
+    if (this.isDevelopment) {
+      return this.processEnv.SNYK_VSCE_DEVELOPMENT_SNYKCODE_BASE_URL ?? 'https://deeproxy.dev.snyk.io';
+    }
+
+    return this.defaultBaseURL;
+  }
+
+  get authHost(): string {
+    return this.isDevelopment ? 'https://dev.snyk.io' : this.defaultAuthHost;
+  }
+
+  get snykCodeUrl(): string {
+    const authUrl = new URL(this.authHost);
+    authUrl.host = `app.${authUrl.host}`;
+
+    return `${authUrl.toString()}manage/snyk-code?from=vscode`;
+  }
+
+  get token(): string | undefined {
+    return this.workspace.getConfiguration(CONFIGURATION_IDENTIFIER, this.getConfigName(TOKEN_SETTING));
+  }
+
+  get snykCodeToken(): string | undefined {
+    return (this.isDevelopment && this.processEnv.SNYK_VSCE_DEVELOPMENT_SNYKCODE_TOKEN) || this.token;
+  }
+
+  async setToken(token: string | undefined): Promise<void> {
+    await this.workspace.updateConfiguration(CONFIGURATION_IDENTIFIER, this.getConfigName(TOKEN_SETTING), token, true);
+  }
+
+  get source(): string {
+    return this.processEnv.GITPOD_WORKSPACE_ID ? 'gitpod' : IDE_NAME;
+  }
+
+  getFeaturesConfiguration(): FeaturesConfiguration | undefined {
+    const codeSecurityEnabled = this.workspace.getConfiguration<boolean>(
+      CONFIGURATION_IDENTIFIER,
+      this.getConfigName(CODE_SECURITY_ENABLED_SETTING),
+    );
+    const codeQualityEnabled = this.workspace.getConfiguration<boolean>(
+      CONFIGURATION_IDENTIFIER,
+      this.getConfigName(CODE_QUALITY_ENABLED_SETTING),
+    );
+
+    if (!codeSecurityEnabled && !codeQualityEnabled) {
+      return undefined;
+    }
+
+    return {
+      codeSecurityEnabled,
+      codeQualityEnabled,
+    };
+  }
+
+  async setFeaturesConfiguration(config: FeaturesConfiguration | undefined): Promise<void> {
+    await this.workspace.updateConfiguration(
+      CONFIGURATION_IDENTIFIER,
+      this.getConfigName(CODE_SECURITY_ENABLED_SETTING),
+      config?.codeSecurityEnabled,
+      true,
+    );
+    await this.workspace.updateConfiguration(
+      CONFIGURATION_IDENTIFIER,
+      this.getConfigName(CODE_QUALITY_ENABLED_SETTING),
+      config?.codeQualityEnabled,
+      true,
+    );
+  }
+
+  get shouldReportErrors(): boolean {
+    return !!this.workspace.getConfiguration<boolean>(
+      CONFIGURATION_IDENTIFIER,
+      this.getConfigName(YES_CRASH_REPORT_SETTING),
+    );
+  }
+
+  get shouldReportEvents(): boolean {
+    return !!this.workspace.getConfiguration<boolean>(
+      CONFIGURATION_IDENTIFIER,
+      this.getConfigName(YES_TELEMETRY_SETTING),
+    );
+  }
+
+  async setShouldReportEvents(yesTelemetry: boolean): Promise<void> {
+    await this.workspace.updateConfiguration(
+      CONFIGURATION_IDENTIFIER,
+      this.getConfigName(YES_TELEMETRY_SETTING),
+      yesTelemetry,
+      true,
+    );
+  }
+
+  get shouldShowWelcomeNotification(): boolean {
+    return !!this.workspace.getConfiguration<boolean>(
+      CONFIGURATION_IDENTIFIER,
+      this.getConfigName(YES_WELCOME_NOTIFICATION_SETTING),
+    );
+  }
+
+  async hideWelcomeNotification(): Promise<void> {
+    await this.workspace.updateConfiguration(
+      CONFIGURATION_IDENTIFIER,
+      this.getConfigName(YES_WELCOME_NOTIFICATION_SETTING),
+      false,
+      true,
+    );
+  }
+
+  get shouldShowAdvancedView(): boolean {
+    return !!this.workspace.getConfiguration<boolean>(
+      CONFIGURATION_IDENTIFIER,
+      this.getConfigName(ADVANCED_ADVANCED_MODE_SETTING),
+    );
+  }
+
+  private getConfigName = (setting: string) => setting.replace(`${CONFIGURATION_IDENTIFIER}.`, '');
+}

src/snyk/common/configuration/instance.ts

@@ -0,0 +1,4 @@
+import { Configuration } from './configuration';
+import { VSCodeWorkspace } from '../vscode/workspace';
+
+export const configuration = new Configuration(process.env, new VSCodeWorkspace());

src/snyk/common/constants/general.ts

@@ -1,7 +1,7 @@
 // Changing this requires changing display name in package.json.
 export const SNYK_NAME = 'Snyk Vulnerability Scanner';
-export const SNYK_NAME_EXTENSION = SNYK_NAME.toLowerCase().replaceAll(' ', '-');
 export const SNYK_PUBLISHER = 'snyk-security';
+export const SNYK_NAME_EXTENSION = SNYK_NAME.toLowerCase().replace(/\s/g, '-');
 export const MAX_CONNECTION_RETRIES = 5; // max number of automatic retries before showing an error
 export const IDE_NAME = 'vscode';
 export const COMMAND_DEBOUNCE_INTERVAL = 200; // 200 milliseconds