beardrive/internal/webapp/markdown_test.go

package webapp

import (
	"strings"
	"testing"
)

// A leading YAML frontmatter block renders as a key/value table (author
// key order, escaped values) instead of goldmark's thematic-break soup;
// everything that isn't a clean frontmatter mapping renders exactly as
// before.
func TestRenderMarkdownFrontmatter(t *testing.T) {
	src := `---
title: Q3 findings
tags: [churn, revenue]
owner: snow@runbear.io
meta:
  reviewed: true
---

# Body

Hello.`
	out, err := RenderMarkdown([]byte(src))
	if err != nil {
		t.Fatal(err)
	}
	for _, want := range []string{
		`<table class="frontmatter">`,
		`<th scope="row">title</th><td>Q3 findings</td>`,
		`<td>churn, revenue</td>`, // flat lists comma-join
		`owner`, `snow@runbear.io`,
		`<code>reviewed: true</code>`, // nested values as compact YAML
		`<h1 id="body">Body</h1>`,     // the body still renders
	} {
		if !strings.Contains(out, want) {
			t.Errorf("missing %q in:\n%s", want, out)
		}
	}
	if strings.Contains(out, "<hr") {
		t.Errorf("frontmatter fences leaked as thematic breaks:\n%s", out)
	}
	// Key order preserved: title row precedes owner row.
	if strings.Index(out, ">title<") > strings.Index(out, ">owner<") {
		t.Errorf("frontmatter keys reordered:\n%s", out)
	}
}

func TestRenderMarkdownFrontmatterEscapes(t *testing.T) {
	out, err := RenderMarkdown([]byte("---\nnote: <script>alert(1)</script>\n---\nx"))
	if err != nil {
		t.Fatal(err)
	}
	if strings.Contains(out, "<script>") {
		t.Fatalf("frontmatter value not escaped:\n%s", out)
	}
	if !strings.Contains(out, "&lt;script&gt;") {
		t.Fatalf("escaped value missing:\n%s", out)
	}
}

func TestRenderMarkdownFrontmatterFallthrough(t *testing.T) {
	cases := map[string]struct {
		src       string
		wantTable bool
		want      string
	}{
		"no frontmatter":           {"# Hi\n\ntext", false, "<h1"},
		"mid-doc fences":           {"para\n\n---\n\nmore", false, "<hr"},
		"unclosed fence":           {"---\ntitle: x\n\nbody", false, ""},
		"non-mapping yaml":         {"---\n- just\n- a list\n---\nbody", false, ""},
		"invalid yaml":             {"---\n: : :\n---\nbody", false, ""},
		"empty frontmatter hidden": {"---\n---\nbody", false, "<p>body</p>"},
	}
	for name, c := range cases {
		out, err := RenderMarkdown([]byte(c.src))
		if err != nil {
			t.Fatalf("%s: %v", name, err)
		}
		if got := strings.Contains(out, `class="frontmatter"`); got != c.wantTable {
			t.Errorf("%s: table presence = %v, want %v\n%s", name, got, c.wantTable, out)
		}
		if c.want != "" && !strings.Contains(out, c.want) {
			t.Errorf("%s: missing %q in:\n%s", name, c.want, out)
		}
	}
}

// The viewer's split: frontmatter comes back as ordered data and the HTML
// is body-only, with the same value rules the table has always applied.
func TestFrontmatterPairs(t *testing.T) {
	src := `---
title: Q3 findings
tags: [churn, revenue]
owner: snow@runbear.io
meta:
  reviewed: true
---

# Body

Hello.`
	pairs, out, err := RenderMarkdownPairs([]byte(src))
	if err != nil {
		t.Fatal(err)
	}
	want := []FrontmatterPair{
		{Key: "title", Value: "Q3 findings"},
		{Key: "tags", Value: "churn, revenue"}, // flat lists comma-join
		{Key: "owner", Value: "snow@runbear.io"},
		{Key: "meta", Value: "reviewed: true", Code: true}, // nested: compact YAML
	}
	if len(pairs) != len(want) {
		t.Fatalf("pairs = %+v, want %d", pairs, len(want))
	}
	for i, w := range want {
		if pairs[i] != w { // index-wise: author order is the contract
			t.Errorf("pair %d = %+v, want %+v", i, pairs[i], w)
		}
	}
	if strings.Contains(out, `class="frontmatter"`) {
		t.Errorf("table leaked into the viewer's html:\n%s", out)
	}
	if !strings.HasPrefix(strings.TrimSpace(out), `<h1 id="body">Body</h1>`) {
		t.Errorf("body does not start with its heading:\n%s", out)
	}
}

// Same tri-state as the table: anything that isn't a clean YAML mapping
// falls through with the source untouched, and empty frontmatter is hidden.
func TestFrontmatterPairsFallthrough(t *testing.T) {
	cases := map[string]struct {
		src  string
		want string
	}{
		"no frontmatter":           {"# Hi\n\ntext", "<h1"},
		"mid-doc fences":           {"para\n\n---\n\nmore", "<hr"},
		"unclosed fence":           {"---\ntitle: x\n\nbody", ""},
		"non-mapping yaml":         {"---\n- just\n- a list\n---\nbody", ""},
		"invalid yaml":             {"---\n: : :\n---\nbody", ""},
		"empty frontmatter hidden": {"---\n---\nbody", "<p>body</p>"},
	}
	for name, c := range cases {
		pairs, out, err := RenderMarkdownPairs([]byte(c.src))
		if err != nil {
			t.Fatalf("%s: %v", name, err)
		}
		if len(pairs) != 0 {
			t.Errorf("%s: pairs = %+v, want none", name, pairs)
		}
		if c.want != "" && !strings.Contains(out, c.want) {
			t.Errorf("%s: missing %q in:\n%s", name, c.want, out)
		}
	}
}