Skip to content

ENG-1858 Materialize Obsidian-origin markdown into Roam #1224

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

Draft
sid597 wants to merge 1 commit into
base: eng-1856-store-source-identity-metadata-for-roam-imported-nodes-v2
Choose a base branch
from
Draft

ENG-1858 Materialize Obsidian-origin markdown into Roam #1224

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
4 changes: 2 additions & 2 deletions apps/roam/src/utils/__tests__/importedSourceIdentity.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,15 +76,15 @@ describe("imported source identity metadata", () => {
).toBeUndefined();
});

it("writes the source RID and modified time while preserving sibling metadata", () => {
it("writes the source RID and modified time while preserving sibling metadata", async () => {
propsByUid.set(PAGE_UID, {
[DISCOURSE_GRAPH_PROP_NAME]: {
"relation-migration": { relationUid: 1718000000000 },
},
"other-extension": { enabled: true },
});

writeImportedSourceIdentity({
await writeImportedSourceIdentity({
pageUid: PAGE_UID,
sourceModifiedAt: SOURCE_MODIFIED_AT,
sourceNodeRid: SOURCE_NODE_RID,
Expand Down
221 changes: 221 additions & 0 deletions apps/roam/src/utils/__tests__/materializeObsidianNode.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,221 @@
import { contentTypes } from "@repo/content-model";
import type { CrossAppNode } from "@repo/database/crossAppContracts";
import { beforeEach, describe, expect, it, vi } from "vitest";
import { materializeObsidianNode } from "~/utils/materializeObsidianNode";

const mocks = vi.hoisted(() => ({
deleteBlock: vi.fn(),
findImportedNodeUidBySourceRid: vi.fn(),
getShallowTreeByParentUid: vi.fn(),
writeImportedSourceIdentity: vi.fn(),
}));

vi.mock("roamjs-components/queries/getShallowTreeByParentUid", () => ({
default: mocks.getShallowTreeByParentUid,
}));

vi.mock("roamjs-components/writes/deleteBlock", () => ({
default: mocks.deleteBlock,
}));

vi.mock("~/utils/importedSourceIdentity", () => ({
findImportedNodeUidBySourceRid: mocks.findImportedNodeUidBySourceRid,
writeImportedSourceIdentity: mocks.writeImportedSourceIdentity,
}));

const SOURCE_NODE_RID = "orn:obsidian.note:vault-a/node-1";
const SOURCE_MODIFIED_AT = "2026-06-14T15:00:00.000Z";
const NEW_PAGE_UID = "new-page-uid";
const EXISTING_PAGE_UID = "existing-page-uid";
const MARKDOWN = "# REM sleep correlates with recall\n\nUpdated evidence.";

const node: CrossAppNode = {
localId: "node-1",
nodeType: { localId: "evidence" },
content: {
direct: { value: "EVD - REM sleep and recall" },
full: {
contentType: contentTypes.obsidianMarkdown,
value: MARKDOWN,
},
},
createdAt: new Date("2026-06-14T10:30:00.000Z"),
modifiedAt: new Date(SOURCE_MODIFIED_AT),
author: { localId: "author" },
};

const pageFromMarkdown = vi.fn();
const blockFromMarkdown = vi.fn();
const deletePage = vi.fn();
const updatePage = vi.fn();

const setRoamAlphaApi = (): void => {
(globalThis as { window: unknown }).window = {
roamAlphaAPI: {
data: {
block: { fromMarkdown: blockFromMarkdown },
page: {
delete: deletePage,
fromMarkdown: pageFromMarkdown,
update: updatePage,
},
},
util: { generateUID: () => NEW_PAGE_UID },
},
};
};

beforeEach(() => {
vi.clearAllMocks();
mocks.deleteBlock.mockResolvedValue(undefined);
mocks.getShallowTreeByParentUid.mockReturnValue([]);
pageFromMarkdown.mockResolvedValue({ uid: NEW_PAGE_UID });
blockFromMarkdown.mockResolvedValue({ uids: [] });
deletePage.mockResolvedValue(undefined);
updatePage.mockResolvedValue(undefined);
setRoamAlphaApi();
});

describe("materializeObsidianNode", () => {
it("creates a Roam page from Obsidian markdown and stores source identity", async () => {
mocks.findImportedNodeUidBySourceRid.mockResolvedValue(null);

await expect(
materializeObsidianNode({
node,
sourceModifiedAt: SOURCE_MODIFIED_AT,
sourceNodeRid: SOURCE_NODE_RID,
}),
).resolves.toEqual({
success: true,
action: "created",
pageUid: NEW_PAGE_UID,
sourceModifiedAt: SOURCE_MODIFIED_AT,
sourceNodeRid: SOURCE_NODE_RID,
});

expect(pageFromMarkdown).toHaveBeenCalledWith({
page: {
title: "EVD - REM sleep and recall",
uid: NEW_PAGE_UID,
},
"markdown-string": MARKDOWN,
});
expect(mocks.writeImportedSourceIdentity).toHaveBeenCalledWith({
pageUid: NEW_PAGE_UID,
sourceModifiedAt: SOURCE_MODIFIED_AT,
sourceNodeRid: SOURCE_NODE_RID,
});
});

it("replaces the existing imported page instead of creating a duplicate", async () => {
mocks.findImportedNodeUidBySourceRid.mockResolvedValue(EXISTING_PAGE_UID);
mocks.getShallowTreeByParentUid.mockReturnValue([
{ uid: "old-child-1", text: "Old content" },
{ uid: "old-child-2", text: "More old content" },
]);

await expect(
materializeObsidianNode({
node,
sourceModifiedAt: SOURCE_MODIFIED_AT,
sourceNodeRid: SOURCE_NODE_RID,
}),
).resolves.toMatchObject({
success: true,
action: "updated",
pageUid: EXISTING_PAGE_UID,
});

expect(pageFromMarkdown).not.toHaveBeenCalled();
expect(updatePage).toHaveBeenCalledWith({
page: {
title: "EVD - REM sleep and recall",
uid: EXISTING_PAGE_UID,
},
"merge-pages": false,
});
expect(mocks.deleteBlock).toHaveBeenCalledTimes(2);
expect(mocks.deleteBlock).toHaveBeenCalledWith("old-child-1");
expect(mocks.deleteBlock).toHaveBeenCalledWith("old-child-2");
expect(blockFromMarkdown).toHaveBeenCalledWith({
location: { "parent-uid": EXISTING_PAGE_UID, order: "last" },
"markdown-string": MARKDOWN,
});
expect(mocks.writeImportedSourceIdentity).toHaveBeenCalledWith({
pageUid: EXISTING_PAGE_UID,
sourceModifiedAt: SOURCE_MODIFIED_AT,
sourceNodeRid: SOURCE_NODE_RID,
});
});

it("returns the source identity and failed stage when replacement fails", async () => {
mocks.findImportedNodeUidBySourceRid.mockResolvedValue(EXISTING_PAGE_UID);
blockFromMarkdown.mockRejectedValue(new Error("markdown parser failed"));

await expect(
materializeObsidianNode({
node,
sourceModifiedAt: SOURCE_MODIFIED_AT,
sourceNodeRid: SOURCE_NODE_RID,
}),
).resolves.toEqual({
success: false,
pageUid: EXISTING_PAGE_UID,
sourceModifiedAt: SOURCE_MODIFIED_AT,
sourceNodeRid: SOURCE_NODE_RID,
error: {
message: `Failed to replace Roam content for '${SOURCE_NODE_RID}': markdown parser failed`,
stage: "replace-page-content",
},
});
expect(mocks.writeImportedSourceIdentity).not.toHaveBeenCalled();
expect(mocks.deleteBlock).not.toHaveBeenCalled();
});

it("removes a new page if its source identity cannot be stored", async () => {
mocks.findImportedNodeUidBySourceRid.mockResolvedValue(null);
mocks.writeImportedSourceIdentity.mockRejectedValue(
new Error("props update failed"),
);

const result = await materializeObsidianNode({
node,
sourceModifiedAt: SOURCE_MODIFIED_AT,
sourceNodeRid: SOURCE_NODE_RID,
});

expect(result).toMatchObject({
success: false,
sourceModifiedAt: SOURCE_MODIFIED_AT,
sourceNodeRid: SOURCE_NODE_RID,
error: {
stage: "write-source-identity",
},
});
expect(result).not.toHaveProperty("pageUid");
expect(deletePage).toHaveBeenCalledWith({ page: { uid: NEW_PAGE_UID } });
});

it("rejects non-Obsidian payload identity before writing to Roam", async () => {
const sourceNodeRid = "orn:roam:graph-a/node-1";

await expect(
materializeObsidianNode({
node,
sourceModifiedAt: SOURCE_MODIFIED_AT,
sourceNodeRid,
}),
).resolves.toEqual({
success: false,
sourceModifiedAt: SOURCE_MODIFIED_AT,
sourceNodeRid,
error: {
message: `Source node RID '${sourceNodeRid}' is not Obsidian-origin`,
stage: "validate-input",
},
});
expect(mocks.findImportedNodeUidBySourceRid).not.toHaveBeenCalled();
expect(pageFromMarkdown).not.toHaveBeenCalled();
});
});
20 changes: 13 additions & 7 deletions apps/roam/src/utils/importedSourceIdentity.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import { DISCOURSE_GRAPH_PROP_NAME } from "./createReifiedBlock";
import getBlockProps, { type json } from "./getBlockProps";
import setBlockProps from "./setBlockProps";

export type ImportedSourceIdentity = {
sourceModifiedAt: string;
Expand Down Expand Up @@ -41,14 +40,21 @@ export const writeImportedSourceIdentity = ({
pageUid: string;
sourceModifiedAt: string;
sourceNodeRid: string;
}): void => {
const existing = getBlockProps(pageUid)[DISCOURSE_GRAPH_PROP_NAME];
}): Promise<void> => {
const props = getBlockProps(pageUid);
const existing = props[DISCOURSE_GRAPH_PROP_NAME];
const discourseGraphProps = isJsonObject(existing) ? existing : {};

setBlockProps(pageUid, {
[DISCOURSE_GRAPH_PROP_NAME]: {
...discourseGraphProps,
[IMPORTED_FROM_PROP_KEY]: { sourceModifiedAt, sourceNodeRid },
return window.roamAlphaAPI.data.block.update({
block: {
uid: pageUid,
props: {
...props,
[DISCOURSE_GRAPH_PROP_NAME]: {
...discourseGraphProps,
[IMPORTED_FROM_PROP_KEY]: { sourceModifiedAt, sourceNodeRid },
},
},
},
});
};
Expand Down
Loading