Skip to content

feat: support document edit URL in documentUnfurler #3

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
lollipop-onl wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: support document edit URL in documentUnfurler #3

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
76 changes: 61 additions & 15 deletions src/entrypoints/content/unfurlers.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,79 @@
import { beforeEach, describe, expect, it, vi } from "vitest";

const { mockReplaceUrlInTextNodes } = vi.hoisted(() => ({
const { mockReplaceUrlInTextNodes, mockClient } = vi.hoisted(() => ({
mockReplaceUrlInTextNodes: vi.fn(),
mockClient: vi
.fn()
.mockResolvedValue({ name: "TestSpace", spaceKey: "test" }),
}));

vi.mock("./fetch", () => ({
client: vi.fn().mockResolvedValue({ name: "TestSpace", spaceKey: "test" }),
client: mockClient,
}));

vi.mock("./replaceUrlInTextNodes", () => ({
replaceUrlInTextNodes: mockReplaceUrlInTextNodes,
}));

import { gitCommitUnfurler, gitFileUnfurler } from "./unfurlers";
import {
documentUnfurler,
gitCommitUnfurler,
gitFileUnfurler,
} from "./unfurlers";

describe("gitFileUnfurler", () => {
const createAnchor = (href: string) => {
const anchor = document.createElement("a");
anchor.href = href;
return anchor;
};

describe("documentUnfurler", () => {
beforeEach(() => {
mockReplaceUrlInTextNodes.mockClear();
mockClient.mockReset();
mockClient.mockImplementation((_hostname: string, path: string) => {
if (path === "/api/v2/space") {
return Promise.resolve({ name: "TestSpace", spaceKey: "test" });
}
if (path.startsWith("/api/v2/documents/")) {
return Promise.resolve({
projectId: 1,
title: "Design Document",
});
}
return Promise.resolve({});
});
});

it("should build title for view URL", async () => {
const anchor = createAnchor(
"https://nulab.backlog.jp/document/PROJ/abcdef01234567890abcdef012345678",
);
await documentUnfurler(anchor);
expect(mockReplaceUrlInTextNodes).toHaveBeenCalledWith(
anchor,
"[TestSpace][PROJ] Design Document | Document",
);
});

it("should build title with Edit prefix for edit URL", async () => {
const anchor = createAnchor(
"https://nulab.backlog.jp/document/PROJ/e/abcdef01234567890abcdef012345678",
);
await documentUnfurler(anchor);
expect(mockReplaceUrlInTextNodes).toHaveBeenCalledWith(
anchor,
"[TestSpace][PROJ] Edit Design Document | Document",
);
});
});

const createAnchor = (href: string) => {
const anchor = document.createElement("a");
anchor.href = href;
return anchor;
};
describe("gitFileUnfurler", () => {
beforeEach(() => {
mockReplaceUrlInTextNodes.mockClear();
mockClient.mockReset();
mockClient.mockResolvedValue({ name: "TestSpace", spaceKey: "test" });
});

it("should build title for blob URL with filename", async () => {
const anchor = createAnchor(
Expand Down Expand Up @@ -76,14 +126,10 @@ describe("gitFileUnfurler", () => {
describe("gitCommitUnfurler", () => {
beforeEach(() => {
mockReplaceUrlInTextNodes.mockClear();
mockClient.mockReset();
mockClient.mockResolvedValue({ name: "TestSpace", spaceKey: "test" });
});

const createAnchor = (href: string) => {
const anchor = document.createElement("a");
anchor.href = href;
return anchor;
};

it("should build title with truncated commit hash", async () => {
const anchor = createAnchor(
"https://nulab.backlog.jp/git/NAKAMURA/hackz-nulab-26/commit/d883cf51748ad8d4d864d1143657a10a27f73e17",
Expand Down
19 changes: 9 additions & 10 deletions src/entrypoints/content/unfurlers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,17 +90,16 @@ export const wikiWithTitleUnfurler = defineUnfurler({

export const documentUnfurler = defineUnfurler({
parseUrl: (url) =>
regex(`^/document/${PROJECT_KEY_REGEX}/${DOCUMENT_ID_REGEX}$`).exec(
url.pathname,
)?.groups,
regex(
`^/document/${PROJECT_KEY_REGEX}/(?<edit>e/)?${DOCUMENT_ID_REGEX}$`,
).exec(url.pathname)?.groups,
buildTitle: async (params, url) => {
const [document] = await Promise.all([
client<BacklogDocument>(
url.hostname,
joinURL("/api/v2/documents", params.documentId),
),
]);
return `[${params.projectKey}] ${document.title} | Document`;
const document = await client<BacklogDocument>(
url.hostname,
joinURL("/api/v2/documents", params.documentId),
);
const prefix = params.edit ? "Edit " : "";
return `[${params.projectKey}] ${prefix}${document.title} | Document`;
},
});

Expand Down