Skip to content

Commit

Permalink
Fixes for Attachments
Browse files Browse the repository at this point in the history
  • Loading branch information
nyarly committed Sep 8, 2023
1 parent f0aeb9b commit 54e8947
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 11 deletions.
4 changes: 4 additions & 0 deletions pkg/mark/attachment/attachment.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ type Attachment struct {
Replace string
}

type Attacher interface {
Attach(Attachment)
}

func ResolveAttachments(
api *confluence.API,
page *confluence.PageInfo,
Expand Down
8 changes: 6 additions & 2 deletions pkg/mark/markdown.go
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,20 @@ func NewConfluenceExtension(stdlib *stdlib.Lib, path string, mermaidProvider str
}
}

func (c *ConfluenceExtension) Attach(a attachment.Attachment) {
c.Attachments = append(c.Attachments, a)
}

func (c *ConfluenceExtension) Extend(m goldmark.Markdown) {

m.Renderer().AddOptions(renderer.WithNodeRenderers(
util.Prioritized(crenderer.NewConfluenceTextRenderer(c.StripNewlines), 100),
util.Prioritized(crenderer.NewConfluenceBlockQuoteRenderer(), 100),
util.Prioritized(crenderer.NewConfluenceCodeBlockRenderer(c.Stdlib, c.Path), 100),
util.Prioritized(crenderer.NewConfluenceFencedCodeBlockRenderer(c.Stdlib, &c.Attachments, c.MermaidProvider, c.MermaidScale), 100),
util.Prioritized(crenderer.NewConfluenceFencedCodeBlockRenderer(c.Stdlib, c, c.MermaidProvider, c.MermaidScale), 100),
util.Prioritized(crenderer.NewConfluenceHTMLBlockRenderer(c.Stdlib), 100),
util.Prioritized(crenderer.NewConfluenceHeadingRenderer(c.DropFirstH1), 100),
util.Prioritized(crenderer.NewConfluenceImageRenderer(c.Stdlib, &c.Attachments, c.Path), 100),
util.Prioritized(crenderer.NewConfluenceImageRenderer(c.Stdlib, c, c.Path), 100),
util.Prioritized(crenderer.NewConfluenceLinkRenderer(), 100),
))

Expand Down
6 changes: 5 additions & 1 deletion pkg/mark/mermaid/mermaid.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,30 @@ import (

mermaid "github.com/dreampuf/mermaid.go"
"github.com/kovetskiy/mark/pkg/mark/attachment"
"github.com/reconquest/pkg/log"
)

var renderTimeout = 60 * time.Second

func ProcessMermaidLocally(title string, mermaidDiagram []byte, scale float64) (attachement attachment.Attachment, err error) {
func ProcessMermaidLocally(title string, mermaidDiagram []byte, scale float64) (attachment.Attachment, error) {
ctx, cancel := context.WithTimeout(context.TODO(), renderTimeout)
defer cancel()

log.Debugf(nil, "Setting up Mermaid renderer: %q", title)
renderer, err := mermaid.NewRenderEngine(ctx)

if err != nil {
return attachment.Attachment{}, err
}

log.Debugf(nil, "Rendering: %q", title)
pngBytes, boxModel, err := renderer.RenderAsScaledPng(string(mermaidDiagram), scale)
if err != nil {
return attachment.Attachment{}, err
}

checkSum, err := attachment.GetChecksum(bytes.NewReader(mermaidDiagram))
log.Debugf(nil, "Checksum: %q -> %s", title, checkSum)

if err != nil {
return attachment.Attachment{}, err
Expand Down
10 changes: 6 additions & 4 deletions pkg/mark/renderer/fencedcodeblock.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"github.com/kovetskiy/mark/pkg/mark/attachment"
"github.com/kovetskiy/mark/pkg/mark/mermaid"
"github.com/kovetskiy/mark/pkg/mark/stdlib"
"github.com/reconquest/pkg/log"

"github.com/yuin/goldmark/ast"
"github.com/yuin/goldmark/renderer"
Expand All @@ -20,7 +21,7 @@ type ConfluenceFencedCodeBlockRenderer struct {
Stdlib *stdlib.Lib
MermaidProvider string
MermaidScale float64
Attachments []attachment.Attachment
Attachments attachment.Attacher
}

var reBlockDetails = regexp.MustCompile(
Expand All @@ -30,13 +31,13 @@ var reBlockDetails = regexp.MustCompile(
)

// NewConfluenceRenderer creates a new instance of the ConfluenceRenderer
func NewConfluenceFencedCodeBlockRenderer(stdlib *stdlib.Lib, attachments *[]attachment.Attachment, mermaidProvider string, mermaidScale float64, opts ...html.Option) renderer.NodeRenderer {
func NewConfluenceFencedCodeBlockRenderer(stdlib *stdlib.Lib, attachments attachment.Attacher, mermaidProvider string, mermaidScale float64, opts ...html.Option) renderer.NodeRenderer {
return &ConfluenceFencedCodeBlockRenderer{
Config: html.NewConfig(),
Stdlib: stdlib,
MermaidProvider: mermaidProvider,
MermaidScale: mermaidScale,
Attachments: *attachments,
Attachments: attachments,
}
}

Expand Down Expand Up @@ -128,9 +129,10 @@ func (r *ConfluenceFencedCodeBlockRenderer) renderFencedCodeBlock(writer util.Bu
if lang == "mermaid" && r.MermaidProvider == "mermaid-go" {
attachment, err := mermaid.ProcessMermaidLocally(title, lval, r.MermaidScale)
if err != nil {
log.Debugf(nil, "error: %v", err)
return ast.WalkStop, err
}
r.Attachments = append(r.Attachments, attachment)
r.Attachments.Attach(attachment)
err = r.Stdlib.Templates.ExecuteTemplate(
writer,
"ac:image",
Expand Down
8 changes: 4 additions & 4 deletions pkg/mark/renderer/image.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,16 @@ type ConfluenceImageRenderer struct {
html.Config
Stdlib *stdlib.Lib
Path string
Attachments []attachment.Attachment
Attachments attachment.Attacher
}

// NewConfluenceRenderer creates a new instance of the ConfluenceRenderer
func NewConfluenceImageRenderer(stdlib *stdlib.Lib, attachments *[]attachment.Attachment, path string, opts ...html.Option) renderer.NodeRenderer {
func NewConfluenceImageRenderer(stdlib *stdlib.Lib, attachments attachment.Attacher, path string, opts ...html.Option) renderer.NodeRenderer {
return &ConfluenceImageRenderer{
Config: html.NewConfig(),
Stdlib: stdlib,
Path: path,
Attachments: *attachments,
Attachments: attachments,
}
}

Expand Down Expand Up @@ -72,7 +72,7 @@ func (r *ConfluenceImageRenderer) renderImage(writer util.BufWriter, source []by
)
} else {

r.Attachments = append(r.Attachments, attachments[0])
r.Attachments.Attach(attachments[0])

err = r.Stdlib.Templates.ExecuteTemplate(
writer,
Expand Down

0 comments on commit 54e8947

Please sign in to comment.