chore: add a diagnostic when there is no auth token (#12)

Author: owenrumney

internal/lsp/diagnostics.go

@@ -170,6 +170,42 @@ func tagViolationToDiagnostics(v scanner.TagViolation) []lsp.Diagnostic {
 	return diags
 }
 
+// publishAuthDiagnostic sends a single info diagnostic to the given file
+// indicating that the user needs to authenticate.
+func (s *Server) publishAuthDiagnostic(uri string) {
+	if s.client == nil {
+		return
+	}
+
+	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
+	defer cancel()
+
+	s.mu.Lock()
+	if s.filesWithDiagnostics == nil {
+		s.filesWithDiagnostics = make(map[string]struct{})
+	}
+	s.filesWithDiagnostics[uri] = struct{}{}
+	s.mu.Unlock()
+
+	severity := lsp.SeverityInformation
+	if err := s.client.PublishDiagnostics(ctx, &lsp.PublishDiagnosticsParams{
+		URI: lsp.DocumentURI(uri),
+		Diagnostics: []lsp.Diagnostic{
+			{
+				Range: lsp.Range{
+					Start: lsp.Position{Line: 0, Character: 0},
+					End:   lsp.Position{Line: 0, Character: 0},
+				},
+				Severity: &severity,
+				Source:   "infracost",
+				Message:  "Infracost: not authenticated. Run `infracost login` to enable cost analysis and FinOps policies.",
+			},
+		},
+	}); err != nil {
+		slog.Warn("publishAuthDiagnostic: failed", "uri", uri, "error", err)
+	}
+}
+
 // isLocalFile returns true if the path exists on disk as a regular file.
 // This filters out violations from remote modules (e.g. github.com/...) whose
 // filenames resolve to non-existent paths.

internal/lsp/server.go

@@ -263,6 +263,11 @@ func (s *Server) DidOpen(_ context.Context, params *lsp.DidOpenTextDocumentParam
 	if !isSupportedFile(uri) {
 		return nil
 	}
+
+	if !s.scanner.HasTokenSource() {
+		s.publishAuthDiagnostic(uri)
+	}
+
 	s.scheduleAnalyze(uri)
 	return nil
 }

internal/scanner/html_test.go

@@ -0,0 +1,58 @@
+package scanner
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestHtmlToMarkdown(t *testing.T) {
+	tests := []struct {
+		name string
+		in   string
+		want string
+	}{
+		{
+			name: "simple anchor tag",
+			in:   `<a href="https://example.com">link text</a>`,
+			want: "[link text](https://example.com)",
+		},
+		{
+			name: "anchor with target blank",
+			in:   `<a href="https://example.com" target="_blank">link</a>`,
+			want: "[link](https://example.com)",
+		},
+		{
+			name: "multiple anchors",
+			in:   `See <a href="https://one.com">first</a> and <a href="https://two.com">second</a>.`,
+			want: "See [first](https://one.com) and [second](https://two.com).",
+		},
+		{
+			name: "non-anchor HTML tags stripped",
+			in:   `Hello<br>world<div>content</div>`,
+			want: "Helloworldcontent",
+		},
+		{
+			name: "no HTML passes through unchanged",
+			in:   "plain text with no tags",
+			want: "plain text with no tags",
+		},
+		{
+			name: "mixed anchors and other HTML",
+			in:   `<b>Bold</b> and <a href="https://example.com">link</a><br>done`,
+			want: "**Bold** and [link](https://example.com)done",
+		},
+		{
+			name: "Italic tags",
+			in:   `This is <i>italic</i> and <em>emphasized</em>.`,
+			want: "This is _italic_ and _emphasized_.",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got := htmlToMarkdown(tt.in)
+			assert.Equal(t, tt.want, got)
+		})
+	}
+}

internal/scanner/scanner.go

@@ -927,16 +927,29 @@ func envToMap() map[string]string {
 	return env
 }
 
+type regexReplacement struct {
+	re  *regexp.Regexp
+	rep string
+}
+
 var (
-	reAnchor  = regexp.MustCompile(`<a\s+[^>]*href=["']([^"']*)["'][^>]*>(.*?)</a>`)
+	replaceRegexes = []regexReplacement{
+		{regexp.MustCompile(`<a\s+[^>]*href=["']([^"']*)["'][^>]*>(.*?)</a>`), "[$2]($1)"},
+		{regexp.MustCompile(`<b>(.*?)</b>`), "**${1}**"},
+		{regexp.MustCompile(`<strong>(.*?)</strong>`), "**${1}**"},
+		{regexp.MustCompile(`<i>(.*?)</i>`), "_${1}_"},
+		{regexp.MustCompile(`<em>(.*?)</em>`), "_${1}_"},
+	}
 	reHTMLTag = regexp.MustCompile(`<[^>]+>`)
 )
 
 // htmlToMarkdown converts HTML anchor tags to markdown links and strips
 // remaining HTML tags so the output renders cleanly in editors that only
 // support markdown (e.g. Zed, Neovim).
 func htmlToMarkdown(s string) string {
-	s = reAnchor.ReplaceAllString(s, "[$2]($1)")
+	for _, rr := range replaceRegexes {
+		s = rr.re.ReplaceAllString(s, rr.rep)
+	}
 	return reHTMLTag.ReplaceAllString(s, "")
 }
 

internal/scanner/violations_test.go

@@ -246,6 +246,24 @@ func TestBuildViolationMarkdown(t *testing.T) {
 			},
 			excludes: []string{"Downgrade"},
 		},
+		{
+			name: "HTML in policy detail converted to markdown",
+			v: FinopsViolation{
+				PolicyName: "GP3 migration",
+				PolicySlug: "gp3-migration",
+				Address:    "aws_ebs_volume.data",
+				Message:    `Migrate to <a href="https://docs.aws.amazon.com/ebs/latest/userguide/gp3.html">gp3</a>`,
+				PolicyDetail: &dashboard.PolicyDetail{
+					ShortTitle:        "Migrate EBS to GP3",
+					AdditionalDetails: `See <a href="https://infracost.io/docs">docs</a> for more info.<br>Contact support if needed.`,
+				},
+			},
+			contains: []string{
+				"[gp3](https://docs.aws.amazon.com/ebs/latest/userguide/gp3.html)",
+				"[docs](https://infracost.io/docs) for more info.",
+			},
+			excludes: []string{"<a ", "</a>", "<br>"},
+		},
 	}
 
 	for _, tt := range tests {