Merge pull request #57 from codiga/feat/add-rule-metrics

feat: add records for Codiga file and rule fix uses

Author: dastrong-codiga

package-lock.json

@@ -31,7 +31,7 @@
     "React",
     "Typescript"
   ],
-  "version": "0.8.8",
+  "version": "0.8.9",
   "engines": {
     "vscode": "^1.70.0"
   },

package.json

@@ -0,0 +1,17 @@
+import { getUserFingerprint } from "../utils/configurationUtils";
+import { doMutation } from "./client";
+import { USE_CREATE_CODIGA_YAML } from "./mutations";
+
+/**
+ * creates a record when the user creates a codiga.yml file through
+ * our VSCode suggestion popup
+ */
+export async function addCreateCodigaYamlRecord(): Promise<void> {
+  // Get the fingerprint from localstorage to initiate the request
+  const userFingerprint = getUserFingerprint();
+
+  // record that a rule fix has taken place
+  await doMutation(USE_CREATE_CODIGA_YAML, {
+    fingerprint: userFingerprint,
+  });
+}

src/graphql-api/add-create-codiga-yaml-record.ts

@@ -0,0 +1,16 @@
+import { getUserFingerprint } from "../utils/configurationUtils";
+import { doMutation } from "./client";
+import { USE_RULE_FIX } from "./mutations";
+
+/**
+ * creates a record when a rule fix was applied in the editor
+ */
+export async function addRuleFixRecord(): Promise<void> {
+  // Get the fingerprint from localstorage to initiate the request
+  const userFingerprint = getUserFingerprint();
+
+  // record that a rule fix has taken place
+  await doMutation(USE_RULE_FIX, {
+    fingerprint: userFingerprint,
+  });
+}

src/graphql-api/add-rule-fix-record.ts

@@ -10,3 +10,24 @@ export const USE_RECIPE: string = gql`
     )
   }
 `;
+
+export const USE_RULE_FIX: string = gql`
+  mutation recordAccess($fingerprint: String, $ruleId: Long) {
+    recordAccess(
+      accessType: VsCode
+      actionType: RuleFix
+      ruleId: $ruleId
+      userFingerprint: $fingerprint
+    )
+  }
+`;
+
+export const USE_CREATE_CODIGA_YAML: string = gql`
+  mutation recordAccess($fingerprint: String) {
+    recordAccess(
+      accessType: VsCode
+      actionType: CreateCodigaYaml
+      userFingerprint: $fingerprint
+    )
+  }
+`;

src/graphql-api/mutations.ts

@@ -1,5 +1,6 @@
 import * as vscode from "vscode";
 import { getFixesForDocument } from "../diagnostics/diagnostics";
+import { addRuleFixRecord } from "../graphql-api/add-rule-fix-record";
 import { RosieFix, RosieFixEdit } from "./rosieTypes";
 
 /**
@@ -59,6 +60,7 @@ export const applyFix = async (
   const workspaceEdit = new vscode.WorkspaceEdit();
   workspaceEdit.set(document.uri, edits);
   await vscode.workspace.applyEdit(workspaceEdit);
+  await addRuleFixRecord();
 };
 
 export class RosieFixAction implements vscode.CodeActionProvider {

src/rosie/rosiefix.ts

@@ -8,6 +8,7 @@ import {
   INFO_MESSAGE_CODIGA_FILE_KEY,
   VALUE_STRING_TRUE,
 } from "../constants";
+import { addCreateCodigaYamlRecord } from "../graphql-api/add-create-codiga-yaml-record";
 import { isRosieLanguageDetected } from "../rosie/rosieUtils";
 import getFileUri, { doesFileExist } from "./fileUtils";
 import { getFromLocalStorage, setToLocalStorage } from "./localStorage";
@@ -43,6 +44,7 @@ export async function checkCodigaFileSuggestion() {
               "utf-8"
             );
             await vscode.workspace.fs.writeFile(codigaUri, codigaFileContent);
+            await addCreateCodigaYamlRecord();
           }
         }
         if (selectedItem === INFO_MESSAGE_CODIGA_FILE_ACTION_IGNORE) {