Skip to content

feat: replace btoa with toBase64Url for encoding in drawMermaidImage #9505

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −10
Open

feat: replace btoa with toBase64Url for encoding in drawMermaidImage #9505

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions libs/langchain-core/src/runnables/graph_mermaid.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { Edge, Node } from "./types.js";
import { toBase64Url } from "./utils.js";

function _escapeNodeLabel(nodeLabel: string): string {
// Escapes the node label for Mermaid syntax.
Expand Down Expand Up @@ -201,8 +202,8 @@ export async function drawMermaidImage(
let backgroundColor = config?.backgroundColor ?? "white";
const imageType = config?.imageType ?? "png";

// Use btoa for compatibility, assume ASCII
const mermaidSyntaxEncoded = btoa(mermaidSyntax);
const mermaidSyntaxEncoded = toBase64Url(mermaidSyntax);

// Check if the background color is a hexadecimal color code using regex
if (backgroundColor !== undefined) {
const hexColorPattern = /^#(?:[0-9a-fA-F]{3}){1,2}$/;
Expand Down
17 changes: 9 additions & 8 deletions libs/langchain-core/src/runnables/tests/graph_mermaid.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
type MockedFunction,
} from "vitest";
import { drawMermaidImage } from "../graph_mermaid.js";
import { toBase64Url } from "../utils.js";

// Mock global fetch
const mockFetch = vi.fn() as MockedFunction<typeof fetch>;
Expand Down Expand Up @@ -36,7 +37,7 @@ describe("drawMermaidImage", () => {
expect(mockFetch).toHaveBeenCalledTimes(1);

// Check the URL construction
const expectedEncodedSyntax = btoa(mermaidSyntax);
const expectedEncodedSyntax = toBase64Url(mermaidSyntax);
const expectedUrl = `https://mermaid.ink/img/${expectedEncodedSyntax}?bgColor=!white&type=png`;
expect(mockFetch).toHaveBeenCalledWith(expectedUrl);
});
Expand All @@ -54,7 +55,7 @@ describe("drawMermaidImage", () => {
});

expect(result).toBe(mockBlob);
const expectedEncodedSyntax = btoa(mermaidSyntax);
const expectedEncodedSyntax = toBase64Url(mermaidSyntax);
const expectedUrl = `https://mermaid.ink/img/${expectedEncodedSyntax}?bgColor=!white&type=jpeg`;
expect(mockFetch).toHaveBeenCalledWith(expectedUrl);
});
Expand All @@ -72,7 +73,7 @@ describe("drawMermaidImage", () => {
});

expect(result).toBe(mockBlob);
const expectedEncodedSyntax = btoa(mermaidSyntax);
const expectedEncodedSyntax = toBase64Url(mermaidSyntax);
const expectedUrl = `https://mermaid.ink/img/${expectedEncodedSyntax}?bgColor=!white&type=webp`;
expect(mockFetch).toHaveBeenCalledWith(expectedUrl);
});
Expand All @@ -90,7 +91,7 @@ describe("drawMermaidImage", () => {
});

expect(result).toBe(mockBlob);
const expectedEncodedSyntax = btoa(mermaidSyntax);
const expectedEncodedSyntax = toBase64Url(mermaidSyntax);
const expectedUrl = `https://mermaid.ink/img/${expectedEncodedSyntax}?bgColor=#FF5733&type=png`;
expect(mockFetch).toHaveBeenCalledWith(expectedUrl);
});
Expand All @@ -108,7 +109,7 @@ describe("drawMermaidImage", () => {
});

expect(result).toBe(mockBlob);
const expectedEncodedSyntax = btoa(mermaidSyntax);
const expectedEncodedSyntax = toBase64Url(mermaidSyntax);
const expectedUrl = `https://mermaid.ink/img/${expectedEncodedSyntax}?bgColor=#FFF&type=png`;
expect(mockFetch).toHaveBeenCalledWith(expectedUrl);
});
Expand All @@ -126,7 +127,7 @@ describe("drawMermaidImage", () => {
});

expect(result).toBe(mockBlob);
const expectedEncodedSyntax = btoa(mermaidSyntax);
const expectedEncodedSyntax = toBase64Url(mermaidSyntax);
const expectedUrl = `https://mermaid.ink/img/${expectedEncodedSyntax}?bgColor=!transparent&type=png`;
expect(mockFetch).toHaveBeenCalledWith(expectedUrl);
});
Expand Down Expand Up @@ -176,7 +177,7 @@ describe("drawMermaidImage", () => {
const result = await drawMermaidImage(complexSyntax);

expect(result).toBe(mockBlob);
const expectedEncodedSyntax = btoa(complexSyntax);
const expectedEncodedSyntax = toBase64Url(complexSyntax);
const expectedUrl = `https://mermaid.ink/img/${expectedEncodedSyntax}?bgColor=!white&type=png`;
expect(mockFetch).toHaveBeenCalledWith(expectedUrl);
});
Expand All @@ -194,7 +195,7 @@ describe("drawMermaidImage", () => {
});

expect(result).toBe(mockBlob);
const expectedEncodedSyntax = btoa(mermaidSyntax);
const expectedEncodedSyntax = toBase64Url(mermaidSyntax);
const expectedUrl = `https://mermaid.ink/img/${expectedEncodedSyntax}?bgColor=!white&type=png`;
expect(mockFetch).toHaveBeenCalledWith(expectedUrl);
});
Expand Down
6 changes: 6 additions & 0 deletions libs/langchain-core/src/runnables/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,9 @@ export class _RootEventFilter {
return include;
}
}

export const toBase64Url = (str: string): string => {
// Use btoa for compatibility, assume ASCII
const encoded = btoa(str);
return encoded.replace(/\+/g, "-").replace(/\//g, "_").replace(/=+$/, "");
};