Increase test coverage and refactor code to make it more testable (#11)

*increase test coverage
* improved repo matching, enabled multiple repos per project

Author: vanesa

Diff for: README.md

@@ -23,13 +23,13 @@ To work, the Sentry Sourcegraph extension must know how to recognize instances o
 Set the following configurations in your settings:
 
 ```
-"sentry.organization": "[Organization Name]",
+"sentry.organization": "[Sentry organization name]",
 "sentry.projects": [
   {
-    "name": "[Project Name]",
-    "projectId": "[Project ID, e.g. "1334031"]",
+    "name": "[Project name for the config overview, e.g. Webapp errors]",
+    "projectId": "[Sentry project ID, e.g. "1334031"]",
     "patternProperties": {
-      "repoMatch": "[repo name asociated with this project]",
+      "repoMatch": "[RegExp[] repo names asociated with this Sentry project]",
       "fileMatches": [
           [RegExp[] that matches file format, e.g. "\\.tsx?"]
         ],
@@ -60,7 +60,10 @@ File matches can also be narrowed down to certain folders by specifying this in
   "patternProperties": {
       "repoMatch": "sourcegraph",
       "fileMatches": ["([^'\"]+)\/.*\\.ts?"],
-      "lineMatches": ["throw new Error+\\(['\"]([^'\"]+)['\"]\\)"]
+      "lineMatches": [
+          "throw new Error+\\(['\"]([^'\"]+)['\"]\\)",
+          "console\\.(warn|debug|info|error)\\(['\"`]([^'\"`]+)['\"`]\\)"
+          ]
     }
 
   ```

Diff for: codecov.yml

@@ -1,3 +1,10 @@
 coverage:
   status:
-    patch: off
+    patch:
+      default:
+        threshold: 50%
+    project:
+      default:
+        target: 80%
+ignore:
+  - "src/test"

Diff for: package.json

@@ -140,7 +140,7 @@
     "mock-require": "^3.0.3",
     "nyc": "^13.3.0",
     "parcel-bundler": "^1.12.3",
-    "prettier": "1.16.4",
+    "prettier": "1.17.0",
     "rxjs": "^6.4.0",
     "sinon": "^7.3.1",
     "source-map-support": "^0.5.12",

Diff for: src/extension.ts

@@ -8,7 +8,7 @@ import {
     isFileMatched,
     matchSentryProject,
 } from './handler'
-import { resolveSettings, Settings } from './settings'
+import { resolveSettings, SentryProject, Settings } from './settings'
 
 /**
  * Params derived from the document's URI.
@@ -27,9 +27,19 @@ const SENTRYORGANIZATION = SETTINGSCONFIG['sentry.organization']
  * are set in the sentry extension settings.
  */
 const COMMON_ERRORLOG_PATTERNS = [
+    // typescript/javascript
     /throw new Error+\(['"]([^'"]+)['"]\)/gi,
     /console\.(error|info|warn)\(['"`]([^'"`]+)['"`]\)/gi,
+    // go
     /log\.(Printf|Print|Println)\(['"]([^'"]+)['"]\)/gi,
+    /fmt\.Errorf\(['"]([^'"]+)['"]\)/gi,
+    /errors\.New\(['"]([^'"]+)['"]\)/gi,
+    /err\.message\(['"`]([^'"`]+)['"`]\)/gi,
+    /panic\(['"]([^'"]+)['"]\)/gi,
+    // python
+    /raise (TypeError|ValueError)\(['"`]([^'"`]+)['"`]\)/gi,
+    // java
+    /logger\.(debug|error)\(['"`]([^'"`]+)['"`]\);/gi,
 ]
 
 export function activate(context: sourcegraph.ExtensionContext): void {
@@ -43,23 +53,30 @@ export function activate(context: sourcegraph.ExtensionContext): void {
         context.subscriptions.add(
             activeEditor.subscribe(editor => {
                 const sentryProjects = SETTINGSCONFIG['sentry.projects']
-                const decorations = getDecorations(editor, sentryProjects)
-                editor.setDecorations(DECORATION_TYPE, decorations)
+                if (editor.document.text) {
+                    const decorations = getDecorations(editor.document.uri, editor.document.text, sentryProjects)
+                    if (decorations.length === 0) {
+                        return
+                    }
+                    editor.setDecorations(DECORATION_TYPE, decorations)
+                }
             })
         )
     }
 }
 
 /**
  * Get and varify the necessary uri and config data and build the decorations.
- * @param editor
- * @param sentryProjects
+ * @param documentUri the current document's URI
+ * @param documentText content of the document being scanned for error handling code
+ * @param sentryProjects list of Sentry projects sourced from the user's Sentry extension configurations
  */
 export function getDecorations(
-    editor: sourcegraph.CodeEditor,
-    sentryProjects: Settings['sentry.projects']
+    documentUri: string,
+    documentText: string,
+    sentryProjects?: SentryProject[]
 ): sourcegraph.TextDocumentDecoration[] {
-    const params: Params = getParamsFromUriPath(editor.document.uri)
+    const params: Params = getParamsFromUriPath(documentUri)
     const sentryProject = sentryProjects && matchSentryProject(params, sentryProjects)
     let missingConfigData: string[] = []
     let fileMatched: boolean | null
@@ -75,39 +92,43 @@ export function getDecorations(
         }
 
         return decorateEditor(
-            editor,
             missingConfigData,
+            documentText,
             sentryProject.projectId,
             sentryProject.patternProperties.lineMatches
         )
     }
-    return decorateEditor(editor, missingConfigData)
+    return decorateEditor(missingConfigData, documentText)
 }
 
 /**
  * Build decorations by matching error handling code with either user config or common error patterns.
- * @param editor
- * @param missingConfigData
- * @param sentryProjectId
- * @param lineMatches
+ * @param missingConfigData list of missing configs that will appear as a hover warning on the Sentry link
+ * @param documentText content of the document being scanned for error handling code
+ * @param sentryProjectId Sentry project id retrieved from Sentry extension settings
+ * @param lineMatches line patching patterns set in the user's Sentry extension configurations
+ * @return a list of decorations to render as links on each matching line
  */
 // TODO: add tests for that new function (kind of like getBlameDecorations())
-function decorateEditor(
-    editor: sourcegraph.CodeEditor,
+export function decorateEditor(
     missingConfigData: string[],
+    documentText: string,
     sentryProjectId?: string,
     lineMatches?: RegExp[]
 ): sourcegraph.TextDocumentDecoration[] {
     const decorations: sourcegraph.TextDocumentDecoration[] = []
-
-    for (const [index, line] of editor.document.text!.split('\n').entries()) {
+    for (const [index, line] of documentText.split('\n').entries()) {
         let match: RegExpExecArray | null
-        for (let pattern of lineMatches ? lineMatches : COMMON_ERRORLOG_PATTERNS) {
+        for (let pattern of lineMatches && lineMatches.length > 0 ? lineMatches : COMMON_ERRORLOG_PATTERNS) {
             pattern = new RegExp(pattern, 'gi')
             do {
                 match = pattern.exec(line)
-                if (match) {
-                    decorations.push(decorateLine(index, match, missingConfigData, sentryProjectId))
+                // Depending on the line matching pattern the query m is indexed in position 1 or 2.
+                // TODO: Specify which capture group should be used through configuration.
+                if (match && match.length <= 2) {
+                    decorations.push(decorateLine(index, match[1], missingConfigData, sentryProjectId))
+                } else if (match && match.length > 2) {
+                    decorations.push(decorateLine(index, match[2], missingConfigData, sentryProjectId))
                 }
             } while (match)
             pattern.lastIndex = 0 // reset
@@ -121,11 +142,13 @@ function decorateEditor(
  * or that matches common error loggin patterns.
  * @param index for decoration range
  * @param match for a line containing an error query
+ * @param missingConfigData list of missing configs that will appear as a hover warning on the Sentry link
  * @param sentryProjectId Sentry project id retrieved from Sentry extension settings
+ * @return either a successful or a warning decoration to render the Sentry link
  */
 export function decorateLine(
     index: number,
-    match: RegExpExecArray,
+    match: string,
     missingConfigData: string[],
     sentryProjectId?: string
 ): sourcegraph.TextDocumentDecoration {
@@ -134,19 +157,17 @@ export function decorateLine(
         range: new sourcegraph.Range(index, 0, index, 0),
         isWholeLine: true,
         after: {
-            backgroundColor: missingConfigData.length === 0 ? '#e03e2f' : '#f2736d',
+            backgroundColor: missingConfigData.length === 0 && sentryProjectId ? '#e03e2f' : '#f2736d',
             color: 'rgba(255, 255, 255, 0.8)',
             contentText: lineDecorationText.content,
             hoverMessage: lineDecorationText.hover,
-            // Depending on the line matching pattern the query m is indexed in position 1 or 2.
-            // TODO: Specify which capture group should be used through configuration.
             // TODO: If !SENTRYORGANIZATION is missing in config, link to $USER/settings and hint
             // user to fill it out.
             linkURL: !SENTRYORGANIZATION
                 ? ''
                 : sentryProjectId
-                ? buildUrl(match.length > 2 ? match[2] : match[1], sentryProjectId).toString()
-                : buildUrl(match.length > 2 ? match[2] : match[1]).toString(),
+                ? buildUrl(match, sentryProjectId).toString()
+                : buildUrl(match).toString(),
         },
     }
     return decoration

Diff for: src/handler.ts

@@ -49,7 +49,13 @@ export function matchSentryProject(params: Params, projects: SentryProject[]): S
     // TODO: Handle the null case instead of using a non-null assertion !
     // TODO: Handle cases where the wrong project is matched due to similar repo name,
     // e.g. `sourcegraph-jetbrains` repo will match the `sourcegraph` project
-    const project = projects.find(p => !!new RegExp(p.patternProperties.repoMatch).exec(params.repo!))
+
+    const project = projects.find(p =>
+        p.patternProperties.repoMatch
+            ? !!p.patternProperties.repoMatch.find(repo => !!new RegExp(repo).exec(params.repo!))
+            : false
+    )
+
     if (!project) {
         return undefined
     }
@@ -74,11 +80,10 @@ export function checkMissingConfig(settings: SentryProject): string[] {
         return []
     }
     const missingConfig: string[] = []
-
     for (const [key, value] of Object.entries(settings)) {
         if (value instanceof Object) {
             for (const [k, v] of Object.entries(value)) {
-                if (!v || Object.keys(v).length === 0) {
+                if (!v || (v instanceof Object && Object.keys(v).length === 0)) {
                     missingConfig.push(k)
                 }
             }
@@ -107,7 +112,8 @@ export function createDecoration(
     } else if (missingConfigData.length > 0) {
         contentText = ' View logs in Sentry (❕)» '
         hoverText =
-            ' Please fill out the following configurations in your Sentry extension settings: ' + missingConfigData
+            ' Please fill out the following configurations in your Sentry extension settings: ' +
+            missingConfigData.join(', ')
     }
     return {
         content: contentText,

Diff for: src/settings.ts

@@ -13,7 +13,7 @@ export interface SentryProject {
     name: string
     projectId: string
     patternProperties: {
-        repoMatch: RegExp
+        repoMatch?: RegExp[]
         fileMatches: RegExp[]
         // RexExp patterns to match log handeling code, e.g. /log\.(Printf|Print)\(['"]([^'"]+)['"]\)/
         lineMatches: RegExp[]