Merge pull request #55 from codiga/feat/add-user-agent-headers

feat: add user agent headers

Author: juli1

package-lock.json

@@ -31,7 +31,7 @@
     "React",
     "Typescript"
   ],
-  "version": "0.8.5",
+  "version": "0.8.7",
   "engines": {
     "vscode": "^1.70.0"
   },
@@ -205,6 +205,7 @@
     "react-markdown": "^8.0.3",
     "remark": "^14.0.2",
     "remark-html": "^15.0.1",
+    "rollbar": "^2.26.0",
     "yaml": "^2.1.1"
   },
   "__metadata": {

package.json

@@ -3,6 +3,12 @@ import { Language } from "./graphql-api/types";
 export const GRAPHQL_ENDPOINT_PROD = "https://api.codiga.io/graphql";
 export const GRAPHQL_ENDPOINT_STAGING = "https://api-staging.codiga.io/graphql";
 
+export const CODIGA_EXTENSION_ID = "codiga.vscode-plugin";
+
+export const API_TOKEN_HEADER_KEY = "X-Api-Token";
+export const USER_AGENT_HEADER_KEY = "User-Agent";
+export const USER_AGENT_HEADER_PRODUCT = "VsCode";
+
 export const CODING_ASSISTANT_WAIT_BEFORE_QUERYING_RESULTS_IN_MS = 200;
 
 export const MESSAGE_STARTUP_SHOW_SHORTCUTS = "View Shortcuts";

src/constants.ts

@@ -39,14 +39,15 @@ import { provideInlineComplextion } from "./code-completion/inline-completion";
 import { AssistantRecipe } from "./graphql-api/types";
 import { subscribeToDocumentChanges } from "./diagnostics/diagnostics";
 import { applyFix, RosieFixAction } from "./rosie/rosiefix";
-import { RosieFix, Violation } from "./rosie/rosieTypes";
+import { RosieFix } from "./rosie/rosieTypes";
 import { refreshCachePeriodic } from "./rosie/rosieCache";
 import { recordLastActivity } from "./utils/activity";
 import {
   IgnoreViolation,
   ignoreViolation,
 } from "./diagnostics/ignore-violation";
 import { checkCodigaFileSuggestion } from "./utils/startupUtils";
+import { rollbarLogger } from "./utils/rollbarUtils";
 
 // this method is called when your extension is activated
 // your extension is activated the very first time the command is executed
@@ -291,6 +292,7 @@ export async function activate(context: vscode.ExtensionContext) {
     } catch (e) {
       console.debug("Error when trying to fetch shortcuts");
       console.debug(e);
+      rollbarLogger(e);
     }
   });
 
@@ -305,6 +307,7 @@ export async function activate(context: vscode.ExtensionContext) {
     } catch (e) {
       console.debug("Error when trying to refresh the webview");
       console.debug(e);
+      rollbarLogger(e);
     }
   });
 

src/extension.ts

@@ -1,6 +1,14 @@
+import * as vscode from "vscode";
 import { GraphQLClient } from "graphql-request";
-import { GRAPHQL_ENDPOINT_STAGING, GRAPHQL_ENDPOINT_PROD } from "../constants";
+import {
+  GRAPHQL_ENDPOINT_PROD,
+  API_TOKEN_HEADER_KEY,
+  USER_AGENT_HEADER_KEY,
+  USER_AGENT_HEADER_PRODUCT,
+} from "../constants";
 import { getApiToken } from "./configuration";
+import { getExtensionVersion } from "../utils/extensionUtils";
+import { rollbarLogger } from "../utils/rollbarUtils";
 
 let client: GraphQLClient;
 
@@ -15,16 +23,25 @@ export function initializeClient(): void {
 function generateHeaders(): Record<string, string> {
   const apiToken = getApiToken();
 
+  const userAgentHeader = {
+    [USER_AGENT_HEADER_KEY]: `${USER_AGENT_HEADER_PRODUCT}/${
+      getExtensionVersion() || ""
+    }`,
+  };
+
   /**
    * First, check if there is a token. If that is the case,
    * prioritize its use.
    */
   if (apiToken && apiToken.length > 20) {
     return {
-      "X-Api-Token": apiToken,
+      ...userAgentHeader,
+      [API_TOKEN_HEADER_KEY]: apiToken,
     };
   }
-  return {};
+  return {
+    ...userAgentHeader,
+  };
 }
 
 /**
@@ -45,6 +62,10 @@ export function doQuery(
     .catch((e) => {
       console.log("exception when querying the GraphQL API");
       console.log(e);
+      // ignore user-not-logged errors
+      if (!e.message.includes("user-not-logged")) {
+        rollbarLogger(e, { variables });
+      }
       return undefined;
     });
   return query;
@@ -65,6 +86,7 @@ export function doMutation(
     .catch((e) => {
       console.error("exception");
       console.debug(e);
+      rollbarLogger(e, { variables });
       return undefined;
     });
   return query;

src/graphql-api/client.ts

@@ -6,6 +6,7 @@ import {
 import { wasActiveRecently } from "../utils/activity";
 import { getDependencies } from "../utils/dependencies/get-dependencies";
 import { getLanguageForDocument } from "../utils/fileUtils";
+import { rollbarLogger } from "../utils/rollbarUtils";
 import {
   getRecipesForClientByShorcut,
   getRecipesForClientByShorcutLastTimestamp,
@@ -204,6 +205,7 @@ export const fetchShortcuts = async () => {
 export const fetchPeriodicShortcuts = async () => {
   if (enablePeriodicPolling) {
     await fetchShortcuts().catch((e) => {
+      rollbarLogger(e);
       console.error("error while fetching shortcuts");
     });
     garbageCollection(cache);

src/graphql-api/shortcut-cache.ts

@@ -2,6 +2,7 @@ import * as vscode from "vscode";
 import * as fs from "fs";
 import { Rule, RuleSet } from "./rosieTypes";
 import { CODIGA_RULES_DEBUGFILE } from "../constants";
+import { rollbarLogger } from "../utils/rollbarUtils";
 
 /**
  * Get the rules from the rulesets in JSON in the .codigadebug file
@@ -36,8 +37,9 @@ export const getRulesDebug = async (
         return undefined;
       }
       return getRulesFromDebugRulesets(rulesJson);
-    } catch (err) {
+    } catch (e) {
       console.debug("error when trying to read the rules");
+      rollbarLogger(e);
       return undefined;
     }
   }

src/rosie/debug.ts

@@ -12,6 +12,7 @@ import { wasActiveRecently } from "../utils/activity";
 import { getLanguageForDocument } from "../utils/fileUtils";
 import { GRAPHQL_LANGUAGE_TO_ROSIE_LANGUAGE } from "./rosieConstants";
 import { Rule } from "./rosieTypes";
+import { rollbarLogger } from "../utils/rollbarUtils";
 
 interface CacheData {
   lastRefreshed: number; // last time we refreshed the data
@@ -27,6 +28,7 @@ const RULES_CACHE = new Map<vscode.WorkspaceFolder, CacheData>();
  */
 export const refreshCachePeriodic = async (): Promise<void> => {
   await refreshCache(RULES_CACHE).catch((e) => {
+    rollbarLogger(e);
     console.error("error while fetching shortcuts");
   });
   garbageCollection(RULES_CACHE);
@@ -116,6 +118,7 @@ const getRulesFromYamlFile = async (
   } catch (e) {
     console.log("error when reading the updating the rules");
     console.log(e);
+    rollbarLogger(e);
     return [];
   }
 };
@@ -193,6 +196,7 @@ const updateCacheForWorkspace = async (
   } catch (e) {
     console.log("error when reading the updating the rules");
     console.log(e);
+    rollbarLogger(e);
   }
 };
 

src/rosie/rosieCache.ts

@@ -12,6 +12,7 @@ import {
   NODE_PACKAGE_FILE,
   REQUIREMENTS_FILE,
 } from "../../constants";
+import { rollbarLogger } from "../rollbarUtils";
 
 /**
  * Search from the top of the project a dependency file and walk backwards to the
@@ -58,6 +59,7 @@ export async function getDependenciesFromProject(
       return await functionToExecute(potentialDependencyFile).catch((e) => {
         console.debug("Codiga - error when fetching dependencies");
         console.debug(e);
+        rollbarLogger(e, { packageFile: filename });
         return [];
       });
     }

src/utils/dependencies/get-dependencies.ts

@@ -0,0 +1,11 @@
+import * as vscode from "vscode";
+import { CODIGA_EXTENSION_ID } from "../constants";
+
+export function getExtensionVersion(): string | null {
+  const codigaExtension = vscode.extensions.getExtension(CODIGA_EXTENSION_ID);
+
+  if (codigaExtension) {
+    return codigaExtension.packageJSON.version;
+  }
+  return null;
+}