Merge pull request #87 from DeepCodeAI/feat/deprecation

feat: deprecate extension in favour of Snyk Vulnerability Scanner [ROAD-36]

Author: michelkaporin

README.md

@@ -1,3 +1,10 @@
+# Latest update 🗞️ (start here first 👇)
+
+- Dear developers 👋, thank you for your support and feedback!
+- With the DeepCode acquisition by [Snyk](https://snyk.io) we will be starting a new journey, a better one, towards helping you write robust and secure application code. The DeepCode extension will be replaced by [Snyk's VS Code extension](https://marketplace.visualstudio.com/items?itemName=snyk-security.snyk-vulnerability-scanner) which includes DeepCode's functionality and more.
+- If you want to read more about it, here is the [official announcement](https://www.deepcode.ai/). We will start sunsetting the official DeepCode API in August, 2021. In the mean time we will do one last update of the VS Code extension with this message to ensure you are up to date.
+- We invite you to join us and start using the new Snyk extension! We are excited and looking forward to helping you build stable and secure applications 🚀
+
 # DeepCode for Visual Studio Code
 
 **The Visual Studio Code extension provided by <a href="https://www.deepcode.ai/">DeepCode.ai</a> finds bugs and critical vulnerabilities in your code. We support JavaScript and TypeScript, Java, Python, C/C++, C# and PHP.**

package.json

@@ -130,6 +130,11 @@
  "contents": "DeepCode is temporarily unavailable\nWe are automatically retrying to connect...",
  "when": "deepcode:error == 'transient'"
  },
+ {
+ "view": "deepcode.views.analysis",
+ "contents": "The DeepCode extension is deprecated. Please use [Snyk Vulnerability Scanner](command:workbench.extensions.search?%22snyk-security.snyk-vulnerability-scanner%22) with included DeepCode's functionality and more.",
+ "when": "deepcode:deprecated"
+ },
  {
  "view": "deepcode.views.analysis",
  "contents": "DeepCode has encountered a problem. Please restart the extension: \n[Restart](command:deepcode.start 'Restart DeepCode')\nIf the error persists, please check your [settings](command:deepcode.settings) and [contact us](https://www.deepcode.ai/feedback?select=2?utm_source=vsc)!",
@@ -138,7 +143,7 @@
  {
  "view": "deepcode.views.analysis",
  "contents": "Welcome to DeepCode for Visual Studio Code. 👋\nLet's start by connecting VS Code with DeepCode:\n[Connect VS Code with DeepCode](command:deepcode.login 'Connect with DeepCode')\n👉 DeepCode's mission is to finds bugs, fast. Connect with DeepCode to start your first analysis!",
- "when": "!deepcode:error && !deepcode:loggedIn"
+ "when": "!deepcode:error && !deepcode:loggedIn && !deepcode:deprecated"
  },
  {
  "view": "deepcode.views.analysis",
@@ -187,7 +192,7 @@
  "commandPalette": [
  {
  "command": "deepcode.login",
- "when": "!deepcode:loggedIn"
+ "when": "!deepcode:loggedIn && !deepcode:deprecated"
  },
  {
  "command": "deepcode.dcignore",
@@ -199,7 +204,8 @@
  {
  "command": "deepcode.start",
  "title": "DeepCode re-scan",
- "icon": "$(refresh)"
+ "icon": "$(refresh)",
+ "enablement": "!deepcode:deprecated"
  },
  {
  "command": "deepcode.settings",

src/deepcode/DeepCodeExtension.ts

@@ -22,6 +22,7 @@ import {
  DEEPCODE_VIEW_SUPPORT,
  DEEPCODE_VIEW_ANALYSIS,
  DEEPCODE_ANALYSIS_STATUS,
+ DEEPCODE_CONTEXT,
 } from './constants/views';
 import { openDeepcodeSettingsCommand, createDCIgnoreCommand } from './utils/vscodeCommandsUtils';
 import { errorsLogs } from './messages/errorsServerLogMessages';
@@ -161,6 +162,10 @@ class DeepCodeExtension extends DeepCodeLib implements ExtensionInterface {
  }),
  );
 
+ if (this.isApiDeprecated(context)) {
+ return;
+ }
+
  // Actually start analysis
  this.startExtension();
  }
@@ -169,6 +174,23 @@ class DeepCodeExtension extends DeepCodeLib implements ExtensionInterface {
  emitter.removeAllListeners();
  }
 
+ private isApiDeprecated(context: vscode.ExtensionContext): boolean {
+ // API is deprecated from 01.09.2021 onwards
+ const deprecated = Date.now() >= new Date(2021, 8, 1).getTime();
+ if (deprecated) {
+ this.setContext(DEEPCODE_CONTEXT.DEPRECATED, true);
+ return true;
+ }
+
+ this.checkDeprecationNote(context).catch(err =>
+ this.processError(err, {
+ message: errorsLogs.checkDeprecationNoteMode,
+ }),
+ );
+
+ return false;
+ }
+
  onSupportedFilesLoaded(data: ISupportedFiles | null) {
  const msg = data ? 'Ignore rules loading' : 'Loading';
 

src/deepcode/constants/views.ts

@@ -12,6 +12,7 @@ export const DEEPCODE_CONTEXT = {
  ERROR: 'error',
  MODE: 'mode',
  ADVANCED: 'advanced',
+ DEPRECATED: 'deprecated',
 };
 
 export const DEEPCODE_ERROR_CODES = {

src/deepcode/lib/modules/LoginModule.ts

@@ -15,6 +15,7 @@ const sleep = (duration: number) => new Promise(resolve => setTimeout(resolve, d
 abstract class LoginModule extends ReportModule implements LoginModuleInterface {
  private pendingLogin: boolean = false;
  private pendingToken = '';
+ private readonly deprecationNoteKey = 'deepcode.deprecationNoteMonth';
 
  async initiateLogin(): Promise<void> {
  await this.setContext(DEEPCODE_CONTEXT.LOGGEDIN, false);
@@ -131,6 +132,16 @@ abstract class LoginModule extends ReportModule implements LoginModuleInterface
  async checkAdvancedMode(): Promise<void> {
  await this.setContext(DEEPCODE_CONTEXT.ADVANCED, this.shouldShowAdvancedView);
  }
+
+ async checkDeprecationNote(context: vscode.ExtensionContext): Promise<void> {
+ const currentMonth = new Date().getMonth();
+ const lastMessageMonth: number | undefined = context.globalState.get(this.deprecationNoteKey);
+
+ if (!lastMessageMonth || currentMonth != lastMessageMonth) {
+ context.globalState.update(this.deprecationNoteKey, currentMonth);
+ await vscode.window.showInformationMessage(deepCodeMessages.deprecation.msg);
+ }
+ }
 }
 
 export default LoginModule;

src/deepcode/messages/deepCodeMessages.ts

@@ -3,4 +3,8 @@ export const deepCodeMessages = {
  msg: "Welcome to DeepCode! Check out our dashboard to start analyzing your code",
  button: "Check it out",
  },
+ deprecation: {
+ msg:
+ 'The DeepCode extension is deprecated. Please use [Snyk Vulnerability Scanner](command:workbench.extensions.search?%22snyk-security.snyk-vulnerability-scanner%22) with included DeepCode\'s functionality and more.',
+ },
 };

src/deepcode/messages/errorsServerLogMessages.ts

@@ -27,6 +27,7 @@ export const errorsLogs = {
  loadingBadge: 'Failed to set loading badge icon',
  welcomeNotification: 'Failed to handle welcome notification',
  checkAdvancedMode: 'Failed to check advanced mode',
+ checkDeprecationNoteMode: 'Failed to check deprecation note',
  suggestionView: 'Failed to show suggestion view',
  suggestionViewMessage: 'Failed handle message from suggestion view',
 };