Feat: Add /graph and /graph/image endpoints

[Its4Nik]

Added these endpoints:

• /graph: has a cached html file with will get responded
• /graph/image: Responds with a png image created using puppeteer, this endpoint can be embed on GitHub for example.

Summary by Sourcery

Add /graph and /graph/image endpoints. The /graph endpoint serves a cached HTML file containing a dependency graph, while /graph/image serves a PNG image of the same graph, suitable for embedding in platforms like GitHub.

New Features:

• Added two new endpoints, /graph and /graph/image, for visualizing container dependencies as an HTML file and a PNG image, respectively.

ToDo:

• Add tests for the new endpoints and associated functionality. Since we cant test if the image looks identical (not easy atleast) there will be no tests!

[github-advanced-security]

CodeQL found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces two new endpoints related to dependency graphs: /graph and /graph/image. The /graph endpoint serves a cached HTML file containing the dependency graph, while /graph/image responds with a PNG image of the graph generated using Puppeteer. This image can be embedded in platforms like GitHub.

Sequence diagram for the new graph endpoints

sequenceDiagram
    participant Client
    participant GraphEndpoint as /graph
    participant GraphImageEndpoint as /graph/image
    participant GraphHandler
    participant Puppeteer
    participant FileSystem

    alt Request HTML Graph
        Client->>GraphEndpoint: GET /graph
        GraphEndpoint->>FileSystem: Read cached HTML
        FileSystem-->>GraphEndpoint: Return HTML file
        GraphEndpoint-->>Client: Serve HTML graph
    else Request PNG Graph
        Client->>GraphImageEndpoint: GET /graph/image
        GraphImageEndpoint->>GraphHandler: Generate graph image
        GraphHandler->>Puppeteer: Create browser instance
        Puppeteer->>Puppeteer: Render HTML content
        Puppeteer->>Puppeteer: Take screenshot
        Puppeteer-->>GraphHandler: Return PNG image
        GraphHandler-->>GraphImageEndpoint: Return image
        GraphImageEndpoint-->>Client: Serve PNG image
    end

Loading

Class diagram for graph-related components

classDiagram
    class GraphHandler {
        -generateGraphFiles(allContainerData)
        -getGraphFilePaths()
        -renderGraphToImage(htmlContent, outputPath)
    }

    class Puppeteer {
        +launch()
        +createPage()
        +setContent()
        +screenshot()
    }

    class FileSystem {
        +writeFile()
        +readFile()
    }

    GraphHandler --> Puppeteer: uses
    GraphHandler --> FileSystem: uses

Loading

Flow diagram for graph generation process

graph TD
    A[Start Graph Generation] --> B[Load Container Data]
    B --> C[Generate Graph Elements]
    C --> D[Create HTML Content]
    D --> E{Cache Files}
    E --> F[Cache JSON Data]
    E --> G[Cache HTML File]
    E --> H[Generate PNG Image]
    H --> I[Use Puppeteer]
    I --> J[Render HTML]
    J --> K[Take Screenshot]
    K --> L[Save PNG File]
    L --> M[End Graph Generation]

Loading

File-Level Changes

Change	Details	Files
Added new endpoints for serving dependency graph	Implemented /graph endpoint to serve cached HTML of dependency graph Implemented /graph/image endpoint to serve PNG image of the graph Updated documentation to include new endpoints Added Puppeteer for graph image generation Implemented graph generation logic using Cytoscape	README.md package.json src/config/swagger.yaml src/handlers/graph.ts src/routes/graphs/routes.ts

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[Its4Nik]

Could use refactoring, won't do it in this branch tho