Skip to content

🧪 [testing improvement] implement tests for RenderHTML and refactor for testability#27

Open
pablontiv wants to merge 1 commit intomasterfrom
fix-render-html-tests-improvement-11742270297916303953
Open

🧪 [testing improvement] implement tests for RenderHTML and refactor for testability#27
pablontiv wants to merge 1 commit intomasterfrom
fix-render-html-tests-improvement-11742270297916303953

Conversation

@pablontiv
Copy link
Copy Markdown
Owner

This PR improves the test coverage and reliability of the Mermaid-to-HTML rendering logic in internal/graph/html.go.

Key Changes:

  • Refactored RenderHTML into two functions:
    • RenderHTMLContent(mermaidContent string) (string, error): A pure function that renders the HTML string from the embedded template.
    • RenderHTML(mermaidContent string) (string, error): A wrapper that calls RenderHTMLContent and handles temporary file creation and writing.
  • Introduced a mockable osCreateTemp variable to enable testing of file system error paths.
  • Added a comprehensive table-driven test suite in internal/graph/html_test.go covering:
    • Standard Mermaid graphs.
    • Empty content scenarios.
    • Handling of HTML-like characters in Mermaid content.
    • Error handling when temporary file creation fails.
  • Added necessary imports (strings, errors) and verified the implementation in an isolated environment.

These changes increase the overall reliability of the graph visualization feature and provide a cleaner architecture for future enhancements.


PR created automatically by Jules for task 11742270297916303953 started by @pablontiv

…estability

Refactors `RenderHTML` into a pure content generation function `RenderHTMLContent` and a wrapper that handles file I/O.
Adds comprehensive table-driven tests for HTML generation and error path coverage for temporary file creation.
Improves testability by making `os.CreateTemp` mockable.

🎯 **What:** The testing gap addressed for `RenderHTML` in `internal/graph/html.go`.
📊 **Coverage:** Happy paths (various Mermaid inputs), edge cases (empty input), and error paths (file system failure) are now tested.
✨ **Result:** Improved test reliability and code modularity.
@google-labs-jules
Copy link
Copy Markdown

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 7e3cfe6cf8

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread internal/graph/html.go
}

tmpl, err := template.New("graph").Parse(string(tmplData))
html, err := RenderHTMLContent(mermaidContent)
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Stream rendered template directly to file

Rendering now materializes the entire HTML document in memory (RenderHTMLContent) before writing it, which introduces an extra full-size allocation of the output and removes the previous streaming behavior (tmpl.Execute directly to the file). For large dependency graphs, rootline graph --open can now hit significantly higher peak memory and fail (OOM) in cases that previously succeeded, even though the final artifact is still just a temp file.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant